all decoders: introduce a reset() method

[libsigrokdecode.git] / decoders / timing / pd.py

diff --git a/decoders/timing/pd.py b/decoders/timing/pd.py
index e0795f3677a7e0f4a306aab4198ed55800b37630..61eab1ea104c03b1a45b8f646f2b16df697cf4eb 100644 (file)
--- a/decoders/timing/pd.py
+++ b/decoders/timing/pd.py
@@ -15,32 +15,41 @@
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
 import sigrokdecode as srd
+from collections import deque
 
 class SamplerateError(Exception):
     pass
 
 def normalize_time(t):
-    if t >= 1.0:
-        return '%.3f s' % t
-    elif t >= 0.001:
-        return '%.3f ms' % (t * 1000.0)
-    elif t >= 0.000001:
-        return '%.3f μs' % (t * 1000.0 * 1000.0)
-    elif t >= 0.000000001:
-        return '%.3f ns' % (t * 1000.0 * 1000.0 * 1000.0)
+    if abs(t) >= 1.0:
+        return '%.3f s  (%.3f Hz)' % (t, (1/t))
+    elif abs(t) >= 0.001:
+        if 1/t/1000 < 1:
+            return '%.3f ms (%.3f Hz)' % (t * 1000.0, (1/t))
+        else:
+            return '%.3f ms (%.3f kHz)' % (t * 1000.0, (1/t)/1000)
+    elif abs(t) >= 0.000001:
+        if 1/t/1000/1000 < 1:
+            return '%.3f μs (%.3f kHz)' % (t * 1000.0 * 1000.0, (1/t)/1000)
+        else:
+            return '%.3f μs (%.3f MHz)' % (t * 1000.0 * 1000.0, (1/t)/1000/1000)
+    elif abs(t) >= 0.000000001:
+        if 1/t/1000/1000/1000:
+            return '%.3f ns (%.3f MHz)' % (t * 1000.0 * 1000.0 * 1000.0, (1/t)/1000/1000)
+        else:
+            return '%.3f ns (%.3f GHz)' % (t * 1000.0 * 1000.0 * 1000.0, (1/t)/1000/1000/1000)
     else:
         return '%f' % t
 
 class Decoder(srd.Decoder):
-    api_version = 2
+    api_version = 3
     id = 'timing'
     name = 'Timing'
-    longname = 'Timing calculation'
+    longname = 'Timing calculation with frequency and averaging'
     desc = 'Calculate time between edges.'
     license = 'gplv2+'
     inputs = ['logic']
@@ -50,15 +59,30 @@ class Decoder(srd.Decoder):
     )
     annotations = (
         ('time', 'Time'),
+        ('average', 'Average'),
+        ('delta', 'Delta'),
     )
     annotation_rows = (
         ('time', 'Time', (0,)),
+        ('average', 'Average', (1,)),
+        ('delta', 'Delta', (2,)),
+    )
+    options = (
+        { 'id': 'avg_period', 'desc': 'Averaging period', 'default': 100 },
+        { 'id': 'edge', 'desc': 'Edges to check', 'default': 'any', 'values': ('any', 'rising', 'falling') },
+        { 'id': 'delta', 'desc': 'Show delta from last', 'default': 'no', 'values': ('yes', 'no') },
     )
 
     def __init__(self):
+        self.reset()
+
+    def reset(self):
         self.samplerate = None
-        self.oldpin = None
         self.last_samplenum = None
+        self.last_n = deque()
+        self.chunks = 0
+        self.level_changed = False
+        self.last_t = None
 
     def metadata(self, key, value):
         if key == srd.SRD_CONF_SAMPLERATE:
@@ -66,29 +90,38 @@ class Decoder(srd.Decoder):
 
     def start(self):
         self.out_ann = self.register(srd.OUTPUT_ANN)
+        self.edge = self.options['edge']
 
-    def decode(self, ss, es, data):
+    def decode(self):
         if not self.samplerate:
             raise SamplerateError('Cannot decode without samplerate.')
+        while True:
+            if self.edge == 'rising':
+                pin = self.wait({0: 'r'})
+            elif self.edge == 'falling':
+                pin = self.wait({0: 'f'})
+            else:
+                pin = self.wait({0: 'e'})
 
-        for (self.samplenum, (pin,)) in data:
-            # Ignore identical samples early on (for performance reasons).
-            if self.oldpin == pin:
-                continue
-
-            if self.oldpin is None:
-                self.oldpin = pin
+            if not self.last_samplenum:
                 self.last_samplenum = self.samplenum
                 continue
+            samples = self.samplenum - self.last_samplenum
+            t = samples / self.samplerate
 
-            if self.oldpin != pin:
-                samples = self.samplenum - self.last_samplenum
-                t = samples / self.samplerate
+            if t > 0:
+                self.last_n.append(t)
+            if len(self.last_n) > self.options['avg_period']:
+                self.last_n.popleft()
 
-                # Report the timing normalized.
+            self.put(self.last_samplenum, self.samplenum, self.out_ann,
+                     [0, [normalize_time(t)]])
+            if self.options['avg_period'] > 0:
+                self.put(self.last_samplenum, self.samplenum, self.out_ann,
+                         [1, [normalize_time(sum(self.last_n) / len(self.last_n))]])
+            if self.last_t and self.options['delta'] == 'yes':
                 self.put(self.last_samplenum, self.samplenum, self.out_ann,
-                         [0, [normalize_time(t)]])
+                         [2, [normalize_time(t - self.last_t)]])
 
-                # Store data for next round.
-                self.last_samplenum = self.samplenum
-                self.oldpin = pin
+            self.last_t = t
+            self.last_samplenum = self.samplenum