]> sigrok.org Git - libsigrok.git/blobdiff - src/input/wav.c
wav: Don't assume CHUNK_SIZE >= total_samples
[libsigrok.git] / src / input / wav.c
index b6a7e5185add90c6eb2d8ccd7d69b4e285468a44..66dfce98e84a47f26fcf11827d9072c2e12fad51 100644 (file)
@@ -17,6 +17,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <unistd.h>
 #include <ctype.h>
 #include <string.h>
 #include <stdint.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 #define LOG_PREFIX "input/wav"
 
 /* How many bytes at a time to process and send to the session bus. */
-#define CHUNK_SIZE 4096
+#define CHUNK_SIZE               (1 * 1024 * 1024 * sizeof(float))
 
 /* Minimum size of header + 1 8-bit mono PCM sample. */
 #define MIN_DATA_CHUNK_OFFSET    45
 
 /* Expect to find the "data" chunk within this offset from the start. */
-#define MAX_DATA_CHUNK_OFFSET    256
+#define MAX_DATA_CHUNK_OFFSET    1024
 
-#define WAVE_FORMAT_PCM          0x0001
-#define WAVE_FORMAT_IEEE_FLOAT   0x0003
-#define WAVE_FORMAT_EXTENSIBLE   0xfffe
+#define WAVE_FORMAT_PCM_         0x0001
+#define WAVE_FORMAT_IEEE_FLOAT_  0x0003
+#define WAVE_FORMAT_EXTENSIBLE_  0xfffe
 
 struct context {
        gboolean started;
@@ -50,6 +51,7 @@ struct context {
        int num_channels;
        int unitsize;
        gboolean found_data;
+       gboolean create_channels;
 };
 
 static int parse_wav_header(GString *buf, struct context *inc)
@@ -73,14 +75,13 @@ static int parse_wav_header(GString *buf, struct context *inc)
                return SR_ERR_DATA;
        }
 
-
-       if (fmt_code == WAVE_FORMAT_PCM) {
-       } else if (fmt_code == WAVE_FORMAT_IEEE_FLOAT) {
+       if (fmt_code == WAVE_FORMAT_PCM_) {
+       } else if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_) {
                if (unitsize != 4) {
                        sr_err("only 32-bit floats supported.");
                        return SR_ERR_DATA;
                }
-       } else if (fmt_code == WAVE_FORMAT_EXTENSIBLE) {
+       } else if (fmt_code == WAVE_FORMAT_EXTENSIBLE_) {
                if (buf->len < 70)
                        /* Not enough for extensible header and next chunk. */
                        return SR_ERR_NA;
@@ -99,11 +100,11 @@ static int parse_wav_header(GString *buf, struct context *inc)
                }
                /* Real format code is the first two bytes of the GUID. */
                fmt_code = RL16(buf->str + 44);
-               if (fmt_code != WAVE_FORMAT_PCM && fmt_code != WAVE_FORMAT_IEEE_FLOAT) {
+               if (fmt_code != WAVE_FORMAT_PCM_ && fmt_code != WAVE_FORMAT_IEEE_FLOAT_) {
                        sr_err("Only PCM and floating point samples are supported.");
                        return SR_ERR_DATA;
                }
-               if (fmt_code == WAVE_FORMAT_IEEE_FLOAT && unitsize != 4) {
+               if (fmt_code == WAVE_FORMAT_IEEE_FLOAT_ && unitsize != 4) {
                        sr_err("only 32-bit floats supported.");
                        return SR_ERR_DATA;
                }
@@ -124,7 +125,7 @@ static int parse_wav_header(GString *buf, struct context *inc)
        return SR_OK;
 }
 
-static int format_match(GHashTable *metadata)
+static int format_match(GHashTable *metadata, unsigned int *confidence)
 {
        GString *buf;
        int ret;
@@ -143,15 +144,22 @@ static int format_match(GHashTable *metadata)
        if ((ret = parse_wav_header(buf, NULL)) != SR_OK)
                return ret;
 
+       *confidence = 1;
+
        return SR_OK;
 }
 
 static int init(struct sr_input *in, GHashTable *options)
 {
+       struct context *inc;
+
        (void)options;
 
-       in->sdi = sr_dev_inst_new(SR_ST_ACTIVE, NULL, NULL, NULL);
+       in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
        in->priv = g_malloc0(sizeof(struct context));
+       inc = in->priv;
+
+       inc->create_channels = TRUE;
 
        return SR_OK;
 }
@@ -161,13 +169,12 @@ static int find_data_chunk(GString *buf, int initial_offset)
        unsigned int offset, i;
 
        offset = initial_offset;
-       while(offset < MIN(MAX_DATA_CHUNK_OFFSET, buf->len)) {
+       while (offset < MIN(MAX_DATA_CHUNK_OFFSET, buf->len)) {
                if (!memcmp(buf->str + offset, "data", 4))
                        /* Skip into the samples. */
                        return offset + 8;
                for (i = 0; i < 4; i++) {
-                       if (!isalpha(buf->str[offset + i])
-                                       && !isascii(buf->str[offset + i])
+                       if (!isalnum(buf->str[offset + i])
                                        && !isblank(buf->str[offset + i]))
                                /* Doesn't look like a chunk ID. */
                                return -1;
@@ -176,6 +183,9 @@ static int find_data_chunk(GString *buf, int initial_offset)
                offset += 8 + RL32(buf->str + offset + 4);
        }
 
+       if (offset > MAX_DATA_CHUNK_OFFSET)
+               return -1;
+
        return offset;
 }
 
@@ -183,32 +193,33 @@ static void send_chunk(const struct sr_input *in, int offset, int num_samples)
 {
        struct sr_datafeed_packet packet;
        struct sr_datafeed_analog analog;
+       struct sr_analog_encoding encoding;
+       struct sr_analog_meaning meaning;
+       struct sr_analog_spec spec;
        struct context *inc;
-       float fdata[CHUNK_SIZE];
-       uint64_t sample;
+       float *fdata;
        int total_samples, samplenum;
        char *s, *d;
 
        inc = in->priv;
 
+       total_samples = num_samples * inc->num_channels;
+       fdata = g_malloc0(total_samples * sizeof(float));
        s = in->buf->str + offset;
        d = (char *)fdata;
-       memset(fdata, 0, CHUNK_SIZE);
-       total_samples = num_samples * inc->num_channels;
+
        for (samplenum = 0; samplenum < total_samples; samplenum++) {
-               if (inc->fmt_code == WAVE_FORMAT_PCM) {
-                       sample = 0;
-                       memcpy(&sample, s, inc->unitsize);
-                       switch (inc->samplesize) {
+               if (inc->fmt_code == WAVE_FORMAT_PCM_) {
+                       switch (inc->unitsize) {
                        case 1:
                                /* 8-bit PCM samples are unsigned. */
-                               fdata[samplenum] = (uint8_t)sample / (float)255;
+                               fdata[samplenum] = *(uint8_t*)(s) / (float)255;
                                break;
                        case 2:
-                               fdata[samplenum] = RL16S(&sample) / (float)INT16_MAX;
+                               fdata[samplenum] = RL16S(s) / (float)INT16_MAX;
                                break;
                        case 4:
-                               fdata[samplenum] = RL32S(&sample) / (float)INT32_MAX;
+                               fdata[samplenum] = RL32S(s) / (float)INT32_MAX;
                                break;
                        }
                } else {
@@ -224,65 +235,40 @@ static void send_chunk(const struct sr_input *in, int offset, int num_samples)
                s += inc->unitsize;
                d += inc->unitsize;
        }
+
+       /* TODO: Use proper 'digits' value for this device (and its modes). */
+       sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
        packet.type = SR_DF_ANALOG;
        packet.payload = &analog;
-       analog.channels = in->sdi->channels;
        analog.num_samples = num_samples;
-       analog.mq = 0;
-       analog.mqflags = 0;
-       analog.unit = 0;
        analog.data = fdata;
+       analog.meaning->channels = in->sdi->channels;
+       analog.meaning->mq = 0;
+       analog.meaning->mqflags = 0;
+       analog.meaning->unit = 0;
        sr_session_send(in->sdi, &packet);
+       g_free(fdata);
 }
 
-static int receive(struct sr_input *in, GString *buf)
+static int process_buffer(struct sr_input *in)
 {
+       struct context *inc;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_meta meta;
-       struct sr_channel *ch;
        struct sr_config *src;
-       struct context *inc;
        int offset, chunk_samples, total_samples, processed, max_chunk_samples;
-       int num_samples, ret, i;
-       char channelname[8];
-
-       g_string_append_len(in->buf, buf->str, buf->len);
-
-       if (in->buf->len < MIN_DATA_CHUNK_OFFSET) {
-               /*
-                * Don't even try until there's enough room
-                * for the data segment to start.
-                */
-               return SR_OK;
-       }
+       int num_samples, i;
 
        inc = in->priv;
-       if (!in->sdi_ready) {
-               if ((ret = parse_wav_header(in->buf, inc)) == SR_ERR_NA)
-                       /* Not enough data yet. */
-                       return SR_OK;
-               else if (ret != SR_OK)
-                       return ret;
-
-               /* sdi is ready, notify frontend. */
-               in->sdi_ready = TRUE;
-               return SR_OK;
-       }
-
        if (!inc->started) {
-               for (i = 0; i < inc->num_channels; i++) {
-                       snprintf(channelname, 8, "CH%d", i + 1);
-                       ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE, channelname);
-                       in->sdi->channels = g_slist_append(in->sdi->channels, ch);
-               }
-
-               std_session_send_df_header(in->sdi, LOG_PREFIX);
+               std_session_send_df_header(in->sdi);
 
                packet.type = SR_DF_META;
                packet.payload = &meta;
                src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(inc->samplerate));
                meta.config = g_slist_append(NULL, src);
                sr_session_send(in->sdi, &packet);
+               g_slist_free(meta.config);
                sr_config_free(src);
 
                inc->started = TRUE;
@@ -303,8 +289,8 @@ static int receive(struct sr_input *in, GString *buf)
                offset = 0;
 
        /* Round off up to the last channels * unitsize boundary. */
-       chunk_samples = (in->buf->len - offset) / inc->num_channels / inc->unitsize;
-       max_chunk_samples = CHUNK_SIZE / inc->num_channels / inc->unitsize;
+       chunk_samples = (in->buf->len - offset) / inc->samplesize;
+       max_chunk_samples = CHUNK_SIZE / inc->samplesize;
        processed = 0;
        total_samples = chunk_samples;
        while (processed < total_samples) {
@@ -313,7 +299,7 @@ static int receive(struct sr_input *in, GString *buf)
                else
                        num_samples = chunk_samples;
                send_chunk(in, offset, num_samples);
-               offset += num_samples * inc->unitsize;
+               offset += num_samples * inc->samplesize;
                chunk_samples -= num_samples;
                processed += num_samples;
        }
@@ -330,19 +316,76 @@ static int receive(struct sr_input *in, GString *buf)
        return SR_OK;
 }
 
-static int cleanup(struct sr_input *in)
+static int receive(struct sr_input *in, GString *buf)
 {
-       struct sr_datafeed_packet packet;
        struct context *inc;
+       int ret;
+       char channelname[8];
+
+       g_string_append_len(in->buf, buf->str, buf->len);
+
+       if (in->buf->len < MIN_DATA_CHUNK_OFFSET) {
+               /*
+                * Don't even try until there's enough room
+                * for the data segment to start.
+                */
+               return SR_OK;
+       }
 
        inc = in->priv;
-       if (inc->started) {
-               /* End of stream. */
-               packet.type = SR_DF_END;
-               sr_session_send(in->sdi, &packet);
+       if (!in->sdi_ready) {
+               if ((ret = parse_wav_header(in->buf, inc)) == SR_ERR_NA)
+                       /* Not enough data yet. */
+                       return SR_OK;
+               else if (ret != SR_OK)
+                       return ret;
+
+               if (inc->create_channels) {
+                       for (int i = 0; i < inc->num_channels; i++) {
+                               snprintf(channelname, sizeof(channelname), "CH%d", i + 1);
+                               sr_channel_new(in->sdi, i, SR_CHANNEL_ANALOG, TRUE, channelname);
+                       }
+               }
+
+               inc->create_channels = FALSE;
+
+               /* sdi is ready, notify frontend. */
+               in->sdi_ready = TRUE;
+               return SR_OK;
        }
-       g_free(in->priv);
-       in->priv = NULL;
+
+       ret = process_buffer(in);
+
+       return ret;
+}
+
+static int end(struct sr_input *in)
+{
+       struct context *inc;
+       int ret;
+
+       if (in->sdi_ready)
+               ret = process_buffer(in);
+       else
+               ret = SR_OK;
+
+       inc = in->priv;
+       if (inc->started)
+               std_session_send_df_end(in->sdi);
+
+       return ret;
+}
+
+static int reset(struct sr_input *in)
+{
+       memset(in->priv, 0, sizeof(struct context));
+
+       /*
+        * We only want to create the sigrok channels once, so
+        * inc->create_channels won't be set to TRUE this time around.
+        */
+
+       g_string_truncate(in->buf, 0);
 
        return SR_OK;
 }
@@ -350,11 +393,12 @@ static int cleanup(struct sr_input *in)
 SR_PRIV struct sr_input_module input_wav = {
        .id = "wav",
        .name = "WAV",
-       .desc = "WAV file",
+       .desc = "Microsoft WAV file format data",
+       .exts = (const char*[]){"wav", NULL},
        .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED },
        .format_match = format_match,
        .init = init,
        .receive = receive,
-       .cleanup = cleanup,
+       .end = end,
+       .reset = reset,
 };
-