]>
Commit | Line | Data |
---|---|---|
b2c19614 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
b2c19614 BV |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
bc5f5a43 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
b2c19614 BV |
6 | * |
7 | * This program is free software: you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation, either version 3 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
36784362 | 21 | #include <config.h> |
f6c7eade MC |
22 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
23 | #include "libsigrokdecode.h" | |
b2c19614 | 24 | #include <glib.h> |
1aef2f93 | 25 | #include <inttypes.h> |
0bdadba2 | 26 | #include <stdlib.h> |
32cfb920 | 27 | #include <stdint.h> |
b2c19614 | 28 | |
32cfb920 | 29 | /** @cond PRIVATE */ |
d906d3f9 | 30 | |
23a29d24 | 31 | extern SRD_PRIV GSList *sessions; |
b2c19614 | 32 | |
201a85a8 DE |
33 | /* module_sigrokdecode.c */ |
34 | extern SRD_PRIV PyObject *srd_logic_type; | |
b2c19614 | 35 | |
57790bc8 UH |
36 | /** @endcond */ |
37 | ||
b2c19614 | 38 | /** |
190b71cf | 39 | * @file |
8c664ca2 | 40 | * |
190b71cf | 41 | * Decoder instance handling. |
b2c19614 | 42 | */ |
4895418c UH |
43 | |
44 | /** | |
45 | * @defgroup grp_instances Decoder instances | |
46 | * | |
47 | * Decoder instance handling. | |
48 | * | |
49 | * @{ | |
50 | */ | |
51 | ||
7ce7775c | 52 | /** |
b33b8aa5 | 53 | * Set one or more options in a decoder instance. |
0bdadba2 | 54 | * |
361fdcaa UH |
55 | * Handled options are removed from the hash. |
56 | * | |
0bdadba2 BV |
57 | * @param di Decoder instance. |
58 | * @param options A GHashTable of options to set. | |
7ce7775c | 59 | * |
0bdadba2 | 60 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
61 | * |
62 | * @since 0.1.0 | |
0bdadba2 | 63 | */ |
b33b8aa5 | 64 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 65 | GHashTable *options) |
0bdadba2 | 66 | { |
d841d5b2 | 67 | struct srd_decoder_option *sdo; |
84c1c0b5 | 68 | PyObject *py_di_options, *py_optval; |
2f395bff | 69 | GVariant *value; |
d841d5b2 UH |
70 | GSList *l; |
71 | double val_double; | |
2f395bff | 72 | gint64 val_int; |
84c1c0b5 | 73 | int ret; |
2f395bff | 74 | const char *val_str; |
0bdadba2 | 75 | |
3af0e345 UH |
76 | if (!di) { |
77 | srd_err("Invalid decoder instance."); | |
78 | return SRD_ERR_ARG; | |
79 | } | |
80 | ||
81 | if (!options) { | |
82 | srd_err("Invalid options GHashTable."); | |
83 | return SRD_ERR_ARG; | |
84 | } | |
85 | ||
c9bfccc6 | 86 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 87 | /* Decoder has no options. */ |
e431d9cc BV |
88 | if (g_hash_table_size(options) == 0) { |
89 | /* No options provided. */ | |
90 | return SRD_OK; | |
91 | } else { | |
92 | srd_err("Protocol decoder has no options."); | |
93 | return SRD_ERR_ARG; | |
94 | } | |
0bdadba2 | 95 | return SRD_OK; |
e431d9cc | 96 | } |
0bdadba2 BV |
97 | |
98 | ret = SRD_ERR_PYTHON; | |
d841d5b2 | 99 | py_optval = NULL; |
119d6258 BV |
100 | |
101 | /* | |
84c1c0b5 | 102 | * The 'options' tuple is a class variable, but we need to |
119d6258 BV |
103 | * change it. Changing it directly will affect the entire class, |
104 | * so we need to create a new object for it, and populate that | |
105 | * instead. | |
106 | */ | |
a8b72b05 | 107 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 | 108 | goto err_out; |
119d6258 BV |
109 | Py_DECREF(py_di_options); |
110 | py_di_options = PyDict_New(); | |
111 | PyObject_SetAttrString(di->py_inst, "options", py_di_options); | |
0bdadba2 | 112 | |
d841d5b2 UH |
113 | for (l = di->decoder->options; l; l = l->next) { |
114 | sdo = l->data; | |
115 | if ((value = g_hash_table_lookup(options, sdo->id))) { | |
116 | /* A value was supplied for this option. */ | |
117 | if (!g_variant_type_equal(g_variant_get_type(value), | |
bd6594c0 | 118 | g_variant_get_type(sdo->def))) { |
d841d5b2 UH |
119 | srd_err("Option '%s' should have the same type " |
120 | "as the default value.", sdo->id); | |
121 | goto err_out; | |
122 | } | |
123 | } else { | |
124 | /* Use default for this option. */ | |
125 | value = sdo->def; | |
126 | } | |
127 | if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { | |
128 | val_str = g_variant_get_string(value, NULL); | |
129 | if (!(py_optval = PyUnicode_FromString(val_str))) { | |
130 | /* Some UTF-8 encoding error. */ | |
131 | PyErr_Clear(); | |
132 | srd_err("Option '%s' requires a UTF-8 string value.", sdo->id); | |
133 | goto err_out; | |
134 | } | |
135 | } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { | |
136 | val_int = g_variant_get_int64(value); | |
137 | if (!(py_optval = PyLong_FromLong(val_int))) { | |
138 | /* ValueError Exception */ | |
139 | PyErr_Clear(); | |
140 | srd_err("Option '%s' has invalid integer value.", sdo->id); | |
141 | goto err_out; | |
142 | } | |
143 | } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) { | |
144 | val_double = g_variant_get_double(value); | |
145 | if (!(py_optval = PyFloat_FromDouble(val_double))) { | |
146 | /* ValueError Exception */ | |
147 | PyErr_Clear(); | |
148 | srd_err("Option '%s' has invalid float value.", | |
149 | sdo->id); | |
150 | goto err_out; | |
151 | } | |
152 | } | |
84c1c0b5 | 153 | if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) |
0bdadba2 | 154 | goto err_out; |
d841d5b2 UH |
155 | /* Not harmful even if we used the default. */ |
156 | g_hash_table_remove(options, sdo->id); | |
157 | } | |
158 | if (g_hash_table_size(options) != 0) | |
159 | srd_warn("Unknown options specified for '%s'", di->inst_id); | |
0bdadba2 BV |
160 | |
161 | ret = SRD_OK; | |
162 | ||
163 | err_out: | |
84c1c0b5 | 164 | Py_XDECREF(py_optval); |
7fc7bde6 | 165 | if (PyErr_Occurred()) { |
201a85a8 | 166 | srd_exception_catch("Stray exception in srd_inst_option_set()"); |
7fc7bde6 BV |
167 | ret = SRD_ERR_PYTHON; |
168 | } | |
0bdadba2 BV |
169 | |
170 | return ret; | |
171 | } | |
172 | ||
6a15597a UH |
173 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */ |
174 | static gint compare_channel_id(const struct srd_channel *pdch, | |
175 | const char *channel_id) | |
f38ec285 | 176 | { |
6a15597a | 177 | return strcmp(pdch->id, channel_id); |
f38ec285 BV |
178 | } |
179 | ||
0bdadba2 | 180 | /** |
6a15597a | 181 | * Set all channels in a decoder instance. |
b33b8aa5 | 182 | * |
6a15597a UH |
183 | * This function sets _all_ channels for the specified decoder instance, i.e., |
184 | * it overwrites any channels that were already defined (if any). | |
0bdadba2 BV |
185 | * |
186 | * @param di Decoder instance. | |
6a15597a UH |
187 | * @param new_channels A GHashTable of channels to set. Key is channel name, |
188 | * value is the channel number. Samples passed to this | |
189 | * instance will be arranged in this order. | |
12243c22 | 190 | * |
0bdadba2 | 191 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 | 192 | * |
cda2d36c | 193 | * @since 0.4.0 |
0bdadba2 | 194 | */ |
6a15597a | 195 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
cda2d36c | 196 | GHashTable *new_channels) |
0bdadba2 | 197 | { |
6a15597a | 198 | GVariant *channel_val; |
f38ec285 BV |
199 | GList *l; |
200 | GSList *sl; | |
6a15597a UH |
201 | struct srd_channel *pdch; |
202 | int *new_channelmap, new_channelnum, num_required_channels, i; | |
203 | char *channel_id; | |
0bdadba2 | 204 | |
cda2d36c UH |
205 | srd_dbg("Setting channels for instance %s with list of %d channels.", |
206 | di->inst_id, g_hash_table_size(new_channels)); | |
ce46beed | 207 | |
6a15597a UH |
208 | if (g_hash_table_size(new_channels) == 0) |
209 | /* No channels provided. */ | |
0bdadba2 BV |
210 | return SRD_OK; |
211 | ||
6a15597a UH |
212 | if (di->dec_num_channels == 0) { |
213 | /* Decoder has no channels. */ | |
214 | srd_err("Protocol decoder %s has no channels to define.", | |
c9bfccc6 | 215 | di->decoder->name); |
f38ec285 BV |
216 | return SRD_ERR_ARG; |
217 | } | |
0bdadba2 | 218 | |
077fa8ac | 219 | new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels); |
0bdadba2 | 220 | |
38ff5046 | 221 | /* |
6a15597a UH |
222 | * For now, map all indexes to channel -1 (can be overridden later). |
223 | * This -1 is interpreted as an unspecified channel later. | |
38ff5046 | 224 | */ |
6a15597a UH |
225 | for (i = 0; i < di->dec_num_channels; i++) |
226 | new_channelmap[i] = -1; | |
227 | ||
228 | for (l = g_hash_table_get_keys(new_channels); l; l = l->next) { | |
229 | channel_id = l->data; | |
230 | channel_val = g_hash_table_lookup(new_channels, channel_id); | |
231 | if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) { | |
232 | /* Channel name was specified without a value. */ | |
233 | srd_err("No channel number was specified for %s.", | |
234 | channel_id); | |
235 | g_free(new_channelmap); | |
be873260 BV |
236 | return SRD_ERR_ARG; |
237 | } | |
6a15597a | 238 | new_channelnum = g_variant_get_int32(channel_val); |
6a15597a UH |
239 | if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id, |
240 | (GCompareFunc)compare_channel_id))) { | |
241 | /* Fall back on optional channels. */ | |
242 | if (!(sl = g_slist_find_custom(di->decoder->opt_channels, | |
d841d5b2 | 243 | channel_id, (GCompareFunc)compare_channel_id))) { |
6a15597a | 244 | srd_err("Protocol decoder %s has no channel " |
d841d5b2 | 245 | "'%s'.", di->decoder->name, channel_id); |
6a15597a | 246 | g_free(new_channelmap); |
f38ec285 BV |
247 | return SRD_ERR_ARG; |
248 | } | |
249 | } | |
6a15597a UH |
250 | pdch = sl->data; |
251 | new_channelmap[pdch->order] = new_channelnum; | |
252 | srd_dbg("Setting channel mapping: %s (index %d) = channel %d.", | |
253 | pdch->id, pdch->order, new_channelnum); | |
38ff5046 UH |
254 | } |
255 | ||
6a15597a UH |
256 | srd_dbg("Final channel map:"); |
257 | num_required_channels = g_slist_length(di->decoder->channels); | |
258 | for (i = 0; i < di->dec_num_channels; i++) { | |
259 | srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i], | |
d841d5b2 | 260 | (i < num_required_channels) ? "required" : "optional"); |
f38ec285 | 261 | } |
38ff5046 | 262 | |
6a15597a UH |
263 | /* Report an error if not all required channels were specified. */ |
264 | for (i = 0; i < num_required_channels; i++) { | |
265 | if (new_channelmap[i] != -1) | |
9bf7f71c | 266 | continue; |
6a15597a UH |
267 | pdch = g_slist_nth(di->decoder->channels, i)->data; |
268 | srd_err("Required channel '%s' (index %d) was not specified.", | |
269 | pdch->id, i); | |
9bf7f71c UH |
270 | return SRD_ERR; |
271 | } | |
272 | ||
6a15597a UH |
273 | g_free(di->dec_channelmap); |
274 | di->dec_channelmap = new_channelmap; | |
0bdadba2 | 275 | |
f38ec285 | 276 | return SRD_OK; |
0bdadba2 BV |
277 | } |
278 | ||
279 | /** | |
280 | * Create a new protocol decoder instance. | |
7ce7775c | 281 | * |
32cfb920 | 282 | * @param sess The session holding the protocol decoder instance. |
38ff5046 | 283 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 284 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 285 | * the decoder class. May be NULL. |
12243c22 | 286 | * |
a8b72b05 | 287 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 288 | * NULL in case of failure. |
8c664ca2 | 289 | * |
69075817 | 290 | * @since 0.3.0 |
7ce7775c | 291 | */ |
32cfb920 BV |
292 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
293 | const char *decoder_id, GHashTable *options) | |
b2c19614 | 294 | { |
c9bfccc6 | 295 | int i; |
b2c19614 | 296 | struct srd_decoder *dec; |
a8b72b05 BV |
297 | struct srd_decoder_inst *di; |
298 | char *inst_id; | |
b2c19614 | 299 | |
7a1712c4 | 300 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 301 | |
32cfb920 BV |
302 | if (session_is_valid(sess) != SRD_OK) { |
303 | srd_err("Invalid session."); | |
304 | return NULL; | |
305 | } | |
306 | ||
9d122fd5 | 307 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 308 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 309 | return NULL; |
0bdadba2 | 310 | } |
b2c19614 | 311 | |
077fa8ac | 312 | di = g_malloc0(sizeof(struct srd_decoder_inst)); |
0bdadba2 | 313 | |
b2c19614 | 314 | di->decoder = dec; |
32cfb920 | 315 | di->sess = sess; |
38ff5046 UH |
316 | if (options) { |
317 | inst_id = g_hash_table_lookup(options, "id"); | |
318 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
319 | g_hash_table_remove(options, "id"); | |
320 | } else | |
321 | di->inst_id = g_strdup(decoder_id); | |
b2c19614 | 322 | |
361fdcaa | 323 | /* |
6a15597a | 324 | * Prepare a default channel map, where samples come in the |
f38ec285 BV |
325 | * order in which the decoder class defined them. |
326 | */ | |
6a15597a UH |
327 | di->dec_num_channels = g_slist_length(di->decoder->channels) + |
328 | g_slist_length(di->decoder->opt_channels); | |
329 | if (di->dec_num_channels) { | |
077fa8ac UH |
330 | di->dec_channelmap = |
331 | g_malloc(sizeof(int) * di->dec_num_channels); | |
6a15597a UH |
332 | for (i = 0; i < di->dec_num_channels; i++) |
333 | di->dec_channelmap[i] = i; | |
37b94c20 BV |
334 | /* |
335 | * Will be used to prepare a sample at every iteration | |
336 | * of the instance's decode() method. | |
337 | */ | |
077fa8ac | 338 | di->channel_samples = g_malloc(di->dec_num_channels); |
f38ec285 | 339 | } |
f38ec285 | 340 | |
0bdadba2 | 341 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 342 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 343 | if (PyErr_Occurred()) |
201a85a8 | 344 | srd_exception_catch("Failed to create %s instance", |
69075817 | 345 | decoder_id); |
6a15597a | 346 | g_free(di->dec_channelmap); |
0bdadba2 | 347 | g_free(di); |
7ce7775c | 348 | return NULL; |
b2c19614 | 349 | } |
7ce7775c | 350 | |
38ff5046 | 351 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
6a15597a | 352 | g_free(di->dec_channelmap); |
0bdadba2 BV |
353 | g_free(di); |
354 | return NULL; | |
355 | } | |
b2c19614 | 356 | |
f38ec285 | 357 | /* Instance takes input from a frontend by default. */ |
32cfb920 | 358 | sess->di_list = g_slist_append(sess->di_list, di); |
f38ec285 | 359 | |
b2c19614 BV |
360 | return di; |
361 | } | |
362 | ||
582c8473 BV |
363 | /** |
364 | * Stack a decoder instance on top of another. | |
365 | * | |
32cfb920 | 366 | * @param sess The session holding the protocol decoder instances. |
4d2c7619 BV |
367 | * @param di_bottom The instance on top of which di_top will be stacked. |
368 | * @param di_top The instance to go on top. | |
582c8473 BV |
369 | * |
370 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 371 | * |
69075817 | 372 | * @since 0.3.0 |
582c8473 | 373 | */ |
32cfb920 | 374 | SRD_API int srd_inst_stack(struct srd_session *sess, |
4d2c7619 BV |
375 | struct srd_decoder_inst *di_bottom, |
376 | struct srd_decoder_inst *di_top) | |
7ce7775c | 377 | { |
32cfb920 BV |
378 | |
379 | if (session_is_valid(sess) != SRD_OK) { | |
380 | srd_err("Invalid session."); | |
381 | return SRD_ERR_ARG; | |
382 | } | |
383 | ||
4d2c7619 | 384 | if (!di_bottom || !di_top) { |
d906d3f9 | 385 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
386 | return SRD_ERR_ARG; |
387 | } | |
388 | ||
4d2c7619 | 389 | if (g_slist_find(sess->di_list, di_top)) { |
2072ae0c | 390 | /* Remove from the unstacked list. */ |
4d2c7619 | 391 | sess->di_list = g_slist_remove(sess->di_list, di_top); |
7ce7775c BV |
392 | } |
393 | ||
7ce7775c | 394 | /* Stack on top of source di. */ |
4d2c7619 BV |
395 | di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top); |
396 | ||
d841d5b2 | 397 | srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id); |
7ce7775c BV |
398 | |
399 | return SRD_OK; | |
400 | } | |
401 | ||
2072ae0c | 402 | /** |
361fdcaa UH |
403 | * Find a decoder instance by its instance ID. |
404 | * | |
405 | * Only the bottom level of instances are searched -- instances already stacked | |
406 | * on top of another one will not be found. | |
2072ae0c | 407 | * |
32cfb920 | 408 | * @param sess The session holding the protocol decoder instance. |
ed2306a6 | 409 | * @param inst_id The instance ID to be found. |
2072ae0c | 410 | * |
a8b72b05 | 411 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 | 412 | * |
69075817 | 413 | * @since 0.3.0 |
2072ae0c | 414 | */ |
32cfb920 BV |
415 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, |
416 | const char *inst_id) | |
7ce7775c BV |
417 | { |
418 | GSList *l; | |
a8b72b05 | 419 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 420 | |
32cfb920 BV |
421 | if (session_is_valid(sess) != SRD_OK) { |
422 | srd_err("Invalid session."); | |
423 | return NULL; | |
424 | } | |
425 | ||
7ce7775c | 426 | di = NULL; |
32cfb920 | 427 | for (l = sess->di_list; l; l = l->next) { |
7ce7775c | 428 | tmp = l->data; |
a8b72b05 | 429 | if (!strcmp(tmp->inst_id, inst_id)) { |
7ce7775c BV |
430 | di = tmp; |
431 | break; | |
432 | } | |
433 | } | |
434 | ||
435 | return di; | |
436 | } | |
437 | ||
32cfb920 BV |
438 | static struct srd_decoder_inst *srd_sess_inst_find_by_obj( |
439 | struct srd_session *sess, const GSList *stack, | |
440 | const PyObject *obj) | |
441 | { | |
442 | const GSList *l; | |
443 | struct srd_decoder_inst *tmp, *di; | |
444 | ||
445 | if (session_is_valid(sess) != SRD_OK) { | |
446 | srd_err("Invalid session."); | |
447 | return NULL; | |
448 | } | |
449 | ||
450 | di = NULL; | |
451 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
452 | tmp = l->data; | |
453 | if (tmp->py_inst == obj) | |
454 | di = tmp; | |
455 | else if (tmp->next_di) | |
456 | di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); | |
457 | } | |
458 | ||
459 | return di; | |
460 | } | |
461 | ||
2072ae0c | 462 | /** |
361fdcaa UH |
463 | * Find a decoder instance by its Python object. |
464 | * | |
465 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
32cfb920 BV |
466 | * This will recurse to find the instance anywhere in the stack tree of all |
467 | * sessions. | |
2072ae0c | 468 | * |
361fdcaa UH |
469 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the |
470 | * stack to search. To start searching at the bottom level of | |
471 | * decoder instances, pass NULL. | |
511e2123 | 472 | * @param obj The Python class instantiation. |
2072ae0c | 473 | * |
a8b72b05 | 474 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
57790bc8 UH |
475 | * |
476 | * @private | |
8c664ca2 UH |
477 | * |
478 | * @since 0.1.0 | |
2072ae0c | 479 | */ |
abeeed8b | 480 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
0ff2d191 | 481 | const PyObject *obj) |
2072ae0c | 482 | { |
32cfb920 BV |
483 | struct srd_decoder_inst *di; |
484 | struct srd_session *sess; | |
485 | GSList *l; | |
2072ae0c BV |
486 | |
487 | di = NULL; | |
32cfb920 BV |
488 | for (l = sessions; di == NULL && l != NULL; l = l->next) { |
489 | sess = l->data; | |
490 | di = srd_sess_inst_find_by_obj(sess, stack, obj); | |
2072ae0c BV |
491 | } |
492 | ||
493 | return di; | |
494 | } | |
495 | ||
57790bc8 | 496 | /** @private */ |
ed416497 | 497 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) |
b2c19614 | 498 | { |
ed416497 | 499 | PyObject *py_res; |
2072ae0c | 500 | GSList *l; |
a8b72b05 | 501 | struct srd_decoder_inst *next_di; |
ed416497 | 502 | int ret; |
b2c19614 | 503 | |
7a1712c4 | 504 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
ed416497 | 505 | di->inst_id); |
b2c19614 | 506 | |
ed416497 | 507 | if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { |
201a85a8 | 508 | srd_exception_catch("Protocol decoder instance %s", |
ed416497 | 509 | di->inst_id); |
7ce7775c BV |
510 | return SRD_ERR_PYTHON; |
511 | } | |
f38ec285 | 512 | Py_DecRef(py_res); |
7ce7775c | 513 | |
ed416497 | 514 | /* Start all the PDs stacked on top of this one. */ |
2072ae0c BV |
515 | for (l = di->next_di; l; l = l->next) { |
516 | next_di = l->data; | |
ed416497 BV |
517 | if ((ret = srd_inst_start(next_di)) != SRD_OK) |
518 | return ret; | |
2072ae0c BV |
519 | } |
520 | ||
b2c19614 BV |
521 | return SRD_OK; |
522 | } | |
523 | ||
b2c19614 BV |
524 | /** |
525 | * Run the specified decoder function. | |
526 | * | |
ed416497 | 527 | * @param di The decoder instance to call. Must not be NULL. |
d906d3f9 | 528 | * @param start_samplenum The starting sample number for the buffer's sample |
7a1712c4 | 529 | * set, relative to the start of capture. |
ed416497 BV |
530 | * @param end_samplenum The ending sample number for the buffer's sample |
531 | * set, relative to the start of capture. | |
7a1712c4 UH |
532 | * @param inbuf The buffer to decode. Must not be NULL. |
533 | * @param inbuflen Length of the buffer. Must be > 0. | |
cda2d36c | 534 | * @param unitsize The number of bytes per sample. |
b2c19614 BV |
535 | * |
536 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
537 | * |
538 | * @private | |
8c664ca2 | 539 | * |
cda2d36c | 540 | * @since 0.4.0 |
b2c19614 | 541 | */ |
ed416497 BV |
542 | SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, |
543 | uint64_t start_samplenum, uint64_t end_samplenum, | |
cda2d36c | 544 | const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize) |
b2c19614 | 545 | { |
d906d3f9 | 546 | PyObject *py_res; |
bc5f5a43 | 547 | srd_logic *logic; |
b2c19614 | 548 | |
d906d3f9 | 549 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
550 | if (!di) { |
551 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
552 | return SRD_ERR_ARG; |
553 | } | |
7a1712c4 UH |
554 | if (!inbuf) { |
555 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
556 | return SRD_ERR_ARG; |
557 | } | |
558 | if (inbuflen == 0) { | |
7a1712c4 | 559 | srd_dbg("empty buffer"); |
d906d3f9 BV |
560 | return SRD_ERR_ARG; |
561 | } | |
b2c19614 | 562 | |
2730fe23 UH |
563 | ((struct srd_decoder_inst *)di)->data_unitsize = unitsize; |
564 | ||
565 | srd_dbg("Calling decode(), start sample %" PRIu64 ", end sample %" | |
566 | PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = " | |
567 | "%d), instance %s.", start_samplenum, end_samplenum, | |
568 | end_samplenum - start_samplenum, inbuflen, di->data_unitsize, | |
569 | di->inst_id); | |
570 | ||
361fdcaa UH |
571 | /* |
572 | * Create new srd_logic object. Each iteration around the PD's loop | |
d906d3f9 BV |
573 | * will fill one sample into this object. |
574 | */ | |
201a85a8 | 575 | logic = PyObject_New(srd_logic, (PyTypeObject *)srd_logic_type); |
bc5f5a43 | 576 | Py_INCREF(logic); |
abeeed8b | 577 | logic->di = (struct srd_decoder_inst *)di; |
86528298 | 578 | logic->start_samplenum = start_samplenum; |
bc5f5a43 | 579 | logic->itercnt = 0; |
abeeed8b | 580 | logic->inbuf = (uint8_t *)inbuf; |
bc5f5a43 BV |
581 | logic->inbuflen = inbuflen; |
582 | logic->sample = PyList_New(2); | |
583 | Py_INCREF(logic->sample); | |
584 | ||
a8b72b05 | 585 | Py_IncRef(di->py_inst); |
a8b72b05 | 586 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", |
ed416497 | 587 | "KKO", start_samplenum, end_samplenum, logic))) { |
201a85a8 | 588 | srd_exception_catch("Protocol decoder instance %s", |
d841d5b2 | 589 | di->inst_id); |
0ff2d191 | 590 | return SRD_ERR_PYTHON; |
b2c19614 | 591 | } |
d906d3f9 | 592 | Py_DecRef(py_res); |
bc5f5a43 | 593 | |
b2c19614 BV |
594 | return SRD_OK; |
595 | } | |
596 | ||
57790bc8 | 597 | /** @private */ |
12243c22 | 598 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
599 | { |
600 | GSList *l; | |
601 | struct srd_pd_output *pdo; | |
602 | ||
a8b72b05 | 603 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 604 | |
a8b72b05 BV |
605 | Py_DecRef(di->py_inst); |
606 | g_free(di->inst_id); | |
6a15597a | 607 | g_free(di->dec_channelmap); |
fa12a21e BV |
608 | g_slist_free(di->next_di); |
609 | for (l = di->pd_output; l; l = l->next) { | |
610 | pdo = l->data; | |
611 | g_free(pdo->proto_id); | |
612 | g_free(pdo); | |
613 | } | |
614 | g_slist_free(di->pd_output); | |
e592ac89 | 615 | g_free(di); |
fa12a21e BV |
616 | } |
617 | ||
57790bc8 | 618 | /** @private */ |
32cfb920 | 619 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) |
fa12a21e BV |
620 | { |
621 | GSList *l; | |
a8b72b05 | 622 | struct srd_decoder_inst *di; |
fa12a21e | 623 | |
32cfb920 BV |
624 | if (session_is_valid(sess) != SRD_OK) { |
625 | srd_err("Invalid session."); | |
626 | return; | |
627 | } | |
628 | ||
fa12a21e | 629 | di = NULL; |
32cfb920 | 630 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { |
fa12a21e BV |
631 | di = l->data; |
632 | if (di->next_di) | |
32cfb920 | 633 | srd_inst_free_all(sess, di->next_di); |
a8b72b05 | 634 | srd_inst_free(di); |
fa12a21e BV |
635 | } |
636 | if (!stack) { | |
32cfb920 BV |
637 | g_slist_free(sess->di_list); |
638 | sess->di_list = NULL; | |
fa12a21e | 639 | } |
fa12a21e | 640 | } |
b2c19614 | 641 | |
4895418c | 642 | /** @} */ |