2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode.h"
29 /* This is only used for nicer srd_dbg() output. */
30 static const char *output_type_name(unsigned int idx)
32 static const char names[][16] = {
40 return names[MIN(idx, G_N_ELEMENTS(names) - 1)];
43 static void release_annotation(struct srd_proto_data_annotation *pda)
48 g_strfreev(pda->ann_text);
52 static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
53 struct srd_proto_data *pdata)
56 struct srd_pd_output *pdo;
57 struct srd_proto_data_annotation *pda;
60 PyGILState_STATE gstate;
62 gstate = PyGILState_Ensure();
64 /* Should be a list of [annotation class, [string, ...]]. */
65 if (!PyList_Check(obj)) {
66 srd_err("Protocol decoder %s submitted an annotation that"
67 " is not a list", di->decoder->name);
71 /* Should have 2 elements. */
72 if (PyList_Size(obj) != 2) {
73 srd_err("Protocol decoder %s submitted annotation list with "
74 "%zd elements instead of 2", di->decoder->name,
80 * The first element should be an integer matching a previously
81 * registered annotation class.
83 py_tmp = PyList_GetItem(obj, 0);
84 if (!PyLong_Check(py_tmp)) {
85 srd_err("Protocol decoder %s submitted annotation list, but "
86 "first element was not an integer.", di->decoder->name);
89 ann_class = PyLong_AsLong(py_tmp);
90 if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
91 srd_err("Protocol decoder %s submitted data to unregistered "
92 "annotation class %d.", di->decoder->name, ann_class);
96 /* Second element must be a list. */
97 py_tmp = PyList_GetItem(obj, 1);
98 if (!PyList_Check(py_tmp)) {
99 srd_err("Protocol decoder %s submitted annotation list, but "
100 "second element was not a list.", di->decoder->name);
103 if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
104 srd_err("Protocol decoder %s submitted annotation list, but "
105 "second element was malformed.", di->decoder->name);
109 pda = g_malloc(sizeof(struct srd_proto_data_annotation));
110 pda->ann_class = ann_class;
111 pda->ann_text = ann_text;
114 PyGILState_Release(gstate);
119 PyGILState_Release(gstate);
121 return SRD_ERR_PYTHON;
124 static void release_binary(struct srd_proto_data_binary *pdb)
128 g_free((void *)pdb->data);
132 static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
133 struct srd_proto_data *pdata)
135 struct srd_proto_data_binary *pdb;
139 char *class_name, *buf;
140 PyGILState_STATE gstate;
142 gstate = PyGILState_Ensure();
144 /* Should be a list of [binary class, bytes]. */
145 if (!PyList_Check(obj)) {
146 srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.",
151 /* Should have 2 elements. */
152 if (PyList_Size(obj) != 2) {
153 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list "
154 "with %zd elements instead of 2", di->decoder->name,
159 /* The first element should be an integer. */
160 py_tmp = PyList_GetItem(obj, 0);
161 if (!PyLong_Check(py_tmp)) {
162 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
163 "but first element was not an integer.", di->decoder->name);
166 bin_class = PyLong_AsLong(py_tmp);
167 if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
168 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
169 "unregistered binary class %d.", di->decoder->name, bin_class);
173 /* Second element should be bytes. */
174 py_tmp = PyList_GetItem(obj, 1);
175 if (!PyBytes_Check(py_tmp)) {
176 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
177 "but second element was not bytes.", di->decoder->name);
181 /* Consider an empty set of bytes a bug. */
182 if (PyBytes_Size(py_tmp) == 0) {
183 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
184 "with empty data set.", di->decoder->name);
188 if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
191 PyGILState_Release(gstate);
193 pdb = g_malloc(sizeof(struct srd_proto_data_binary));
194 pdb->bin_class = bin_class;
196 if (!(pdb->data = g_try_malloc(pdb->size))) {
198 return SRD_ERR_MALLOC;
200 memcpy((void *)pdb->data, (const void *)buf, pdb->size);
206 PyGILState_Release(gstate);
208 return SRD_ERR_PYTHON;
211 static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
215 PyGILState_STATE gstate;
217 gstate = PyGILState_Ensure();
219 if (g_variant_type_equal(pdata->pdo->meta_type, G_VARIANT_TYPE_INT64)) {
220 if (!PyLong_Check(obj)) {
221 PyErr_Format(PyExc_TypeError, "This output was registered "
222 "as 'int', but something else was passed.");
225 intvalue = PyLong_AsLongLong(obj);
226 if (PyErr_Occurred())
228 pdata->data = g_variant_new_int64(intvalue);
229 } else if (g_variant_type_equal(pdata->pdo->meta_type, G_VARIANT_TYPE_DOUBLE)) {
230 if (!PyFloat_Check(obj)) {
231 PyErr_Format(PyExc_TypeError, "This output was registered "
232 "as 'float', but something else was passed.");
235 dvalue = PyFloat_AsDouble(obj);
236 if (PyErr_Occurred())
238 pdata->data = g_variant_new_double(dvalue);
241 PyGILState_Release(gstate);
246 PyGILState_Release(gstate);
248 return SRD_ERR_PYTHON;
251 static void release_meta(GVariant *gvar)
255 g_variant_unref(gvar);
258 static PyObject *Decoder_put(PyObject *self, PyObject *args)
261 PyObject *py_data, *py_res;
262 struct srd_decoder_inst *di, *next_di;
263 struct srd_pd_output *pdo;
264 struct srd_proto_data pdata;
265 uint64_t start_sample, end_sample;
267 struct srd_pd_callback *cb;
268 PyGILState_STATE gstate;
272 gstate = PyGILState_Ensure();
274 if (!(di = srd_inst_find_by_obj(NULL, self))) {
275 /* Shouldn't happen. */
276 srd_dbg("put(): self instance not found.");
280 if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
281 &output_id, &py_data)) {
283 * This throws an exception, but by returning NULL here we let
284 * Python raise it. This results in a much better trace in
285 * controller.c on the decode() method call.
290 if (!(l = g_slist_nth(di->pd_output, output_id))) {
291 srd_err("Protocol decoder %s submitted invalid output ID %d.",
292 di->decoder->name, output_id);
297 srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
298 di->inst_id, start_sample, end_sample,
299 output_type_name(pdo->output_type), output_id);
301 pdata.start_sample = start_sample;
302 pdata.end_sample = end_sample;
306 switch (pdo->output_type) {
308 /* Annotations are only fed to callbacks. */
309 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
310 /* Convert from PyDict to srd_proto_data_annotation. */
311 if (convert_annotation(di, py_data, &pdata) != SRD_OK) {
312 /* An error was already logged. */
315 Py_BEGIN_ALLOW_THREADS
316 cb->cb(&pdata, cb->cb_data);
318 release_annotation(pdata.data);
321 case SRD_OUTPUT_PYTHON:
322 for (l = di->next_di; l; l = l->next) {
324 srd_spew("Sending %" PRIu64 "-%" PRIu64 " to instance %s",
325 start_sample, end_sample, next_di->inst_id);
326 if (!(py_res = PyObject_CallMethod(
327 next_di->py_inst, "decode", "KKO", start_sample,
328 end_sample, py_data))) {
329 srd_exception_catch("Calling %s decode() failed",
334 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
336 * Frontends aren't really supposed to get Python
337 * callbacks, but it's useful for testing.
339 pdata.data = py_data;
340 cb->cb(&pdata, cb->cb_data);
343 case SRD_OUTPUT_BINARY:
344 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
345 /* Convert from PyDict to srd_proto_data_binary. */
346 if (convert_binary(di, py_data, &pdata) != SRD_OK) {
347 /* An error was already logged. */
350 Py_BEGIN_ALLOW_THREADS
351 cb->cb(&pdata, cb->cb_data);
353 release_binary(pdata.data);
356 case SRD_OUTPUT_META:
357 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
358 /* Annotations need converting from PyObject. */
359 if (convert_meta(&pdata, py_data) != SRD_OK) {
360 /* An exception was already set up. */
363 Py_BEGIN_ALLOW_THREADS
364 cb->cb(&pdata, cb->cb_data);
366 release_meta(pdata.data);
370 srd_err("Protocol decoder %s submitted invalid output type %d.",
371 di->decoder->name, pdo->output_type);
375 PyGILState_Release(gstate);
380 PyGILState_Release(gstate);
385 static PyObject *Decoder_register(PyObject *self, PyObject *args,
388 struct srd_decoder_inst *di;
389 struct srd_pd_output *pdo;
390 PyObject *py_new_output_id;
391 PyTypeObject *meta_type_py;
392 const GVariantType *meta_type_gv;
394 char *proto_id, *meta_name, *meta_descr;
395 char *keywords[] = { "output_type", "proto_id", "meta", NULL };
396 PyGILState_STATE gstate;
399 struct srd_pd_output *cmp;
401 gstate = PyGILState_Ensure();
405 meta_name = meta_descr = NULL;
407 if (!(di = srd_inst_find_by_obj(NULL, self))) {
408 PyErr_SetString(PyExc_Exception, "decoder instance not found");
412 /* Default to instance ID, which defaults to class ID. */
413 proto_id = di->inst_id;
414 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
415 &output_type, &proto_id,
416 &meta_type_py, &meta_name, &meta_descr)) {
417 /* Let Python raise this exception. */
421 /* Check if the meta value's type is supported. */
422 is_meta = output_type == SRD_OUTPUT_META;
424 if (meta_type_py == &PyLong_Type)
425 meta_type_gv = G_VARIANT_TYPE_INT64;
426 else if (meta_type_py == &PyFloat_Type)
427 meta_type_gv = G_VARIANT_TYPE_DOUBLE;
429 PyErr_Format(PyExc_TypeError, "Unsupported type.");
435 for (l = di->pd_output; l; l = l->next) {
437 if (cmp->output_type != output_type)
439 if (strcmp(cmp->proto_id, proto_id) != 0)
441 if (is_meta && cmp->meta_type != meta_type_gv)
443 if (is_meta && strcmp(cmp->meta_name, meta_name) != 0)
445 if (is_meta && strcmp(cmp->meta_descr, meta_descr) != 0)
451 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
452 PyGILState_Release(gstate);
453 return py_new_output_id;
456 srd_dbg("Instance %s creating new output type %d for %s.",
457 di->inst_id, output_type, proto_id);
459 pdo = g_malloc(sizeof(struct srd_pd_output));
461 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
462 pdo->pdo_id = g_slist_length(di->pd_output);
463 pdo->output_type = output_type;
465 pdo->proto_id = g_strdup(proto_id);
467 if (output_type == SRD_OUTPUT_META) {
468 pdo->meta_type = meta_type_gv;
469 pdo->meta_name = g_strdup(meta_name);
470 pdo->meta_descr = g_strdup(meta_descr);
473 di->pd_output = g_slist_append(di->pd_output, pdo);
474 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
476 PyGILState_Release(gstate);
478 return py_new_output_id;
481 PyGILState_Release(gstate);
486 static int get_term_type(const char *v)
490 return SRD_TERM_HIGH;
494 return SRD_TERM_RISING_EDGE;
496 return SRD_TERM_FALLING_EDGE;
498 return SRD_TERM_EITHER_EDGE;
500 return SRD_TERM_NO_EDGE;
509 * Get the pin values at the current sample number.
511 * @param di The decoder instance to use. Must not be NULL.
512 * The number of channels must be >= 1.
514 * @return A newly allocated PyTuple containing the pin values at the
515 * current sample number.
517 static PyObject *get_current_pinvalues(const struct srd_decoder_inst *di)
521 const uint8_t *sample_pos;
522 int byte_offset, bit_offset;
523 PyObject *py_pinvalues;
524 PyGILState_STATE gstate;
527 srd_err("Invalid decoder instance.");
531 gstate = PyGILState_Ensure();
533 py_pinvalues = PyTuple_New(di->dec_num_channels);
535 for (i = 0; i < di->dec_num_channels; i++) {
536 /* A channelmap value of -1 means "unused optional channel". */
537 if (di->dec_channelmap[i] == -1) {
538 /* Value of unused channel is 0xff, instead of 0 or 1. */
539 PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(0xff));
541 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
542 byte_offset = di->dec_channelmap[i] / 8;
543 bit_offset = di->dec_channelmap[i] % 8;
544 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
545 PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(sample));
549 PyGILState_Release(gstate);
555 * Create a list of terms in the specified condition.
557 * If there are no terms in the condition, 'term_list' will be NULL.
559 * @param py_dict A Python dict containing terms. Must not be NULL.
560 * @param term_list Pointer to a GSList which will be set to the newly
561 * created list of terms. Must not be NULL.
563 * @return SRD_OK upon success, a negative error code otherwise.
565 static int create_term_list(PyObject *py_dict, GSList **term_list)
568 PyObject *py_key, *py_value;
569 struct srd_term *term;
570 uint64_t num_samples_to_skip;
572 PyGILState_STATE gstate;
574 if (!py_dict || !term_list)
577 /* "Create" an empty GSList of terms. */
580 gstate = PyGILState_Ensure();
582 /* Iterate over all items in the current dict. */
583 while (PyDict_Next(py_dict, &pos, &py_key, &py_value)) {
584 /* Check whether the current key is a string or a number. */
585 if (PyLong_Check(py_key)) {
586 /* The key is a number. */
587 /* TODO: Check if the number is a valid channel. */
588 /* Get the value string. */
589 if ((py_pydictitem_as_str(py_dict, py_key, &term_str)) != SRD_OK) {
590 srd_err("Failed to get the value.");
593 term = g_malloc(sizeof(struct srd_term));
594 term->type = get_term_type(term_str);
595 term->channel = PyLong_AsLong(py_key);
597 } else if (PyUnicode_Check(py_key)) {
598 /* The key is a string. */
599 /* TODO: Check if it's "skip". */
600 if ((py_pydictitem_as_long(py_dict, py_key, &num_samples_to_skip)) != SRD_OK) {
601 srd_err("Failed to get number of samples to skip.");
604 term = g_malloc(sizeof(struct srd_term));
605 term->type = SRD_TERM_SKIP;
606 term->num_samples_to_skip = num_samples_to_skip;
607 term->num_samples_already_skipped = 0;
609 srd_err("Term key is neither a string nor a number.");
613 /* Add the term to the list of terms. */
614 *term_list = g_slist_append(*term_list, term);
617 PyGILState_Release(gstate);
622 PyGILState_Release(gstate);
628 * Replace the current condition list with the new one.
630 * @param self TODO. Must not be NULL.
631 * @param args TODO. Must not be NULL.
633 * @retval SRD_OK The new condition list was set successfully.
634 * @retval SRD_ERR There was an error setting the new condition list.
635 * The contents of di->condition_list are undefined.
638 static int set_new_condition_list(PyObject *self, PyObject *args)
640 struct srd_decoder_inst *di;
642 PyObject *py_conditionlist, *py_conds, *py_dict;
643 int i, num_conditions, ret;
644 PyGILState_STATE gstate;
649 gstate = PyGILState_Ensure();
651 /* Get the decoder instance. */
652 if (!(di = srd_inst_find_by_obj(NULL, self))) {
653 PyErr_SetString(PyExc_Exception, "decoder instance not found");
658 * Return an error condition from .wait() when termination is
659 * requested, such that decode() will terminate.
661 if (di->want_wait_terminate) {
662 srd_dbg("%s: %s: Skip (want_term).", di->inst_id, __func__);
667 * Parse the argument of self.wait() into 'py_conds', and check
668 * the data type. The argument is optional, None is assumed in
669 * its absence. None or an empty dict or an empty list mean that
670 * there is no condition, and the next available sample shall
671 * get returned to the caller.
674 if (!PyArg_ParseTuple(args, "|O", &py_conds)) {
675 /* Let Python raise this exception. */
678 if (py_conds == Py_None) {
679 /* 'py_conds' is None. */
681 } else if (PyList_Check(py_conds)) {
682 /* 'py_conds' is a list. */
683 py_conditionlist = py_conds;
684 num_conditions = PyList_Size(py_conditionlist);
685 if (num_conditions == 0)
686 goto ret_9999; /* The PD invoked self.wait([]). */
687 Py_IncRef(py_conditionlist);
688 } else if (PyDict_Check(py_conds)) {
689 /* 'py_conds' is a dict. */
690 if (PyDict_Size(py_conds) == 0)
691 goto ret_9999; /* The PD invoked self.wait({}). */
692 /* Make a list and put the dict in there for convenience. */
693 py_conditionlist = PyList_New(1);
695 PyList_SetItem(py_conditionlist, 0, py_conds);
698 srd_err("Condition list is neither a list nor a dict.");
702 /* Free the old condition list. */
703 condition_list_free(di);
707 /* Iterate over the conditions, set di->condition_list accordingly. */
708 for (i = 0; i < num_conditions; i++) {
709 /* Get a condition (dict) from the condition list. */
710 py_dict = PyList_GetItem(py_conditionlist, i);
711 if (!PyDict_Check(py_dict)) {
712 srd_err("Condition is not a dict.");
717 /* Create the list of terms in this condition. */
718 if ((ret = create_term_list(py_dict, &term_list)) < 0)
721 /* Add the new condition to the PD instance's condition list. */
722 di->condition_list = g_slist_append(di->condition_list, term_list);
725 Py_DecRef(py_conditionlist);
727 PyGILState_Release(gstate);
732 PyGILState_Release(gstate);
737 PyGILState_Release(gstate);
743 * Create a SKIP condition list for condition-less .wait() calls.
745 * @param di Decoder instance.
746 * @param count Number of samples to skip.
748 * @retval SRD_OK The new condition list was set successfully.
749 * @retval SRD_ERR There was an error setting the new condition list.
750 * The contents of di->condition_list are undefined.
752 * This routine is a reduced and specialized version of the @ref
753 * set_new_condition_list() and @ref create_term_list() routines which
754 * gets invoked when .wait() was called without specifications for
755 * conditions. This minor duplication of the SKIP term list creation
756 * simplifies the logic and avoids the creation of expensive Python
757 * objects with "constant" values which the caller did not pass in the
758 * first place. It results in maximum sharing of match handling code
761 static int set_skip_condition(struct srd_decoder_inst *di, uint64_t count)
763 struct srd_term *term;
766 condition_list_free(di);
767 term = g_malloc(sizeof(*term));
768 term->type = SRD_TERM_SKIP;
769 term->num_samples_to_skip = count;
770 term->num_samples_already_skipped = 0;
771 term_list = g_slist_append(NULL, term);
772 di->condition_list = g_slist_append(di->condition_list, term_list);
777 static PyObject *Decoder_wait(PyObject *self, PyObject *args)
782 gboolean found_match;
783 struct srd_decoder_inst *di;
784 PyObject *py_pinvalues, *py_matched;
785 PyGILState_STATE gstate;
790 gstate = PyGILState_Ensure();
792 if (!(di = srd_inst_find_by_obj(NULL, self))) {
793 PyErr_SetString(PyExc_Exception, "decoder instance not found");
794 PyGILState_Release(gstate);
798 ret = set_new_condition_list(self, args);
800 srd_dbg("%s: %s: Aborting wait().", di->inst_id, __func__);
805 * Empty condition list, automatic match. Arrange for the
806 * execution of regular match handling code paths such that
807 * the next available sample is returned to the caller.
808 * Make sure to skip one sample when "anywhere within the
809 * stream", yet make sure to not skip sample number 0.
811 if (di->abs_cur_samplenum)
813 else if (!di->condition_list)
817 ret = set_skip_condition(di, skip_count);
819 srd_dbg("%s: %s: Cannot setup condition-less wait().",
820 di->inst_id, __func__);
827 Py_BEGIN_ALLOW_THREADS
829 /* Wait for new samples to process, or termination request. */
830 g_mutex_lock(&di->data_mutex);
831 while (!di->got_new_samples && !di->want_wait_terminate)
832 g_cond_wait(&di->got_new_samples_cond, &di->data_mutex);
835 * Check whether any of the current condition(s) match.
836 * Arrange for termination requests to take a code path which
837 * won't find new samples to process, pretends to have processed
838 * previously stored samples, and returns to the main thread,
839 * while the termination request still gets signalled.
843 /* Ignore return value for now, should never be negative. */
844 (void)process_samples_until_condition_match(di, &found_match);
848 /* If there's a match, set self.samplenum etc. and return. */
850 /* Set self.samplenum to the (absolute) sample number that matched. */
851 PyObject_SetAttrString(di->py_inst, "samplenum",
852 PyLong_FromLong(di->abs_cur_samplenum));
854 if (di->match_array && di->match_array->len > 0) {
855 py_matched = PyTuple_New(di->match_array->len);
856 for (i = 0; i < di->match_array->len; i++)
857 PyTuple_SetItem(py_matched, i, PyBool_FromLong(di->match_array->data[i]));
858 PyObject_SetAttrString(di->py_inst, "matched", py_matched);
859 match_array_free(di);
861 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
864 py_pinvalues = get_current_pinvalues(di);
866 g_mutex_unlock(&di->data_mutex);
868 PyGILState_Release(gstate);
873 /* No match, reset state for the next chunk. */
874 di->got_new_samples = FALSE;
875 di->handled_all_samples = TRUE;
876 di->abs_start_samplenum = 0;
877 di->abs_end_samplenum = 0;
881 /* Signal the main thread that we handled all samples. */
882 g_cond_signal(&di->handled_all_samples_cond);
885 * When termination of wait() and decode() was requested,
886 * then exit the loop after releasing the mutex.
888 if (di->want_wait_terminate) {
889 srd_dbg("%s: %s: Will return from wait().",
890 di->inst_id, __func__);
891 g_mutex_unlock(&di->data_mutex);
895 g_mutex_unlock(&di->data_mutex);
898 PyGILState_Release(gstate);
903 PyGILState_Release(gstate);
909 * Return whether the specified channel was supplied to the decoder.
911 * @param self TODO. Must not be NULL.
912 * @param args TODO. Must not be NULL.
914 * @retval Py_True The channel has been supplied by the frontend.
915 * @retval Py_False The channel has been supplied by the frontend.
916 * @retval NULL An error occurred.
918 static PyObject *Decoder_has_channel(PyObject *self, PyObject *args)
921 struct srd_decoder_inst *di;
922 PyGILState_STATE gstate;
927 gstate = PyGILState_Ensure();
929 if (!(di = srd_inst_find_by_obj(NULL, self))) {
930 PyErr_SetString(PyExc_Exception, "decoder instance not found");
935 * Get the integer argument of self.has_channel(). Check for
936 * the range of supported PD input channel numbers.
938 if (!PyArg_ParseTuple(args, "i", &idx)) {
939 /* Let Python raise this exception. */
943 count = g_slist_length(di->decoder->channels) +
944 g_slist_length(di->decoder->opt_channels);
945 if (idx < 0 || idx >= count) {
946 srd_err("Invalid index %d, PD channel count %d.", idx, count);
947 PyErr_SetString(PyExc_IndexError, "invalid channel index");
951 PyGILState_Release(gstate);
953 return (di->dec_channelmap[idx] == -1) ? Py_False : Py_True;
956 PyGILState_Release(gstate);
961 static PyMethodDef Decoder_methods[] = {
962 { "put", Decoder_put, METH_VARARGS,
963 "Accepts a dictionary with the following keys: startsample, endsample, data" },
964 { "register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
965 "Register a new output stream" },
966 { "wait", Decoder_wait, METH_VARARGS,
967 "Wait for one or more conditions to occur" },
968 { "has_channel", Decoder_has_channel, METH_VARARGS,
969 "Report whether a channel was supplied" },
970 {NULL, NULL, 0, NULL}
974 * Create the sigrokdecode.Decoder type.
976 * @return The new type object.
980 SRD_PRIV PyObject *srd_Decoder_type_new(void)
983 PyType_Slot slots[] = {
984 { Py_tp_doc, "sigrok Decoder base class" },
985 { Py_tp_methods, Decoder_methods },
986 { Py_tp_new, (void *)&PyType_GenericNew },
990 PyGILState_STATE gstate;
992 gstate = PyGILState_Ensure();
994 spec.name = "sigrokdecode.Decoder";
995 spec.basicsize = sizeof(srd_Decoder);
997 spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
1000 py_obj = PyType_FromSpec(&spec);
1002 PyGILState_Release(gstate);