X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Finput%2Finput.c;h=18a4b639ed5160e122e046bed5b44a463fe3ed96;hb=e1b115bd4d5ed195b46daf604c35a33c7a760533;hp=36f63e1dfa507e918a09fb340020e3f45d709a16;hpb=fe4fe25bf5afdcab336e2fc10625c77720733ded;p=libsigrok.git

diff --git a/src/input/input.c b/src/input/input.c
index 36f63e1d..18a4b639 100644
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -17,16 +17,17 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <string.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <unistd.h>
-#include <fcntl.h>
 #include <errno.h>
-#include "libsigrok.h"
+#include <glib.h>
+#include <glib/gstdio.h>
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "input"
+/** @endcond */
 
 /**
  * @file
@@ -61,17 +62,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;
+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 +98,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 +113,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 +128,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 (!o) {
+	if (!imod) {
 		sr_err("Invalid input module NULL!");
 		return NULL;
 	}
 
-	return o->desc;
+	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;
 }
 
 /**
@@ -211,8 +238,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 +250,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 +270,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 +289,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 +300,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;
@@ -309,23 +341,30 @@ static gboolean check_required_metadata(const uint8_t *metadata, uint8_t *avail)
  * 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 and returned.
- * Otherwise, NULL is returned.
+ * 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 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;
 	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;
+	*in = NULL;
+	ret = SR_ERR;
 	for (i = 0; input_module_list[i]; i++) {
 		imod = input_module_list[i];
 		if (!imod->metadata[0]) {
@@ -348,64 +387,96 @@ 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);
+		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. */
-			g_hash_table_destroy(meta);
 			continue;
+		} else if (ret != SR_OK) {
+			/* Can be SR_ERR_NA. */
+			return ret;
 		}
-		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);
+		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 in;
+	return ret;
 }
 
 /**
  * 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.
  *
  */
-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;
+	int64_t filesize;
+	FILE *stream;
 	const struct sr_input_module *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;
+	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;
 	}
-
+	/* This actually allocates 256 bytes to allow for NUL termination. */
+	header = g_string_sized_new(255);
+	count = fread(header->str, 1, header->allocated_len - 1, stream);
+
+	if (count != header->allocated_len - 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;
+	ret = SR_ERR;
+
 	for (i = 0; input_module_list[i]; i++) {
 		imod = input_module_list[i];
 		if (!imod->metadata[0]) {
@@ -417,63 +488,44 @@ 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);
-			continue;
-		}
-		if (!imod->format_match(meta))
+		sr_dbg("Trying module %s.", imod->id);
+
+		ret = imod->format_match(meta);
+		if (ret == SR_ERR) {
 			/* Module didn't recognize this buffer. */
 			continue;
-
+		} else if (ret != SR_OK) {
+			/* Module recognized this buffer, but cannot handle it. */
+			break;
+		}
 		/* Found a matching module. */
-		in = sr_input_new(imod, NULL);
-		in->buf = g_string_new_len(buf->str, buf->len);
+		sr_dbg("Module %s matched.", imod->id);
+
+		*in = sr_input_new(imod, NULL);
 		break;
 	}
-	if (!in && buf)
-		g_string_free(buf, TRUE);
+	g_hash_table_destroy(meta);
+	g_string_free(header, TRUE);
 
-	return in;
+	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)
 {
-	return in->sdi;
+	if (in->sdi_ready)
+		return in->sdi;
+	else
+		return NULL;
 }
 
 /**
@@ -482,36 +534,77 @@ 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);
+	sr_spew("Sending %" G_GSIZE_FORMAT " bytes to %s module.",
+		buf->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);
+}
 
+/**
+ * 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)
+{
+	if (!in->module->reset) {
+		sr_spew("Tried to reset %s module but no reset handler found.",
+			in->module->id);
+		return SR_OK;
+	}
+
+	sr_spew("Resetting %s module.", in->module->id);
+	return in->module->reset((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 SR_ERR_ARG;
+		return;
 
-	ret = SR_OK;
 	if (in->module->cleanup)
-		ret = in->module->cleanup((struct sr_input *)in);
-	if (in->sdi)
-		sr_dev_inst_free(in->sdi);
-	if (in->buf)
-		g_string_free(in->buf, TRUE);
+		in->module->cleanup((struct sr_input *)in);
+	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);
-
-	return ret;
 }
 
-
 /** @} */