2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include <sys/types.h>
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "input/wav"
33 /* How many bytes at a time to process and send to the session bus. */
34 #define CHUNK_SIZE (1 * 1024 * 1024 * sizeof(float))
36 /* Minimum size of header + 1 8-bit mono PCM sample. */
37 #define MIN_DATA_CHUNK_OFFSET 45
39 /* Expect to find the "data" chunk within this offset from the start. */
40 #define MAX_DATA_CHUNK_OFFSET 1024
42 #define WAVE_FORMAT_PCM_ 0x0001
43 #define WAVE_FORMAT_IEEE_FLOAT_ 0x0003
44 #define WAVE_FORMAT_EXTENSIBLE_ 0xfffe
54 GSList *prev_sr_channels;
57 static int parse_wav_header(GString *buf, struct context *inc)
60 unsigned int fmt_code, samplesize, num_channels, unitsize;
62 if (buf->len < MIN_DATA_CHUNK_OFFSET)
65 fmt_code = RL16(buf->str + 20);
66 samplerate = RL32(buf->str + 24);
68 samplesize = RL16(buf->str + 32);
69 num_channels = RL16(buf->str + 22);
70 if (num_channels == 0)
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.");
78 if (fmt_code == WAVE_FORMAT_PCM_) {
79 } else if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_) {
81 sr_err("only 32-bit floats supported.");
84 } else if (fmt_code == WAVE_FORMAT_EXTENSIBLE_) {
86 /* Not enough for extensible header and next chunk. */
89 if (RL16(buf->str + 16) != 40) {
90 sr_err("WAV extensible format chunk must be 40 bytes.");
93 if (RL16(buf->str + 36) != 22) {
94 sr_err("WAV extension must be 22 bytes.");
97 if (RL16(buf->str + 34) != RL16(buf->str + 38)) {
98 sr_err("Reduced valid bits per sample not supported.");
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.");
107 if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_ && unitsize != 4) {
108 sr_err("only 32-bit floats supported.");
112 sr_err("Only PCM and floating point samples are supported.");
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;
128 static int format_match(GHashTable *metadata, unsigned int *confidence)
133 buf = g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_HEADER));
134 if (strncmp(buf->str, "RIFF", 4))
136 if (strncmp(buf->str + 8, "WAVE", 4))
138 if (strncmp(buf->str + 12, "fmt ", 4))
141 * Only gets called when we already know this is a WAV file, so
142 * this parser can log error messages.
144 if ((ret = parse_wav_header(buf, NULL)) != SR_OK)
152 static int init(struct sr_input *in, GHashTable *options)
156 in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
157 in->priv = g_malloc0(sizeof(struct context));
162 static int find_data_chunk(GString *buf, int initial_offset)
164 unsigned int offset, i;
166 offset = initial_offset;
167 while (offset < MIN(MAX_DATA_CHUNK_OFFSET, buf->len)) {
168 if (!memcmp(buf->str + offset, "data", 4))
169 /* Skip into the samples. */
171 for (i = 0; i < 4; i++) {
172 if (!isalnum(buf->str[offset + i])
173 && !isblank(buf->str[offset + i]))
174 /* Doesn't look like a chunk ID. */
177 /* Skip past this chunk. */
178 offset += 8 + RL32(buf->str + offset + 4);
181 if (offset > MAX_DATA_CHUNK_OFFSET)
187 static void send_chunk(const struct sr_input *in, int offset, int num_samples)
189 struct sr_datafeed_packet packet;
190 struct sr_datafeed_analog analog;
191 struct sr_analog_encoding encoding;
192 struct sr_analog_meaning meaning;
193 struct sr_analog_spec spec;
196 int total_samples, samplenum;
201 total_samples = num_samples * inc->num_channels;
202 fdata = g_malloc0(total_samples * sizeof(float));
203 s = in->buf->str + offset;
206 for (samplenum = 0; samplenum < total_samples; samplenum++) {
207 if (inc->fmt_code == WAVE_FORMAT_PCM_) {
208 switch (inc->unitsize) {
210 /* 8-bit PCM samples are unsigned. */
211 fdata[samplenum] = *(uint8_t*)(s) / (float)255;
214 fdata[samplenum] = RL16S(s) / (float)INT16_MAX;
217 fdata[samplenum] = RL32S(s) / (float)INT32_MAX;
222 #ifdef WORDS_BIGENDIAN
224 for (i = 0; i < inc->unitsize; i++)
225 d[i] = s[inc->unitsize - 1 - i];
227 memcpy(d, s, inc->unitsize);
234 /* TODO: Use proper 'digits' value for this device (and its modes). */
235 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
236 packet.type = SR_DF_ANALOG;
237 packet.payload = &analog;
238 analog.num_samples = num_samples;
240 analog.meaning->channels = in->sdi->channels;
241 analog.meaning->mq = 0;
242 analog.meaning->mqflags = 0;
243 analog.meaning->unit = 0;
244 sr_session_send(in->sdi, &packet);
248 static int process_buffer(struct sr_input *in)
251 int offset, chunk_samples, total_samples, processed, max_chunk_samples;
256 std_session_send_df_header(in->sdi);
257 (void)sr_session_send_meta(in->sdi, SR_CONF_SAMPLERATE,
258 g_variant_new_uint64(inc->samplerate));
262 if (!inc->found_data) {
263 /* Skip past size of 'fmt ' chunk. */
264 i = 20 + RL32(in->buf->str + 16);
265 offset = find_data_chunk(in->buf, i);
267 if (in->buf->len > MAX_DATA_CHUNK_OFFSET) {
268 sr_err("Couldn't find data chunk.");
272 inc->found_data = TRUE;
276 /* Round off up to the last channels * unitsize boundary. */
277 chunk_samples = (in->buf->len - offset) / inc->samplesize;
278 max_chunk_samples = CHUNK_SIZE / inc->samplesize;
280 total_samples = chunk_samples;
281 while (processed < total_samples) {
282 if (chunk_samples > max_chunk_samples)
283 num_samples = max_chunk_samples;
285 num_samples = chunk_samples;
286 send_chunk(in, offset, num_samples);
287 offset += num_samples * inc->samplesize;
288 chunk_samples -= num_samples;
289 processed += num_samples;
292 if ((unsigned int)offset < in->buf->len) {
294 * The incoming buffer wasn't processed completely. Stash
295 * the leftover data for next time.
297 g_string_erase(in->buf, 0, offset);
299 g_string_truncate(in->buf, 0);
305 * Check the channel list for consistency across file re-import. See
306 * the VCD input module for more details and motivation.
309 static void keep_header_for_reread(const struct sr_input *in)
314 g_slist_free_full(inc->prev_sr_channels, sr_channel_free_cb);
315 inc->prev_sr_channels = in->sdi->channels;
316 in->sdi->channels = NULL;
319 static int check_header_in_reread(const struct sr_input *in)
328 if (!inc->prev_sr_channels)
331 if (sr_channel_lists_differ(inc->prev_sr_channels, in->sdi->channels)) {
332 sr_err("Channel list change not supported for file re-read.");
335 g_slist_free_full(in->sdi->channels, sr_channel_free_cb);
336 in->sdi->channels = inc->prev_sr_channels;
337 inc->prev_sr_channels = NULL;
342 static int receive(struct sr_input *in, GString *buf)
346 char channelname[16];
348 g_string_append_len(in->buf, buf->str, buf->len);
350 if (in->buf->len < MIN_DATA_CHUNK_OFFSET) {
352 * Don't even try until there's enough room
353 * for the data segment to start.
359 if (!in->sdi_ready) {
360 if ((ret = parse_wav_header(in->buf, inc)) == SR_ERR_NA)
361 /* Not enough data yet. */
363 else if (ret != SR_OK)
366 for (int i = 0; i < inc->num_channels; i++) {
367 snprintf(channelname, sizeof(channelname), "CH%d", i + 1);
368 sr_channel_new(in->sdi, i, SR_CHANNEL_ANALOG, TRUE, channelname);
370 if (!check_header_in_reread(in))
373 /* sdi is ready, notify frontend. */
374 in->sdi_ready = TRUE;
378 ret = process_buffer(in);
383 static int end(struct sr_input *in)
389 ret = process_buffer(in);
395 std_session_send_df_end(in->sdi);
400 static int reset(struct sr_input *in)
405 memset(inc, 0, sizeof(*inc));
408 * Create, and re-create channels for every iteration of file
409 * import. Other logic will enforce a consistent set of channels
410 * across re-import, or an appropriate error message when file
411 * properties should change.
413 keep_header_for_reread(in);
415 g_string_truncate(in->buf, 0);
420 SR_PRIV struct sr_input_module input_wav = {
423 .desc = "Microsoft WAV file format data",
424 .exts = (const char*[]){"wav", NULL},
425 .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED },
426 .format_match = format_match,