2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode.h"
34 * @defgroup grp_session Session handling
36 * Starting and handling decoding sessions.
43 SRD_PRIV GSList *sessions = NULL;
44 SRD_PRIV int max_session_id = -1;
49 SRD_PRIV int session_is_valid(struct srd_session *sess)
52 if (!sess || sess->session_id < 1)
59 * Create a decoding session.
61 * A session holds all decoder instances, their stack relationships and
64 * @param sess A pointer which will hold a pointer to a newly
65 * initialized session on return.
67 * @return SRD_OK upon success, a (negative) error code otherwise.
71 SRD_API int srd_session_new(struct srd_session **sess)
75 srd_err("Invalid session pointer.");
79 *sess = g_malloc(sizeof(struct srd_session));
80 (*sess)->session_id = ++max_session_id;
81 (*sess)->di_list = (*sess)->callbacks = NULL;
83 /* Keep a list of all sessions, so we can clean up as needed. */
84 sessions = g_slist_append(sessions, *sess);
86 srd_dbg("Created session %d.", (*sess)->session_id);
92 * Start a decoding session.
94 * Decoders, instances and stack must have been prepared beforehand,
95 * and all SRD_CONF parameters set.
97 * @param sess The session to start.
99 * @return SRD_OK upon success, a (negative) error code otherwise.
103 SRD_API int srd_session_start(struct srd_session *sess)
106 struct srd_decoder_inst *di;
109 if (session_is_valid(sess) != SRD_OK) {
110 srd_err("Invalid session pointer.");
114 srd_dbg("Calling start() on all instances in session %d.", sess->session_id);
116 /* Run the start() method on all decoders receiving frontend data. */
118 for (d = sess->di_list; d; d = d->next) {
120 if ((ret = srd_inst_start(di)) != SRD_OK)
127 static int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
132 if (key != SRD_CONF_SAMPLERATE)
133 /* This is the only key we pass on to the decoder for now. */
136 if (!PyObject_HasAttrString(di->py_inst, "metadata"))
137 /* This decoder doesn't want metadata, that's fine. */
140 py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK",
141 (long)SRD_CONF_SAMPLERATE,
142 (unsigned long long)g_variant_get_uint64(data));
149 * Set a metadata configuration key in a session.
151 * @param sess The session to configure.
152 * @param key The configuration key (SRD_CONF_*).
153 * @param data The new value for the key, as a GVariant with GVariantType
154 * appropriate to that key. A floating reference can be passed
155 * in; its refcount will be sunk and unreferenced after use.
157 * @return SRD_OK upon success, a (negative) error code otherwise.
161 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
167 if (session_is_valid(sess) != SRD_OK) {
168 srd_err("Invalid session.");
173 srd_err("Invalid key.");
178 srd_err("Invalid value.");
182 /* Hardcoded to samplerate/uint64 for now. */
184 if (key != SRD_CONF_SAMPLERATE) {
185 srd_err("Unknown config key %d.", key);
188 if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
189 srd_err("Invalid value type: expected uint64, got %s",
190 g_variant_get_type_string(data));
194 srd_dbg("Setting session %d samplerate to %"PRIu64".",
195 sess->session_id, g_variant_get_uint64(data));
198 for (l = sess->di_list; l; l = l->next) {
199 if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK)
203 g_variant_unref(data);
209 * Send a chunk of logic sample data to a running decoder session.
211 * If no channel map has been set up, the logic samples must be arranged
212 * in channel order, in the least amount of space possible. The default
213 * channel set consists of all required channels + all optional channels.
215 * The size of a sample in inbuf is 'unitsize' bytes. If no channel map
216 * has been configured, it is the minimum number of bytes needed to store
217 * the default channels.
219 * @param sess The session to use.
220 * @param start_samplenum The sample number of the first sample in this chunk.
221 * @param end_samplenum The sample number of the last sample in this chunk.
222 * @param inbuf Pointer to sample data.
223 * @param inbuflen Length in bytes of the buffer.
224 * @param unitsize The number of bytes per sample.
226 * @return SRD_OK upon success, a (negative) error code otherwise.
230 SRD_API int srd_session_send(struct srd_session *sess,
231 uint64_t start_samplenum, uint64_t end_samplenum,
232 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
237 if (session_is_valid(sess) != SRD_OK) {
238 srd_err("Invalid session.");
242 for (d = sess->di_list; d; d = d->next) {
243 if ((ret = srd_inst_decode(d->data, start_samplenum,
244 end_samplenum, inbuf, inbuflen, unitsize)) != SRD_OK)
252 * Destroy a decoding session.
254 * All decoder instances and output callbacks are properly released.
256 * @param sess The session to be destroyed.
258 * @return SRD_OK upon success, a (negative) error code otherwise.
262 SRD_API int srd_session_destroy(struct srd_session *sess)
267 srd_err("Invalid session.");
271 session_id = sess->session_id;
273 srd_inst_free_all(sess, NULL);
275 g_slist_free_full(sess->callbacks, g_free);
276 sessions = g_slist_remove(sessions, sess);
279 srd_dbg("Destroyed session %d.", session_id);
285 * Register/add a decoder output callback function.
287 * The function will be called when a protocol decoder sends output back
288 * to the PD controller (except for Python objects, which only go up the
291 * @param sess The output session in which to register the callback.
292 * @param output_type The output type this callback will receive. Only one
293 * callback per output type can be registered.
294 * @param cb The function to call. Must not be NULL.
295 * @param cb_data Private data for the callback function. Can be NULL.
299 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
300 int output_type, srd_pd_output_callback cb, void *cb_data)
302 struct srd_pd_callback *pd_cb;
304 if (session_is_valid(sess) != SRD_OK) {
305 srd_err("Invalid session.");
309 srd_dbg("Registering new callback for output type %d.", output_type);
311 pd_cb = g_malloc(sizeof(struct srd_pd_callback));
312 pd_cb->output_type = output_type;
314 pd_cb->cb_data = cb_data;
315 sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
321 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
322 struct srd_session *sess, int output_type)
325 struct srd_pd_callback *tmp, *pd_cb;
327 if (session_is_valid(sess) != SRD_OK) {
328 srd_err("Invalid session.");
333 for (l = sess->callbacks; l; l = l->next) {
335 if (tmp->output_type == output_type) {