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