2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode.h"
31 extern SRD_PRIV GSList *sessions;
33 /* module_sigrokdecode.c */
34 extern SRD_PRIV PyObject *srd_logic_type;
41 * Decoder instance handling.
45 * @defgroup grp_instances Decoder instances
47 * Decoder instance handling.
53 * Set one or more options in a decoder instance.
55 * Handled options are removed from the hash.
57 * @param di Decoder instance.
58 * @param options A GHashTable of options to set.
60 * @return SRD_OK upon success, a (negative) error code otherwise.
64 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
67 struct srd_decoder_option *sdo;
68 PyObject *py_di_options, *py_optval;
77 srd_err("Invalid decoder instance.");
82 srd_err("Invalid options GHashTable.");
86 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
87 /* Decoder has no options. */
88 if (g_hash_table_size(options) == 0) {
89 /* No options provided. */
92 srd_err("Protocol decoder has no options.");
102 * The 'options' tuple is a class variable, but we need to
103 * change it. Changing it directly will affect the entire class,
104 * so we need to create a new object for it, and populate that
107 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
109 Py_DECREF(py_di_options);
110 py_di_options = PyDict_New();
111 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
113 for (l = di->decoder->options; l; l = l->next) {
115 if ((value = g_hash_table_lookup(options, sdo->id))) {
116 /* A value was supplied for this option. */
117 if (!g_variant_type_equal(g_variant_get_type(value),
118 g_variant_get_type(sdo->def))) {
119 srd_err("Option '%s' should have the same type "
120 "as the default value.", sdo->id);
124 /* Use default for this option. */
127 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
128 val_str = g_variant_get_string(value, NULL);
129 if (!(py_optval = PyUnicode_FromString(val_str))) {
130 /* Some UTF-8 encoding error. */
132 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
135 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
136 val_int = g_variant_get_int64(value);
137 if (!(py_optval = PyLong_FromLong(val_int))) {
138 /* ValueError Exception */
140 srd_err("Option '%s' has invalid integer value.", sdo->id);
143 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
144 val_double = g_variant_get_double(value);
145 if (!(py_optval = PyFloat_FromDouble(val_double))) {
146 /* ValueError Exception */
148 srd_err("Option '%s' has invalid float value.",
153 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
155 /* Not harmful even if we used the default. */
156 g_hash_table_remove(options, sdo->id);
158 if (g_hash_table_size(options) != 0)
159 srd_warn("Unknown options specified for '%s'", di->inst_id);
164 Py_XDECREF(py_optval);
165 if (PyErr_Occurred()) {
166 srd_exception_catch("Stray exception in srd_inst_option_set()");
167 ret = SRD_ERR_PYTHON;
173 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */
174 static gint compare_channel_id(const struct srd_channel *pdch,
175 const char *channel_id)
177 return strcmp(pdch->id, channel_id);
181 * Set all channels in a decoder instance.
183 * This function sets _all_ channels for the specified decoder instance, i.e.,
184 * it overwrites any channels that were already defined (if any).
186 * @param di Decoder instance.
187 * @param new_channels A GHashTable of channels to set. Key is channel name,
188 * value is the channel number. Samples passed to this
189 * instance will be arranged in this order.
191 * @return SRD_OK upon success, a (negative) error code otherwise.
195 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
196 GHashTable *new_channels)
198 GVariant *channel_val;
201 struct srd_channel *pdch;
202 int *new_channelmap, new_channelnum, num_required_channels, i;
205 srd_dbg("Setting channels for instance %s with list of %d channels.",
206 di->inst_id, g_hash_table_size(new_channels));
208 if (g_hash_table_size(new_channels) == 0)
209 /* No channels provided. */
212 if (di->dec_num_channels == 0) {
213 /* Decoder has no channels. */
214 srd_err("Protocol decoder %s has no channels to define.",
219 new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
222 * For now, map all indexes to channel -1 (can be overridden later).
223 * This -1 is interpreted as an unspecified channel later.
225 for (i = 0; i < di->dec_num_channels; i++)
226 new_channelmap[i] = -1;
228 for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
229 channel_id = l->data;
230 channel_val = g_hash_table_lookup(new_channels, channel_id);
231 if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
232 /* Channel name was specified without a value. */
233 srd_err("No channel number was specified for %s.",
235 g_free(new_channelmap);
238 new_channelnum = g_variant_get_int32(channel_val);
239 if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
240 (GCompareFunc)compare_channel_id))) {
241 /* Fall back on optional channels. */
242 if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
243 channel_id, (GCompareFunc)compare_channel_id))) {
244 srd_err("Protocol decoder %s has no channel "
245 "'%s'.", di->decoder->name, channel_id);
246 g_free(new_channelmap);
251 new_channelmap[pdch->order] = new_channelnum;
252 srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
253 pdch->id, pdch->order, new_channelnum);
256 srd_dbg("Final channel map:");
257 num_required_channels = g_slist_length(di->decoder->channels);
258 for (i = 0; i < di->dec_num_channels; i++) {
259 srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i],
260 (i < num_required_channels) ? "required" : "optional");
263 /* Report an error if not all required channels were specified. */
264 for (i = 0; i < num_required_channels; i++) {
265 if (new_channelmap[i] != -1)
267 pdch = g_slist_nth(di->decoder->channels, i)->data;
268 srd_err("Required channel '%s' (index %d) was not specified.",
273 g_free(di->dec_channelmap);
274 di->dec_channelmap = new_channelmap;
280 * Create a new protocol decoder instance.
282 * @param sess The session holding the protocol decoder instance.
283 * @param decoder_id Decoder 'id' field.
284 * @param options GHashtable of options which override the defaults set in
285 * the decoder class. May be NULL.
287 * @return Pointer to a newly allocated struct srd_decoder_inst, or
288 * NULL in case of failure.
292 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
293 const char *decoder_id, GHashTable *options)
296 struct srd_decoder *dec;
297 struct srd_decoder_inst *di;
301 srd_dbg("Creating new %s instance.", decoder_id);
303 if (session_is_valid(sess) != SRD_OK) {
304 srd_err("Invalid session.");
308 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
309 srd_err("Protocol decoder %s not found.", decoder_id);
313 di = g_malloc0(sizeof(struct srd_decoder_inst));
319 inst_id = g_hash_table_lookup(options, "id");
321 di->inst_id = g_strdup(inst_id);
322 g_hash_table_remove(options, "id");
325 /* Create a unique instance ID (as none was provided). */
327 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
328 while (srd_inst_find_by_id(sess, di->inst_id)) {
330 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
335 * Prepare a default channel map, where samples come in the
336 * order in which the decoder class defined them.
338 di->dec_num_channels = g_slist_length(di->decoder->channels) +
339 g_slist_length(di->decoder->opt_channels);
340 if (di->dec_num_channels) {
342 g_malloc(sizeof(int) * di->dec_num_channels);
343 for (i = 0; i < di->dec_num_channels; i++)
344 di->dec_channelmap[i] = i;
346 * Will be used to prepare a sample at every iteration
347 * of the instance's decode() method.
349 di->channel_samples = g_malloc(di->dec_num_channels);
352 /* Create a new instance of this decoder class. */
353 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
354 if (PyErr_Occurred())
355 srd_exception_catch("Failed to create %s instance",
357 g_free(di->dec_channelmap);
362 if (options && srd_inst_option_set(di, options) != SRD_OK) {
363 g_free(di->dec_channelmap);
368 di->condition_list = NULL;
369 di->match_array = NULL;
370 di->abs_start_samplenum = 0;
371 di->abs_end_samplenum = 0;
374 di->abs_cur_samplenum = 0;
375 di->old_pins_array = NULL;
376 di->thread_handle = NULL;
377 di->got_new_samples = FALSE;
378 di->handled_all_samples = FALSE;
380 /* Instance takes input from a frontend by default. */
381 sess->di_list = g_slist_append(sess->di_list, di);
382 srd_dbg("Created new %s instance with ID %s.", decoder_id, di->inst_id);
388 * Stack a decoder instance on top of another.
390 * @param sess The session holding the protocol decoder instances.
391 * @param di_bottom The instance on top of which di_top will be stacked.
392 * @param di_top The instance to go on top.
394 * @return SRD_OK upon success, a (negative) error code otherwise.
398 SRD_API int srd_inst_stack(struct srd_session *sess,
399 struct srd_decoder_inst *di_bottom,
400 struct srd_decoder_inst *di_top)
403 if (session_is_valid(sess) != SRD_OK) {
404 srd_err("Invalid session.");
408 if (!di_bottom || !di_top) {
409 srd_err("Invalid from/to instance pair.");
413 if (g_slist_find(sess->di_list, di_top)) {
414 /* Remove from the unstacked list. */
415 sess->di_list = g_slist_remove(sess->di_list, di_top);
418 /* Stack on top of source di. */
419 di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
421 srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
427 * Search a decoder instance and its stack for instance ID.
429 * @param[in] inst_id ID to search for.
430 * @param[in] stack A decoder instance, potentially with stacked instances.
432 * @return The matching instance, or NULL.
434 static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id,
435 struct srd_decoder_inst *stack)
438 struct srd_decoder_inst *tmp, *di;
440 if (!strcmp(stack->inst_id, inst_id))
443 /* Otherwise, look recursively in our stack. */
445 if (stack->next_di) {
446 for (l = stack->next_di; l; l = l->next) {
448 if (!strcmp(tmp->inst_id, inst_id)) {
459 * Find a decoder instance by its instance ID.
461 * This will recurse to find the instance anywhere in the stack tree of the
464 * @param sess The session holding the protocol decoder instance.
465 * @param inst_id The instance ID to be found.
467 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
471 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
475 struct srd_decoder_inst *tmp, *di;
477 if (session_is_valid(sess) != SRD_OK) {
478 srd_err("Invalid session.");
483 for (l = sess->di_list; l; l = l->next) {
485 if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL)
492 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
493 struct srd_session *sess, const GSList *stack,
497 struct srd_decoder_inst *tmp, *di;
499 if (session_is_valid(sess) != SRD_OK) {
500 srd_err("Invalid session.");
505 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
507 if (tmp->py_inst == obj)
509 else if (tmp->next_di)
510 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
517 * Find a decoder instance by its Python object.
519 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
520 * This will recurse to find the instance anywhere in the stack tree of all
523 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
524 * stack to search. To start searching at the bottom level of
525 * decoder instances, pass NULL.
526 * @param obj The Python class instantiation.
528 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
534 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
537 struct srd_decoder_inst *di;
538 struct srd_session *sess;
542 for (l = sessions; di == NULL && l != NULL; l = l->next) {
544 di = srd_sess_inst_find_by_obj(sess, stack, obj);
551 * Set the list of initial (assumed) pin values.
553 * If the list already exists, do nothing.
555 * @param di Decoder instance to use. Must not be NULL.
559 static void set_initial_pin_values(struct srd_decoder_inst *di)
563 PyObject *py_initial_pins;
565 if (!di || !di->py_inst) {
566 srd_err("Invalid decoder instance.");
570 /* Nothing to do if di->old_pins_array is already != NULL. */
571 if (di->old_pins_array) {
572 srd_dbg("Initial pins already set, nothing to do.");
576 /* Create an array of old (previous sample) pins, init to 0. */
577 di->old_pins_array = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), di->dec_num_channels);
578 g_array_set_size(di->old_pins_array, di->dec_num_channels);
580 /* Check if the decoder has set self.initial_pins. */
581 if (!PyObject_HasAttrString(di->py_inst, "initial_pins")) {
582 srd_dbg("Initial pins: all 0 (self.initial_pins not set).");
586 /* Get self.initial_pins. */
587 py_initial_pins = PyObject_GetAttrString(di->py_inst, "initial_pins");
589 /* Fill di->old_pins_array based on self.initial_pins. */
590 s = g_string_sized_new(100);
591 for (i = 0; i < di->dec_num_channels; i++) {
592 di->old_pins_array->data[i] = PyLong_AsLong(PyList_GetItem(py_initial_pins, i));
593 g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]);
595 s = g_string_truncate(s, s->len - 2);
596 srd_dbg("Initial pins: %s.", s->str);
597 g_string_free(s, TRUE);
601 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
605 struct srd_decoder_inst *next_di;
608 srd_dbg("Calling start() method on protocol decoder instance %s.",
611 /* Run self.start(). */
612 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
613 srd_exception_catch("Protocol decoder instance %s",
615 return SRD_ERR_PYTHON;
619 /* Set the initial pins based on self.initial_pins. */
620 set_initial_pin_values(di);
622 /* Set self.samplenum to 0. */
623 PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0));
625 /* Set self.matched to None. */
626 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
628 /* Start all the PDs stacked on top of this one. */
629 for (l = di->next_di; l; l = l->next) {
631 if ((ret = srd_inst_start(next_di)) != SRD_OK)
639 * Check whether the specified sample matches the specified term.
641 * In the case of SRD_TERM_SKIP, this function can modify
642 * term->num_samples_already_skipped.
644 * @param old_sample The value of the previous sample (0/1).
645 * @param sample The value of the current sample (0/1).
646 * @param term The term that should be checked for a match. Must not be NULL.
648 * @retval TRUE The current sample matches the specified term.
649 * @retval FALSE The current sample doesn't match the specified term, or an
650 * invalid term was provided.
654 static gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
659 switch (term->type) {
668 case SRD_TERM_RISING_EDGE:
669 if (old_sample == 0 && sample == 1)
672 case SRD_TERM_FALLING_EDGE:
673 if (old_sample == 1 && sample == 0)
676 case SRD_TERM_EITHER_EDGE:
677 if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1))
680 case SRD_TERM_NO_EDGE:
681 if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1))
685 if (term->num_samples_already_skipped == term->num_samples_to_skip)
687 term->num_samples_already_skipped++;
690 srd_err("Unknown term type %d.", term->type);
697 SRD_PRIV void match_array_free(struct srd_decoder_inst *di)
699 if (!di || !di->match_array)
702 g_array_free(di->match_array, TRUE);
703 di->match_array = NULL;
706 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di)
713 for (l = di->condition_list; l; l = l->next) {
716 g_slist_free_full(ll, g_free);
719 di->condition_list = NULL;
722 static gboolean have_non_null_conds(const struct srd_decoder_inst *di)
729 for (l = di->condition_list; l; l = l->next) {
738 static void update_old_pins_array(struct srd_decoder_inst *di,
739 const uint8_t *sample_pos)
742 int i, byte_offset, bit_offset;
744 if (!di || !di->dec_channelmap || !sample_pos)
747 for (i = 0; i < di->dec_num_channels; i++) {
748 byte_offset = di->dec_channelmap[i] / 8;
749 bit_offset = di->dec_channelmap[i] % 8;
750 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
751 di->old_pins_array->data[i] = sample;
755 static gboolean term_matches(const struct srd_decoder_inst *di,
756 struct srd_term *term, const uint8_t *sample_pos)
758 uint8_t old_sample, sample;
759 int byte_offset, bit_offset, ch;
761 if (!di || !di->dec_channelmap || !term || !sample_pos)
764 /* Overwritten below (or ignored for SRD_TERM_SKIP). */
765 old_sample = sample = 0;
767 if (term->type != SRD_TERM_SKIP) {
769 byte_offset = di->dec_channelmap[ch] / 8;
770 bit_offset = di->dec_channelmap[ch] % 8;
771 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
772 old_sample = di->old_pins_array->data[ch];
775 return sample_matches(old_sample, sample, term);
778 static gboolean all_terms_match(const struct srd_decoder_inst *di,
779 const GSList *cond, const uint8_t *sample_pos)
782 struct srd_term *term;
784 if (!di || !cond || !sample_pos)
787 for (l = cond; l; l = l->next) {
789 if (!term_matches(di, term, sample_pos))
796 static gboolean at_least_one_condition_matched(
797 const struct srd_decoder_inst *di, unsigned int num_conditions)
804 for (i = 0; i < num_conditions; i++) {
805 if (di->match_array->data[i])
812 static gboolean find_match(struct srd_decoder_inst *di)
814 static uint64_t s = 0;
815 uint64_t i, j, num_samples_to_process;
817 const uint8_t *sample_pos;
818 unsigned int num_conditions;
820 /* Check whether the condition list is NULL/empty. */
821 if (!di->condition_list) {
822 srd_dbg("NULL/empty condition list, automatic match.");
826 /* Check whether we have any non-NULL conditions. */
827 if (!have_non_null_conds(di)) {
828 srd_dbg("Only NULL conditions in list, automatic match.");
832 num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum;
833 num_conditions = g_slist_length(di->condition_list);
835 /* di->match_array is NULL here. Create a new GArray. */
836 di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions);
837 g_array_set_size(di->match_array, num_conditions);
839 for (i = 0, s = 0; i < num_samples_to_process; i++, s++, (di->abs_cur_samplenum)++) {
841 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
843 /* Check whether the current sample matches at least one of the conditions (logical OR). */
844 /* IMPORTANT: We need to check all conditions, even if there was a match already! */
845 for (l = di->condition_list, j = 0; l; l = l->next, j++) {
849 /* All terms in 'cond' must match (logical AND). */
850 di->match_array->data[j] = all_terms_match(di, cond, sample_pos);
853 update_old_pins_array(di, sample_pos);
855 /* If at least one condition matched we're done. */
856 if (at_least_one_condition_matched(di, num_conditions))
864 * Process available samples and check if they match the defined conditions.
866 * This function returns if there is an error, or when a match is found, or
867 * when all samples have been processed (whether a match was found or not).
869 * @param di The decoder instance to use. Must not be NULL.
870 * @param found_match Will be set to TRUE if at least one condition matched,
871 * FALSE otherwise. Must not be NULL.
873 * @retval SRD_OK No errors occured, see found_match for the result.
874 * @retval SRD_ERR_ARG Invalid arguments.
878 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match)
880 if (!di || !found_match)
883 /* Check if any of the current condition(s) match. */
885 /* Feed the (next chunk of the) buffer to find_match(). */
886 *found_match = find_match(di);
888 /* Did we handle all samples yet? */
889 if (di->abs_cur_samplenum >= di->abs_end_samplenum) {
890 srd_dbg("Done, handled all samples (abs cur %" PRIu64
891 " / abs end %" PRIu64 ").",
892 di->abs_cur_samplenum, di->abs_end_samplenum);
896 /* If we didn't find a match, continue looking. */
900 /* At least one condition matched, return. */
908 * Worker thread (per PD-stack).
910 * @param data Pointer to the lowest-level PD's device instance.
913 * @return NULL if there was an error.
915 static gpointer di_thread(gpointer data)
918 struct srd_decoder_inst *di;
925 /* Call self.decode(). Only returns if the PD throws an exception. */
926 Py_IncRef(di->py_inst);
927 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", NULL))) {
928 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
929 exit(1); /* TODO: Proper shutdown. This is a hack. */
938 * Decode a chunk of samples.
940 * The calls to this function must provide the samples that shall be
941 * used by the protocol decoder
942 * - in the correct order ([...]5, 6, 4, 7, 8[...] is a bug),
943 * - starting from sample zero (2, 3, 4, 5, 6[...] is a bug),
944 * - consecutively, with no gaps (0, 1, 2, 4, 5[...] is a bug).
946 * The start- and end-sample numbers are absolute sample numbers (relative
947 * to the start of the whole capture/file/stream), i.e. they are not relative
948 * sample numbers within the chunk specified by 'inbuf' and 'inbuflen'.
950 * Correct example (4096 samples total, 4 chunks @ 1024 samples each):
951 * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
952 * srd_inst_decode(di, 1024, 2047, inbuf, 1024, 1);
953 * srd_inst_decode(di, 2048, 3071, inbuf, 1024, 1);
954 * srd_inst_decode(di, 3072, 4095, inbuf, 1024, 1);
956 * The chunk size ('inbuflen') can be arbitrary and can differ between calls.
958 * Correct example (4096 samples total, 7 chunks @ various samples each):
959 * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
960 * srd_inst_decode(di, 1024, 1123, inbuf, 100, 1);
961 * srd_inst_decode(di, 1124, 1423, inbuf, 300, 1);
962 * srd_inst_decode(di, 1424, 1642, inbuf, 219, 1);
963 * srd_inst_decode(di, 1643, 2047, inbuf, 405, 1);
964 * srd_inst_decode(di, 2048, 3071, inbuf, 1024, 1);
965 * srd_inst_decode(di, 3072, 4095, inbuf, 1024, 1);
967 * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but
968 * the start- and end-samplenumbers are not absolute):
969 * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
970 * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
971 * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
972 * srd_inst_decode(di, 0, 1023, inbuf, 1024, 1);
974 * @param di The decoder instance to call. Must not be NULL.
975 * @param abs_start_samplenum The absolute starting sample number for the
976 * buffer's sample set, relative to the start of capture.
977 * @param abs_end_samplenum The absolute ending sample number for the
978 * buffer's sample set, relative to the start of capture.
979 * @param inbuf The buffer to decode. Must not be NULL.
980 * @param inbuflen Length of the buffer. Must be > 0.
981 * @param unitsize The number of bytes per sample. Must be > 0.
983 * @return SRD_OK upon success, a (negative) error code otherwise.
987 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
988 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
989 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
995 /* Return an error upon unusable input. */
997 srd_dbg("empty decoder instance");
1001 srd_dbg("NULL buffer pointer");
1004 if (inbuflen == 0) {
1005 srd_dbg("empty buffer");
1008 if (unitsize == 0) {
1009 srd_dbg("unitsize 0");
1013 di->data_unitsize = unitsize;
1015 srd_dbg("Decoding: abs start sample %" PRIu64 ", abs end sample %"
1016 PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
1017 "%d), instance %s.", abs_start_samplenum, abs_end_samplenum,
1018 abs_end_samplenum - abs_start_samplenum, inbuflen, di->data_unitsize,
1021 apiver = srd_decoder_apiver(di->decoder);
1025 * Create new srd_logic object. Each iteration around the PD's
1026 * loop will fill one sample into this object.
1028 logic = PyObject_New(srd_logic, (PyTypeObject *)srd_logic_type);
1030 logic->di = (struct srd_decoder_inst *)di;
1031 logic->abs_start_samplenum = abs_start_samplenum;
1033 logic->inbuf = (uint8_t *)inbuf;
1034 logic->inbuflen = inbuflen;
1035 logic->sample = PyList_New(2);
1036 Py_INCREF(logic->sample);
1038 Py_IncRef(di->py_inst);
1039 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
1040 "KKO", abs_start_samplenum, abs_end_samplenum, logic))) {
1041 srd_exception_catch("Protocol decoder instance %s",
1043 return SRD_ERR_PYTHON;
1047 /* If this is the first call, start the worker thread. */
1048 if (!di->thread_handle)
1049 di->thread_handle = g_thread_new("di_thread",
1052 /* Push the new sample chunk to the worker thread. */
1053 g_mutex_lock(&di->data_mutex);
1054 di->abs_start_samplenum = abs_start_samplenum;
1055 di->abs_end_samplenum = abs_end_samplenum;
1057 di->inbuflen = inbuflen;
1058 di->got_new_samples = TRUE;
1059 di->handled_all_samples = FALSE;
1061 /* Signal the thread that we have new data. */
1062 g_cond_signal(&di->got_new_samples_cond);
1063 g_mutex_unlock(&di->data_mutex);
1065 /* When all samples in this chunk were handled, return. */
1066 g_mutex_lock(&di->data_mutex);
1067 while (!di->handled_all_samples)
1068 g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex);
1069 g_mutex_unlock(&di->data_mutex);
1076 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
1079 struct srd_pd_output *pdo;
1081 srd_dbg("Freeing instance %s", di->inst_id);
1083 Py_DecRef(di->py_inst);
1084 g_free(di->inst_id);
1085 g_free(di->dec_channelmap);
1086 g_free(di->channel_samples);
1087 g_slist_free(di->next_di);
1088 for (l = di->pd_output; l; l = l->next) {
1090 g_free(pdo->proto_id);
1093 g_slist_free(di->pd_output);
1098 SRD_PRIV void srd_inst_free_all(struct srd_session *sess)
1100 if (session_is_valid(sess) != SRD_OK) {
1101 srd_err("Invalid session.");
1105 g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free);