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/>.
24 #include <glib/gstdio.h>
25 #include <libsigrok/libsigrok.h>
26 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "input"
33 #define CHUNK_SIZE (4 * 1024 * 1024)
39 * Input module handling.
43 * @defgroup grp_input Input modules
45 * Input file/data module handling.
47 * libsigrok can process acquisition data in several different ways.
48 * Aside from acquiring data from a hardware device, it can also take it
49 * from a file in various formats (binary, CSV, VCD, and so on).
51 * Like all libsigrok data handling, processing is done in a streaming
52 * manner: input should be supplied a chunk at a time. This way anything
53 * that processes data can do so in real time, without the user having
54 * to wait for the whole thing to be finished.
56 * Every input module is "pluggable", meaning it's handled as being separate
57 * from the main libsigrok, but linked in to it statically. To keep things
58 * modular and separate like this, functions within an input module should be
59 * declared static, with only the respective 'struct sr_input_module' being
60 * exported for use into the wider libsigrok namespace.
66 extern SR_PRIV struct sr_input_module input_chronovu_la8;
67 extern SR_PRIV struct sr_input_module input_csv;
68 extern SR_PRIV struct sr_input_module input_binary;
69 extern SR_PRIV struct sr_input_module input_stf;
70 extern SR_PRIV struct sr_input_module input_trace32_ad;
71 extern SR_PRIV struct sr_input_module input_vcd;
72 extern SR_PRIV struct sr_input_module input_wav;
73 extern SR_PRIV struct sr_input_module input_raw_analog;
74 extern SR_PRIV struct sr_input_module input_logicport;
75 extern SR_PRIV struct sr_input_module input_saleae;
76 extern SR_PRIV struct sr_input_module input_null;
79 static const struct sr_input_module *input_module_list[] = {
83 #if defined HAVE_INPUT_STF && HAVE_INPUT_STF
97 * Returns a NULL-terminated list of all available input modules.
101 SR_API const struct sr_input_module **sr_input_list(void)
103 return input_module_list;
107 * Returns the specified input module's ID.
111 SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
114 sr_err("Invalid input module NULL!");
122 * Returns the specified input module's name.
126 SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
129 sr_err("Invalid input module NULL!");
137 * Returns the specified input module's description.
141 SR_API const char *sr_input_description_get(const struct sr_input_module *imod)
144 sr_err("Invalid input module NULL!");
152 * Returns the specified input module's file extensions typical for the file
153 * format, as a NULL terminated array, or returns a NULL pointer if there is
154 * no preferred extension.
155 * @note these are a suggestions only.
159 SR_API const char *const *sr_input_extensions_get(
160 const struct sr_input_module *imod)
163 sr_err("Invalid input module NULL!");
171 * Return the input module with the specified ID, or NULL if no module
172 * with that id is found.
176 SR_API const struct sr_input_module *sr_input_find(char *id)
180 for (i = 0; input_module_list[i]; i++) {
181 if (!strcmp(input_module_list[i]->id, id))
182 return input_module_list[i];
189 * Returns a NULL-terminated array of struct sr_option, or NULL if the
190 * module takes no options.
192 * Each call to this function must be followed by a call to
193 * sr_input_options_free().
197 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod)
199 const struct sr_option *mod_opts, **opts;
202 if (!imod || !imod->options)
205 mod_opts = imod->options();
207 for (size = 0; mod_opts[size].id; size++)
209 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
211 for (i = 0; i < size; i++)
212 opts[i] = &mod_opts[i];
219 * After a call to sr_input_options_get(), this function cleans up all
220 * resources returned by that call.
224 SR_API void sr_input_options_free(const struct sr_option **options)
231 for (i = 0; options[i]; i++) {
232 if (options[i]->def) {
233 g_variant_unref(options[i]->def);
234 ((struct sr_option *)options[i])->def = NULL;
237 if (options[i]->values) {
238 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
239 ((struct sr_option *)options[i])->values = NULL;
246 * Create a new input instance using the specified input module.
248 * This function is used when a client wants to use a specific input
249 * module to parse a stream. No effort is made to identify the format.
251 * @param imod The input module to use. Must not be NULL.
252 * @param options GHashTable consisting of keys corresponding with
253 * the module options @c id field. The values should be GVariant
254 * pointers with sunk references, of the same GVariantType as the option's
259 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
263 const struct sr_option *mod_opts;
264 const GVariantType *gvt;
265 GHashTable *new_opts;
270 in = g_malloc0(sizeof(struct sr_input));
273 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
274 (GDestroyNotify)g_variant_unref);
276 mod_opts = imod->options();
277 for (i = 0; mod_opts[i].id; i++) {
278 if (options && g_hash_table_lookup_extended(options,
279 mod_opts[i].id, &key, &value)) {
280 /* Option not given: insert the default value. */
281 gvt = g_variant_get_type(mod_opts[i].def);
282 if (!g_variant_is_of_type(value, gvt)) {
283 sr_err("Invalid type for '%s' option.",
288 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
289 g_variant_ref(value));
291 /* Pass option along. */
292 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
293 g_variant_ref(mod_opts[i].def));
297 /* Make sure no invalid options were given. */
299 g_hash_table_iter_init(&iter, options);
300 while (g_hash_table_iter_next(&iter, &key, &value)) {
301 if (!g_hash_table_lookup(new_opts, key)) {
302 sr_err("Input module '%s' has no option '%s'",
303 imod->id, (char *)key);
304 g_hash_table_destroy(new_opts);
312 if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
316 in->buf = g_string_sized_new(128);
320 g_hash_table_destroy(new_opts);
325 /* Returns TRUE if all required meta items are available. */
326 static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
331 for (m = 0; metadata[m]; m++) {
332 if (!(metadata[m] & SR_INPUT_META_REQUIRED))
334 reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
335 for (a = 0; avail[a]; a++) {
336 if (avail[a] == reqd)
340 /* Found a required meta item that isn't available. */
348 * Try to find an input module that can parse the given buffer.
350 * The buffer must contain enough of the beginning of the file for
351 * the input modules to find a match. This is format-dependent. When
352 * magic strings get checked, 128 bytes normally could be enough. Note
353 * that some formats try to parse larger header sections, and benefit
354 * from seeing a larger scope.
356 * If an input module is found, an instance is created into *in.
357 * Otherwise, *in contains NULL. When multiple input moduless claim
358 * support for the format, the one with highest confidence takes
359 * precedence. Applications will see at most one input module spec.
361 * If an instance is created, it has the given buffer used for scanning
362 * already submitted to it, to be processed before more data is sent.
363 * This allows a frontend to submit an initial chunk of a non-seekable
364 * stream, such as stdin, without having to keep it around and submit
368 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
370 const struct sr_input_module *imod, *best_imod;
373 unsigned int conf, best_conf;
375 uint8_t mitem, avail_metadata[8];
377 /* No more metadata to be had from a buffer. */
378 avail_metadata[0] = SR_INPUT_META_HEADER;
379 avail_metadata[1] = 0;
384 for (i = 0; input_module_list[i]; i++) {
385 imod = input_module_list[i];
386 if (!imod->metadata[0]) {
387 /* Module has no metadata for matching so will take
388 * any input. No point in letting it try to match. */
391 if (!check_required_metadata(imod->metadata, avail_metadata))
392 /* Cannot satisfy this module's requirements. */
395 meta = g_hash_table_new(NULL, NULL);
396 for (m = 0; m < sizeof(imod->metadata); m++) {
397 mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
398 if (mitem == SR_INPUT_META_HEADER)
399 g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
401 if (g_hash_table_size(meta) == 0) {
402 /* No metadata for this module, so nothing to match. */
403 g_hash_table_destroy(meta);
406 sr_spew("Trying module %s.", imod->id);
407 ret = imod->format_match(meta, &conf);
408 g_hash_table_destroy(meta);
409 if (ret == SR_ERR_DATA) {
410 /* Module recognized this buffer, but cannot handle it. */
412 } else if (ret == SR_ERR) {
413 /* Module didn't recognize this buffer. */
415 } else if (ret != SR_OK) {
416 /* Can be SR_ERR_NA. */
420 /* Found a matching module. */
421 sr_spew("Module %s matched, confidence %u.", imod->id, conf);
422 if (conf >= best_conf)
429 *in = sr_input_new(best_imod, NULL);
430 g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
438 * Try to find an input module that can parse the given file.
440 * If an input module is found, an instance is created into *in.
441 * Otherwise, *in contains NULL. When multiple input moduless claim
442 * support for the format, the one with highest confidence takes
443 * precedence. Applications will see at most one input module spec.
446 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
450 const struct sr_input_module *imod, *best_imod;
454 unsigned int midx, i;
455 unsigned int conf, best_conf;
457 uint8_t avail_metadata[8];
461 if (!filename || !filename[0]) {
462 sr_err("Invalid filename.");
465 stream = g_fopen(filename, "rb");
467 sr_err("Failed to open %s: %s", filename, g_strerror(errno));
470 filesize = sr_file_get_size(stream);
472 sr_err("Failed to get size of %s: %s",
473 filename, g_strerror(errno));
477 header = g_string_sized_new(CHUNK_SIZE);
478 count = fread(header->str, 1, header->allocated_len - 1, stream);
479 if (count < 1 || ferror(stream)) {
480 sr_err("Failed to read %s: %s", filename, g_strerror(errno));
482 g_string_free(header, TRUE);
486 g_string_set_size(header, count);
488 meta = g_hash_table_new(NULL, NULL);
489 g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILENAME),
491 g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILESIZE),
492 GSIZE_TO_POINTER(MIN(filesize, G_MAXSSIZE)));
493 g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_HEADER),
496 avail_metadata[midx++] = SR_INPUT_META_FILENAME;
497 avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
498 avail_metadata[midx++] = SR_INPUT_META_HEADER;
499 avail_metadata[midx] = 0;
500 /* TODO: MIME type */
504 for (i = 0; input_module_list[i]; i++) {
505 imod = input_module_list[i];
506 if (!imod->metadata[0]) {
507 /* Module has no metadata for matching so will take
508 * any input. No point in letting it try to match. */
511 if (!check_required_metadata(imod->metadata, avail_metadata))
512 /* Cannot satisfy this module's requirements. */
515 sr_dbg("Trying module %s.", imod->id);
517 ret = imod->format_match(meta, &conf);
519 /* Module didn't recognize this buffer. */
521 } else if (ret != SR_OK) {
522 /* Module recognized this buffer, but cannot handle it. */
525 /* Found a matching module. */
526 sr_dbg("Module %s matched, confidence %u.", imod->id, conf);
527 if (conf >= best_conf)
532 g_hash_table_destroy(meta);
533 g_string_free(header, TRUE);
536 *in = sr_input_new(best_imod, NULL);
544 * Return the input instance's module "class". This can be used to find out
545 * which input module handles a specific input file. This is especially
546 * useful when an application did not create the input stream by specifying
547 * an input module, but instead some shortcut or convenience wrapper did.
551 SR_API const struct sr_input_module *sr_input_module_get(const struct sr_input *in)
560 * Return the input instance's (virtual) device instance. This can be
561 * used to find out the number of channels and other information.
563 * If the device instance has not yet been fully populated by the input
564 * module, NULL is returned. This indicates the module needs more data
565 * to identify the number of channels and so on.
569 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
578 * Send data to the specified input instance.
580 * When an input module instance is created with sr_input_new(), this
581 * function is used to feed data to the instance.
583 * As enough data gets fed into this function to completely populate
584 * the device instance associated with this input instance, this is
585 * guaranteed to return the moment it's ready. This gives the caller
586 * the chance to examine the device instance, attach session callbacks
591 SR_API int sr_input_send(const struct sr_input *in, GString *buf)
595 len = buf ? buf->len : 0;
596 sr_spew("Sending %zu bytes to %s module.", len, in->module->id);
597 return in->module->receive((struct sr_input *)in, buf);
601 * Signal the input module no more data will come.
603 * This will cause the module to process any data it may have buffered.
604 * The SR_DF_END packet will also typically be sent at this time.
608 SR_API int sr_input_end(const struct sr_input *in)
610 sr_spew("Calling end() on %s module.", in->module->id);
611 return in->module->end((struct sr_input *)in);
615 * Reset the input module's input handling structures.
617 * Causes the input module to reset its internal state so that we can re-send
618 * the input data from the beginning without having to re-create the entire
623 SR_API int sr_input_reset(const struct sr_input *in_ro)
628 in = (struct sr_input *)in_ro; /* "un-const" */
629 if (!in || !in->module)
633 * Run the optional input module's .reset() method. This shall
634 * take care of the context (kept in the 'inc' variable).
636 if (in->module->reset) {
637 sr_spew("Resetting %s module.", in->module->id);
638 rc = in->module->reset(in);
640 sr_spew("Tried to reset %s module but no reset handler found.",
646 * Handle input module status (kept in the 'in' variable) here
647 * in common logic. This agrees with how input module's receive()
648 * and end() routines "amend but never seed" the 'in' information.
650 * Void potentially accumulated receive() buffer content, and
651 * clear the sdi_ready flag. This makes sure that subsequent
652 * processing will scan the header again before sample data gets
653 * interpreted, and stale content from previous calls won't affect
656 * This common logic does not harm when the input module implements
657 * .reset() and contains identical assignments. In the absence of
658 * an individual .reset() method, simple input modules can completely
659 * rely on common code and keep working across resets.
662 g_string_truncate(in->buf, 0);
663 in->sdi_ready = FALSE;
669 * Free the specified input instance and all associated resources.
673 SR_API void sr_input_free(const struct sr_input *in)
679 * Run the input module's optional .cleanup() routine. This
680 * takes care of the context (kept in the 'inc' variable).
682 if (in->module->cleanup)
683 in->module->cleanup((struct sr_input *)in);
686 * Common code releases the input module's state (kept in the
687 * 'in' variable). Release the device instance, the receive()
688 * buffer, the shallow 'in->priv' block which is 'inc' (after
689 * .cleanup() released potentially nested resources under 'inc').
691 sr_dev_inst_free(in->sdi);
692 if (in->buf->len > 64) {
693 /* That seems more than just some sub-unitsize leftover... */
694 sr_warn("Found %" G_GSIZE_FORMAT
695 " unprocessed bytes at free time.", in->buf->len);
697 g_string_free(in->buf, TRUE);
699 g_free((gpointer)in);