X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Finput%2Finput.c;h=48dbb157dbbf224cd562b009da85a087326d9008;hb=5e78a56481769db6ffe9b9fd392d71be3fcf0319;hp=46bff0e39de22886dae44e789aac8cffaf77183e;hpb=bd0bfaafd863ef1eb0cd7d1711c28d66bca3359b;p=libsigrok.git
diff --git a/src/input/input.c b/src/input/input.c
index 46bff0e3..48dbb157 100644
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -17,16 +17,21 @@
* along with this program. If not, see .
*/
+#include
#include
-#include
-#include
-#include
-#include
#include
-#include "libsigrok.h"
+#include
+#include
+#include
#include "libsigrok-internal.h"
+/** @cond PRIVATE */
#define LOG_PREFIX "input"
+/** @endcond */
+
+/** @cond PRIVATE */
+#define CHUNK_SIZE (4 * 1024 * 1024)
+/** @endcond */
/**
* @file
@@ -61,17 +66,24 @@
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_trace32_ad;
extern SR_PRIV struct sr_input_module input_vcd;
extern SR_PRIV struct sr_input_module input_wav;
-/* @endcond */
+extern SR_PRIV struct sr_input_module input_raw_analog;
+extern SR_PRIV struct sr_input_module input_logicport;
+extern SR_PRIV struct sr_input_module input_null;
+/** @endcond */
static const struct sr_input_module *input_module_list[] = {
+ &input_binary,
+ &input_chronovu_la8,
+ &input_csv,
+ &input_trace32_ad,
&input_vcd,
-// &input_chronovu_la8,
&input_wav,
-// &input_csv,
- /* This one has to be last, because it will take any input. */
-// &input_binary,
+ &input_raw_analog,
+ &input_logicport,
+ &input_null,
NULL,
};
@@ -90,14 +102,14 @@ SR_API const struct sr_input_module **sr_input_list(void)
*
* @since 0.4.0
*/
-SR_API const char *sr_input_id_get(const struct sr_input_module *o)
+SR_API const char *sr_input_id_get(const struct sr_input_module *imod)
{
- if (!o) {
+ if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
- return o->id;
+ return imod->id;
}
/**
@@ -105,14 +117,14 @@ SR_API const char *sr_input_id_get(const struct sr_input_module *o)
*
* @since 0.4.0
*/
-SR_API const char *sr_input_name_get(const struct sr_input_module *o)
+SR_API const char *sr_input_name_get(const struct sr_input_module *imod)
{
- if (!o) {
+ if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
- return o->name;
+ return imod->name;
}
/**
@@ -120,14 +132,33 @@ SR_API const char *sr_input_name_get(const struct sr_input_module *o)
*
* @since 0.4.0
*/
-SR_API const char *sr_input_description_get(const struct sr_input_module *o)
+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 (!o) {
+ if (!imod) {
sr_err("Invalid input module NULL!");
return NULL;
}
- return o->desc;
+ return imod->exts;
}
/**
@@ -167,9 +198,9 @@ SR_API const struct sr_option **sr_input_options_get(const struct sr_input_modul
mod_opts = imod->options();
- for (size = 1; mod_opts[size].id; size++)
+ for (size = 0; mod_opts[size].id; size++)
;
- opts = g_malloc(size * sizeof(struct sr_option *));
+ opts = g_malloc((size + 1) * sizeof(struct sr_option *));
for (i = 0; i < size; i++)
opts[i] = &mod_opts[i];
@@ -186,20 +217,20 @@ SR_API const struct sr_option **sr_input_options_get(const struct sr_input_modul
*/
SR_API void sr_input_options_free(const struct sr_option **options)
{
- struct sr_option *opt;
+ int i;
if (!options)
return;
- for (opt = (struct sr_option *)options[0]; opt; opt++) {
- if (opt->def) {
- g_variant_unref(opt->def);
- opt->def = NULL;
+ for (i = 0; options[i]; i++) {
+ if (options[i]->def) {
+ g_variant_unref(options[i]->def);
+ ((struct sr_option *)options[i])->def = NULL;
}
- if (opt->values) {
- g_slist_free_full(opt->values, (GDestroyNotify)g_variant_unref);
- opt->values = 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);
@@ -211,8 +242,9 @@ SR_API void sr_input_options_free(const struct sr_option **options)
* 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
+ * 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.
*
@@ -222,7 +254,7 @@ 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 struct sr_option *mod_opts;
const GVariantType *gvt;
GHashTable *new_opts;
GHashTableIter iter;
@@ -242,7 +274,8 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
/* 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);
+ sr_err("Invalid type for '%s' option.",
+ (char *)key);
g_free(in);
return NULL;
}
@@ -260,7 +293,8 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
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);
+ sr_err("Input module '%s' has no option '%s'",
+ imod->id, (char *)key);
g_hash_table_destroy(new_opts);
g_free(in);
return NULL;
@@ -270,17 +304,19 @@ SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
}
if (in->module->init && in->module->init(in, new_opts) != SR_OK) {
- g_hash_table_destroy(new_opts);
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 is all required meta items are available. */
+/* Returns TRUE if all required meta items are available. */
static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
{
int m, a;
@@ -306,26 +342,39 @@ static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
* 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.
+ * the input modules to find a match. This is format-dependent. When
+ * magic strings get checked, 128 bytes normally could be enough. Note
+ * that some formats try to parse larger header sections, and benefit
+ * from seeing a larger scope.
*
- * If an input module is found, an instance is created and returned.
- * Otherwise, NULL is returned.
+ * If an input module is found, an instance is created into *in.
+ * Otherwise, *in contains NULL. When multiple input moduless claim
+ * support for the format, the one with highest confidence takes
+ * precedence. Applications will see at most one input module spec.
+ *
+ * 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 const struct sr_input *sr_input_scan_buffer(GString *buf)
+SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in)
{
- struct sr_input *in;
- const struct sr_input_module *imod;
+ const struct sr_input_module *imod, *best_imod;
GHashTable *meta;
unsigned int m, i;
+ unsigned int conf, best_conf;
+ 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;
+ *in = NULL;
+ best_imod = NULL;
+ best_conf = ~0;
for (i = 0; input_module_list[i]; i++) {
imod = input_module_list[i];
if (!imod->metadata[0]) {
@@ -348,64 +397,104 @@ SR_API const struct sr_input *sr_input_scan_buffer(GString *buf)
g_hash_table_destroy(meta);
continue;
}
- if (!imod->format_match(meta)) {
+ sr_spew("Trying module %s.", imod->id);
+ ret = imod->format_match(meta, &conf);
+ g_hash_table_destroy(meta);
+ if (ret == SR_ERR_DATA) {
+ /* Module recognized this buffer, but cannot handle it. */
+ continue;
+ } else if (ret == SR_ERR) {
/* Module didn't recognize this buffer. */
- g_hash_table_destroy(meta);
+ continue;
+ } else if (ret != SR_OK) {
+ /* Can be SR_ERR_NA. */
continue;
}
- g_hash_table_destroy(meta);
/* Found a matching module. */
- in = sr_input_new(imod, NULL);
- in->buf = g_string_new_len(buf->str, buf->len);
- break;
+ sr_spew("Module %s matched, confidence %u.", imod->id, conf);
+ if (conf >= best_conf)
+ continue;
+ best_imod = imod;
+ best_conf = conf;
}
- return in;
+ if (best_imod) {
+ *in = sr_input_new(best_imod, NULL);
+ g_string_insert_len((*in)->buf, 0, buf->str, buf->len);
+ return SR_OK;
+ }
+
+ return SR_ERR;
}
/**
* Try to find an input module that can parse the given file.
*
- * If an input module is found, an instance is created and returned.
- * Otherwise, NULL is returned.
+ * If an input module is found, an instance is created into *in.
+ * Otherwise, *in contains NULL. When multiple input moduless claim
+ * support for the format, the one with highest confidence takes
+ * precedence. Applications will see at most one input module spec.
*
*/
-SR_API const struct sr_input *sr_input_scan_file(const char *filename)
+SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in)
{
- struct sr_input *in;
- const struct sr_input_module *imod;
+ int64_t filesize;
+ FILE *stream;
+ const struct sr_input_module *imod, *best_imod;
GHashTable *meta;
- GString *buf;
- struct stat st;
- unsigned int midx, m, i;
- int fd;
- ssize_t size;
- uint8_t mitem, avail_metadata[8];
+ GString *header;
+ size_t count;
+ unsigned int midx, i;
+ unsigned int conf, best_conf;
+ int ret;
+ uint8_t avail_metadata[8];
+
+ *in = NULL;
if (!filename || !filename[0]) {
sr_err("Invalid filename.");
- return NULL;
+ return SR_ERR_ARG;
}
-
- if (!g_file_test(filename, G_FILE_TEST_EXISTS)) {
- sr_err("No such file.");
- return NULL;
+ stream = g_fopen(filename, "rb");
+ if (!stream) {
+ sr_err("Failed to open %s: %s", filename, g_strerror(errno));
+ return SR_ERR;
}
-
- if (stat(filename, &st) < 0) {
- sr_err("%s", strerror(errno));
- return NULL;
+ filesize = sr_file_get_size(stream);
+ if (filesize < 0) {
+ sr_err("Failed to get size of %s: %s",
+ filename, g_strerror(errno));
+ fclose(stream);
+ return SR_ERR;
}
-
+ header = g_string_sized_new(CHUNK_SIZE);
+ count = fread(header->str, 1, header->allocated_len - 1, stream);
+ if (count < 1 || ferror(stream)) {
+ sr_err("Failed to read %s: %s", filename, g_strerror(errno));
+ fclose(stream);
+ g_string_free(header, TRUE);
+ return SR_ERR;
+ }
+ fclose(stream);
+ g_string_set_size(header, count);
+
+ meta = g_hash_table_new(NULL, NULL);
+ g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILENAME),
+ (char *)filename);
+ g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_FILESIZE),
+ GSIZE_TO_POINTER(MIN(filesize, G_MAXSSIZE)));
+ g_hash_table_insert(meta, GINT_TO_POINTER(SR_INPUT_META_HEADER),
+ header);
midx = 0;
avail_metadata[midx++] = SR_INPUT_META_FILENAME;
avail_metadata[midx++] = SR_INPUT_META_FILESIZE;
avail_metadata[midx++] = SR_INPUT_META_HEADER;
+ avail_metadata[midx] = 0;
/* TODO: MIME type */
- in = NULL;
- buf = NULL;
+ best_imod = NULL;
+ best_conf = ~0;
for (i = 0; input_module_list[i]; i++) {
imod = input_module_list[i];
if (!imod->metadata[0]) {
@@ -417,63 +506,66 @@ SR_API const struct sr_input *sr_input_scan_file(const char *filename)
/* 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_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) {
- buf = g_string_sized_new(128);
- if ((fd = open(filename, O_RDONLY)) < 0) {
- sr_err("%s", strerror(errno));
- return NULL;
- }
- size = read(fd, buf->str, 128);
- buf->len = size;
- close(fd);
- if (size <= 0) {
- g_string_free(buf, TRUE);
- sr_err("%s", strerror(errno));
- return NULL;
- }
- g_hash_table_insert(meta, GINT_TO_POINTER(mitem), buf);
- g_string_free(buf, TRUE);
- }
- }
- 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);
+ sr_dbg("Trying module %s.", imod->id);
+
+ ret = imod->format_match(meta, &conf);
+ if (ret == SR_ERR) {
+ /* Module didn't recognize this buffer. */
+ continue;
+ } else if (ret != SR_OK) {
+ /* Module recognized this buffer, but cannot handle it. */
continue;
}
- if (!imod->format_match(meta))
- /* Module didn't recognize this buffer. */
+ /* Found a matching module. */
+ sr_dbg("Module %s matched, confidence %u.", imod->id, conf);
+ if (conf >= best_conf)
continue;
+ best_imod = imod;
+ best_conf = conf;
+ }
+ g_hash_table_destroy(meta);
+ g_string_free(header, TRUE);
- /* Found a matching module. */
- in = sr_input_new(imod, NULL);
- in->buf = g_string_new_len(buf->str, buf->len);
- break;
+ if (best_imod) {
+ *in = sr_input_new(best_imod, NULL);
+ return SR_OK;
}
- if (!in && buf)
- g_string_free(buf, TRUE);
- return in;
+ return SR_ERR;
+}
+
+/**
+ * Return the input instance's module "class". This can be used to find out
+ * which input module handles a specific input file. This is especially
+ * useful when an application did not create the input stream by specifying
+ * an input module, but instead some shortcut or convenience wrapper did.
+ *
+ * @since 0.6.0
+ */
+SR_API const struct sr_input_module *sr_input_module_get(const struct sr_input *in)
+{
+ if (!in)
+ return NULL;
+
+ return in->module;
}
/**
* 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)
{
- return in->sdi;
+ if (in->sdi_ready)
+ return in->sdi;
+ else
+ return NULL;
}
/**
@@ -482,36 +574,123 @@ SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
* 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)
{
- return in->module->receive(in, buf);
+ size_t len;
+
+ len = buf ? buf->len : 0;
+ sr_spew("Sending %zu bytes to %s module.", len, in->module->id);
+ return in->module->receive((struct sr_input *)in, buf);
}
/**
- * Free the specified input instance and all associated resources.
+ * 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_free(const struct sr_input *in)
+SR_API int sr_input_end(const struct sr_input *in)
{
- int ret;
+ sr_spew("Calling end() on %s module.", in->module->id);
+ return in->module->end((struct sr_input *)in);
+}
- if (!in)
+/**
+ * Reset the input module's input handling structures.
+ *
+ * Causes the input module to reset its internal state so that we can re-send
+ * the input data from the beginning without having to re-create the entire
+ * input module.
+ *
+ * @since 0.5.0
+ */
+SR_API int sr_input_reset(const struct sr_input *in_ro)
+{
+ struct sr_input *in;
+ int rc;
+
+ in = (struct sr_input *)in_ro; /* "un-const" */
+ if (!in || !in->module)
return SR_ERR_ARG;
- ret = SR_OK;
- if (in->module->cleanup)
- ret = in->module->cleanup((struct sr_input *)in);
- if (in->sdi)
- sr_dev_inst_free(in->sdi);
+ /*
+ * Run the optional input module's .reset() method. This shall
+ * take care of the context (kept in the 'inc' variable).
+ */
+ if (in->module->reset) {
+ sr_spew("Resetting %s module.", in->module->id);
+ rc = in->module->reset(in);
+ } else {
+ sr_spew("Tried to reset %s module but no reset handler found.",
+ in->module->id);
+ rc = SR_OK;
+ }
+
+ /*
+ * Handle input module status (kept in the 'in' variable) here
+ * in common logic. This agrees with how input module's receive()
+ * and end() routines "amend but never seed" the 'in' information.
+ *
+ * Void potentially accumulated receive() buffer content, and
+ * clear the sdi_ready flag. This makes sure that subsequent
+ * processing will scan the header again before sample data gets
+ * interpreted, and stale content from previous calls won't affect
+ * the result.
+ *
+ * This common logic does not harm when the input module implements
+ * .reset() and contains identical assignments. In the absence of
+ * an individual .reset() method, simple input modules can completely
+ * rely on common code and keep working across resets.
+ */
if (in->buf)
- g_string_free(in->buf, TRUE);
- g_free((gpointer)in);
+ g_string_truncate(in->buf, 0);
+ in->sdi_ready = FALSE;
- return ret;
+ return rc;
}
+/**
+ * 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;
+
+ /*
+ * Run the input module's optional .cleanup() routine. This
+ * takes care of the context (kept in the 'inc' variable).
+ */
+ if (in->module->cleanup)
+ in->module->cleanup((struct sr_input *)in);
+
+ /*
+ * Common code releases the input module's state (kept in the
+ * 'in' variable). Release the device instance, the receive()
+ * buffer, the shallow 'in->priv' block which is 'inc' (after
+ * .cleanup() released potentially nested resources under 'inc').
+ */
+ sr_dev_inst_free(in->sdi);
+ if (in->buf->len > 64) {
+ /* That seems more than just some sub-unitsize leftover... */
+ sr_warn("Found %" G_GSIZE_FORMAT
+ " unprocessed bytes at free time.", in->buf->len);
+ }
+ g_string_free(in->buf, TRUE);
+ g_free(in->priv);
+ g_free((gpointer)in);
+}
/** @} */