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_buf_size *= inc->sample_unit_size;
 630         inc->datafeed_buffer = g_malloc(inc->datafeed_buf_size);
 631         inc->datafeed_buf_fill = 0;
 632         inc->sample_buffer = &inc->datafeed_buffer[inc->datafeed_buf_fill];
 633
 634 out:
 635         if (columns)
 636                 g_strfreev(columns);
 637         g_strfreev(lines);
 638
 639         return ret;
 640 }
 641
 642 /*
 643  * Gets called from initial_receive(), which runs until the end-of-line
 644  * encoding of the input stream could get determined. Assumes that this
 645  * routine receives enough buffered initial input data to either see the
 646  * BOM when there is one, or that no BOM will follow when a text line
 647  * termination sequence was seen. Silently drops the UTF-8 BOM sequence
 648  * from the input buffer if one was seen. Does not care to protect
 649  * against multiple execution or dropping the BOM multiple times --
 650  * there should be at most one in the input stream.
 651  */
 652 static void initial_bom_check(const struct sr_input *in)
 653 {
 654         static const char *utf8_bom = "\xef\xbb\xbf";
 655
 656         if (in->buf->len < strlen(utf8_bom))
 657                 return;
 658         if (strncmp(in->buf->str, utf8_bom, strlen(utf8_bom)) != 0)
 659                 return;
 660         g_string_erase(in->buf, 0, strlen(utf8_bom));
 661 }
 662
 663 static int initial_receive(const struct sr_input *in)
 664 {
 665         struct context *inc;
 666         GString *new_buf;
 667         int len, ret;
 668         char *p;
 669         const char *termination;
 670
 671         initial_bom_check(in);
 672
 673         inc = in->priv;
 674
 675         termination = get_line_termination(in->buf);
 676         if (!termination)
 677                 /* Don't have a full line yet. */
 678                 return SR_ERR_NA;
 679
 680         p = g_strrstr_len(in->buf->str, in->buf->len, termination);
 681         if (!p)
 682                 /* Don't have a full line yet. */
 683                 return SR_ERR_NA;
 684         len = p - in->buf->str - 1;
 685         new_buf = g_string_new_len(in->buf->str, len);
 686         g_string_append_c(new_buf, '\0');
 687
 688         inc->termination = g_strdup(termination);
 689
 690         if (in->buf->str[0] != '\0')
 691                 ret = initial_parse(in, new_buf);
 692         else
 693                 ret = SR_OK;
 694
 695         g_string_free(new_buf, TRUE);
 696
 697         return ret;
 698 }
 699
 700 static int process_buffer(struct sr_input *in, gboolean is_eof)
 701 {
 702         struct sr_datafeed_packet packet;
 703         struct sr_datafeed_meta meta;
 704         struct sr_config *src;
 705         struct context *inc;
 706         gsize num_columns;
 707         uint64_t samplerate;
 708         int max_columns, ret, l;
 709         char *p, **lines, *line, **columns;
 710
 711         inc = in->priv;
 712         if (!inc->started) {
 713                 std_session_send_df_header(in->sdi);
 714
 715                 if (inc->samplerate) {
 716                         packet.type = SR_DF_META;
 717                         packet.payload = &meta;
 718                         samplerate = inc->samplerate;
 719                         src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(samplerate));
 720                         meta.config = g_slist_append(NULL, src);
 721                         sr_session_send(in->sdi, &packet);
 722                         g_slist_free(meta.config);
 723                         sr_config_free(src);
 724                 }
 725
 726                 inc->started = TRUE;
 727         }
 728
 729         /* Limit the number of columns to parse. */
 730         if (inc->multi_column_mode)
 731                 max_columns = inc->num_channels;
 732         else
 733                 max_columns = 1;
 734
 735         /*
 736          * Consider empty input non-fatal. Keep accumulating input until
 737          * at least one full text line has become available. Grab the
 738          * maximum amount of accumulated data that consists of full text
 739          * lines, and process what has been received so far, leaving not
 740          * yet complete lines for the next invocation.
 741          *
 742          * Enforce that all previously buffered data gets processed in
 743          * the "EOF" condition. Do not insist in the presence of the
 744          * termination sequence for the last line (may often be missing
 745          * on Windows). A present termination sequence will just result
 746          * in the "execution of an empty line", and does not harm.
 747          */
 748         if (!in->buf->len)
 749                 return SR_OK;
 750         if (is_eof) {
 751                 p = in->buf->str + in->buf->len;
 752         } else {
 753                 p = g_strrstr_len(in->buf->str, in->buf->len, inc->termination);
 754                 if (!p)
 755                         return SR_ERR;
 756                 *p = '\0';
 757                 p += strlen(inc->termination);
 758         }
 759         g_strstrip(in->buf->str);
 760
 761         ret = SR_OK;
 762         lines = g_strsplit_set(in->buf->str, delim_set, 0);
 763         for (l = 0; lines[l]; l++) {
 764                 inc->line_number++;
 765                 line = lines[l];
 766                 if (line[0] == '\0') {
 767                         sr_spew("Blank line %zu skipped.", inc->line_number);
 768                         continue;
 769                 }
 770
 771                 /* Remove trailing comment. */
 772                 strip_comment(line, inc->comment);
 773                 if (line[0] == '\0') {
 774                         sr_spew("Comment-only line %zu skipped.", inc->line_number);
 775                         continue;
 776                 }
 777
 778                 /* Skip the header line, its content was used as the channel names. */
 779                 if (inc->header) {
 780                         sr_spew("Header line %zu skipped.", inc->line_number);
 781                         inc->header = FALSE;
 782                         continue;
 783                 }
 784
 785                 columns = parse_line(line, inc, max_columns);
 786                 if (!columns) {
 787                         sr_err("Error while parsing line %zu.", inc->line_number);
 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                         return SR_ERR;
 796                 }
 797                 /*
 798                  * Ensure that the number of channels does not exceed the number
 799                  * of columns in multi column mode.
 800                  */
 801                 if (inc->multi_column_mode && num_columns < inc->num_channels) {
 802                         sr_err("Not enough columns for desired number of channels in line %zu.",
 803                                 inc->line_number);
 804                         g_strfreev(columns);
 805                         return SR_ERR;
 806                 }
 807
 808                 if (inc->multi_column_mode)
 809                         ret = parse_multi_columns(columns, inc);
 810                 else
 811                         ret = parse_single_column(columns[0], inc);
 812                 if (ret != SR_OK) {
 813                         g_strfreev(columns);
 814                         return SR_ERR;
 815                 }
 816
 817                 /* Send sample data to the session bus. */
 818                 ret = queue_samples(in);
 819                 if (ret != SR_OK) {
 820                         sr_err("Sending samples failed.");
 821                         g_strfreev(columns);
 822                         return SR_ERR;
 823                 }
 824
 825                 g_strfreev(columns);
 826         }
 827         g_strfreev(lines);
 828         g_string_erase(in->buf, 0, p - in->buf->str);
 829
 830         return ret;
 831 }
 832
 833 static int receive(struct sr_input *in, GString *buf)
 834 {
 835         struct context *inc;
 836         int ret;
 837
 838         g_string_append_len(in->buf, buf->str, buf->len);
 839
 840         inc = in->priv;
 841         if (!inc->termination) {
 842                 ret = initial_receive(in);
 843                 if (ret == SR_ERR_NA)
 844                         /* Not enough data yet. */
 845                         return SR_OK;
 846                 else if (ret != SR_OK)
 847                         return SR_ERR;
 848
 849                 /* sdi is ready, notify frontend. */
 850                 in->sdi_ready = TRUE;
 851                 return SR_OK;
 852         }
 853
 854         ret = process_buffer(in, FALSE);
 855
 856         return ret;
 857 }
 858
 859 static int end(struct sr_input *in)
 860 {
 861         struct context *inc;
 862         int ret;
 863
 864         if (in->sdi_ready)
 865                 ret = process_buffer(in, TRUE);
 866         else
 867                 ret = SR_OK;
 868         if (ret != SR_OK)
 869                 return ret;
 870
 871         ret = flush_samples(in);
 872         if (ret != SR_OK)
 873                 return ret;
 874
 875         inc = in->priv;
 876         if (inc->started)
 877                 std_session_send_df_end(in->sdi);
 878
 879         return ret;
 880 }
 881
 882 static void cleanup(struct sr_input *in)
 883 {
 884         struct context *inc;
 885
 886         inc = in->priv;
 887
 888         if (inc->delimiter)
 889                 g_string_free(inc->delimiter, TRUE);
 890
 891         if (inc->comment)
 892                 g_string_free(inc->comment, TRUE);
 893
 894         g_free(inc->termination);
 895         g_free(inc->datafeed_buffer);
 896 }
 897
 898 static int reset(struct sr_input *in)
 899 {
 900         struct context *inc = in->priv;
 901
 902         cleanup(in);
 903         inc->started = FALSE;
 904         g_string_truncate(in->buf, 0);
 905
 906         return SR_OK;
 907 }
 908
 909 static struct sr_option options[] = {
 910         { "single-column", "Single column", "Enable/specify single column", NULL, NULL },
 911         { "numchannels", "Max channels", "Number of channels", NULL, NULL },
 912         { "delimiter", "Delimiter", "Column delimiter", NULL, NULL },
 913         { "format", "Format", "Numeric format", NULL, NULL },
 914         { "comment", "Comment", "Comment prefix character", NULL, NULL },
 915         { "samplerate", "Samplerate", "Samplerate used during capture", NULL, NULL },
 916         { "first-channel", "First channel", "Column number of first channel", NULL, NULL },
 917         { "header", "Header", "Treat first line as header with channel names", NULL, NULL },
 918         { "startline", "Start line", "Line number at which to start processing samples", NULL, NULL },
 919         ALL_ZERO
 920 };
 921
 922 static const struct sr_option *get_options(void)
 923 {
 924         if (!options[0].def) {
 925                 options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
 926                 options[1].def = g_variant_ref_sink(g_variant_new_int32(0));
 927                 options[2].def = g_variant_ref_sink(g_variant_new_string(","));
 928                 options[3].def = g_variant_ref_sink(g_variant_new_string("bin"));
 929                 options[4].def = g_variant_ref_sink(g_variant_new_string(";"));
 930                 options[5].def = g_variant_ref_sink(g_variant_new_uint64(0));
 931                 options[6].def = g_variant_ref_sink(g_variant_new_int32(0));
 932                 options[7].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
 933                 options[8].def = g_variant_ref_sink(g_variant_new_int32(1));
 934         }
 935
 936         return options;
 937 }
 938
 939 SR_PRIV struct sr_input_module input_csv = {
 940         .id = "csv",
 941         .name = "CSV",
 942         .desc = "Comma-separated values",
 943         .exts = (const char*[]){"csv", NULL},
 944         .options = get_options,
 945         .init = init,
 946         .receive = receive,
 947         .end = end,
 948         .cleanup = cleanup,
 949         .reset = reset,
 950 };