]> sigrok.org Git - libsigrok.git/blame - src/input/wav.c
Factor out std_session_send_df_end() helper.
[libsigrok.git] / src / input / wav.c
CommitLineData
1d36b4d2 1/*
50985c20 2 * This file is part of the libsigrok project.
1d36b4d2
BV
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
6ec6c43b 20#include <config.h>
1d36b4d2
BV
21#include <sys/types.h>
22#include <sys/stat.h>
23#include <unistd.h>
24#include <fcntl.h>
cb41a838 25#include <ctype.h>
1d36b4d2 26#include <string.h>
962d4344 27#include <stdint.h>
c1aae900 28#include <libsigrok/libsigrok.h>
1d36b4d2
BV
29#include "libsigrok-internal.h"
30
3544f848 31#define LOG_PREFIX "input/wav"
1d36b4d2 32
cb41a838 33/* How many bytes at a time to process and send to the session bus. */
1d36b4d2 34#define CHUNK_SIZE 4096
17bfaca6
BV
35
36/* Minimum size of header + 1 8-bit mono PCM sample. */
37#define MIN_DATA_CHUNK_OFFSET 45
38
cb41a838 39/* Expect to find the "data" chunk within this offset from the start. */
b944e336 40#define MAX_DATA_CHUNK_OFFSET 1024
cb41a838 41
76598cda
UH
42#define WAVE_FORMAT_PCM_ 0x0001
43#define WAVE_FORMAT_IEEE_FLOAT_ 0x0003
44#define WAVE_FORMAT_EXTENSIBLE_ 0xfffe
1d36b4d2
BV
45
46struct context {
d0181813 47 gboolean started;
17bfaca6 48 int fmt_code;
1d36b4d2
BV
49 uint64_t samplerate;
50 int samplesize;
51 int num_channels;
cb41a838 52 int unitsize;
17bfaca6 53 gboolean found_data;
1d36b4d2
BV
54};
55
17bfaca6 56static int parse_wav_header(GString *buf, struct context *inc)
1d36b4d2 57{
17bfaca6 58 uint64_t samplerate;
cbd9e6e9 59 unsigned int fmt_code, samplesize, num_channels, unitsize;
1d36b4d2 60
cbd9e6e9 61 if (buf->len < MIN_DATA_CHUNK_OFFSET)
d0181813 62 return SR_ERR_NA;
1d36b4d2 63
962d4344
BV
64 fmt_code = RL16(buf->str + 20);
65 samplerate = RL32(buf->str + 24);
cbd9e6e9 66
962d4344
BV
67 samplesize = RL16(buf->str + 32);
68 num_channels = RL16(buf->str + 22);
cbd9e6e9
BV
69 if (num_channels == 0)
70 return SR_ERR;
17bfaca6 71 unitsize = samplesize / num_channels;
e8779db7
BV
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
76598cda
UH
77 if (fmt_code == WAVE_FORMAT_PCM_) {
78 } else if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_) {
17bfaca6
BV
79 if (unitsize != 4) {
80 sr_err("only 32-bit floats supported.");
4f979115 81 return SR_ERR_DATA;
17bfaca6 82 }
76598cda 83 } else if (fmt_code == WAVE_FORMAT_EXTENSIBLE_) {
cbd9e6e9
BV
84 if (buf->len < 70)
85 /* Not enough for extensible header and next chunk. */
d0181813 86 return SR_ERR_NA;
cbd9e6e9
BV
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.");
4f979115 98 return SR_ERR_DATA;
cbd9e6e9
BV
99 }
100 /* Real format code is the first two bytes of the GUID. */
101 fmt_code = RL16(buf->str + 44);
76598cda 102 if (fmt_code != WAVE_FORMAT_PCM_ && fmt_code != WAVE_FORMAT_IEEE_FLOAT_) {
cbd9e6e9 103 sr_err("Only PCM and floating point samples are supported.");
4f979115 104 return SR_ERR_DATA;
cbd9e6e9 105 }
76598cda 106 if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_ && unitsize != 4) {
28d9df72
MC
107 sr_err("only 32-bit floats supported.");
108 return SR_ERR_DATA;
109 }
17bfaca6
BV
110 } else {
111 sr_err("Only PCM and floating point samples are supported.");
4f979115 112 return SR_ERR_DATA;
17bfaca6 113 }
1d36b4d2 114
17bfaca6
BV
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 }
1d36b4d2
BV
123
124 return SR_OK;
125}
126
17bfaca6 127static int format_match(GHashTable *metadata)
1d36b4d2 128{
17bfaca6 129 GString *buf;
4f979115 130 int ret;
1d36b4d2 131
17bfaca6
BV
132 buf = g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_HEADER));
133 if (strncmp(buf->str, "RIFF", 4))
4f979115 134 return SR_ERR;
17bfaca6 135 if (strncmp(buf->str + 8, "WAVE", 4))
4f979115 136 return SR_ERR;
17bfaca6 137 if (strncmp(buf->str + 12, "fmt ", 4))
4f979115 138 return SR_ERR;
17bfaca6
BV
139 /*
140 * Only gets called when we already know this is a WAV file, so
141 * this parser can log error messages.
142 */
4f979115
BV
143 if ((ret = parse_wav_header(buf, NULL)) != SR_OK)
144 return ret;
1d36b4d2 145
4f979115 146 return SR_OK;
1d36b4d2
BV
147}
148
17bfaca6 149static int init(struct sr_input *in, GHashTable *options)
1d36b4d2 150{
17bfaca6 151 (void)options;
1d36b4d2 152
aac29cc1 153 in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
d0181813 154 in->priv = g_malloc0(sizeof(struct context));
1d36b4d2
BV
155
156 return SR_OK;
157}
158
17bfaca6 159static int find_data_chunk(GString *buf, int initial_offset)
cb41a838 160{
17bfaca6 161 unsigned int offset, i;
cb41a838
BV
162
163 offset = initial_offset;
0c5f2abc 164 while (offset < MIN(MAX_DATA_CHUNK_OFFSET, buf->len)) {
17bfaca6 165 if (!memcmp(buf->str + offset, "data", 4))
cb41a838
BV
166 /* Skip into the samples. */
167 return offset + 8;
168 for (i = 0; i < 4; i++) {
94b138a3 169 if (!isalnum(buf->str[offset + i])
17bfaca6 170 && !isblank(buf->str[offset + i]))
cb41a838
BV
171 /* Doesn't look like a chunk ID. */
172 return -1;
173 }
174 /* Skip past this chunk. */
962d4344 175 offset += 8 + RL32(buf->str + offset + 4);
cb41a838
BV
176 }
177
b944e336
SB
178 if (offset > MAX_DATA_CHUNK_OFFSET)
179 return -1;
180
cb41a838
BV
181 return offset;
182}
183
17bfaca6
BV
184static void send_chunk(const struct sr_input *in, int offset, int num_samples)
185{
186 struct sr_datafeed_packet packet;
5faebab2 187 struct sr_datafeed_analog_old analog;
17bfaca6
BV
188 struct context *inc;
189 float fdata[CHUNK_SIZE];
17bfaca6
BV
190 int total_samples, samplenum;
191 char *s, *d;
1d36b4d2 192
7db06394 193 inc = in->priv;
17bfaca6
BV
194
195 s = in->buf->str + offset;
196 d = (char *)fdata;
cb41a838 197 memset(fdata, 0, CHUNK_SIZE);
17bfaca6
BV
198 total_samples = num_samples * inc->num_channels;
199 for (samplenum = 0; samplenum < total_samples; samplenum++) {
76598cda 200 if (inc->fmt_code == WAVE_FORMAT_PCM_) {
8b5aefc6 201 switch (inc->unitsize) {
17bfaca6
BV
202 case 1:
203 /* 8-bit PCM samples are unsigned. */
8b5aefc6 204 fdata[samplenum] = *(uint8_t*)(s) / (float)255;
17bfaca6
BV
205 break;
206 case 2:
8b5aefc6 207 fdata[samplenum] = RL16S(s) / (float)INT16_MAX;
17bfaca6
BV
208 break;
209 case 4:
8b5aefc6 210 fdata[samplenum] = RL32S(s) / (float)INT32_MAX;
17bfaca6
BV
211 break;
212 }
213 } else {
214 /* BINARY32 float */
cb41a838 215#ifdef WORDS_BIGENDIAN
28d9df72 216 int i;
17bfaca6 217 for (i = 0; i < inc->unitsize; i++)
28d9df72 218 d[i] = s[inc->unitsize - 1 - i];
cb41a838 219#else
17bfaca6 220 memcpy(d, s, inc->unitsize);
cb41a838 221#endif
1d36b4d2 222 }
17bfaca6
BV
223 s += inc->unitsize;
224 d += inc->unitsize;
225 }
5faebab2 226 packet.type = SR_DF_ANALOG_OLD;
17bfaca6
BV
227 packet.payload = &analog;
228 analog.channels = in->sdi->channels;
229 analog.num_samples = num_samples;
230 analog.mq = 0;
231 analog.mqflags = 0;
232 analog.unit = 0;
233 analog.data = fdata;
234 sr_session_send(in->sdi, &packet);
235}
236
7066fd46 237static int process_buffer(struct sr_input *in)
17bfaca6 238{
7066fd46 239 struct context *inc;
d0181813
BV
240 struct sr_datafeed_packet packet;
241 struct sr_datafeed_meta meta;
d0181813 242 struct sr_config *src;
d0181813 243 int offset, chunk_samples, total_samples, processed, max_chunk_samples;
7066fd46 244 int num_samples, i;
17bfaca6 245
d0181813 246 inc = in->priv;
d0181813 247 if (!inc->started) {
d0181813
BV
248 std_session_send_df_header(in->sdi, LOG_PREFIX);
249
250 packet.type = SR_DF_META;
251 packet.payload = &meta;
252 src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(inc->samplerate));
253 meta.config = g_slist_append(NULL, src);
254 sr_session_send(in->sdi, &packet);
c01378c9 255 g_slist_free(meta.config);
d0181813
BV
256 sr_config_free(src);
257
258 inc->started = TRUE;
17bfaca6 259 }
17bfaca6
BV
260
261 if (!inc->found_data) {
262 /* Skip past size of 'fmt ' chunk. */
962d4344 263 i = 20 + RL32(in->buf->str + 16);
17bfaca6
BV
264 offset = find_data_chunk(in->buf, i);
265 if (offset < 0) {
266 if (in->buf->len > MAX_DATA_CHUNK_OFFSET) {
267 sr_err("Couldn't find data chunk.");
268 return SR_ERR;
269 }
270 }
271 inc->found_data = TRUE;
272 } else
273 offset = 0;
274
275 /* Round off up to the last channels * unitsize boundary. */
288f8ce2
SB
276 chunk_samples = (in->buf->len - offset) / inc->samplesize;
277 max_chunk_samples = CHUNK_SIZE / inc->samplesize;
17bfaca6
BV
278 processed = 0;
279 total_samples = chunk_samples;
280 while (processed < total_samples) {
281 if (chunk_samples > max_chunk_samples)
282 num_samples = max_chunk_samples;
283 else
284 num_samples = chunk_samples;
285 send_chunk(in, offset, num_samples);
288f8ce2 286 offset += num_samples * inc->samplesize;
17bfaca6
BV
287 chunk_samples -= num_samples;
288 processed += num_samples;
289 }
290
291 if ((unsigned int)offset < in->buf->len) {
292 /*
293 * The incoming buffer wasn't processed completely. Stash
294 * the leftover data for next time.
295 */
296 g_string_erase(in->buf, 0, offset);
297 } else
298 g_string_truncate(in->buf, 0);
1d36b4d2
BV
299
300 return SR_OK;
301}
302
7066fd46
BV
303static int receive(struct sr_input *in, GString *buf)
304{
305 struct context *inc;
306 int ret;
74c9a8d2 307 char channelname[8];
7066fd46
BV
308
309 g_string_append_len(in->buf, buf->str, buf->len);
310
311 if (in->buf->len < MIN_DATA_CHUNK_OFFSET) {
312 /*
313 * Don't even try until there's enough room
314 * for the data segment to start.
315 */
316 return SR_OK;
317 }
318
319 inc = in->priv;
320 if (!in->sdi_ready) {
321 if ((ret = parse_wav_header(in->buf, inc)) == SR_ERR_NA)
322 /* Not enough data yet. */
323 return SR_OK;
324 else if (ret != SR_OK)
325 return ret;
326
74c9a8d2
SB
327 for (int i = 0; i < inc->num_channels; i++) {
328 snprintf(channelname, 8, "CH%d", i + 1);
329 sr_channel_new(in->sdi, i, SR_CHANNEL_ANALOG, TRUE, channelname);
330 }
331
7066fd46
BV
332 /* sdi is ready, notify frontend. */
333 in->sdi_ready = TRUE;
334 return SR_OK;
335 }
336
337 ret = process_buffer(in);
338
18078d05 339 return ret;
7066fd46
BV
340}
341
342static int end(struct sr_input *in)
7db06394 343{
d0181813 344 struct context *inc;
7066fd46
BV
345 int ret;
346
347 if (in->sdi_ready)
348 ret = process_buffer(in);
349 else
350 ret = SR_OK;
0a4d68f7 351
d0181813 352 inc = in->priv;
3be42bc2
UH
353 if (inc->started)
354 std_session_send_df_end(in->sdi, LOG_PREFIX);
7db06394 355
7066fd46 356 return ret;
7db06394
BV
357}
358
d4c93774 359SR_PRIV struct sr_input_module input_wav = {
1d36b4d2 360 .id = "wav",
17bfaca6
BV
361 .name = "WAV",
362 .desc = "WAV file",
c7bc82ff 363 .exts = (const char*[]){"wav", NULL},
17bfaca6 364 .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED },
1d36b4d2
BV
365 .format_match = format_match,
366 .init = init,
17bfaca6 367 .receive = receive,
7066fd46 368 .end = end,
1d36b4d2 369};