X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Finput%2Finput.c;h=b5de532bc58a1c25a4d3430d223a8b5b8ee7299b;hb=d8fbfcd9d6d66bffcb8607e9de7706ce322d42c7;hp=ee19d66169ece22b67254fdf4c330afbcccb62c7;hpb=0dabb880af49c5eb54e22668d3477435b370e763;p=libsigrok.git

diff --git a/src/input/input.c b/src/input/input.c
index ee19d661..b5de532b 100644
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -29,7 +29,9 @@
 #define LOG_PREFIX "input"
 /** @endcond */
 
+/** @cond PRIVATE */
 #define CHUNK_SIZE	(4 * 1024 * 1024)
+/** @endcond */
 
 /**
  * @file
@@ -64,23 +66,29 @@
 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_stf;
 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_saleae;
 extern SR_PRIV struct sr_input_module input_null;
-/* @endcond */
+/** @endcond */
 
 static const struct sr_input_module *input_module_list[] = {
 	&input_binary,
 	&input_chronovu_la8,
 	&input_csv,
+#if defined HAVE_INPUT_STF && HAVE_INPUT_STF
+	&input_stf,
+#endif
 	&input_trace32_ad,
 	&input_vcd,
 	&input_wav,
 	&input_raw_analog,
 	&input_logicport,
+	&input_saleae,
 	&input_null,
 	NULL,
 };
@@ -532,6 +540,22 @@ SR_API int sr_input_scan_file(const char *filename, const struct sr_input **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.
@@ -566,8 +590,10 @@ SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in)
  */
 SR_API int sr_input_send(const struct sr_input *in, GString *buf)
 {
-	sr_spew("Sending %" G_GSIZE_FORMAT " bytes to %s module.",
-		buf->len, in->module->id);
+	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);
 }
 
@@ -594,16 +620,49 @@ SR_API int sr_input_end(const struct sr_input *in)
  *
  * @since 0.5.0
  */
-SR_API int sr_input_reset(const struct sr_input *in)
+SR_API int sr_input_reset(const struct sr_input *in_ro)
 {
-	if (!in->module->reset) {
+	struct sr_input *in;
+	int rc;
+
+	in = (struct sr_input *)in_ro;	/* "un-const" */
+	if (!in || !in->module)
+		return SR_ERR_ARG;
+
+	/*
+	 * 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);
-		return SR_OK;
+		rc = SR_OK;
 	}
 
-	sr_spew("Resetting %s module.", in->module->id);
-	return in->module->reset((struct sr_input *)in);
+	/*
+	 * 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_truncate(in->buf, 0);
+	in->sdi_ready = FALSE;
+
+	return rc;
 }
 
 /**
@@ -616,8 +675,19 @@ 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... */