]>
Commit | Line | Data |
---|---|---|
34e4813f | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
34e4813f | 3 | * |
17bfaca6 | 4 | * Copyright (C) 2014 Bert Vermeulen <bert@biot.com> |
34e4813f BV |
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 3 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, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
17bfaca6 BV |
20 | #include <string.h> |
21 | #include <sys/types.h> | |
22 | #include <sys/stat.h> | |
23 | #include <unistd.h> | |
24 | #include <fcntl.h> | |
25 | #include <errno.h> | |
45c59c8b BV |
26 | #include "libsigrok.h" |
27 | #include "libsigrok-internal.h" | |
34e4813f | 28 | |
17bfaca6 BV |
29 | #define LOG_PREFIX "input" |
30 | ||
393fb9cb UH |
31 | /** |
32 | * @file | |
33 | * | |
0f3dbc95 | 34 | * Input module handling. |
393fb9cb UH |
35 | */ |
36 | ||
7b870c38 | 37 | /** |
d4c93774 | 38 | * @defgroup grp_input Input modules |
7b870c38 | 39 | * |
d4c93774 | 40 | * Input file/data module handling. |
7b870c38 | 41 | * |
83687343 | 42 | * libsigrok can process acquisition data in several different ways. |
0f3dbc95 BV |
43 | * Aside from acquiring data from a hardware device, it can also take it |
44 | * from a file in various formats (binary, CSV, VCD, and so on). | |
83687343 | 45 | * |
0f3dbc95 BV |
46 | * Like all libsigrok data handling, processing is done in a streaming |
47 | * manner: input should be supplied a chunk at a time. This way anything | |
48 | * that processes data can do so in real time, without the user having | |
49 | * to wait for the whole thing to be finished. | |
83687343 UH |
50 | * |
51 | * Every input module is "pluggable", meaning it's handled as being separate | |
52 | * from the main libsigrok, but linked in to it statically. To keep things | |
53 | * modular and separate like this, functions within an input module should be | |
d4c93774 | 54 | * declared static, with only the respective 'struct sr_input_module' being |
83687343 UH |
55 | * exported for use into the wider libsigrok namespace. |
56 | * | |
7b870c38 UH |
57 | * @{ |
58 | */ | |
59 | ||
b4bd7088 | 60 | /** @cond PRIVATE */ |
d4c93774 BV |
61 | extern SR_PRIV struct sr_input_module input_chronovu_la8; |
62 | extern SR_PRIV struct sr_input_module input_csv; | |
63 | extern SR_PRIV struct sr_input_module input_binary; | |
64 | extern SR_PRIV struct sr_input_module input_vcd; | |
65 | extern SR_PRIV struct sr_input_module input_wav; | |
b4bd7088 | 66 | /* @endcond */ |
34e4813f | 67 | |
17bfaca6 | 68 | static const struct sr_input_module *input_module_list[] = { |
b84cba4d | 69 | &input_binary, |
02e24c0c | 70 | &input_chronovu_la8, |
41d214f6 | 71 | &input_csv, |
b84cba4d BV |
72 | &input_vcd, |
73 | &input_wav, | |
34e4813f BV |
74 | NULL, |
75 | }; | |
76 | ||
0f3dbc95 BV |
77 | /** |
78 | * Returns a NULL-terminated list of all available input modules. | |
79 | * | |
80 | * @since 0.4.0 | |
81 | */ | |
17bfaca6 | 82 | SR_API const struct sr_input_module **sr_input_list(void) |
34e4813f | 83 | { |
34e4813f BV |
84 | return input_module_list; |
85 | } | |
7b870c38 | 86 | |
17bfaca6 BV |
87 | /** |
88 | * Returns the specified input module's ID. | |
89 | * | |
90 | * @since 0.4.0 | |
91 | */ | |
92 | SR_API const char *sr_input_id_get(const struct sr_input_module *o) | |
93 | { | |
94 | if (!o) { | |
95 | sr_err("Invalid input module NULL!"); | |
96 | return NULL; | |
97 | } | |
98 | ||
99 | return o->id; | |
100 | } | |
101 | ||
102 | /** | |
103 | * Returns the specified input module's name. | |
104 | * | |
105 | * @since 0.4.0 | |
106 | */ | |
107 | SR_API const char *sr_input_name_get(const struct sr_input_module *o) | |
108 | { | |
109 | if (!o) { | |
110 | sr_err("Invalid input module NULL!"); | |
111 | return NULL; | |
112 | } | |
113 | ||
114 | return o->name; | |
115 | } | |
116 | ||
117 | /** | |
118 | * Returns the specified input module's description. | |
119 | * | |
120 | * @since 0.4.0 | |
121 | */ | |
122 | SR_API const char *sr_input_description_get(const struct sr_input_module *o) | |
123 | { | |
124 | if (!o) { | |
125 | sr_err("Invalid input module NULL!"); | |
126 | return NULL; | |
127 | } | |
128 | ||
129 | return o->desc; | |
130 | } | |
131 | ||
132 | /** | |
133 | * Return the input module with the specified ID, or NULL if no module | |
134 | * with that id is found. | |
135 | * | |
136 | * @since 0.4.0 | |
137 | */ | |
138 | SR_API const struct sr_input_module *sr_input_find(char *id) | |
139 | { | |
140 | int i; | |
141 | ||
142 | for (i = 0; input_module_list[i]; i++) { | |
143 | if (!strcmp(input_module_list[i]->id, id)) | |
144 | return input_module_list[i]; | |
145 | } | |
146 | ||
147 | return NULL; | |
148 | } | |
149 | ||
150 | /** | |
151 | * Returns a NULL-terminated array of struct sr_option, or NULL if the | |
152 | * module takes no options. | |
153 | * | |
154 | * Each call to this function must be followed by a call to | |
155 | * sr_input_options_free(). | |
156 | * | |
157 | * @since 0.4.0 | |
158 | */ | |
bd0bfaaf | 159 | SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod) |
17bfaca6 | 160 | { |
bd0bfaaf BV |
161 | const struct sr_option *mod_opts, **opts; |
162 | int size, i; | |
17bfaca6 | 163 | |
bd0bfaaf | 164 | if (!imod || !imod->options) |
17bfaca6 BV |
165 | return NULL; |
166 | ||
bd0bfaaf BV |
167 | mod_opts = imod->options(); |
168 | ||
fe4fe25b | 169 | for (size = 0; mod_opts[size].id; size++) |
bd0bfaaf | 170 | ; |
fe4fe25b | 171 | opts = g_malloc((size + 1) * sizeof(struct sr_option *)); |
bd0bfaaf BV |
172 | |
173 | for (i = 0; i < size; i++) | |
174 | opts[i] = &mod_opts[i]; | |
175 | opts[i] = NULL; | |
176 | ||
177 | return opts; | |
17bfaca6 BV |
178 | } |
179 | ||
180 | /** | |
181 | * After a call to sr_input_options_get(), this function cleans up all | |
bd0bfaaf | 182 | * resources returned by that call. |
17bfaca6 BV |
183 | * |
184 | * @since 0.4.0 | |
185 | */ | |
bd0bfaaf | 186 | SR_API void sr_input_options_free(const struct sr_option **options) |
17bfaca6 | 187 | { |
fe4fe25b | 188 | int i; |
17bfaca6 | 189 | |
bd0bfaaf | 190 | if (!options) |
17bfaca6 BV |
191 | return; |
192 | ||
fe4fe25b BV |
193 | for (i = 0; options[i]; i++) { |
194 | if (options[i]->def) { | |
195 | g_variant_unref(options[i]->def); | |
196 | ((struct sr_option *)options[i])->def = NULL; | |
17bfaca6 BV |
197 | } |
198 | ||
fe4fe25b BV |
199 | if (options[i]->values) { |
200 | g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref); | |
201 | ((struct sr_option *)options[i])->values = NULL; | |
17bfaca6 BV |
202 | } |
203 | } | |
bd0bfaaf | 204 | g_free(options); |
17bfaca6 BV |
205 | } |
206 | ||
207 | /** | |
208 | * Create a new input instance using the specified input module. | |
209 | * | |
210 | * This function is used when a client wants to use a specific input | |
211 | * module to parse a stream. No effort is made to identify the format. | |
212 | * | |
0f3dbc95 BV |
213 | * @param options GHashTable consisting of keys corresponding with |
214 | * the module options \c id field. The values should be GVariant | |
215 | * pointers with sunk references, of the same GVariantType as the option's | |
17bfaca6 BV |
216 | * default value. |
217 | * | |
218 | * @since 0.4.0 | |
219 | */ | |
220 | SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod, | |
221 | GHashTable *options) | |
222 | { | |
223 | struct sr_input *in; | |
224 | struct sr_option *mod_opts; | |
225 | const GVariantType *gvt; | |
226 | GHashTable *new_opts; | |
227 | GHashTableIter iter; | |
228 | gpointer key, value; | |
229 | int i; | |
230 | ||
231 | in = g_malloc0(sizeof(struct sr_input)); | |
232 | in->module = imod; | |
233 | ||
7db06394 BV |
234 | new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, |
235 | (GDestroyNotify)g_variant_unref); | |
236 | if (imod->options) { | |
17bfaca6 BV |
237 | mod_opts = imod->options(); |
238 | for (i = 0; mod_opts[i].id; i++) { | |
7db06394 BV |
239 | if (options && g_hash_table_lookup_extended(options, |
240 | mod_opts[i].id, &key, &value)) { | |
17bfaca6 BV |
241 | /* Option not given: insert the default value. */ |
242 | gvt = g_variant_get_type(mod_opts[i].def); | |
243 | if (!g_variant_is_of_type(value, gvt)) { | |
244 | sr_err("Invalid type for '%s' option.", key); | |
245 | g_free(in); | |
246 | return NULL; | |
247 | } | |
248 | g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id), | |
249 | g_variant_ref(value)); | |
250 | } else { | |
251 | /* Pass option along. */ | |
252 | g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id), | |
253 | g_variant_ref(mod_opts[i].def)); | |
254 | } | |
255 | } | |
256 | ||
257 | /* Make sure no invalid options were given. */ | |
7db06394 BV |
258 | if (options) { |
259 | g_hash_table_iter_init(&iter, options); | |
260 | while (g_hash_table_iter_next(&iter, &key, &value)) { | |
261 | if (!g_hash_table_lookup(new_opts, key)) { | |
262 | sr_err("Input module '%s' has no option '%s'", imod->id, key); | |
263 | g_hash_table_destroy(new_opts); | |
264 | g_free(in); | |
265 | return NULL; | |
266 | } | |
17bfaca6 BV |
267 | } |
268 | } | |
7db06394 | 269 | } |
17bfaca6 BV |
270 | |
271 | if (in->module->init && in->module->init(in, new_opts) != SR_OK) { | |
17bfaca6 BV |
272 | g_free(in); |
273 | in = NULL; | |
274 | } | |
275 | if (new_opts) | |
276 | g_hash_table_destroy(new_opts); | |
57486a75 | 277 | in->buf = g_string_sized_new(128); |
17bfaca6 BV |
278 | |
279 | return in; | |
280 | } | |
281 | ||
282 | /* Returns TRUE is all required meta items are available. */ | |
283 | static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail) | |
284 | { | |
285 | int m, a; | |
286 | uint8_t reqd; | |
287 | ||
288 | for (m = 0; metadata[m]; m++) { | |
7db06394 | 289 | if (!(metadata[m] & SR_INPUT_META_REQUIRED)) |
17bfaca6 BV |
290 | continue; |
291 | reqd = metadata[m] & ~SR_INPUT_META_REQUIRED; | |
292 | for (a = 0; avail[a]; a++) { | |
293 | if (avail[a] == reqd) | |
294 | break; | |
295 | } | |
296 | if (!avail[a]) | |
297 | /* Found a required meta item that isn't available. */ | |
298 | return FALSE; | |
299 | } | |
300 | ||
301 | return TRUE; | |
302 | } | |
303 | ||
304 | /** | |
305 | * Try to find an input module that can parse the given buffer. | |
306 | * | |
307 | * The buffer must contain enough of the beginning of the file for | |
308 | * the input modules to find a match. This is format-dependent, but | |
309 | * 128 bytes is normally enough. | |
310 | * | |
4f979115 BV |
311 | * If an input module is found, an instance is created into *in. |
312 | * Otherwise, *in contains NULL. | |
17bfaca6 | 313 | * |
33e4303b BV |
314 | * If an instance is created, it has the given buffer used for scanning |
315 | * already submitted to it, to be processed before more data is sent. | |
316 | * This allows a frontend to submit an initial chunk of a non-seekable | |
317 | * stream, such as stdin, without having to keep it around and submit | |
318 | * it again later. | |
319 | * | |
17bfaca6 | 320 | */ |
4f979115 | 321 | SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in) |
17bfaca6 | 322 | { |
17bfaca6 BV |
323 | const struct sr_input_module *imod; |
324 | GHashTable *meta; | |
325 | unsigned int m, i; | |
4f979115 | 326 | int ret; |
17bfaca6 BV |
327 | uint8_t mitem, avail_metadata[8]; |
328 | ||
329 | /* No more metadata to be had from a buffer. */ | |
330 | avail_metadata[0] = SR_INPUT_META_HEADER; | |
331 | avail_metadata[1] = 0; | |
332 | ||
4f979115 BV |
333 | *in = NULL; |
334 | ret = SR_ERR; | |
17bfaca6 BV |
335 | for (i = 0; input_module_list[i]; i++) { |
336 | imod = input_module_list[i]; | |
337 | if (!imod->metadata[0]) { | |
338 | /* Module has no metadata for matching so will take | |
339 | * any input. No point in letting it try to match. */ | |
340 | continue; | |
341 | } | |
342 | if (!check_required_metadata(imod->metadata, avail_metadata)) | |
343 | /* Cannot satisfy this module's requirements. */ | |
344 | continue; | |
345 | ||
346 | meta = g_hash_table_new(NULL, NULL); | |
347 | for (m = 0; m < sizeof(imod->metadata); m++) { | |
348 | mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED; | |
349 | if (mitem == SR_INPUT_META_HEADER) | |
350 | g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf); | |
351 | } | |
352 | if (g_hash_table_size(meta) == 0) { | |
353 | /* No metadata for this module, so nothing to match. */ | |
354 | g_hash_table_destroy(meta); | |
355 | continue; | |
356 | } | |
4f979115 BV |
357 | sr_spew("Trying module %s.", imod->id); |
358 | ret = imod->format_match(meta); | |
359 | g_hash_table_destroy(meta); | |
360 | if (ret == SR_ERR_DATA) { | |
361 | /* Module recognized this buffer, but cannot handle it. */ | |
362 | break; | |
363 | } else if (ret == SR_ERR) { | |
17bfaca6 | 364 | /* Module didn't recognize this buffer. */ |
17bfaca6 | 365 | continue; |
4f979115 BV |
366 | } else if (ret != SR_OK) { |
367 | /* Can be SR_OK_CONTINUE. */ | |
368 | return ret; | |
17bfaca6 | 369 | } |
17bfaca6 BV |
370 | |
371 | /* Found a matching module. */ | |
4f979115 BV |
372 | sr_spew("Module %s matched.", imod->id); |
373 | *in = sr_input_new(imod, NULL); | |
374 | g_string_insert_len((*in)->buf, 0, buf->str, buf->len); | |
17bfaca6 BV |
375 | break; |
376 | } | |
377 | ||
4f979115 | 378 | return ret; |
17bfaca6 BV |
379 | } |
380 | ||
381 | /** | |
382 | * Try to find an input module that can parse the given file. | |
383 | * | |
4f979115 BV |
384 | * If an input module is found, an instance is created into *in. |
385 | * Otherwise, *in contains NULL. | |
17bfaca6 BV |
386 | * |
387 | */ | |
4f979115 | 388 | SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in) |
17bfaca6 | 389 | { |
17bfaca6 BV |
390 | const struct sr_input_module *imod; |
391 | GHashTable *meta; | |
115fbe94 | 392 | GString *header_buf; |
17bfaca6 BV |
393 | struct stat st; |
394 | unsigned int midx, m, i; | |
4f979115 | 395 | int fd, ret; |
17bfaca6 BV |
396 | ssize_t size; |
397 | uint8_t mitem, avail_metadata[8]; | |
398 | ||
399 | if (!filename || !filename[0]) { | |
400 | sr_err("Invalid filename."); | |
4f979115 | 401 | return SR_ERR_ARG; |
17bfaca6 BV |
402 | } |
403 | ||
404 | if (!g_file_test(filename, G_FILE_TEST_EXISTS)) { | |
405 | sr_err("No such file."); | |
4f979115 | 406 | return SR_ERR_ARG; |
17bfaca6 BV |
407 | } |
408 | ||
409 | if (stat(filename, &st) < 0) { | |
410 | sr_err("%s", strerror(errno)); | |
4f979115 | 411 | return SR_ERR_ARG; |
17bfaca6 BV |
412 | } |
413 | ||
414 | midx = 0; | |
415 | avail_metadata[midx++] = SR_INPUT_META_FILENAME; | |
416 | avail_metadata[midx++] = SR_INPUT_META_FILESIZE; | |
417 | avail_metadata[midx++] = SR_INPUT_META_HEADER; | |
418 | /* TODO: MIME type */ | |
419 | ||
4f979115 BV |
420 | *in = NULL; |
421 | ret = SR_ERR; | |
115fbe94 | 422 | header_buf = g_string_sized_new(128); |
17bfaca6 | 423 | for (i = 0; input_module_list[i]; i++) { |
115fbe94 BV |
424 | g_string_truncate(header_buf, 0); |
425 | ||
17bfaca6 BV |
426 | imod = input_module_list[i]; |
427 | if (!imod->metadata[0]) { | |
428 | /* Module has no metadata for matching so will take | |
429 | * any input. No point in letting it try to match. */ | |
430 | continue; | |
431 | } | |
432 | if (!check_required_metadata(imod->metadata, avail_metadata)) | |
433 | /* Cannot satisfy this module's requirements. */ | |
434 | continue; | |
435 | ||
436 | meta = g_hash_table_new(NULL, NULL); | |
437 | for (m = 0; m < sizeof(imod->metadata); m++) { | |
438 | mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED; | |
115fbe94 BV |
439 | if (!mitem) |
440 | /* Metadata list is 0-terminated. */ | |
441 | break; | |
4f979115 | 442 | if (mitem == SR_INPUT_META_FILENAME) { |
17bfaca6 BV |
443 | g_hash_table_insert(meta, GINT_TO_POINTER(mitem), |
444 | (gpointer)filename); | |
4f979115 | 445 | } else if (mitem == SR_INPUT_META_FILESIZE) { |
17bfaca6 BV |
446 | g_hash_table_insert(meta, GINT_TO_POINTER(mitem), |
447 | GINT_TO_POINTER(st.st_size)); | |
115fbe94 | 448 | } else if (mitem == SR_INPUT_META_HEADER) { |
17bfaca6 BV |
449 | if ((fd = open(filename, O_RDONLY)) < 0) { |
450 | sr_err("%s", strerror(errno)); | |
4f979115 | 451 | return SR_ERR; |
17bfaca6 | 452 | } |
115fbe94 BV |
453 | size = read(fd, header_buf->str, 128); |
454 | header_buf->len = size; | |
17bfaca6 BV |
455 | close(fd); |
456 | if (size <= 0) { | |
115fbe94 | 457 | g_string_free(header_buf, TRUE); |
17bfaca6 | 458 | sr_err("%s", strerror(errno)); |
4f979115 | 459 | return SR_ERR; |
17bfaca6 | 460 | } |
115fbe94 | 461 | g_hash_table_insert(meta, GINT_TO_POINTER(mitem), header_buf); |
17bfaca6 BV |
462 | } |
463 | } | |
464 | if (g_hash_table_size(meta) == 0) { | |
465 | /* No metadata for this module, so there's no way it | |
466 | * can match. */ | |
467 | g_hash_table_destroy(meta); | |
468 | continue; | |
469 | } | |
4f979115 BV |
470 | sr_spew("Trying module %s.", imod->id); |
471 | ret = imod->format_match(meta); | |
472 | g_hash_table_destroy(meta); | |
473 | if (ret == SR_ERR_DATA) { | |
474 | /* Module recognized this buffer, but cannot handle it. */ | |
475 | break; | |
476 | } else if (ret == SR_ERR) { | |
17bfaca6 BV |
477 | /* Module didn't recognize this buffer. */ |
478 | continue; | |
4f979115 BV |
479 | } else if (ret != SR_OK) { |
480 | /* Can be SR_OK_CONTINUE. */ | |
481 | return ret; | |
482 | } | |
17bfaca6 BV |
483 | |
484 | /* Found a matching module. */ | |
4f979115 BV |
485 | sr_spew("Module %s matched.", imod->id); |
486 | *in = sr_input_new(imod, NULL); | |
17bfaca6 BV |
487 | break; |
488 | } | |
115fbe94 | 489 | g_string_free(header_buf, TRUE); |
17bfaca6 | 490 | |
4f979115 | 491 | return ret; |
17bfaca6 BV |
492 | } |
493 | ||
0f3dbc95 BV |
494 | /** |
495 | * Return the input instance's (virtual) device instance. This can be | |
496 | * used to find out the number of channels and other information. | |
497 | * | |
498 | * @since 0.4.0 | |
499 | */ | |
17bfaca6 BV |
500 | SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in) |
501 | { | |
502 | return in->sdi; | |
503 | } | |
504 | ||
505 | /** | |
506 | * Send data to the specified input instance. | |
507 | * | |
508 | * When an input module instance is created with sr_input_new(), this | |
509 | * function is used to feed data to the instance. | |
510 | * | |
511 | * @since 0.4.0 | |
512 | */ | |
513 | SR_API int sr_input_send(const struct sr_input *in, GString *buf) | |
514 | { | |
515 | return in->module->receive(in, buf); | |
516 | } | |
517 | ||
518 | /** | |
519 | * Free the specified input instance and all associated resources. | |
520 | * | |
521 | * @since 0.4.0 | |
522 | */ | |
523 | SR_API int sr_input_free(const struct sr_input *in) | |
524 | { | |
525 | int ret; | |
526 | ||
527 | if (!in) | |
528 | return SR_ERR_ARG; | |
529 | ||
530 | ret = SR_OK; | |
531 | if (in->module->cleanup) | |
532 | ret = in->module->cleanup((struct sr_input *)in); | |
7db06394 BV |
533 | if (in->sdi) |
534 | sr_dev_inst_free(in->sdi); | |
17bfaca6 BV |
535 | if (in->buf) |
536 | g_string_free(in->buf, TRUE); | |
537 | g_free((gpointer)in); | |
538 | ||
539 | return ret; | |
540 | } | |
541 | ||
542 | ||
7b870c38 | 543 | /** @} */ |