X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decode.c;h=50b87b4c269478d834770531f7092417ca2ae2a7;hp=5ff6415bdf6df8fcb7cae442c9c7b043a1a9b787;hb=c4262fd6b2f8ef540b8cc93ac61956d89062d2be;hpb=922763abc279fc5d4e0ed93ed6c6bebbf68d7baf

diff --git a/decode.c b/decode.c
index 5ff6415..50b87b4 100644
--- a/decode.c
+++ b/decode.c
@@ -49,69 +49,49 @@ static GSList *list_pds = NULL;
 
 static int srd_load_decoder(const char *name, struct srd_decoder **dec);
 
-static int _unitsize = 1;
-
-static PyObject*
-emb_getmeta(PyObject *self, PyObject *args)
+static PyObject *emb_put(PyObject *self, PyObject *args)
 {
-	if (!PyArg_ParseTuple(args, ":get"))
-		return NULL;
-
-	return Py_BuildValue("{sssisd}", 
-						 "driver", "demo",
-						 "unitsize", _unitsize,
-						 "starttime", 129318231823.0 //TODO: Fill with something reasonable.
-						 );
-}
-
-#if 0
-static PyObject*
-emb_get(PyObject *self, PyObject *args)
-{
-	PyObject *r;
-	if (!PyArg_ParseTuple(args, ":get"))
-		return NULL;
+	PyObject *arg;
 
-	fprintf(stderr, "get called, returns %d\n", _bufoffset);
-	if ((_bufoffset + _unitsize) <= _buflen) {
-		r = Py_BuildValue("{sisiss#}", 
-							 "time", _bufoffset / _unitsize,
-							 "duration", 10,
-							 "data", &_buf[_bufoffset], _unitsize
-							 );
-		_bufoffset += _unitsize;
-		return r;
-	}
-	Py_RETURN_NONE;
-}
-#endif
+	(void)self;
 
-static PyObject*
-emb_put(PyObject *self, PyObject *args)
-{
-	PyObject *arg;
-	
 	if (!PyArg_ParseTuple(args, "O:put", &arg))
 		return NULL;
 
-	fprintf(stderr, "put called, got passed %d\n", arg);
+	// fprintf(stdout, "sigrok.put() called by decoder:\n");
+	PyObject_Print(arg, stdout, Py_PRINT_RAW);
+	puts("");
+
 	Py_RETURN_NONE;
 }
 
 static PyMethodDef EmbMethods[] = {
-	{"get_meta", emb_getmeta, METH_VARARGS,
-		"Returns information about the stream."},
-	/*{"get", emb_get, METH_VARARGS,
-		"Returns a dictionary with the following keys: time, duration, data"},*/
 	{"put", emb_put, METH_VARARGS,
-		"Accepts a dictionary with the following keys: time, duration, data"},
+	 "Accepts a dictionary with the following keys: time, duration, data"},
 	{NULL, NULL, 0, NULL}
 };
 
 /**
  * Initialize libsigrokdecode.
  *
+ * This initializes the Python interpreter, and creates and initializes
+ * a "sigrok" Python module with a single put() method.
+ *
+ * Then, it searches for sigrok protocol decoder files (*.py) in the
+ * "decoders" subdirectory of the the sigrok installation directory.
+ * All decoders that are found are loaded into memory and added to an
+ * internal list of decoders, which can be queried via srd_list_decoders().
+ *
+ * The caller is responsible for calling the clean-up function srd_exit(),
+ * which will properly shut down libsigrokdecode and free its allocated memory.
+ *
+ * Multiple calls to srd_init(), without calling srd_exit() inbetween,
+ * are not allowed.
+ *
  * @return SRD_OK upon success, a (negative) error code otherwise.
+ *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
+ *         directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
+ *         If not enough memory could be allocated, return SRD_ERR_MALLOC.
  */
 int srd_init(void)
 {
@@ -124,32 +104,47 @@ int srd_init(void)
 	/* Py_Initialize() returns void and usually cannot fail. */
 	Py_Initialize();
 
-	Py_InitModule("sigrok", EmbMethods);
+	/* TODO: Use Py_InitModule3() to add a docstring? */
+	if (!Py_InitModule("sigrok", EmbMethods)) {
+		Py_Finalize(); /* Returns void. */
+		return SRD_ERR_PYTHON;
+	}
 
 	/* Add search directory for the protocol decoders. */
-	/* FIXME: Check error code. */
 	/* FIXME: What happens if this function is called multiple times? */
-	PyRun_SimpleString("import sys;"
-			   "sys.path.append(r'" DECODERS_DIR "');");
+	ret = PyRun_SimpleString("import sys;"
+				 "sys.path.append(r'" DECODERS_DIR "');");
+	if (ret != 0) {
+		Py_Finalize(); /* Returns void. */
+		return SRD_ERR_PYTHON;
+	}
 
-	if (!(dir = opendir(DECODERS_DIR)))
+	if (!(dir = opendir(DECODERS_DIR))) {
+		Py_Finalize(); /* Returns void. */
 		return SRD_ERR_DECODERS_DIR;
+	}
 
 	while ((dp = readdir(dir)) != NULL) {
+		/* Ignore filenames which don't end with ".py". */
 		if (!g_str_has_suffix(dp->d_name, ".py"))
 			continue;
 
 		/* Decoder name == filename (without .py suffix). */
 		decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
 
-		/* TODO: Error handling. */
-		dec = malloc(sizeof(struct srd_decoder));
+		/* TODO: Error handling. Use g_try_malloc(). */
+		if (!(dec = malloc(sizeof(struct srd_decoder)))) {
+			Py_Finalize(); /* Returns void. */
+			return SRD_ERR_MALLOC;
+		}
 
 		/* Load the decoder. */
+		/* TODO: Warning if loading fails for a decoder. */
 		ret = srd_load_decoder(decodername, &dec);
-
-		/* Append it to the list of supported/loaded decoders. */
-		list_pds = g_slist_append(list_pds, dec);
+		if (!ret) {
+			/* Append it to the list of supported/loaded decoders. */
+			list_pds = g_slist_append(list_pds, dec);
+		}
 	}
 	closedir(dir);
 
@@ -203,7 +198,7 @@ static int h_str(PyObject *py_res, PyObject *py_mod,
 	char *str;
 	int ret;
 
-	py_str = PyMapping_GetItemString(py_res, (char *)key);
+	py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */
 	if (!py_str || !PyString_Check(py_str)) {
 		ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
 		goto err_h_decref_mod;
@@ -246,35 +241,35 @@ err_h_decref_mod:
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-static int srd_load_decoder(const char *name,
-			      struct srd_decoder **dec)
+static int srd_load_decoder(const char *name, struct srd_decoder **dec)
 {
 	struct srd_decoder *d;
-	PyObject *py_mod, *py_func, *py_res /* , *py_tuple */;
+	PyObject *py_mod, *py_res;
 	int r;
 
+	fprintf(stdout, "%s: %s\n", __func__, name);
+
 	/* "Import" the Python module. */
 	if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
 		PyErr_Print(); /* Returns void. */
 		return SRD_ERR_PYTHON; /* TODO: More specific error? */
 	}
 
-	/* Get the 'register' dictionary as Python object. */
-	py_res = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */
-	if (!py_res || PyCallable_Check(py_res)) {
+	/* Get the 'Decoder' class as Python object. */
+	py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
+	if (!py_res) {
 		if (PyErr_Occurred())
 			PyErr_Print(); /* Returns void. */
 		Py_XDECREF(py_mod);
-		fprintf(stderr, "register dictionary was not found or is declared a function.\n");
+		fprintf(stderr, "Decoder class not found in PD module %s\n", name);
 		return SRD_ERR_PYTHON; /* TODO: More specific error? */
 	}
 
-
 	if (!(d = malloc(sizeof(struct srd_decoder))))
 		return SRD_ERR_MALLOC;
 
-	if ((r = h_str(py_res, py_mod, "id", &(d->id))) < 0)
-		return r;
+	/* We'll just use the name of the module for the ID. */
+	d->id = strdup(name);
 
 	if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
 		return r;
@@ -300,29 +295,91 @@ static int srd_load_decoder(const char *name,
 		return r;
 
 	d->py_mod = py_mod;
+	d->py_decobj = py_res;
 
-	Py_XDECREF(py_res);
+	/* TODO: Handle func, inputformats, outputformats. */
+	/* Note: They must at least be set to NULL, will segfault otherwise. */
+	d->func = NULL;
+	d->inputformats = NULL;
+	d->outputformats = NULL;
+
+	*dec = d;
+
+	return SRD_OK;
+}
+
+struct srd_decoder_instance *srd_instance_new(const char *id)
+{
+	struct srd_decoder *dec;
+	struct srd_decoder_instance *di;
+	PyObject *py_args;
+
+	if (!(dec = srd_get_decoder_by_id(id)))
+		return NULL;
 
+	/* TODO: Error handling. Use g_try_malloc(). */
+	di = g_malloc(sizeof(*di));
 
-	/* Get the 'decode' function name as Python callable object. */
-	py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
-	if (!py_func || !PyCallable_Check(py_func)) {
+	/* Create an empty Python tuple. */
+	if (!(py_args = PyTuple_New(0))) { /* NEWREF */
 		if (PyErr_Occurred())
 			PyErr_Print(); /* Returns void. */
-		Py_XDECREF(py_mod);
+
+		return NULL; /* TODO: More specific error? */
+	}
+
+	/* Create an instance of the 'Decoder' class. */
+	di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL);
+	if (!di->py_instance) {
+		if (PyErr_Occurred())
+			PyErr_Print(); /* Returns void. */
+		Py_XDECREF(py_args);
+		return NULL; /* TODO: More specific error? */
+	}
+
+	Py_XDECREF(py_args);
+
+	return di;
+}
+
+int srd_instance_set_probe(struct srd_decoder_instance *di,
+			   const char *probename, int num)
+{
+	PyObject *probedict, *probenum;
+
+	probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
+	if (!probedict) {
+		if (PyErr_Occurred())
+			PyErr_Print(); /* Returns void. */
+
 		return SRD_ERR_PYTHON; /* TODO: More specific error? */
 	}
 
-	d->py_decodefunc = py_func;
+	probenum = PyInt_FromLong(num);
+	PyMapping_SetItemString(probedict, (char *)probename, probenum);
 
-	/* TODO: Handle func, inputformats, outputformats. */
-	/* Note: They must at least be set to NULL, will segfault otherwise. */
-	d->func = NULL;
-	d->inputformats = NULL;
-	d->outputformats = NULL;
+	Py_XDECREF(probenum);
+	Py_XDECREF(probedict);
 
-	*dec = d;
+	return SRD_OK;
+}
 
+int srd_instance_start(struct srd_decoder_instance *di,
+			const char *driver, int unitsize, uint64_t starttime)
+{
+	PyObject *py_res;
+
+	if (!(py_res = PyObject_CallMethod(di->py_instance, "start",
+					 "{s:s,s:i,s:d}", 
+					 "driver", driver,
+					 "unitsize", unitsize,
+					 "starttime", starttime))) {
+		if (PyErr_Occurred())
+			PyErr_Print(); /* Returns void. */
+
+		return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	}
+	Py_XDECREF(py_res);
 	return SRD_OK;
 }
 
@@ -337,13 +394,15 @@ static int srd_load_decoder(const char *name,
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-int srd_run_decoder(struct srd_decoder *dec,
-			     uint8_t *inbuf, uint64_t inbuflen,
-			     uint8_t **outbuf, uint64_t *outbuflen)
+int srd_run_decoder(struct srd_decoder_instance *dec,
+		    uint8_t *inbuf, uint64_t inbuflen,
+		    uint8_t **outbuf, uint64_t *outbuflen)
 {
-	PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
-	uint64_t inbuf_pos = 0;
-	int r, ret;
+	PyObject *py_instance, *py_res;
+	/* FIXME: Don't have a timebase available here. Make one up. */
+	static int _timehack = 0;
+
+	_timehack += inbuflen;
 
 	/* TODO: Use #defines for the return codes. */
 
@@ -358,61 +417,24 @@ int srd_run_decoder(struct srd_decoder *dec,
 		return SRD_ERR_ARGS; /* TODO: More specific error? */
 	if (outbuflen == NULL)
 		return SRD_ERR_ARGS; /* TODO: More specific error? */
-	
-	/* TODO: Error handling. */
-	py_mod = dec->py_mod;
-	Py_XINCREF(py_mod);
-	py_func = dec->py_decodefunc;
-	Py_XINCREF(py_func);
 
-	/* Create a Python tuple of size 1. */
-	if (!(py_args = PyTuple_New(1))) { /* NEWREF */
-		ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
-		goto err_run_decref_func;
-	}
-
-	while (inbuf_pos < inbuflen) {
-		/* Get the input buffer as Python "string" (byte array). */
-		/* TODO: int vs. uint64_t for 'inbuflen'? */
-
-		py_value = Py_BuildValue("{sisiss#}", 
-						  "time", inbuf_pos / _unitsize,
-						  "duration", 10,
-						  "data", &inbuf[inbuf_pos], _unitsize
-						  );
-		
-		/*
-		 * IMPORTANT: PyTuple_SetItem() "steals" a reference to py_value!
-		 * That means we are no longer responsible for Py_XDECREF()'ing it.
-		 * It will automatically be free'd when the 'py_args' tuple is free'd.
-		 */
-		if (PyTuple_SetItem(py_args, 0, py_value) != 0) { /* STEAL */
-			ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
-			Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
-			goto err_run_decref_args;
-		}
-		
-		if (!(py_res = PyObject_CallObject(py_func, py_args))) { /* NEWREF */
-			ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
-			goto err_run_decref_args;
-		}
-		inbuf_pos++;
-	}
+	/* TODO: Error handling. */
+	py_instance = dec->py_instance;
+	Py_XINCREF(py_instance);
+
+	if (!(py_res = PyObject_CallMethod(py_instance, "decode",
+					   "{s:i,s:i,s:s#}", 
+					   "time", _timehack,
+					   "duration", 10,
+					   "data", inbuf, inbuflen))) { /* NEWREF */
+		if (PyErr_Occurred())
+			PyErr_Print(); /* Returns void. */
 
-	ret = SRD_OK;
+		return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	} 
 
 	Py_XDECREF(py_res);
-
-err_run_decref_args:
-	Py_XDECREF(py_args);
-err_run_decref_func:
-	Py_XDECREF(py_func);
-	Py_XDECREF(py_mod);
-
-	if (PyErr_Occurred())
-		PyErr_Print(); /* Returns void. */
-
-	return ret;
+	return SRD_OK;
 }
 
 /**
@@ -432,9 +454,11 @@ static int srd_unload_decoder(struct srd_decoder *dec)
 	if (dec->outputformats != NULL)
 		g_slist_free(dec->outputformats);
 
-	Py_XDECREF(dec->py_decodefunc);
+	Py_XDECREF(dec->py_decobj);
 	Py_XDECREF(dec->py_mod);
 
+	/* TODO: (g_)free dec itself? */
+
 	return SRD_OK;
 }
 
@@ -458,6 +482,13 @@ static int srd_unload_all_decoders(void)
 /**
  * Shutdown libsigrokdecode.
  *
+ * This frees all the memory allocated for protocol decoders and shuts down
+ * the Python interpreter.
+ *
+ * This function should only be called if there was a (successful!) invocation
+ * of srd_init() before. Calling this function multiple times in a row, without
+ * any successful srd_init() calls inbetween, is not allowed.
+ *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
 int srd_exit(void)