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