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"
32 #define CHUNK_SIZE (4 * 1024 * 1024)
37 * Input module handling.
41 * @defgroup grp_input Input modules
43 * Input file/data module handling.
45 * libsigrok can process acquisition data in several different ways.
46 * Aside from acquiring data from a hardware device, it can also take it
47 * from a file in various formats (binary, CSV, VCD, and so on).
49 * Like all libsigrok data handling, processing is done in a streaming
50 * manner: input should be supplied a chunk at a time. This way anything
51 * that processes data can do so in real time, without the user having
52 * to wait for the whole thing to be finished.
54 * Every input module is "pluggable", meaning it's handled as being separate
55 * from the main libsigrok, but linked in to it statically. To keep things
56 * modular and separate like this, functions within an input module should be
57 * declared static, with only the respective 'struct sr_input_module' being
58 * exported for use into the wider libsigrok namespace.
64 extern SR_PRIV struct sr_input_module input_chronovu_la8;
65 extern SR_PRIV struct sr_input_module input_csv;
66 extern SR_PRIV struct sr_input_module input_binary;
67 extern SR_PRIV struct sr_input_module input_trace32_ad;
68 extern SR_PRIV struct sr_input_module input_vcd;
69 extern SR_PRIV struct sr_input_module input_wav;
70 extern SR_PRIV struct sr_input_module input_raw_analog;
71 extern SR_PRIV struct sr_input_module input_logicport;
72 extern SR_PRIV struct sr_input_module input_null;
75 static const struct sr_input_module *input_module_list[] = {
89 * Returns a NULL-terminated list of all available input modules.
93 SR_API const struct sr_input_module **sr_input_list(void)
95 return input_module_list;
99 * Returns the specified input module's ID.
103 SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
106 sr_err("Invalid input module NULL!");
114 * Returns the specified input module's name.
118 SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
121 sr_err("Invalid input module NULL!");
129 * Returns the specified input module's description.
133 SR_API const char *sr_input_description_get(const struct sr_input_module *imod)
136 sr_err("Invalid input module NULL!");
144 * Returns the specified input module's file extensions typical for the file
145 * format, as a NULL terminated array, or returns a NULL pointer if there is
146 * no preferred extension.
147 * @note these are a suggestions only.
151 SR_API const char *const *sr_input_extensions_get(
152 const struct sr_input_module *imod)
155 sr_err("Invalid input module NULL!");
163 * Return the input module with the specified ID, or NULL if no module
164 * with that id is found.
168 SR_API const struct sr_input_module *sr_input_find(char *id)
172 for (i = 0; input_module_list[i]; i++) {
173 if (!strcmp(input_module_list[i]->id, id))
174 return input_module_list[i];
181 * Returns a NULL-terminated array of struct sr_option, or NULL if the
182 * module takes no options.
184 * Each call to this function must be followed by a call to
185 * sr_input_options_free().
189 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod)
191 const struct sr_option *mod_opts, **opts;
194 if (!imod || !imod->options)
197 mod_opts = imod->options();
199 for (size = 0; mod_opts[size].id; size++)
201 opts = g_malloc((size + 1) * sizeof(struct sr_option *));
203 for (i = 0; i < size; i++)
204 opts[i] = &mod_opts[i];
211 * After a call to sr_input_options_get(), this function cleans up all
212 * resources returned by that call.
216 SR_API void sr_input_options_free(const struct sr_option **options)
223 for (i = 0; options[i]; i++) {
224 if (options[i]->def) {
225 g_variant_unref(options[i]->def);
226 ((struct sr_option *)options[i])->def = NULL;
229 if (options[i]->values) {
230 g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
231 ((struct sr_option *)options[i])->values = NULL;
238 * Create a new input instance using the specified input module.
240 * This function is used when a client wants to use a specific input
241 * module to parse a stream. No effort is made to identify the format.
243 * @param imod The input module to use. Must not be NULL.
244 * @param options GHashTable consisting of keys corresponding with
245 * the module options @c id field. The values should be GVariant
246 * pointers with sunk references, of the same GVariantType as the option's
251 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
255 const struct sr_option *mod_opts;
256 const GVariantType *gvt;
257 GHashTable *new_opts;
262 in = g_malloc0(sizeof(struct sr_input));
265 new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
266 (GDestroyNotify)g_variant_unref);
268 mod_opts = imod->options();
269 for (i = 0; mod_opts[i].id; i++) {
270 if (options && g_hash_table_lookup_extended(options,
271 mod_opts[i].id, &key, &value)) {
272 /* Option not given: insert the default value. */
273 gvt = g_variant_get_type(mod_opts[i].def);
274 if (!g_variant_is_of_type(value, gvt)) {
275 sr_err("Invalid type for '%s' option.",
280 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
281 g_variant_ref(value));
283 /* Pass option along. */
284 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
285 g_variant_ref(mod_opts[i].def));
289 /* Make sure no invalid options were given. */
291 g_hash_table_iter_init(&iter, options);
292 while (g_hash_table_iter_next(&iter, &key, &value)) {
293 if (!g_hash_table_lookup(new_opts, key)) {
294 sr_err("Input module '%s' has no option '%s'",
295 imod->id, (char *)key);
296 g_hash_table_destroy(new_opts);
304 if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
308 in->buf = g_string_sized_new(128);
312 g_hash_table_destroy(new_opts);
317 /* Returns TRUE if all required meta items are available. */
318 static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
323 for (m = 0; metadata[m]; m++) {
324 if (!(metadata[m] & SR_INPUT_META_REQUIRED))
326 reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
327 for (a = 0; avail[a]; a++) {
328 if (avail[a] == reqd)
332 /* Found a required meta item that isn't available. */
340 * Try to find an input module that can parse the given buffer.
342 * The buffer must contain enough of the beginning of the file for
343 * the input modules to find a match. This is format-dependent. When
344 * magic strings get checked, 128 bytes normally could be enough. Note
345 * that some formats try to parse larger header sections, and benefit
346 * from seeing a larger scope.
348 * If an input module is found, an instance is created into *in.
349 * Otherwise, *in contains NULL. When multiple input moduless claim
350 * support for the format, the one with highest confidence takes
351 * precedence. Applications will see at most one input module spec.
353 * If an instance is created, it has the given buffer used for scanning
354 * already submitted to it, to be processed before more data is sent.
355 * This allows a frontend to submit an initial chunk of a non-seekable
356 * stream, such as stdin, without having to keep it around and submit
360 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
362 const struct sr_input_module *imod, *best_imod;
365 unsigned int conf, best_conf;
367 uint8_t mitem, avail_metadata[8];
369 /* No more metadata to be had from a buffer. */
370 avail_metadata[0] = SR_INPUT_META_HEADER;
371 avail_metadata[1] = 0;
376 for (i = 0; input_module_list[i]; i++) {
377 imod = input_module_list[i];
378 if (!imod->metadata[0]) {
379 /* Module has no metadata for matching so will take
380 * any input. No point in letting it try to match. */
383 if (!check_required_metadata(imod->metadata, avail_metadata))
384 /* Cannot satisfy this module's requirements. */
387 meta = g_hash_table_new(NULL, NULL);
388 for (m = 0; m < sizeof(imod->metadata); m++) {
389 mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
390 if (mitem == SR_INPUT_META_HEADER)
391 g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
393 if (g_hash_table_size(meta) == 0) {
394 /* No metadata for this module, so nothing to match. */
395 g_hash_table_destroy(meta);
398 sr_spew("Trying module %s.", imod->id);
399 ret = imod->format_match(meta, &conf);
400 g_hash_table_destroy(meta);
401 if (ret == SR_ERR_DATA) {
402 /* Module recognized this buffer, but cannot handle it. */
404 } else if (ret == SR_ERR) {
405 /* Module didn't recognize this buffer. */
407 } else if (ret != SR_OK) {
408 /* Can be SR_ERR_NA. */
412 /* Found a matching module. */
413 sr_spew("Module %s matched, confidence %u.", imod->id, conf);
414 if (conf >= best_conf)
421 *in = sr_input_new(best_imod, NULL);
422 g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
430 * Try to find an input module that can parse the given file.
432 * If an input module is found, an instance is created into *in.
433 * Otherwise, *in contains NULL. When multiple input moduless claim
434 * support for the format, the one with highest confidence takes
435 * precedence. Applications will see at most one input module spec.
438 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
442 const struct sr_input_module *imod, *best_imod;
446 unsigned int midx, i;
447 unsigned int conf, best_conf;
449 uint8_t avail_metadata[8];
453 if (!filename || !filename[0]) {
454 sr_err("Invalid filename.");
457 stream = g_fopen(filename, "rb");
459 sr_err("Failed to open %s: %s", filename, g_strerror(errno));
462 filesize = sr_file_get_size(stream);
464 sr_err("Failed to get size of %s: %s",
465 filename, g_strerror(errno));
469 header = g_string_sized_new(CHUNK_SIZE);
470 count = fread(header->str, 1, header->allocated_len - 1, stream);
471 if (count < 1 || ferror(stream)) {
472 sr_err("Failed to read %s: %s", filename, g_strerror(errno));
474 g_string_free(header, TRUE);
478 g_string_set_size(header, count);
480 meta = g_hash_table_new(NULL, NULL);
481 g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILENAME),
483 g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILESIZE),
484 GSIZE_TO_POINTER(MIN(filesize, G_MAXSSIZE)));
485 g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_HEADER),
488 avail_metadata[midx++] = SR_INPUT_META_FILENAME;
489 avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
490 avail_metadata[midx++] = SR_INPUT_META_HEADER;
491 avail_metadata[midx] = 0;
492 /* TODO: MIME type */
496 for (i = 0; input_module_list[i]; i++) {
497 imod = input_module_list[i];
498 if (!imod->metadata[0]) {
499 /* Module has no metadata for matching so will take
500 * any input. No point in letting it try to match. */
503 if (!check_required_metadata(imod->metadata, avail_metadata))
504 /* Cannot satisfy this module's requirements. */
507 sr_dbg("Trying module %s.", imod->id);
509 ret = imod->format_match(meta, &conf);
511 /* Module didn't recognize this buffer. */
513 } else if (ret != SR_OK) {
514 /* Module recognized this buffer, but cannot handle it. */
517 /* Found a matching module. */
518 sr_dbg("Module %s matched, confidence %u.", imod->id, conf);
519 if (conf >= best_conf)
524 g_hash_table_destroy(meta);
525 g_string_free(header, TRUE);
528 *in = sr_input_new(best_imod, NULL);
536 * Return the input instance's module "class". This can be used to find out
537 * which input module handles a specific input file. This is especially
538 * useful when an application did not create the input stream by specifying
539 * an input module, but instead some shortcut or convenience wrapper did.
543 SR_API const struct sr_input_module *sr_input_module_get(const struct sr_input *in)
552 * Return the input instance's (virtual) device instance. This can be
553 * used to find out the number of channels and other information.
555 * If the device instance has not yet been fully populated by the input
556 * module, NULL is returned. This indicates the module needs more data
557 * to identify the number of channels and so on.
561 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
570 * Send data to the specified input instance.
572 * When an input module instance is created with sr_input_new(), this
573 * function is used to feed data to the instance.
575 * As enough data gets fed into this function to completely populate
576 * the device instance associated with this input instance, this is
577 * guaranteed to return the moment it's ready. This gives the caller
578 * the chance to examine the device instance, attach session callbacks
583 SR_API int sr_input_send(const struct sr_input *in, GString *buf)
587 len = buf ? buf->len : 0;
588 sr_spew("Sending %zu bytes to %s module.", len, in->module->id);
589 return in->module->receive((struct sr_input *)in, buf);
593 * Signal the input module no more data will come.
595 * This will cause the module to process any data it may have buffered.
596 * The SR_DF_END packet will also typically be sent at this time.
600 SR_API int sr_input_end(const struct sr_input *in)
602 sr_spew("Calling end() on %s module.", in->module->id);
603 return in->module->end((struct sr_input *)in);
607 * Reset the input module's input handling structures.
609 * Causes the input module to reset its internal state so that we can re-send
610 * the input data from the beginning without having to re-create the entire
615 SR_API int sr_input_reset(const struct sr_input *in_ro)
620 in = (struct sr_input *)in_ro; /* "un-const" */
621 if (!in || !in->module)
625 * Run the optional input module's .reset() method. This shall
626 * take care of the context (kept in the 'inc' variable).
628 if (in->module->reset) {
629 sr_spew("Resetting %s module.", in->module->id);
630 rc = in->module->reset(in);
632 sr_spew("Tried to reset %s module but no reset handler found.",
638 * Handle input module status (kept in the 'in' variable) here
639 * in common logic. This agrees with how input module's receive()
640 * and end() routines "amend but never seed" the 'in' information.
642 * Void potentially accumulated receive() buffer content, and
643 * clear the sdi_ready flag. This makes sure that subsequent
644 * processing will scan the header again before sample data gets
645 * interpreted, and stale content from previous calls won't affect
648 * This common logic does not harm when the input module implements
649 * .reset() and contains identical assignments. In the absence of
650 * an individual .reset() method, simple input modules can completely
651 * rely on common code and keep working across resets.
654 g_string_truncate(in->buf, 0);
655 in->sdi_ready = FALSE;
661 * Free the specified input instance and all associated resources.
665 SR_API void sr_input_free(const struct sr_input *in)
671 * Run the input module's optional .cleanup() routine. This
672 * takes care of the context (kept in the 'inc' variable).
674 if (in->module->cleanup)
675 in->module->cleanup((struct sr_input *)in);
678 * Common code releases the input module's state (kept in the
679 * 'in' variable). Release the device instance, the receive()
680 * buffer, the shallow 'in->priv' block which is 'inc' (after
681 * .cleanup() released potentially nested resources under 'inc').
683 sr_dev_inst_free(in->sdi);
684 if (in->buf->len > 64) {
685 /* That seems more than just some sub-unitsize leftover... */
686 sr_warn("Found %" G_GSIZE_FORMAT
687 " unprocessed bytes at free time.", in->buf->len);
689 g_string_free(in->buf, TRUE);
691 g_free((gpointer)in);