07016740a9cab4afe054ebe8272c1b352c78c7cf
[libsigrokdecode.git] / controller.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
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.
11  *
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.
16  *
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/>.
19  */
20
21 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "sigrokdecode-internal.h"
23 #include "config.h"
24 #include <glib.h>
25 #include <inttypes.h>
26 #include <stdlib.h>
27
28 /* List of decoder instances. */
29 static GSList *di_list = NULL;
30
31 /* List of frontend callbacks to receive PD output. */
32 static GSList *callbacks = NULL;
33
34 /* decoder.c */
35 extern SRD_PRIV GSList *pd_list;
36
37 /* module_sigrokdecode.c */
38 extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void);
39
40 /* type_logic.c */
41 extern SRD_PRIV PyTypeObject srd_logic_type;
42
43 /**
44  * Initialize libsigrokdecode.
45  *
46  * This initializes the Python interpreter, and creates and initializes
47  * a "sigrok" Python module with a single put() method.
48  *
49  * Then, it searches for sigrok protocol decoder files (*.py) in the
50  * "decoders" subdirectory of the the sigrok installation directory.
51  * All decoders that are found are loaded into memory and added to an
52  * internal list of decoders, which can be queried via srd_list_decoders().
53  *
54  * The caller is responsible for calling the clean-up function srd_exit(),
55  * which will properly shut down libsigrokdecode and free its allocated memory.
56  *
57  * Multiple calls to srd_init(), without calling srd_exit() in between,
58  * are not allowed.
59  *
60  * @param path Path to an extra directory containing protocol decoders
61  *              which will be added to the python sys.path, or NULL.
62  *
63  * @return SRD_OK upon success, a (negative) error code otherwise.
64  *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
65  *         directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
66  *         If not enough memory could be allocated, return SRD_ERR_MALLOC.
67  */
68 SRD_API int srd_init(char *path)
69 {
70         int ret;
71         char *env_path;
72
73         srd_dbg("Initializing libsigrokdecode.");
74
75         /* Add our own module to the list of built-in modules. */
76         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
77
78         /* Initialize the Python interpreter. */
79         Py_Initialize();
80
81         /* Installed decoders. */
82         if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) {
83                 Py_Finalize();
84                 return ret;
85         }
86
87         /* Path specified by the user. */
88         if (path) {
89                 if ((ret = add_modulepath(path)) != SRD_OK) {
90                         Py_Finalize();
91                         return ret;
92                 }
93         }
94
95         /* Environment variable overrides everything, for debugging. */
96         if ((env_path = getenv("SIGROKDECODE_DIR"))) {
97                 if ((ret = add_modulepath(path)) != SRD_OK) {
98                         Py_Finalize();
99                         return ret;
100                 }
101         }
102
103         if ((ret = srd_load_all_decoders()) != SRD_OK) {
104                 Py_Finalize();
105                 return ret;
106         }
107
108         return SRD_OK;
109 }
110
111 /**
112  * Shutdown libsigrokdecode.
113  *
114  * This frees all the memory allocated for protocol decoders and shuts down
115  * the Python interpreter.
116  *
117  * This function should only be called if there was a (successful!) invocation
118  * of srd_init() before. Calling this function multiple times in a row, without
119  * any successful srd_init() calls in between, is not allowed.
120  *
121  * @return SRD_OK upon success, a (negative) error code otherwise.
122  */
123 SRD_API int srd_exit(void)
124 {
125         srd_dbg("Exiting libsigrokdecode.");
126
127         srd_unload_all_decoders();
128         g_slist_free(pd_list);
129
130         /* Py_Finalize() returns void, any finalization errors are ignored. */
131         Py_Finalize();
132
133         return SRD_OK;
134 }
135
136 /**
137  * Add an additional search directory for the protocol decoders.
138  *
139  * The specified directory is prepended (not appended!) to Python's sys.path,
140  * in order to search for sigrok protocol decoders in the specified
141  * directories first, and in the generic Python module directories (and in
142  * the current working directory) last. This avoids conflicts if there are
143  * Python modules which have the same name as a sigrok protocol decoder in
144  * sys.path or in the current working directory.
145  *
146  * @param path Path to an extra directory containing protocol decoders
147  *              which will be added to the python sys.path, or NULL.
148  *
149  * @return SRD_OK upon success, a (negative) error code otherwise.
150  */
151 SRD_PRIV int add_modulepath(const char *path)
152 {
153         PyObject *py_cur_path, *py_item;
154         GString *new_path;
155         int wc_len, i;
156         wchar_t *wc_new_path;
157         char *item;
158
159         srd_dbg("adding %s to module path", path);
160
161         new_path = g_string_sized_new(256);
162         g_string_assign(new_path, g_strdup(path));
163         py_cur_path = PySys_GetObject("path");
164         for (i = 0; i < PyList_Size(py_cur_path); i++) {
165                 g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S));
166                 py_item = PyList_GetItem(py_cur_path, i);
167                 if (!PyUnicode_Check(py_item))
168                         /* Shouldn't happen. */
169                         continue;
170                 if (py_str_as_str(py_item, &item) != SRD_OK)
171                         continue;
172                 g_string_append(new_path, item);
173         }
174
175         /* Convert to wide chars. */
176         wc_len = sizeof(wchar_t) * (new_path->len + 1);
177         if (!(wc_new_path = g_try_malloc(wc_len))) {
178                 srd_dbg("malloc failed");
179                 return SRD_ERR_MALLOC;
180         }
181         mbstowcs(wc_new_path, new_path->str, wc_len);
182         PySys_SetPath(wc_new_path);
183         g_string_free(new_path, TRUE);
184         g_free(wc_new_path);
185
186 //#ifdef _WIN32
187 //      gchar **splitted;
188 //
189 //      /*
190 //       * On Windows/MinGW, Python's sys.path needs entries of the form
191 //       * 'C:\\foo\\bar' instead of '/foo/bar'.
192 //       */
193 //
194 //      splitted = g_strsplit(DECODERS_DIR, "/", 0);
195 //      path = g_build_pathv("\\\\", splitted);
196 //      g_strfreev(splitted);
197 //#else
198 //      path = g_strdup(DECODERS_DIR);
199 //#endif
200
201         return SRD_OK;
202 }
203
204 /**
205  * Set options in a decoder instance.
206  *
207  * @param di Decoder instance.
208  * @param options A GHashTable of options to set.
209  *
210  * Handled options are removed from the hash.
211  *
212  * @return SRD_OK upon success, a (negative) error code otherwise.
213  */
214 SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
215                                      GHashTable *options)
216 {
217         PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
218         PyObject *py_optlist, *py_classval;
219         Py_UNICODE *py_ustr;
220         unsigned long long int val_ull;
221         int num_optkeys, ret, size, i;
222         char *key, *value;
223
224         if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
225                 /* Decoder has no options. */
226                 if (g_hash_table_size(options) == 0) {
227                         /* No options provided. */
228                         return SRD_OK;
229                 } else {
230                         srd_err("Protocol decoder has no options.");
231                         return SRD_ERR_ARG;
232                 }
233                 return SRD_OK;
234         }
235
236         ret = SRD_ERR_PYTHON;
237         key = NULL;
238         py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
239         py_optlist = py_classval = NULL;
240         py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
241
242         /* All of these are synthesized objects, so they're good. */
243         py_dec_optkeys = PyDict_Keys(py_dec_options);
244         num_optkeys = PyList_Size(py_dec_optkeys);
245         if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
246                 goto err_out;
247         for (i = 0; i < num_optkeys; i++) {
248                 /* Get the default class value for this option. */
249                 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
250                 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
251                         goto err_out;
252                 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
253                         goto err_out;
254                 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
255                         srd_err("Options of type %s are not yet supported.",
256                                 Py_TYPE(py_classval)->tp_name);
257                         goto err_out;
258                 }
259
260                 if ((value = g_hash_table_lookup(options, key))) {
261                         /* An override for this option was provided. */
262                         if (PyUnicode_Check(py_classval)) {
263                                 if (!(py_optval = PyUnicode_FromString(value))) {
264                                         /* Some UTF-8 encoding error. */
265                                         PyErr_Clear();
266                                         goto err_out;
267                                 }
268                         } else if (PyLong_Check(py_classval)) {
269                                 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
270                                         /* ValueError Exception */
271                                         PyErr_Clear();
272                                         srd_err("Option %s has invalid value "
273                                                 "%s: expected integer.",
274                                                 key, value);
275                                         goto err_out;
276                                 }
277                         }
278                         g_hash_table_remove(options, key);
279                 } else {
280                         /* Use the class default for this option. */
281                         if (PyUnicode_Check(py_classval)) {
282                                 /* Make a brand new copy of the string. */
283                                 py_ustr = PyUnicode_AS_UNICODE(py_classval);
284                                 size = PyUnicode_GET_SIZE(py_classval);
285                                 py_optval = PyUnicode_FromUnicode(py_ustr, size);
286                         } else if (PyLong_Check(py_classval)) {
287                                 /* Make a brand new copy of the integer. */
288                                 val_ull = PyLong_AsUnsignedLongLong(py_classval);
289                                 if (val_ull == (unsigned long long)-1) {
290                                         /* OverFlowError exception */
291                                         PyErr_Clear();
292                                         srd_err("Invalid integer value for %s: "
293                                                 "expected integer.", key);
294                                         goto err_out;
295                                 }
296                                 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
297                                         goto err_out;
298                         }
299                 }
300
301                 /* If we got here, py_optval holds a known good new reference
302                  * to the instance option to set.
303                  */
304                 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
305                         goto err_out;
306         }
307
308         ret = SRD_OK;
309
310 err_out:
311         Py_XDECREF(py_optlist);
312         Py_XDECREF(py_di_options);
313         Py_XDECREF(py_dec_optkeys);
314         Py_XDECREF(py_dec_options);
315         g_free(key);
316         if (PyErr_Occurred())
317                 catch_exception("Stray exception in srd_inst_set_options().");
318
319         return ret;
320 }
321
322 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_set_probes() */
323 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
324 {
325         return strcmp(a->id, probe_id);
326 }
327
328 /**
329  * Set probes in a decoder instance.
330  *
331  * @param di Decoder instance.
332  * @param probes A GHashTable of probes to set. Key is probe name, value is
333  *               the probe number. Samples passed to this instance will be
334  *               arranged in this order.
335  * @return SRD_OK upon success, a (negative) error code otherwise.
336  */
337 SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
338                                     GHashTable *new_probes)
339 {
340         GList *l;
341         GSList *sl;
342         struct srd_probe *p;
343         int *new_probemap, new_probenum;
344         char *probe_id, *probenum_str;
345
346         srd_dbg("set probes called for instance %s with list of %d probes",
347                 di->inst_id, g_hash_table_size(new_probes));
348
349         if (g_hash_table_size(new_probes) == 0)
350                 /* No probes provided. */
351                 return SRD_OK;
352
353         if (di->dec_num_probes == 0) {
354                 /* Decoder has no probes. */
355                 srd_err("Protocol decoder %s has no probes to define.",
356                         di->decoder->name);
357                 return SRD_ERR_ARG;
358         }
359
360         new_probemap = NULL;
361
362         if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
363                 srd_err("Failed to g_malloc() new probe map.");
364                 return SRD_ERR_MALLOC;
365         }
366
367         for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
368                 probe_id = l->data;
369                 probenum_str = g_hash_table_lookup(new_probes, probe_id);
370                 if (!probenum_str) {
371                         /* Probe name was specified without a value. */
372                         srd_err("No probe number was specified for %s.",
373                                 probe_id);
374                         g_free(new_probemap);
375                         return SRD_ERR_ARG;
376                 }
377                 new_probenum = strtol(probenum_str, NULL, 10);
378                 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
379                                 (GCompareFunc)compare_probe_id))) {
380                         /* Fall back on optional probes. */
381                         if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
382                              probe_id, (GCompareFunc) compare_probe_id))) {
383                                 srd_err("Protocol decoder %s has no probe "
384                                         "'%s'.", di->decoder->name, probe_id);
385                                 g_free(new_probemap);
386                                 return SRD_ERR_ARG;
387                         }
388                 }
389                 p = sl->data;
390                 new_probemap[p->order] = new_probenum;
391                 srd_dbg("setting probe mapping for %d = probe %d", p->order,
392                         new_probenum);
393         }
394         g_free(di->dec_probemap);
395         di->dec_probemap = new_probemap;
396
397         return SRD_OK;
398 }
399
400 /**
401  * Create a new protocol decoder instance.
402  *
403  * @param id Decoder 'id' field.
404  * @param options GHashtable of options which override the defaults set in
405  *                the decoder class.
406  * @return Pointer to a newly allocated struct srd_decoder_inst, or
407  *         NULL in case of failure.
408  */
409 SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
410                                                       GHashTable *options)
411 {
412         int i;
413         struct srd_decoder *dec;
414         struct srd_decoder_inst *di;
415         char *inst_id;
416
417         srd_dbg("Creating new %s instance.", decoder_id);
418
419         if (!(dec = srd_get_decoder_by_id(decoder_id))) {
420                 srd_err("Protocol decoder %s not found.", decoder_id);
421                 return NULL;
422         }
423
424         if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
425                 srd_err("Failed to g_malloc() instance.");
426                 return NULL;
427         }
428
429         inst_id = g_hash_table_lookup(options, "id");
430         di->decoder = dec;
431         di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
432         g_hash_table_remove(options, "id");
433
434         /* Prepare a default probe map, where samples come in the
435          * order in which the decoder class defined them.
436          */
437         di->dec_num_probes = g_slist_length(di->decoder->probes) +
438                              g_slist_length(di->decoder->opt_probes);
439         if (di->dec_num_probes) {
440                 if (!(di->dec_probemap =
441                      g_try_malloc(sizeof(int) * di->dec_num_probes))) {
442                         srd_err("Failed to g_malloc() probe map.");
443                         g_free(di);
444                         return NULL;
445                 }
446                 for (i = 0; i < di->dec_num_probes; i++)
447                         di->dec_probemap[i] = i;
448         }
449
450         /* Create a new instance of this decoder class. */
451         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
452                 if (PyErr_Occurred())
453                         catch_exception("failed to create %s instance: ",
454                                         decoder_id);
455                 g_free(di->dec_probemap);
456                 g_free(di);
457                 return NULL;
458         }
459
460         if (srd_inst_set_options(di, options) != SRD_OK) {
461                 g_free(di->dec_probemap);
462                 g_free(di);
463                 return NULL;
464         }
465
466         /* Instance takes input from a frontend by default. */
467         di_list = g_slist_append(di_list, di);
468
469         return di;
470 }
471
472 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
473                                struct srd_decoder_inst *di_to)
474 {
475         if (!di_from || !di_to) {
476                 srd_err("Invalid from/to instance pair.");
477                 return SRD_ERR_ARG;
478         }
479
480         if (g_slist_find(di_list, di_to)) {
481                 /* Remove from the unstacked list. */
482                 di_list = g_slist_remove(di_list, di_to);
483         }
484
485         /* Stack on top of source di. */
486         di_from->next_di = g_slist_append(di_from->next_di, di_to);
487
488         return SRD_OK;
489 }
490
491 /**
492  * Finds a decoder instance by its instance id, but only in the bottom
493  * level of instances -- instances already stacked on top of another one
494  * will not be found.
495  *
496  * @param inst_id The instance id to be found.
497  *
498  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
499  */
500 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
501 {
502         GSList *l;
503         struct srd_decoder_inst *tmp, *di;
504
505         di = NULL;
506         for (l = di_list; l; l = l->next) {
507                 tmp = l->data;
508                 if (!strcmp(tmp->inst_id, inst_id)) {
509                         di = tmp;
510                         break;
511                 }
512         }
513
514         return di;
515 }
516
517 /**
518  * Finds a decoder instance by its Python object, i.e. that instance's
519  * instantiation of the sigrokdecode.Decoder class. This will recurse
520  * to find the instance anywhere in the stack tree.
521  *
522  * @param stack Pointer to a GSList of struct srd_decoder_inst,
523  *              indicating the stack to search. To start searching at the bottom
524  *              level of decoder instances, pass NULL.
525  * @param obj The Python class instantiation.
526  *
527  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
528  */
529 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
530                                                               PyObject *obj)
531 {
532         GSList *l;
533         struct srd_decoder_inst *tmp, *di;
534
535         di = NULL;
536         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
537                 tmp = l->data;
538                 if (tmp->py_inst == obj)
539                         di = tmp;
540                 else if (tmp->next_di)
541                         di = srd_inst_find_by_obj(tmp->next_di, obj);
542         }
543
544         return di;
545 }
546
547 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
548 {
549         PyObject *py_name, *py_res;
550         GSList *l;
551         struct srd_decoder_inst *next_di;
552
553         srd_dbg("Calling start() method on protocol decoder instance %s.",
554                 di->inst_id);
555
556         if (!(py_name = PyUnicode_FromString("start"))) {
557                 srd_err("Unable to build Python object for 'start'.");
558                 catch_exception("Protocol decoder instance %s: ",
559                                 di->inst_id);
560                 return SRD_ERR_PYTHON;
561         }
562
563         if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
564                                                   py_name, args, NULL))) {
565                 catch_exception("Protocol decoder instance %s: ",
566                                 di->inst_id);
567                 return SRD_ERR_PYTHON;
568         }
569
570         Py_DecRef(py_res);
571         Py_DecRef(py_name);
572
573         /* Start all the PDs stacked on top of this one. Pass along the
574          * metadata all the way from the bottom PD, even though it's only
575          * applicable to logic data for now.
576          */
577         for (l = di->next_di; l; l = l->next) {
578                 next_di = l->data;
579                 srd_inst_start(next_di, args);
580         }
581
582         return SRD_OK;
583 }
584
585 /**
586  * Run the specified decoder function.
587  *
588  * @param start_samplenum The starting sample number for the buffer's sample
589  *                        set, relative to the start of capture.
590  * @param di The decoder instance to call. Must not be NULL.
591  * @param inbuf The buffer to decode. Must not be NULL.
592  * @param inbuflen Length of the buffer. Must be > 0.
593  *
594  * @return SRD_OK upon success, a (negative) error code otherwise.
595  */
596 SRD_API int srd_inst_decode(uint64_t start_samplenum,
597                                 struct srd_decoder_inst *di,
598                                 uint8_t *inbuf, uint64_t inbuflen)
599 {
600         PyObject *py_res;
601         srd_logic *logic;
602         uint64_t end_samplenum;
603
604         srd_dbg("Calling decode() on instance %s with %d bytes starting "
605                 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
606
607         /* Return an error upon unusable input. */
608         if (!di) {
609                 srd_dbg("empty decoder instance");
610                 return SRD_ERR_ARG;
611         }
612         if (!inbuf) {
613                 srd_dbg("NULL buffer pointer");
614                 return SRD_ERR_ARG;
615         }
616         if (inbuflen == 0) {
617                 srd_dbg("empty buffer");
618                 return SRD_ERR_ARG;
619         }
620
621         /* Create new srd_logic object. Each iteration around the PD's loop
622          * will fill one sample into this object.
623          */
624         logic = PyObject_New(srd_logic, &srd_logic_type);
625         Py_INCREF(logic);
626         logic->di = di;
627         logic->start_samplenum = start_samplenum;
628         logic->itercnt = 0;
629         logic->inbuf = inbuf;
630         logic->inbuflen = inbuflen;
631         logic->sample = PyList_New(2);
632         Py_INCREF(logic->sample);
633
634         Py_IncRef(di->py_inst);
635         end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
636         if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
637                                            "KKO", logic->start_samplenum,
638                                            end_samplenum, logic))) {
639                 catch_exception("Protocol decoder instance %s: ",
640                                 di->inst_id);
641                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
642         }
643         Py_DecRef(py_res);
644
645         return SRD_OK;
646 }
647
648 SRD_API void srd_inst_free(struct srd_decoder_inst *di)
649 {
650         GSList *l;
651         struct srd_pd_output *pdo;
652
653         srd_dbg("Freeing instance %s", di->inst_id);
654
655         Py_DecRef(di->py_inst);
656         g_free(di->inst_id);
657         g_free(di->dec_probemap);
658         g_slist_free(di->next_di);
659         for (l = di->pd_output; l; l = l->next) {
660                 pdo = l->data;
661                 g_free(pdo->proto_id);
662                 g_free(pdo);
663         }
664         g_slist_free(di->pd_output);
665 }
666
667 SRD_API void srd_inst_free_all(GSList *stack)
668 {
669         GSList *l;
670         struct srd_decoder_inst *di;
671
672         di = NULL;
673         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
674                 di = l->data;
675                 if (di->next_di)
676                         srd_inst_free_all(di->next_di);
677                 srd_inst_free(di);
678         }
679         if (!stack) {
680                 g_slist_free(di_list);
681                 di_list = NULL;
682         }
683 }
684
685 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
686 {
687         PyObject *args;
688         GSList *d;
689         struct srd_decoder_inst *di;
690         int ret;
691
692         srd_dbg("Calling start() on all instances with %d probes, "
693                 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
694
695         /* Currently only one item of metadata is passed along to decoders,
696          * samplerate. This can be extended as needed.
697          */
698         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
699                 srd_err("Unable to build Python object for metadata.");
700                 return SRD_ERR_PYTHON;
701         }
702
703         /* Run the start() method on all decoders receiving frontend data. */
704         for (d = di_list; d; d = d->next) {
705                 di = d->data;
706                 di->data_num_probes = num_probes;
707                 di->data_unitsize = unitsize;
708                 di->data_samplerate = samplerate;
709                 if ((ret = srd_inst_start(di, args) != SRD_OK))
710                         break;
711         }
712
713         Py_DecRef(args);
714
715         return ret;
716 }
717
718 /* Feed logic samples to decoder session. */
719 SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
720                              uint64_t inbuflen)
721 {
722         GSList *d;
723         int ret;
724
725         srd_dbg("Calling decode() on all instances with starting sample "
726                 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
727                 start_samplenum, inbuflen, inbuf);
728
729         for (d = di_list; d; d = d->next) {
730                 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
731                                                inbuflen)) != SRD_OK)
732                         return ret;
733         }
734
735         return SRD_OK;
736 }
737
738 SRD_API int srd_register_callback(int output_type,
739                                   srd_pd_output_callback_t cb, void *user_data)
740 {
741         struct srd_pd_callback *pd_cb;
742
743         srd_dbg("Registering new callback for output type %d.", output_type);
744
745         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
746                 srd_err("Failed to g_malloc() struct srd_pd_callback.");
747                 return SRD_ERR_MALLOC;
748         }
749
750         pd_cb->output_type = output_type;
751         pd_cb->callback = cb;
752         pd_cb->user_data = user_data;
753         callbacks = g_slist_append(callbacks, pd_cb);
754
755         return SRD_OK;
756 }
757
758 SRD_API void *srd_find_callback(int output_type)
759 {
760         GSList *l;
761         struct srd_pd_callback *pd_cb;
762         void *(cb);
763
764         cb = NULL;
765         for (l = callbacks; l; l = l->next) {
766                 pd_cb = l->data;
767                 if (pd_cb->output_type == output_type) {
768                         cb = pd_cb->callback;
769                         break;
770                 }
771         }
772
773         return cb;
774 }
775
776 /* This is the backend function to Python sigrokdecode.add() call. */
777 SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
778                     char *proto_id)
779 {
780         struct srd_pd_output *pdo;
781
782         srd_dbg("Instance %s creating new output type %d for %s.",
783                 di->inst_id, output_type, proto_id);
784
785         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
786                 srd_err("Failed to g_malloc() struct srd_pd_output.");
787                 return -1;
788         }
789
790         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
791         pdo->pdo_id = g_slist_length(di->pd_output);
792         pdo->output_type = output_type;
793         pdo->di = di;
794         pdo->proto_id = g_strdup(proto_id);
795         di->pd_output = g_slist_append(di->pd_output, pdo);
796
797         return pdo->pdo_id;
798 }