]>
Commit | Line | Data |
---|---|---|
2ab416c2 | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
2ab416c2 JH |
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 | |
4539e9ca | 17 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
2ab416c2 JH |
18 | ## |
19 | ||
2ab416c2 | 20 | import sigrokdecode as srd |
7f214f53 | 21 | import struct |
2ab416c2 | 22 | |
4adb11a9 | 23 | ''' |
c515eed7 | 24 | OUTPUT_PYTHON format: |
4adb11a9 UH |
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 | ||
2ab416c2 | 36 | class Decoder(srd.Decoder): |
07e40f34 | 37 | api_version = 3 |
2ab416c2 | 38 | id = 'i2s' |
270a59d8 | 39 | name = 'I²S' |
2ab416c2 | 40 | longname = 'Integrated Interchip Sound' |
a465436e | 41 | desc = 'Serial bus for connecting digital audio devices.' |
2ab416c2 JH |
42 | license = 'gplv2+' |
43 | inputs = ['logic'] | |
44 | outputs = ['i2s'] | |
6a15597a | 45 | channels = ( |
2ab416c2 JH |
46 | {'id': 'sck', 'name': 'SCK', 'desc': 'Bit clock line'}, |
47 | {'id': 'ws', 'name': 'WS', 'desc': 'Word select line'}, | |
ee3e279c | 48 | {'id': 'sd', 'name': 'SD', 'desc': 'Serial data line'}, |
da9bcbd9 BV |
49 | ) |
50 | annotations = ( | |
51 | ('left', 'Left channel'), | |
52 | ('right', 'Right channel'), | |
53 | ('warnings', 'Warnings'), | |
54 | ) | |
e54f222c UH |
55 | binary = ( |
56 | ('wav', 'WAV file'), | |
57 | ) | |
2ab416c2 | 58 | |
92b7b49f | 59 | def __init__(self): |
10aeb8ea GS |
60 | self.reset() |
61 | ||
62 | def reset(self): | |
f372d597 | 63 | self.samplerate = None |
2ab416c2 JH |
64 | self.oldws = 1 |
65 | self.bitcount = 0 | |
66 | self.data = 0 | |
67 | self.samplesreceived = 0 | |
780a5bee | 68 | self.first_sample = None |
486b19ce | 69 | self.ss_block = None |
abbbd2ba | 70 | self.wordlength = -1 |
e54f222c | 71 | self.wrote_wav_header = False |
2ab416c2 | 72 | |
f372d597 | 73 | def start(self): |
c515eed7 | 74 | self.out_python = self.register(srd.OUTPUT_PYTHON) |
2f370328 | 75 | self.out_binary = self.register(srd.OUTPUT_BINARY) |
be465111 | 76 | self.out_ann = self.register(srd.OUTPUT_ANN) |
2ab416c2 | 77 | |
f372d597 BV |
78 | def metadata(self, key, value): |
79 | if key == srd.SRD_CONF_SAMPLERATE: | |
80 | self.samplerate = value | |
81 | ||
2b2b7c30 | 82 | def putpb(self, data): |
486b19ce | 83 | self.put(self.ss_block, self.samplenum, self.out_python, data) |
2b2b7c30 | 84 | |
e54f222c | 85 | def putbin(self, data): |
2f370328 | 86 | self.put(self.ss_block, self.samplenum, self.out_binary, data) |
e54f222c | 87 | |
2b2b7c30 | 88 | def putb(self, data): |
486b19ce | 89 | self.put(self.ss_block, self.samplenum, self.out_ann, data) |
2b2b7c30 | 90 | |
2ab416c2 | 91 | def report(self): |
ee3e279c | 92 | # Calculate the sample rate. |
780a5bee | 93 | samplerate = '?' |
486b19ce | 94 | if self.ss_block is not None and \ |
35b380b1 | 95 | self.first_sample is not None and \ |
72cced49 GS |
96 | self.ss_block > self.first_sample and \ |
97 | self.samplerate: | |
ee3e279c | 98 | samplerate = '%d' % (self.samplesreceived * |
486b19ce | 99 | self.samplerate / (self.ss_block - |
780a5bee JH |
100 | self.first_sample)) |
101 | ||
ea48f543 | 102 | return 'I²S: %d %d-bit samples received at %sHz' % \ |
780a5bee | 103 | (self.samplesreceived, self.wordlength, samplerate) |
2ab416c2 | 104 | |
e54f222c UH |
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) | |
7f214f53 | 116 | h += b'\x00\xfa\x00\x00' # Byterate (64000) |
e54f222c | 117 | h += b'\x04\x00' # Blockalign (4) |
7f214f53 | 118 | h += b'\x20\x00' # Bits per sample (32) |
e54f222c UH |
119 | # Data subchunk |
120 | h += b'data' | |
65658c0a | 121 | h += b'\xff\xff\xff\xff' # Subchunk size (4G bytes) TODO |
e54f222c UH |
122 | return h |
123 | ||
124 | def wav_sample(self, sample): | |
30c855f6 | 125 | return struct.pack('<I', self.data) |
e54f222c | 126 | |
07e40f34 | 127 | def decode(self): |
07e40f34 UH |
128 | while True: |
129 | # Wait for a rising edge on the SCK pin. | |
130 | sck, ws, sd = self.wait({0: 'r'}) | |
2ab416c2 JH |
131 | |
132 | self.data = (self.data << 1) | sd | |
133 | self.bitcount += 1 | |
134 | ||
ee3e279c | 135 | # This was not the LSB unless WS has flipped. |
2ab416c2 JH |
136 | if ws == self.oldws: |
137 | continue | |
138 | ||
ee3e279c | 139 | # Only submit the sample, if we received the beginning of it. |
486b19ce | 140 | if self.ss_block is not None: |
e54f222c UH |
141 | |
142 | if not self.wrote_wav_header: | |
2f370328 | 143 | self.put(0, 0, self.out_binary, [0, self.wav_header()]) |
e54f222c UH |
144 | self.wrote_wav_header = True |
145 | ||
2ab416c2 | 146 | self.samplesreceived += 1 |
750a808a UH |
147 | |
148 | idx = 0 if self.oldws else 1 | |
149 | c1 = 'Left channel' if self.oldws else 'Right channel' | |
150 | c2 = 'Left' if self.oldws else 'Right' | |
151 | c3 = 'L' if self.oldws else 'R' | |
152 | v = '%08x' % self.data | |
153 | self.putpb(['DATA', [c3, self.data]]) | |
154 | self.putb([idx, ['%s: %s' % (c1, v), '%s: %s' % (c2, v), | |
155 | '%s: %s' % (c3, v), c3]]) | |
2824e811 | 156 | self.putbin([0, self.wav_sample(self.data)]) |
abbbd2ba | 157 | |
ee3e279c | 158 | # Check that the data word was the correct length. |
abbbd2ba | 159 | if self.wordlength != -1 and self.wordlength != self.bitcount: |
2b2b7c30 UH |
160 | self.putb([2, ['Received %d-bit word, expected %d-bit ' |
161 | 'word' % (self.bitcount, self.wordlength)]]) | |
abbbd2ba JH |
162 | |
163 | self.wordlength = self.bitcount | |
2ab416c2 JH |
164 | |
165 | # Reset decoder state. | |
166 | self.data = 0 | |
167 | self.bitcount = 0 | |
486b19ce | 168 | self.ss_block = self.samplenum |
780a5bee | 169 | |
ee3e279c | 170 | # Save the first sample position. |
35b380b1 | 171 | if self.first_sample is None: |
2b2b7c30 | 172 | self.first_sample = self.samplenum |
780a5bee | 173 | |
2ab416c2 | 174 | self.oldws = ws |