Add a CFP decoder.
[libsigrokdecode.git] / module_sigrokdecode.c
index b3bdafd792ce1c9ec0df73e5442ff1bf7ae9d8d3..39b5b4392e479a5dfde3fa2985002b50f0e2384c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrokdecode project.
  *
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
-#include "config.h"
+#include <config.h>
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h"
 
-/* lives in type_logic.c */
-extern PyTypeObject srd_logic_type;
+/** @cond PRIVATE */
 
+/*
+ * When initialized, a reference to this module inside the Python interpreter
+ * lives here.
+ */
+SRD_PRIV PyObject *mod_sigrokdecode = NULL;
 
-static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
-               int *annotation_format, char ***annotation)
-{
-       PyObject *py_tmp;
-       struct srd_pd_output *pdo;
-       int ann_id;
-
-       /* Should be a list of [annotation format, [string, ...]] */
-       if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
-               srd_err("Protocol decoder %s submitted %s instead of list",
-                               di->decoder->name, obj->ob_type->tp_name);
-               return SRD_ERR_PYTHON;
-       }
-
-       /* Should have 2 elements... */
-       if (PyList_Size(obj) != 2) {
-               srd_err("Protocol decoder %s submitted annotation list with %d elements instead of 2",
-                               di->decoder->name, PyList_Size(obj));
-               return SRD_ERR_PYTHON;
-       }
-
-       /* First element should be an integer matching a previously
-        * registered annotation format. */
-       py_tmp = PyList_GetItem(obj, 0);
-       if (!PyLong_Check(py_tmp)) {
-               srd_err("Protocol decoder %s submitted annotation list, but first element was not an integer",
-                               di->decoder->name);
-               return SRD_ERR_PYTHON;
-       }
-
-       ann_id = PyLong_AsLong(py_tmp);
-       if (!(pdo = g_slist_nth_data(di->decoder->annotation, ann_id))) {
-               srd_err("Protocol decoder %s submitted data to non-existent annotation format %d",
-                               di->decoder->name, ann_id);
-               return SRD_ERR_PYTHON;
-       }
-       *annotation_format = ann_id;
-
-       /* Second element must be a list */
-       py_tmp = PyList_GetItem(obj, 1);
-       if (!PyList_Check(py_tmp)) {
-               srd_err("Protocol decoder %s submitted annotation list, but second element was not a list",
-                               di->decoder->name);
-               return SRD_ERR_PYTHON;
-       }
-       if (py_strlist_to_char(py_tmp, annotation) != SRD_OK) {
-               srd_err("Protocol decoder %s submitted annotation list, but second element was malformed",
-                               di->decoder->name);
-               return SRD_ERR_PYTHON;
-       }
-
-       return SRD_OK;
-}
-
-/* TODO: not used, doesn't work actually */
-static PyObject *Decoder_init(PyObject *self, PyObject *args)
-{
-       (void)self;
-       (void)args;
-       printf("init Decoder object %p\n", self);
-
-       Py_RETURN_NONE;
-}
-
-static PyObject *Decoder_put(PyObject *self, PyObject *args)
-{
-       GSList *l;
-       PyObject *data;
-       struct srd_decoder_instance *di;
-       struct srd_pd_output *pdo;
-       uint64_t timeoffset, duration;
-       int output_id, annotation_format, i;
-       char **annotation, **ann_info;
-
-       if (!(di = get_di_by_decobject(self)))
-               return NULL;
-
-       if (!PyArg_ParseTuple(args, "KKiO", &timeoffset, &duration, &output_id, &data))
-               return NULL;
-
-       if (!(l = g_slist_nth(di->pd_output, output_id))) {
-               srd_err("Protocol decoder %s submitted invalid output ID %d",
-                               di->decoder->name, output_id);
-               return NULL;
-       }
-       pdo = l->data;
-
-       switch (pdo->output_type) {
-       case SRD_OUTPUT_ANNOTATION:
-               if (convert_pyobj(di, data, &annotation_format, &annotation) != SRD_OK)
-                       return NULL;
-
-               /* TODO: SRD_OUTPUT_ANNOTATION should go back up to the caller */
-               ann_info = g_slist_nth_data(pdo->decoder->annotation, annotation_format);
-               printf("annotation format %d (%s): ", annotation_format, ann_info[0]);
-               for (i = 0; annotation[i]; i++)
-                       printf("\"%s\" ", annotation[i]);
-               printf("\n");
-               break;
-
-       case SRD_OUTPUT_PROTOCOL:
-
-               /* TODO: SRD_OUTPUT_PROTOCOL should go up the PD stack. */
-               printf("%s protocol data: ", pdo->protocol_id);
-               PyObject_Print(data, stdout, Py_PRINT_RAW);
-               puts("");
-               break;
-
-       default:
-               srd_err("Protocol decoder %s submitted invalid output type %d",
-                               di->decoder->name, pdo->output_type);
-               break;
-       }
-
-       Py_RETURN_NONE;
-}
-
-
-static PyObject *Decoder_output_new(PyObject *self, PyObject *args)
-{
-       PyObject *ret;
-       struct srd_decoder_instance *di;
-       char *protocol_id;
-       int output_type, pdo_id;
-
-       if (!(di = get_di_by_decobject(self)))
-               return NULL;
-
-       printf("output_new di %s\n", di->decoder->name);
-
-       if (!PyArg_ParseTuple(args, "is", &output_type, &protocol_id))
-               return NULL;
-
-       pdo_id = pd_output_new(di, output_type, protocol_id);
-       if (pdo_id < 0)
-               Py_RETURN_NONE;
-       else
-               ret = Py_BuildValue("i", pdo_id);
-
-       return ret;
-}
-
-static PyMethodDef no_methods[] = { {NULL, NULL, 0, NULL} };
-static PyMethodDef Decoder_methods[] = {
-       {"put", Decoder_put, METH_VARARGS,
-        "Accepts a dictionary with the following keys: time, duration, data"},
-       {"output_new", Decoder_output_new, METH_VARARGS,
-        "Create a new output stream"},
-       {NULL, NULL, 0, NULL}
-};
-
-
-typedef struct {
-       PyObject_HEAD
-} sigrok_Decoder_object;
-
-static PyTypeObject srd_Decoder_type = {
-       PyVarObject_HEAD_INIT(NULL, 0)
-       .tp_name = "sigrokdecode.Decoder",
-       .tp_basicsize = sizeof(sigrok_Decoder_object),
-       .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
-       .tp_doc = "Sigrok Decoder object",
-       .tp_methods = Decoder_methods,
-       .tp_init = (initproc) Decoder_init,
-};
+/** @endcond */
 
 static struct PyModuleDef sigrokdecode_module = {
        PyModuleDef_HEAD_INIT,
        .m_name = "sigrokdecode",
-       .m_doc = "sigrokdecode base class",
+       .m_doc = "sigrokdecode module",
        .m_size = -1,
-       .m_methods = no_methods,
 };
 
+/** @cond PRIVATE */
 PyMODINIT_FUNC PyInit_sigrokdecode(void)
 {
-       PyObject *mod;
+       PyObject *mod, *Decoder_type;
+       PyGILState_STATE gstate;
 
-       /* tp_new needs to be assigned here for compiler portability */
-       srd_Decoder_type.tp_new = PyType_GenericNew;
-       if (PyType_Ready(&srd_Decoder_type) < 0)
-               return NULL;
-
-       srd_logic_type.tp_new = PyType_GenericNew;
-       if (PyType_Ready(&srd_logic_type) < 0)
-               return NULL;
+       gstate = PyGILState_Ensure();
 
        mod = PyModule_Create(&sigrokdecode_module);
-       Py_INCREF(&srd_Decoder_type);
-       if (PyModule_AddObject(mod, "Decoder", (PyObject *)&srd_Decoder_type) == -1)
-               return NULL;
-       Py_INCREF(&srd_logic_type);
-       if (PyModule_AddObject(mod, "srd_logic", (PyObject *)&srd_logic_type) == -1)
-               return NULL;
+       if (!mod)
+               goto err_out;
+
+       Decoder_type = srd_Decoder_type_new();
+       if (!Decoder_type)
+               goto err_out;
+       if (PyModule_AddObject(mod, "Decoder", Decoder_type) < 0)
+               goto err_out;
+
+       /* Expose output types as symbols in the sigrokdecode module */
+       if (PyModule_AddIntConstant(mod, "OUTPUT_ANN", SRD_OUTPUT_ANN) < 0)
+               goto err_out;
+       if (PyModule_AddIntConstant(mod, "OUTPUT_PYTHON", SRD_OUTPUT_PYTHON) < 0)
+               goto err_out;
+       if (PyModule_AddIntConstant(mod, "OUTPUT_BINARY", SRD_OUTPUT_BINARY) < 0)
+               goto err_out;
+       if (PyModule_AddIntConstant(mod, "OUTPUT_META", SRD_OUTPUT_META) < 0)
+               goto err_out;
+       /* Expose meta input symbols. */
+       if (PyModule_AddIntConstant(mod, "SRD_CONF_SAMPLERATE", SRD_CONF_SAMPLERATE) < 0)
+               goto err_out;
+
+       mod_sigrokdecode = mod;
+
+       PyGILState_Release(gstate);
 
        return mod;
+
+err_out:
+       Py_XDECREF(mod);
+       srd_exception_catch("Failed to initialize module");
+       PyGILState_Release(gstate);
+
+       return NULL;
 }
 
+/** @endcond */