]>
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 | ||
f6c7eade MC |
21 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
22 | #include "libsigrokdecode.h" | |
7ce7775c | 23 | #include "config.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 | |
c9bfccc6 | 33 | /* type_logic.c */ |
55c3c5f4 | 34 | extern SRD_PRIV PyTypeObject 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()) { |
aafeeaea | 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. | |
9eec72cb | 190 | * @param unit_size Number of bytes per sample in the data stream to be passed |
6a15597a UH |
191 | * to the decoder. The highest channel index specified in the |
192 | * channel map must lie within a sample unit. | |
12243c22 | 193 | * |
0bdadba2 | 194 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 | 195 | * |
c57d1013 | 196 | * @since 0.3.0 |
0bdadba2 | 197 | */ |
6a15597a UH |
198 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
199 | GHashTable *new_channels, int unit_size) | |
0bdadba2 | 200 | { |
6a15597a | 201 | GVariant *channel_val; |
f38ec285 BV |
202 | GList *l; |
203 | GSList *sl; | |
6a15597a UH |
204 | struct srd_channel *pdch; |
205 | int *new_channelmap, new_channelnum, num_required_channels, i; | |
206 | char *channel_id; | |
0bdadba2 | 207 | |
f714f8f8 | 208 | srd_dbg("Setting channels for instance %s with list of %d channels, " |
d841d5b2 UH |
209 | "unitsize %d.", di->inst_id, g_hash_table_size(new_channels), |
210 | unit_size); | |
ce46beed | 211 | |
6a15597a UH |
212 | if (g_hash_table_size(new_channels) == 0) |
213 | /* No channels provided. */ | |
0bdadba2 BV |
214 | return SRD_OK; |
215 | ||
6a15597a UH |
216 | if (di->dec_num_channels == 0) { |
217 | /* Decoder has no channels. */ | |
218 | srd_err("Protocol decoder %s has no channels to define.", | |
c9bfccc6 | 219 | di->decoder->name); |
f38ec285 BV |
220 | return SRD_ERR_ARG; |
221 | } | |
0bdadba2 | 222 | |
077fa8ac | 223 | new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels); |
0bdadba2 | 224 | |
38ff5046 | 225 | /* |
6a15597a UH |
226 | * For now, map all indexes to channel -1 (can be overridden later). |
227 | * This -1 is interpreted as an unspecified channel later. | |
38ff5046 | 228 | */ |
6a15597a UH |
229 | for (i = 0; i < di->dec_num_channels; i++) |
230 | new_channelmap[i] = -1; | |
231 | ||
232 | for (l = g_hash_table_get_keys(new_channels); l; l = l->next) { | |
233 | channel_id = l->data; | |
234 | channel_val = g_hash_table_lookup(new_channels, channel_id); | |
235 | if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) { | |
236 | /* Channel name was specified without a value. */ | |
237 | srd_err("No channel number was specified for %s.", | |
238 | channel_id); | |
239 | g_free(new_channelmap); | |
be873260 BV |
240 | return SRD_ERR_ARG; |
241 | } | |
6a15597a UH |
242 | new_channelnum = g_variant_get_int32(channel_val); |
243 | if (new_channelnum >= 8 * unit_size) { | |
244 | srd_err("Channel index %d not within data unit (%d bit).", | |
245 | new_channelnum, 8 * unit_size); | |
246 | g_free(new_channelmap); | |
9eec72cb DE |
247 | return SRD_ERR_ARG; |
248 | } | |
6a15597a UH |
249 | if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id, |
250 | (GCompareFunc)compare_channel_id))) { | |
251 | /* Fall back on optional channels. */ | |
252 | if (!(sl = g_slist_find_custom(di->decoder->opt_channels, | |
d841d5b2 | 253 | channel_id, (GCompareFunc)compare_channel_id))) { |
6a15597a | 254 | srd_err("Protocol decoder %s has no channel " |
d841d5b2 | 255 | "'%s'.", di->decoder->name, channel_id); |
6a15597a | 256 | g_free(new_channelmap); |
f38ec285 BV |
257 | return SRD_ERR_ARG; |
258 | } | |
259 | } | |
6a15597a UH |
260 | pdch = sl->data; |
261 | new_channelmap[pdch->order] = new_channelnum; | |
262 | srd_dbg("Setting channel mapping: %s (index %d) = channel %d.", | |
263 | pdch->id, pdch->order, new_channelnum); | |
38ff5046 | 264 | } |
9eec72cb | 265 | di->data_unitsize = unit_size; |
38ff5046 | 266 | |
6a15597a UH |
267 | srd_dbg("Final channel map:"); |
268 | num_required_channels = g_slist_length(di->decoder->channels); | |
269 | for (i = 0; i < di->dec_num_channels; i++) { | |
270 | srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i], | |
d841d5b2 | 271 | (i < num_required_channels) ? "required" : "optional"); |
f38ec285 | 272 | } |
38ff5046 | 273 | |
6a15597a UH |
274 | /* Report an error if not all required channels were specified. */ |
275 | for (i = 0; i < num_required_channels; i++) { | |
276 | if (new_channelmap[i] != -1) | |
9bf7f71c | 277 | continue; |
6a15597a UH |
278 | pdch = g_slist_nth(di->decoder->channels, i)->data; |
279 | srd_err("Required channel '%s' (index %d) was not specified.", | |
280 | pdch->id, i); | |
9bf7f71c UH |
281 | return SRD_ERR; |
282 | } | |
283 | ||
6a15597a UH |
284 | g_free(di->dec_channelmap); |
285 | di->dec_channelmap = new_channelmap; | |
0bdadba2 | 286 | |
f38ec285 | 287 | return SRD_OK; |
0bdadba2 BV |
288 | } |
289 | ||
290 | /** | |
291 | * Create a new protocol decoder instance. | |
7ce7775c | 292 | * |
32cfb920 | 293 | * @param sess The session holding the protocol decoder instance. |
38ff5046 | 294 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 295 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 296 | * the decoder class. May be NULL. |
12243c22 | 297 | * |
a8b72b05 | 298 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 299 | * NULL in case of failure. |
8c664ca2 | 300 | * |
69075817 | 301 | * @since 0.3.0 |
7ce7775c | 302 | */ |
32cfb920 BV |
303 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
304 | const char *decoder_id, GHashTable *options) | |
b2c19614 | 305 | { |
c9bfccc6 | 306 | int i; |
b2c19614 | 307 | struct srd_decoder *dec; |
a8b72b05 BV |
308 | struct srd_decoder_inst *di; |
309 | char *inst_id; | |
b2c19614 | 310 | |
7a1712c4 | 311 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 312 | |
32cfb920 BV |
313 | if (session_is_valid(sess) != SRD_OK) { |
314 | srd_err("Invalid session."); | |
315 | return NULL; | |
316 | } | |
317 | ||
9d122fd5 | 318 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 319 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 320 | return NULL; |
0bdadba2 | 321 | } |
b2c19614 | 322 | |
077fa8ac | 323 | di = g_malloc0(sizeof(struct srd_decoder_inst)); |
0bdadba2 | 324 | |
b2c19614 | 325 | di->decoder = dec; |
32cfb920 | 326 | di->sess = sess; |
38ff5046 UH |
327 | if (options) { |
328 | inst_id = g_hash_table_lookup(options, "id"); | |
329 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
330 | g_hash_table_remove(options, "id"); | |
331 | } else | |
332 | di->inst_id = g_strdup(decoder_id); | |
b2c19614 | 333 | |
361fdcaa | 334 | /* |
6a15597a | 335 | * Prepare a default channel map, where samples come in the |
f38ec285 BV |
336 | * order in which the decoder class defined them. |
337 | */ | |
6a15597a UH |
338 | di->dec_num_channels = g_slist_length(di->decoder->channels) + |
339 | g_slist_length(di->decoder->opt_channels); | |
340 | if (di->dec_num_channels) { | |
077fa8ac UH |
341 | di->dec_channelmap = |
342 | g_malloc(sizeof(int) * di->dec_num_channels); | |
6a15597a UH |
343 | for (i = 0; i < di->dec_num_channels; i++) |
344 | di->dec_channelmap[i] = i; | |
345 | di->data_unitsize = (di->dec_num_channels + 7) / 8; | |
37b94c20 BV |
346 | /* |
347 | * Will be used to prepare a sample at every iteration | |
348 | * of the instance's decode() method. | |
349 | */ | |
077fa8ac | 350 | di->channel_samples = g_malloc(di->dec_num_channels); |
f38ec285 | 351 | } |
f38ec285 | 352 | |
0bdadba2 | 353 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 354 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 355 | if (PyErr_Occurred()) |
aafeeaea | 356 | srd_exception_catch("failed to create %s instance: ", |
69075817 | 357 | decoder_id); |
6a15597a | 358 | g_free(di->dec_channelmap); |
0bdadba2 | 359 | g_free(di); |
7ce7775c | 360 | return NULL; |
b2c19614 | 361 | } |
7ce7775c | 362 | |
38ff5046 | 363 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
6a15597a | 364 | g_free(di->dec_channelmap); |
0bdadba2 BV |
365 | g_free(di); |
366 | return NULL; | |
367 | } | |
b2c19614 | 368 | |
f38ec285 | 369 | /* Instance takes input from a frontend by default. */ |
32cfb920 | 370 | sess->di_list = g_slist_append(sess->di_list, di); |
f38ec285 | 371 | |
b2c19614 BV |
372 | return di; |
373 | } | |
374 | ||
582c8473 BV |
375 | /** |
376 | * Stack a decoder instance on top of another. | |
377 | * | |
32cfb920 | 378 | * @param sess The session holding the protocol decoder instances. |
4d2c7619 BV |
379 | * @param di_bottom The instance on top of which di_top will be stacked. |
380 | * @param di_top The instance to go on top. | |
582c8473 BV |
381 | * |
382 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 383 | * |
69075817 | 384 | * @since 0.3.0 |
582c8473 | 385 | */ |
32cfb920 | 386 | SRD_API int srd_inst_stack(struct srd_session *sess, |
4d2c7619 BV |
387 | struct srd_decoder_inst *di_bottom, |
388 | struct srd_decoder_inst *di_top) | |
7ce7775c | 389 | { |
32cfb920 BV |
390 | |
391 | if (session_is_valid(sess) != SRD_OK) { | |
392 | srd_err("Invalid session."); | |
393 | return SRD_ERR_ARG; | |
394 | } | |
395 | ||
4d2c7619 | 396 | if (!di_bottom || !di_top) { |
d906d3f9 | 397 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
398 | return SRD_ERR_ARG; |
399 | } | |
400 | ||
4d2c7619 | 401 | if (g_slist_find(sess->di_list, di_top)) { |
2072ae0c | 402 | /* Remove from the unstacked list. */ |
4d2c7619 | 403 | sess->di_list = g_slist_remove(sess->di_list, di_top); |
7ce7775c BV |
404 | } |
405 | ||
7ce7775c | 406 | /* Stack on top of source di. */ |
4d2c7619 BV |
407 | di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top); |
408 | ||
d841d5b2 | 409 | srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id); |
7ce7775c BV |
410 | |
411 | return SRD_OK; | |
412 | } | |
413 | ||
2072ae0c | 414 | /** |
361fdcaa UH |
415 | * Find a decoder instance by its instance ID. |
416 | * | |
417 | * Only the bottom level of instances are searched -- instances already stacked | |
418 | * on top of another one will not be found. | |
2072ae0c | 419 | * |
32cfb920 | 420 | * @param sess The session holding the protocol decoder instance. |
ed2306a6 | 421 | * @param inst_id The instance ID to be found. |
2072ae0c | 422 | * |
a8b72b05 | 423 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 | 424 | * |
69075817 | 425 | * @since 0.3.0 |
2072ae0c | 426 | */ |
32cfb920 BV |
427 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, |
428 | const char *inst_id) | |
7ce7775c BV |
429 | { |
430 | GSList *l; | |
a8b72b05 | 431 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 432 | |
32cfb920 BV |
433 | if (session_is_valid(sess) != SRD_OK) { |
434 | srd_err("Invalid session."); | |
435 | return NULL; | |
436 | } | |
437 | ||
7ce7775c | 438 | di = NULL; |
32cfb920 | 439 | for (l = sess->di_list; l; l = l->next) { |
7ce7775c | 440 | tmp = l->data; |
a8b72b05 | 441 | if (!strcmp(tmp->inst_id, inst_id)) { |
7ce7775c BV |
442 | di = tmp; |
443 | break; | |
444 | } | |
445 | } | |
446 | ||
447 | return di; | |
448 | } | |
449 | ||
32cfb920 BV |
450 | static struct srd_decoder_inst *srd_sess_inst_find_by_obj( |
451 | struct srd_session *sess, const GSList *stack, | |
452 | const PyObject *obj) | |
453 | { | |
454 | const GSList *l; | |
455 | struct srd_decoder_inst *tmp, *di; | |
456 | ||
457 | if (session_is_valid(sess) != SRD_OK) { | |
458 | srd_err("Invalid session."); | |
459 | return NULL; | |
460 | } | |
461 | ||
462 | di = NULL; | |
463 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
464 | tmp = l->data; | |
465 | if (tmp->py_inst == obj) | |
466 | di = tmp; | |
467 | else if (tmp->next_di) | |
468 | di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); | |
469 | } | |
470 | ||
471 | return di; | |
472 | } | |
473 | ||
2072ae0c | 474 | /** |
361fdcaa UH |
475 | * Find a decoder instance by its Python object. |
476 | * | |
477 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
32cfb920 BV |
478 | * This will recurse to find the instance anywhere in the stack tree of all |
479 | * sessions. | |
2072ae0c | 480 | * |
361fdcaa UH |
481 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the |
482 | * stack to search. To start searching at the bottom level of | |
483 | * decoder instances, pass NULL. | |
511e2123 | 484 | * @param obj The Python class instantiation. |
2072ae0c | 485 | * |
a8b72b05 | 486 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
57790bc8 UH |
487 | * |
488 | * @private | |
8c664ca2 UH |
489 | * |
490 | * @since 0.1.0 | |
2072ae0c | 491 | */ |
abeeed8b | 492 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
0ff2d191 | 493 | const PyObject *obj) |
2072ae0c | 494 | { |
32cfb920 BV |
495 | struct srd_decoder_inst *di; |
496 | struct srd_session *sess; | |
497 | GSList *l; | |
2072ae0c BV |
498 | |
499 | di = NULL; | |
32cfb920 BV |
500 | for (l = sessions; di == NULL && l != NULL; l = l->next) { |
501 | sess = l->data; | |
502 | di = srd_sess_inst_find_by_obj(sess, stack, obj); | |
2072ae0c BV |
503 | } |
504 | ||
505 | return di; | |
506 | } | |
507 | ||
57790bc8 | 508 | /** @private */ |
ed416497 | 509 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) |
b2c19614 | 510 | { |
ed416497 | 511 | PyObject *py_res; |
2072ae0c | 512 | GSList *l; |
a8b72b05 | 513 | struct srd_decoder_inst *next_di; |
ed416497 | 514 | int ret; |
b2c19614 | 515 | |
7a1712c4 | 516 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
ed416497 | 517 | di->inst_id); |
b2c19614 | 518 | |
ed416497 | 519 | if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { |
aafeeaea | 520 | srd_exception_catch("Protocol decoder instance %s: ", |
ed416497 | 521 | di->inst_id); |
7ce7775c BV |
522 | return SRD_ERR_PYTHON; |
523 | } | |
f38ec285 | 524 | Py_DecRef(py_res); |
7ce7775c | 525 | |
ed416497 | 526 | /* Start all the PDs stacked on top of this one. */ |
2072ae0c BV |
527 | for (l = di->next_di; l; l = l->next) { |
528 | next_di = l->data; | |
ed416497 BV |
529 | if ((ret = srd_inst_start(next_di)) != SRD_OK) |
530 | return ret; | |
2072ae0c BV |
531 | } |
532 | ||
b2c19614 BV |
533 | return SRD_OK; |
534 | } | |
535 | ||
b2c19614 BV |
536 | /** |
537 | * Run the specified decoder function. | |
538 | * | |
ed416497 | 539 | * @param di The decoder instance to call. Must not be NULL. |
d906d3f9 | 540 | * @param start_samplenum The starting sample number for the buffer's sample |
7a1712c4 | 541 | * set, relative to the start of capture. |
ed416497 BV |
542 | * @param end_samplenum The ending sample number for the buffer's sample |
543 | * set, relative to the start of capture. | |
7a1712c4 UH |
544 | * @param inbuf The buffer to decode. Must not be NULL. |
545 | * @param inbuflen Length of the buffer. Must be > 0. | |
b2c19614 BV |
546 | * |
547 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
548 | * |
549 | * @private | |
8c664ca2 UH |
550 | * |
551 | * @since 0.1.0 | |
b2c19614 | 552 | */ |
ed416497 BV |
553 | SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, |
554 | uint64_t start_samplenum, uint64_t end_samplenum, | |
555 | const uint8_t *inbuf, uint64_t inbuflen) | |
b2c19614 | 556 | { |
d906d3f9 | 557 | PyObject *py_res; |
bc5f5a43 | 558 | srd_logic *logic; |
b2c19614 | 559 | |
fbff319f UH |
560 | srd_dbg("Calling decode(), start sample %" PRIu64 ", end sample %" |
561 | PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = " | |
562 | "%d), instance %s.", start_samplenum, end_samplenum, | |
563 | end_samplenum - start_samplenum, inbuflen, di->data_unitsize, | |
564 | di->inst_id); | |
b2c19614 | 565 | |
d906d3f9 | 566 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
567 | if (!di) { |
568 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
569 | return SRD_ERR_ARG; |
570 | } | |
7a1712c4 UH |
571 | if (!inbuf) { |
572 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
573 | return SRD_ERR_ARG; |
574 | } | |
575 | if (inbuflen == 0) { | |
7a1712c4 | 576 | srd_dbg("empty buffer"); |
d906d3f9 BV |
577 | return SRD_ERR_ARG; |
578 | } | |
b2c19614 | 579 | |
361fdcaa UH |
580 | /* |
581 | * Create new srd_logic object. Each iteration around the PD's loop | |
d906d3f9 BV |
582 | * will fill one sample into this object. |
583 | */ | |
bc5f5a43 BV |
584 | logic = PyObject_New(srd_logic, &srd_logic_type); |
585 | Py_INCREF(logic); | |
abeeed8b | 586 | logic->di = (struct srd_decoder_inst *)di; |
86528298 | 587 | logic->start_samplenum = start_samplenum; |
bc5f5a43 | 588 | logic->itercnt = 0; |
abeeed8b | 589 | logic->inbuf = (uint8_t *)inbuf; |
bc5f5a43 BV |
590 | logic->inbuflen = inbuflen; |
591 | logic->sample = PyList_New(2); | |
592 | Py_INCREF(logic->sample); | |
593 | ||
a8b72b05 | 594 | Py_IncRef(di->py_inst); |
a8b72b05 | 595 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", |
ed416497 | 596 | "KKO", start_samplenum, end_samplenum, logic))) { |
d841d5b2 UH |
597 | srd_exception_catch("Protocol decoder instance %s: ", |
598 | di->inst_id); | |
0ff2d191 | 599 | return SRD_ERR_PYTHON; |
b2c19614 | 600 | } |
d906d3f9 | 601 | Py_DecRef(py_res); |
bc5f5a43 | 602 | |
b2c19614 BV |
603 | return SRD_OK; |
604 | } | |
605 | ||
57790bc8 | 606 | /** @private */ |
12243c22 | 607 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
608 | { |
609 | GSList *l; | |
610 | struct srd_pd_output *pdo; | |
611 | ||
a8b72b05 | 612 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 613 | |
a8b72b05 BV |
614 | Py_DecRef(di->py_inst); |
615 | g_free(di->inst_id); | |
6a15597a | 616 | g_free(di->dec_channelmap); |
fa12a21e BV |
617 | g_slist_free(di->next_di); |
618 | for (l = di->pd_output; l; l = l->next) { | |
619 | pdo = l->data; | |
620 | g_free(pdo->proto_id); | |
621 | g_free(pdo); | |
622 | } | |
623 | g_slist_free(di->pd_output); | |
e592ac89 | 624 | g_free(di); |
fa12a21e BV |
625 | } |
626 | ||
57790bc8 | 627 | /** @private */ |
32cfb920 | 628 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) |
fa12a21e BV |
629 | { |
630 | GSList *l; | |
a8b72b05 | 631 | struct srd_decoder_inst *di; |
fa12a21e | 632 | |
32cfb920 BV |
633 | if (session_is_valid(sess) != SRD_OK) { |
634 | srd_err("Invalid session."); | |
635 | return; | |
636 | } | |
637 | ||
fa12a21e | 638 | di = NULL; |
32cfb920 | 639 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { |
fa12a21e BV |
640 | di = l->data; |
641 | if (di->next_di) | |
32cfb920 | 642 | srd_inst_free_all(sess, di->next_di); |
a8b72b05 | 643 | srd_inst_free(di); |
fa12a21e BV |
644 | } |
645 | if (!stack) { | |
32cfb920 BV |
646 | g_slist_free(sess->di_list); |
647 | sess->di_list = NULL; | |
fa12a21e | 648 | } |
fa12a21e | 649 | } |
b2c19614 | 650 | |
4895418c | 651 | /** @} */ |