srd: last public/private fix, and docs for all publis functions.
[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  *
336  * @return SRD_OK upon success, a (negative) error code otherwise.
337  */
338 SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
339                                     GHashTable *new_probes)
340 {
341         GList *l;
342         GSList *sl;
343         struct srd_probe *p;
344         int *new_probemap, new_probenum;
345         char *probe_id, *probenum_str;
346
347         srd_dbg("set probes called for instance %s with list of %d probes",
348                 di->inst_id, g_hash_table_size(new_probes));
349
350         if (g_hash_table_size(new_probes) == 0)
351                 /* No probes provided. */
352                 return SRD_OK;
353
354         if (di->dec_num_probes == 0) {
355                 /* Decoder has no probes. */
356                 srd_err("Protocol decoder %s has no probes to define.",
357                         di->decoder->name);
358                 return SRD_ERR_ARG;
359         }
360
361         new_probemap = NULL;
362
363         if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
364                 srd_err("Failed to g_malloc() new probe map.");
365                 return SRD_ERR_MALLOC;
366         }
367
368         for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
369                 probe_id = l->data;
370                 probenum_str = g_hash_table_lookup(new_probes, probe_id);
371                 if (!probenum_str) {
372                         /* Probe name was specified without a value. */
373                         srd_err("No probe number was specified for %s.",
374                                 probe_id);
375                         g_free(new_probemap);
376                         return SRD_ERR_ARG;
377                 }
378                 new_probenum = strtol(probenum_str, NULL, 10);
379                 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
380                                 (GCompareFunc)compare_probe_id))) {
381                         /* Fall back on optional probes. */
382                         if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
383                              probe_id, (GCompareFunc) compare_probe_id))) {
384                                 srd_err("Protocol decoder %s has no probe "
385                                         "'%s'.", di->decoder->name, probe_id);
386                                 g_free(new_probemap);
387                                 return SRD_ERR_ARG;
388                         }
389                 }
390                 p = sl->data;
391                 new_probemap[p->order] = new_probenum;
392                 srd_dbg("setting probe mapping for %d = probe %d", p->order,
393                         new_probenum);
394         }
395         g_free(di->dec_probemap);
396         di->dec_probemap = new_probemap;
397
398         return SRD_OK;
399 }
400
401 /**
402  * Create a new protocol decoder instance.
403  *
404  * @param id Decoder 'id' field.
405  * @param options GHashtable of options which override the defaults set in
406  *                the decoder class.
407  *
408  * @return Pointer to a newly allocated struct srd_decoder_inst, or
409  *         NULL in case of failure.
410  */
411 SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
412                                                       GHashTable *options)
413 {
414         int i;
415         struct srd_decoder *dec;
416         struct srd_decoder_inst *di;
417         char *inst_id;
418
419         srd_dbg("Creating new %s instance.", decoder_id);
420
421         if (!(dec = srd_get_decoder_by_id(decoder_id))) {
422                 srd_err("Protocol decoder %s not found.", decoder_id);
423                 return NULL;
424         }
425
426         if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
427                 srd_err("Failed to g_malloc() instance.");
428                 return NULL;
429         }
430
431         inst_id = g_hash_table_lookup(options, "id");
432         di->decoder = dec;
433         di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
434         g_hash_table_remove(options, "id");
435
436         /* Prepare a default probe map, where samples come in the
437          * order in which the decoder class defined them.
438          */
439         di->dec_num_probes = g_slist_length(di->decoder->probes) +
440                              g_slist_length(di->decoder->opt_probes);
441         if (di->dec_num_probes) {
442                 if (!(di->dec_probemap =
443                      g_try_malloc(sizeof(int) * di->dec_num_probes))) {
444                         srd_err("Failed to g_malloc() probe map.");
445                         g_free(di);
446                         return NULL;
447                 }
448                 for (i = 0; i < di->dec_num_probes; i++)
449                         di->dec_probemap[i] = i;
450         }
451
452         /* Create a new instance of this decoder class. */
453         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
454                 if (PyErr_Occurred())
455                         catch_exception("failed to create %s instance: ",
456                                         decoder_id);
457                 g_free(di->dec_probemap);
458                 g_free(di);
459                 return NULL;
460         }
461
462         if (srd_inst_set_options(di, options) != SRD_OK) {
463                 g_free(di->dec_probemap);
464                 g_free(di);
465                 return NULL;
466         }
467
468         /* Instance takes input from a frontend by default. */
469         di_list = g_slist_append(di_list, di);
470
471         return di;
472 }
473
474 /**
475  * Stack a decoder instance on top of another.
476  *
477  * @param di_from The instance to move.
478  * @param di_to The instance on top of which di_from will be stacked.
479  *
480  * @return SRD_OK upon success, a (negative) error code otherwise.
481  */
482 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
483                                struct srd_decoder_inst *di_to)
484 {
485         if (!di_from || !di_to) {
486                 srd_err("Invalid from/to instance pair.");
487                 return SRD_ERR_ARG;
488         }
489
490         if (g_slist_find(di_list, di_to)) {
491                 /* Remove from the unstacked list. */
492                 di_list = g_slist_remove(di_list, di_to);
493         }
494
495         /* Stack on top of source di. */
496         di_from->next_di = g_slist_append(di_from->next_di, di_to);
497
498         return SRD_OK;
499 }
500
501 /**
502  * Finds a decoder instance by its instance id, but only in the bottom
503  * level of instances -- instances already stacked on top of another one
504  * will not be found.
505  *
506  * @param inst_id The instance id to be found.
507  *
508  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
509  */
510 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
511 {
512         GSList *l;
513         struct srd_decoder_inst *tmp, *di;
514
515         di = NULL;
516         for (l = di_list; l; l = l->next) {
517                 tmp = l->data;
518                 if (!strcmp(tmp->inst_id, inst_id)) {
519                         di = tmp;
520                         break;
521                 }
522         }
523
524         return di;
525 }
526
527 /**
528  * Finds a decoder instance by its Python object, i.e. that instance's
529  * instantiation of the sigrokdecode.Decoder class. This will recurse
530  * to find the instance anywhere in the stack tree.
531  *
532  * @param stack Pointer to a GSList of struct srd_decoder_inst,
533  *              indicating the stack to search. To start searching at the bottom
534  *              level of decoder instances, pass NULL.
535  * @param obj The Python class instantiation.
536  *
537  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
538  */
539 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
540                                                               PyObject *obj)
541 {
542         GSList *l;
543         struct srd_decoder_inst *tmp, *di;
544
545         di = NULL;
546         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
547                 tmp = l->data;
548                 if (tmp->py_inst == obj)
549                         di = tmp;
550                 else if (tmp->next_di)
551                         di = srd_inst_find_by_obj(tmp->next_di, obj);
552         }
553
554         return di;
555 }
556
557 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
558 {
559         PyObject *py_name, *py_res;
560         GSList *l;
561         struct srd_decoder_inst *next_di;
562
563         srd_dbg("Calling start() method on protocol decoder instance %s.",
564                 di->inst_id);
565
566         if (!(py_name = PyUnicode_FromString("start"))) {
567                 srd_err("Unable to build Python object for 'start'.");
568                 catch_exception("Protocol decoder instance %s: ",
569                                 di->inst_id);
570                 return SRD_ERR_PYTHON;
571         }
572
573         if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
574                                                   py_name, args, NULL))) {
575                 catch_exception("Protocol decoder instance %s: ",
576                                 di->inst_id);
577                 return SRD_ERR_PYTHON;
578         }
579
580         Py_DecRef(py_res);
581         Py_DecRef(py_name);
582
583         /* Start all the PDs stacked on top of this one. Pass along the
584          * metadata all the way from the bottom PD, even though it's only
585          * applicable to logic data for now.
586          */
587         for (l = di->next_di; l; l = l->next) {
588                 next_di = l->data;
589                 srd_inst_start(next_di, args);
590         }
591
592         return SRD_OK;
593 }
594
595 /**
596  * Run the specified decoder function.
597  *
598  * @param start_samplenum The starting sample number for the buffer's sample
599  *                        set, relative to the start of capture.
600  * @param di The decoder instance to call. Must not be NULL.
601  * @param inbuf The buffer to decode. Must not be NULL.
602  * @param inbuflen Length of the buffer. Must be > 0.
603  *
604  * @return SRD_OK upon success, a (negative) error code otherwise.
605  */
606 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
607                                 struct srd_decoder_inst *di,
608                                 uint8_t *inbuf, uint64_t inbuflen)
609 {
610         PyObject *py_res;
611         srd_logic *logic;
612         uint64_t end_samplenum;
613
614         srd_dbg("Calling decode() on instance %s with %d bytes starting "
615                 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
616
617         /* Return an error upon unusable input. */
618         if (!di) {
619                 srd_dbg("empty decoder instance");
620                 return SRD_ERR_ARG;
621         }
622         if (!inbuf) {
623                 srd_dbg("NULL buffer pointer");
624                 return SRD_ERR_ARG;
625         }
626         if (inbuflen == 0) {
627                 srd_dbg("empty buffer");
628                 return SRD_ERR_ARG;
629         }
630
631         /* Create new srd_logic object. Each iteration around the PD's loop
632          * will fill one sample into this object.
633          */
634         logic = PyObject_New(srd_logic, &srd_logic_type);
635         Py_INCREF(logic);
636         logic->di = di;
637         logic->start_samplenum = start_samplenum;
638         logic->itercnt = 0;
639         logic->inbuf = inbuf;
640         logic->inbuflen = inbuflen;
641         logic->sample = PyList_New(2);
642         Py_INCREF(logic->sample);
643
644         Py_IncRef(di->py_inst);
645         end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
646         if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
647                                            "KKO", logic->start_samplenum,
648                                            end_samplenum, logic))) {
649                 catch_exception("Protocol decoder instance %s: ",
650                                 di->inst_id);
651                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
652         }
653         Py_DecRef(py_res);
654
655         return SRD_OK;
656 }
657
658 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
659 {
660         GSList *l;
661         struct srd_pd_output *pdo;
662
663         srd_dbg("Freeing instance %s", di->inst_id);
664
665         Py_DecRef(di->py_inst);
666         g_free(di->inst_id);
667         g_free(di->dec_probemap);
668         g_slist_free(di->next_di);
669         for (l = di->pd_output; l; l = l->next) {
670                 pdo = l->data;
671                 g_free(pdo->proto_id);
672                 g_free(pdo);
673         }
674         g_slist_free(di->pd_output);
675 }
676
677 SRD_PRIV void srd_inst_free_all(GSList *stack)
678 {
679         GSList *l;
680         struct srd_decoder_inst *di;
681
682         di = NULL;
683         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
684                 di = l->data;
685                 if (di->next_di)
686                         srd_inst_free_all(di->next_di);
687                 srd_inst_free(di);
688         }
689         if (!stack) {
690                 g_slist_free(di_list);
691                 di_list = NULL;
692         }
693 }
694
695 /**
696  * Start a decoding session.
697  *
698  * Decoders, instances and stack must have been prepared beforehand.
699  *
700  * @param num_probes The number of probes which the incoming feed will contain.
701  * @param unitsize The number of bytes per sample in the incoming feed.
702  * @param The samplerate of the incoming feed.
703  *
704  * @return SRD_OK upon success, a (negative) error code otherwise.
705  */
706 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
707 {
708         PyObject *args;
709         GSList *d;
710         struct srd_decoder_inst *di;
711         int ret;
712
713         srd_dbg("Calling start() on all instances with %d probes, "
714                 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
715
716         /* Currently only one item of metadata is passed along to decoders,
717          * samplerate. This can be extended as needed.
718          */
719         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
720                 srd_err("Unable to build Python object for metadata.");
721                 return SRD_ERR_PYTHON;
722         }
723
724         /* Run the start() method on all decoders receiving frontend data. */
725         for (d = di_list; d; d = d->next) {
726                 di = d->data;
727                 di->data_num_probes = num_probes;
728                 di->data_unitsize = unitsize;
729                 di->data_samplerate = samplerate;
730                 if ((ret = srd_inst_start(di, args) != SRD_OK))
731                         break;
732         }
733
734         Py_DecRef(args);
735
736         return ret;
737 }
738
739 /**
740  * Feed a chunk of logic sample data to a running decoder session.
741  *
742  * @param start_samplenum The sample number of the first sample in this chunk.
743  * @param inbuf Pointer to sample data.
744  * @param inbuf Length in bytes of the buffer.
745  *
746  * @return SRD_OK upon success, a (negative) error code otherwise.
747  */
748 SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
749                              uint64_t inbuflen)
750 {
751         GSList *d;
752         int ret;
753
754         srd_dbg("Calling decode() on all instances with starting sample "
755                 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
756                 start_samplenum, inbuflen, inbuf);
757
758         for (d = di_list; d; d = d->next) {
759                 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
760                                                inbuflen)) != SRD_OK)
761                         return ret;
762         }
763
764         return SRD_OK;
765 }
766
767 /**
768  * Register a decoder output callback function.
769  *
770  * The function will be called when a protocol decoder sends output back
771  * to the PD controller (except for Python objects, which only go up the
772  * stack).
773  *
774  * @param output_type The output type this callback will receive. Only one
775  * callback per output type can be registered.
776  * @param cb The function to call.
777  * @param user_data Unused.
778  */
779 SRD_API int srd_register_callback(int output_type,
780                                   srd_pd_output_callback_t cb, void *user_data)
781 {
782         struct srd_pd_callback *pd_cb;
783
784         srd_dbg("Registering new callback for output type %d.", output_type);
785
786         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
787                 srd_err("Failed to g_malloc() struct srd_pd_callback.");
788                 return SRD_ERR_MALLOC;
789         }
790
791         pd_cb->output_type = output_type;
792         pd_cb->callback = cb;
793         pd_cb->user_data = user_data;
794         callbacks = g_slist_append(callbacks, pd_cb);
795
796         return SRD_OK;
797 }
798
799 SRD_PRIV void *srd_find_callback(int output_type)
800 {
801         GSList *l;
802         struct srd_pd_callback *pd_cb;
803         void *(cb);
804
805         cb = NULL;
806         for (l = callbacks; l; l = l->next) {
807                 pd_cb = l->data;
808                 if (pd_cb->output_type == output_type) {
809                         cb = pd_cb->callback;
810                         break;
811                 }
812         }
813
814         return cb;
815 }
816
817 /* This is the backend function to Python sigrokdecode.add() call. */
818 SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
819                     char *proto_id)
820 {
821         struct srd_pd_output *pdo;
822
823         srd_dbg("Instance %s creating new output type %d for %s.",
824                 di->inst_id, output_type, proto_id);
825
826         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
827                 srd_err("Failed to g_malloc() struct srd_pd_output.");
828                 return -1;
829         }
830
831         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
832         pdo->pdo_id = g_slist_length(di->pd_output);
833         pdo->output_type = output_type;
834         pdo->di = di;
835         pdo->proto_id = g_strdup(proto_id);
836         di->pd_output = g_slist_append(di->pd_output, pdo);
837
838         return pdo->pdo_id;
839 }