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, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21 import struct
  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 Decoder(srd.Decoder):
  37     api_version = 3
  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     tags = ['Audio', 'PC']
  46     channels = (
  47         {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'},
  48         {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'},
  49         {'id': 'sd', 'name': 'SD', 'desc': 'Serial data line'},
  50     )
  51     annotations = (
  52         ('left', 'Left channel'),
  53         ('right', 'Right channel'),
  54         ('warnings', 'Warnings'),
  55     )
  56     binary = (
  57         ('wav', 'WAV file'),
  58     )
  59
  60     def __init__(self):
  61         self.reset()
  62
  63     def reset(self):
  64         self.samplerate = None
  65         self.oldws = 1
  66         self.bitcount = 0
  67         self.data = 0
  68         self.samplesreceived = 0
  69         self.first_sample = None
  70         self.ss_block = None
  71         self.wordlength = -1
  72         self.wrote_wav_header = False
  73
  74     def start(self):
  75         self.out_python = self.register(srd.OUTPUT_PYTHON)
  76         self.out_binary = self.register(srd.OUTPUT_BINARY)
  77         self.out_ann = self.register(srd.OUTPUT_ANN)
  78
  79     def metadata(self, key, value):
  80         if key == srd.SRD_CONF_SAMPLERATE:
  81             self.samplerate = value
  82
  83     def putpb(self, data):
  84         self.put(self.ss_block, self.samplenum, self.out_python, data)
  85
  86     def putbin(self, data):
  87         self.put(self.ss_block, self.samplenum, self.out_binary, data)
  88
  89     def putb(self, data):
  90         self.put(self.ss_block, self.samplenum, self.out_ann, data)
  91
  92     def report(self):
  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 and \
  98             self.samplerate:
  99             samplerate = '%d' % (self.samplesreceived *
 100                 self.samplerate / (self.ss_block -
 101                 self.first_sample))
 102
 103         return 'I²S: %d %d-bit samples received at %sHz' % \
 104             (self.samplesreceived, self.wordlength, samplerate)
 105
 106     def wav_header(self):
 107         # Chunk descriptor
 108         h  = b'RIFF'
 109         h += b'\x24\x80\x00\x00' # Chunk size (2084)
 110         h += b'WAVE'
 111         # Fmt subchunk
 112         h += b'fmt '
 113         h += b'\x10\x00\x00\x00' # Subchunk size (16 bytes)
 114         h += b'\x01\x00'         # Audio format (0x0001 == PCM)
 115         h += b'\x02\x00'         # Number of channels (2)
 116         h += b'\x80\x3e\x00\x00' # Samplerate (16000)
 117         h += b'\x00\xfa\x00\x00' # Byterate (64000)
 118         h += b'\x04\x00'         # Blockalign (4)
 119         h += b'\x20\x00'         # Bits per sample (32)
 120         # Data subchunk
 121         h += b'data'
 122         h += b'\xff\xff\xff\xff' # Subchunk size (4G bytes) TODO
 123         return h
 124
 125     def wav_sample(self, sample):
 126         return struct.pack('<I', self.data)
 127
 128     def decode(self):
 129         while True:
 130             # Wait for a rising edge on the SCK pin.
 131             sck, ws, sd = self.wait({0: 'r'})
 132
 133             self.data = (self.data << 1) | sd
 134             self.bitcount += 1
 135
 136             # This was not the LSB unless WS has flipped.
 137             if ws == self.oldws:
 138                 continue
 139
 140             # Only submit the sample, if we received the beginning of it.
 141             if self.ss_block is not None:
 142
 143                 if not self.wrote_wav_header:
 144                     self.put(0, 0, self.out_binary, [0, self.wav_header()])
 145                     self.wrote_wav_header = True
 146
 147                 self.samplesreceived += 1
 148
 149                 sck = self.wait({0: 'f'})
 150
 151                 idx = 0 if not self.oldws else 1
 152                 c1 = 'Left channel' if not self.oldws else 'Right channel'
 153                 c2 = 'Left' if not self.oldws else 'Right'
 154                 c3 = 'L' if not self.oldws else 'R'
 155                 v = '%08x' % self.data
 156                 self.putpb(['DATA', [c3, self.data]])
 157                 self.putb([idx, ['%s: %s' % (c1, v), '%s: %s' % (c2, v),
 158                                  '%s: %s' % (c3, v), c3]])
 159                 self.putbin([0, self.wav_sample(self.data)])
 160
 161                 # Check that the data word was the correct length.
 162                 if self.wordlength != -1 and self.wordlength != self.bitcount:
 163                     self.putb([2, ['Received %d-bit word, expected %d-bit '
 164                                    'word' % (self.bitcount, self.wordlength)]])
 165
 166                 self.wordlength = self.bitcount
 167             else:
 168                 sck = self.wait({0: 'f'})
 169
 170             # Reset decoder state.
 171             self.data = 0
 172             self.bitcount = 0
 173             self.ss_block = self.samplenum
 174
 175             # Save the first sample position.
 176             if self.first_sample is None:
 177                 self.first_sample = self.samplenum
 178
 179             self.oldws = ws