decoders/i2s/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 import sigrokdecode as srd
  22
  23 '''
  24 Protocol output format:
  25
  26 Packet:
  27 [<ptype>, <pdata>]
  28
  29 <ptype>, <pdata>:
  30  - 'DATA', [<channel>, <value>]
  31
  32 <channel>: 'L' or 'R'
  33 <value>: integer
  34 '''
  35
  36 class Decoder(srd.Decoder):
  37     api_version = 1
  38     id = 'i2s'
  39     name = 'I²S'
  40     longname = 'Integrated Interchip Sound'
  41     desc = 'Serial bus for connecting digital audio devices.'
  42     license = 'gplv2+'
  43     inputs = ['logic']
  44     outputs = ['i2s']
  45     probes = [
  46         {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'},
  47         {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'},
  48         {'id': 'sd', 'name': 'SD', 'desc': 'Serial data line'},
  49     ]
  50     optional_probes = []
  51     options = {}
  52     annotations = [
  53         ['left', 'Left channel'],
  54         ['right', 'Right channel'],
  55         ['warnings', 'Warnings'],
  56     ]
  57     binary = (
  58         ('wav', 'WAV file'),
  59     )
  60
  61     def __init__(self, **kwargs):
  62         self.samplerate = None
  63         self.oldsck = 1
  64         self.oldws = 1
  65         self.bitcount = 0
  66         self.data = 0
  67         self.samplesreceived = 0
  68         self.first_sample = None
  69         self.start_sample = None
  70         self.wordlength = -1
  71         self.wrote_wav_header = False
  72
  73     def start(self):
  74         self.out_proto = self.register(srd.OUTPUT_PYTHON)
  75         self.out_bin = self.register(srd.OUTPUT_BINARY)
  76         self.out_ann = self.register(srd.OUTPUT_ANN)
  77
  78     def metadata(self, key, value):
  79         if key == srd.SRD_CONF_SAMPLERATE:
  80             self.samplerate = value
  81
  82     def putpb(self, data):
  83         self.put(self.start_sample, self.samplenum, self.out_proto, data)
  84
  85     def putbin(self, data):
  86         self.put(self.start_sample, self.samplenum, self.out_bin, data)
  87
  88     def putb(self, data):
  89         self.put(self.start_sample, self.samplenum, self.out_ann, data)
  90
  91     def report(self):
  92
  93         # Calculate the sample rate.
  94         samplerate = '?'
  95         if self.start_sample != None and \
  96             self.first_sample != None and \
  97             self.start_sample > self.first_sample:
  98             samplerate = '%d' % (self.samplesreceived *
  99                 self.samplerate / (self.start_sample -
 100                 self.first_sample))
 101
 102         return 'I²S: %d %d-bit samples received at %sHz' % \
 103             (self.samplesreceived, self.wordlength, samplerate)
 104
 105     def wav_header(self):
 106         # Chunk descriptor
 107         h  = b'RIFF'
 108         h += b'\x24\x80\x00\x00' # Chunk size (2084)
 109         h += b'WAVE'
 110         # Fmt subchunk
 111         h += b'fmt '
 112         h += b'\x10\x00\x00\x00' # Subchunk size (16 bytes)
 113         h += b'\x01\x00'         # Audio format (0x0001 == PCM)
 114         h += b'\x02\x00'         # Number of channels (2)
 115         h += b'\x80\x3e\x00\x00' # Samplerate (16000)
 116         h += b'\x00\x7d\x00\x00' # Byterate (32000)
 117         h += b'\x04\x00'         # Blockalign (4)
 118         h += b'\x10\x00'         # Bits per sample (16)
 119         # Data subchunk
 120         h += b'data'
 121         h += b'\xff\xff\x00\x00' # Subchunk size (65535 bytes) TODO
 122         return h
 123
 124     def wav_sample(self, sample):
 125         # TODO: This currently assumes U32 samples, and converts to S16.
 126         s = sample >> 16
 127         if s >= 0x8000:
 128             s -= 0x10000
 129         lo, hi = s & 0xff, (s >> 8) & 0xff
 130         return bytes([lo, hi])
 131
 132     def decode(self, ss, es, data):
 133         if self.samplerate is None:
 134             raise Exception("Cannot decode without samplerate.")
 135         for self.samplenum, (sck, ws, sd) in data:
 136
 137             # Ignore sample if the bit clock hasn't changed.
 138             if sck == self.oldsck:
 139                 continue
 140
 141             self.oldsck = sck
 142             if sck == 0:   # Ignore the falling clock edge.
 143                 continue
 144
 145             self.data = (self.data << 1) | sd
 146             self.bitcount += 1
 147
 148             # This was not the LSB unless WS has flipped.
 149             if ws == self.oldws:
 150                 continue
 151
 152             # Only submit the sample, if we received the beginning of it.
 153             if self.start_sample != None:
 154
 155                 if not self.wrote_wav_header:
 156                     self.put(0, 0, self.out_bin, (0, self.wav_header()))
 157                     self.wrote_wav_header = True
 158
 159                 self.samplesreceived += 1
 160
 161                 idx = 0 if self.oldws else 1
 162                 c1 = 'Left channel' if self.oldws else 'Right channel'
 163                 c2 = 'Left' if self.oldws else 'Right'
 164                 c3 = 'L' if self.oldws else 'R'
 165                 v = '%08x' % self.data
 166                 self.putpb(['DATA', [c3, self.data]])
 167                 self.putb([idx, ['%s: %s' % (c1, v), '%s: %s' % (c2, v),
 168                                  '%s: %s' % (c3, v), c3]])
 169                 self.putbin((0, self.wav_sample(self.data)))
 170
 171                 # Check that the data word was the correct length.
 172                 if self.wordlength != -1 and self.wordlength != self.bitcount:
 173                     self.putb([2, ['Received %d-bit word, expected %d-bit '
 174                                    'word' % (self.bitcount, self.wordlength)]])
 175
 176                 self.wordlength = self.bitcount
 177
 178             # Reset decoder state.
 179             self.data = 0
 180             self.bitcount = 0
 181             self.start_sample = self.samplenum
 182
 183             # Save the first sample position.
 184             if self.first_sample == None:
 185                 self.first_sample = self.samplenum
 186
 187             self.oldws = ws
 188