]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/i2s/pd.py
configure.ac: Drop obsolete MinGW Python3 workaround.
[libsigrokdecode.git] / decoders / i2s / pd.py
index b1f36caba7d927925dfcfbd4e7809c10bc6f6932..9f04e1030ec7d66598c3c3acf098235bfa7cc3a8 100644 (file)
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-# I2S protocol decoder
+# I²S protocol decoder
 
 import sigrokdecode as srd
 
+'''
+Protocol output format:
+
+Packet:
+[<ptype>, <pdata>]
+
+<ptype>, <pdata>:
+ - 'DATA', [<channel>, <value>]
+
+<channel>: 'L' or 'R'
+<value>: integer
+'''
+
 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+'
@@ -45,6 +58,7 @@ class Decoder(srd.Decoder):
     ]
 
     def __init__(self, **kwargs):
+        self.samplerate = None
         self.oldsck = 1
         self.oldws = 1
         self.bitcount = 0
@@ -54,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)
@@ -76,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.
@@ -100,8 +119,15 @@ class Decoder(srd.Decoder):
             # Only submit the sample, if we received the beginning of it.
             if self.start_sample != None:
                 self.samplesreceived += 1
-                self.putpb(['data', self.data])
-                self.putb([0 if self.oldws else 1, ['0x%08x' % self.data]])
+
+                idx = 0 if self.oldws else 1
+                c1 = 'Left channel' if self.oldws else 'Right channel'
+                c2 = 'Left' if self.oldws else 'Right'
+                c3 = 'L' if self.oldws else 'R'
+                v = '%08x' % self.data
+                self.putpb(['DATA', [c3, self.data]])
+                self.putb([idx, ['%s: %s' % (c1, v), '%s: %s' % (c2, v),
+                                 '%s: %s' % (c3, v), c3]])
 
                 # Check that the data word was the correct length.
                 if self.wordlength != -1 and self.wordlength != self.bitcount: