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] = {
45 return names[MIN(idx, G_N_ELEMENTS(names) - 1)];
48 static void release_annotation(struct srd_proto_data_annotation *pda)
53 g_strfreev(pda->ann_text);
56 static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
57 struct srd_proto_data *pdata)
60 struct srd_pd_output *pdo;
61 struct srd_proto_data_annotation *pda;
64 PyGILState_STATE gstate;
66 gstate = PyGILState_Ensure();
68 /* Should be a list of [annotation class, [string, ...]]. */
69 if (!PyList_Check(obj)) {
70 srd_err("Protocol decoder %s submitted an annotation that"
71 " is not a list", di->decoder->name);
75 /* Should have 2 elements. */
76 if (PyList_Size(obj) != 2) {
77 srd_err("Protocol decoder %s submitted annotation list with "
78 "%zd elements instead of 2", di->decoder->name,
84 * The first element should be an integer matching a previously
85 * registered annotation class.
87 py_tmp = PyList_GetItem(obj, 0);
88 if (!PyLong_Check(py_tmp)) {
89 srd_err("Protocol decoder %s submitted annotation list, but "
90 "first element was not an integer.", di->decoder->name);
93 ann_class = PyLong_AsLong(py_tmp);
94 if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
95 srd_err("Protocol decoder %s submitted data to unregistered "
96 "annotation class %d.", di->decoder->name, ann_class);
100 /* Second element must be a list. */
101 py_tmp = PyList_GetItem(obj, 1);
102 if (!PyList_Check(py_tmp)) {
103 srd_err("Protocol decoder %s submitted annotation list, but "
104 "second element was not a list.", di->decoder->name);
107 if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
108 srd_err("Protocol decoder %s submitted annotation list, but "
109 "second element was malformed.", di->decoder->name);
114 pda->ann_class = ann_class;
115 pda->ann_text = ann_text;
117 PyGILState_Release(gstate);
122 PyGILState_Release(gstate);
124 return SRD_ERR_PYTHON;
127 static void release_logic(struct srd_proto_data_logic *pdl)
131 g_free((void *)pdl->data);
134 static int convert_logic(struct srd_decoder_inst *di, PyObject *obj,
135 struct srd_proto_data *pdata)
137 struct srd_proto_data_logic *pdl;
141 char *group_name, *buf;
142 PyGILState_STATE gstate;
144 gstate = PyGILState_Ensure();
146 /* Should be a list of [logic group, bytes]. */
147 if (!PyList_Check(obj)) {
148 srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_LOGIC.",
153 /* Should have 2 elements. */
154 if (PyList_Size(obj) != 2) {
155 srd_err("Protocol decoder %s submitted SRD_OUTPUT_LOGIC list "
156 "with %zd elements instead of 2", di->decoder->name,
161 /* The first element should be an integer. */
162 py_tmp = PyList_GetItem(obj, 0);
163 if (!PyLong_Check(py_tmp)) {
164 srd_err("Protocol decoder %s submitted SRD_OUTPUT_LOGIC list, "
165 "but first element was not an integer.", di->decoder->name);
168 logic_group = PyLong_AsLong(py_tmp);
169 if (!(group_name = g_slist_nth_data(di->decoder->logic_output_channels, logic_group))) {
170 srd_err("Protocol decoder %s submitted SRD_OUTPUT_LOGIC with "
171 "unregistered logic group %d.", di->decoder->name, logic_group);
175 /* Second element should be bytes. */
176 py_tmp = PyList_GetItem(obj, 1);
177 if (!PyBytes_Check(py_tmp)) {
178 srd_err("Protocol decoder %s submitted SRD_OUTPUT_LOGIC list, "
179 "but second element was not bytes.", di->decoder->name);
183 /* Consider an empty set of bytes a bug. */
184 if (PyBytes_Size(py_tmp) == 0) {
185 srd_err("Protocol decoder %s submitted SRD_OUTPUT_LOGIC "
186 "with empty data set.", di->decoder->name);
190 if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
193 PyGILState_Release(gstate);
196 pdl->logic_group = logic_group;
197 /* pdl->repeat_count is set by the caller as it depends on the sample range */
198 if (!(pdl->data = g_try_malloc(size)))
199 return SRD_ERR_MALLOC;
200 memcpy((void *)pdl->data, (const void *)buf, size);
205 PyGILState_Release(gstate);
207 return SRD_ERR_PYTHON;
210 static void release_binary(struct srd_proto_data_binary *pdb)
214 g_free((void *)pdb->data);
217 static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
218 struct srd_proto_data *pdata)
220 struct srd_proto_data_binary *pdb;
224 char *class_name, *buf;
225 PyGILState_STATE gstate;
227 gstate = PyGILState_Ensure();
229 /* Should be a list of [binary class, bytes]. */
230 if (!PyList_Check(obj)) {
231 srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.",
236 /* Should have 2 elements. */
237 if (PyList_Size(obj) != 2) {
238 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list "
239 "with %zd elements instead of 2", di->decoder->name,
244 /* The first element should be an integer. */
245 py_tmp = PyList_GetItem(obj, 0);
246 if (!PyLong_Check(py_tmp)) {
247 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
248 "but first element was not an integer.", di->decoder->name);
251 bin_class = PyLong_AsLong(py_tmp);
252 if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
253 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
254 "unregistered binary class %d.", di->decoder->name, bin_class);
258 /* Second element should be bytes. */
259 py_tmp = PyList_GetItem(obj, 1);
260 if (!PyBytes_Check(py_tmp)) {
261 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
262 "but second element was not bytes.", di->decoder->name);
266 /* Consider an empty set of bytes a bug. */
267 if (PyBytes_Size(py_tmp) == 0) {
268 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
269 "with empty data set.", di->decoder->name);
273 if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
276 PyGILState_Release(gstate);
279 pdb->bin_class = bin_class;
281 if (!(pdb->data = g_try_malloc(pdb->size)))
282 return SRD_ERR_MALLOC;
283 memcpy((void *)pdb->data, (const void *)buf, pdb->size);
288 PyGILState_Release(gstate);
290 return SRD_ERR_PYTHON;
293 static inline struct srd_decoder_inst *srd_sess_inst_find_by_obj(
294 struct srd_session *sess, const GSList *stack, const PyObject *obj)
297 struct srd_decoder_inst *tmp, *di;
303 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
305 if (tmp->py_inst == obj)
307 else if (tmp->next_di)
308 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
315 * Find a decoder instance by its Python object.
317 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
318 * This will recurse to find the instance anywhere in the stack tree of all
321 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
322 * stack to search. To start searching at the bottom level of
323 * decoder instances, pass NULL.
324 * @param obj The Python class instantiation.
326 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
330 static inline struct srd_decoder_inst *srd_inst_find_by_obj(
331 const GSList *stack, const PyObject *obj)
333 struct srd_decoder_inst *di;
334 struct srd_session *sess;
337 /* Performance shortcut: Handle the most common case first. */
338 sess = sessions->data;
339 di = sess->di_list->data;
340 if (di->py_inst == obj)
344 for (l = sessions; di == NULL && l != NULL; l = l->next) {
346 di = srd_sess_inst_find_by_obj(sess, stack, obj);
352 static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
356 PyGILState_STATE gstate;
358 gstate = PyGILState_Ensure();
360 if (g_variant_type_equal(pdata->pdo->meta_type, G_VARIANT_TYPE_INT64)) {
361 if (!PyLong_Check(obj)) {
362 PyErr_Format(PyExc_TypeError, "This output was registered "
363 "as 'int', but something else was passed.");
366 intvalue = PyLong_AsLongLong(obj);
367 if (PyErr_Occurred())
369 pdata->data = g_variant_new_int64(intvalue);
370 } else if (g_variant_type_equal(pdata->pdo->meta_type, G_VARIANT_TYPE_DOUBLE)) {
371 if (!PyFloat_Check(obj)) {
372 PyErr_Format(PyExc_TypeError, "This output was registered "
373 "as 'float', but something else was passed.");
376 dvalue = PyFloat_AsDouble(obj);
377 if (PyErr_Occurred())
379 pdata->data = g_variant_new_double(dvalue);
382 PyGILState_Release(gstate);
387 PyGILState_Release(gstate);
389 return SRD_ERR_PYTHON;
392 static void release_meta(GVariant *gvar)
396 g_variant_unref(gvar);
399 PyDoc_STRVAR(Decoder_put_doc,
400 "Accepts a dictionary with the following keys: startsample, endsample, data"
403 static PyObject *Decoder_put(PyObject *self, PyObject *args)
406 PyObject *py_data, *py_res;
407 struct srd_decoder_inst *di, *next_di;
408 struct srd_pd_output *pdo;
409 struct srd_proto_data pdata;
410 struct srd_proto_data_annotation pda;
411 struct srd_proto_data_binary pdb;
412 struct srd_proto_data_logic pdl;
413 uint64_t start_sample, end_sample;
415 struct srd_pd_callback *cb;
416 PyGILState_STATE gstate;
420 gstate = PyGILState_Ensure();
422 if (!(di = srd_inst_find_by_obj(NULL, self))) {
423 /* Shouldn't happen. */
424 srd_dbg("put(): self instance not found.");
428 if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
429 &output_id, &py_data)) {
431 * This throws an exception, but by returning NULL here we let
432 * Python raise it. This results in a much better trace in
433 * controller.c on the decode() method call.
438 if (!(l = g_slist_nth(di->pd_output, output_id))) {
439 srd_err("Protocol decoder %s submitted invalid output ID %d.",
440 di->decoder->name, output_id);
445 /* Upon SRD_OUTPUT_PYTHON for stacked PDs, we have a nicer log message later. */
446 if (pdo->output_type != SRD_OUTPUT_PYTHON && di->next_di != NULL) {
447 srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on "
448 "oid %d (%s).", di->inst_id, start_sample, end_sample,
449 output_type_name(pdo->output_type), output_id,
453 pdata.start_sample = start_sample;
454 pdata.end_sample = end_sample;
458 switch (pdo->output_type) {
460 /* Annotations are only fed to callbacks. */
461 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
463 /* Convert from PyDict to srd_proto_data_annotation. */
464 if (convert_annotation(di, py_data, &pdata) != SRD_OK) {
465 /* An error was already logged. */
468 Py_BEGIN_ALLOW_THREADS
469 cb->cb(&pdata, cb->cb_data);
471 release_annotation(pdata.data);
474 case SRD_OUTPUT_PYTHON:
475 for (l = di->next_di; l; l = l->next) {
477 srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s "
478 "on oid %d (%s) to instance %s.", di->inst_id,
480 end_sample, output_type_name(pdo->output_type),
481 output_id, pdo->proto_id, next_di->inst_id);
482 if (!(py_res = PyObject_CallMethod(
483 next_di->py_inst, "decode", "KKO", start_sample,
484 end_sample, py_data))) {
485 srd_exception_catch("Calling %s decode() failed",
490 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
492 * Frontends aren't really supposed to get Python
493 * callbacks, but it's useful for testing.
495 pdata.data = py_data;
496 cb->cb(&pdata, cb->cb_data);
499 case SRD_OUTPUT_BINARY:
500 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
502 /* Convert from PyDict to srd_proto_data_binary. */
503 if (convert_binary(di, py_data, &pdata) != SRD_OK) {
504 /* An error was already logged. */
507 Py_BEGIN_ALLOW_THREADS
508 cb->cb(&pdata, cb->cb_data);
510 release_binary(pdata.data);
513 case SRD_OUTPUT_LOGIC:
514 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
516 /* Convert from PyDict to srd_proto_data_logic. */
517 if (convert_logic(di, py_data, &pdata) != SRD_OK) {
518 /* An error was already logged. */
521 if (end_sample <= start_sample) {
522 srd_err("Ignored SRD_OUTPUT_LOGIC with invalid sample range.");
525 pdl.repeat_count = (end_sample - start_sample) - 1;
526 Py_BEGIN_ALLOW_THREADS
527 cb->cb(&pdata, cb->cb_data);
529 release_logic(pdata.data);
532 case SRD_OUTPUT_META:
533 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
534 /* Annotations need converting from PyObject. */
535 if (convert_meta(&pdata, py_data) != SRD_OK) {
536 /* An exception was already set up. */
539 Py_BEGIN_ALLOW_THREADS
540 cb->cb(&pdata, cb->cb_data);
542 release_meta(pdata.data);
546 srd_err("Protocol decoder %s submitted invalid output type %d.",
547 di->decoder->name, pdo->output_type);
551 PyGILState_Release(gstate);
556 PyGILState_Release(gstate);
561 PyDoc_STRVAR(Decoder_register_doc,
562 "Register a new output stream"
565 static PyObject *Decoder_register(PyObject *self,
566 PyObject *args, PyObject *kwargs)
568 struct srd_decoder_inst *di;
569 struct srd_pd_output *pdo;
570 PyObject *py_new_output_id;
571 PyTypeObject *meta_type_py;
572 const GVariantType *meta_type_gv;
574 char *proto_id, *meta_name, *meta_descr;
575 char *keywords[] = { "output_type", "proto_id", "meta", NULL };
576 PyGILState_STATE gstate;
579 struct srd_pd_output *cmp;
581 gstate = PyGILState_Ensure();
585 meta_name = meta_descr = NULL;
587 if (!(di = srd_inst_find_by_obj(NULL, self))) {
588 PyErr_SetString(PyExc_Exception, "decoder instance not found");
592 /* Default to instance ID, which defaults to class ID. */
593 proto_id = di->inst_id;
594 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
595 &output_type, &proto_id,
596 &meta_type_py, &meta_name, &meta_descr)) {
597 /* Let Python raise this exception. */
601 /* Check if the meta value's type is supported. */
602 is_meta = output_type == SRD_OUTPUT_META;
604 if (meta_type_py == &PyLong_Type)
605 meta_type_gv = G_VARIANT_TYPE_INT64;
606 else if (meta_type_py == &PyFloat_Type)
607 meta_type_gv = G_VARIANT_TYPE_DOUBLE;
609 PyErr_Format(PyExc_TypeError, "Unsupported type.");
615 for (l = di->pd_output; l; l = l->next) {
617 if (cmp->output_type != output_type)
619 if (strcmp(cmp->proto_id, proto_id) != 0)
621 if (is_meta && cmp->meta_type != meta_type_gv)
623 if (is_meta && strcmp(cmp->meta_name, meta_name) != 0)
625 if (is_meta && strcmp(cmp->meta_descr, meta_descr) != 0)
631 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
632 PyGILState_Release(gstate);
633 return py_new_output_id;
636 pdo = g_malloc(sizeof(struct srd_pd_output));
638 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
639 pdo->pdo_id = g_slist_length(di->pd_output);
640 pdo->output_type = output_type;
642 pdo->proto_id = g_strdup(proto_id);
644 if (output_type == SRD_OUTPUT_META) {
645 pdo->meta_type = meta_type_gv;
646 pdo->meta_name = g_strdup(meta_name);
647 pdo->meta_descr = g_strdup(meta_descr);
650 di->pd_output = g_slist_append(di->pd_output, pdo);
651 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
653 PyGILState_Release(gstate);
655 srd_dbg("Instance %s creating new output type %s as oid %d (%s).",
656 di->inst_id, output_type_name(output_type), pdo->pdo_id,
659 return py_new_output_id;
662 PyGILState_Release(gstate);
667 static int get_term_type(const char *v)
671 return SRD_TERM_HIGH;
675 return SRD_TERM_RISING_EDGE;
677 return SRD_TERM_FALLING_EDGE;
679 return SRD_TERM_EITHER_EDGE;
681 return SRD_TERM_NO_EDGE;
690 * Get the pin values at the current sample number.
692 * @param di The decoder instance to use. Must not be NULL.
693 * The number of channels must be >= 1.
695 * @return A newly allocated PyTuple containing the pin values at the
696 * current sample number.
698 static PyObject *get_current_pinvalues(const struct srd_decoder_inst *di)
702 const uint8_t *sample_pos;
703 int byte_offset, bit_offset;
704 PyObject *py_pinvalues;
705 PyGILState_STATE gstate;
708 srd_err("Invalid decoder instance.");
712 gstate = PyGILState_Ensure();
714 py_pinvalues = PyTuple_New(di->dec_num_channels);
716 for (i = 0; i < di->dec_num_channels; i++) {
717 /* A channelmap value of -1 means "unused optional channel". */
718 if (di->dec_channelmap[i] == -1) {
719 /* Value of unused channel is 0xff, instead of 0 or 1. */
720 PyTuple_SetItem(py_pinvalues, i, PyLong_FromUnsignedLong(0xff));
722 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
723 byte_offset = di->dec_channelmap[i] / 8;
724 bit_offset = di->dec_channelmap[i] % 8;
725 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
726 PyTuple_SetItem(py_pinvalues, i, PyLong_FromUnsignedLong(sample));
730 PyGILState_Release(gstate);
736 * Create a list of terms in the specified condition.
738 * If there are no terms in the condition, 'term_list' will be NULL.
740 * @param di The decoder instance to use. Must not be NULL.
741 * @param py_dict A Python dict containing terms. Must not be NULL.
742 * @param term_list Pointer to a GSList which will be set to the newly
743 * created list of terms. Must not be NULL.
745 * @return SRD_OK upon success, a negative error code otherwise.
747 static int create_term_list(struct srd_decoder_inst *di,
748 PyObject *py_dict, GSList **term_list)
751 PyObject *py_key, *py_value;
752 struct srd_term *term;
753 int64_t num_samples_to_skip;
755 PyGILState_STATE gstate;
757 if (!py_dict || !term_list)
760 /* "Create" an empty GSList of terms. */
763 gstate = PyGILState_Ensure();
765 /* Iterate over all items in the current dict. */
766 while (PyDict_Next(py_dict, &pos, &py_key, &py_value)) {
767 /* Check whether the current key is a string or a number. */
768 if (PyLong_Check(py_key)) {
769 /* The key is a number. */
770 /* Get the value string. */
771 if ((py_pydictitem_as_str(py_dict, py_key, &term_str)) != SRD_OK) {
772 srd_err("Failed to get the value.");
775 term = g_malloc(sizeof(struct srd_term));
776 term->type = get_term_type(term_str);
777 term->channel = PyLong_AsLong(py_key);
778 if (term->channel < 0 || term->channel >= di->dec_num_channels)
779 term->type = SRD_TERM_ALWAYS_FALSE;
781 } else if (PyUnicode_Check(py_key)) {
782 /* The key is a string. */
783 /* TODO: Check if the key is "skip". */
784 if ((py_pydictitem_as_long(py_dict, py_key, &num_samples_to_skip)) != SRD_OK) {
785 srd_err("Failed to get number of samples to skip.");
788 term = g_malloc(sizeof(struct srd_term));
789 term->type = SRD_TERM_SKIP;
790 term->num_samples_to_skip = num_samples_to_skip;
791 term->num_samples_already_skipped = 0;
792 if (num_samples_to_skip < 0)
793 term->type = SRD_TERM_ALWAYS_FALSE;
795 srd_err("Term key is neither a string nor a number.");
799 /* Add the term to the list of terms. */
800 *term_list = g_slist_append(*term_list, term);
803 PyGILState_Release(gstate);
808 PyGILState_Release(gstate);
814 * Replace the current condition list with the new one.
816 * @param self TODO. Must not be NULL.
817 * @param args TODO. Must not be NULL.
819 * @retval SRD_OK The new condition list was set successfully.
820 * @retval SRD_ERR There was an error setting the new condition list.
821 * The contents of di->condition_list are undefined.
824 static int set_new_condition_list(PyObject *self, PyObject *args)
826 struct srd_decoder_inst *di;
828 PyObject *py_conditionlist, *py_conds, *py_dict;
829 int i, num_conditions, ret;
830 PyGILState_STATE gstate;
835 gstate = PyGILState_Ensure();
837 /* Get the decoder instance. */
838 if (!(di = srd_inst_find_by_obj(NULL, self))) {
839 PyErr_SetString(PyExc_Exception, "decoder instance not found");
844 * Return an error condition from .wait() when termination is
845 * requested, such that decode() will terminate.
847 if (di->want_wait_terminate) {
848 srd_dbg("%s: %s: Skip (want_term).", di->inst_id, __func__);
853 * Parse the argument of self.wait() into 'py_conds', and check
854 * the data type. The argument is optional, None is assumed in
855 * its absence. None or an empty dict or an empty list mean that
856 * there is no condition, and the next available sample shall
857 * get returned to the caller.
860 if (!PyArg_ParseTuple(args, "|O", &py_conds)) {
861 /* Let Python raise this exception. */
864 if (py_conds == Py_None) {
865 /* 'py_conds' is None. */
867 } else if (PyList_Check(py_conds)) {
868 /* 'py_conds' is a list. */
869 py_conditionlist = py_conds;
870 num_conditions = PyList_Size(py_conditionlist);
871 if (num_conditions == 0)
872 goto ret_9999; /* The PD invoked self.wait([]). */
873 Py_INCREF(py_conditionlist);
874 } else if (PyDict_Check(py_conds)) {
875 /* 'py_conds' is a dict. */
876 if (PyDict_Size(py_conds) == 0)
877 goto ret_9999; /* The PD invoked self.wait({}). */
878 /* Make a list and put the dict in there for convenience. */
879 py_conditionlist = PyList_New(1);
881 PyList_SetItem(py_conditionlist, 0, py_conds);
884 srd_err("Condition list is neither a list nor a dict.");
888 /* Free the old condition list. */
889 condition_list_free(di);
893 /* Iterate over the conditions, set di->condition_list accordingly. */
894 for (i = 0; i < num_conditions; i++) {
895 /* Get a condition (dict) from the condition list. */
896 py_dict = PyList_GetItem(py_conditionlist, i);
897 if (!PyDict_Check(py_dict)) {
898 srd_err("Condition is not a dict.");
903 /* Create the list of terms in this condition. */
904 if ((ret = create_term_list(di, py_dict, &term_list)) < 0)
907 /* Add the new condition to the PD instance's condition list. */
908 di->condition_list = g_slist_append(di->condition_list, term_list);
911 Py_DecRef(py_conditionlist);
913 PyGILState_Release(gstate);
918 PyGILState_Release(gstate);
923 PyGILState_Release(gstate);
929 * Create a SKIP condition list for condition-less .wait() calls.
931 * @param di Decoder instance.
932 * @param count Number of samples to skip.
934 * @retval SRD_OK The new condition list was set successfully.
935 * @retval SRD_ERR There was an error setting the new condition list.
936 * The contents of di->condition_list are undefined.
938 * This routine is a reduced and specialized version of the @ref
939 * set_new_condition_list() and @ref create_term_list() routines which
940 * gets invoked when .wait() was called without specifications for
941 * conditions. This minor duplication of the SKIP term list creation
942 * simplifies the logic and avoids the creation of expensive Python
943 * objects with "constant" values which the caller did not pass in the
944 * first place. It results in maximum sharing of match handling code
947 static int set_skip_condition(struct srd_decoder_inst *di, uint64_t count)
949 struct srd_term *term;
952 condition_list_free(di);
953 term = g_malloc(sizeof(*term));
954 term->type = SRD_TERM_SKIP;
955 term->num_samples_to_skip = count;
956 term->num_samples_already_skipped = 0;
957 term_list = g_slist_append(NULL, term);
958 di->condition_list = g_slist_append(di->condition_list, term_list);
963 PyDoc_STRVAR(Decoder_wait_doc,
964 "Wait for one or more conditions to occur"
967 static PyObject *Decoder_wait(PyObject *self, PyObject *args)
972 gboolean found_match;
973 struct srd_decoder_inst *di;
974 PyObject *py_pinvalues, *py_matched, *py_samplenum;
975 PyGILState_STATE gstate;
980 gstate = PyGILState_Ensure();
982 if (!(di = srd_inst_find_by_obj(NULL, self))) {
983 PyErr_SetString(PyExc_Exception, "decoder instance not found");
984 PyGILState_Release(gstate);
988 ret = set_new_condition_list(self, args);
990 srd_dbg("%s: %s: Aborting wait().", di->inst_id, __func__);
995 * Empty condition list, automatic match. Arrange for the
996 * execution of regular match handling code paths such that
997 * the next available sample is returned to the caller.
998 * Make sure to skip one sample when "anywhere within the
999 * stream", yet make sure to not skip sample number 0.
1001 if (di->abs_cur_samplenum)
1003 else if (!di->condition_list)
1007 ret = set_skip_condition(di, skip_count);
1009 srd_dbg("%s: %s: Cannot setup condition-less wait().",
1010 di->inst_id, __func__);
1017 Py_BEGIN_ALLOW_THREADS
1019 /* Wait for new samples to process, or termination request. */
1020 g_mutex_lock(&di->data_mutex);
1021 while (!di->got_new_samples && !di->want_wait_terminate)
1022 g_cond_wait(&di->got_new_samples_cond, &di->data_mutex);
1025 * Check whether any of the current condition(s) match.
1026 * Arrange for termination requests to take a code path which
1027 * won't find new samples to process, pretends to have processed
1028 * previously stored samples, and returns to the main thread,
1029 * while the termination request still gets signalled.
1031 found_match = FALSE;
1033 /* Ignore return value for now, should never be negative. */
1034 (void)process_samples_until_condition_match(di, &found_match);
1036 Py_END_ALLOW_THREADS
1038 /* If there's a match, set self.samplenum etc. and return. */
1040 /* Set self.samplenum to the (absolute) sample number that matched. */
1041 py_samplenum = PyLong_FromUnsignedLongLong(di->abs_cur_samplenum);
1042 PyObject_SetAttrString(di->py_inst, "samplenum", py_samplenum);
1043 Py_DECREF(py_samplenum);
1045 if (di->match_array && di->match_array->len > 0) {
1046 py_matched = PyTuple_New(di->match_array->len);
1047 for (i = 0; i < di->match_array->len; i++)
1048 PyTuple_SetItem(py_matched, i, PyBool_FromLong(di->match_array->data[i]));
1049 PyObject_SetAttrString(di->py_inst, "matched", py_matched);
1050 Py_DECREF(py_matched);
1051 match_array_free(di);
1053 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
1056 py_pinvalues = get_current_pinvalues(di);
1058 g_mutex_unlock(&di->data_mutex);
1060 PyGILState_Release(gstate);
1062 return py_pinvalues;
1065 /* No match, reset state for the next chunk. */
1066 di->got_new_samples = FALSE;
1067 di->handled_all_samples = TRUE;
1068 di->abs_start_samplenum = 0;
1069 di->abs_end_samplenum = 0;
1073 /* Signal the main thread that we handled all samples. */
1074 g_cond_signal(&di->handled_all_samples_cond);
1077 * When termination of wait() and decode() was requested,
1078 * then exit the loop after releasing the mutex.
1080 if (di->want_wait_terminate) {
1081 srd_dbg("%s: %s: Will return from wait().",
1082 di->inst_id, __func__);
1083 g_mutex_unlock(&di->data_mutex);
1087 g_mutex_unlock(&di->data_mutex);
1090 PyGILState_Release(gstate);
1095 PyGILState_Release(gstate);
1100 PyDoc_STRVAR(Decoder_has_channel_doc,
1101 "Report whether a channel was supplied"
1105 * Return whether the specified channel was supplied to the decoder.
1107 * @param self TODO. Must not be NULL.
1108 * @param args TODO. Must not be NULL.
1110 * @retval Py_True The channel has been supplied by the frontend.
1111 * @retval Py_False The channel has been supplied by the frontend.
1112 * @retval NULL An error occurred.
1114 static PyObject *Decoder_has_channel(PyObject *self, PyObject *args)
1117 struct srd_decoder_inst *di;
1118 PyGILState_STATE gstate;
1124 gstate = PyGILState_Ensure();
1126 if (!(di = srd_inst_find_by_obj(NULL, self))) {
1127 PyErr_SetString(PyExc_Exception, "decoder instance not found");
1132 * Get the integer argument of self.has_channel(). Check for
1133 * the range of supported PD input channel numbers.
1135 if (!PyArg_ParseTuple(args, "i", &idx)) {
1136 /* Let Python raise this exception. */
1140 count = g_slist_length(di->decoder->channels) +
1141 g_slist_length(di->decoder->opt_channels);
1142 if (idx < 0 || idx >= count) {
1143 srd_err("Invalid index %d, PD channel count %d.", idx, count);
1144 PyErr_SetString(PyExc_IndexError, "invalid channel index");
1148 PyGILState_Release(gstate);
1150 bool_ret = (di->dec_channelmap[idx] == -1) ? Py_False : Py_True;
1151 Py_INCREF(bool_ret);
1155 PyGILState_Release(gstate);
1160 PyDoc_STRVAR(Decoder_doc, "sigrok Decoder base class");
1162 static PyMethodDef Decoder_methods[] = {
1164 Decoder_put, METH_VARARGS,
1168 (PyCFunction)(void(*)(void))Decoder_register, METH_VARARGS | METH_KEYWORDS,
1169 Decoder_register_doc,
1172 Decoder_wait, METH_VARARGS,
1176 Decoder_has_channel, METH_VARARGS,
1177 Decoder_has_channel_doc,
1179 {NULL, NULL, 0, NULL}
1183 * Create the sigrokdecode.Decoder type.
1185 * @return The new type object.
1189 SRD_PRIV PyObject *srd_Decoder_type_new(void)
1192 PyType_Slot slots[] = {
1193 { Py_tp_doc, Decoder_doc },
1194 { Py_tp_methods, Decoder_methods },
1195 { Py_tp_new, (void *)&PyType_GenericNew },
1199 PyGILState_STATE gstate;
1201 gstate = PyGILState_Ensure();
1203 spec.name = "sigrokdecode.Decoder";
1204 spec.basicsize = sizeof(srd_Decoder);
1206 spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
1209 py_obj = PyType_FromSpec(&spec);
1211 PyGILState_Release(gstate);