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 OUTPUT_PYTHON 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 SamplerateError(Exception):
  37     pass
  38
  39 class Decoder(srd.Decoder):
  40     api_version = 3
  41     id = 'i2s'
  42     name = 'I²S'
  43     longname = 'Integrated Interchip Sound'
  44     desc = 'Serial bus for connecting digital audio devices.'
  45     license = 'gplv2+'
  46     inputs = ['logic']
  47     outputs = ['i2s']
  48     channels = (
  49         {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'},
  50         {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'},
  51         {'id': 'sd', 'name': 'SD', 'desc': 'Serial data line'},
  52     )
  53     annotations = (
  54         ('left', 'Left channel'),
  55         ('right', 'Right channel'),
  56         ('warnings', 'Warnings'),
  57     )
  58     binary = (
  59         ('wav', 'WAV file'),
  60     )
  61
  62     def __init__(self):
  63         self.samplerate = None
  64         self.oldws = 1
  65         self.bitcount = 0
  66         self.data = 0
  67         self.samplesreceived = 0
  68         self.first_sample = None
  69         self.ss_block = None
  70         self.wordlength = -1
  71         self.wrote_wav_header = False
  72
  73     def start(self):
  74         self.out_python = self.register(srd.OUTPUT_PYTHON)
  75         self.out_binary = 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.ss_block, self.samplenum, self.out_python, data)
  84
  85     def putbin(self, data):
  86         self.put(self.ss_block, self.samplenum, self.out_binary, data)
  87
  88     def putb(self, data):
  89         self.put(self.ss_block, self.samplenum, self.out_ann, data)
  90
  91     def report(self):
  92
  93         # Calculate the sample rate.
  94         samplerate = '?'
  95         if self.ss_block is not None and \
  96             self.first_sample is not None and \
  97             self.ss_block > self.first_sample:
  98             samplerate = '%d' % (self.samplesreceived *
  99                 self.samplerate / (self.ss_block -
 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):
 133         if not self.samplerate:
 134             raise SamplerateError('Cannot decode without samplerate.')
 135         while True:
 136             # Wait for a rising edge on the SCK pin.
 137             sck, ws, sd = self.wait({0: 'r'})
 138
 139             self.data = (self.data << 1) | sd
 140             self.bitcount += 1
 141
 142             # This was not the LSB unless WS has flipped.
 143             if ws == self.oldws:
 144                 continue
 145
 146             # Only submit the sample, if we received the beginning of it.
 147             if self.ss_block is not None:
 148
 149                 if not self.wrote_wav_header:
 150                     self.put(0, 0, self.out_binary, [0, self.wav_header()])
 151                     self.wrote_wav_header = True
 152
 153                 self.samplesreceived += 1
 154
 155                 idx = 0 if self.oldws else 1
 156                 c1 = 'Left channel' if self.oldws else 'Right channel'
 157                 c2 = 'Left' if self.oldws else 'Right'
 158                 c3 = 'L' if self.oldws else 'R'
 159                 v = '%08x' % self.data
 160                 self.putpb(['DATA', [c3, self.data]])
 161                 self.putb([idx, ['%s: %s' % (c1, v), '%s: %s' % (c2, v),
 162                                  '%s: %s' % (c3, v), c3]])
 163                 self.putbin([0, self.wav_sample(self.data)])
 164
 165                 # Check that the data word was the correct length.
 166                 if self.wordlength != -1 and self.wordlength != self.bitcount:
 167                     self.putb([2, ['Received %d-bit word, expected %d-bit '
 168                                    'word' % (self.bitcount, self.wordlength)]])
 169
 170                 self.wordlength = self.bitcount
 171
 172             # Reset decoder state.
 173             self.data = 0
 174             self.bitcount = 0
 175             self.ss_block = self.samplenum
 176
 177             # Save the first sample position.
 178             if self.first_sample is None:
 179                 self.first_sample = self.samplenum
 180
 181             self.oldws = ws