]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/transitioncounter.py
srd: Remove decode() docstrings.
[libsigrokdecode.git] / decoders / transitioncounter.py
index a6d331e85fc1af676d87edbebdce96c28d343a0a..846e9d982fda48361bcf295fe162a1ed88ed02a3 100644 (file)
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-def decode(inbuf):
-       """Counts the low->high and high->low transitions in the specified
-          channel(s) of the signal."""
-
-       outbuf = ''
-
-       # FIXME: Get the data in the correct format in the first place.
-       inbuf = [ord(x) for x in inbuf]
-
-       # TODO: Don't hardcode the number of channels.
-       channels = 8
-
-       oldbit = [0] * channels
-       transitions = [0] * channels
-       rising = [0] * channels
-       falling = [0] * channels
-
-       # Initial values.
-       oldbyte = inbuf[0]
-       for i in range(channels):
-               oldbit[i] = (oldbyte & (1 << i)) >> i
-
-       # Loop over all samples.
-       # TODO: Handle LAs with more/less than 8 channels.
-       for s in inbuf:
-               # Optimization: Skip identical bytes (no transitions).
-               if oldbyte == s:
-                       continue
-               for i in range(channels):
-                       curbit = (s & (1 << i)) >> i
-                       # Optimization: Skip identical bits (no transitions).
-                       if oldbit[i] == curbit:
-                               continue
-                       elif (oldbit[i] == 0 and curbit == 1):
-                               rising[i] += 1
-                       elif (oldbit[i] == 1 and curbit == 0):
-                               falling[i] += 1
-                       oldbit[i] = curbit
-               oldbyte = s
-
-       # Total number of transitions is the sum of rising and falling edges.
-       for i in range(channels):
-               transitions[i] = rising[i] + falling[i]
-
-       outbuf += "Rising edges:  "
-       for i in range(channels):
-               outbuf += str(rising[i]) + " "
-       outbuf += "\nFalling edges: "
-       for i in range(channels):
-               outbuf += str(falling[i]) + " "
-       outbuf += "\nTransitions:   "
-       for i in range(channels):
-               outbuf += str(transitions[i]) + " "
-       outbuf += "\n"
-
-       return outbuf
-
-def register():
-       return {
-               'id': 'transitioncounter',
-               'name': 'Transition counter',
-               'desc': 'Count rising/falling edges',
-               'inputformats': ['raw'],
-               'signalnames': {}, # FIXME
-               'outputformats': ['transitioncounts'],
-       }
-
-# Use psyco (if available) as it results in huge performance improvements.
-try:
-       import psyco
-       psyco.bind(decode)
-except ImportError:
-       pass
+import sigrok
+
+class Sample():
+    def __init__(self, data):
+        self.data = data
+    def probe(self, probe):
+        s = self.data[int(probe / 8)] & (1 << (probe % 8))
+        return True if s else False
+
+def sampleiter(data, unitsize):
+    for i in range(0, len(data), unitsize):
+        yield(Sample(data[i:i+unitsize]))
+
+class Decoder(sigrok.Decoder):
+    id = 'transitioncounter'
+    name = 'Transition counter'
+    longname = '...'
+    desc = 'Counts rising/falling edges in the signal.'
+    longdesc = '...'
+    author = 'Uwe Hermann'
+    email = 'uwe@hermann-uwe.de'
+    license = 'gplv2+'
+    inputs = ['logic']
+    outputs = ['transitioncounts']
+    probes = {}
+    options = {}
+
+    def __init__(self, **kwargs):
+        self.probes = Decoder.probes.copy()
+        self.output_protocol = None
+        self.output_annotation = None
+
+        # TODO: Don't hardcode the number of channels.
+        self.channels = 8
+
+        self.lastsample = None
+        self.oldbit = [0] * self.channels
+        self.transitions = [0] * self.channels
+        self.rising = [0] * self.channels
+        self.falling = [0] * self.channels
+
+    def start(self, metadata):
+        self.unitsize = metadata['unitsize']
+        # self.output_protocol = self.output_new(2)
+        self.output_annotation = self.output_new(1)
+
+    def report(self):
+        pass
+
+    def decode(self, timeoffset, duration, data):
+        # We should accept a list of samples and iterate...
+        for sample in sampleiter(data, self.unitsize):
+
+            # TODO: Eliminate the need for ord().
+            s = ord(sample.data)
+
+            # Optimization: Skip identical samples (no transitions).
+            if self.lastsample == s:
+                continue
+
+            # Upon the first sample, store the initial values.
+            if self.lastsample == None:
+                self.lastsample = s
+                for i in range(self.channels):
+                    self.oldbit[i] = (self.lastsample & (1 << i)) >> i
+
+            # Iterate over all channels/probes in this sample.
+            # Count rising and falling edges for each channel.
+            for i in range(self.channels):
+                curbit = (s & (1 << i)) >> i
+                # Optimization: Skip identical bits (no transitions).
+                if self.oldbit[i] == curbit:
+                    continue
+                elif (self.oldbit[i] == 0 and curbit == 1):
+                    self.rising[i] += 1
+                elif (self.oldbit[i] == 1 and curbit == 0):
+                    self.falling[i] += 1
+                self.oldbit[i] = curbit
+
+            # Save the current sample as 'lastsample' for the next round.
+            self.lastsample = s
+
+        # Total number of transitions = rising + falling edges.
+        for i in range(self.channels):
+            self.transitions[i] = self.rising[i] + self.falling[i]
+
+        # TODO: Which output format?
+        # TODO: How to only output something after the last chunk of data?
+        outdata = []
+        for i in range(self.channels):
+            outdata += [[self.transitions[i], self.rising[i], self.falling[i]]]
+
+        if outdata != []:
+            # self.put(self.output_protocol, 0, 0, out_proto)
+            self.put(self.output_annotation, 0, 0, outdata)