/*
* This file is part of the libsigrok project.
*
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include <string.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <errno.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
+#define LOG_PREFIX "input"
+
/**
* @file
*
- * Input file/data format handling.
+ * Input module handling.
*/
/**
- * @defgroup grp_input Input formats
+ * @defgroup grp_input Input modules
*
- * Input file/data format handling.
+ * Input file/data module handling.
*
* libsigrok can process acquisition data in several different ways.
- * Aside from acquiring data from a hardware device, it can also take it from
- * a file in various formats (binary, CSV, VCD, and so on).
+ * Aside from acquiring data from a hardware device, it can also take it
+ * from a file in various formats (binary, CSV, VCD, and so on).
*
- * Like everything in libsigrok that handles data, processing is done in a
- * streaming manner -- input should be supplied to libsigrok a chunk at a time.
- * This way anything that processes data can do so in real time, without the
- * user having to wait for the whole thing to be finished.
+ * Like all libsigrok data handling, processing is done in a streaming
+ * manner: input should be supplied a chunk at a time. This way anything
+ * that processes data can do so in real time, without the user having
+ * to wait for the whole thing to be finished.
*
* Every input module is "pluggable", meaning it's handled as being separate
* from the main libsigrok, but linked in to it statically. To keep things
* modular and separate like this, functions within an input module should be
- * declared static, with only the respective 'struct sr_input_format' being
+ * declared static, with only the respective 'struct sr_input_module' being
* exported for use into the wider libsigrok namespace.
*
* @{
*/
/** @cond PRIVATE */
-extern SR_PRIV struct sr_input_format input_chronovu_la8;
-extern SR_PRIV struct sr_input_format input_csv;
-extern SR_PRIV struct sr_input_format input_binary;
-extern SR_PRIV struct sr_input_format input_vcd;
-extern SR_PRIV struct sr_input_format input_wav;
+extern SR_PRIV struct sr_input_module input_chronovu_la8;
+extern SR_PRIV struct sr_input_module input_csv;
+extern SR_PRIV struct sr_input_module input_binary;
+extern SR_PRIV struct sr_input_module input_vcd;
+extern SR_PRIV struct sr_input_module input_wav;
/* @endcond */
-static struct sr_input_format *input_module_list[] = {
- &input_vcd,
+static const struct sr_input_module *input_module_list[] = {
+ &input_binary,
&input_chronovu_la8,
- &input_wav,
&input_csv,
- /* This one has to be last, because it will take any input. */
- &input_binary,
+ &input_vcd,
+ &input_wav,
NULL,
};
-/** @since 0.1.0 */
-SR_API struct sr_input_format **sr_input_list(void)
+/**
+ * Returns a NULL-terminated list of all available input modules.
+ *
+ * @since 0.4.0
+ */
+SR_API const struct sr_input_module **sr_input_list(void)
{
return input_module_list;
}
+/**
+ * Returns the specified input module's ID.
+ *
+ * @since 0.4.0
+ */
+SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
+{
+ if (!imod) {
+ sr_err("Invalid input module NULL!");
+ return NULL;
+ }
+
+ return imod->id;
+}
+
+/**
+ * Returns the specified input module's name.
+ *
+ * @since 0.4.0
+ */
+SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
+{
+ if (!imod) {
+ sr_err("Invalid input module NULL!");
+ return NULL;
+ }
+
+ return imod->name;
+}
+
+/**
+ * Returns the specified input module's description.
+ *
+ * @since 0.4.0
+ */
+SR_API const char *sr_input_description_get(const struct sr_input_module *imod)
+{
+ if (!imod) {
+ sr_err("Invalid input module NULL!");
+ return NULL;
+ }
+
+ return imod->desc;
+}
+
+/**
+ * Returns the specified input module's file extensions typical for the file
+ * format, as a NULL terminated array, or returns a NULL pointer if there is
+ * no preferred extension.
+ * @note these are a suggestions only.
+ *
+ * @since 0.4.0
+ */
+SR_API const char *const *sr_input_extensions_get(
+ const struct sr_input_module *imod)
+{
+ if (!imod) {
+ sr_err("Invalid input module NULL!");
+ return NULL;
+ }
+
+ return imod->exts;
+}
+
+/**
+ * Return the input module with the specified ID, or NULL if no module
+ * with that id is found.
+ *
+ * @since 0.4.0
+ */
+SR_API const struct sr_input_module *sr_input_find(char *id)
+{
+ int i;
+
+ for (i = 0; input_module_list[i]; i++) {
+ if (!strcmp(input_module_list[i]->id, id))
+ return input_module_list[i];
+ }
+
+ return NULL;
+}
+
+/**
+ * Returns a NULL-terminated array of struct sr_option, or NULL if the
+ * module takes no options.
+ *
+ * Each call to this function must be followed by a call to
+ * sr_input_options_free().
+ *
+ * @since 0.4.0
+ */
+SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod)
+{
+ const struct sr_option *mod_opts, **opts;
+ int size, i;
+
+ if (!imod || !imod->options)
+ return NULL;
+
+ mod_opts = imod->options();
+
+ for (size = 0; mod_opts[size].id; size++)
+ ;
+ opts = g_malloc((size + 1) * sizeof(struct sr_option *));
+
+ for (i = 0; i < size; i++)
+ opts[i] = &mod_opts[i];
+ opts[i] = NULL;
+
+ return opts;
+}
+
+/**
+ * After a call to sr_input_options_get(), this function cleans up all
+ * resources returned by that call.
+ *
+ * @since 0.4.0
+ */
+SR_API void sr_input_options_free(const struct sr_option **options)
+{
+ int i;
+
+ if (!options)
+ return;
+
+ for (i = 0; options[i]; i++) {
+ if (options[i]->def) {
+ g_variant_unref(options[i]->def);
+ ((struct sr_option *)options[i])->def = NULL;
+ }
+
+ if (options[i]->values) {
+ g_slist_free_full(options[i]->values, (GDestroyNotify)g_variant_unref);
+ ((struct sr_option *)options[i])->values = NULL;
+ }
+ }
+ g_free(options);
+}
+
+/**
+ * Create a new input instance using the specified input module.
+ *
+ * This function is used when a client wants to use a specific input
+ * module to parse a stream. No effort is made to identify the format.
+ *
+ * @param imod The input module to use. Must not be NULL.
+ * @param options GHashTable consisting of keys corresponding with
+ * the module options \c id field. The values should be GVariant
+ * pointers with sunk references, of the same GVariantType as the option's
+ * default value.
+ *
+ * @since 0.4.0
+ */
+SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
+ GHashTable *options)
+{
+ struct sr_input *in;
+ struct sr_option *mod_opts;
+ const GVariantType *gvt;
+ GHashTable *new_opts;
+ GHashTableIter iter;
+ gpointer key, value;
+ int i;
+
+ in = g_malloc0(sizeof(struct sr_input));
+ in->module = imod;
+
+ new_opts = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
+ (GDestroyNotify)g_variant_unref);
+ if (imod->options) {
+ mod_opts = imod->options();
+ for (i = 0; mod_opts[i].id; i++) {
+ if (options && g_hash_table_lookup_extended(options,
+ mod_opts[i].id, &key, &value)) {
+ /* Option not given: insert the default value. */
+ gvt = g_variant_get_type(mod_opts[i].def);
+ if (!g_variant_is_of_type(value, gvt)) {
+ sr_err("Invalid type for '%s' option.", key);
+ g_free(in);
+ return NULL;
+ }
+ g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
+ g_variant_ref(value));
+ } else {
+ /* Pass option along. */
+ g_hash_table_insert(new_opts, g_strdup(mod_opts[i].id),
+ g_variant_ref(mod_opts[i].def));
+ }
+ }
+
+ /* Make sure no invalid options were given. */
+ if (options) {
+ g_hash_table_iter_init(&iter, options);
+ while (g_hash_table_iter_next(&iter, &key, &value)) {
+ if (!g_hash_table_lookup(new_opts, key)) {
+ sr_err("Input module '%s' has no option '%s'", imod->id, key);
+ g_hash_table_destroy(new_opts);
+ g_free(in);
+ return NULL;
+ }
+ }
+ }
+ }
+
+ if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
+ g_free(in);
+ in = NULL;
+ } else {
+ in->buf = g_string_sized_new(128);
+ }
+
+ if (new_opts)
+ g_hash_table_destroy(new_opts);
+
+ return in;
+}
+
+/* Returns TRUE if all required meta items are available. */
+static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
+{
+ int m, a;
+ uint8_t reqd;
+
+ for (m = 0; metadata[m]; m++) {
+ if (!(metadata[m] & SR_INPUT_META_REQUIRED))
+ continue;
+ reqd = metadata[m] & ~SR_INPUT_META_REQUIRED;
+ for (a = 0; avail[a]; a++) {
+ if (avail[a] == reqd)
+ break;
+ }
+ if (!avail[a])
+ /* Found a required meta item that isn't available. */
+ return FALSE;
+ }
+
+ return TRUE;
+}
+
+/**
+ * Try to find an input module that can parse the given buffer.
+ *
+ * The buffer must contain enough of the beginning of the file for
+ * the input modules to find a match. This is format-dependent, but
+ * 128 bytes is normally enough.
+ *
+ * If an input module is found, an instance is created into *in.
+ * Otherwise, *in contains NULL.
+ *
+ * If an instance is created, it has the given buffer used for scanning
+ * already submitted to it, to be processed before more data is sent.
+ * This allows a frontend to submit an initial chunk of a non-seekable
+ * stream, such as stdin, without having to keep it around and submit
+ * it again later.
+ *
+ */
+SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
+{
+ const struct sr_input_module *imod;
+ GHashTable *meta;
+ unsigned int m, i;
+ int ret;
+ uint8_t mitem, avail_metadata[8];
+
+ /* No more metadata to be had from a buffer. */
+ avail_metadata[0] = SR_INPUT_META_HEADER;
+ avail_metadata[1] = 0;
+
+ *in = NULL;
+ ret = SR_ERR;
+ for (i = 0; input_module_list[i]; i++) {
+ imod = input_module_list[i];
+ if (!imod->metadata[0]) {
+ /* Module has no metadata for matching so will take
+ * any input. No point in letting it try to match. */
+ continue;
+ }
+ if (!check_required_metadata(imod->metadata, avail_metadata))
+ /* Cannot satisfy this module's requirements. */
+ continue;
+
+ meta = g_hash_table_new(NULL, NULL);
+ for (m = 0; m < sizeof(imod->metadata); m++) {
+ mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
+ if (mitem == SR_INPUT_META_HEADER)
+ g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
+ }
+ if (g_hash_table_size(meta) == 0) {
+ /* No metadata for this module, so nothing to match. */
+ g_hash_table_destroy(meta);
+ continue;
+ }
+ sr_spew("Trying module %s.", imod->id);
+ ret = imod->format_match(meta);
+ g_hash_table_destroy(meta);
+ if (ret == SR_ERR_DATA) {
+ /* Module recognized this buffer, but cannot handle it. */
+ break;
+ } else if (ret == SR_ERR) {
+ /* Module didn't recognize this buffer. */
+ continue;
+ } else if (ret != SR_OK) {
+ /* Can be SR_ERR_NA. */
+ return ret;
+ }
+
+ /* Found a matching module. */
+ sr_spew("Module %s matched.", imod->id);
+ *in = sr_input_new(imod, NULL);
+ g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
+ break;
+ }
+
+ return ret;
+}
+
+/**
+ * Try to find an input module that can parse the given file.
+ *
+ * If an input module is found, an instance is created into *in.
+ * Otherwise, *in contains NULL.
+ *
+ */
+SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
+{
+ const struct sr_input_module *imod;
+ GHashTable *meta;
+ GString *header_buf;
+ struct stat st;
+ unsigned int midx, m, i;
+ int fd, ret;
+ ssize_t size;
+ uint8_t mitem, avail_metadata[8];
+
+ if (!filename || !filename[0]) {
+ sr_err("Invalid filename.");
+ return SR_ERR_ARG;
+ }
+
+ if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
+ sr_err("No such file.");
+ return SR_ERR_ARG;
+ }
+
+ if (stat(filename, &st) < 0) {
+ sr_err("%s", strerror(errno));
+ return SR_ERR_ARG;
+ }
+
+ midx = 0;
+ avail_metadata[midx++] = SR_INPUT_META_FILENAME;
+ avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
+ avail_metadata[midx++] = SR_INPUT_META_HEADER;
+ /* TODO: MIME type */
+
+ *in = NULL;
+ ret = SR_ERR;
+ header_buf = g_string_sized_new(128);
+ for (i = 0; input_module_list[i]; i++) {
+ g_string_truncate(header_buf, 0);
+
+ imod = input_module_list[i];
+ if (!imod->metadata[0]) {
+ /* Module has no metadata for matching so will take
+ * any input. No point in letting it try to match. */
+ continue;
+ }
+ if (!check_required_metadata(imod->metadata, avail_metadata))
+ /* Cannot satisfy this module's requirements. */
+ continue;
+
+ meta = g_hash_table_new(NULL, NULL);
+ for (m = 0; m < sizeof(imod->metadata); m++) {
+ mitem = imod->metadata[m] & ~SR_INPUT_META_REQUIRED;
+ if (!mitem)
+ /* Metadata list is 0-terminated. */
+ break;
+ if (mitem == SR_INPUT_META_FILENAME) {
+ g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
+ (gpointer)filename);
+ } else if (mitem == SR_INPUT_META_FILESIZE) {
+ g_hash_table_insert(meta, GINT_TO_POINTER(mitem),
+ GINT_TO_POINTER(st.st_size));
+ } else if (mitem == SR_INPUT_META_HEADER) {
+ if ((fd = open(filename, O_RDONLY)) < 0) {
+ sr_err("%s", strerror(errno));
+ return SR_ERR;
+ }
+ size = read(fd, header_buf->str, 128);
+ header_buf->len = size;
+ close(fd);
+ if (size <= 0) {
+ g_string_free(header_buf, TRUE);
+ sr_err("%s", strerror(errno));
+ return SR_ERR;
+ }
+ g_hash_table_insert(meta, GINT_TO_POINTER(mitem), header_buf);
+ }
+ }
+ if (g_hash_table_size(meta) == 0) {
+ /* No metadata for this module, so there's no way it
+ * can match. */
+ g_hash_table_destroy(meta);
+ continue;
+ }
+ sr_spew("Trying module %s.", imod->id);
+ ret = imod->format_match(meta);
+ g_hash_table_destroy(meta);
+ if (ret == SR_ERR_DATA) {
+ /* Module recognized this buffer, but cannot handle it. */
+ break;
+ } else if (ret == SR_ERR) {
+ /* Module didn't recognize this buffer. */
+ continue;
+ } else if (ret != SR_OK) {
+ /* Can be SR_ERR_NA. */
+ return ret;
+ }
+
+ /* Found a matching module. */
+ sr_spew("Module %s matched.", imod->id);
+ *in = sr_input_new(imod, NULL);
+ break;
+ }
+ g_string_free(header_buf, TRUE);
+
+ return ret;
+}
+
+/**
+ * Return the input instance's (virtual) device instance. This can be
+ * used to find out the number of channels and other information.
+ *
+ * If the device instance has not yet been fully populated by the input
+ * module, NULL is returned. This indicates the module needs more data
+ * to identify the number of channels and so on.
+ *
+ * @since 0.4.0
+ */
+SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
+{
+ if (in->sdi_ready)
+ return in->sdi;
+ else
+ return NULL;
+}
+
+/**
+ * Send data to the specified input instance.
+ *
+ * When an input module instance is created with sr_input_new(), this
+ * function is used to feed data to the instance.
+ *
+ * As enough data gets fed into this function to completely populate
+ * the device instance associated with this input instance, this is
+ * guaranteed to return the moment it's ready. This gives the caller
+ * the chance to examine the device instance, attach session callbacks
+ * and so on.
+ *
+ * @since 0.4.0
+ */
+SR_API int sr_input_send(const struct sr_input *in, GString *buf)
+{
+ sr_spew("Sending %d bytes to %s module.", buf->len, in->module->id);
+ return in->module->receive((struct sr_input *)in, buf);
+}
+
+/**
+ * Signal the input module no more data will come.
+ *
+ * This will cause the module to process any data it may have buffered.
+ * The SR_DF_END packet will also typically be sent at this time.
+ *
+ * @since 0.4.0
+ */
+SR_API int sr_input_end(const struct sr_input *in)
+{
+ sr_spew("Calling end() on %s module.", in->module->id);
+ return in->module->end((struct sr_input *)in);
+}
+
+/**
+ * Free the specified input instance and all associated resources.
+ *
+ * @since 0.4.0
+ */
+SR_API void sr_input_free(const struct sr_input *in)
+{
+ if (!in)
+ return;
+
+ if (in->module->cleanup)
+ in->module->cleanup((struct sr_input *)in);
+ if (in->sdi)
+ sr_dev_inst_free(in->sdi);
+ if (in->buf->len > 64) {
+ /* That seems more than just some sub-unitsize leftover... */
+ sr_warn("Found %d unprocessed bytes at free time.", in->buf->len);
+ }
+ g_string_free(in->buf, TRUE);
+ g_free(in->priv);
+ g_free((gpointer)in);
+}
+
+
/** @} */
projects / libsigrok.git / blobdiff