i2s: Replace I2S with I²S

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

diff --git a/decoders/i2s/pd.py b/decoders/i2s/pd.py
index 9fbcef7c7ed5ceb49015e3f0ea8bf62db9eeb070..705e4b9a800271e7d290c5d50f76b56dfccb9ec4 100644 (file)
--- a/decoders/i2s/pd.py
+++ b/decoders/i2s/pd.py
@@ -18,7 +18,7 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-# I2S protocol decoder
+# I²S protocol decoder
 
 import sigrokdecode as srd
 
@@ -38,7 +38,7 @@ Packet:
 class Decoder(srd.Decoder):
     api_version = 1
     id = 'i2s'
-    name = 'I2S'
+    name = 'I²S'
     longname = 'Integrated Interchip Sound'
     desc = 'Serial bus for connecting digital audio devices.'
     license = 'gplv2+'
@@ -58,6 +58,7 @@ class Decoder(srd.Decoder):
     ]
 
     def __init__(self, **kwargs):
+        self.samplerate = None
         self.oldsck = 1
         self.oldws = 1
         self.bitcount = 0
@@ -67,10 +68,13 @@ class Decoder(srd.Decoder):
         self.start_sample = None
         self.wordlength = -1
 
-    def start(self, metadata):
-        self.samplerate = metadata['samplerate']
-        self.out_proto = self.add(srd.OUTPUT_PROTO, 'i2s')
-        self.out_ann = self.add(srd.OUTPUT_ANN, 'i2s')
+    def start(self):
+        self.out_proto = self.register(srd.OUTPUT_PYTHON)
+        self.out_ann = self.register(srd.OUTPUT_ANN)
+
+    def metadata(self, key, value):
+        if key == srd.SRD_CONF_SAMPLERATE:
+            self.samplerate = value
 
     def putpb(self, data):
         self.put(self.start_sample, self.samplenum, self.out_proto, data)
@@ -89,10 +93,12 @@ class Decoder(srd.Decoder):
                 self.samplerate / (self.start_sample -
                 self.first_sample))
 
-        return 'I2S: %d %d-bit samples received at %sHz' % \
+        return 'I³S: %d %d-bit samples received at %sHz' % \
             (self.samplesreceived, self.wordlength, samplerate)
 
     def decode(self, ss, es, data):
+        if self.samplerate is None:
+            raise Exception("Cannot decode without samplerate.")
         for self.samplenum, (sck, ws, sd) in data:
 
             # Ignore sample if the bit clock hasn't changed.