2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include <sys/types.h>
26 #include "libsigrok.h"
27 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "input"
36 * Input module handling.
40 * @defgroup grp_input Input modules
42 * Input file/data module handling.
44 * libsigrok can process acquisition data in several different ways.
45 * Aside from acquiring data from a hardware device, it can also take it
46 * from a file in various formats (binary, CSV, VCD, and so on).
48 * Like all libsigrok data handling, processing is done in a streaming
49 * manner: input should be supplied a chunk at a time. This way anything
50 * that processes data can do so in real time, without the user having
51 * to wait for the whole thing to be finished.
53 * Every input module is "pluggable", meaning it's handled as being separate
54 * from the main libsigrok, but linked in to it statically. To keep things
55 * modular and separate like this, functions within an input module should be
56 * declared static, with only the respective 'struct sr_input_module' being
57 * exported for use into the wider libsigrok namespace.
63 extern SR_PRIV struct sr_input_module input_chronovu_la8;
64 extern SR_PRIV struct sr_input_module input_csv;
65 extern SR_PRIV struct sr_input_module input_binary;
66 extern SR_PRIV struct sr_input_module input_vcd;
67 extern SR_PRIV struct sr_input_module input_wav;
70 static const struct sr_input_module *input_module_list[] = {
80 * Returns a NULL-terminated list of all available input modules.
84 SR_API const struct sr_input_module **sr_input_list(void)
86 return input_module_list;
90 * Returns the specified input module's ID.
94 SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
97 sr_err("Invalid input module NULL!");
105 * Returns the specified input module's name.
109 SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
112 sr_err("Invalid input module NULL!");
120 * Returns the specified input module's description.
124 SR_API const char *sr_input_description_get(const struct sr_input_module *imod)
127 sr_err("Invalid input module NULL!");
135 * Returns the specified input module's file extensions typical for the file
136 * format, as a NULL terminated array, or returns a NULL pointer if there is
137 * no preferred extension.
138 * @note these are a suggestions only.
142 SR_API const char *const *sr_input_extensions_get(
143 const struct sr_input_module *imod)
146 sr_err("Invalid input module NULL!");
154 * Return the input module with the specified ID, or NULL if no module
155 * with that id is found.
159 SR_API const struct sr_input_module *sr_input_find(char *id)
163 for (i = 0; input_module_list[i]; i++) {
164 if (!strcmp(input_module_list[i]->id, id))
165 return input_module_list[i];
172 * Returns a NULL-terminated array of struct sr_option, or NULL if the
173 * module takes no options.
175 * Each call to this function must be followed by a call to
176 * sr_input_options_free().
180 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod)
182 const struct sr_option *mod_opts, **opts;
185 if (!imod || !imod->options)
188 mod_opts = imod->options();
190 for (size = 0; mod_opts[size].id; size++)
192 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
194 for (i = 0; i < size; i++)
195 opts[i] = &mod_opts[i];
202 * After a call to sr_input_options_get(), this function cleans up all
203 * resources returned by that call.
207 SR_API void sr_input_options_free(const struct sr_option **options)
214 for (i = 0; options[i]; i++) {
215 if (options[i]->def) {
216 g_variant_unref(options[i]->def);
217 ((struct sr_option *)options[i])->def = NULL;
220 if (options[i]->values) {
221 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
222 ((struct sr_option *)options[i])->values = NULL;
229 * Create a new input instance using the specified input module.
231 * This function is used when a client wants to use a specific input
232 * module to parse a stream. No effort is made to identify the format.
234 * @param imod The input module to use. Must not be NULL.
235 * @param options GHashTable consisting of keys corresponding with
236 * the module options \c id field. The values should be GVariant
237 * pointers with sunk references, of the same GVariantType as the option's
242 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
246 struct sr_option *mod_opts;
247 const GVariantType *gvt;
248 GHashTable *new_opts;
253 in = g_malloc0(sizeof(struct sr_input));
256 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
257 (GDestroyNotify)g_variant_unref);
259 mod_opts = imod->options();
260 for (i = 0; mod_opts[i].id; i++) {
261 if (options && g_hash_table_lookup_extended(options,
262 mod_opts[i].id, &key, &value)) {
263 /* Option not given: insert the default value. */
264 gvt = g_variant_get_type(mod_opts[i].def);
265 if (!g_variant_is_of_type(value, gvt)) {
266 sr_err("Invalid type for '%s' option.", key);
270 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
271 g_variant_ref(value));
273 /* Pass option along. */
274 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
275 g_variant_ref(mod_opts[i].def));
279 /* Make sure no invalid options were given. */
281 g_hash_table_iter_init(&iter, options);
282 while (g_hash_table_iter_next(&iter, &key, &value)) {
283 if (!g_hash_table_lookup(new_opts, key)) {
284 sr_err("Input module '%s' has no option '%s'", imod->id, key);
285 g_hash_table_destroy(new_opts);
293 if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
297 in->buf = g_string_sized_new(128);
301 g_hash_table_destroy(new_opts);
306 /* Returns TRUE if all required meta items are available. */
307 static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
312 for (m = 0; metadata[m]; m++) {
313 if (!(metadata[m] & SR_INPUT_META_REQUIRED))
315 reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
316 for (a = 0; avail[a]; a++) {
317 if (avail[a] == reqd)
321 /* Found a required meta item that isn't available. */
329 * Try to find an input module that can parse the given buffer.
331 * The buffer must contain enough of the beginning of the file for
332 * the input modules to find a match. This is format-dependent, but
333 * 128 bytes is normally enough.
335 * If an input module is found, an instance is created into *in.
336 * Otherwise, *in contains NULL.
338 * If an instance is created, it has the given buffer used for scanning
339 * already submitted to it, to be processed before more data is sent.
340 * This allows a frontend to submit an initial chunk of a non-seekable
341 * stream, such as stdin, without having to keep it around and submit
345 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
347 const struct sr_input_module *imod;
351 uint8_t mitem, avail_metadata[8];
353 /* No more metadata to be had from a buffer. */
354 avail_metadata[0] = SR_INPUT_META_HEADER;
355 avail_metadata[1] = 0;
359 for (i = 0; input_module_list[i]; i++) {
360 imod = input_module_list[i];
361 if (!imod->metadata[0]) {
362 /* Module has no metadata for matching so will take
363 * any input. No point in letting it try to match. */
366 if (!check_required_metadata(imod->metadata, avail_metadata))
367 /* Cannot satisfy this module's requirements. */
370 meta = g_hash_table_new(NULL, NULL);
371 for (m = 0; m < sizeof(imod->metadata); m++) {
372 mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
373 if (mitem == SR_INPUT_META_HEADER)
374 g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
376 if (g_hash_table_size(meta) == 0) {
377 /* No metadata for this module, so nothing to match. */
378 g_hash_table_destroy(meta);
381 sr_spew("Trying module %s.", imod->id);
382 ret = imod->format_match(meta);
383 g_hash_table_destroy(meta);
384 if (ret == SR_ERR_DATA) {
385 /* Module recognized this buffer, but cannot handle it. */
387 } else if (ret == SR_ERR) {
388 /* Module didn't recognize this buffer. */
390 } else if (ret != SR_OK) {
391 /* Can be SR_ERR_NA. */
395 /* Found a matching module. */
396 sr_spew("Module %s matched.", imod->id);
397 *in = sr_input_new(imod, NULL);
398 g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
406 * Try to find an input module that can parse the given file.
408 * If an input module is found, an instance is created into *in.
409 * Otherwise, *in contains NULL.
412 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
414 const struct sr_input_module *imod;
418 unsigned int midx, m, i;
421 uint8_t mitem, avail_metadata[8];
423 if (!filename || !filename[0]) {
424 sr_err("Invalid filename.");
428 if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
429 sr_err("No such file.");
433 if (stat(filename, &st) < 0) {
434 sr_err("%s", strerror(errno));
439 avail_metadata[midx++] = SR_INPUT_META_FILENAME;
440 avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
441 avail_metadata[midx++] = SR_INPUT_META_HEADER;
442 /* TODO: MIME type */
446 header_buf = g_string_sized_new(128);
447 for (i = 0; input_module_list[i]; i++) {
448 g_string_truncate(header_buf, 0);
450 imod = input_module_list[i];
451 if (!imod->metadata[0]) {
452 /* Module has no metadata for matching so will take
453 * any input. No point in letting it try to match. */
456 if (!check_required_metadata(imod->metadata, avail_metadata))
457 /* Cannot satisfy this module's requirements. */
460 meta = g_hash_table_new(NULL, NULL);
461 for (m = 0; m < sizeof(imod->metadata); m++) {
462 mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
464 /* Metadata list is 0-terminated. */
466 if (mitem == SR_INPUT_META_FILENAME) {
467 g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
469 } else if (mitem == SR_INPUT_META_FILESIZE) {
470 g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
471 GINT_TO_POINTER(st.st_size));
472 } else if (mitem == SR_INPUT_META_HEADER) {
473 if ((fd = open(filename, O_RDONLY)) < 0) {
474 sr_err("%s", strerror(errno));
477 size = read(fd, header_buf->str, 128);
478 header_buf->len = size;
481 g_string_free(header_buf, TRUE);
482 sr_err("%s", strerror(errno));
485 g_hash_table_insert(meta, GINT_TO_POINTER(mitem), header_buf);
488 if (g_hash_table_size(meta) == 0) {
489 /* No metadata for this module, so there's no way it
491 g_hash_table_destroy(meta);
494 sr_spew("Trying module %s.", imod->id);
495 ret = imod->format_match(meta);
496 g_hash_table_destroy(meta);
497 if (ret == SR_ERR_DATA) {
498 /* Module recognized this buffer, but cannot handle it. */
500 } else if (ret == SR_ERR) {
501 /* Module didn't recognize this buffer. */
503 } else if (ret != SR_OK) {
504 /* Can be SR_ERR_NA. */
508 /* Found a matching module. */
509 sr_spew("Module %s matched.", imod->id);
510 *in = sr_input_new(imod, NULL);
513 g_string_free(header_buf, TRUE);
519 * Return the input instance's (virtual) device instance. This can be
520 * used to find out the number of channels and other information.
522 * If the device instance has not yet been fully populated by the input
523 * module, NULL is returned. This indicates the module needs more data
524 * to identify the number of channels and so on.
528 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
537 * Send data to the specified input instance.
539 * When an input module instance is created with sr_input_new(), this
540 * function is used to feed data to the instance.
542 * As enough data gets fed into this function to completely populate
543 * the device instance associated with this input instance, this is
544 * guaranteed to return the moment it's ready. This gives the caller
545 * the chance to examine the device instance, attach session callbacks
550 SR_API int sr_input_send(const struct sr_input *in, GString *buf)
552 sr_spew("Sending %d bytes to %s module.", buf->len, in->module->id);
553 return in->module->receive((struct sr_input *)in, buf);
557 * Signal the input module no more data will come.
559 * This will cause the module to process any data it may have buffered.
560 * The SR_DF_END packet will also typically be sent at this time.
564 SR_API int sr_input_end(const struct sr_input *in)
566 sr_spew("Calling end() on %s module.", in->module->id);
567 return in->module->end((struct sr_input *)in);
571 * Free the specified input instance and all associated resources.
575 SR_API void sr_input_free(const struct sr_input *in)
580 if (in->module->cleanup)
581 in->module->cleanup((struct sr_input *)in);
583 sr_dev_inst_free(in->sdi);
584 if (in->buf->len > 64) {
585 /* That seems more than just some sub-unitsize leftover... */
586 sr_warn("Found %d unprocessed bytes at free time.", in->buf->len);
588 g_string_free(in->buf, TRUE);
590 g_free((gpointer)in);