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_probe *probe;
60 sr_err("%s: o was NULL", __func__);
65 sr_err("%s: o->sdi was NULL", __func__);
69 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
70 sr_err("%s: ctx malloc failed", __func__);
76 /* Get the number of probes, and the unitsize. */
77 for (l = o->sdi->probes; l; l = l->next) {
80 ctx->num_enabled_probes++;
83 ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
85 num_probes = g_slist_length(o->sdi->probes);
87 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
89 ctx->samplerate = g_variant_get_uint64(gvar);
90 g_variant_unref(gvar);
95 ctx->header = g_string_sized_new(512);
100 g_string_append_printf(ctx->header, "; CSV, generated by %s on %s",
101 PACKAGE_STRING, ctime(&t));
102 g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n",
105 /* Columns / channels */
106 g_string_append_printf(ctx->header, "; Channels (%d/%d): ",
107 ctx->num_enabled_probes, num_probes);
108 for (l = o->sdi->probes; l; l = l->next) {
111 g_string_append_printf(ctx->header, "%s, ", probe->name);
113 g_string_append_printf(ctx->header, "\n");
118 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
119 uint64_t *length_out)
124 sr_err("%s: o was NULL", __func__);
128 if (!(ctx = o->internal)) {
129 sr_err("%s: o->internal was NULL", __func__);
134 sr_err("%s: data_out was NULL", __func__);
138 switch (event_type) {
140 sr_dbg("%s: SR_DF_TRIGGER event", __func__);
146 sr_dbg("%s: SR_DF_END event", __func__);
154 sr_err("%s: unsupported event type: %d", __func__, event_type);
163 static int data(struct sr_output *o, const uint8_t *data_in,
164 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
168 uint64_t sample, i, j;
171 sr_err("%s: o was NULL", __func__);
175 if (!(ctx = o->internal)) {
176 sr_err("%s: o->internal was NULL", __func__);
181 sr_err("%s: data_in was NULL", __func__);
186 /* First data packet. */
187 outstr = ctx->header;
190 outstr = g_string_sized_new(512);
193 for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
194 memcpy(&sample, data_in + i, ctx->unitsize);
195 for (j = 0; j < ctx->num_enabled_probes; j++) {
196 g_string_append_printf(outstr, "%d%c",
197 (int)((sample & (1 << j)) >> j),
200 g_string_append_printf(outstr, "\n");
203 *data_out = (uint8_t *)outstr->str;
204 *length_out = outstr->len;
205 g_string_free(outstr, FALSE);
210 SR_PRIV struct sr_output_format output_csv = {
212 .description = "Comma-separated values (CSV)",
213 .df_type = SR_DF_LOGIC,