2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
21 #include "sigrokdecode-internal.h"
24 /* lives in type_logic.c */
25 extern PyTypeObject srd_logic_type;
28 static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj,
29 int *annotation_format, char ***annotation)
32 struct srd_pd_output *pdo;
35 /* Should be a list of [annotation format, [string, ...]] */
36 if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
37 srd_err("Protocol decoder %s submitted %s instead of list",
38 di->decoder->name, obj->ob_type->tp_name);
39 return SRD_ERR_PYTHON;
42 /* Should have 2 elements... */
43 if (PyList_Size(obj) != 2) {
44 srd_err("Protocol decoder %s submitted annotation list with %d elements instead of 2",
45 di->decoder->name, PyList_Size(obj));
46 return SRD_ERR_PYTHON;
49 /* First element should be an integer matching a previously
50 * registered annotation format. */
51 py_tmp = PyList_GetItem(obj, 0);
52 if (!PyLong_Check(py_tmp)) {
53 srd_err("Protocol decoder %s submitted annotation list, but first element was not an integer",
55 return SRD_ERR_PYTHON;
58 ann_id = PyLong_AsLong(py_tmp);
59 if (!(pdo = g_slist_nth_data(di->decoder->annotation, ann_id))) {
60 srd_err("Protocol decoder %s submitted data to non-existent annotation format %d",
61 di->decoder->name, ann_id);
62 return SRD_ERR_PYTHON;
64 *annotation_format = ann_id;
66 /* Second element must be a list */
67 py_tmp = PyList_GetItem(obj, 1);
68 if (!PyList_Check(py_tmp)) {
69 srd_err("Protocol decoder %s submitted annotation list, but second element was not a list",
71 return SRD_ERR_PYTHON;
73 if (py_strlist_to_char(py_tmp, annotation) != SRD_OK) {
74 srd_err("Protocol decoder %s submitted annotation list, but second element was malformed",
76 return SRD_ERR_PYTHON;
82 /* TODO: not used, doesn't work actually */
83 static PyObject *Decoder_init(PyObject *self, PyObject *args)
87 printf("init Decoder object %p\n", self);
92 static PyObject *Decoder_put(PyObject *self, PyObject *args)
96 struct srd_decoder_instance *di;
97 struct srd_pd_output *pdo;
98 uint64_t timeoffset, duration;
99 int output_id, annotation_format, i;
100 char **annotation, **ann_info;
102 if (!(di = get_di_by_decobject(self)))
105 if (!PyArg_ParseTuple(args, "KKiO", &timeoffset, &duration, &output_id, &data))
108 if (!(l = g_slist_nth(di->pd_output, output_id))) {
109 srd_err("Protocol decoder %s submitted invalid output ID %d",
110 di->decoder->name, output_id);
115 switch (pdo->output_type) {
116 case SRD_OUTPUT_ANNOTATION:
117 if (convert_pyobj(di, data, &annotation_format, &annotation) != SRD_OK)
120 /* TODO: SRD_OUTPUT_ANNOTATION should go back up to the caller */
121 ann_info = g_slist_nth_data(pdo->decoder->annotation, annotation_format);
122 printf("annotation format %d (%s): ", annotation_format, ann_info[0]);
123 for (i = 0; annotation[i]; i++)
124 printf("\"%s\" ", annotation[i]);
128 case SRD_OUTPUT_PROTOCOL:
130 /* TODO: SRD_OUTPUT_PROTOCOL should go up the PD stack. */
131 printf("%s protocol data: ", pdo->protocol_id);
132 PyObject_Print(data, stdout, Py_PRINT_RAW);
137 srd_err("Protocol decoder %s submitted invalid output type %d",
138 di->decoder->name, pdo->output_type);
146 static PyObject *Decoder_output_new(PyObject *self, PyObject *args)
149 struct srd_decoder_instance *di;
151 int output_type, pdo_id;
153 if (!(di = get_di_by_decobject(self)))
156 printf("output_new di %s\n", di->decoder->name);
158 if (!PyArg_ParseTuple(args, "is", &output_type, &protocol_id))
161 pdo_id = pd_output_new(di, output_type, protocol_id);
165 ret = Py_BuildValue("i", pdo_id);
170 static PyMethodDef no_methods[] = { {NULL, NULL, 0, NULL} };
171 static PyMethodDef Decoder_methods[] = {
172 {"put", Decoder_put, METH_VARARGS,
173 "Accepts a dictionary with the following keys: time, duration, data"},
174 {"output_new", Decoder_output_new, METH_VARARGS,
175 "Create a new output stream"},
176 {NULL, NULL, 0, NULL}
182 } sigrok_Decoder_object;
184 static PyTypeObject srd_Decoder_type = {
185 PyVarObject_HEAD_INIT(NULL, 0)
186 .tp_name = "sigrokdecode.Decoder",
187 .tp_basicsize = sizeof(sigrok_Decoder_object),
188 .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
189 .tp_doc = "Sigrok Decoder object",
190 .tp_methods = Decoder_methods,
191 .tp_init = (initproc) Decoder_init,
194 static struct PyModuleDef sigrokdecode_module = {
195 PyModuleDef_HEAD_INIT,
196 .m_name = "sigrokdecode",
197 .m_doc = "sigrokdecode base class",
199 .m_methods = no_methods,
202 PyMODINIT_FUNC PyInit_sigrokdecode(void)
206 /* tp_new needs to be assigned here for compiler portability */
207 srd_Decoder_type.tp_new = PyType_GenericNew;
208 if (PyType_Ready(&srd_Decoder_type) < 0)
211 srd_logic_type.tp_new = PyType_GenericNew;
212 if (PyType_Ready(&srd_logic_type) < 0)
215 mod = PyModule_Create(&sigrokdecode_module);
216 Py_INCREF(&srd_Decoder_type);
217 if (PyModule_AddObject(mod, "Decoder", (PyObject *)&srd_Decoder_type) == -1)
219 Py_INCREF(&srd_logic_type);
220 if (PyModule_AddObject(mod, "srd_logic", (PyObject *)&srd_logic_type) == -1)
223 /* expose output types as symbols in the sigrokdecode module */
224 if(PyModule_AddObject(mod, "SRD_OUTPUT_ANNOTATION",
225 PyLong_FromLong(SRD_OUTPUT_ANNOTATION)) == -1)
227 if(PyModule_AddObject(mod, "SRD_OUTPUT_PROTOCOL",
228 PyLong_FromLong(SRD_OUTPUT_PROTOCOL)) == -1)
230 if(PyModule_AddObject(mod, "SRD_OUTPUT_BINARY",
231 PyLong_FromLong(SRD_OUTPUT_BINARY)) == -1)