]>
Commit | Line | Data |
---|---|---|
d0a0ed03 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
d0a0ed03 BV |
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 | ||
c1f86f02 UH |
20 | #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
21 | #include "libsigrokdecode-internal.h" | |
d0a0ed03 | 22 | #include "config.h" |
dbeaab27 | 23 | #include <inttypes.h> |
d0a0ed03 | 24 | |
58572aed | 25 | /* This is only used for nicer srd_dbg() output. */ |
abeeed8b | 26 | static const char *OUTPUT_TYPES[] = { |
58572aed BV |
27 | "OUTPUT_ANN", |
28 | "OUTPUT_PROTO", | |
29 | "OUTPUT_BINARY", | |
30 | }; | |
31 | ||
a8b72b05 | 32 | static int convert_pyobj(struct srd_decoder_inst *di, PyObject *obj, |
c9bfccc6 | 33 | int *ann_format, char ***ann) |
d0a0ed03 BV |
34 | { |
35 | PyObject *py_tmp; | |
36 | struct srd_pd_output *pdo; | |
37 | int ann_id; | |
38 | ||
361fdcaa | 39 | /* Should be a list of [annotation format, [string, ...]]. */ |
d0a0ed03 | 40 | if (!PyList_Check(obj) && !PyTuple_Check(obj)) { |
d906d3f9 | 41 | srd_err("Protocol decoder %s submitted %s instead of list.", |
c9bfccc6 | 42 | di->decoder->name, obj->ob_type->tp_name); |
d0a0ed03 BV |
43 | return SRD_ERR_PYTHON; |
44 | } | |
45 | ||
361fdcaa | 46 | /* Should have 2 elements. */ |
d0a0ed03 | 47 | if (PyList_Size(obj) != 2) { |
c9bfccc6 UH |
48 | srd_err("Protocol decoder %s submitted annotation list with " |
49 | "%d elements instead of 2", di->decoder->name, | |
50 | PyList_Size(obj)); | |
d0a0ed03 BV |
51 | return SRD_ERR_PYTHON; |
52 | } | |
53 | ||
c9bfccc6 UH |
54 | /* |
55 | * The first element should be an integer matching a previously | |
56 | * registered annotation format. | |
57 | */ | |
d0a0ed03 BV |
58 | py_tmp = PyList_GetItem(obj, 0); |
59 | if (!PyLong_Check(py_tmp)) { | |
c9bfccc6 UH |
60 | srd_err("Protocol decoder %s submitted annotation list, but " |
61 | "first element was not an integer.", di->decoder->name); | |
d0a0ed03 BV |
62 | return SRD_ERR_PYTHON; |
63 | } | |
64 | ||
65 | ann_id = PyLong_AsLong(py_tmp); | |
66 | if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_id))) { | |
d906d3f9 | 67 | srd_err("Protocol decoder %s submitted data to unregistered " |
c9bfccc6 | 68 | "annotation format %d.", di->decoder->name, ann_id); |
d0a0ed03 BV |
69 | return SRD_ERR_PYTHON; |
70 | } | |
71 | *ann_format = ann_id; | |
72 | ||
361fdcaa | 73 | /* Second element must be a list. */ |
d0a0ed03 BV |
74 | py_tmp = PyList_GetItem(obj, 1); |
75 | if (!PyList_Check(py_tmp)) { | |
d906d3f9 | 76 | srd_err("Protocol decoder %s submitted annotation list, but " |
c9bfccc6 | 77 | "second element was not a list.", di->decoder->name); |
d0a0ed03 BV |
78 | return SRD_ERR_PYTHON; |
79 | } | |
80 | if (py_strlist_to_char(py_tmp, ann) != SRD_OK) { | |
d906d3f9 | 81 | srd_err("Protocol decoder %s submitted annotation list, but " |
c9bfccc6 | 82 | "second element was malformed.", di->decoder->name); |
d0a0ed03 BV |
83 | return SRD_ERR_PYTHON; |
84 | } | |
85 | ||
86 | return SRD_OK; | |
87 | } | |
88 | ||
89 | static PyObject *Decoder_put(PyObject *self, PyObject *args) | |
90 | { | |
91 | GSList *l; | |
92 | PyObject *data, *py_res; | |
a8b72b05 | 93 | struct srd_decoder_inst *di, *next_di; |
d0a0ed03 BV |
94 | struct srd_pd_output *pdo; |
95 | struct srd_proto_data *pdata; | |
96 | uint64_t start_sample, end_sample; | |
97 | int output_id; | |
2994587f | 98 | struct srd_pd_callback *cb; |
d0a0ed03 | 99 | |
a8b72b05 | 100 | if (!(di = srd_inst_find_by_obj(NULL, self))) { |
58572aed | 101 | /* Shouldn't happen. */ |
7a1712c4 | 102 | srd_dbg("put(): self instance not found."); |
d0a0ed03 | 103 | return NULL; |
58572aed | 104 | } |
d0a0ed03 | 105 | |
c9bfccc6 UH |
106 | if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample, |
107 | &output_id, &data)) { | |
108 | /* | |
109 | * This throws an exception, but by returning NULL here we let | |
110 | * Python raise it. This results in a much better trace in | |
111 | * controller.c on the decode() method call. | |
112 | */ | |
d0a0ed03 | 113 | return NULL; |
c9bfccc6 | 114 | } |
d0a0ed03 BV |
115 | |
116 | if (!(l = g_slist_nth(di->pd_output, output_id))) { | |
d906d3f9 | 117 | srd_err("Protocol decoder %s submitted invalid output ID %d.", |
c9bfccc6 | 118 | di->decoder->name, output_id); |
d0a0ed03 BV |
119 | return NULL; |
120 | } | |
121 | pdo = l->data; | |
122 | ||
1c2b0d0b | 123 | srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.", |
a8b72b05 | 124 | di->inst_id, start_sample, end_sample, |
1c2b0d0b | 125 | OUTPUT_TYPES[pdo->output_type], output_id); |
58572aed | 126 | |
a61ece20 UH |
127 | if (!(pdata = g_try_malloc0(sizeof(struct srd_proto_data)))) { |
128 | srd_err("Failed to g_malloc() struct srd_proto_data."); | |
d0a0ed03 | 129 | return NULL; |
a61ece20 | 130 | } |
d0a0ed03 BV |
131 | pdata->start_sample = start_sample; |
132 | pdata->end_sample = end_sample; | |
133 | pdata->pdo = pdo; | |
134 | ||
135 | switch (pdo->output_type) { | |
136 | case SRD_OUTPUT_ANN: | |
137 | /* Annotations are only fed to callbacks. */ | |
b33b8aa5 | 138 | if ((cb = srd_pd_output_callback_find(pdo->output_type))) { |
d0a0ed03 BV |
139 | /* Annotations need converting from PyObject. */ |
140 | if (convert_pyobj(di, data, &pdata->ann_format, | |
c9bfccc6 | 141 | (char ***)&pdata->data) != SRD_OK) { |
d0a0ed03 BV |
142 | /* An error was already logged. */ |
143 | break; | |
144 | } | |
2994587f | 145 | cb->cb(pdata, cb->cb_data); |
d0a0ed03 BV |
146 | } |
147 | break; | |
148 | case SRD_OUTPUT_PROTO: | |
149 | for (l = di->next_di; l; l = l->next) { | |
150 | next_di = l->data; | |
361fdcaa | 151 | /* TODO: Is this needed? */ |
a8b72b05 | 152 | Py_XINCREF(next_di->py_inst); |
7a1712c4 | 153 | srd_spew("Sending %d-%d to instance %s", |
c9bfccc6 | 154 | start_sample, end_sample, |
a8b72b05 | 155 | next_di->inst_id); |
c9bfccc6 | 156 | if (!(py_res = PyObject_CallMethod( |
a8b72b05 | 157 | next_di->py_inst, "decode", "KKO", start_sample, |
c9bfccc6 | 158 | end_sample, data))) { |
aafeeaea UH |
159 | srd_exception_catch("Calling %s decode(): ", |
160 | next_di->inst_id); | |
d0a0ed03 BV |
161 | } |
162 | Py_XDECREF(py_res); | |
163 | } | |
164 | break; | |
165 | case SRD_OUTPUT_BINARY: | |
d906d3f9 | 166 | srd_err("SRD_OUTPUT_BINARY not yet supported."); |
d0a0ed03 BV |
167 | break; |
168 | default: | |
d906d3f9 | 169 | srd_err("Protocol decoder %s submitted invalid output type %d.", |
c9bfccc6 | 170 | di->decoder->name, pdo->output_type); |
d0a0ed03 BV |
171 | break; |
172 | } | |
173 | ||
174 | g_free(pdata); | |
175 | ||
176 | Py_RETURN_NONE; | |
177 | } | |
178 | ||
d0a0ed03 BV |
179 | static PyObject *Decoder_add(PyObject *self, PyObject *args) |
180 | { | |
181 | PyObject *ret; | |
a8b72b05 | 182 | struct srd_decoder_inst *di; |
d0a0ed03 BV |
183 | char *proto_id; |
184 | int output_type, pdo_id; | |
185 | ||
a8b72b05 | 186 | if (!(di = srd_inst_find_by_obj(NULL, self))) { |
d0a0ed03 BV |
187 | PyErr_SetString(PyExc_Exception, "decoder instance not found"); |
188 | return NULL; | |
189 | } | |
190 | ||
191 | if (!PyArg_ParseTuple(args, "is", &output_type, &proto_id)) { | |
511e2123 | 192 | /* Let Python raise this exception. */ |
d0a0ed03 BV |
193 | return NULL; |
194 | } | |
195 | ||
aafeeaea | 196 | pdo_id = srd_inst_pd_output_add(di, output_type, proto_id); |
d0a0ed03 BV |
197 | if (pdo_id < 0) |
198 | Py_RETURN_NONE; | |
199 | else | |
200 | ret = Py_BuildValue("i", pdo_id); | |
201 | ||
202 | return ret; | |
203 | } | |
204 | ||
205 | static PyMethodDef Decoder_methods[] = { | |
206 | {"put", Decoder_put, METH_VARARGS, | |
86528298 | 207 | "Accepts a dictionary with the following keys: startsample, endsample, data"}, |
d0a0ed03 BV |
208 | {"add", Decoder_add, METH_VARARGS, "Create a new output stream"}, |
209 | {NULL, NULL, 0, NULL} | |
210 | }; | |
211 | ||
57790bc8 | 212 | /** @cond PRIVATE */ |
55c3c5f4 | 213 | SRD_PRIV PyTypeObject srd_Decoder_type = { |
d0a0ed03 BV |
214 | PyVarObject_HEAD_INIT(NULL, 0) |
215 | .tp_name = "sigrokdecode.Decoder", | |
216 | .tp_basicsize = sizeof(srd_Decoder), | |
217 | .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, | |
361fdcaa | 218 | .tp_doc = "sigrok Decoder base class", |
d0a0ed03 BV |
219 | .tp_methods = Decoder_methods, |
220 | }; | |
57790bc8 | 221 | /** @endcond */ |