]> sigrok.org Git - libsigrokdecode.git/blobdiff - decode.c
Add support for OO based PDs.
[libsigrokdecode.git] / decode.c
index 026a6133a7956a5344a416b84bbbfab8e9e34efa..b706124121dcff48ff2185b9c4057dea033dc08c 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -32,7 +32,7 @@
 #endif
 
 /* The list of protocol decoders. */
-GSList *list_pds = NULL;
+static GSList *list_pds = NULL;
 
 /*
  * Here's a quick overview of Python/C API reference counting.
@@ -49,6 +49,28 @@ GSList *list_pds = NULL;
 
 static int srd_load_decoder(const char *name, struct srd_decoder **dec);
 
+static int _unitsize = 1;
+
+static PyObject*
+emb_put(PyObject *self, PyObject *args)
+{
+       PyObject *arg;
+       
+       if (!PyArg_ParseTuple(args, "O:put", &arg))
+               return NULL;
+
+       fprintf(stderr, "sigrok.put() called by decoder:\n", arg);
+       PyObject_Print(arg, stdout, Py_PRINT_RAW);
+
+       Py_RETURN_NONE;
+}
+
+static PyMethodDef EmbMethods[] = {
+       {"put", emb_put, METH_VARARGS,
+               "Accepts a dictionary with the following keys: time, duration, data"},
+       {NULL, NULL, 0, NULL}
+};
+
 /**
  * Initialize libsigrokdecode.
  *
@@ -65,6 +87,8 @@ int srd_init(void)
        /* Py_Initialize() returns void and usually cannot fail. */
        Py_Initialize();
 
+       Py_InitModule("sigrok", EmbMethods);
+
        /* Add search directory for the protocol decoders. */
        /* FIXME: Check error code. */
        /* FIXME: What happens if this function is called multiple times? */
@@ -86,9 +110,11 @@ int srd_init(void)
 
                /* Load the 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);
 
@@ -135,7 +161,7 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
  */
-static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
+static int h_str(PyObject *py_res, PyObject *py_mod,
                 const char *key, char **outstr)
 {
        PyObject *py_str;
@@ -145,7 +171,7 @@ static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
        py_str = PyMapping_GetItemString(py_res, (char *)key);
        if (!py_str || !PyString_Check(py_str)) {
                ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
-               goto err_h_decref_func;
+               goto err_h_decref_mod;
        }
 
        /*
@@ -169,8 +195,7 @@ static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
 
 err_h_decref_str:
        Py_XDECREF(py_str);
-err_h_decref_func:
-       Py_XDECREF(py_func);
+err_h_decref_mod:
        Py_XDECREF(py_mod);
 
        if (PyErr_Occurred())
@@ -190,8 +215,9 @@ 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_func, *py_res, *py_instance = NULL, *py_args, *py_value/* , *py_tuple */;
        int r;
+       fprintf(stdout, "\n%s\n", name);
 
        /* "Import" the Python module. */
        if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
@@ -199,67 +225,128 @@ static int srd_load_decoder(const char *name,
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
 
-       /* Get the 'register' function name as Python callable object. */
-       py_func = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */
-       if (!py_func || !PyCallable_Check(py_func)) {
+       /* Get the 'register' dictionary as Python object. */
+       py_res = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */
+       if (!py_res || PyCallable_Check(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");
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
 
-       /* Call the 'register' function without arguments, get the result. */
-       if (!(py_res = PyObject_CallFunction(py_func, NULL))) { /* NEWREF */
-               PyErr_Print(); /* Returns void. */
-               Py_XDECREF(py_func);
-               Py_XDECREF(py_mod);
-               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_func, py_mod, "id", &(d->id))) < 0)
+       if ((r = h_str(py_res, py_mod, "id", &(d->id))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
+       if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "longname",
+       if ((r = h_str(py_res, py_mod, "longname",
                       &(d->longname))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
+       if ((r = h_str(py_res, py_mod, "desc", &(d->desc))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "longdesc",
+       if ((r = h_str(py_res, py_mod, "longdesc",
                       &(d->longdesc))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "author", &(d->author))) < 0)
+       if ((r = h_str(py_res, py_mod, "author", &(d->author))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "email", &(d->email))) < 0)
+       if ((r = h_str(py_res, py_mod, "email", &(d->email))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_func, py_mod, "license", &(d->license))) < 0)
+       if ((r = h_str(py_res, py_mod, "license", &(d->license))) < 0)
                return r;
 
        d->py_mod = py_mod;
 
        Py_XDECREF(py_res);
-       Py_XDECREF(py_func);
-
-       /* Get the 'decode' function name as Python callable object. */
-       py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
-       if (!py_func || !PyCallable_Check(py_func)) {
+       
+       
+       /* 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);
-               return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               //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_func = py_func;
+       d->py_decodefunc = py_func;
 
        /* TODO: Handle func, inputformats, outputformats. */
        /* Note: They must at least be set to NULL, will segfault otherwise. */
@@ -289,6 +376,10 @@ int srd_run_decoder(struct srd_decoder *dec,
 {
        PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
        int r, ret;
+       
+       /* FIXME: Don't have a timebase available here. Make one up. */
+       static int _timehack = 0;
+       _timehack += inbuflen;
 
        /* TODO: Use #defines for the return codes. */
 
@@ -303,11 +394,11 @@ 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_func;
+       py_func = dec->py_decodefunc;
        Py_XINCREF(py_func);
 
        /* Create a Python tuple of size 1. */
@@ -318,11 +409,13 @@ int srd_run_decoder(struct srd_decoder *dec,
 
        /* Get the input buffer as Python "string" (byte array). */
        /* TODO: int vs. uint64_t for 'inbuflen'? */
-       if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) { /* NEWREF */
-               ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
-               goto err_run_decref_args;
-       }
 
+       py_value = Py_BuildValue("{sisiss#}", 
+                                         "time", _timehack,
+                                         "duration", 10,
+                                         "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.
@@ -333,18 +426,12 @@ int srd_run_decoder(struct srd_decoder *dec,
                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;
        }
 
-       if ((r = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
-                                     (Py_ssize_t *)outbuflen))) {
-               ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
-               Py_XDECREF(py_res);
-               goto err_run_decref_args;
-       }
 
        ret = SRD_OK;
 
@@ -379,7 +466,7 @@ static int srd_unload_decoder(struct srd_decoder *dec)
        if (dec->outputformats != NULL)
                g_slist_free(dec->outputformats);
 
-       Py_XDECREF(dec->py_func);
+       Py_XDECREF(dec->py_decodefunc);
        Py_XDECREF(dec->py_mod);
 
        return SRD_OK;