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/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.",
271 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
272 g_variant_ref(value));
274 /* Pass option along. */
275 g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
276 g_variant_ref(mod_opts[i].def));
280 /* Make sure no invalid options were given. */
282 g_hash_table_iter_init(&iter, options);
283 while (g_hash_table_iter_next(&iter, &key, &value)) {
284 if (!g_hash_table_lookup(new_opts, key)) {
285 sr_err("Input module '%s' has no option '%s'",
286 imod->id, (char *)key);
287 g_hash_table_destroy(new_opts);
295 if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
299 in->buf = g_string_sized_new(128);
303 g_hash_table_destroy(new_opts);
308 /* Returns TRUE if all required meta items are available. */
309 static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
314 for (m = 0; metadata[m]; m++) {
315 if (!(metadata[m] & SR_INPUT_META_REQUIRED))
317 reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
318 for (a = 0; avail[a]; a++) {
319 if (avail[a] == reqd)
323 /* Found a required meta item that isn't available. */
331 * Try to find an input module that can parse the given buffer.
333 * The buffer must contain enough of the beginning of the file for
334 * the input modules to find a match. This is format-dependent, but
335 * 128 bytes is normally enough.
337 * If an input module is found, an instance is created into *in.
338 * Otherwise, *in contains NULL.
340 * If an instance is created, it has the given buffer used for scanning
341 * already submitted to it, to be processed before more data is sent.
342 * This allows a frontend to submit an initial chunk of a non-seekable
343 * stream, such as stdin, without having to keep it around and submit
347 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
349 const struct sr_input_module *imod;
353 uint8_t mitem, avail_metadata[8];
355 /* No more metadata to be had from a buffer. */
356 avail_metadata[0] = SR_INPUT_META_HEADER;
357 avail_metadata[1] = 0;
361 for (i = 0; input_module_list[i]; i++) {
362 imod = input_module_list[i];
363 if (!imod->metadata[0]) {
364 /* Module has no metadata for matching so will take
365 * any input. No point in letting it try to match. */
368 if (!check_required_metadata(imod->metadata, avail_metadata))
369 /* Cannot satisfy this module's requirements. */
372 meta = g_hash_table_new(NULL, NULL);
373 for (m = 0; m < sizeof(imod->metadata); m++) {
374 mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
375 if (mitem == SR_INPUT_META_HEADER)
376 g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
378 if (g_hash_table_size(meta) == 0) {
379 /* No metadata for this module, so nothing to match. */
380 g_hash_table_destroy(meta);
383 sr_spew("Trying module %s.", imod->id);
384 ret = imod->format_match(meta);
385 g_hash_table_destroy(meta);
386 if (ret == SR_ERR_DATA) {
387 /* Module recognized this buffer, but cannot handle it. */
389 } else if (ret == SR_ERR) {
390 /* Module didn't recognize this buffer. */
392 } else if (ret != SR_OK) {
393 /* Can be SR_ERR_NA. */
397 /* Found a matching module. */
398 sr_spew("Module %s matched.", imod->id);
399 *in = sr_input_new(imod, NULL);
400 g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
408 * Try to find an input module that can parse the given file.
410 * If an input module is found, an instance is created into *in.
411 * Otherwise, *in contains NULL.
414 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
416 const struct sr_input_module *imod;
420 unsigned int midx, m, i;
423 uint8_t mitem, avail_metadata[8];
425 if (!filename || !filename[0]) {
426 sr_err("Invalid filename.");
430 if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
431 sr_err("No such file.");
435 if (stat(filename, &st) < 0) {
436 sr_err("%s", g_strerror(errno));
441 avail_metadata[midx++] = SR_INPUT_META_FILENAME;
442 avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
443 avail_metadata[midx++] = SR_INPUT_META_HEADER;
444 /* TODO: MIME type */
448 header_buf = g_string_sized_new(128);
449 for (i = 0; input_module_list[i]; i++) {
450 g_string_truncate(header_buf, 0);
452 imod = input_module_list[i];
453 if (!imod->metadata[0]) {
454 /* Module has no metadata for matching so will take
455 * any input. No point in letting it try to match. */
458 if (!check_required_metadata(imod->metadata, avail_metadata))
459 /* Cannot satisfy this module's requirements. */
462 meta = g_hash_table_new(NULL, NULL);
463 for (m = 0; m < sizeof(imod->metadata); m++) {
464 mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
466 /* Metadata list is 0-terminated. */
468 if (mitem == SR_INPUT_META_FILENAME) {
469 g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
471 } else if (mitem == SR_INPUT_META_FILESIZE) {
472 g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
473 GINT_TO_POINTER(st.st_size));
474 } else if (mitem == SR_INPUT_META_HEADER) {
475 if ((fd = open(filename, O_RDONLY)) < 0) {
476 sr_err("%s", g_strerror(errno));
479 size = read(fd, header_buf->str, 128);
480 header_buf->len = size;
483 g_string_free(header_buf, TRUE);
484 sr_err("%s", g_strerror(errno));
487 g_hash_table_insert(meta, GINT_TO_POINTER(mitem), header_buf);
490 if (g_hash_table_size(meta) == 0) {
491 /* No metadata for this module, so there's no way it
493 g_hash_table_destroy(meta);
496 sr_spew("Trying module %s.", imod->id);
497 ret = imod->format_match(meta);
498 g_hash_table_destroy(meta);
499 if (ret == SR_ERR_DATA) {
500 /* Module recognized this buffer, but cannot handle it. */
502 } else if (ret == SR_ERR) {
503 /* Module didn't recognize this buffer. */
505 } else if (ret != SR_OK) {
506 /* Can be SR_ERR_NA. */
510 /* Found a matching module. */
511 sr_spew("Module %s matched.", imod->id);
512 *in = sr_input_new(imod, NULL);
515 g_string_free(header_buf, TRUE);
521 * Return the input instance's (virtual) device instance. This can be
522 * used to find out the number of channels and other information.
524 * If the device instance has not yet been fully populated by the input
525 * module, NULL is returned. This indicates the module needs more data
526 * to identify the number of channels and so on.
530 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
539 * Send data to the specified input instance.
541 * When an input module instance is created with sr_input_new(), this
542 * function is used to feed data to the instance.
544 * As enough data gets fed into this function to completely populate
545 * the device instance associated with this input instance, this is
546 * guaranteed to return the moment it's ready. This gives the caller
547 * the chance to examine the device instance, attach session callbacks
552 SR_API int sr_input_send(const struct sr_input *in, GString *buf)
554 sr_spew("Sending %" G_GSIZE_FORMAT " bytes to %s module.",
555 buf->len, in->module->id);
556 return in->module->receive((struct sr_input *)in, buf);
560 * Signal the input module no more data will come.
562 * This will cause the module to process any data it may have buffered.
563 * The SR_DF_END packet will also typically be sent at this time.
567 SR_API int sr_input_end(const struct sr_input *in)
569 sr_spew("Calling end() on %s module.", in->module->id);
570 return in->module->end((struct sr_input *)in);
574 * Free the specified input instance and all associated resources.
578 SR_API void sr_input_free(const struct sr_input *in)
583 if (in->module->cleanup)
584 in->module->cleanup((struct sr_input *)in);
586 sr_dev_inst_free(in->sdi);
587 if (in->buf->len > 64) {
588 /* That seems more than just some sub-unitsize leftover... */
589 sr_warn("Found %" G_GSIZE_FORMAT
590 " unprocessed bytes at free time.", in->buf->len);
592 g_string_free(in->buf, TRUE);
594 g_free((gpointer)in);