]> sigrok.org Git - libsigrokdecode.git/blobdiff - decode.c
srd: Doxygen comments for srd_init() and srd_exit().
[libsigrokdecode.git] / decode.c
index 9899985ca52d523586ce974fad151ea1a01b7c5c..6c63fa7c1f069ca44faa1ed4b80966cb752a0aba 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -61,8 +61,9 @@ emb_put(PyObject *self, PyObject *args)
        if (!PyArg_ParseTuple(args, "O:put", &arg))
                return NULL;
 
-       fprintf(stderr, "sigrok.put() called by decoder:\n");
+       fprintf(stdout, "sigrok.put() called by decoder:\n");
        PyObject_Print(arg, stdout, Py_PRINT_RAW);
+       puts("");
 
        Py_RETURN_NONE;
 }
@@ -76,7 +77,24 @@ static PyMethodDef EmbMethods[] = {
 /**
  * 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)
 {
@@ -218,7 +236,6 @@ static int srd_load_decoder(const char *name,
 {
        struct srd_decoder *d;
        PyObject *py_mod, *py_res;
-       PyObject *py_args, *py_value, *py_instance;
        int r;
        fprintf(stdout, "%s: %s\n", __func__, name);
 
@@ -270,15 +287,31 @@ static int srd_load_decoder(const char *name,
        d->py_mod = py_mod;
        d->py_decobj = 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 = 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. */
                
-               Py_XDECREF(py_res);
-               Py_XDECREF(py_mod);
-               
-               return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               return NULL; /* TODO: More specific error? */
        }
        
        py_value = Py_BuildValue("{sssisd}", 
@@ -286,27 +319,40 @@ static int srd_load_decoder(const char *name,
                                  "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 */
-       py_instance = PyObject_Call(py_res, py_args, py_value);
-       if (!py_instance) {
+       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? */
-               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? */
+               return NULL; /* TODO: More specific error? */
        } 
-       d->py_instance = py_instance;
 
-       /* 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(py_args);
+       Py_XDECREF(py_value);
 
-       *dec = d;
+       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;
 }
 
@@ -321,12 +367,12 @@ 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,
+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_instance, *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;
@@ -347,17 +393,9 @@ int srd_run_decoder(struct srd_decoder *dec,
                return SRD_ERR_ARGS; /* TODO: More specific error? */
        
        /* TODO: Error handling. */
-       py_mod = dec->py_mod;
-       Py_XINCREF(py_mod);
        py_instance = dec->py_instance;
        Py_XINCREF(py_instance);
 
-       /* 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;
-       }
-
        /* Get the input buffer as Python "string" (byte array). */
        /* TODO: int vs. uint64_t for 'inbuflen'? */
 
@@ -377,12 +415,8 @@ int srd_run_decoder(struct srd_decoder *dec,
        ret = SRD_OK;
 
        Py_XDECREF(py_res);
-
 err_run_decref_args:
-       Py_XDECREF(py_args);
-err_run_decref_func:
-       Py_XDECREF(py_instance);
-       Py_XDECREF(py_mod);
+       Py_XDECREF(py_value);
 
        if (PyErr_Occurred())
                PyErr_Print(); /* Returns void. */
@@ -407,7 +441,7 @@ static int srd_unload_decoder(struct srd_decoder *dec)
        if (dec->outputformats != NULL)
                g_slist_free(dec->outputformats);
 
-       Py_XDECREF(dec->py_instance);
+       Py_XDECREF(dec->py_decobj);
        Py_XDECREF(dec->py_mod);
 
        return SRD_OK;
@@ -433,6 +467,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)