]>
Commit | Line | Data |
---|---|---|
bc5f5a43 BV |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
20 | #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
15969949 | 21 | #include "sigrokdecode-internal.h" |
bc5f5a43 BV |
22 | #include "config.h" |
23 | ||
451680f1 BV |
24 | |
25 | /* When initialized, a reference to this module inside the python interpreter | |
26 | * lives here. | |
27 | */ | |
28 | PyObject *mod_sigrokdecode = NULL; | |
29 | ||
bc5f5a43 BV |
30 | /* lives in type_logic.c */ |
31 | extern PyTypeObject srd_logic_type; | |
32 | ||
33 | ||
15969949 | 34 | static int convert_pyobj(struct srd_decoder_instance *di, PyObject *obj, |
94d43b37 | 35 | int *ann_format, char ***ann) |
15969949 BV |
36 | { |
37 | PyObject *py_tmp; | |
38 | struct srd_pd_output *pdo; | |
39 | int ann_id; | |
40 | ||
41 | /* Should be a list of [annotation format, [string, ...]] */ | |
42 | if (!PyList_Check(obj) && !PyTuple_Check(obj)) { | |
43 | srd_err("Protocol decoder %s submitted %s instead of list", | |
44 | di->decoder->name, obj->ob_type->tp_name); | |
45 | return SRD_ERR_PYTHON; | |
46 | } | |
47 | ||
48 | /* Should have 2 elements... */ | |
49 | if (PyList_Size(obj) != 2) { | |
50 | srd_err("Protocol decoder %s submitted annotation list with %d elements instead of 2", | |
51 | di->decoder->name, PyList_Size(obj)); | |
52 | return SRD_ERR_PYTHON; | |
53 | } | |
54 | ||
55 | /* First element should be an integer matching a previously | |
56 | * registered annotation format. */ | |
57 | py_tmp = PyList_GetItem(obj, 0); | |
58 | if (!PyLong_Check(py_tmp)) { | |
59 | srd_err("Protocol decoder %s submitted annotation list, but first element was not an integer", | |
60 | di->decoder->name); | |
61 | return SRD_ERR_PYTHON; | |
62 | } | |
63 | ||
64 | ann_id = PyLong_AsLong(py_tmp); | |
e97b6ef5 | 65 | if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_id))) { |
15969949 BV |
66 | srd_err("Protocol decoder %s submitted data to non-existent annotation format %d", |
67 | di->decoder->name, ann_id); | |
68 | return SRD_ERR_PYTHON; | |
69 | } | |
94d43b37 | 70 | *ann_format = ann_id; |
15969949 BV |
71 | |
72 | /* Second element must be a list */ | |
73 | py_tmp = PyList_GetItem(obj, 1); | |
74 | if (!PyList_Check(py_tmp)) { | |
75 | srd_err("Protocol decoder %s submitted annotation list, but second element was not a list", | |
76 | di->decoder->name); | |
77 | return SRD_ERR_PYTHON; | |
78 | } | |
94d43b37 | 79 | if (py_strlist_to_char(py_tmp, ann) != SRD_OK) { |
15969949 BV |
80 | srd_err("Protocol decoder %s submitted annotation list, but second element was malformed", |
81 | di->decoder->name); | |
82 | return SRD_ERR_PYTHON; | |
83 | } | |
84 | ||
85 | return SRD_OK; | |
86 | } | |
87 | ||
bc5f5a43 BV |
88 | static PyObject *Decoder_put(PyObject *self, PyObject *args) |
89 | { | |
90 | GSList *l; | |
7ce7775c BV |
91 | PyObject *data, *py_res; |
92 | struct srd_decoder_instance *di, *next_di; | |
bc5f5a43 | 93 | struct srd_pd_output *pdo; |
94d43b37 | 94 | struct srd_proto_data *pdata; |
983cb0f5 BV |
95 | uint64_t start_sample, end_sample; |
96 | int output_id; | |
97 | void (*cb)(); | |
bc5f5a43 BV |
98 | |
99 | if (!(di = get_di_by_decobject(self))) | |
100 | return NULL; | |
101 | ||
983cb0f5 | 102 | if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample, &output_id, &data)) |
bc5f5a43 BV |
103 | return NULL; |
104 | ||
105 | if (!(l = g_slist_nth(di->pd_output, output_id))) { | |
15969949 BV |
106 | srd_err("Protocol decoder %s submitted invalid output ID %d", |
107 | di->decoder->name, output_id); | |
bc5f5a43 BV |
108 | return NULL; |
109 | } | |
110 | pdo = l->data; | |
111 | ||
94d43b37 | 112 | if (!(pdata = g_try_malloc0(sizeof(struct srd_proto_data)))) |
7ce7775c BV |
113 | return NULL; |
114 | pdata->start_sample = start_sample; | |
115 | pdata->end_sample = end_sample; | |
116 | pdata->pdo = pdo; | |
117 | ||
15969949 | 118 | switch (pdo->output_type) { |
94d43b37 | 119 | case SRD_OUTPUT_ANN: |
7ce7775c BV |
120 | /* Annotations are only fed to callbacks. */ |
121 | if ((cb = srd_find_callback(pdo->output_type))) { | |
122 | /* Annotations need converting from PyObject. */ | |
94d43b37 | 123 | if (convert_pyobj(di, data, &pdata->ann_format, |
7ce7775c BV |
124 | (char ***)&pdata->data) != SRD_OK) { |
125 | /* An error was already logged. */ | |
126 | break; | |
127 | } | |
128 | cb(pdata); | |
129 | } | |
130 | break; | |
94d43b37 | 131 | case SRD_OUTPUT_PROTO: |
7ce7775c BV |
132 | for (l = di->next_di; l; l = l->next) { |
133 | next_di = l->data; | |
134 | /* TODO: is this needed? */ | |
135 | Py_XINCREF(next_di->py_instance); | |
136 | if (!(py_res = PyObject_CallMethod(next_di->py_instance, "decode", | |
137 | "KKO", start_sample, end_sample, data))) { | |
138 | if (PyErr_Occurred()) | |
139 | PyErr_Print(); | |
140 | } | |
141 | Py_XDECREF(py_res); | |
142 | } | |
143 | break; | |
983cb0f5 | 144 | case SRD_OUTPUT_BINARY: |
7ce7775c | 145 | srd_err("SRD_OUTPUT_BINARY not yet supported"); |
15969949 | 146 | break; |
15969949 BV |
147 | default: |
148 | srd_err("Protocol decoder %s submitted invalid output type %d", | |
149 | di->decoder->name, pdo->output_type); | |
150 | break; | |
151 | } | |
bc5f5a43 | 152 | |
7ce7775c | 153 | g_free(pdata); |
983cb0f5 | 154 | |
bc5f5a43 BV |
155 | Py_RETURN_NONE; |
156 | } | |
157 | ||
158 | ||
f9a3947a | 159 | static PyObject *Decoder_add(PyObject *self, PyObject *args) |
bc5f5a43 BV |
160 | { |
161 | PyObject *ret; | |
162 | struct srd_decoder_instance *di; | |
94d43b37 | 163 | char *proto_id; |
bc5f5a43 BV |
164 | int output_type, pdo_id; |
165 | ||
7ce7775c BV |
166 | if (!(di = get_di_by_decobject(self))) { |
167 | srd_err("%s():%d decoder instance not found", __func__, __LINE__); | |
168 | PyErr_SetString(PyExc_Exception, "decoder instance not found"); | |
bc5f5a43 | 169 | return NULL; |
7ce7775c | 170 | } |
bc5f5a43 | 171 | |
94d43b37 | 172 | if (!PyArg_ParseTuple(args, "is", &output_type, &proto_id)) { |
7ce7775c BV |
173 | if (PyErr_Occurred()) |
174 | PyErr_Print(); | |
bc5f5a43 | 175 | return NULL; |
7ce7775c | 176 | } |
bc5f5a43 | 177 | |
94d43b37 | 178 | pdo_id = pd_add(di, output_type, proto_id); |
bc5f5a43 BV |
179 | if (pdo_id < 0) |
180 | Py_RETURN_NONE; | |
181 | else | |
182 | ret = Py_BuildValue("i", pdo_id); | |
183 | ||
184 | return ret; | |
185 | } | |
186 | ||
187 | static PyMethodDef no_methods[] = { {NULL, NULL, 0, NULL} }; | |
188 | static PyMethodDef Decoder_methods[] = { | |
189 | {"put", Decoder_put, METH_VARARGS, | |
190 | "Accepts a dictionary with the following keys: time, duration, data"}, | |
f9a3947a | 191 | {"add", Decoder_add, METH_VARARGS, "Create a new output stream"}, |
bc5f5a43 BV |
192 | {NULL, NULL, 0, NULL} |
193 | }; | |
194 | ||
195 | ||
f8e45857 | 196 | PyTypeObject srd_Decoder_type = { |
bc5f5a43 BV |
197 | PyVarObject_HEAD_INIT(NULL, 0) |
198 | .tp_name = "sigrokdecode.Decoder", | |
f8e45857 | 199 | .tp_basicsize = sizeof(srd_Decoder), |
bc5f5a43 | 200 | .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, |
f8e45857 | 201 | .tp_doc = "Sigrok Decoder base class", |
bc5f5a43 | 202 | .tp_methods = Decoder_methods, |
bc5f5a43 BV |
203 | }; |
204 | ||
205 | static struct PyModuleDef sigrokdecode_module = { | |
206 | PyModuleDef_HEAD_INIT, | |
207 | .m_name = "sigrokdecode", | |
f8e45857 | 208 | .m_doc = "sigrokdecode module", |
bc5f5a43 BV |
209 | .m_size = -1, |
210 | .m_methods = no_methods, | |
211 | }; | |
212 | ||
213 | PyMODINIT_FUNC PyInit_sigrokdecode(void) | |
214 | { | |
215 | PyObject *mod; | |
216 | ||
217 | /* tp_new needs to be assigned here for compiler portability */ | |
218 | srd_Decoder_type.tp_new = PyType_GenericNew; | |
219 | if (PyType_Ready(&srd_Decoder_type) < 0) | |
220 | return NULL; | |
221 | ||
222 | srd_logic_type.tp_new = PyType_GenericNew; | |
223 | if (PyType_Ready(&srd_logic_type) < 0) | |
224 | return NULL; | |
225 | ||
226 | mod = PyModule_Create(&sigrokdecode_module); | |
227 | Py_INCREF(&srd_Decoder_type); | |
228 | if (PyModule_AddObject(mod, "Decoder", (PyObject *)&srd_Decoder_type) == -1) | |
229 | return NULL; | |
230 | Py_INCREF(&srd_logic_type); | |
231 | if (PyModule_AddObject(mod, "srd_logic", (PyObject *)&srd_logic_type) == -1) | |
232 | return NULL; | |
233 | ||
3e2a9de2 | 234 | /* expose output types as symbols in the sigrokdecode module */ |
56202222 | 235 | if(PyModule_AddObject(mod, "OUTPUT_ANN", |
94d43b37 | 236 | PyLong_FromLong(SRD_OUTPUT_ANN)) == -1) |
3e2a9de2 | 237 | return NULL; |
56202222 | 238 | if(PyModule_AddObject(mod, "OUTPUT_PROTO", |
94d43b37 | 239 | PyLong_FromLong(SRD_OUTPUT_PROTO)) == -1) |
3e2a9de2 | 240 | return NULL; |
56202222 | 241 | if(PyModule_AddObject(mod, "OUTPUT_BINARY", |
3e2a9de2 BV |
242 | PyLong_FromLong(SRD_OUTPUT_BINARY)) == -1) |
243 | return NULL; | |
244 | ||
451680f1 BV |
245 | mod_sigrokdecode = mod; |
246 | ||
bc5f5a43 BV |
247 | return mod; |
248 | } | |
249 |