]> sigrok.org Git - libsigrok.git/blame_incremental - src/input/wav.c
scpi-dmm: model and MQ dependent delay when switching functions
[libsigrok.git] / src / input / wav.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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 3 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#include <config.h>
21#include <sys/types.h>
22#include <sys/stat.h>
23#include <unistd.h>
24#include <fcntl.h>
25#include <ctype.h>
26#include <string.h>
27#include <stdint.h>
28#include <libsigrok/libsigrok.h>
29#include "libsigrok-internal.h"
30
31#define LOG_PREFIX "input/wav"
32
33/* How many bytes at a time to process and send to the session bus. */
34#define CHUNK_SIZE (1 * 1024 * 1024 * sizeof(float))
35
36/* Minimum size of header + 1 8-bit mono PCM sample. */
37#define MIN_DATA_CHUNK_OFFSET 45
38
39/* Expect to find the "data" chunk within this offset from the start. */
40#define MAX_DATA_CHUNK_OFFSET 1024
41
42#define WAVE_FORMAT_PCM_ 0x0001
43#define WAVE_FORMAT_IEEE_FLOAT_ 0x0003
44#define WAVE_FORMAT_EXTENSIBLE_ 0xfffe
45
46struct context {
47 gboolean started;
48 int fmt_code;
49 uint64_t samplerate;
50 int samplesize;
51 int num_channels;
52 int unitsize;
53 gboolean found_data;
54 gboolean create_channels;
55};
56
57static int parse_wav_header(GString *buf, struct context *inc)
58{
59 uint64_t samplerate;
60 unsigned int fmt_code, samplesize, num_channels, unitsize;
61
62 if (buf->len < MIN_DATA_CHUNK_OFFSET)
63 return SR_ERR_NA;
64
65 fmt_code = RL16(buf->str + 20);
66 samplerate = RL32(buf->str + 24);
67
68 samplesize = RL16(buf->str + 32);
69 num_channels = RL16(buf->str + 22);
70 if (num_channels == 0)
71 return SR_ERR;
72 unitsize = samplesize / num_channels;
73 if (unitsize != 1 && unitsize != 2 && unitsize != 4) {
74 sr_err("Only 8, 16 or 32 bits per sample supported.");
75 return SR_ERR_DATA;
76 }
77
78 if (fmt_code == WAVE_FORMAT_PCM_) {
79 } else if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_) {
80 if (unitsize != 4) {
81 sr_err("only 32-bit floats supported.");
82 return SR_ERR_DATA;
83 }
84 } else if (fmt_code == WAVE_FORMAT_EXTENSIBLE_) {
85 if (buf->len < 70)
86 /* Not enough for extensible header and next chunk. */
87 return SR_ERR_NA;
88
89 if (RL16(buf->str + 16) != 40) {
90 sr_err("WAV extensible format chunk must be 40 bytes.");
91 return SR_ERR;
92 }
93 if (RL16(buf->str + 36) != 22) {
94 sr_err("WAV extension must be 22 bytes.");
95 return SR_ERR;
96 }
97 if (RL16(buf->str + 34) != RL16(buf->str + 38)) {
98 sr_err("Reduced valid bits per sample not supported.");
99 return SR_ERR_DATA;
100 }
101 /* Real format code is the first two bytes of the GUID. */
102 fmt_code = RL16(buf->str + 44);
103 if (fmt_code != WAVE_FORMAT_PCM_ && fmt_code != WAVE_FORMAT_IEEE_FLOAT_) {
104 sr_err("Only PCM and floating point samples are supported.");
105 return SR_ERR_DATA;
106 }
107 if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_ && unitsize != 4) {
108 sr_err("only 32-bit floats supported.");
109 return SR_ERR_DATA;
110 }
111 } else {
112 sr_err("Only PCM and floating point samples are supported.");
113 return SR_ERR_DATA;
114 }
115
116 if (inc) {
117 inc->fmt_code = fmt_code;
118 inc->samplerate = samplerate;
119 inc->samplesize = samplesize;
120 inc->num_channels = num_channels;
121 inc->unitsize = unitsize;
122 inc->found_data = FALSE;
123 }
124
125 return SR_OK;
126}
127
128static int format_match(GHashTable *metadata, unsigned int *confidence)
129{
130 GString *buf;
131 int ret;
132
133 buf = g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_HEADER));
134 if (strncmp(buf->str, "RIFF", 4))
135 return SR_ERR;
136 if (strncmp(buf->str + 8, "WAVE", 4))
137 return SR_ERR;
138 if (strncmp(buf->str + 12, "fmt ", 4))
139 return SR_ERR;
140 /*
141 * Only gets called when we already know this is a WAV file, so
142 * this parser can log error messages.
143 */
144 if ((ret = parse_wav_header(buf, NULL)) != SR_OK)
145 return ret;
146
147 *confidence = 1;
148
149 return SR_OK;
150}
151
152static int init(struct sr_input *in, GHashTable *options)
153{
154 struct context *inc;
155
156 (void)options;
157
158 in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
159 in->priv = g_malloc0(sizeof(struct context));
160 inc = in->priv;
161
162 inc->create_channels = TRUE;
163
164 return SR_OK;
165}
166
167static int find_data_chunk(GString *buf, int initial_offset)
168{
169 unsigned int offset, i;
170
171 offset = initial_offset;
172 while (offset < MIN(MAX_DATA_CHUNK_OFFSET, buf->len)) {
173 if (!memcmp(buf->str + offset, "data", 4))
174 /* Skip into the samples. */
175 return offset + 8;
176 for (i = 0; i < 4; i++) {
177 if (!isalnum(buf->str[offset + i])
178 && !isblank(buf->str[offset + i]))
179 /* Doesn't look like a chunk ID. */
180 return -1;
181 }
182 /* Skip past this chunk. */
183 offset += 8 + RL32(buf->str + offset + 4);
184 }
185
186 if (offset > MAX_DATA_CHUNK_OFFSET)
187 return -1;
188
189 return offset;
190}
191
192static void send_chunk(const struct sr_input *in, int offset, int num_samples)
193{
194 struct sr_datafeed_packet packet;
195 struct sr_datafeed_analog analog;
196 struct sr_analog_encoding encoding;
197 struct sr_analog_meaning meaning;
198 struct sr_analog_spec spec;
199 struct context *inc;
200 float *fdata;
201 int total_samples, samplenum;
202 char *s, *d;
203
204 inc = in->priv;
205
206 total_samples = num_samples * inc->num_channels;
207 fdata = g_malloc0(total_samples * sizeof(float));
208 s = in->buf->str + offset;
209 d = (char *)fdata;
210
211 for (samplenum = 0; samplenum < total_samples; samplenum++) {
212 if (inc->fmt_code == WAVE_FORMAT_PCM_) {
213 switch (inc->unitsize) {
214 case 1:
215 /* 8-bit PCM samples are unsigned. */
216 fdata[samplenum] = *(uint8_t*)(s) / (float)255;
217 break;
218 case 2:
219 fdata[samplenum] = RL16S(s) / (float)INT16_MAX;
220 break;
221 case 4:
222 fdata[samplenum] = RL32S(s) / (float)INT32_MAX;
223 break;
224 }
225 } else {
226 /* BINARY32 float */
227#ifdef WORDS_BIGENDIAN
228 int i;
229 for (i = 0; i < inc->unitsize; i++)
230 d[i] = s[inc->unitsize - 1 - i];
231#else
232 memcpy(d, s, inc->unitsize);
233#endif
234 }
235 s += inc->unitsize;
236 d += inc->unitsize;
237 }
238
239 /* TODO: Use proper 'digits' value for this device (and its modes). */
240 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
241 packet.type = SR_DF_ANALOG;
242 packet.payload = &analog;
243 analog.num_samples = num_samples;
244 analog.data = fdata;
245 analog.meaning->channels = in->sdi->channels;
246 analog.meaning->mq = 0;
247 analog.meaning->mqflags = 0;
248 analog.meaning->unit = 0;
249 sr_session_send(in->sdi, &packet);
250 g_free(fdata);
251}
252
253static int process_buffer(struct sr_input *in)
254{
255 struct context *inc;
256 int offset, chunk_samples, total_samples, processed, max_chunk_samples;
257 int num_samples, i;
258
259 inc = in->priv;
260 if (!inc->started) {
261 std_session_send_df_header(in->sdi);
262 (void)sr_session_send_meta(in->sdi, SR_CONF_SAMPLERATE,
263 g_variant_new_uint64(inc->samplerate));
264 inc->started = TRUE;
265 }
266
267 if (!inc->found_data) {
268 /* Skip past size of 'fmt ' chunk. */
269 i = 20 + RL32(in->buf->str + 16);
270 offset = find_data_chunk(in->buf, i);
271 if (offset < 0) {
272 if (in->buf->len > MAX_DATA_CHUNK_OFFSET) {
273 sr_err("Couldn't find data chunk.");
274 return SR_ERR;
275 }
276 }
277 inc->found_data = TRUE;
278 } else
279 offset = 0;
280
281 /* Round off up to the last channels * unitsize boundary. */
282 chunk_samples = (in->buf->len - offset) / inc->samplesize;
283 max_chunk_samples = CHUNK_SIZE / inc->samplesize;
284 processed = 0;
285 total_samples = chunk_samples;
286 while (processed < total_samples) {
287 if (chunk_samples > max_chunk_samples)
288 num_samples = max_chunk_samples;
289 else
290 num_samples = chunk_samples;
291 send_chunk(in, offset, num_samples);
292 offset += num_samples * inc->samplesize;
293 chunk_samples -= num_samples;
294 processed += num_samples;
295 }
296
297 if ((unsigned int)offset < in->buf->len) {
298 /*
299 * The incoming buffer wasn't processed completely. Stash
300 * the leftover data for next time.
301 */
302 g_string_erase(in->buf, 0, offset);
303 } else
304 g_string_truncate(in->buf, 0);
305
306 return SR_OK;
307}
308
309static int receive(struct sr_input *in, GString *buf)
310{
311 struct context *inc;
312 int ret;
313 char channelname[16];
314
315 g_string_append_len(in->buf, buf->str, buf->len);
316
317 if (in->buf->len < MIN_DATA_CHUNK_OFFSET) {
318 /*
319 * Don't even try until there's enough room
320 * for the data segment to start.
321 */
322 return SR_OK;
323 }
324
325 inc = in->priv;
326 if (!in->sdi_ready) {
327 if ((ret = parse_wav_header(in->buf, inc)) == SR_ERR_NA)
328 /* Not enough data yet. */
329 return SR_OK;
330 else if (ret != SR_OK)
331 return ret;
332
333 if (inc->create_channels) {
334 for (int i = 0; i < inc->num_channels; i++) {
335 snprintf(channelname, sizeof(channelname), "CH%d", i + 1);
336 sr_channel_new(in->sdi, i, SR_CHANNEL_ANALOG, TRUE, channelname);
337 }
338 }
339
340 inc->create_channels = FALSE;
341
342 /* sdi is ready, notify frontend. */
343 in->sdi_ready = TRUE;
344 return SR_OK;
345 }
346
347 ret = process_buffer(in);
348
349 return ret;
350}
351
352static int end(struct sr_input *in)
353{
354 struct context *inc;
355 int ret;
356
357 if (in->sdi_ready)
358 ret = process_buffer(in);
359 else
360 ret = SR_OK;
361
362 inc = in->priv;
363 if (inc->started)
364 std_session_send_df_end(in->sdi);
365
366 return ret;
367}
368
369static int reset(struct sr_input *in)
370{
371 memset(in->priv, 0, sizeof(struct context));
372
373 /*
374 * We only want to create the sigrok channels once, so
375 * inc->create_channels won't be set to TRUE this time around.
376 */
377
378 g_string_truncate(in->buf, 0);
379
380 return SR_OK;
381}
382
383SR_PRIV struct sr_input_module input_wav = {
384 .id = "wav",
385 .name = "WAV",
386 .desc = "Microsoft WAV file format data",
387 .exts = (const char*[]){"wav", NULL},
388 .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED },
389 .format_match = format_match,
390 .init = init,
391 .receive = receive,
392 .end = end,
393 .reset = reset,
394};