All PDs: Only import the 'Decoder' object.

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

diff --git a/decoders/i2s/pd.py b/decoders/i2s/pd.py
index c934b5dbd9f0aa0ce228b3d1d6029650acbdd167..8b45a752cbae2c750581a511cff382002734934e 100644 (file)
--- a/decoders/i2s/pd.py
+++ b/decoders/i2s/pd.py
@@ -18,12 +18,10 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-# I²S protocol decoder
-
 import sigrokdecode as srd
 
 '''
-Protocol output format:
+OUTPUT_PYTHON format:
 
 Packet:
 [<ptype>, <pdata>]
@@ -35,8 +33,11 @@ Packet:
 <value>: integer
 '''
 
+class SamplerateError(Exception):
+    pass
+
 class Decoder(srd.Decoder):
-    api_version = 1
+    api_version = 2
     id = 'i2s'
     name = 'I²S'
     longname = 'Integrated Interchip Sound'
@@ -44,18 +45,16 @@ class Decoder(srd.Decoder):
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['i2s']
-    probes = [
+    channels = (
         {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'},
         {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'},
         {'id': 'sd', 'name': 'SD', 'desc': 'Serial data line'},
-    ]
-    optional_probes = []
-    options = {}
-    annotations = [
-        ['left', 'Left channel'],
-        ['right', 'Right channel'],
-        ['warnings', 'Warnings'],
-    ]
+    )
+    annotations = (
+        ('left', 'Left channel'),
+        ('right', 'Right channel'),
+        ('warnings', 'Warnings'),
+    )
     binary = (
         ('wav', 'WAV file'),
     )
@@ -73,7 +72,7 @@ class Decoder(srd.Decoder):
         self.wrote_wav_header = False
 
     def start(self):
-        self.out_proto = self.register(srd.OUTPUT_PYTHON)
+        self.out_python = self.register(srd.OUTPUT_PYTHON)
         self.out_bin = self.register(srd.OUTPUT_BINARY)
         self.out_ann = self.register(srd.OUTPUT_ANN)
 
@@ -82,7 +81,7 @@ class Decoder(srd.Decoder):
             self.samplerate = value
 
     def putpb(self, data):
-        self.put(self.start_sample, self.samplenum, self.out_proto, data)
+        self.put(self.start_sample, self.samplenum, self.out_python, data)
 
     def putbin(self, data):
         self.put(self.start_sample, self.samplenum, self.out_bin, data)
@@ -94,8 +93,8 @@ class Decoder(srd.Decoder):
 
         # Calculate the sample rate.
         samplerate = '?'
-        if self.start_sample != None and \
-            self.first_sample != None and \
+        if self.start_sample is not None and \
+            self.first_sample is not None and \
             self.start_sample > self.first_sample:
             samplerate = '%d' % (self.samplesreceived *
                 self.samplerate / (self.start_sample -
@@ -132,8 +131,8 @@ class Decoder(srd.Decoder):
         return bytes([lo, hi])
 
     def decode(self, ss, es, data):
-        if self.samplerate is None:
-            raise Exception("Cannot decode without samplerate.")
+        if not self.samplerate:
+            raise SamplerateError('Cannot decode without samplerate.')
         for self.samplenum, (sck, ws, sd) in data:
 
             # Ignore sample if the bit clock hasn't changed.
@@ -152,7 +151,7 @@ class Decoder(srd.Decoder):
                 continue
 
             # Only submit the sample, if we received the beginning of it.
-            if self.start_sample != None:
+            if self.start_sample is not None:
 
                 if not self.wrote_wav_header:
                     self.put(0, 0, self.out_bin, (0, self.wav_header()))
@@ -183,8 +182,7 @@ class Decoder(srd.Decoder):
             self.start_sample = self.samplenum
 
             # Save the first sample position.
-            if self.first_sample == None:
+            if self.first_sample is None:
                 self.first_sample = self.samplenum
 
             self.oldws = ws
-