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/>.
21 #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode-internal.h"
30 * @mainpage libsigrokdecode API
32 * @section sec_intro Introduction
34 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
35 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
36 * suite that supports various device types (such as logic analyzers,
37 * oscilloscopes, multimeters, and more).
39 * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a
40 * shared library written in C which provides the basic API for (streaming)
41 * protocol decoding functionality.
43 * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
44 * are written in Python (>= 3.0).
46 * @section sec_api API reference
48 * See the "Modules" page for an introduction to various libsigrokdecode
49 * related topics and the detailed API documentation of the respective
52 * You can also browse the API documentation by file, or review all
55 * @section sec_mailinglists Mailing lists
57 * There are two mailing lists for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
59 * @section sec_irc IRC
61 * You can find the sigrok developers in the
62 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
63 * IRC channel on Freenode.
65 * @section sec_website Website
67 * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
73 * Initializing and shutting down libsigrokdecode.
77 * @defgroup grp_init Initialization
79 * Initializing and shutting down libsigrokdecode.
81 * Before using any of the libsigrokdecode functionality, srd_init() must
82 * be called to initialize the library.
84 * When libsigrokdecode functionality is no longer needed, srd_exit() should
92 SRD_PRIV GSList *sessions = NULL;
93 static int max_session_id = -1;
95 static int session_is_valid(struct srd_session *sess);
98 extern SRD_PRIV GSList *pd_list;
100 /* module_sigrokdecode.c */
101 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
104 extern SRD_PRIV PyTypeObject srd_logic_type;
109 * Initialize libsigrokdecode.
111 * This initializes the Python interpreter, and creates and initializes
112 * a "sigrokdecode" Python module.
114 * Then, it searches for sigrok protocol decoders in the "decoders"
115 * subdirectory of the the libsigrokdecode installation directory.
116 * All decoders that are found are loaded into memory and added to an
117 * internal list of decoders, which can be queried via srd_decoder_list().
119 * The caller is responsible for calling the clean-up function srd_exit(),
120 * which will properly shut down libsigrokdecode and free its allocated memory.
122 * Multiple calls to srd_init(), without calling srd_exit() in between,
125 * @param path Path to an extra directory containing protocol decoders
126 * which will be added to the Python sys.path. May be NULL.
128 * @return SRD_OK upon success, a (negative) error code otherwise.
129 * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
130 * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
131 * If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
135 SRD_API int srd_init(const char *path)
140 if (max_session_id != -1) {
141 srd_err("libsigrokdecode is already initialized.");
145 srd_dbg("Initializing libsigrokdecode.");
147 /* Add our own module to the list of built-in modules. */
148 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
150 /* Initialize the Python interpreter. */
153 /* Installed decoders. */
154 if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
159 /* Path specified by the user. */
161 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
167 /* Environment variable overrides everything, for debugging. */
168 if ((env_path = getenv("SIGROKDECODE_DIR"))) {
169 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
181 * Shutdown libsigrokdecode.
183 * This frees all the memory allocated for protocol decoders and shuts down
184 * the Python interpreter.
186 * This function should only be called if there was a (successful!) invocation
187 * of srd_init() before. Calling this function multiple times in a row, without
188 * any successful srd_init() calls in between, is not allowed.
190 * @return SRD_OK upon success, a (negative) error code otherwise.
194 SRD_API int srd_exit(void)
198 srd_dbg("Exiting libsigrokdecode.");
200 for (l = sessions; l; l = l->next)
201 srd_session_destroy((struct srd_session *)l->data);
203 srd_decoder_unload_all();
204 g_slist_free(pd_list);
207 /* Py_Finalize() returns void, any finalization errors are ignored. */
216 * Add an additional search directory for the protocol decoders.
218 * The specified directory is prepended (not appended!) to Python's sys.path,
219 * in order to search for sigrok protocol decoders in the specified
220 * directories first, and in the generic Python module directories (and in
221 * the current working directory) last. This avoids conflicts if there are
222 * Python modules which have the same name as a sigrok protocol decoder in
223 * sys.path or in the current working directory.
225 * @param path Path to the directory containing protocol decoders which shall
226 * be added to the Python sys.path, or NULL.
228 * @return SRD_OK upon success, a (negative) error code otherwise.
234 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
236 PyObject *py_cur_path, *py_item;
239 wchar_t *wc_new_path;
242 srd_dbg("Adding '%s' to module path.", path);
244 new_path = g_string_sized_new(256);
245 g_string_assign(new_path, path);
246 py_cur_path = PySys_GetObject("path");
247 for (i = 0; i < PyList_Size(py_cur_path); i++) {
248 g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S);
249 py_item = PyList_GetItem(py_cur_path, i);
250 if (!PyUnicode_Check(py_item))
251 /* Shouldn't happen. */
253 if (py_str_as_str(py_item, &item) != SRD_OK)
255 g_string_append(new_path, item);
259 /* Convert to wide chars. */
260 wc_len = sizeof(wchar_t) * (new_path->len + 1);
261 if (!(wc_new_path = g_try_malloc(wc_len))) {
262 srd_dbg("malloc failed");
263 return SRD_ERR_MALLOC;
265 mbstowcs(wc_new_path, new_path->str, wc_len);
266 PySys_SetPath(wc_new_path);
267 g_string_free(new_path, TRUE);
276 * @defgroup grp_instances Decoder instances
278 * Decoder instance handling.
284 * Set one or more options in a decoder instance.
286 * Handled options are removed from the hash.
288 * @param di Decoder instance.
289 * @param options A GHashTable of options to set.
291 * @return SRD_OK upon success, a (negative) error code otherwise.
295 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
298 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
299 PyObject *py_optlist, *py_classval;
302 unsigned long long int val_ull;
304 int num_optkeys, ret, size, i;
309 srd_err("Invalid decoder instance.");
314 srd_err("Invalid options GHashTable.");
318 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
319 /* Decoder has no options. */
320 if (g_hash_table_size(options) == 0) {
321 /* No options provided. */
324 srd_err("Protocol decoder has no options.");
330 ret = SRD_ERR_PYTHON;
332 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
333 py_optlist = py_classval = NULL;
334 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
336 /* All of these are synthesized objects, so they're good. */
337 py_dec_optkeys = PyDict_Keys(py_dec_options);
338 num_optkeys = PyList_Size(py_dec_optkeys);
341 * The 'options' dictionary is a class variable, but we need to
342 * change it. Changing it directly will affect the entire class,
343 * so we need to create a new object for it, and populate that
346 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
348 Py_DECREF(py_di_options);
349 py_di_options = PyDict_New();
350 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
351 for (i = 0; i < num_optkeys; i++) {
352 /* Get the default class value for this option. */
353 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
354 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
356 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
358 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
359 srd_err("Options of type %s are not yet supported.",
360 Py_TYPE(py_classval)->tp_name);
364 if ((value = g_hash_table_lookup(options, key))) {
365 dbg = g_variant_print(value, TRUE);
366 srd_dbg("got option '%s' = %s", key, dbg);
368 /* An override for this option was provided. */
369 if (PyUnicode_Check(py_classval)) {
370 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
371 srd_err("Option '%s' requires a string value.", key);
374 val_str = g_variant_get_string(value, NULL);
375 if (!(py_optval = PyUnicode_FromString(val_str))) {
376 /* Some UTF-8 encoding error. */
378 srd_err("Option '%s' requires a UTF-8 string value.", key);
381 } else if (PyLong_Check(py_classval)) {
382 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
383 srd_err("Option '%s' requires an integer value.", key);
386 val_int = g_variant_get_int64(value);
387 if (!(py_optval = PyLong_FromLong(val_int))) {
388 /* ValueError Exception */
390 srd_err("Option '%s' has invalid integer value.", key);
394 g_hash_table_remove(options, key);
396 /* Use the class default for this option. */
397 if (PyUnicode_Check(py_classval)) {
398 /* Make a brand new copy of the string. */
399 py_ustr = PyUnicode_AS_UNICODE(py_classval);
400 size = PyUnicode_GET_SIZE(py_classval);
401 py_optval = PyUnicode_FromUnicode(py_ustr, size);
402 } else if (PyLong_Check(py_classval)) {
403 /* Make a brand new copy of the integer. */
404 val_ull = PyLong_AsUnsignedLongLong(py_classval);
405 if (val_ull == (unsigned long long)-1) {
406 /* OverFlowError exception */
408 srd_err("Invalid integer value for %s: "
409 "expected integer.", key);
412 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
418 * If we got here, py_optval holds a known good new reference
419 * to the instance option to set.
421 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
430 Py_XDECREF(py_di_options);
431 Py_XDECREF(py_dec_optkeys);
432 Py_XDECREF(py_dec_options);
434 if (PyErr_Occurred()) {
435 srd_exception_catch("Stray exception in srd_inst_option_set().");
436 ret = SRD_ERR_PYTHON;
442 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
443 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
445 return strcmp(a->id, probe_id);
449 * Set all probes in a decoder instance.
451 * This function sets _all_ probes for the specified decoder instance, i.e.,
452 * it overwrites any probes that were already defined (if any).
454 * @param di Decoder instance.
455 * @param new_probes A GHashTable of probes to set. Key is probe name, value is
456 * the probe number. Samples passed to this instance will be
457 * arranged in this order.
459 * @return SRD_OK upon success, a (negative) error code otherwise.
463 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
464 GHashTable *new_probes)
470 int *new_probemap, new_probenum, num_required_probes, num_probes, i;
473 srd_dbg("set probes called for instance %s with list of %d probes",
474 di->inst_id, g_hash_table_size(new_probes));
476 if (g_hash_table_size(new_probes) == 0)
477 /* No probes provided. */
480 if (di->dec_num_probes == 0) {
481 /* Decoder has no probes. */
482 srd_err("Protocol decoder %s has no probes to define.",
489 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
490 srd_err("Failed to g_malloc() new probe map.");
491 return SRD_ERR_MALLOC;
495 * For now, map all indexes to probe -1 (can be overridden later).
496 * This -1 is interpreted as an unspecified probe later.
498 for (i = 0; i < di->dec_num_probes; i++)
499 new_probemap[i] = -1;
502 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
504 probe_val = g_hash_table_lookup(new_probes, probe_id);
505 if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
506 /* Probe name was specified without a value. */
507 srd_err("No probe number was specified for %s.",
509 g_free(new_probemap);
512 new_probenum = g_variant_get_int32(probe_val);
513 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
514 (GCompareFunc)compare_probe_id))) {
515 /* Fall back on optional probes. */
516 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
517 probe_id, (GCompareFunc) compare_probe_id))) {
518 srd_err("Protocol decoder %s has no probe "
519 "'%s'.", di->decoder->name, probe_id);
520 g_free(new_probemap);
525 new_probemap[p->order] = new_probenum;
526 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
527 p->id, p->order, new_probenum);
530 di->data_unitsize = (num_probes + 7) / 8;
532 srd_dbg("Final probe map:");
533 num_required_probes = g_slist_length(di->decoder->probes);
534 for (i = 0; i < di->dec_num_probes; i++) {
535 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
536 (i < num_required_probes) ? "required" : "optional");
539 g_free(di->dec_probemap);
540 di->dec_probemap = new_probemap;
546 * Create a new protocol decoder instance.
548 * @param sess The session holding the protocol decoder instance.
549 * @param decoder_id Decoder 'id' field.
550 * @param options GHashtable of options which override the defaults set in
551 * the decoder class. May be NULL.
553 * @return Pointer to a newly allocated struct srd_decoder_inst, or
554 * NULL in case of failure.
558 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
559 const char *decoder_id, GHashTable *options)
562 struct srd_decoder *dec;
563 struct srd_decoder_inst *di;
566 srd_dbg("Creating new %s instance.", decoder_id);
568 if (session_is_valid(sess) != SRD_OK) {
569 srd_err("Invalid session.");
573 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
574 srd_err("Protocol decoder %s not found.", decoder_id);
578 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
579 srd_err("Failed to g_malloc() instance.");
586 inst_id = g_hash_table_lookup(options, "id");
587 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
588 g_hash_table_remove(options, "id");
590 di->inst_id = g_strdup(decoder_id);
593 * Prepare a default probe map, where samples come in the
594 * order in which the decoder class defined them.
596 di->dec_num_probes = g_slist_length(di->decoder->probes) +
597 g_slist_length(di->decoder->opt_probes);
598 if (di->dec_num_probes) {
599 if (!(di->dec_probemap =
600 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
601 srd_err("Failed to g_malloc() probe map.");
605 for (i = 0; i < di->dec_num_probes; i++)
606 di->dec_probemap[i] = i;
608 di->data_unitsize = (di->dec_num_probes + 7) / 8;
610 /* Create a new instance of this decoder class. */
611 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
612 if (PyErr_Occurred())
613 srd_exception_catch("failed to create %s instance: ",
615 g_free(di->dec_probemap);
620 if (options && srd_inst_option_set(di, options) != SRD_OK) {
621 g_free(di->dec_probemap);
626 /* Instance takes input from a frontend by default. */
627 sess->di_list = g_slist_append(sess->di_list, di);
633 * Stack a decoder instance on top of another.
635 * @param sess The session holding the protocol decoder instances.
636 * @param di_from The instance to move.
637 * @param di_to The instance on top of which di_from will be stacked.
639 * @return SRD_OK upon success, a (negative) error code otherwise.
643 SRD_API int srd_inst_stack(struct srd_session *sess,
644 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to)
647 if (session_is_valid(sess) != SRD_OK) {
648 srd_err("Invalid session.");
652 if (!di_from || !di_to) {
653 srd_err("Invalid from/to instance pair.");
657 if (g_slist_find(sess->di_list, di_to)) {
658 /* Remove from the unstacked list. */
659 sess->di_list = g_slist_remove(sess->di_list, di_to);
662 /* Stack on top of source di. */
663 di_from->next_di = g_slist_append(di_from->next_di, di_to);
669 * Find a decoder instance by its instance ID.
671 * Only the bottom level of instances are searched -- instances already stacked
672 * on top of another one will not be found.
674 * @param sess The session holding the protocol decoder instance.
675 * @param inst_id The instance ID to be found.
677 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
681 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
685 struct srd_decoder_inst *tmp, *di;
687 if (session_is_valid(sess) != SRD_OK) {
688 srd_err("Invalid session.");
693 for (l = sess->di_list; l; l = l->next) {
695 if (!strcmp(tmp->inst_id, inst_id)) {
704 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
705 struct srd_session *sess, const GSList *stack,
709 struct srd_decoder_inst *tmp, *di;
711 if (session_is_valid(sess) != SRD_OK) {
712 srd_err("Invalid session.");
717 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
719 if (tmp->py_inst == obj)
721 else if (tmp->next_di)
722 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
729 * Find a decoder instance by its Python object.
731 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
732 * This will recurse to find the instance anywhere in the stack tree of all
735 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
736 * stack to search. To start searching at the bottom level of
737 * decoder instances, pass NULL.
738 * @param obj The Python class instantiation.
740 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
746 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
749 struct srd_decoder_inst *di;
750 struct srd_session *sess;
754 for (l = sessions; di == NULL && l != NULL; l = l->next) {
756 di = srd_sess_inst_find_by_obj(sess, stack, obj);
763 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
767 struct srd_decoder_inst *next_di;
770 srd_dbg("Calling start() method on protocol decoder instance %s.",
773 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
774 srd_exception_catch("Protocol decoder instance %s: ",
776 return SRD_ERR_PYTHON;
780 /* Start all the PDs stacked on top of this one. */
781 for (l = di->next_di; l; l = l->next) {
783 if ((ret = srd_inst_start(next_di)) != SRD_OK)
791 * Run the specified decoder function.
793 * @param di The decoder instance to call. Must not be NULL.
794 * @param start_samplenum The starting sample number for the buffer's sample
795 * set, relative to the start of capture.
796 * @param end_samplenum The ending sample number for the buffer's sample
797 * set, relative to the start of capture.
798 * @param inbuf The buffer to decode. Must not be NULL.
799 * @param inbuflen Length of the buffer. Must be > 0.
801 * @return SRD_OK upon success, a (negative) error code otherwise.
807 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
808 uint64_t start_samplenum, uint64_t end_samplenum,
809 const uint8_t *inbuf, uint64_t inbuflen)
814 srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
815 "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
818 /* Return an error upon unusable input. */
820 srd_dbg("empty decoder instance");
824 srd_dbg("NULL buffer pointer");
828 srd_dbg("empty buffer");
833 * Create new srd_logic object. Each iteration around the PD's loop
834 * will fill one sample into this object.
836 logic = PyObject_New(srd_logic, &srd_logic_type);
838 logic->di = (struct srd_decoder_inst *)di;
839 logic->start_samplenum = start_samplenum;
841 logic->inbuf = (uint8_t *)inbuf;
842 logic->inbuflen = inbuflen;
843 logic->sample = PyList_New(2);
844 Py_INCREF(logic->sample);
846 Py_IncRef(di->py_inst);
847 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
848 "KKO", start_samplenum, end_samplenum, logic))) {
849 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
850 return SRD_ERR_PYTHON;
858 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
861 struct srd_pd_output *pdo;
863 srd_dbg("Freeing instance %s", di->inst_id);
865 Py_DecRef(di->py_inst);
867 g_free(di->dec_probemap);
868 g_slist_free(di->next_di);
869 for (l = di->pd_output; l; l = l->next) {
871 g_free(pdo->proto_id);
874 g_slist_free(di->pd_output);
879 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
882 struct srd_decoder_inst *di;
884 if (session_is_valid(sess) != SRD_OK) {
885 srd_err("Invalid session.");
890 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
893 srd_inst_free_all(sess, di->next_di);
897 g_slist_free(sess->di_list);
898 sess->di_list = NULL;
905 * @defgroup grp_session Session handling
907 * Starting and handling decoding sessions.
912 static int session_is_valid(struct srd_session *sess)
915 if (!sess || sess->session_id < 1)
922 * Create a decoding session.
924 * A session holds all decoder instances, their stack relationships and
927 * @param sess A pointer which will hold a pointer to a newly
928 * initialized session on return.
930 * @return SRD_OK upon success, a (negative) error code otherwise.
934 SRD_API int srd_session_new(struct srd_session **sess)
938 srd_err("Invalid session pointer.");
942 if (!(*sess = g_try_malloc(sizeof(struct srd_session))))
943 return SRD_ERR_MALLOC;
944 (*sess)->session_id = ++max_session_id;
945 (*sess)->di_list = (*sess)->callbacks = NULL;
947 /* Keep a list of all sessions, so we can clean up as needed. */
948 sessions = g_slist_append(sessions, *sess);
950 srd_dbg("Created session %d.", (*sess)->session_id);
956 * Start a decoding session.
958 * Decoders, instances and stack must have been prepared beforehand,
959 * and all SRD_CONF parameters set.
961 * @param sess The session to start.
963 * @return SRD_OK upon success, a (negative) error code otherwise.
967 SRD_API int srd_session_start(struct srd_session *sess)
970 struct srd_decoder_inst *di;
973 if (session_is_valid(sess) != SRD_OK) {
974 srd_err("Invalid session pointer.");
978 srd_dbg("Calling start() on all instances in session %d.", sess->session_id);
980 /* Run the start() method on all decoders receiving frontend data. */
982 for (d = sess->di_list; d; d = d->next) {
984 if ((ret = srd_inst_start(di)) != SRD_OK)
991 SRD_PRIV int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
996 if (key != SRD_CONF_SAMPLERATE)
997 /* This is the only key we pass on to the decoder for now. */
1000 if (!PyObject_HasAttrString(di->py_inst, "metadata"))
1001 /* This decoder doesn't want metadata, that's fine. */
1004 py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK",
1005 (long)SRD_CONF_SAMPLERATE,
1006 (unsigned long long)g_variant_get_uint64(data));
1013 * Set a metadata configuration key in a session.
1015 * @param sess The session to configure.
1016 * @param key The configuration key (SRD_CONF_*).
1017 * @param data The new value for the key, as a GVariant with GVariantType
1018 * appropriate to that key. A floating reference can be passed
1019 * in; its refcount will be sunk and unreferenced after use.
1021 * @return SRD_OK upon success, a (negative) error code otherwise.
1025 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
1031 if (session_is_valid(sess) != SRD_OK) {
1032 srd_err("Invalid session.");
1036 if (key != SRD_CONF_SAMPLERATE) {
1037 srd_err("Unknown config key %d.", key);
1041 srd_dbg("Setting session %d samplerate to %"PRIu64".",
1042 sess->session_id, g_variant_get_uint64(data));
1045 for (l = sess->di_list; l; l = l->next) {
1046 if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK)
1050 g_variant_unref(data);
1056 * Send a chunk of logic sample data to a running decoder session.
1058 * The logic samples must be arranged in probe order, in the least
1059 * amount of space possible. If no probes were configured, the default
1060 * probe set consists of all required probes + all optional probes.
1062 * The size of a sample in inbuf is the minimum number of bytes needed
1063 * to store the configured (or default) probes.
1065 * @param sess The session to use.
1066 * @param start_samplenum The sample number of the first sample in this chunk.
1067 * @param end_samplenum The sample number of the last sample in this chunk.
1068 * @param inbuf Pointer to sample data.
1069 * @param inbuflen Length in bytes of the buffer.
1071 * @return SRD_OK upon success, a (negative) error code otherwise.
1075 SRD_API int srd_session_send(struct srd_session *sess,
1076 uint64_t start_samplenum, uint64_t end_samplenum,
1077 const uint8_t *inbuf, uint64_t inbuflen)
1082 if (session_is_valid(sess) != SRD_OK) {
1083 srd_err("Invalid session.");
1087 srd_dbg("Calling decode() on all instances with starting sample "
1088 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
1089 start_samplenum, inbuflen, inbuf);
1091 for (d = sess->di_list; d; d = d->next) {
1092 if ((ret = srd_inst_decode(d->data, start_samplenum,
1093 end_samplenum, inbuf, inbuflen)) != SRD_OK)
1101 * Destroy a decoding session.
1103 * All decoder instances and output callbacks are properly released.
1105 * @param sess The session to be destroyed.
1107 * @return SRD_OK upon success, a (negative) error code otherwise.
1111 SRD_API int srd_session_destroy(struct srd_session *sess)
1116 srd_err("Invalid session.");
1120 session_id = sess->session_id;
1122 srd_inst_free_all(sess, NULL);
1123 if (sess->callbacks)
1124 g_slist_free_full(sess->callbacks, g_free);
1125 sessions = g_slist_remove(sessions, sess);
1128 srd_dbg("Destroyed session %d.", session_id);
1134 * Register/add a decoder output callback function.
1136 * The function will be called when a protocol decoder sends output back
1137 * to the PD controller (except for Python objects, which only go up the
1140 * @param sess The output session in which to register the callback.
1141 * @param output_type The output type this callback will receive. Only one
1142 * callback per output type can be registered.
1143 * @param cb The function to call. Must not be NULL.
1144 * @param cb_data Private data for the callback function. Can be NULL.
1148 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
1149 int output_type, srd_pd_output_callback_t cb, void *cb_data)
1151 struct srd_pd_callback *pd_cb;
1153 if (session_is_valid(sess) != SRD_OK) {
1154 srd_err("Invalid session.");
1158 srd_dbg("Registering new callback for output type %d.", output_type);
1160 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
1161 srd_err("Failed to g_malloc() struct srd_pd_callback.");
1162 return SRD_ERR_MALLOC;
1165 pd_cb->output_type = output_type;
1167 pd_cb->cb_data = cb_data;
1168 sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
1174 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
1175 struct srd_session *sess, int output_type)
1178 struct srd_pd_callback *tmp, *pd_cb;
1180 if (session_is_valid(sess) != SRD_OK) {
1181 srd_err("Invalid session.");
1186 for (l = sess->callbacks; l; l = l->next) {
1188 if (tmp->output_type == output_type) {