]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
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 | ||
21 | #include <config.h> | |
22 | #include <stdlib.h> | |
23 | #include <string.h> | |
24 | #include <glib.h> | |
25 | #include <libsigrok/libsigrok.h> | |
26 | #include "libsigrok-internal.h" | |
27 | ||
28 | #define LOG_PREFIX "output/csv" | |
29 | ||
30 | struct context { | |
31 | unsigned int num_enabled_channels; | |
32 | uint64_t samplerate; | |
33 | char separator; | |
34 | gboolean header_done; | |
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; | |
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 | |
52 | * channel LAs) as ASCII/hex etc. etc. | |
53 | * - Trigger support. | |
54 | */ | |
55 | ||
56 | static int init(struct sr_output *o, GHashTable *options) | |
57 | { | |
58 | struct context *ctx; | |
59 | struct sr_channel *ch; | |
60 | GSList *l; | |
61 | int i, j; | |
62 | ||
63 | (void)options; | |
64 | ||
65 | if (!o || !o->sdi) | |
66 | return SR_ERR_ARG; | |
67 | ||
68 | ctx = g_malloc0(sizeof(struct context)); | |
69 | o->priv = ctx; | |
70 | ctx->separator = ','; | |
71 | ||
72 | /* Get the number of channels, and the unitsize. */ | |
73 | for (l = o->sdi->channels; l; l = l->next) { | |
74 | ch = l->data; | |
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 | } | |
82 | } | |
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); | |
88 | ||
89 | /* Once more to map the enabled channels. */ | |
90 | for (i = 0, l = o->sdi->channels, j = 0; l; l = l->next) { | |
91 | ch = l->data; | |
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 | ||
100 | } | |
101 | ||
102 | return SR_OK; | |
103 | } | |
104 | ||
105 | static GString *gen_header(const struct sr_output *o) | |
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; | |
115 | ||
116 | ctx = o->priv; | |
117 | header = g_string_sized_new(512); | |
118 | ||
119 | /* Some metadata */ | |
120 | t = time(NULL); | |
121 | g_string_append_printf(header, "; CSV, generated by %s %s on %s", | |
122 | PACKAGE_NAME, SR_PACKAGE_VERSION_STRING, ctime(&t)); | |
123 | ||
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++) { | |
129 | ch = l->data; | |
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); | |
134 | } | |
135 | if (o->sdi->channels) | |
136 | /* Drop last separator. */ | |
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 | } | |
152 | ||
153 | return header; | |
154 | } | |
155 | ||
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, GSList *channels, | |
168 | unsigned int num_samples, float *data) | |
169 | { | |
170 | unsigned int numch, nums, i, j, s; | |
171 | GSList *l; | |
172 | ||
173 | numch = g_slist_length(channels); | |
174 | if (num_samples > numch) | |
175 | nums = num_samples / numch; | |
176 | else | |
177 | nums = 1; | |
178 | ||
179 | s = 0; | |
180 | l = 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] = data[s++]; | |
185 | } | |
186 | l = l->next; | |
187 | } | |
188 | } | |
189 | ||
190 | static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet, | |
191 | GString **out) | |
192 | { | |
193 | const struct sr_datafeed_meta *meta; | |
194 | const struct sr_datafeed_logic *logic; | |
195 | const struct sr_datafeed_analog_old *analog_old; | |
196 | const struct sr_datafeed_analog *analog; | |
197 | const struct sr_config *src; | |
198 | unsigned int num_samples; | |
199 | float *data; | |
200 | GSList *l, *channels; | |
201 | struct context *ctx; | |
202 | int idx; | |
203 | uint64_t i, j, k, nums, numch; | |
204 | gchar *p, c; | |
205 | int ret = SR_OK; | |
206 | ||
207 | *out = NULL; | |
208 | if (!o || !o->sdi) | |
209 | return SR_ERR_ARG; | |
210 | if (!(ctx = o->priv)) | |
211 | return SR_ERR_ARG; | |
212 | ||
213 | switch (packet->type) { | |
214 | case SR_DF_META: | |
215 | meta = packet->payload; | |
216 | for (l = meta->config; l; l = l->next) { | |
217 | src = l->data; | |
218 | if (src->key != SR_CONF_SAMPLERATE) | |
219 | continue; | |
220 | ctx->samplerate = g_variant_get_uint64(src->data); | |
221 | } | |
222 | break; | |
223 | case SR_DF_FRAME_BEGIN: | |
224 | /* | |
225 | * Special case - we start gathering data from analog channels | |
226 | * and wait for SR_DF_FRAME_END to dump it. | |
227 | */ | |
228 | memset(ctx->analog_vals, 0, sizeof(float) * ctx->num_analog_channels); | |
229 | ctx->inframe = TRUE; | |
230 | ret = SR_OK; | |
231 | break; | |
232 | case SR_DF_FRAME_END: | |
233 | /* | |
234 | * Dump gathered data. | |
235 | */ | |
236 | init_output(out, ctx, o); | |
237 | ||
238 | for (i = 0, j = 0; i < ctx->num_enabled_channels; i++) { | |
239 | if (ctx->channels[i]->type == SR_CHANNEL_ANALOG) { | |
240 | g_string_append_printf(*out, "%f", | |
241 | ctx->analog_vals[j++]); | |
242 | } | |
243 | g_string_append_c(*out, ctx->separator); | |
244 | } | |
245 | g_string_truncate(*out, (*out)->len - 1); | |
246 | g_string_append_printf(*out, "\n"); | |
247 | ||
248 | ctx->inframe = FALSE; | |
249 | break; | |
250 | case SR_DF_LOGIC: | |
251 | logic = packet->payload; | |
252 | init_output(out, ctx, o); | |
253 | ||
254 | for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) { | |
255 | for (j = 0; j < ctx->num_enabled_channels; j++) { | |
256 | if (ctx->channels[j]->type == SR_CHANNEL_LOGIC) { | |
257 | idx = ctx->channels[j]->index; | |
258 | p = logic->data + i + idx / 8; | |
259 | c = *p & (1 << (idx % 8)); | |
260 | g_string_append_c(*out, c ? '1' : '0'); | |
261 | } | |
262 | g_string_append_c(*out, ctx->separator); | |
263 | } | |
264 | if (j) { | |
265 | /* Drop last separator. */ | |
266 | g_string_truncate(*out, (*out)->len - 1); | |
267 | } | |
268 | g_string_append_printf(*out, "\n"); | |
269 | } | |
270 | break; | |
271 | case SR_DF_ANALOG_OLD: | |
272 | case SR_DF_ANALOG: | |
273 | analog_old = packet->payload; | |
274 | analog = packet->payload; | |
275 | ||
276 | if (packet->type == SR_DF_ANALOG_OLD) { | |
277 | channels = analog_old->channels; | |
278 | numch = g_slist_length(channels); | |
279 | num_samples = analog_old->num_samples; | |
280 | data = analog_old->data; | |
281 | } else { | |
282 | channels = analog->meaning->channels; | |
283 | numch = g_slist_length(channels); | |
284 | num_samples = analog->num_samples; | |
285 | data = g_malloc(sizeof(float) * num_samples * numch); | |
286 | ret = sr_analog_to_float(analog, data); | |
287 | if (ret != SR_OK) | |
288 | return ret; | |
289 | } | |
290 | ||
291 | if (ctx->inframe) { | |
292 | handle_analog_frame(ctx, channels, num_samples, data); | |
293 | break; | |
294 | } | |
295 | ||
296 | init_output(out, ctx, o); | |
297 | k = 0; | |
298 | l = NULL; | |
299 | ||
300 | if (num_samples > numch) | |
301 | nums = num_samples / numch; | |
302 | else | |
303 | nums = 1; | |
304 | ||
305 | for (i = 0; i < nums; i++) { | |
306 | for (j = 0; j < ctx->num_enabled_channels; j++) { | |
307 | if (ctx->channels[j]->type == SR_CHANNEL_ANALOG) { | |
308 | if (!l) | |
309 | l = channels; | |
310 | ||
311 | if (ctx->channels[j] == l->data) { | |
312 | g_string_append_printf(*out, | |
313 | "%f", data[k++]); | |
314 | } | |
315 | ||
316 | l = l->next; | |
317 | } | |
318 | g_string_append_c(*out, ctx->separator); | |
319 | } | |
320 | g_string_truncate(*out, (*out)->len - 1); | |
321 | g_string_append_printf(*out, "\n"); | |
322 | } | |
323 | break; | |
324 | } | |
325 | ||
326 | return ret; | |
327 | } | |
328 | ||
329 | static int cleanup(struct sr_output *o) | |
330 | { | |
331 | struct context *ctx; | |
332 | ||
333 | if (!o || !o->sdi) | |
334 | return SR_ERR_ARG; | |
335 | ||
336 | if (o->priv) { | |
337 | ctx = o->priv; | |
338 | g_free(ctx->channels); | |
339 | g_free(ctx->analog_channels); | |
340 | g_free(ctx->analog_vals); | |
341 | g_free(o->priv); | |
342 | o->priv = NULL; | |
343 | } | |
344 | ||
345 | return SR_OK; | |
346 | } | |
347 | ||
348 | SR_PRIV struct sr_output_module output_csv = { | |
349 | .id = "csv", | |
350 | .name = "CSV", | |
351 | .desc = "Comma-separated values", | |
352 | .exts = (const char*[]){"csv", NULL}, | |
353 | .flags = 0, | |
354 | .options = NULL, | |
355 | .init = init, | |
356 | .receive = receive, | |
357 | .cleanup = cleanup, | |
358 | }; |