ipdbg-la: Minor cosmetic and comment fixes.
[libsigrok.git] / src / input / csv.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Marc Schink <sigrok-dev@marcschink.de>
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 <stdlib.h>
22 #include <string.h>
23 #include <glib.h>
24 #include <libsigrok/libsigrok.h>
25 #include "libsigrok-internal.h"
26
27 #define LOG_PREFIX "input/csv"
28
29 #define DATAFEED_MAX_SAMPLES    (128 * 1024)
30
31 /*
32  * The CSV input module has the following options:
33  *
34  * single-column: Specifies the column number which stores the sample data for
35  *                single column mode and enables single column mode. Multi
36  *                column mode is used if this parameter is omitted.
37  *
38  * numchannels:   Specifies the number of channels to use. In multi column mode
39  *                the number of channels are the number of columns and in single
40  *                column mode the number of bits (LSB first) beginning at
41  *                'first-channel'.
42  *
43  * delimiter:     Specifies the delimiter for columns. Must be at least one
44  *                character. Comma is used as default delimiter.
45  *
46  * format:        Specifies the format of the sample data in single column mode.
47  *                Available formats are: 'bin', 'hex' and 'oct'. The binary
48  *                format is used by default. This option has no effect in multi
49  *                column mode.
50  *
51  * comment:       Specifies the prefix character(s) for comments. No prefix
52  *                characters are used by default which disables removing of
53  *                comments.
54  *
55  * samplerate:    Samplerate which the sample data was captured with. Default
56  *                value is 0.
57  *
58  * first-channel: Column number of the first channel in multi column mode and
59  *                position of the bit for the first channel in single column mode.
60  *                Default value is 0.
61  *
62  * header:        Determines if the first line should be treated as header
63  *                and used for channel names in multi column mode. Empty header
64  *                names will be replaced by the channel number. If enabled in
65  *                single column mode the first line will be skipped. Usage of
66  *                header is disabled by default.
67  *
68  * startline:     Line number to start processing sample data. Must be greater
69  *                than 0. The default line number to start processing is 1.
70  */
71
72 /*
73  * TODO
74  *
75  * - Determine how the text line handling can get improved, regarding
76  *   all of robustness and flexibility and correctness.
77  *   - The current implementation splits on "any run of CR and LF". Which
78  *     translates to: Line numbers are wrong in the presence of empty
79  *     lines in the input stream. See below for an (expensive) fix.
80  *   - Dropping support for CR style end-of-line markers could improve
81  *     the situation a lot. Code could search for and split on LF, and
82  *     trim optional trailing CR. This would result in proper support
83  *     for CRLF (Windows) as well as LF (Unix), and allow for correct
84  *     line number counts.
85  *   - When support for CR-only line termination cannot get dropped,
86  *     then the current implementation is inappropriate. Currently the
87  *     input stream is scanned for the first occurance of either of the
88  *     supported termination styles (which is good). For the remaining
89  *     session a consistent encoding of the text lines is assumed (which
90  *     is acceptable).
91  *   - When line numbers need to be correct and reliable, _and_ the full
92  *     set of previously supported line termination sequences are required,
93  *     and potentially more are to get added for improved compatibility
94  *     with more platforms or generators, then the current approach of
95  *     splitting on runs of termination characters needs to get replaced,
96  *     by the more expensive approach to scan for and count the initially
97  *     determined termination sequence.
98  *
99  * - Add support for analog input data? (optional)
100  *   - Needs a syntax first for user specs which channels (columns) are
101  *     logic and which are analog. May need heuristics(?) to guess from
102  *     input data in the absence of user provided specs.
103  */
104
105 /* Single column formats. */
106 enum {
107         FORMAT_BIN,
108         FORMAT_HEX,
109         FORMAT_OCT
110 };
111
112 struct context {
113         gboolean started;
114
115         /* Current selected samplerate. */
116         uint64_t samplerate;
117
118         /* Number of channels. */
119         unsigned int num_channels;
120
121         /* Column delimiter character(s). */
122         GString *delimiter;
123
124         /* Comment prefix character(s). */
125         GString *comment;
126
127         /* Termination character(s) used in current stream. */
128         char *termination;
129
130         /* Determines if sample data is stored in multiple columns. */
131         gboolean multi_column_mode;
132
133         /* Column number of the sample data in single column mode. */
134         unsigned int single_column;
135
136         /*
137          * Number of the first column to parse. Equivalent to the number of the
138          * first channel in multi column mode and the single column number in
139          * single column mode.
140          */
141         unsigned int first_column;
142
143         /*
144          * Column number of the first channel in multi column mode and position of
145          * the bit for the first channel in single column mode.
146          */
147         unsigned int first_channel;
148
149         /* Line number to start processing. */
150         size_t start_line;
151
152         /*
153          * Determines if the first line should be treated as header and used for
154          * channel names in multi column mode.
155          */
156         gboolean header;
157
158         /* Format sample data is stored in single column mode. */
159         int format;
160
161         size_t sample_unit_size;        /**!< Byte count for a single sample. */
162         uint8_t *sample_buffer;         /**!< Buffer for a single sample. */
163
164         uint8_t *datafeed_buffer;       /**!< Queue for datafeed submission. */
165         size_t datafeed_buf_size;
166         size_t datafeed_buf_fill;
167
168         /* Current line number. */
169         size_t line_number;
170 };
171
172 static void strip_comment(char *buf, const GString *prefix)
173 {
174         char *ptr;
175
176         if (!prefix->len)
177                 return;
178
179         if ((ptr = strstr(buf, prefix->str)))
180                 *ptr = '\0';
181 }
182
183 static int parse_binstr(const char *str, struct context *inc)
184 {
185         gsize i, j, length;
186
187         length = strlen(str);
188
189         if (!length) {
190                 sr_err("Column %u in line %zu is empty.", inc->single_column,
191                         inc->line_number);
192                 return SR_ERR;
193         }
194
195         /* Clear buffer in order to set bits only. */
196         memset(inc->sample_buffer, 0, inc->sample_unit_size);
197
198         i = inc->first_channel;
199
200         for (j = 0; i < length && j < inc->num_channels; i++, j++) {
201                 if (str[length - i - 1] == '1') {
202                         inc->sample_buffer[j / 8] |= (1 << (j % 8));
203                 } else if (str[length - i - 1] != '0') {
204                         sr_err("Invalid value '%s' in column %u in line %zu.",
205                                 str, inc->single_column, inc->line_number);
206                         return SR_ERR;
207                 }
208         }
209
210         return SR_OK;
211 }
212
213 static int parse_hexstr(const char *str, struct context *inc)
214 {
215         gsize i, j, k, length;
216         uint8_t value;
217         char c;
218
219         length = strlen(str);
220
221         if (!length) {
222                 sr_err("Column %u in line %zu is empty.", inc->single_column,
223                         inc->line_number);
224                 return SR_ERR;
225         }
226
227         /* Clear buffer in order to set bits only. */
228         memset(inc->sample_buffer, 0, inc->sample_unit_size);
229
230         /* Calculate the position of the first hexadecimal digit. */
231         i = inc->first_channel / 4;
232
233         for (j = 0; i < length && j < inc->num_channels; i++) {
234                 c = str[length - i - 1];
235
236                 if (!g_ascii_isxdigit(c)) {
237                         sr_err("Invalid value '%s' in column %u in line %zu.",
238                                 str, inc->single_column, inc->line_number);
239                         return SR_ERR;
240                 }
241
242                 value = g_ascii_xdigit_value(c);
243
244                 k = (inc->first_channel + j) % 4;
245
246                 for (; j < inc->num_channels && k < 4; k++) {
247                         if (value & (1 << k))
248                                 inc->sample_buffer[j / 8] |= (1 << (j % 8));
249
250                         j++;
251                 }
252         }
253
254         return SR_OK;
255 }
256
257 static int parse_octstr(const char *str, struct context *inc)
258 {
259         gsize i, j, k, length;
260         uint8_t value;
261         char c;
262
263         length = strlen(str);
264
265         if (!length) {
266                 sr_err("Column %u in line %zu is empty.", inc->single_column,
267                         inc->line_number);
268                 return SR_ERR;
269         }
270
271         /* Clear buffer in order to set bits only. */
272         memset(inc->sample_buffer, 0, inc->sample_unit_size);
273
274         /* Calculate the position of the first octal digit. */
275         i = inc->first_channel / 3;
276
277         for (j = 0; i < length && j < inc->num_channels; i++) {
278                 c = str[length - i - 1];
279
280                 if (c < '0' || c > '7') {
281                         sr_err("Invalid value '%s' in column %u in line %zu.",
282                                 str, inc->single_column, inc->line_number);
283                         return SR_ERR;
284                 }
285
286                 value = g_ascii_xdigit_value(c);
287
288                 k = (inc->first_channel + j) % 3;
289
290                 for (; j < inc->num_channels && k < 3; k++) {
291                         if (value & (1 << k))
292                                 inc->sample_buffer[j / 8] |= (1 << (j % 8));
293
294                         j++;
295                 }
296         }
297
298         return SR_OK;
299 }
300
301 static char **parse_line(char *buf, struct context *inc, int max_columns)
302 {
303         const char *str, *remainder;
304         GSList *list, *l;
305         char **columns;
306         char *column;
307         gsize n, k;
308
309         n = 0;
310         k = 0;
311         list = NULL;
312
313         remainder = buf;
314         str = strstr(remainder, inc->delimiter->str);
315
316         while (str && max_columns) {
317                 if (n >= inc->first_column) {
318                         column = g_strndup(remainder, str - remainder);
319                         list = g_slist_prepend(list, g_strstrip(column));
320
321                         max_columns--;
322                         k++;
323                 }
324
325                 remainder = str + inc->delimiter->len;
326                 str = strstr(remainder, inc->delimiter->str);
327                 n++;
328         }
329
330         if (buf[0] && max_columns && n >= inc->first_column) {
331                 column = g_strdup(remainder);
332                 list = g_slist_prepend(list, g_strstrip(column));
333                 k++;
334         }
335
336         if (!(columns = g_try_new(char *, k + 1)))
337                 return NULL;
338
339         columns[k--] = NULL;
340
341         for (l = list; l; l = l->next)
342                 columns[k--] = l->data;
343
344         g_slist_free(list);
345
346         return columns;
347 }
348
349 static int parse_multi_columns(char **columns, struct context *inc)
350 {
351         gsize i;
352         char *column;
353
354         /* Clear buffer in order to set bits only. */
355         memset(inc->sample_buffer, 0, inc->sample_unit_size);
356
357         for (i = 0; i < inc->num_channels; i++) {
358                 column = columns[i];
359                 if (column[0] == '1') {
360                         inc->sample_buffer[i / 8] |= (1 << (i % 8));
361                 } else if (!strlen(column)) {
362                         sr_err("Column %zu in line %zu is empty.",
363                                 inc->first_channel + i, inc->line_number);
364                         return SR_ERR;
365                 } else if (column[0] != '0') {
366                         sr_err("Invalid value '%s' in column %zu in line %zu.",
367                                 column, inc->first_channel + i,
368                                 inc->line_number);
369                         return SR_ERR;
370                 }
371         }
372
373         return SR_OK;
374 }
375
376 static int parse_single_column(const char *column, struct context *inc)
377 {
378         int res;
379
380         res = SR_ERR;
381
382         switch (inc->format) {
383         case FORMAT_BIN:
384                 res = parse_binstr(column, inc);
385                 break;
386         case FORMAT_HEX:
387                 res = parse_hexstr(column, inc);
388                 break;
389         case FORMAT_OCT:
390                 res = parse_octstr(column, inc);
391                 break;
392         }
393
394         return res;
395 }
396
397 static int flush_samples(const struct sr_input *in)
398 {
399         struct context *inc;
400         struct sr_datafeed_packet packet;
401         struct sr_datafeed_logic logic;
402         int rc;
403
404         inc = in->priv;
405         if (!inc->datafeed_buf_fill)
406                 return SR_OK;
407
408         memset(&packet, 0, sizeof(packet));
409         memset(&logic, 0, sizeof(logic));
410         packet.type = SR_DF_LOGIC;
411         packet.payload = &logic;
412         logic.unitsize = inc->sample_unit_size;
413         logic.length = inc->datafeed_buf_fill;
414         logic.data = inc->datafeed_buffer;
415
416         rc = sr_session_send(in->sdi, &packet);
417         if (rc != SR_OK)
418                 return rc;
419
420         inc->datafeed_buf_fill = 0;
421         return SR_OK;
422 }
423
424 static int queue_samples(const struct sr_input *in)
425 {
426         struct context *inc;
427         int rc;
428
429         inc = in->priv;
430
431         inc->datafeed_buf_fill += inc->sample_unit_size;
432         if (inc->datafeed_buf_fill == inc->datafeed_buf_size) {
433                 rc = flush_samples(in);
434                 if (rc != SR_OK)
435                         return rc;
436         }
437         inc->sample_buffer = &inc->datafeed_buffer[inc->datafeed_buf_fill];
438         return SR_OK;
439 }
440
441 static int init(struct sr_input *in, GHashTable *options)
442 {
443         struct context *inc;
444         const char *s;
445
446         in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
447         in->priv = inc = g_malloc0(sizeof(struct context));
448
449         inc->single_column = g_variant_get_int32(g_hash_table_lookup(options, "single-column"));
450         inc->multi_column_mode = inc->single_column == 0;
451
452         inc->num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels"));
453
454         inc->delimiter = g_string_new(g_variant_get_string(
455                         g_hash_table_lookup(options, "delimiter"), NULL));
456         if (inc->delimiter->len == 0) {
457                 sr_err("Delimiter must be at least one character.");
458                 return SR_ERR_ARG;
459         }
460
461         s = g_variant_get_string(g_hash_table_lookup(options, "format"), NULL);
462         if (!g_ascii_strncasecmp(s, "bin", 3)) {
463                 inc->format = FORMAT_BIN;
464         } else if (!g_ascii_strncasecmp(s, "hex", 3)) {
465                 inc->format = FORMAT_HEX;
466         } else if (!g_ascii_strncasecmp(s, "oct", 3)) {
467                 inc->format = FORMAT_OCT;
468         } else {
469                 sr_err("Invalid format: '%s'", s);
470                 return SR_ERR_ARG;
471         }
472
473         inc->comment = g_string_new(g_variant_get_string(
474                         g_hash_table_lookup(options, "comment"), NULL));
475         if (g_string_equal(inc->comment, inc->delimiter)) {
476                 /* That's never going to work. Likely the result of the user
477                  * setting the delimiter to ; -- the default comment. Clearing
478                  * the comment setting will work in that case. */
479                 g_string_truncate(inc->comment, 0);
480         }
481
482         inc->samplerate = g_variant_get_uint64(g_hash_table_lookup(options, "samplerate"));
483
484         inc->first_channel = g_variant_get_int32(g_hash_table_lookup(options, "first-channel"));
485
486         inc->header = g_variant_get_boolean(g_hash_table_lookup(options, "header"));
487
488         inc->start_line = g_variant_get_int32(g_hash_table_lookup(options, "startline"));
489         if (inc->start_line < 1) {
490                 sr_err("Invalid start line %zu.", inc->start_line);
491                 return SR_ERR_ARG;
492         }
493
494         if (inc->multi_column_mode)
495                 inc->first_column = inc->first_channel;
496         else
497                 inc->first_column = inc->single_column;
498
499         if (!inc->multi_column_mode && !inc->num_channels) {
500                 sr_err("Number of channels needs to be specified in single column mode.");
501                 return SR_ERR_ARG;
502         }
503
504         return SR_OK;
505 }
506
507 static const char *delim_set = "\r\n";
508
509 static const char *get_line_termination(GString *buf)
510 {
511         const char *term;
512
513         term = NULL;
514         if (g_strstr_len(buf->str, buf->len, "\r\n"))
515                 term = "\r\n";
516         else if (memchr(buf->str, '\n', buf->len))
517                 term = "\n";
518         else if (memchr(buf->str, '\r', buf->len))
519                 term = "\r";
520
521         return term;
522 }
523
524 static int initial_parse(const struct sr_input *in, GString *buf)
525 {
526         struct context *inc;
527         GString *channel_name;
528         unsigned int num_columns, i;
529         size_t line_number, l;
530         int ret;
531         char **lines, *line, **columns, *column;
532
533         ret = SR_OK;
534         inc = in->priv;
535         columns = NULL;
536
537         line_number = 0;
538         lines = g_strsplit_set(buf->str, delim_set, 0);
539         for (l = 0; lines[l]; l++) {
540                 line_number++;
541                 line = lines[l];
542                 if (inc->start_line > line_number) {
543                         sr_spew("Line %zu skipped.", line_number);
544                         continue;
545                 }
546                 if (line[0] == '\0') {
547                         sr_spew("Blank line %zu skipped.", line_number);
548                         continue;
549                 }
550                 strip_comment(line, inc->comment);
551                 if (line[0] == '\0') {
552                         sr_spew("Comment-only line %zu skipped.", line_number);
553                         continue;
554                 }
555
556                 /* Reached first proper line. */
557                 break;
558         }
559         if (!lines[l]) {
560                 /* Not enough data for a proper line yet. */
561                 ret = SR_ERR_NA;
562                 goto out;
563         }
564
565         /*
566          * In order to determine the number of columns parse the current line
567          * without limiting the number of columns.
568          */
569         columns = parse_line(line, inc, -1);
570         if (!columns) {
571                 sr_err("Error while parsing line %zu.", line_number);
572                 ret = SR_ERR;
573                 goto out;
574         }
575         num_columns = g_strv_length(columns);
576
577         /* Ensure that the first column is not out of bounds. */
578         if (!num_columns) {
579                 sr_err("Column %u in line %zu is out of bounds.",
580                         inc->first_column, line_number);
581                 ret = SR_ERR;
582                 goto out;
583         }
584
585         if (inc->multi_column_mode) {
586                 /*
587                  * Detect the number of channels in multi column mode
588                  * automatically if not specified.
589                  */
590                 if (!inc->num_channels) {
591                         inc->num_channels = num_columns;
592                         sr_dbg("Number of auto-detected channels: %u.",
593                                 inc->num_channels);
594                 }
595
596                 /*
597                  * Ensure that the number of channels does not exceed the number
598                  * of columns in multi column mode.
599                  */
600                 if (num_columns < inc->num_channels) {
601                         sr_err("Not enough columns for desired number of channels in line %zu.",
602                                 line_number);
603                         ret = SR_ERR;
604                         goto out;
605                 }
606         }
607
608         channel_name = g_string_sized_new(64);
609         for (i = 0; i < inc->num_channels; i++) {
610                 column = columns[i];
611                 if (inc->header && inc->multi_column_mode && column[0] != '\0')
612                         g_string_assign(channel_name, column);
613                 else
614                         g_string_printf(channel_name, "%u", i);
615                 sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name->str);
616         }
617         g_string_free(channel_name, TRUE);
618
619         /*
620          * Calculate the minimum buffer size to store the set of samples
621          * of all channels (unit size). Determine a larger buffer size
622          * for datafeed submission that is a multiple of the unit size.
623          * Allocate the larger buffer, and have the "sample buffer" point
624          * to a location within that large buffer.
625          */
626         inc->sample_unit_size = (inc->num_channels + 7) / 8;
627         inc->datafeed_buf_size = DATAFEED_MAX_SAMPLES;
628         inc->datafeed_buf_size *= inc->sample_unit_size;
629         inc->datafeed_buffer = g_malloc(inc->datafeed_buf_size);
630         inc->datafeed_buf_fill = 0;
631         inc->sample_buffer = &inc->datafeed_buffer[inc->datafeed_buf_fill];
632
633 out:
634         if (columns)
635                 g_strfreev(columns);
636         g_strfreev(lines);
637
638         return ret;
639 }
640
641 /*
642  * Gets called from initial_receive(), which runs until the end-of-line
643  * encoding of the input stream could get determined. Assumes that this
644  * routine receives enough buffered initial input data to either see the
645  * BOM when there is one, or that no BOM will follow when a text line
646  * termination sequence was seen. Silently drops the UTF-8 BOM sequence
647  * from the input buffer if one was seen. Does not care to protect
648  * against multiple execution or dropping the BOM multiple times --
649  * there should be at most one in the input stream.
650  */
651 static void initial_bom_check(const struct sr_input *in)
652 {
653         static const char *utf8_bom = "\xef\xbb\xbf";
654
655         if (in->buf->len < strlen(utf8_bom))
656                 return;
657         if (strncmp(in->buf->str, utf8_bom, strlen(utf8_bom)) != 0)
658                 return;
659         g_string_erase(in->buf, 0, strlen(utf8_bom));
660 }
661
662 static int initial_receive(const struct sr_input *in)
663 {
664         struct context *inc;
665         GString *new_buf;
666         int len, ret;
667         char *p;
668         const char *termination;
669
670         initial_bom_check(in);
671
672         inc = in->priv;
673
674         termination = get_line_termination(in->buf);
675         if (!termination)
676                 /* Don't have a full line yet. */
677                 return SR_ERR_NA;
678
679         p = g_strrstr_len(in->buf->str, in->buf->len, termination);
680         if (!p)
681                 /* Don't have a full line yet. */
682                 return SR_ERR_NA;
683         len = p - in->buf->str - 1;
684         new_buf = g_string_new_len(in->buf->str, len);
685         g_string_append_c(new_buf, '\0');
686
687         inc->termination = g_strdup(termination);
688
689         if (in->buf->str[0] != '\0')
690                 ret = initial_parse(in, new_buf);
691         else
692                 ret = SR_OK;
693
694         g_string_free(new_buf, TRUE);
695
696         return ret;
697 }
698
699 static int process_buffer(struct sr_input *in, gboolean is_eof)
700 {
701         struct sr_datafeed_packet packet;
702         struct sr_datafeed_meta meta;
703         struct sr_config *src;
704         struct context *inc;
705         gsize num_columns;
706         uint64_t samplerate;
707         int max_columns, ret, l;
708         char *p, **lines, *line, **columns;
709
710         inc = in->priv;
711         if (!inc->started) {
712                 std_session_send_df_header(in->sdi);
713
714                 if (inc->samplerate) {
715                         packet.type = SR_DF_META;
716                         packet.payload = &meta;
717                         samplerate = inc->samplerate;
718                         src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(samplerate));
719                         meta.config = g_slist_append(NULL, src);
720                         sr_session_send(in->sdi, &packet);
721                         g_slist_free(meta.config);
722                         sr_config_free(src);
723                 }
724
725                 inc->started = TRUE;
726         }
727
728         /* Limit the number of columns to parse. */
729         if (inc->multi_column_mode)
730                 max_columns = inc->num_channels;
731         else
732                 max_columns = 1;
733
734         /*
735          * Consider empty input non-fatal. Keep accumulating input until
736          * at least one full text line has become available. Grab the
737          * maximum amount of accumulated data that consists of full text
738          * lines, and process what has been received so far, leaving not
739          * yet complete lines for the next invocation.
740          *
741          * Enforce that all previously buffered data gets processed in
742          * the "EOF" condition. Do not insist in the presence of the
743          * termination sequence for the last line (may often be missing
744          * on Windows). A present termination sequence will just result
745          * in the "execution of an empty line", and does not harm.
746          */
747         if (!in->buf->len)
748                 return SR_OK;
749         if (is_eof) {
750                 p = in->buf->str + in->buf->len;
751         } else {
752                 p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination);
753                 if (!p)
754                         return SR_ERR;
755                 *p = '\0';
756                 p += strlen(inc->termination);
757         }
758         g_strstrip(in->buf->str);
759
760         ret = SR_OK;
761         lines = g_strsplit_set(in->buf->str, delim_set, 0);
762         for (l = 0; lines[l]; l++) {
763                 inc->line_number++;
764                 line = lines[l];
765                 if (line[0] == '\0') {
766                         sr_spew("Blank line %zu skipped.", inc->line_number);
767                         continue;
768                 }
769
770                 /* Remove trailing comment. */
771                 strip_comment(line, inc->comment);
772                 if (line[0] == '\0') {
773                         sr_spew("Comment-only line %zu skipped.", inc->line_number);
774                         continue;
775                 }
776
777                 /* Skip the header line, its content was used as the channel names. */
778                 if (inc->header) {
779                         sr_spew("Header line %zu skipped.", inc->line_number);
780                         inc->header = FALSE;
781                         continue;
782                 }
783
784                 columns = parse_line(line, inc, max_columns);
785                 if (!columns) {
786                         sr_err("Error while parsing line %zu.", inc->line_number);
787                         g_strfreev(lines);
788                         return SR_ERR;
789                 }
790                 num_columns = g_strv_length(columns);
791                 if (!num_columns) {
792                         sr_err("Column %u in line %zu is out of bounds.",
793                                 inc->first_column, inc->line_number);
794                         g_strfreev(columns);
795                         g_strfreev(lines);
796                         return SR_ERR;
797                 }
798                 /*
799                  * Ensure that the number of channels does not exceed the number
800                  * of columns in multi column mode.
801                  */
802                 if (inc->multi_column_mode && num_columns < inc->num_channels) {
803                         sr_err("Not enough columns for desired number of channels in line %zu.",
804                                 inc->line_number);
805                         g_strfreev(columns);
806                         g_strfreev(lines);
807                         return SR_ERR;
808                 }
809
810                 if (inc->multi_column_mode)
811                         ret = parse_multi_columns(columns, inc);
812                 else
813                         ret = parse_single_column(columns[0], inc);
814                 if (ret != SR_OK) {
815                         g_strfreev(columns);
816                         g_strfreev(lines);
817                         return SR_ERR;
818                 }
819
820                 /* Send sample data to the session bus. */
821                 ret = queue_samples(in);
822                 if (ret != SR_OK) {
823                         sr_err("Sending samples failed.");
824                         g_strfreev(columns);
825                         g_strfreev(lines);
826                         return SR_ERR;
827                 }
828
829                 g_strfreev(columns);
830         }
831         g_strfreev(lines);
832         g_string_erase(in->buf, 0, p - in->buf->str);
833
834         return ret;
835 }
836
837 static int receive(struct sr_input *in, GString *buf)
838 {
839         struct context *inc;
840         int ret;
841
842         g_string_append_len(in->buf, buf->str, buf->len);
843
844         inc = in->priv;
845         if (!inc->termination) {
846                 ret = initial_receive(in);
847                 if (ret == SR_ERR_NA)
848                         /* Not enough data yet. */
849                         return SR_OK;
850                 else if (ret != SR_OK)
851                         return SR_ERR;
852
853                 /* sdi is ready, notify frontend. */
854                 in->sdi_ready = TRUE;
855                 return SR_OK;
856         }
857
858         ret = process_buffer(in, FALSE);
859
860         return ret;
861 }
862
863 static int end(struct sr_input *in)
864 {
865         struct context *inc;
866         int ret;
867
868         if (in->sdi_ready)
869                 ret = process_buffer(in, TRUE);
870         else
871                 ret = SR_OK;
872         if (ret != SR_OK)
873                 return ret;
874
875         ret = flush_samples(in);
876         if (ret != SR_OK)
877                 return ret;
878
879         inc = in->priv;
880         if (inc->started)
881                 std_session_send_df_end(in->sdi);
882
883         return ret;
884 }
885
886 static void cleanup(struct sr_input *in)
887 {
888         struct context *inc;
889
890         inc = in->priv;
891
892         if (inc->delimiter)
893                 g_string_free(inc->delimiter, TRUE);
894
895         if (inc->comment)
896                 g_string_free(inc->comment, TRUE);
897
898         g_free(inc->termination);
899         g_free(inc->datafeed_buffer);
900 }
901
902 static int reset(struct sr_input *in)
903 {
904         struct context *inc = in->priv;
905
906         cleanup(in);
907         inc->started = FALSE;
908         g_string_truncate(in->buf, 0);
909
910         return SR_OK;
911 }
912
913 static struct sr_option options[] = {
914         { "single-column", "Single column", "Enable/specify single column", NULL, NULL },
915         { "numchannels", "Max channels", "Number of channels", NULL, NULL },
916         { "delimiter", "Delimiter", "Column delimiter", NULL, NULL },
917         { "format", "Format", "Numeric format", NULL, NULL },
918         { "comment", "Comment", "Comment prefix character", NULL, NULL },
919         { "samplerate", "Samplerate", "Samplerate used during capture", NULL, NULL },
920         { "first-channel", "First channel", "Column number of first channel", NULL, NULL },
921         { "header", "Header", "Treat first line as header with channel names", NULL, NULL },
922         { "startline", "Start line", "Line number at which to start processing samples", NULL, NULL },
923         ALL_ZERO
924 };
925
926 static const struct sr_option *get_options(void)
927 {
928         if (!options[0].def) {
929                 options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
930                 options[1].def = g_variant_ref_sink(g_variant_new_int32(0));
931                 options[2].def = g_variant_ref_sink(g_variant_new_string(","));
932                 options[3].def = g_variant_ref_sink(g_variant_new_string("bin"));
933                 options[4].def = g_variant_ref_sink(g_variant_new_string(";"));
934                 options[5].def = g_variant_ref_sink(g_variant_new_uint64(0));
935                 options[6].def = g_variant_ref_sink(g_variant_new_int32(0));
936                 options[7].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
937                 options[8].def = g_variant_ref_sink(g_variant_new_int32(1));
938         }
939
940         return options;
941 }
942
943 SR_PRIV struct sr_input_module input_csv = {
944         .id = "csv",
945         .name = "CSV",
946         .desc = "Comma-separated values",
947         .exts = (const char*[]){"csv", NULL},
948         .options = get_options,
949         .init = init,
950         .receive = receive,
951         .end = end,
952         .cleanup = cleanup,
953         .reset = reset,
954 };