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
25 #include <libsigrok/libsigrok.h>
26 #include "libsigrok-internal.h"
28 #define LOG_PREFIX "output/csv"
31 unsigned int num_enabled_channels;
35 struct sr_channel **channels;
37 /* For analog measurements split into frames, not packets. */
38 struct sr_channel **analog_channels;
39 float *analog_vals; /* Analog values stored until the end of the frame. */
40 unsigned int num_analog_channels;
46 * - Option to specify delimiter character and/or string.
47 * - Option to (not) print metadata as comments.
48 * - Option to specify the comment character(s), e.g. # or ; or C/C++-style.
49 * - Option to (not) print samplenumber / time as extra column.
50 * - Option to "compress" output (only print changed samples, VCD-like).
51 * - Option to print comma-separated bits, or whole bytes/words (for 8/16
52 * channel LAs) as ASCII/hex etc. etc.
56 static int init(struct sr_output *o, GHashTable *options)
59 struct sr_channel *ch;
68 ctx = g_malloc0(sizeof(struct context));
72 /* Get the number of channels, and the unitsize. */
73 for (l = o->sdi->channels; l; l = l->next) {
76 if (ch->type == SR_CHANNEL_LOGIC ||
77 ch->type == SR_CHANNEL_ANALOG)
78 ctx->num_enabled_channels++;
79 if (ch->type == SR_CHANNEL_ANALOG)
80 ctx->num_analog_channels++;
83 ctx->channels = g_malloc(sizeof(struct sr_channel *)
84 * ctx->num_enabled_channels);
85 ctx->analog_channels = g_malloc(sizeof(struct sr_channel *)
86 * ctx->num_analog_channels);
87 ctx->analog_vals = g_malloc(sizeof(float) * ctx->num_analog_channels);
89 /* Once more to map the enabled channels. */
90 for (i = 0, l = o->sdi->channels, j = 0; l; l = l->next) {
93 if (ch->type == SR_CHANNEL_LOGIC ||
94 ch->type == SR_CHANNEL_ANALOG)
95 ctx->channels[i++] = ch;
96 if (ch->type == SR_CHANNEL_ANALOG)
97 ctx->analog_channels[j++] = ch;
105 static GString *gen_header(const struct sr_output *o)
108 struct sr_channel *ch;
117 header = g_string_sized_new(512);
121 g_string_append_printf(header, "; CSV, generated by %s %s on %s",
122 PACKAGE_NAME, SR_PACKAGE_VERSION_STRING, ctime(&t));
124 /* Columns / channels */
125 num_channels = g_slist_length(o->sdi->channels);
126 g_string_append_printf(header, "; Channels (%d/%d):",
127 ctx->num_enabled_channels, num_channels);
128 for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
131 (ch->type == SR_CHANNEL_LOGIC ||
132 ch->type == SR_CHANNEL_ANALOG))
133 g_string_append_printf(header, " %s,", ch->name);
135 if (o->sdi->channels)
136 /* Drop last separator. */
137 g_string_truncate(header, header->len - 1);
138 g_string_append_printf(header, "\n");
140 if (ctx->samplerate == 0) {
141 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
143 ctx->samplerate = g_variant_get_uint64(gvar);
144 g_variant_unref(gvar);
147 if (ctx->samplerate != 0) {
148 samplerate_s = sr_samplerate_string(ctx->samplerate);
149 g_string_append_printf(header, "; Samplerate: %s\n", samplerate_s);
150 g_free(samplerate_s);
156 static void init_output(GString **out, struct context *ctx,
157 const struct sr_output *o)
159 if (!ctx->header_done) {
160 *out = gen_header(o);
161 ctx->header_done = TRUE;
163 *out = g_string_sized_new(512);
167 static void handle_analog_frame(struct context *ctx,
168 const struct sr_datafeed_analog *analog)
170 unsigned int numch, nums, i, j, s;
173 numch = g_slist_length(analog->channels);
174 if ((unsigned int)analog->num_samples > numch)
175 nums = analog->num_samples / numch;
180 l = analog->channels;
181 for (i = 0; i < nums; i++) {
182 for (j = 0; j < ctx->num_analog_channels; j++) {
183 if (ctx->analog_channels[j] == l->data)
184 ctx->analog_vals[j] = analog->data[s++];
190 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
193 const struct sr_datafeed_meta *meta;
194 const struct sr_datafeed_logic *logic;
195 const struct sr_datafeed_analog *analog;
196 const struct sr_config *src;
200 uint64_t i, j, k, nums, numch;
207 if (!(ctx = o->priv))
210 switch (packet->type) {
212 meta = packet->payload;
213 for (l = meta->config; l; l = l->next) {
215 if (src->key != SR_CONF_SAMPLERATE)
217 ctx->samplerate = g_variant_get_uint64(src->data);
220 case SR_DF_FRAME_BEGIN:
222 * Special case - we start gathering data from analog channels
223 * and wait for SR_DF_FRAME_END to dump it.
225 memset(ctx->analog_vals, 0, sizeof(float) * ctx->num_analog_channels);
229 case SR_DF_FRAME_END:
231 * Dump gathered data.
233 init_output(out, ctx, o);
235 for (i = 0, j = 0; i < ctx->num_enabled_channels; i++) {
236 if (ctx->channels[i]->type == SR_CHANNEL_ANALOG) {
237 g_string_append_printf(*out, "%f",
238 ctx->analog_vals[j++]);
240 g_string_append_c(*out, ctx->separator);
242 g_string_truncate(*out, (*out)->len - 1);
243 g_string_append_printf(*out, "\n");
245 ctx->inframe = FALSE;
248 logic = packet->payload;
249 init_output(out, ctx, o);
251 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
252 for (j = 0; j < ctx->num_enabled_channels; j++) {
253 if (ctx->channels[j]->type == SR_CHANNEL_LOGIC) {
254 idx = ctx->channels[j]->index;
255 p = logic->data + i + idx / 8;
256 c = *p & (1 << (idx % 8));
257 g_string_append_c(*out, c ? '1' : '0');
259 g_string_append_c(*out, ctx->separator);
262 /* Drop last separator. */
263 g_string_truncate(*out, (*out)->len - 1);
265 g_string_append_printf(*out, "\n");
269 analog = packet->payload;
272 handle_analog_frame(ctx, analog);
276 init_output(out, ctx, o);
280 numch = g_slist_length(analog->channels);
281 if ((unsigned int)analog->num_samples > numch)
282 nums = analog->num_samples / numch;
286 for (i = 0; i < nums; i++) {
287 for (j = 0; j < ctx->num_enabled_channels; j++) {
288 if (ctx->channels[j]->type == SR_CHANNEL_ANALOG) {
290 l = analog->channels;
292 if (ctx->channels[j] == l->data) {
293 g_string_append_printf(*out,
294 "%f", analog->data[k++]);
299 g_string_append_c(*out, ctx->separator);
301 g_string_truncate(*out, (*out)->len - 1);
302 g_string_append_printf(*out, "\n");
305 /* TODO case SR_DF_ANALOG2: */
311 static int cleanup(struct sr_output *o)
320 g_free(ctx->channels);
321 g_free(ctx->analog_channels);
322 g_free(ctx->analog_vals);
330 SR_PRIV struct sr_output_module output_csv = {
333 .desc = "Comma-separated values",
334 .exts = (const char*[]){"csv", NULL},