{
PyObject *arg;
+ (void)self;
+
if (!PyArg_ParseTuple(args, "O:put", &arg))
return NULL;
- fprintf(stderr, "sigrok.put() called by decoder:\n", arg);
+ fprintf(stdout, "sigrok.put() called by decoder:\n");
PyObject_Print(arg, stdout, Py_PRINT_RAW);
+ puts("");
Py_RETURN_NONE;
}
/**
* 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)
{
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;
struct srd_decoder **dec)
{
struct srd_decoder *d;
- PyObject *py_mod, *py_func, *py_res, *py_instance = NULL, *py_args, *py_value/* , *py_tuple */;
+ PyObject *py_mod, *py_res;
int r;
- fprintf(stdout, "\n%s\n", name);
+ fprintf(stdout, "%s: %s\n", __func__, name);
/* "Import" the Python module. */
if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
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;
return r;
d->py_mod = py_mod;
-
- Py_XDECREF(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, "Decoder class not found in PD module %s\n", name);
- //return SRD_ERR_PYTHON; /* TODO: More specific error? */
-
-
- /* Get the 'decode' function name as Python callable object. */
- py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
- if (!py_func || !PyCallable_Check(py_func)) {
- if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
- Py_XDECREF(py_mod);
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
- }
- } else {
- PyObject_Print(py_res, stdout, Py_PRINT_RAW);
- fprintf(stdout, "\n");
-
- /* Create a Python tuple of size 1. */
- if (!(py_args = PyTuple_New(1))) { /* NEWREF */
- if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
-
- Py_XDECREF(py_res);
- Py_XDECREF(py_mod);
-
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
- }
-
- py_value = Py_BuildValue("{sssisd}",
- "driver", "demo",
- "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA
- "starttime", 129318231823.0 //TODO: Fill with something reasonable.
- );
- /*
- * 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 */
- Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
- Py_XDECREF(py_res);
- Py_XDECREF(py_mod);
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
- }
-
- /* Create an instance of the Decoder class */
- py_instance = PyObject_CallObject(py_res, py_args);
- if (!py_instance) {
- if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
- Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
- Py_XDECREF(py_res);
- Py_XDECREF(py_mod);
- fprintf(stderr, "Unable to create instance of Decoder class in PD module %s\n", name);
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
- } else {
- /* OK, we have successfully created an instance of the Decoder object */
-
- /* Get the 'decode' function name as Python callable object. */
- py_func = PyObject_GetAttrString(py_instance, "decode"); /* NEWREF */
- if (!py_func || !PyCallable_Check(py_func)) {
- if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
- fprintf(stderr, "Unable to find decode function in instance of Decoder class in PD module %s\n", name);
- Py_XDECREF(py_instance);
- Py_XDECREF(py_mod);
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
- }
- }
- }
-
- d->py_decodefunc = py_func;
+ d->py_decobj = py_res;
/* TODO: Handle func, inputformats, outputformats. */
/* Note: They must at least be set to NULL, will segfault otherwise. */
return SRD_OK;
}
+struct srd_decoder_instance *srd_instance_new(const char *id)
+{
+ struct srd_decoder *dec = srd_get_decoder_by_id(id);
+ if (!dec)
+ return NULL;
+ struct srd_decoder_instance *di = g_malloc(sizeof(*di));
+ PyObject *py_args, *py_value;
+
+ /* Create a Python tuple of size 1. */
+ if (!(py_args = PyTuple_New(0))) { /* NEWREF */
+ if (PyErr_Occurred())
+ PyErr_Print(); /* Returns void. */
+
+ return NULL; /* TODO: More specific error? */
+ }
+
+ py_value = Py_BuildValue("{sssisd}",
+ "driver", "demo",
+ "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA
+ "starttime", 129318231823.0 //TODO: Fill with something reasonable.
+ );
+
+ /* Create an instance of the Decoder class */
+ di->py_instance = PyObject_Call(dec->py_decobj, py_args, py_value);
+ if (!di->py_instance) {
+ if (PyErr_Occurred())
+ PyErr_Print(); /* Returns void. */
+ Py_XDECREF(py_args);
+ Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
+ return NULL; /* TODO: More specific error? */
+ }
+
+ Py_XDECREF(py_args);
+ Py_XDECREF(py_value);
+
+ 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? */
+ }
+
+ probenum = PyInt_FromLong(num);
+ PyMapping_SetItemString(probedict, (char*)probename, probenum);
+
+ Py_XDECREF(probenum);
+ Py_XDECREF(probedict);
+ return SRD_OK;
+}
+
/**
* Run the specified decoder function.
*
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_run_decoder(struct srd_decoder *dec,
+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;
- int r, ret;
+ PyObject *py_instance, *py_value, *py_res;
+ int ret;
/* FIXME: Don't have a timebase available here. Make one up. */
static int _timehack = 0;
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;
- }
+ py_instance = dec->py_instance;
+ Py_XINCREF(py_instance);
/* Get the input buffer as Python "string" (byte array). */
/* TODO: int vs. uint64_t for 'inbuflen'? */
"data", inbuf, inbuflen / _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 */
+ if (!(py_res = PyObject_CallMethod(py_instance, "decode",
+ "O", py_value))) { /* NEWREF */
ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
goto err_run_decref_args;
}
ret = SRD_OK;
Py_XDECREF(py_res);
-
err_run_decref_args:
- Py_XDECREF(py_args);
-err_run_decref_func:
- Py_XDECREF(py_func);
- Py_XDECREF(py_mod);
+ Py_XDECREF(py_value);
if (PyErr_Occurred())
PyErr_Print(); /* Returns void. */
if (dec->outputformats != NULL)
g_slist_free(dec->outputformats);
- Py_XDECREF(dec->py_decodefunc);
+ Py_XDECREF(dec->py_decobj);
Py_XDECREF(dec->py_mod);
return SRD_OK;
/**
* 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)
projects / libsigrokdecode.git / blobdiff