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"
26 extern SRD_PRIV GSList *sessions;
33 /* This is only used for nicer srd_dbg() output. */
34 SRD_PRIV const char *output_type_name(unsigned int idx)
36 static const char names[][16] = {
44 return names[MIN(idx, G_N_ELEMENTS(names) - 1)];
47 static void release_annotation(struct srd_proto_data_annotation *pda)
52 g_strfreev(pda->ann_text);
55 static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
56 struct srd_proto_data *pdata)
59 struct srd_pd_output *pdo;
60 struct srd_proto_data_annotation *pda;
63 PyGILState_STATE gstate;
65 gstate = PyGILState_Ensure();
67 /* Should be a list of [annotation class, [string, ...]]. */
68 if (!PyList_Check(obj)) {
69 srd_err("Protocol decoder %s submitted an annotation that"
70 " is not a list", di->decoder->name);
74 /* Should have 2 elements. */
75 if (PyList_Size(obj) != 2) {
76 srd_err("Protocol decoder %s submitted annotation list with "
77 "%zd elements instead of 2", di->decoder->name,
83 * The first element should be an integer matching a previously
84 * registered annotation class.
86 py_tmp = PyList_GetItem(obj, 0);
87 if (!PyLong_Check(py_tmp)) {
88 srd_err("Protocol decoder %s submitted annotation list, but "
89 "first element was not an integer.", di->decoder->name);
92 ann_class = PyLong_AsLong(py_tmp);
93 if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
94 srd_err("Protocol decoder %s submitted data to unregistered "
95 "annotation class %d.", di->decoder->name, ann_class);
99 /* Second element must be a list. */
100 py_tmp = PyList_GetItem(obj, 1);
101 if (!PyList_Check(py_tmp)) {
102 srd_err("Protocol decoder %s submitted annotation list, but "
103 "second element was not a list.", di->decoder->name);
106 if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
107 srd_err("Protocol decoder %s submitted annotation list, but "
108 "second element was malformed.", di->decoder->name);
113 pda->ann_class = ann_class;
114 pda->ann_text = ann_text;
116 PyGILState_Release(gstate);
121 PyGILState_Release(gstate);
123 return SRD_ERR_PYTHON;
126 static void release_binary(struct srd_proto_data_binary *pdb)
130 g_free((void *)pdb->data);
133 static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
134 struct srd_proto_data *pdata)
136 struct srd_proto_data_binary *pdb;
140 char *class_name, *buf;
141 PyGILState_STATE gstate;
143 gstate = PyGILState_Ensure();
145 /* Should be a list of [binary class, bytes]. */
146 if (!PyList_Check(obj)) {
147 srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.",
152 /* Should have 2 elements. */
153 if (PyList_Size(obj) != 2) {
154 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list "
155 "with %zd elements instead of 2", di->decoder->name,
160 /* The first element should be an integer. */
161 py_tmp = PyList_GetItem(obj, 0);
162 if (!PyLong_Check(py_tmp)) {
163 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
164 "but first element was not an integer.", di->decoder->name);
167 bin_class = PyLong_AsLong(py_tmp);
168 if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
169 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
170 "unregistered binary class %d.", di->decoder->name, bin_class);
174 /* Second element should be bytes. */
175 py_tmp = PyList_GetItem(obj, 1);
176 if (!PyBytes_Check(py_tmp)) {
177 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
178 "but second element was not bytes.", di->decoder->name);
182 /* Consider an empty set of bytes a bug. */
183 if (PyBytes_Size(py_tmp) == 0) {
184 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
185 "with empty data set.", di->decoder->name);
189 if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
192 PyGILState_Release(gstate);
195 pdb->bin_class = bin_class;
197 if (!(pdb->data = g_try_malloc(pdb->size)))
198 return SRD_ERR_MALLOC;
199 memcpy((void *)pdb->data, (const void *)buf, pdb->size);
204 PyGILState_Release(gstate);
206 return SRD_ERR_PYTHON;
209 static inline struct srd_decoder_inst *srd_sess_inst_find_by_obj(
210 struct srd_session *sess, const GSList *stack, const PyObject *obj)
213 struct srd_decoder_inst *tmp, *di;
219 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
221 if (tmp->py_inst == obj)
223 else if (tmp->next_di)
224 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
231 * Find a decoder instance by its Python object.
233 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
234 * This will recurse to find the instance anywhere in the stack tree of all
237 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
238 * stack to search. To start searching at the bottom level of
239 * decoder instances, pass NULL.
240 * @param obj The Python class instantiation.
242 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
246 static inline struct srd_decoder_inst *srd_inst_find_by_obj(
247 const GSList *stack, const PyObject *obj)
249 struct srd_decoder_inst *di;
250 struct srd_session *sess;
253 /* Performance shortcut: Handle the most common case first. */
254 sess = sessions->data;
255 di = sess->di_list->data;
256 if (di->py_inst == obj)
260 for (l = sessions; di == NULL && l != NULL; l = l->next) {
262 di = srd_sess_inst_find_by_obj(sess, stack, obj);
268 static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
272 PyGILState_STATE gstate;
274 gstate = PyGILState_Ensure();
276 if (g_variant_type_equal(pdata->pdo->meta_type, G_VARIANT_TYPE_INT64)) {
277 if (!PyLong_Check(obj)) {
278 PyErr_Format(PyExc_TypeError, "This output was registered "
279 "as 'int', but something else was passed.");
282 intvalue = PyLong_AsLongLong(obj);
283 if (PyErr_Occurred())
285 pdata->data = g_variant_new_int64(intvalue);
286 } else if (g_variant_type_equal(pdata->pdo->meta_type, G_VARIANT_TYPE_DOUBLE)) {
287 if (!PyFloat_Check(obj)) {
288 PyErr_Format(PyExc_TypeError, "This output was registered "
289 "as 'float', but something else was passed.");
292 dvalue = PyFloat_AsDouble(obj);
293 if (PyErr_Occurred())
295 pdata->data = g_variant_new_double(dvalue);
298 PyGILState_Release(gstate);
303 PyGILState_Release(gstate);
305 return SRD_ERR_PYTHON;
308 static void release_meta(GVariant *gvar)
312 g_variant_unref(gvar);
315 static PyObject *Decoder_put(PyObject *self, PyObject *args)
318 PyObject *py_data, *py_res;
319 struct srd_decoder_inst *di, *next_di;
320 struct srd_pd_output *pdo;
321 struct srd_proto_data pdata;
322 struct srd_proto_data_annotation pda;
323 struct srd_proto_data_binary pdb;
324 uint64_t start_sample, end_sample;
326 struct srd_pd_callback *cb;
327 PyGILState_STATE gstate;
331 gstate = PyGILState_Ensure();
333 if (!(di = srd_inst_find_by_obj(NULL, self))) {
334 /* Shouldn't happen. */
335 srd_dbg("put(): self instance not found.");
339 if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
340 &output_id, &py_data)) {
342 * This throws an exception, but by returning NULL here we let
343 * Python raise it. This results in a much better trace in
344 * controller.c on the decode() method call.
349 if (!(l = g_slist_nth(di->pd_output, output_id))) {
350 srd_err("Protocol decoder %s submitted invalid output ID %d.",
351 di->decoder->name, output_id);
356 /* Upon SRD_OUTPUT_PYTHON for stacked PDs, we have a nicer log message later. */
357 if (pdo->output_type != SRD_OUTPUT_PYTHON && di->next_di != NULL) {
358 srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
359 di->inst_id, start_sample, end_sample,
360 output_type_name(pdo->output_type), output_id);
363 pdata.start_sample = start_sample;
364 pdata.end_sample = end_sample;
368 switch (pdo->output_type) {
370 /* Annotations are only fed to callbacks. */
371 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
373 /* Convert from PyDict to srd_proto_data_annotation. */
374 if (convert_annotation(di, py_data, &pdata) != SRD_OK) {
375 /* An error was already logged. */
378 Py_BEGIN_ALLOW_THREADS
379 cb->cb(&pdata, cb->cb_data);
381 release_annotation(pdata.data);
384 case SRD_OUTPUT_PYTHON:
385 for (l = di->next_di; l; l = l->next) {
387 srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on "
388 "oid %d to instance %s.", di->inst_id, start_sample,
389 end_sample, output_type_name(pdo->output_type),
390 output_id, next_di->inst_id);
391 if (!(py_res = PyObject_CallMethod(
392 next_di->py_inst, "decode", "KKO", start_sample,
393 end_sample, py_data))) {
394 srd_exception_catch("Calling %s decode() failed",
399 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
401 * Frontends aren't really supposed to get Python
402 * callbacks, but it's useful for testing.
404 pdata.data = py_data;
405 cb->cb(&pdata, cb->cb_data);
408 case SRD_OUTPUT_BINARY:
409 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
411 /* Convert from PyDict to srd_proto_data_binary. */
412 if (convert_binary(di, py_data, &pdata) != SRD_OK) {
413 /* An error was already logged. */
416 Py_BEGIN_ALLOW_THREADS
417 cb->cb(&pdata, cb->cb_data);
419 release_binary(pdata.data);
422 case SRD_OUTPUT_META:
423 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
424 /* Annotations need converting from PyObject. */
425 if (convert_meta(&pdata, py_data) != SRD_OK) {
426 /* An exception was already set up. */
429 Py_BEGIN_ALLOW_THREADS
430 cb->cb(&pdata, cb->cb_data);
432 release_meta(pdata.data);
436 srd_err("Protocol decoder %s submitted invalid output type %d.",
437 di->decoder->name, pdo->output_type);
441 PyGILState_Release(gstate);
446 PyGILState_Release(gstate);
451 static PyObject *Decoder_register(PyObject *self, PyObject *args,
454 struct srd_decoder_inst *di;
455 struct srd_pd_output *pdo;
456 PyObject *py_new_output_id;
457 PyTypeObject *meta_type_py;
458 const GVariantType *meta_type_gv;
460 char *proto_id, *meta_name, *meta_descr;
461 char *keywords[] = { "output_type", "proto_id", "meta", NULL };
462 PyGILState_STATE gstate;
465 struct srd_pd_output *cmp;
467 gstate = PyGILState_Ensure();
471 meta_name = meta_descr = NULL;
473 if (!(di = srd_inst_find_by_obj(NULL, self))) {
474 PyErr_SetString(PyExc_Exception, "decoder instance not found");
478 /* Default to instance ID, which defaults to class ID. */
479 proto_id = di->inst_id;
480 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
481 &output_type, &proto_id,
482 &meta_type_py, &meta_name, &meta_descr)) {
483 /* Let Python raise this exception. */
487 /* Check if the meta value's type is supported. */
488 is_meta = output_type == SRD_OUTPUT_META;
490 if (meta_type_py == &PyLong_Type)
491 meta_type_gv = G_VARIANT_TYPE_INT64;
492 else if (meta_type_py == &PyFloat_Type)
493 meta_type_gv = G_VARIANT_TYPE_DOUBLE;
495 PyErr_Format(PyExc_TypeError, "Unsupported type.");
501 for (l = di->pd_output; l; l = l->next) {
503 if (cmp->output_type != output_type)
505 if (strcmp(cmp->proto_id, proto_id) != 0)
507 if (is_meta && cmp->meta_type != meta_type_gv)
509 if (is_meta && strcmp(cmp->meta_name, meta_name) != 0)
511 if (is_meta && strcmp(cmp->meta_descr, meta_descr) != 0)
517 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
518 PyGILState_Release(gstate);
519 return py_new_output_id;
522 srd_dbg("Instance %s creating new output type %s for %s.",
523 di->inst_id, output_type_name(output_type), proto_id);
525 pdo = g_malloc(sizeof(struct srd_pd_output));
527 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
528 pdo->pdo_id = g_slist_length(di->pd_output);
529 pdo->output_type = output_type;
531 pdo->proto_id = g_strdup(proto_id);
533 if (output_type == SRD_OUTPUT_META) {
534 pdo->meta_type = meta_type_gv;
535 pdo->meta_name = g_strdup(meta_name);
536 pdo->meta_descr = g_strdup(meta_descr);
539 di->pd_output = g_slist_append(di->pd_output, pdo);
540 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
542 PyGILState_Release(gstate);
544 return py_new_output_id;
547 PyGILState_Release(gstate);
552 static int get_term_type(const char *v)
556 return SRD_TERM_HIGH;
560 return SRD_TERM_RISING_EDGE;
562 return SRD_TERM_FALLING_EDGE;
564 return SRD_TERM_EITHER_EDGE;
566 return SRD_TERM_NO_EDGE;
575 * Get the pin values at the current sample number.
577 * @param di The decoder instance to use. Must not be NULL.
578 * The number of channels must be >= 1.
580 * @return A newly allocated PyTuple containing the pin values at the
581 * current sample number.
583 static PyObject *get_current_pinvalues(const struct srd_decoder_inst *di)
587 const uint8_t *sample_pos;
588 int byte_offset, bit_offset;
589 PyObject *py_pinvalues;
590 PyGILState_STATE gstate;
593 srd_err("Invalid decoder instance.");
597 gstate = PyGILState_Ensure();
599 py_pinvalues = PyTuple_New(di->dec_num_channels);
601 for (i = 0; i < di->dec_num_channels; i++) {
602 /* A channelmap value of -1 means "unused optional channel". */
603 if (di->dec_channelmap[i] == -1) {
604 /* Value of unused channel is 0xff, instead of 0 or 1. */
605 PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(0xff));
607 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
608 byte_offset = di->dec_channelmap[i] / 8;
609 bit_offset = di->dec_channelmap[i] % 8;
610 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
611 PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(sample));
615 PyGILState_Release(gstate);
621 * Create a list of terms in the specified condition.
623 * If there are no terms in the condition, 'term_list' will be NULL.
625 * @param py_dict A Python dict containing terms. Must not be NULL.
626 * @param term_list Pointer to a GSList which will be set to the newly
627 * created list of terms. Must not be NULL.
629 * @return SRD_OK upon success, a negative error code otherwise.
631 static int create_term_list(PyObject *py_dict, GSList **term_list)
634 PyObject *py_key, *py_value;
635 struct srd_term *term;
636 uint64_t num_samples_to_skip;
638 PyGILState_STATE gstate;
640 if (!py_dict || !term_list)
643 /* "Create" an empty GSList of terms. */
646 gstate = PyGILState_Ensure();
648 /* Iterate over all items in the current dict. */
649 while (PyDict_Next(py_dict, &pos, &py_key, &py_value)) {
650 /* Check whether the current key is a string or a number. */
651 if (PyLong_Check(py_key)) {
652 /* The key is a number. */
653 /* TODO: Check if the number is a valid channel. */
654 /* Get the value string. */
655 if ((py_pydictitem_as_str(py_dict, py_key, &term_str)) != SRD_OK) {
656 srd_err("Failed to get the value.");
659 term = g_malloc(sizeof(struct srd_term));
660 term->type = get_term_type(term_str);
661 term->channel = PyLong_AsLong(py_key);
663 } else if (PyUnicode_Check(py_key)) {
664 /* The key is a string. */
665 /* TODO: Check if it's "skip". */
666 if ((py_pydictitem_as_long(py_dict, py_key, &num_samples_to_skip)) != SRD_OK) {
667 srd_err("Failed to get number of samples to skip.");
670 term = g_malloc(sizeof(struct srd_term));
671 term->type = SRD_TERM_SKIP;
672 term->num_samples_to_skip = num_samples_to_skip;
673 term->num_samples_already_skipped = 0;
675 srd_err("Term key is neither a string nor a number.");
679 /* Add the term to the list of terms. */
680 *term_list = g_slist_append(*term_list, term);
683 PyGILState_Release(gstate);
688 PyGILState_Release(gstate);
694 * Replace the current condition list with the new one.
696 * @param self TODO. Must not be NULL.
697 * @param args TODO. Must not be NULL.
699 * @retval SRD_OK The new condition list was set successfully.
700 * @retval SRD_ERR There was an error setting the new condition list.
701 * The contents of di->condition_list are undefined.
704 static int set_new_condition_list(PyObject *self, PyObject *args)
706 struct srd_decoder_inst *di;
708 PyObject *py_conditionlist, *py_conds, *py_dict;
709 int i, num_conditions, ret;
710 PyGILState_STATE gstate;
715 gstate = PyGILState_Ensure();
717 /* Get the decoder instance. */
718 if (!(di = srd_inst_find_by_obj(NULL, self))) {
719 PyErr_SetString(PyExc_Exception, "decoder instance not found");
724 * Return an error condition from .wait() when termination is
725 * requested, such that decode() will terminate.
727 if (di->want_wait_terminate) {
728 srd_dbg("%s: %s: Skip (want_term).", di->inst_id, __func__);
733 * Parse the argument of self.wait() into 'py_conds', and check
734 * the data type. The argument is optional, None is assumed in
735 * its absence. None or an empty dict or an empty list mean that
736 * there is no condition, and the next available sample shall
737 * get returned to the caller.
740 if (!PyArg_ParseTuple(args, "|O", &py_conds)) {
741 /* Let Python raise this exception. */
744 if (py_conds == Py_None) {
745 /* 'py_conds' is None. */
747 } else if (PyList_Check(py_conds)) {
748 /* 'py_conds' is a list. */
749 py_conditionlist = py_conds;
750 num_conditions = PyList_Size(py_conditionlist);
751 if (num_conditions == 0)
752 goto ret_9999; /* The PD invoked self.wait([]). */
753 Py_IncRef(py_conditionlist);
754 } else if (PyDict_Check(py_conds)) {
755 /* 'py_conds' is a dict. */
756 if (PyDict_Size(py_conds) == 0)
757 goto ret_9999; /* The PD invoked self.wait({}). */
758 /* Make a list and put the dict in there for convenience. */
759 py_conditionlist = PyList_New(1);
761 PyList_SetItem(py_conditionlist, 0, py_conds);
764 srd_err("Condition list is neither a list nor a dict.");
768 /* Free the old condition list. */
769 condition_list_free(di);
773 /* Iterate over the conditions, set di->condition_list accordingly. */
774 for (i = 0; i < num_conditions; i++) {
775 /* Get a condition (dict) from the condition list. */
776 py_dict = PyList_GetItem(py_conditionlist, i);
777 if (!PyDict_Check(py_dict)) {
778 srd_err("Condition is not a dict.");
783 /* Create the list of terms in this condition. */
784 if ((ret = create_term_list(py_dict, &term_list)) < 0)
787 /* Add the new condition to the PD instance's condition list. */
788 di->condition_list = g_slist_append(di->condition_list, term_list);
791 Py_DecRef(py_conditionlist);
793 PyGILState_Release(gstate);
798 PyGILState_Release(gstate);
803 PyGILState_Release(gstate);
809 * Create a SKIP condition list for condition-less .wait() calls.
811 * @param di Decoder instance.
812 * @param count Number of samples to skip.
814 * @retval SRD_OK The new condition list was set successfully.
815 * @retval SRD_ERR There was an error setting the new condition list.
816 * The contents of di->condition_list are undefined.
818 * This routine is a reduced and specialized version of the @ref
819 * set_new_condition_list() and @ref create_term_list() routines which
820 * gets invoked when .wait() was called without specifications for
821 * conditions. This minor duplication of the SKIP term list creation
822 * simplifies the logic and avoids the creation of expensive Python
823 * objects with "constant" values which the caller did not pass in the
824 * first place. It results in maximum sharing of match handling code
827 static int set_skip_condition(struct srd_decoder_inst *di, uint64_t count)
829 struct srd_term *term;
832 condition_list_free(di);
833 term = g_malloc(sizeof(*term));
834 term->type = SRD_TERM_SKIP;
835 term->num_samples_to_skip = count;
836 term->num_samples_already_skipped = 0;
837 term_list = g_slist_append(NULL, term);
838 di->condition_list = g_slist_append(di->condition_list, term_list);
843 static PyObject *Decoder_wait(PyObject *self, PyObject *args)
848 gboolean found_match;
849 struct srd_decoder_inst *di;
850 PyObject *py_pinvalues, *py_matched;
851 PyGILState_STATE gstate;
856 gstate = PyGILState_Ensure();
858 if (!(di = srd_inst_find_by_obj(NULL, self))) {
859 PyErr_SetString(PyExc_Exception, "decoder instance not found");
860 PyGILState_Release(gstate);
864 ret = set_new_condition_list(self, args);
866 srd_dbg("%s: %s: Aborting wait().", di->inst_id, __func__);
871 * Empty condition list, automatic match. Arrange for the
872 * execution of regular match handling code paths such that
873 * the next available sample is returned to the caller.
874 * Make sure to skip one sample when "anywhere within the
875 * stream", yet make sure to not skip sample number 0.
877 if (di->abs_cur_samplenum)
879 else if (!di->condition_list)
883 ret = set_skip_condition(di, skip_count);
885 srd_dbg("%s: %s: Cannot setup condition-less wait().",
886 di->inst_id, __func__);
893 Py_BEGIN_ALLOW_THREADS
895 /* Wait for new samples to process, or termination request. */
896 g_mutex_lock(&di->data_mutex);
897 while (!di->got_new_samples && !di->want_wait_terminate)
898 g_cond_wait(&di->got_new_samples_cond, &di->data_mutex);
901 * Check whether any of the current condition(s) match.
902 * Arrange for termination requests to take a code path which
903 * won't find new samples to process, pretends to have processed
904 * previously stored samples, and returns to the main thread,
905 * while the termination request still gets signalled.
909 /* Ignore return value for now, should never be negative. */
910 (void)process_samples_until_condition_match(di, &found_match);
914 /* If there's a match, set self.samplenum etc. and return. */
916 /* Set self.samplenum to the (absolute) sample number that matched. */
917 PyObject_SetAttrString(di->py_inst, "samplenum",
918 PyLong_FromLong(di->abs_cur_samplenum));
920 if (di->match_array && di->match_array->len > 0) {
921 py_matched = PyTuple_New(di->match_array->len);
922 for (i = 0; i < di->match_array->len; i++)
923 PyTuple_SetItem(py_matched, i, PyBool_FromLong(di->match_array->data[i]));
924 PyObject_SetAttrString(di->py_inst, "matched", py_matched);
925 match_array_free(di);
927 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
930 py_pinvalues = get_current_pinvalues(di);
932 g_mutex_unlock(&di->data_mutex);
934 PyGILState_Release(gstate);
939 /* No match, reset state for the next chunk. */
940 di->got_new_samples = FALSE;
941 di->handled_all_samples = TRUE;
942 di->abs_start_samplenum = 0;
943 di->abs_end_samplenum = 0;
947 /* Signal the main thread that we handled all samples. */
948 g_cond_signal(&di->handled_all_samples_cond);
951 * When termination of wait() and decode() was requested,
952 * then exit the loop after releasing the mutex.
954 if (di->want_wait_terminate) {
955 srd_dbg("%s: %s: Will return from wait().",
956 di->inst_id, __func__);
957 g_mutex_unlock(&di->data_mutex);
961 g_mutex_unlock(&di->data_mutex);
964 PyGILState_Release(gstate);
969 PyGILState_Release(gstate);
975 * Return whether the specified channel was supplied to the decoder.
977 * @param self TODO. Must not be NULL.
978 * @param args TODO. Must not be NULL.
980 * @retval Py_True The channel has been supplied by the frontend.
981 * @retval Py_False The channel has been supplied by the frontend.
982 * @retval NULL An error occurred.
984 static PyObject *Decoder_has_channel(PyObject *self, PyObject *args)
987 struct srd_decoder_inst *di;
988 PyGILState_STATE gstate;
993 gstate = PyGILState_Ensure();
995 if (!(di = srd_inst_find_by_obj(NULL, self))) {
996 PyErr_SetString(PyExc_Exception, "decoder instance not found");
1001 * Get the integer argument of self.has_channel(). Check for
1002 * the range of supported PD input channel numbers.
1004 if (!PyArg_ParseTuple(args, "i", &idx)) {
1005 /* Let Python raise this exception. */
1009 count = g_slist_length(di->decoder->channels) +
1010 g_slist_length(di->decoder->opt_channels);
1011 if (idx < 0 || idx >= count) {
1012 srd_err("Invalid index %d, PD channel count %d.", idx, count);
1013 PyErr_SetString(PyExc_IndexError, "invalid channel index");
1017 PyGILState_Release(gstate);
1019 return (di->dec_channelmap[idx] == -1) ? Py_False : Py_True;
1022 PyGILState_Release(gstate);
1027 static PyMethodDef Decoder_methods[] = {
1028 { "put", Decoder_put, METH_VARARGS,
1029 "Accepts a dictionary with the following keys: startsample, endsample, data" },
1030 { "register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
1031 "Register a new output stream" },
1032 { "wait", Decoder_wait, METH_VARARGS,
1033 "Wait for one or more conditions to occur" },
1034 { "has_channel", Decoder_has_channel, METH_VARARGS,
1035 "Report whether a channel was supplied" },
1036 {NULL, NULL, 0, NULL}
1040 * Create the sigrokdecode.Decoder type.
1042 * @return The new type object.
1046 SRD_PRIV PyObject *srd_Decoder_type_new(void)
1049 PyType_Slot slots[] = {
1050 { Py_tp_doc, "sigrok Decoder base class" },
1051 { Py_tp_methods, Decoder_methods },
1052 { Py_tp_new, (void *)&PyType_GenericNew },
1056 PyGILState_STATE gstate;
1058 gstate = PyGILState_Ensure();
1060 spec.name = "sigrokdecode.Decoder";
1061 spec.basicsize = sizeof(srd_Decoder);
1063 spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
1066 py_obj = PyType_FromSpec(&spec);
1068 PyGILState_Release(gstate);