]> sigrok.org Git - libsigrok.git/blobdiff - src/input/csv.c
input/csv: add channel list checks for file re-read
[libsigrok.git] / src / input / csv.c
index ad18e32293cde662cedbc55994dc84ce5350b9ae..2fffc50394fb6b39765f45561160b686f90c8d75 100644 (file)
@@ -26,7 +26,7 @@
 
 #define LOG_PREFIX "input/csv"
 
-#define DATAFEED_MAX_SAMPLES   (128 * 1024)
+#define CHUNK_SIZE     (4 * 1024 * 1024)
 
 /*
  * The CSV input module has the following options:
@@ -167,6 +167,9 @@ struct context {
 
        /* Current line number. */
        size_t line_number;
+
+       /* List of previously created sigrok channels. */
+       GSList *prev_sr_channels;
 };
 
 static void strip_comment(char *buf, const GString *prefix)
@@ -504,6 +507,44 @@ static int init(struct sr_input *in, GHashTable *options)
        return SR_OK;
 }
 
+/*
+ * Check the channel list for consistency across file re-import. See
+ * the VCD input module for more details and motivation.
+ */
+
+static void keep_header_for_reread(const struct sr_input *in)
+{
+       struct context *inc;
+
+       inc = in->priv;
+       g_slist_free_full(inc->prev_sr_channels, sr_channel_free_cb);
+       inc->prev_sr_channels = in->sdi->channels;
+       in->sdi->channels = NULL;
+}
+
+static int check_header_in_reread(const struct sr_input *in)
+{
+       struct context *inc;
+
+       if (!in)
+               return FALSE;
+       inc = in->priv;
+       if (!inc)
+               return FALSE;
+       if (!inc->prev_sr_channels)
+               return TRUE;
+
+       if (sr_channel_lists_differ(inc->prev_sr_channels, in->sdi->channels)) {
+               sr_err("Channel list change not supported for file re-read.");
+               return FALSE;
+       }
+       g_slist_free_full(in->sdi->channels, sr_channel_free_cb);
+       in->sdi->channels = inc->prev_sr_channels;
+       inc->prev_sr_channels = NULL;
+
+       return TRUE;
+}
+
 static const char *delim_set = "\r\n";
 
 static const char *get_line_termination(GString *buf)
@@ -615,6 +656,10 @@ static int initial_parse(const struct sr_input *in, GString *buf)
                sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
        }
        g_string_free(channel_name, TRUE);
+       if (!check_header_in_reread(in)) {
+               ret = SR_ERR_DATA;
+               goto out;
+       }
 
        /*
         * Calculate the minimum buffer size to store the set of samples
@@ -624,7 +669,7 @@ static int initial_parse(const struct sr_input *in, GString *buf)
         * to a location within that large buffer.
         */
        inc->sample_unit_size = (inc->num_channels + 7) / 8;
-       inc->datafeed_buf_size = DATAFEED_MAX_SAMPLES;
+       inc->datafeed_buf_size = CHUNK_SIZE;
        inc->datafeed_buf_size *= inc->sample_unit_size;
        inc->datafeed_buffer = g_malloc(inc->datafeed_buf_size);
        inc->datafeed_buf_fill = 0;
@@ -784,6 +829,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                columns = parse_line(line, inc, max_columns);
                if (!columns) {
                        sr_err("Error while parsing line %zu.", inc->line_number);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
                num_columns = g_strv_length(columns);
@@ -791,6 +837,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                        sr_err("Column %u in line %zu is out of bounds.",
                                inc->first_column, inc->line_number);
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
                /*
@@ -801,6 +848,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                        sr_err("Not enough columns for desired number of channels in line %zu.",
                                inc->line_number);
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
 
@@ -810,6 +858,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                        ret = parse_single_column(columns[0], inc);
                if (ret != SR_OK) {
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
 
@@ -818,6 +867,7 @@ static int process_buffer(struct sr_input *in, gboolean is_eof)
                if (ret != SR_OK) {
                        sr_err("Sending samples failed.");
                        g_strfreev(columns);
+                       g_strfreev(lines);
                        return SR_ERR;
                }
 
@@ -882,16 +932,14 @@ static void cleanup(struct sr_input *in)
 {
        struct context *inc;
 
-       inc = in->priv;
-
-       if (inc->delimiter)
-               g_string_free(inc->delimiter, TRUE);
+       keep_header_for_reread(in);
 
-       if (inc->comment)
-               g_string_free(inc->comment, TRUE);
+       inc = in->priv;
 
        g_free(inc->termination);
+       inc->termination = NULL;
        g_free(inc->datafeed_buffer);
+       inc->datafeed_buffer = NULL;
 }
 
 static int reset(struct sr_input *in)
@@ -906,25 +954,32 @@ static int reset(struct sr_input *in)
 }
 
 static struct sr_option options[] = {
-       { "single-column", "Single column", "Enable/specify single column", NULL, NULL },
-       { "numchannels", "Max channels", "Number of channels", NULL, NULL },
-       { "delimiter", "Delimiter", "Column delimiter", NULL, NULL },
-       { "format", "Format", "Numeric format", NULL, NULL },
-       { "comment", "Comment", "Comment prefix character", NULL, NULL },
-       { "samplerate", "Samplerate", "Samplerate used during capture", NULL, NULL },
-       { "first-channel", "First channel", "Column number of first channel", NULL, NULL },
-       { "header", "Header", "Treat first line as header with channel names", NULL, NULL },
-       { "startline", "Start line", "Line number at which to start processing samples", NULL, NULL },
+       { "single-column", "Single column", "Enable single-column mode, using the specified column (>= 1); 0: multi-col. mode", NULL, NULL },
+       { "numchannels", "Number of logic channels", "The number of (logic) channels (single-col. mode: number of bits beginning at 'first channel', LSB-first)", NULL, NULL },
+       { "delimiter", "Column delimiter", "The column delimiter (>= 1 characters)", NULL, NULL },
+       { "format", "Data format (single-col. mode)", "The numeric format of the data (single-col. mode): bin, hex, oct", NULL, NULL },
+       { "comment", "Comment character(s)", "The comment prefix character(s)", NULL, NULL },
+       { "samplerate", "Samplerate (Hz)", "The sample rate (used during capture) in Hz", NULL, NULL },
+       { "first-channel", "First channel", "The column number of the first channel (multi-col. mode); bit position for the first channel (single-col. mode)", NULL, NULL },
+       { "header", "Interpret first line as header (multi-col. mode)", "Treat the first line as header with channel names (multi-col. mode)", NULL, NULL },
+       { "startline", "Start line", "The line number at which to start processing samples (>= 1)", NULL, NULL },
        ALL_ZERO
 };
 
 static const struct sr_option *get_options(void)
 {
+       GSList *l;
+
        if (!options[0].def) {
                options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
                options[1].def = g_variant_ref_sink(g_variant_new_int32(0));
                options[2].def = g_variant_ref_sink(g_variant_new_string(","));
                options[3].def = g_variant_ref_sink(g_variant_new_string("bin"));
+               l = NULL;
+               l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("bin")));
+               l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("hex")));
+               l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("oct")));
+               options[3].values = l;
                options[4].def = g_variant_ref_sink(g_variant_new_string(";"));
                options[5].def = g_variant_ref_sink(g_variant_new_uint64(0));
                options[6].def = g_variant_ref_sink(g_variant_new_int32(0));