srd: decoders: Metadata consistency fixes/updates.
[libsigrokdecode.git] / decoders / transitioncounter.py
1 ##
2 ## This file is part of the sigrok project.
3 ##
4 ## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 of the License, or
9 ## (at your option) any later version.
10 ##
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ## GNU General Public License for more details.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19 ##
20
21 import sigrokdecode as srd
22
23 class Decoder(srd.Decoder):
24     id = 'transitioncounter'
25     name = 'Transition counter'
26     longname = '...'
27     desc = 'Counts rising/falling edges in the signal.'
28     longdesc = '...'
29     author = 'Uwe Hermann'
30     email = 'uwe@hermann-uwe.de'
31     license = 'gplv2+'
32     inputs = ['logic']
33     outputs = ['transitioncounts']
34     probes = []
35     options = {}
36     annotations = []
37
38     def __init__(self, **kwargs):
39         self.channels = -1
40         self.lastsample = None
41
42     def start(self, metadata):
43         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'transitioncounter')
44         self.out_ann = self.add(srd.OUTPUT_ANN, 'transitioncounter')
45
46     def report(self):
47         pass
48
49     def decode(self, timeoffset, duration, data):
50
51         for (samplenum, s) in data:
52
53             # ...
54             if self.channels == -1:
55                 self.channels = len(s)
56                 self.oldbit = [0] * self.channels
57                 self.transitions = [0] * self.channels
58                 self.rising = [0] * self.channels
59                 self.falling = [0] * self.channels
60
61             # Optimization: Skip identical samples (no transitions).
62             if self.lastsample == s:
63                 continue
64
65             # Upon the first sample, store the initial values.
66             if self.lastsample == None:
67                 self.lastsample = s
68                 for i in range(self.channels):
69                     self.oldbit[i] = self.lastsample[i]
70
71             # Iterate over all channels/probes in this sample.
72             # Count rising and falling edges for each channel.
73             for i in range(self.channels):
74                 curbit = s[i]
75                 # Optimization: Skip identical bits (no transitions).
76                 if self.oldbit[i] == curbit:
77                     continue
78                 elif (self.oldbit[i] == 0 and curbit == 1):
79                     self.rising[i] += 1
80                 elif (self.oldbit[i] == 1 and curbit == 0):
81                     self.falling[i] += 1
82                 self.oldbit[i] = curbit
83
84             # Save the current sample as 'lastsample' for the next round.
85             self.lastsample = s
86
87         # Total number of transitions = rising + falling edges.
88         for i in range(self.channels):
89             self.transitions[i] = self.rising[i] + self.falling[i]
90
91         # TODO: Which output format?
92         # TODO: How to only output something after the last chunk of data?
93         outdata = []
94         for i in range(self.channels):
95             outdata += [[self.transitions[i], self.rising[i], self.falling[i]]]
96
97         if outdata != []:
98             # self.put(0, 0, self.out_proto, out_proto)
99             self.put(0, 0, self.out_ann, outdata)
100