]> sigrok.org Git - libsigrok.git/blame - src/output/csv.c
output/csv: Avoid accumulated timestamp error for odd samplerates
[libsigrok.git] / src / output / csv.c
CommitLineData
02604ed6 1/*
50985c20 2 * This file is part of the libsigrok project.
02604ed6
UH
3 *
4 * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.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 2 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
2ea1fdf1 17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
02604ed6
UH
18 */
19
9e24c8bc
MM
20/*
21 * Options and their values:
22 *
23 * gnuplot: Write out a gnuplot interpreter script (.gpi file) to plot
24 * the datafile using the parameters given. It should be called
25 * from a gnuplot session with the data file name as a parameter
26 * after adjusting line styles, terminal, etc.
27 *
28 * scale: The gnuplot graphs are scaled so they all have the same
29 * peak-to-peak distance. Defaults to TRUE.
30 *
31 * value: The string used to separate values in a record. Defaults to ','.
32 *
33 * record: The string to use to separate records. Default is newline. gnuplot
34 * files must use newline.
35 *
36 * frame: The string to use when a frame ends. The default is a blank line.
37 * This may confuse some CSV parsers, but it makes gnuplot happy.
38 *
39 * comment: The string that starts a comment line. Defaults to ';'.
40 *
41 * header: Print header comment with capture metadata. Defaults to TRUE.
42 *
cad447d2
MM
43 * label: What to use for channel labels as the first line of output.
44 * Values are "channel", "units", "off". Defaults to "units".
9e24c8bc
MM
45 *
46 * time: Whether or not the first column should include the time the sample
5a273567 47 * was taken. Defaults to FALSE.
9e24c8bc
MM
48 *
49 * trigger: Whether or not to add a "trigger" column as the last column.
50 * Defaults to FALSE.
51 *
04a0e0dc 52 * dedup: Don't output duplicate rows. Defaults to FALSE. If time is off, then
9e24c8bc
MM
53 * this is forced to be off.
54 */
55
6ec6c43b 56#include <config.h>
65788048 57#include <math.h>
02604ed6
UH
58#include <stdlib.h>
59#include <string.h>
60#include <glib.h>
c1aae900 61#include <libsigrok/libsigrok.h>
45c59c8b 62#include "libsigrok-internal.h"
02604ed6 63
3544f848 64#define LOG_PREFIX "output/csv"
a944a84b 65
9e24c8bc
MM
66struct ctx_channel {
67 struct sr_channel *ch;
cad447d2 68 char *label;
9e24c8bc
MM
69 float min, max;
70};
71
02604ed6 72struct context {
9e24c8bc
MM
73 /* Options */
74 const char *gnuplot;
75 gboolean scale;
76 const char *value;
77 const char *record;
78 const char *frame;
79 const char *comment;
80 gboolean header, did_header;
cad447d2 81 gboolean label_do, label_did, label_names;
9e24c8bc
MM
82 gboolean time;
83 gboolean do_trigger;
84 gboolean dedup;
85
86 /* Plot data */
c04cf9aa 87 unsigned int num_analog_channels;
9e24c8bc
MM
88 unsigned int num_logic_channels;
89 struct ctx_channel *channels;
90
91 /* Metadata */
92 gboolean trigger;
93 uint32_t num_samples;
94 uint32_t channel_count, logic_channel_count;
95 uint32_t channels_seen;
01ac3eed
EPI
96 uint64_t sample_rate;
97 uint64_t sample_scale;
9e24c8bc
MM
98 uint64_t sample_time;
99 uint8_t *previous_sample;
100 float *analog_samples;
101 uint8_t *logic_samples;
102 const char *xlabel; /* Don't free: will point to a static string. */
103 const char *title; /* Don't free: will point into the driver struct. */
02604ed6
UH
104};
105
106/*
107 * TODO:
02604ed6 108 * - Option to print comma-separated bits, or whole bytes/words (for 8/16
ba7dd8bb 109 * channel LAs) as ASCII/hex etc. etc.
02604ed6
UH
110 */
111
a755b0e1 112static int init(struct sr_output *o, GHashTable *options)
02604ed6 113{
9e24c8bc 114 unsigned int i, analog_channels, logic_channels;
02604ed6 115 struct context *ctx;
ba7dd8bb 116 struct sr_channel *ch;
cad447d2 117 const char *label_string;
02604ed6 118 GSList *l;
a755b0e1 119
0f3d8c89 120 if (!o || !o->sdi)
02604ed6 121 return SR_ERR_ARG;
02604ed6 122
2a035e53 123 ctx = g_malloc0(sizeof(struct context));
d686c5ec 124 o->priv = ctx;
02604ed6 125
9e24c8bc
MM
126 /* Options */
127 ctx->gnuplot = g_strdup(g_variant_get_string(
128 g_hash_table_lookup(options, "gnuplot"), NULL));
129 ctx->scale = g_variant_get_boolean(g_hash_table_lookup(options, "scale"));
130 ctx->value = g_strdup(g_variant_get_string(
131 g_hash_table_lookup(options, "value"), NULL));
132 ctx->record = g_strdup(g_variant_get_string(
133 g_hash_table_lookup(options, "record"), NULL));
134 ctx->frame = g_strdup(g_variant_get_string(
135 g_hash_table_lookup(options, "frame"), NULL));
136 ctx->comment = g_strdup(g_variant_get_string(
137 g_hash_table_lookup(options, "comment"), NULL));
138 ctx->header = g_variant_get_boolean(g_hash_table_lookup(options, "header"));
139 ctx->time = g_variant_get_boolean(g_hash_table_lookup(options, "time"));
140 ctx->do_trigger = g_variant_get_boolean(g_hash_table_lookup(options, "trigger"));
cad447d2
MM
141 label_string = g_variant_get_string(
142 g_hash_table_lookup(options, "label"), NULL);
9e24c8bc
MM
143 ctx->dedup = g_variant_get_boolean(g_hash_table_lookup(options, "dedup"));
144 ctx->dedup &= ctx->time;
145
146 if (*ctx->gnuplot && g_strcmp0(ctx->record, "\n"))
147 sr_warn("gnuplot record separator must be newline.");
148
149 if (*ctx->gnuplot && strlen(ctx->value) > 1)
150 sr_warn("gnuplot doesn't support multichar value separators.");
151
cad447d2
MM
152 if ((ctx->label_did = ctx->label_do = g_strcmp0(label_string, "off") != 0))
153 ctx->label_names = g_strcmp0(label_string, "units") != 0;
154
9e24c8bc
MM
155 sr_dbg("gnuplot = '%s', scale = %d", ctx->gnuplot, ctx->scale);
156 sr_dbg("value = '%s', record = '%s', frame = '%s', comment = '%s'",
157 ctx->value, ctx->record, ctx->frame, ctx->comment);
cad447d2
MM
158 sr_dbg("header = %d, time = %d, do_trigger = %d, dedup = %d",
159 ctx->header, ctx->time, ctx->do_trigger, ctx->dedup);
160 sr_dbg("label_do = %d, label_names = %d", ctx->label_do, ctx->label_names);
9e24c8bc
MM
161
162 analog_channels = logic_channels = 0;
ba7dd8bb
UH
163 /* Get the number of channels, and the unitsize. */
164 for (l = o->sdi->channels; l; l = l->next) {
165 ch = l->data;
9e24c8bc
MM
166 if (ch->type == SR_CHANNEL_LOGIC) {
167 ctx->logic_channel_count++;
168 if (ch->enabled)
169 logic_channels++;
c04cf9aa 170 }
9e24c8bc
MM
171 if (ch->type == SR_CHANNEL_ANALOG && ch->enabled)
172 analog_channels++;
173 }
174 if (analog_channels) {
175 sr_info("Outputting %d analog values", analog_channels);
176 ctx->num_analog_channels = analog_channels;
177 }
178 if (logic_channels) {
179 sr_info("Outputting %d logic values", logic_channels);
180 ctx->num_logic_channels = logic_channels;
02604ed6 181 }
9e24c8bc
MM
182 ctx->channels = g_malloc(sizeof(struct ctx_channel)
183 * (ctx->num_analog_channels + ctx->num_logic_channels));
02604ed6 184
0f3d8c89 185 /* Once more to map the enabled channels. */
9e24c8bc
MM
186 ctx->channel_count = g_slist_length(o->sdi->channels);
187 for (i = 0, l = o->sdi->channels; l; l = l->next) {
0f3d8c89 188 ch = l->data;
c04cf9aa 189 if (ch->enabled) {
9e24c8bc
MM
190 if (ch->type == SR_CHANNEL_ANALOG) {
191 ctx->channels[i].min = FLT_MAX;
192 ctx->channels[i].max = FLT_MIN;
193 } else if (ch->type == SR_CHANNEL_LOGIC) {
194 ctx->channels[i].min = 0;
195 ctx->channels[i].max = 1;
196 } else {
197 sr_warn("Unknown channel type %d.", ch->type);
198 }
cad447d2
MM
199 if (ctx->label_do && ctx->label_names)
200 ctx->channels[i].label = ch->name;
9e24c8bc 201 ctx->channels[i++].ch = ch;
c04cf9aa 202 }
0f3d8c89 203 }
02604ed6 204
0f3d8c89
BV
205 return SR_OK;
206}
02604ed6 207
9e24c8bc
MM
208static const char *xlabels[] = {
209 "samples", "milliseconds", "microseconds", "nanoseconds", "picoseconds",
210 "femtoseconds", "attoseconds",
211};
212
213static GString *gen_header(const struct sr_output *o,
214 const struct sr_datafeed_header *hdr)
0f3d8c89
BV
215{
216 struct context *ctx;
217 struct sr_channel *ch;
218 GVariant *gvar;
219 GString *header;
a21fef07 220 GSList *channels, *l;
9e24c8bc 221 unsigned int num_channels, i;
0f3d8c89 222 char *samplerate_s;
02604ed6 223
d686c5ec 224 ctx = o->priv;
0f3d8c89 225 header = g_string_sized_new(512);
02604ed6 226
01ac3eed 227 if (ctx->sample_rate == 0) {
9e24c8bc
MM
228 if (sr_config_get(o->sdi->driver, o->sdi, NULL,
229 SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
01ac3eed 230 ctx->sample_rate = g_variant_get_uint64(gvar);
0f3d8c89
BV
231 g_variant_unref(gvar);
232 }
9e24c8bc
MM
233
234 i = 0;
01ac3eed
EPI
235 ctx->sample_scale = 1;
236 while (ctx->sample_scale < ctx->sample_rate) {
9e24c8bc 237 i++;
01ac3eed 238 ctx->sample_scale *= 1000;
9e24c8bc 239 }
9e24c8bc
MM
240 if (i < ARRAY_SIZE(xlabels))
241 ctx->xlabel = xlabels[i];
01ac3eed
EPI
242 sr_info("Set sample rate, scale to %" PRIu64 ", %" PRIu64 " %s",
243 ctx->sample_rate, ctx->sample_scale, ctx->xlabel);
0f3d8c89 244 }
cf1d5f17 245 ctx->title = (o->sdi && o->sdi->driver) ? o->sdi->driver->longname : "unknown";
9e24c8bc
MM
246
247 /* Some metadata */
248 if (ctx->header && !ctx->did_header) {
249 /* save_gnuplot knows how many lines we print. */
250 g_string_append_printf(header,
251 "%s CSV generated by %s %s\n%s from %s on %s",
252 ctx->comment, PACKAGE_NAME,
2868bca3 253 sr_package_version_string_get(), ctx->comment,
9e24c8bc
MM
254 ctx->title, ctime(&hdr->starttime.tv_sec));
255
256 /* Columns / channels */
a21fef07
GS
257 channels = o->sdi ? o->sdi->channels : NULL;
258 num_channels = g_slist_length(channels);
9e24c8bc
MM
259 g_string_append_printf(header, "%s Channels (%d/%d):",
260 ctx->comment, ctx->num_analog_channels +
261 ctx->num_logic_channels, num_channels);
a21fef07 262 for (l = channels; l; l = l->next) {
9e24c8bc
MM
263 ch = l->data;
264 if (ch->enabled)
265 g_string_append_printf(header, " %s,", ch->name);
266 }
a21fef07 267 if (channels) {
9e24c8bc
MM
268 /* Drop last separator. */
269 g_string_truncate(header, header->len - 1);
a21fef07 270 }
9e24c8bc 271 g_string_append_printf(header, "\n");
01ac3eed
EPI
272 if (ctx->sample_rate != 0) {
273 samplerate_s = sr_samplerate_string(ctx->sample_rate);
9e24c8bc
MM
274 g_string_append_printf(header, "%s Samplerate: %s\n",
275 ctx->comment, samplerate_s);
276 g_free(samplerate_s);
277 }
278 ctx->did_header = TRUE;
0f3d8c89 279 }
02604ed6 280
0f3d8c89 281 return header;
02604ed6
UH
282}
283
9e24c8bc
MM
284/*
285 * Analog devices can have samples of different types. Since each
286 * packet has only one meaning, it is restricted to having at most one
287 * type of data. So they can send multiple packets for a single sample.
288 * To further complicate things, they can send multiple samples in a
289 * single packet.
290 *
291 * So we need to pull any channels of interest out of a packet and save
292 * them until we have complete samples to output. Some devices make this
293 * simple by sending DF_FRAME_BEGIN/DF_FRAME_END packets, the latter of which
294 * signals the end of a set of samples, so we can dump things there.
295 *
296 * At least one driver (the demo driver) sends packets that contain parts of
297 * multiple samples without wrapping them in DF_FRAME. Possibly this driver
298 * is buggy, but it's also the standard for testing, so it has to be supported
299 * as is.
300 *
301 * Many assumptions about the "shape" of the data here:
302 *
303 * All of the data for a channel is assumed to be in one frame;
304 * otherwise the data in the second packet will overwrite the data in
305 * the first packet.
306 */
307static void process_analog(struct context *ctx,
308 const struct sr_datafeed_analog *analog)
309{
310 int ret;
a551cb09
GS
311 size_t num_rcvd_ch, num_have_ch;
312 size_t idx_have, idx_smpl, idx_rcvd;
823b0e29 313 size_t idx_send;
9e24c8bc
MM
314 struct sr_analog_meaning *meaning;
315 GSList *l;
316 float *fdata = NULL;
b078dddb 317 struct sr_channel *ch;
9e24c8bc
MM
318
319 if (!ctx->analog_samples) {
320 ctx->analog_samples = g_malloc(analog->num_samples
321 * sizeof(float) * ctx->num_analog_channels);
322 if (!ctx->num_samples)
323 ctx->num_samples = analog->num_samples;
324 }
325 if (ctx->num_samples != analog->num_samples)
326 sr_warn("Expecting %u analog samples, got %u.",
327 ctx->num_samples, analog->num_samples);
328
329 meaning = analog->meaning;
a551cb09
GS
330 num_rcvd_ch = g_slist_length(meaning->channels);
331 ctx->channels_seen += num_rcvd_ch;
332 sr_dbg("Processing packet of %zu analog channels", num_rcvd_ch);
333 fdata = g_malloc(analog->num_samples * num_rcvd_ch * sizeof(float));
9e24c8bc
MM
334 if ((ret = sr_analog_to_float(analog, fdata)) != SR_OK)
335 sr_warn("Problems converting data to floating point values.");
336
a551cb09 337 num_have_ch = ctx->num_analog_channels + ctx->num_logic_channels;
823b0e29 338 idx_send = 0;
a551cb09
GS
339 for (idx_have = 0; idx_have < num_have_ch; idx_have++) {
340 if (ctx->channels[idx_have].ch->type != SR_CHANNEL_ANALOG)
b078dddb
GS
341 continue;
342 sr_dbg("Looking for channel %s",
a551cb09
GS
343 ctx->channels[idx_have].ch->name);
344 for (l = meaning->channels, idx_rcvd = 0; l; l = l->next, idx_rcvd++) {
b078dddb
GS
345 ch = l->data;
346 sr_dbg("Checking %s", ch->name);
a551cb09 347 if (ctx->channels[idx_have].ch != ch)
b078dddb
GS
348 continue;
349 if (ctx->label_do && !ctx->label_names) {
350 sr_analog_unit_to_string(analog,
a551cb09 351 &ctx->channels[idx_have].label);
9e24c8bc 352 }
a551cb09 353 for (idx_smpl = 0; idx_smpl < analog->num_samples; idx_smpl++)
823b0e29 354 ctx->analog_samples[idx_smpl * ctx->num_analog_channels + idx_send] = fdata[idx_smpl * num_rcvd_ch + idx_rcvd];
b078dddb 355 break;
9e24c8bc 356 }
823b0e29 357 idx_send++;
9e24c8bc
MM
358 }
359 g_free(fdata);
360}
361
362/*
363 * We treat logic packets the same as analog packets, though it's not
364 * strictly required. This allows us to process mixed signals properly.
365 */
366static void process_logic(struct context *ctx,
367 const struct sr_datafeed_logic *logic)
c04cf9aa 368{
9e24c8bc
MM
369 unsigned int i, j, ch, num_samples;
370 int idx;
371 uint8_t *sample;
372
373 num_samples = logic->length / logic->unitsize;
374 ctx->channels_seen += ctx->logic_channel_count;
375 sr_dbg("Logic packet had %d channels", logic->unitsize * 8);
376 if (!ctx->logic_samples) {
377 ctx->logic_samples = g_malloc(num_samples * ctx->num_logic_channels);
378 if (!ctx->num_samples)
379 ctx->num_samples = num_samples;
380 }
381 if (ctx->num_samples != num_samples)
382 sr_warn("Expecting %u samples, got %u",
383 ctx->num_samples, num_samples);
384
385 for (j = ch = 0; ch < ctx->num_logic_channels; j++) {
386 if (ctx->channels[j].ch->type == SR_CHANNEL_LOGIC) {
d3cc09a6
WS
387 for (i = 0; i < num_samples; i++) {
388 sample = logic->data + i * logic->unitsize;
10892c5b 389 idx = ctx->channels[j].ch->index;
cad447d2 390 if (ctx->label_do && !ctx->label_names)
6a235225 391 ctx->channels[j].label = "logic";
9e24c8bc
MM
392 ctx->logic_samples[i * ctx->num_logic_channels + ch] = sample[idx / 8] & (1 << (idx % 8));
393 }
394 ch++;
395 }
396 }
397}
398
399static void dump_saved_values(struct context *ctx, GString **out)
400{
401 unsigned int i, j, analog_size, num_channels;
402 float *analog_sample, value;
403 uint8_t *logic_sample;
404
405 /* If we haven't seen samples we're expecting, skip them. */
406 if ((ctx->num_analog_channels && !ctx->analog_samples) ||
407 (ctx->num_logic_channels && !ctx->logic_samples)) {
408 sr_warn("Discarding partial packet");
c04cf9aa 409 } else {
9e24c8bc
MM
410 sr_info("Dumping %u samples", ctx->num_samples);
411
c04cf9aa 412 *out = g_string_sized_new(512);
9e24c8bc
MM
413 num_channels =
414 ctx->num_logic_channels + ctx->num_analog_channels;
415
cad447d2 416 if (ctx->label_do) {
9e24c8bc 417 if (ctx->time)
cad447d2
MM
418 g_string_append_printf(*out, "%s%s",
419 ctx->label_names ? "Time" :
420 ctx->xlabel, ctx->value);
9e24c8bc
MM
421 for (i = 0; i < num_channels; i++) {
422 g_string_append_printf(*out, "%s%s",
cad447d2
MM
423 ctx->channels[i].label, ctx->value);
424 if (ctx->channels[i].ch->type == SR_CHANNEL_ANALOG
425 && ctx->label_names)
426 g_free(ctx->channels[i].label);
9e24c8bc
MM
427 }
428 if (ctx->do_trigger)
429 g_string_append_printf(*out, "Trigger%s",
430 ctx->value);
431 /* Drop last separator. */
432 g_string_truncate(*out, (*out)->len - 1);
433 g_string_append(*out, ctx->record);
434
cad447d2 435 ctx->label_do = FALSE;
9e24c8bc
MM
436 }
437
438 analog_size = ctx->num_analog_channels * sizeof(float);
439 if (ctx->dedup && !ctx->previous_sample)
440 ctx->previous_sample = g_malloc0(analog_size + ctx->num_logic_channels);
441
442 for (i = 0; i < ctx->num_samples; i++) {
01ac3eed 443 ctx->sample_time = (ctx->sample_scale * i) / ctx->sample_rate;
9e24c8bc
MM
444 analog_sample =
445 &ctx->analog_samples[i * ctx->num_analog_channels];
446 logic_sample =
447 &ctx->logic_samples[i * ctx->num_logic_channels];
448
449 if (ctx->dedup) {
450 if (i > 0 && i < ctx->num_samples - 1 &&
451 !memcmp(logic_sample, ctx->previous_sample,
452 ctx->num_logic_channels) &&
453 !memcmp(analog_sample,
454 ctx->previous_sample +
455 ctx->num_logic_channels,
456 analog_size))
457 continue;
458 memcpy(ctx->previous_sample, logic_sample,
459 ctx->num_logic_channels);
460 memcpy(ctx->previous_sample
461 + ctx->num_logic_channels,
462 analog_sample, analog_size);
463 }
464
465 if (ctx->time)
8005151b 466 g_string_append_printf(*out, "%" PRIu64 "%s",
9e24c8bc
MM
467 ctx->sample_time, ctx->value);
468
469 for (j = 0; j < num_channels; j++) {
470 if (ctx->channels[j].ch->type == SR_CHANNEL_ANALOG) {
471 value = ctx->analog_samples[i * ctx->num_analog_channels + j];
472 ctx->channels[j].max =
473 fmax(value, ctx->channels[j].max);
474 ctx->channels[j].min =
475 fmin(value, ctx->channels[j].min);
476 g_string_append_printf(*out, "%g%s",
477 value, ctx->value);
478 } else if (ctx->channels[j].ch->type == SR_CHANNEL_LOGIC) {
479 g_string_append_printf(*out, "%c%s",
480 ctx->logic_samples[i * ctx->num_logic_channels + j] ? '1' : '0', ctx->value);
481 } else {
482 sr_warn("Unexpected channel type: %d",
483 ctx->channels[i].ch->type);
484 }
485 }
486
487 if (ctx->do_trigger) {
488 g_string_append_printf(*out, "%d%s",
489 ctx->trigger, ctx->value);
490 ctx->trigger = FALSE;
491 }
492 g_string_truncate(*out, (*out)->len - 1);
493 g_string_append(*out, ctx->record);
494 }
c04cf9aa 495 }
9e24c8bc
MM
496
497 /* Discard all of the working space. */
498 g_free(ctx->previous_sample);
499 g_free(ctx->analog_samples);
500 g_free(ctx->logic_samples);
501 ctx->channels_seen = 0;
502 ctx->num_samples = 0;
503 ctx->previous_sample = NULL;
504 ctx->analog_samples = NULL;
505 ctx->logic_samples = NULL;
c04cf9aa
BG
506}
507
9e24c8bc 508static void save_gnuplot(struct context *ctx)
c04cf9aa 509{
9e24c8bc
MM
510 float offset, max, sum;
511 unsigned int i, num_channels;
512 GString *script;
513
514 script = g_string_sized_new(512);
515 g_string_append_printf(script, "set datafile separator '%s'\n",
516 ctx->value);
cad447d2 517 if (ctx->label_did)
9e24c8bc
MM
518 g_string_append(script, "set key autotitle columnhead\n");
519 if (ctx->xlabel && ctx->time)
520 g_string_append_printf(script, "set xlabel '%s'\n",
521 ctx->xlabel);
522
523 g_string_append(script, "plot ");
524
525 num_channels = ctx->num_analog_channels + ctx->num_logic_channels;
526
527 /* Graph position and scaling. */
528 max = FLT_MIN;
529 sum = 0;
530 for (i = 0; i < num_channels; i++) {
531 ctx->channels[i].max =
532 ctx->channels[i].max - ctx->channels[i].min;
533 max = fmax(max, ctx->channels[i].max);
534 sum += ctx->channels[i].max;
535 }
536 sum = (ctx->scale ? max : sum / num_channels) / 4;
537 offset = sum;
538 for (i = num_channels; i > 0;) {
539 i--;
540 ctx->channels[i].min = offset - ctx->channels[i].min;
541 offset += sum + (ctx->scale ? max : ctx->channels[i].max);
542 }
c04cf9aa 543
9e24c8bc
MM
544 for (i = 0; i < num_channels; i++) {
545 sr_spew("Channel %d, min %g, max %g", i, ctx->channels[i].min,
546 ctx->channels[i].max);
547 g_string_append(script, "ARG1 ");
548 if (ctx->did_header)
549 g_string_append(script, "skip 4 ");
550 g_string_append_printf(script, "using %u:($%u * %g + %g), ",
551 ctx->time, i + 1 + ctx->time, ctx->scale ?
552 max / ctx->channels[i].max : 1, ctx->channels[i].min);
553 offset += 1.1 * (ctx->channels[i].max - ctx->channels[i].min);
c04cf9aa 554 }
9e24c8bc
MM
555 g_string_truncate(script, script->len - 2);
556 g_file_set_contents(ctx->gnuplot, script->str, script->len, NULL);
557 g_string_free(script, TRUE);
c04cf9aa
BG
558}
559
9e24c8bc
MM
560static int receive(const struct sr_output *o,
561 const struct sr_datafeed_packet *packet, GString **out)
02604ed6
UH
562{
563 struct context *ctx;
02604ed6 564
4829d37d
BV
565 *out = NULL;
566 if (!o || !o->sdi)
02604ed6 567 return SR_ERR_ARG;
d686c5ec 568 if (!(ctx = o->priv))
02604ed6 569 return SR_ERR_ARG;
02604ed6 570
9e24c8bc 571 sr_dbg("Got packet of type %d", packet->type);
4829d37d 572 switch (packet->type) {
9e24c8bc
MM
573 case SR_DF_HEADER:
574 *out = gen_header(o, packet->payload);
0f3d8c89 575 break;
9e24c8bc
MM
576 case SR_DF_TRIGGER:
577 ctx->trigger = TRUE;
c04cf9aa 578 break;
4829d37d 579 case SR_DF_LOGIC:
9e24c8bc 580 process_logic(ctx, packet->payload);
02604ed6 581 break;
edb691fc 582 case SR_DF_ANALOG:
9e24c8bc
MM
583 process_analog(ctx, packet->payload);
584 break;
585 case SR_DF_FRAME_BEGIN:
586 *out = g_string_new(ctx->frame);
317c97be 587 /* Fallthrough */
9e24c8bc
MM
588 case SR_DF_END:
589 /* Got to end of frame/session with part of the data. */
590 if (ctx->channels_seen)
591 ctx->channels_seen = ctx->channel_count;
592 if (*ctx->gnuplot)
593 save_gnuplot(ctx);
c04cf9aa 594 break;
02604ed6
UH
595 }
596
9e24c8bc
MM
597 /* If we've got them all, dump the values. */
598 if (ctx->channels_seen >= ctx->channel_count)
599 dump_saved_values(ctx, out);
600
601 return SR_OK;
02604ed6
UH
602}
603
4829d37d 604static int cleanup(struct sr_output *o)
02604ed6
UH
605{
606 struct context *ctx;
02604ed6 607
4829d37d 608 if (!o || !o->sdi)
02604ed6 609 return SR_ERR_ARG;
02604ed6 610
d686c5ec
BV
611 if (o->priv) {
612 ctx = o->priv;
9e24c8bc
MM
613 g_free((gpointer)ctx->record);
614 g_free((gpointer)ctx->frame);
615 g_free((gpointer)ctx->comment);
616 g_free((gpointer)ctx->gnuplot);
7e7d7bc0 617 g_free((gpointer)ctx->value);
9e24c8bc 618 g_free(ctx->previous_sample);
c04cf9aa 619 g_free(ctx->channels);
d686c5ec
BV
620 g_free(o->priv);
621 o->priv = NULL;
02604ed6
UH
622 }
623
02604ed6
UH
624 return SR_OK;
625}
626
9e24c8bc
MM
627static struct sr_option options[] = {
628 {"gnuplot", "gnuplot", "gnuplot script file name", NULL, NULL},
629 {"scale", "scale", "Scale gnuplot graphs", NULL, NULL},
630 {"value", "Value separator", "Character to print between values", NULL, NULL},
631 {"record", "Record separator", "String to print between records", NULL, NULL},
51d64bf5 632 {"frame", "Frame separator", "String to print between frames", NULL, NULL},
9e24c8bc
MM
633 {"comment", "Comment start string", "String used at start of comment lines", NULL, NULL},
634 {"header", "Output header", "Output header comment with capture metdata", NULL, NULL},
cad447d2 635 {"label", "Label values", "Type of column labels", NULL, NULL},
9e24c8bc
MM
636 {"time", "Time column", "Output sample time as column 1", NULL, NULL},
637 {"trigger", "Trigger column", "Output trigger indicator as last column ", NULL, NULL},
638 {"dedup", "Dedup rows", "Set to false to output duplicate rows", NULL, NULL},
639 ALL_ZERO
640};
641
642static const struct sr_option *get_options(void)
643{
7c59d8f3
UH
644 GSList *l = NULL;
645
9e24c8bc
MM
646 if (!options[0].def) {
647 options[0].def = g_variant_ref_sink(g_variant_new_string(""));
648 options[1].def = g_variant_ref_sink(g_variant_new_boolean(TRUE));
649 options[2].def = g_variant_ref_sink(g_variant_new_string(","));
650 options[3].def = g_variant_ref_sink(g_variant_new_string("\n"));
651 options[4].def = g_variant_ref_sink(g_variant_new_string("\n"));
652 options[5].def = g_variant_ref_sink(g_variant_new_string(";"));
653 options[6].def = g_variant_ref_sink(g_variant_new_boolean(TRUE));
cad447d2 654 options[7].def = g_variant_ref_sink(g_variant_new_string("units"));
7c59d8f3
UH
655 l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("units")));
656 l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("channel")));
657 l = g_slist_append(l, g_variant_ref_sink(g_variant_new_string("off")));
658 options[7].values = l;
5a273567 659 options[8].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
9e24c8bc 660 options[9].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
04a0e0dc 661 options[10].def = g_variant_ref_sink(g_variant_new_boolean(FALSE));
9e24c8bc
MM
662 }
663
664 return options;
665}
666
a755b0e1 667SR_PRIV struct sr_output_module output_csv = {
02604ed6 668 .id = "csv",
a755b0e1
BV
669 .name = "CSV",
670 .desc = "Comma-separated values",
9e24c8bc 671 .exts = (const char *[]){"csv", NULL},
3cd4b381 672 .flags = 0,
9e24c8bc 673 .options = get_options,
02604ed6 674 .init = init,
4829d37d
BV
675 .receive = receive,
676 .cleanup = cleanup,
02604ed6 677};