]>
Commit | Line | Data |
---|---|---|
02604ed6 UH |
1 | /* |
2 | * This file is part of the sigrok 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 <stdlib.h> | |
22 | #include <string.h> | |
23 | #include <glib.h> | |
24 | #include <sigrok.h> | |
25 | #include <sigrok-internal.h> | |
26 | #include "config.h" | |
27 | ||
28 | struct context { | |
29 | unsigned int num_enabled_probes; | |
30 | unsigned int unitsize; | |
31 | char *probelist[SR_MAX_NUM_PROBES + 1]; | |
32 | uint64_t samplerate; | |
33 | GString *header; | |
34 | char separator; | |
35 | }; | |
36 | ||
37 | /* | |
38 | * TODO: | |
39 | * - Option to specify delimiter character and/or string. | |
40 | * - Option to (not) print metadata as comments. | |
41 | * - Option to specify the comment character(s), e.g. # or ; or C/C++-style. | |
42 | * - Option to (not) print samplenumber / time as extra column. | |
43 | * - Option to "compress" output (only print changed samples, VCD-like). | |
44 | * - Option to print comma-separated bits, or whole bytes/words (for 8/16 | |
45 | * probe LAs) as ASCII/hex etc. etc. | |
46 | * - Trigger support. | |
47 | */ | |
48 | ||
49 | static int init(struct sr_output *o) | |
50 | { | |
51 | struct context *ctx; | |
52 | struct sr_probe *probe; | |
53 | GSList *l; | |
54 | int num_probes; | |
55 | uint64_t samplerate; | |
56 | time_t t; | |
57 | unsigned int i; | |
58 | ||
59 | if (!o) { | |
60 | sr_err("csv out: %s: o was NULL", __func__); | |
61 | return SR_ERR_ARG; | |
62 | } | |
63 | ||
64 | if (!o->device) { | |
65 | sr_err("csv out: %s: o->device was NULL", __func__); | |
66 | return SR_ERR_ARG; | |
67 | } | |
68 | ||
69 | if (!o->device->plugin) { | |
70 | sr_err("csv out: %s: o->device->plugin was NULL", __func__); | |
71 | return SR_ERR_ARG; | |
72 | } | |
73 | ||
74 | if (!(ctx = g_try_malloc0(sizeof(struct context)))) { | |
75 | sr_err("csv out: %s: ctx malloc failed", __func__); | |
76 | return SR_ERR_MALLOC; | |
77 | } | |
78 | ||
79 | o->internal = ctx; | |
80 | ||
81 | /* Get the number of probes, their names, and the unitsize. */ | |
82 | /* TODO: Error handling. */ | |
83 | for (l = o->device->probes; l; l = l->next) { | |
84 | probe = l->data; | |
85 | if (!probe->enabled) | |
86 | continue; | |
87 | ctx->probelist[ctx->num_enabled_probes++] = probe->name; | |
88 | } | |
89 | ctx->probelist[ctx->num_enabled_probes] = 0; | |
90 | ctx->unitsize = (ctx->num_enabled_probes + 7) / 8; | |
91 | ||
92 | num_probes = g_slist_length(o->device->probes); | |
93 | ||
94 | if (sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) { | |
95 | samplerate = *((uint64_t *) o->device->plugin->get_device_info( | |
96 | o->device->plugin_index, SR_DI_CUR_SAMPLERATE)); | |
97 | /* TODO: Error checks. */ | |
98 | } else { | |
99 | samplerate = 0; /* TODO: Error or set some value? */ | |
100 | } | |
101 | ctx->samplerate = samplerate; | |
102 | ||
103 | ctx->separator = ','; | |
104 | ||
105 | ctx->header = g_string_sized_new(512); | |
106 | ||
107 | t = time(NULL); | |
108 | ||
109 | /* Some metadata */ | |
110 | g_string_append_printf(ctx->header, "; CSV, generated by %s on %s", | |
111 | PACKAGE_STRING, ctime(&t)); | |
112 | g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n", | |
113 | ctx->samplerate); | |
114 | ||
115 | /* Columns / channels */ | |
116 | g_string_append_printf(ctx->header, "; Channels (%d/%d): ", | |
117 | ctx->num_enabled_probes, num_probes); | |
118 | for (i = 0; i < ctx->num_enabled_probes; i++) | |
119 | g_string_append_printf(ctx->header, "%s, ", ctx->probelist[i]); | |
120 | g_string_append_printf(ctx->header, "\n"); | |
121 | ||
122 | return 0; /* TODO: SR_OK? */ | |
123 | } | |
124 | ||
125 | static int event(struct sr_output *o, int event_type, char **data_out, | |
126 | uint64_t *length_out) | |
127 | { | |
128 | struct context *ctx; | |
129 | char *outbuf; | |
130 | ||
131 | if (!o) { | |
132 | sr_err("csv out: %s: o was NULL", __func__); | |
133 | return SR_ERR_ARG; | |
134 | } | |
135 | ||
136 | if (!(ctx = o->internal)) { | |
137 | sr_err("csv out: %s: o->internal was NULL", __func__); | |
138 | return SR_ERR_ARG; | |
139 | } | |
140 | ||
141 | if (!data_out) { | |
142 | sr_err("csv out: %s: data_out was NULL", __func__); | |
143 | return SR_ERR_ARG; | |
144 | } | |
145 | ||
146 | switch (event_type) { | |
147 | case SR_DF_TRIGGER: | |
148 | sr_dbg("csv out: %s: SR_DF_TRIGGER event", __func__); | |
149 | /* TODO */ | |
150 | *data_out = NULL; | |
151 | *length_out = 0; | |
152 | break; | |
153 | case SR_DF_END: | |
154 | sr_dbg("csv out: %s: SR_DF_END event", __func__); | |
155 | /* TODO */ | |
156 | *data_out = NULL; | |
157 | *length_out = 0; | |
158 | g_free(o->internal); | |
159 | o->internal = NULL; | |
160 | break; | |
161 | default: | |
162 | sr_err("csv out: %s: unsupported event type: %d", __func__, | |
163 | event_type); | |
164 | *data_out = NULL; | |
165 | *length_out = 0; | |
166 | break; | |
167 | } | |
168 | ||
169 | return SR_OK; | |
170 | } | |
171 | ||
172 | static int data(struct sr_output *o, const char *data_in, uint64_t length_in, | |
173 | char **data_out, uint64_t *length_out) | |
174 | { | |
175 | struct context *ctx; | |
176 | GString *outstr; | |
177 | uint64_t sample, i; | |
178 | int j; | |
179 | ||
180 | if (!o) { | |
181 | sr_err("csv out: %s: o was NULL", __func__); | |
182 | return SR_ERR_ARG; | |
183 | } | |
184 | ||
185 | if (!(ctx = o->internal)) { | |
186 | sr_err("csv out: %s: o->internal was NULL", __func__); | |
187 | return SR_ERR_ARG; | |
188 | } | |
189 | ||
190 | if (!data_in) { | |
191 | sr_err("csv out: %s: data_in was NULL", __func__); | |
192 | return SR_ERR_ARG; | |
193 | } | |
194 | ||
195 | if (ctx->header) { | |
196 | /* First data packet. */ | |
197 | outstr = ctx->header; | |
198 | ctx->header = NULL; | |
199 | } else { | |
200 | outstr = g_string_sized_new(512); | |
201 | } | |
202 | ||
203 | for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) { | |
204 | memcpy(&sample, data_in + i, ctx->unitsize); | |
205 | for (j = ctx->num_enabled_probes - 1; j >= 0; j--) { | |
206 | g_string_append_printf(outstr, "%d%c", | |
207 | (int)((sample & (1 << j)) >> j), | |
208 | ctx->separator); | |
209 | } | |
210 | g_string_append_printf(outstr, "\n"); | |
211 | } | |
212 | ||
213 | *data_out = outstr->str; | |
214 | *length_out = outstr->len; | |
215 | g_string_free(outstr, FALSE); | |
216 | ||
217 | return SR_OK; | |
218 | } | |
219 | ||
220 | struct sr_output_format output_csv = { | |
221 | .id = "csv", | |
222 | .description = "Comma-separated values (CSV)", | |
223 | .df_type = SR_DF_LOGIC, | |
224 | .init = init, | |
225 | .data = data, | |
226 | .event = event, | |
227 | }; |