]>
Commit | Line | Data |
---|---|---|
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 | |
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 | |
19 | */ | |
20 | ||
6ec6c43b | 21 | #include <config.h> |
02604ed6 UH |
22 | #include <stdlib.h> |
23 | #include <string.h> | |
24 | #include <glib.h> | |
c1aae900 | 25 | #include <libsigrok/libsigrok.h> |
45c59c8b | 26 | #include "libsigrok-internal.h" |
02604ed6 | 27 | |
3544f848 | 28 | #define LOG_PREFIX "output/csv" |
a944a84b | 29 | |
02604ed6 | 30 | struct context { |
ba7dd8bb | 31 | unsigned int num_enabled_channels; |
02604ed6 | 32 | uint64_t samplerate; |
02604ed6 | 33 | char separator; |
0f3d8c89 | 34 | gboolean header_done; |
c04cf9aa BG |
35 | struct sr_channel **channels; |
36 | ||
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; | |
41 | gboolean inframe; | |
02604ed6 UH |
42 | }; |
43 | ||
44 | /* | |
45 | * TODO: | |
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 | |
ba7dd8bb | 52 | * channel LAs) as ASCII/hex etc. etc. |
02604ed6 UH |
53 | * - Trigger support. |
54 | */ | |
55 | ||
a755b0e1 | 56 | static int init(struct sr_output *o, GHashTable *options) |
02604ed6 UH |
57 | { |
58 | struct context *ctx; | |
ba7dd8bb | 59 | struct sr_channel *ch; |
02604ed6 | 60 | GSList *l; |
c04cf9aa | 61 | int i, j; |
02604ed6 | 62 | |
a755b0e1 BV |
63 | (void)options; |
64 | ||
0f3d8c89 | 65 | if (!o || !o->sdi) |
02604ed6 | 66 | return SR_ERR_ARG; |
02604ed6 | 67 | |
2a035e53 | 68 | ctx = g_malloc0(sizeof(struct context)); |
d686c5ec | 69 | o->priv = ctx; |
0f3d8c89 | 70 | ctx->separator = ','; |
02604ed6 | 71 | |
ba7dd8bb UH |
72 | /* Get the number of channels, and the unitsize. */ |
73 | for (l = o->sdi->channels; l; l = l->next) { | |
74 | ch = l->data; | |
c04cf9aa BG |
75 | if (ch->enabled) { |
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++; | |
81 | } | |
02604ed6 | 82 | } |
c04cf9aa BG |
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); | |
02604ed6 | 88 | |
0f3d8c89 | 89 | /* Once more to map the enabled channels. */ |
c04cf9aa | 90 | for (i = 0, l = o->sdi->channels, j = 0; l; l = l->next) { |
0f3d8c89 | 91 | ch = l->data; |
c04cf9aa BG |
92 | if (ch->enabled) { |
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; | |
98 | } | |
99 | ||
0f3d8c89 | 100 | } |
02604ed6 | 101 | |
0f3d8c89 BV |
102 | return SR_OK; |
103 | } | |
02604ed6 | 104 | |
a755b0e1 | 105 | static GString *gen_header(const struct sr_output *o) |
0f3d8c89 BV |
106 | { |
107 | struct context *ctx; | |
108 | struct sr_channel *ch; | |
109 | GVariant *gvar; | |
110 | GString *header; | |
111 | GSList *l; | |
112 | time_t t; | |
113 | int num_channels, i; | |
114 | char *samplerate_s; | |
02604ed6 | 115 | |
d686c5ec | 116 | ctx = o->priv; |
0f3d8c89 | 117 | header = g_string_sized_new(512); |
02604ed6 UH |
118 | |
119 | /* Some metadata */ | |
0f3d8c89 | 120 | t = time(NULL); |
b9eb8e1a DE |
121 | g_string_append_printf(header, "; CSV, generated by %s %s on %s", |
122 | PACKAGE_NAME, SR_PACKAGE_VERSION_STRING, ctime(&t)); | |
02604ed6 UH |
123 | |
124 | /* Columns / channels */ | |
0f3d8c89 BV |
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++) { | |
ba7dd8bb | 129 | ch = l->data; |
c04cf9aa BG |
130 | if (ch->enabled && |
131 | (ch->type == SR_CHANNEL_LOGIC || | |
132 | ch->type == SR_CHANNEL_ANALOG)) | |
133 | g_string_append_printf(header, " %s,", ch->name); | |
1c5b099a | 134 | } |
ba7dd8bb | 135 | if (o->sdi->channels) |
e36aae98 | 136 | /* Drop last separator. */ |
0f3d8c89 BV |
137 | g_string_truncate(header, header->len - 1); |
138 | g_string_append_printf(header, "\n"); | |
139 | ||
140 | if (ctx->samplerate == 0) { | |
141 | if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE, | |
142 | &gvar) == SR_OK) { | |
143 | ctx->samplerate = g_variant_get_uint64(gvar); | |
144 | g_variant_unref(gvar); | |
145 | } | |
146 | } | |
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); | |
151 | } | |
02604ed6 | 152 | |
0f3d8c89 | 153 | return header; |
02604ed6 UH |
154 | } |
155 | ||
c04cf9aa BG |
156 | static void init_output(GString **out, struct context *ctx, |
157 | const struct sr_output *o) | |
158 | { | |
159 | if (!ctx->header_done) { | |
160 | *out = gen_header(o); | |
161 | ctx->header_done = TRUE; | |
162 | } else { | |
163 | *out = g_string_sized_new(512); | |
164 | } | |
165 | } | |
166 | ||
167 | static void handle_analog_frame(struct context *ctx, | |
168 | const struct sr_datafeed_analog *analog) | |
169 | { | |
170 | unsigned int numch, nums, i, j, s; | |
171 | GSList *l; | |
172 | ||
173 | numch = g_slist_length(analog->channels); | |
174 | if ((unsigned int)analog->num_samples > numch) | |
175 | nums = analog->num_samples / numch; | |
176 | else | |
177 | nums = 1; | |
178 | ||
179 | s = 0; | |
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++]; | |
185 | } | |
186 | l = l->next; | |
187 | } | |
188 | } | |
189 | ||
a755b0e1 | 190 | static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet, |
dba3e682 | 191 | GString **out) |
02604ed6 | 192 | { |
0f3d8c89 | 193 | const struct sr_datafeed_meta *meta; |
4829d37d | 194 | const struct sr_datafeed_logic *logic; |
c04cf9aa | 195 | const struct sr_datafeed_analog *analog; |
0f3d8c89 BV |
196 | const struct sr_config *src; |
197 | GSList *l; | |
02604ed6 | 198 | struct context *ctx; |
2a035e53 | 199 | int idx; |
c04cf9aa | 200 | uint64_t i, j, k, nums, numch; |
e96cf218 | 201 | gchar *p, c; |
c04cf9aa | 202 | int ret = SR_OK; |
02604ed6 | 203 | |
4829d37d BV |
204 | *out = NULL; |
205 | if (!o || !o->sdi) | |
02604ed6 | 206 | return SR_ERR_ARG; |
d686c5ec | 207 | if (!(ctx = o->priv)) |
02604ed6 | 208 | return SR_ERR_ARG; |
02604ed6 | 209 | |
4829d37d | 210 | switch (packet->type) { |
0f3d8c89 BV |
211 | case SR_DF_META: |
212 | meta = packet->payload; | |
213 | for (l = meta->config; l; l = l->next) { | |
214 | src = l->data; | |
215 | if (src->key != SR_CONF_SAMPLERATE) | |
216 | continue; | |
217 | ctx->samplerate = g_variant_get_uint64(src->data); | |
218 | } | |
219 | break; | |
c04cf9aa BG |
220 | case SR_DF_FRAME_BEGIN: |
221 | /* | |
222 | * Special case - we start gathering data from analog channels | |
223 | * and wait for SR_DF_FRAME_END to dump it. | |
224 | */ | |
225 | memset(ctx->analog_vals, 0, sizeof(float) * ctx->num_analog_channels); | |
226 | ctx->inframe = TRUE; | |
b9300678 | 227 | ret = SR_OK; |
c04cf9aa BG |
228 | break; |
229 | case SR_DF_FRAME_END: | |
230 | /* | |
231 | * Dump gathered data. | |
232 | */ | |
233 | init_output(out, ctx, o); | |
234 | ||
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++]); | |
239 | } | |
240 | g_string_append_c(*out, ctx->separator); | |
241 | } | |
242 | g_string_truncate(*out, (*out)->len - 1); | |
243 | g_string_append_printf(*out, "\n"); | |
244 | ||
245 | ctx->inframe = FALSE; | |
246 | break; | |
4829d37d BV |
247 | case SR_DF_LOGIC: |
248 | logic = packet->payload; | |
c04cf9aa | 249 | init_output(out, ctx, o); |
4829d37d | 250 | |
2a035e53 | 251 | for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) { |
ba7dd8bb | 252 | for (j = 0; j < ctx->num_enabled_channels; j++) { |
c04cf9aa BG |
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'); | |
258 | } | |
e96cf218 | 259 | g_string_append_c(*out, ctx->separator); |
4829d37d | 260 | } |
e36aae98 | 261 | if (j) { |
54da58ca BV |
262 | /* Drop last separator. */ |
263 | g_string_truncate(*out, (*out)->len - 1); | |
264 | } | |
4829d37d BV |
265 | g_string_append_printf(*out, "\n"); |
266 | } | |
02604ed6 | 267 | break; |
c04cf9aa BG |
268 | case SR_DF_ANALOG: |
269 | analog = packet->payload; | |
270 | ||
271 | if (ctx->inframe) { | |
272 | handle_analog_frame(ctx, analog); | |
c04cf9aa BG |
273 | break; |
274 | } | |
275 | ||
276 | init_output(out, ctx, o); | |
277 | k = 0; | |
278 | l = NULL; | |
279 | ||
280 | numch = g_slist_length(analog->channels); | |
281 | if ((unsigned int)analog->num_samples > numch) | |
282 | nums = analog->num_samples / numch; | |
283 | else | |
284 | nums = 1; | |
285 | ||
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) { | |
289 | if (!l) | |
290 | l = analog->channels; | |
291 | ||
292 | if (ctx->channels[j] == l->data) { | |
293 | g_string_append_printf(*out, | |
294 | "%f", analog->data[k++]); | |
295 | } | |
296 | ||
297 | l = l->next; | |
298 | } | |
299 | g_string_append_c(*out, ctx->separator); | |
300 | } | |
301 | g_string_truncate(*out, (*out)->len - 1); | |
302 | g_string_append_printf(*out, "\n"); | |
303 | } | |
304 | break; | |
305 | /* TODO case SR_DF_ANALOG2: */ | |
02604ed6 UH |
306 | } |
307 | ||
c04cf9aa | 308 | return ret; |
02604ed6 UH |
309 | } |
310 | ||
4829d37d | 311 | static int cleanup(struct sr_output *o) |
02604ed6 UH |
312 | { |
313 | struct context *ctx; | |
02604ed6 | 314 | |
4829d37d | 315 | if (!o || !o->sdi) |
02604ed6 | 316 | return SR_ERR_ARG; |
02604ed6 | 317 | |
d686c5ec BV |
318 | if (o->priv) { |
319 | ctx = o->priv; | |
c04cf9aa BG |
320 | g_free(ctx->channels); |
321 | g_free(ctx->analog_channels); | |
322 | g_free(ctx->analog_vals); | |
d686c5ec BV |
323 | g_free(o->priv); |
324 | o->priv = NULL; | |
02604ed6 UH |
325 | } |
326 | ||
02604ed6 UH |
327 | return SR_OK; |
328 | } | |
329 | ||
a755b0e1 | 330 | SR_PRIV struct sr_output_module output_csv = { |
02604ed6 | 331 | .id = "csv", |
a755b0e1 BV |
332 | .name = "CSV", |
333 | .desc = "Comma-separated values", | |
8a174d23 | 334 | .exts = (const char*[]){"csv", NULL}, |
3cd4b381 | 335 | .flags = 0, |
a755b0e1 | 336 | .options = NULL, |
02604ed6 | 337 | .init = init, |
4829d37d BV |
338 | .receive = receive, |
339 | .cleanup = cleanup, | |
02604ed6 | 340 | }; |