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_probes;
32 unsigned int unitsize;
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 * probe LAs) as ASCII/hex etc. etc.
50 static int init(struct sr_output *o)
53 struct sr_channel *probe;
65 ctx = g_try_malloc0(sizeof(struct context));
68 /* Get the number of probes, and the unitsize. */
69 for (l = o->sdi->probes; l; l = l->next) {
71 if (probe->type != SR_PROBE_LOGIC)
75 ctx->num_enabled_probes++;
78 ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
80 num_probes = g_slist_length(o->sdi->probes);
82 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
84 ctx->samplerate = g_variant_get_uint64(gvar);
85 g_variant_unref(gvar);
90 ctx->header = g_string_sized_new(512);
95 g_string_append_printf(ctx->header, "; CSV, generated by %s on %s",
96 PACKAGE_STRING, ctime(&t));
97 g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n",
100 /* Columns / channels */
101 g_string_append_printf(ctx->header, "; Channels (%d/%d):",
102 ctx->num_enabled_probes, num_probes);
103 for (l = o->sdi->probes; l; l = l->next) {
105 if (probe->type != SR_PROBE_LOGIC)
109 g_string_append_printf(ctx->header, " %s,", probe->name);
112 /* Drop last separator. */
113 g_string_truncate(ctx->header, ctx->header->len - 1);
114 g_string_append_printf(ctx->header, "\n");
119 static int receive(struct sr_output *o, const struct sr_dev_inst *sdi,
120 const struct sr_datafeed_packet *packet, GString **out)
122 const struct sr_datafeed_logic *logic;
132 if (!(ctx = o->internal))
135 switch (packet->type) {
137 logic = packet->payload;
140 * First data packet: prime the output with the
141 * previously prepared header.
146 *out = g_string_sized_new(512);
149 for (i = 0; i <= logic->length - ctx->unitsize; i += ctx->unitsize) {
150 for (j = 0; j < ctx->num_enabled_probes; j++) {
151 p = logic->data + i + j / 8;
152 c = *p & (1 << (j % 8));
153 g_string_append_c(*out, c ? '1' : '0');
154 g_string_append_c(*out, ctx->separator);
157 /* Drop last separator. */
158 g_string_truncate(*out, (*out)->len - 1);
160 g_string_append_printf(*out, "\n");
172 static int cleanup(struct sr_output *o)
182 g_string_free(ctx->header, TRUE);
190 SR_PRIV struct sr_output_format output_csv = {
192 .description = "Comma-separated values (CSV)",
193 .df_type = SR_DF_LOGIC,