2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
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 2 of the License, or
9 * (at your option) any later version.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "config.h" /* Needed for PACKAGE_STRING and others. */
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
28 #define LOG_PREFIX "output/csv"
31 unsigned int num_enabled_channels;
40 * - Option to specify delimiter character and/or string.
41 * - Option to (not) print metadata as comments.
42 * - Option to specify the comment character(s), e.g. # or ; or C/C++-style.
43 * - Option to (not) print samplenumber / time as extra column.
44 * - Option to "compress" output (only print changed samples, VCD-like).
45 * - Option to print comma-separated bits, or whole bytes/words (for 8/16
46 * channel LAs) as ASCII/hex etc. etc.
50 static int init(struct sr_output *o, GHashTable *options)
53 struct sr_channel *ch;
62 ctx = g_malloc0(sizeof(struct context));
66 /* Get the number of channels, and the unitsize. */
67 for (l = o->sdi->channels; l; l = l->next) {
69 if (ch->type != SR_CHANNEL_LOGIC)
73 ctx->num_enabled_channels++;
75 ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
77 /* Once more to map the enabled channels. */
78 for (i = 0, l = o->sdi->channels; l; l = l->next) {
80 if (ch->type != SR_CHANNEL_LOGIC)
84 ctx->channel_index[i++] = ch->index;
90 static GString *gen_header(const struct sr_output *o)
93 struct sr_channel *ch;
102 header = g_string_sized_new(512);
106 g_string_append_printf(header, "; CSV, generated by %s on %s",
107 PACKAGE_STRING, ctime(&t));
109 /* Columns / channels */
110 num_channels = g_slist_length(o->sdi->channels);
111 g_string_append_printf(header, "; Channels (%d/%d):",
112 ctx->num_enabled_channels, num_channels);
113 for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
115 if (ch->type != SR_CHANNEL_LOGIC)
119 g_string_append_printf(header, " %s,", ch->name);
121 if (o->sdi->channels)
122 /* Drop last separator. */
123 g_string_truncate(header, header->len - 1);
124 g_string_append_printf(header, "\n");
126 if (ctx->samplerate == 0) {
127 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
129 ctx->samplerate = g_variant_get_uint64(gvar);
130 g_variant_unref(gvar);
133 if (ctx->samplerate != 0) {
134 samplerate_s = sr_samplerate_string(ctx->samplerate);
135 g_string_append_printf(header, "; Samplerate: %s\n", samplerate_s);
136 g_free(samplerate_s);
142 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
145 const struct sr_datafeed_meta *meta;
146 const struct sr_datafeed_logic *logic;
147 const struct sr_config *src;
157 if (!(ctx = o->priv))
160 switch (packet->type) {
162 meta = packet->payload;
163 for (l = meta->config; l; l = l->next) {
165 if (src->key != SR_CONF_SAMPLERATE)
167 ctx->samplerate = g_variant_get_uint64(src->data);
171 logic = packet->payload;
172 if (!ctx->header_done) {
173 *out = gen_header(o);
174 ctx->header_done = TRUE;
176 *out = g_string_sized_new(512);
179 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
180 for (j = 0; j < ctx->num_enabled_channels; j++) {
181 idx = ctx->channel_index[j];
182 p = logic->data + i + idx / 8;
183 c = *p & (1 << (idx % 8));
184 g_string_append_c(*out, c ? '1' : '0');
185 g_string_append_c(*out, ctx->separator);
188 /* Drop last separator. */
189 g_string_truncate(*out, (*out)->len - 1);
191 g_string_append_printf(*out, "\n");
199 static int cleanup(struct sr_output *o)
208 g_free(ctx->channel_index);
216 SR_PRIV struct sr_output_module output_csv = {
219 .desc = "Comma-separated values",