dda0de28a2aab2fd9c6a991604eabeb031d49ed2
[libsigrokdecode.git] / type_decoder.c
1 /*
2  * This file is part of the libsigrokdecode 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 <config.h>
21 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode.h"
23 #include <inttypes.h>
24
25 typedef struct {
26         PyObject_HEAD
27 } srd_Decoder;
28
29 /* This is only used for nicer srd_dbg() output.
30  */
31 static const char *output_type_name(unsigned int idx)
32 {
33         static const char names[][16] = {
34                 "OUTPUT_ANN",
35                 "OUTPUT_PYTHON",
36                 "OUTPUT_BINARY",
37                 "OUTPUT_META",
38                 "(invalid)"
39         };
40         return names[MIN(idx, G_N_ELEMENTS(names) - 1)];
41 }
42
43 static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
44                 struct srd_proto_data *pdata)
45 {
46         PyObject *py_tmp;
47         struct srd_pd_output *pdo;
48         struct srd_proto_data_annotation *pda;
49         int ann_class;
50         char **ann_text;
51
52         /* Should be a list of [annotation class, [string, ...]]. */
53         if (!PyList_Check(obj)) {
54                 srd_err("Protocol decoder %s submitted an annotation that"
55                         " is not a list", di->decoder->name);
56                 return SRD_ERR_PYTHON;
57         }
58
59         /* Should have 2 elements. */
60         if (PyList_Size(obj) != 2) {
61                 srd_err("Protocol decoder %s submitted annotation list with "
62                         "%zd elements instead of 2", di->decoder->name,
63                         PyList_Size(obj));
64                 return SRD_ERR_PYTHON;
65         }
66
67         /*
68          * The first element should be an integer matching a previously
69          * registered annotation class.
70          */
71         py_tmp = PyList_GetItem(obj, 0);
72         if (!PyLong_Check(py_tmp)) {
73                 srd_err("Protocol decoder %s submitted annotation list, but "
74                         "first element was not an integer.", di->decoder->name);
75                 return SRD_ERR_PYTHON;
76         }
77         ann_class = PyLong_AsLong(py_tmp);
78         if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
79                 srd_err("Protocol decoder %s submitted data to unregistered "
80                         "annotation class %d.", di->decoder->name, ann_class);
81                 return SRD_ERR_PYTHON;
82         }
83
84         /* Second element must be a list. */
85         py_tmp = PyList_GetItem(obj, 1);
86         if (!PyList_Check(py_tmp)) {
87                 srd_err("Protocol decoder %s submitted annotation list, but "
88                         "second element was not a list.", di->decoder->name);
89                 return SRD_ERR_PYTHON;
90         }
91         if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
92                 srd_err("Protocol decoder %s submitted annotation list, but "
93                         "second element was malformed.", di->decoder->name);
94                 return SRD_ERR_PYTHON;
95         }
96
97         pda = g_malloc(sizeof(struct srd_proto_data_annotation));
98         pda->ann_class = ann_class;
99         pda->ann_text = ann_text;
100         pdata->data = pda;
101
102         return SRD_OK;
103 }
104
105 static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
106                 struct srd_proto_data *pdata)
107 {
108         struct srd_proto_data_binary *pdb;
109         PyObject *py_tmp;
110         Py_ssize_t size;
111         int bin_class;
112         char *class_name, *buf;
113
114         /* Should be a list of [binary class, bytes]. */
115         if (!PyList_Check(obj)) {
116                 srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.",
117                         di->decoder->name);
118                 return SRD_ERR_PYTHON;
119         }
120
121         /* Should have 2 elements. */
122         if (PyList_Size(obj) != 2) {
123                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list "
124                                 "with %zd elements instead of 2", di->decoder->name,
125                                 PyList_Size(obj));
126                 return SRD_ERR_PYTHON;
127         }
128
129         /* The first element should be an integer. */
130         py_tmp = PyList_GetItem(obj, 0);
131         if (!PyLong_Check(py_tmp)) {
132                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
133                         "but first element was not an integer.", di->decoder->name);
134                 return SRD_ERR_PYTHON;
135         }
136         bin_class = PyLong_AsLong(py_tmp);
137         if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
138                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
139                         "unregistered binary class %d.", di->decoder->name, bin_class);
140                 return SRD_ERR_PYTHON;
141         }
142
143         /* Second element should be bytes. */
144         py_tmp = PyList_GetItem(obj, 1);
145         if (!PyBytes_Check(py_tmp)) {
146                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
147                         "but second element was not bytes.", di->decoder->name);
148                 return SRD_ERR_PYTHON;
149         }
150
151         /* Consider an empty set of bytes a bug. */
152         if (PyBytes_Size(py_tmp) == 0) {
153                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
154                                 "with empty data set.", di->decoder->name);
155                 return SRD_ERR_PYTHON;
156         }
157
158         pdb = g_malloc(sizeof(struct srd_proto_data_binary));
159         if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
160                 return SRD_ERR_PYTHON;
161         pdb->bin_class = bin_class;
162         pdb->size = size;
163         if (!(pdb->data = g_try_malloc(pdb->size)))
164                 return SRD_ERR_MALLOC;
165         memcpy((void *)pdb->data, (const void *)buf, pdb->size);
166         pdata->data = pdb;
167
168         return SRD_OK;
169 }
170
171 static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
172 {
173         long long intvalue;
174         double dvalue;
175
176         if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) {
177                 if (!PyLong_Check(obj)) {
178                         PyErr_Format(PyExc_TypeError, "This output was registered "
179                                         "as 'int', but something else was passed.");
180                         return SRD_ERR_PYTHON;
181                 }
182                 intvalue = PyLong_AsLongLong(obj);
183                 if (PyErr_Occurred())
184                         return SRD_ERR_PYTHON;
185                 pdata->data = g_variant_new_int64(intvalue);
186         } else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) {
187                 if (!PyFloat_Check(obj)) {
188                         PyErr_Format(PyExc_TypeError, "This output was registered "
189                                         "as 'float', but something else was passed.");
190                         return SRD_ERR_PYTHON;
191                 }
192                 dvalue = PyFloat_AsDouble(obj);
193                 if (PyErr_Occurred())
194                         return SRD_ERR_PYTHON;
195                 pdata->data = g_variant_new_double(dvalue);
196         }
197
198         return SRD_OK;
199 }
200
201 static PyObject *Decoder_put(PyObject *self, PyObject *args)
202 {
203         GSList *l;
204         PyObject *py_data, *py_res;
205         struct srd_decoder_inst *di, *next_di;
206         struct srd_pd_output *pdo;
207         struct srd_proto_data *pdata;
208         uint64_t start_sample, end_sample;
209         int output_id;
210         struct srd_pd_callback *cb;
211
212         if (!(di = srd_inst_find_by_obj(NULL, self))) {
213                 /* Shouldn't happen. */
214                 srd_dbg("put(): self instance not found.");
215                 return NULL;
216         }
217
218         if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
219                 &output_id, &py_data)) {
220                 /*
221                  * This throws an exception, but by returning NULL here we let
222                  * Python raise it. This results in a much better trace in
223                  * controller.c on the decode() method call.
224                  */
225                 return NULL;
226         }
227
228         if (!(l = g_slist_nth(di->pd_output, output_id))) {
229                 srd_err("Protocol decoder %s submitted invalid output ID %d.",
230                         di->decoder->name, output_id);
231                 return NULL;
232         }
233         pdo = l->data;
234
235         srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
236                  di->inst_id, start_sample, end_sample,
237                  output_type_name(pdo->output_type), output_id);
238
239         pdata = g_malloc0(sizeof(struct srd_proto_data));
240         pdata->start_sample = start_sample;
241         pdata->end_sample = end_sample;
242         pdata->pdo = pdo;
243
244         switch (pdo->output_type) {
245         case SRD_OUTPUT_ANN:
246                 /* Annotations are only fed to callbacks. */
247                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
248                         /* Convert from PyDict to srd_proto_data_annotation. */
249                         if (convert_annotation(di, py_data, pdata) != SRD_OK) {
250                                 /* An error was already logged. */
251                                 break;
252                         }
253                         cb->cb(pdata, cb->cb_data);
254                 }
255                 break;
256         case SRD_OUTPUT_PYTHON:
257                 for (l = di->next_di; l; l = l->next) {
258                         next_di = l->data;
259                         srd_spew("Sending %" PRIu64 "-%" PRIu64 " to instance %s",
260                                  start_sample, end_sample, next_di->inst_id);
261                         if (!(py_res = PyObject_CallMethod(
262                                 next_di->py_inst, "decode", "KKO", start_sample,
263                                 end_sample, py_data))) {
264                                 srd_exception_catch("Calling %s decode() failed",
265                                                         next_di->inst_id);
266                         }
267                         Py_XDECREF(py_res);
268                 }
269                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
270                         /* Frontends aren't really supposed to get Python
271                          * callbacks, but it's useful for testing. */
272                         pdata->data = py_data;
273                         cb->cb(pdata, cb->cb_data);
274                 }
275                 break;
276         case SRD_OUTPUT_BINARY:
277                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
278                         /* Convert from PyDict to srd_proto_data_binary. */
279                         if (convert_binary(di, py_data, pdata) != SRD_OK) {
280                                 /* An error was already logged. */
281                                 break;
282                         }
283                         cb->cb(pdata, cb->cb_data);
284                 }
285                 break;
286         case SRD_OUTPUT_META:
287                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
288                         /* Annotations need converting from PyObject. */
289                         if (convert_meta(pdata, py_data) != SRD_OK) {
290                                 /* An exception was already set up. */
291                                 break;
292                         }
293                         cb->cb(pdata, cb->cb_data);
294                 }
295                 break;
296         default:
297                 srd_err("Protocol decoder %s submitted invalid output type %d.",
298                         di->decoder->name, pdo->output_type);
299                 break;
300         }
301
302         g_free(pdata);
303
304         Py_RETURN_NONE;
305 }
306
307 static PyObject *Decoder_register(PyObject *self, PyObject *args,
308                 PyObject *kwargs)
309 {
310         struct srd_decoder_inst *di;
311         struct srd_pd_output *pdo;
312         PyObject *py_new_output_id;
313         PyTypeObject *meta_type_py;
314         const GVariantType *meta_type_gv;
315         int output_type;
316         char *proto_id, *meta_name, *meta_descr;
317         char *keywords[] = {"output_type", "proto_id", "meta", NULL};
318
319         meta_type_py = NULL;
320         meta_type_gv = NULL;
321         meta_name = meta_descr = NULL;
322
323         if (!(di = srd_inst_find_by_obj(NULL, self))) {
324                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
325                 return NULL;
326         }
327
328         /* Default to instance id, which defaults to class id. */
329         proto_id = di->inst_id;
330         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
331                         &output_type, &proto_id,
332                         &meta_type_py, &meta_name, &meta_descr)) {
333                 /* Let Python raise this exception. */
334                 return NULL;
335         }
336
337         /* Check if the meta value's type is supported. */
338         if (output_type == SRD_OUTPUT_META) {
339                 if (meta_type_py == &PyLong_Type)
340                         meta_type_gv = G_VARIANT_TYPE_INT64;
341                 else if (meta_type_py == &PyFloat_Type)
342                         meta_type_gv = G_VARIANT_TYPE_DOUBLE;
343                 else {
344                         PyErr_Format(PyExc_TypeError, "Unsupported type.");
345                         return NULL;
346                 }
347         }
348
349         srd_dbg("Instance %s creating new output type %d for %s.",
350                 di->inst_id, output_type, proto_id);
351
352         pdo = g_malloc(sizeof(struct srd_pd_output));
353
354         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
355         pdo->pdo_id = g_slist_length(di->pd_output);
356         pdo->output_type = output_type;
357         pdo->di = di;
358         pdo->proto_id = g_strdup(proto_id);
359
360         if (output_type == SRD_OUTPUT_META) {
361                 pdo->meta_type = meta_type_gv;
362                 pdo->meta_name = g_strdup(meta_name);
363                 pdo->meta_descr = g_strdup(meta_descr);
364         }
365
366         di->pd_output = g_slist_append(di->pd_output, pdo);
367         py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
368
369         return py_new_output_id;
370 }
371
372 static int get_term_type(const char *v)
373 {
374         switch (v[0]) {
375         case 'h':
376                 return SRD_TERM_HIGH;
377         case 'l':
378                 return SRD_TERM_LOW;
379         case 'r':
380                 return SRD_TERM_RISING_EDGE;
381         case 'f':
382                 return SRD_TERM_FALLING_EDGE;
383         case 'e':
384                 return SRD_TERM_EITHER_EDGE;
385         case 'n':
386                 return SRD_TERM_NO_EDGE;
387         }
388
389         return -1;
390 }
391
392 /**
393  * Get the pin values at the current sample number.
394  *
395  * @param di The decoder instance to use. Must not be NULL.
396  *           The number of channels must be >= 1.
397  *
398  * @return A newly allocated PyTuple containing the pin values at the
399  *         current sample number.
400  */
401 static PyObject *get_current_pinvalues(const struct srd_decoder_inst *di)
402 {
403         int i;
404         uint8_t sample;
405         const uint8_t *sample_pos;
406         int byte_offset, bit_offset;
407         PyObject *py_pinvalues;
408
409         if (!di) {
410                 srd_err("Invalid decoder instance.");
411                 return NULL;
412         }
413
414         py_pinvalues = PyTuple_New(di->dec_num_channels);
415
416         for (i = 0; i < di->dec_num_channels; i++) {
417                 /* A channelmap value of -1 means "unused optional channel". */
418                 if (di->dec_channelmap[i] == -1) {
419                         /* Value of unused channel is 0xff, instead of 0 or 1. */
420                         PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(0xff));
421                 } else {
422                         sample_pos = di->inbuf + ((di->cur_samplenum - di->start_samplenum) * di->data_unitsize);
423                         byte_offset = di->dec_channelmap[i] / 8;
424                         bit_offset = di->dec_channelmap[i] % 8;
425                         sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
426                         PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(sample));
427                 }
428         }
429
430         Py_IncRef(py_pinvalues);
431
432         return py_pinvalues;
433 }
434
435 /**
436  * Create a list of terms in the specified condition.
437  *
438  * If there are no terms in the condition, 'term_list' will be NULL.
439  *
440  * @param py_dict A Python dict containing terms. Must not be NULL.
441  * @param term_list Pointer to a GSList which will be set to the newly
442  *                  created list of terms. Must not be NULL.
443  *
444  * @return SRD_OK upon success, a negative error code otherwise.
445  */
446 static int create_term_list(PyObject *py_dict, GSList **term_list)
447 {
448         Py_ssize_t pos = 0;
449         PyObject *py_key, *py_value;
450         struct srd_term *term;
451         uint64_t num_samples_to_skip;
452         char *term_str;
453
454         if (!py_dict || !term_list)
455                 return SRD_ERR_ARG;
456
457         /* "Create" an empty GSList of terms. */
458         *term_list = NULL;
459
460         /* Iterate over all items in the current dict. */
461         while (PyDict_Next(py_dict, &pos, &py_key, &py_value)) {
462                 /* Check whether the current key is a string or a number. */
463                 if (PyLong_Check(py_key)) {
464                         /* The key is a number. */
465                         /* TODO: Check if the number is a valid channel. */
466                         /* Get the value string. */
467                         if ((py_pydictitem_as_str(py_dict, py_key, &term_str)) != SRD_OK) {
468                                 srd_err("Failed to get the value.");
469                                 return SRD_ERR;
470                         }
471                         term = g_malloc0(sizeof(struct srd_term));
472                         term->type = get_term_type(term_str);
473                         term->channel = PyLong_AsLong(py_key);
474                         g_free(term_str);
475                 } else if (PyUnicode_Check(py_key)) {
476                         /* The key is a string. */
477                         /* TODO: Check if it's "skip". */
478                         if ((py_pydictitem_as_long(py_dict, py_key, &num_samples_to_skip)) != SRD_OK) {
479                                 srd_err("Failed to get number of samples to skip.");
480                                 return SRD_ERR;
481                         }
482                         term = g_malloc0(sizeof(struct srd_term));
483                         term->type = SRD_TERM_SKIP;
484                         term->num_samples_to_skip = num_samples_to_skip;
485                         term->num_samples_already_skipped = 0;
486                 } else {
487                         srd_err("Term key is neither a string nor a number.");
488                         return SRD_ERR;
489                 }
490
491                 /* Add the term to the list of terms. */
492                 *term_list = g_slist_append(*term_list, term);
493         }
494
495         return SRD_OK;
496 }
497
498 /**
499  * Replace the current condition list with the new one.
500  *
501  * @param self TODO. Must not be NULL.
502  * @param args TODO. Must not be NULL.
503  *
504  * @retval SRD_OK The new condition list was set successfully.
505  * @retval SRD_ERR There was an error setting the new condition list.
506  *                 The contents of di->condition_list are undefined.
507  * @retval 9999 TODO.
508  */
509 static int set_new_condition_list(PyObject *self, PyObject *args)
510 {
511         struct srd_decoder_inst *di;
512         GSList *term_list;
513         PyObject *py_conditionlist, *py_conds, *py_dict;
514         int i, num_conditions, ret;
515
516         if (!self || !args)
517                 return SRD_ERR_ARG;
518
519         /* Get the decoder instance. */
520         if (!(di = srd_inst_find_by_obj(NULL, self))) {
521                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
522                 return SRD_ERR;
523         }
524
525         /* Parse the argument of self.wait() into 'py_conds'. */
526         if (!PyArg_ParseTuple(args, "O", &py_conds)) {
527                 /* Let Python raise this exception. */
528                 return SRD_ERR;
529         }
530
531         /* Check whether 'py_conds' is a dict or a list. */
532         if (PyList_Check(py_conds)) {
533                 /* 'py_conds' is a list. */
534                 py_conditionlist = py_conds;
535                 num_conditions = PyList_Size(py_conditionlist);
536                 if (num_conditions == 0)
537                         return 9999; /* The PD invoked self.wait([]). */
538         } else if (PyDict_Check(py_conds)) {
539                 /* 'py_conds' is a dict. */
540                 if (PyDict_Size(py_conds) == 0)
541                         return 9999; /* The PD invoked self.wait({}). */
542                 /* Make a list and put the dict in there for convenience. */
543                 py_conditionlist = PyList_New(1);
544                 PyList_SetItem(py_conditionlist, 0, py_conds);
545                 num_conditions = 1;
546         } else {
547                 srd_err("Condition list is neither a list nor a dict.");
548                 return SRD_ERR;
549         }
550
551         /* Free the old condition list. */
552         condition_list_free(di);
553
554         ret = SRD_OK;
555
556         /* Iterate over the conditions, set di->condition_list accordingly. */
557         for (i = 0; i < num_conditions; i++) {
558                 /* Get a condition (dict) from the condition list. */
559                 py_dict = PyList_GetItem(py_conditionlist, i);
560                 if (!PyDict_Check(py_dict)) {
561                         srd_err("Condition is not a dict.");
562                         ret = SRD_ERR;
563                         break;
564                 }
565
566                 /* Create the list of terms in this condition. */
567                 if ((ret = create_term_list(py_dict, &term_list)) < 0)
568                         break;
569
570                 /* Add the new condition to the PD instance's condition list. */
571                 di->condition_list = g_slist_append(di->condition_list, term_list);
572         }
573
574         Py_DecRef(py_conditionlist);
575
576         return ret;
577 }
578
579 static PyObject *Decoder_wait(PyObject *self, PyObject *args)
580 {
581         int ret;
582         unsigned int i;
583         gboolean found_match;
584         struct srd_decoder_inst *di;
585         PyObject *py_pinvalues, *py_matched;
586
587         if (!self || !args)
588                 return NULL;
589
590         if (!(di = srd_inst_find_by_obj(NULL, self))) {
591                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
592                 Py_RETURN_NONE;
593         }
594
595         ret = set_new_condition_list(self, args);
596
597         if (ret == 9999) {
598                 /* Empty condition list, automatic match. */
599                 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
600                 /* Leave self.samplenum unchanged (== di->cur_samplenum). */
601                 return get_current_pinvalues(di);
602         }
603
604         while (1) {
605                 /* Wait for new samples to process. */
606                 g_mutex_lock(&di->data_mutex);
607                 while (!di->got_new_samples)
608                         g_cond_wait(&di->got_new_samples_cond, &di->data_mutex);
609
610                 /* Check whether any of the current condition(s) match. */
611                 ret = process_samples_until_condition_match(di, &found_match);
612
613                 /* If there's a match, set self.samplenum etc. and return. */
614                 if (found_match) {
615                         /* Set self.samplenum to the (absolute) sample number that matched. */
616                         PyObject_SetAttrString(di->py_inst, "samplenum",
617                                 PyLong_FromLong(di->cur_samplenum));
618
619                         if (di->match_array && di->match_array->len > 0) {
620                                 py_matched = PyTuple_New(di->match_array->len);
621                                 for (i = 0; i < di->match_array->len; i++)
622                                         PyTuple_SetItem(py_matched, i, PyBool_FromLong(di->match_array->data[i]));
623                                 PyObject_SetAttrString(di->py_inst, "matched", py_matched);
624                                 match_array_free(di);
625                         } else {
626                                 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
627                         }
628         
629                         py_pinvalues = get_current_pinvalues(di);
630
631                         g_mutex_unlock(&di->data_mutex);
632
633                         return py_pinvalues;
634                 }
635
636                 /* No match, reset state for the next chunk. */
637                 di->got_new_samples = FALSE;
638                 di->handled_all_samples = TRUE;
639                 di->start_samplenum = 0;
640                 di->end_samplenum = 0;
641                 di->inbuf = NULL;
642                 di->inbuflen = 0;
643
644                 /* Signal the main thread that we handled all samples. */
645                 g_cond_signal(&di->handled_all_samples_cond);
646
647                 g_mutex_unlock(&di->data_mutex);
648         }
649
650         Py_RETURN_NONE;
651 }
652
653 /**
654  * Return whether the specified channel was supplied to the decoder.
655  *
656  * @param self TODO. Must not be NULL.
657  * @param args TODO. Must not be NULL.
658  *
659  * @retval Py_True The channel has been supplied by the frontend.
660  * @retval Py_False The channel has been supplied by the frontend.
661  * @retval NULL An error occurred.
662  */
663 static PyObject *Decoder_has_channel(PyObject *self, PyObject *args)
664 {
665         int idx, max_idx;
666         struct srd_decoder_inst *di;
667         PyObject *py_channel;
668
669         if (!self || !args)
670                 return NULL;
671
672         if (!(di = srd_inst_find_by_obj(NULL, self))) {
673                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
674                 return NULL;
675         }
676
677         /* Parse the argument of self.has_channel() into 'py_channel'. */
678         if (!PyArg_ParseTuple(args, "O", &py_channel)) {
679                 /* Let Python raise this exception. */
680                 return NULL;
681         }
682
683         if (!PyLong_Check(py_channel)) {
684                 PyErr_SetString(PyExc_Exception, "channel index not a number");
685                 return NULL;
686         }
687
688         idx = PyLong_AsLong(py_channel);
689         max_idx = g_slist_length(di->decoder->channels)
690                 + g_slist_length(di->decoder->opt_channels) - 1;
691
692         if (idx < 0 || idx > max_idx) {
693                 srd_err("Invalid channel index %d/%d.", idx, max_idx);
694                 PyErr_SetString(PyExc_Exception, "invalid channel");
695                 return NULL;
696         }
697
698         return (di->dec_channelmap[idx] == -1) ? Py_False : Py_True;
699 }
700
701 static PyMethodDef Decoder_methods[] = {
702         {"put", Decoder_put, METH_VARARGS,
703          "Accepts a dictionary with the following keys: startsample, endsample, data"},
704         {"register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
705                         "Register a new output stream"},
706         {"wait", Decoder_wait, METH_VARARGS,
707                         "Wait for one or more conditions to occur"},
708         {"has_channel", Decoder_has_channel, METH_VARARGS,
709                         "Report whether a channel was supplied"},
710         {NULL, NULL, 0, NULL}
711 };
712
713 /**
714  * Create the sigrokdecode.Decoder type.
715  *
716  * @return The new type object.
717  *
718  * @private
719  */
720 SRD_PRIV PyObject *srd_Decoder_type_new(void)
721 {
722         PyType_Spec spec;
723         PyType_Slot slots[] = {
724                 { Py_tp_doc, "sigrok Decoder base class" },
725                 { Py_tp_methods, Decoder_methods },
726                 { Py_tp_new, (void *)&PyType_GenericNew },
727                 { 0, NULL }
728         };
729         spec.name = "sigrokdecode.Decoder";
730         spec.basicsize = sizeof(srd_Decoder);
731         spec.itemsize = 0;
732         spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
733         spec.slots = slots;
734
735         return PyType_FromSpec(&spec);
736 }