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