Move session-specific functionality into session.c
[libsigrokdecode.git] / session.c
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2013 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 "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode-internal.h"
23 #include "config.h"
24 #include <glib.h>
25
26 /**
27  * @file
28  *
29  * Session handling.
30  */
31
32 /**
33  * @defgroup grp_session Session handling
34  *
35  * Starting and handling decoding sessions.
36  *
37  * @{
38  */
39
40 /** @cond PRIVATE */
41
42 SRD_PRIV GSList *sessions = NULL;
43 int max_session_id = -1;
44
45 /** @endcond */
46
47 /** @private */
48 SRD_PRIV int session_is_valid(struct srd_session *sess)
49 {
50
51         if (!sess || sess->session_id < 1)
52                 return SRD_ERR;
53
54         return SRD_OK;
55 }
56
57 /**
58  * Create a decoding session.
59  *
60  * A session holds all decoder instances, their stack relationships and
61  * output callbacks.
62  *
63  * @param sess A pointer which will hold a pointer to a newly
64  *             initialized session on return.
65  *
66  * @return SRD_OK upon success, a (negative) error code otherwise.
67  *
68  * @since 0.3.0
69  */
70 SRD_API int srd_session_new(struct srd_session **sess)
71 {
72
73         if (!sess) {
74                 srd_err("Invalid session pointer.");
75                 return SRD_ERR_ARG;
76         }
77
78         if (!(*sess = g_try_malloc(sizeof(struct srd_session))))
79                 return SRD_ERR_MALLOC;
80         (*sess)->session_id = ++max_session_id;
81         (*sess)->di_list = (*sess)->callbacks = NULL;
82
83         /* Keep a list of all sessions, so we can clean up as needed. */
84         sessions = g_slist_append(sessions, *sess);
85
86         srd_dbg("Created session %d.", (*sess)->session_id);
87
88         return SRD_OK;
89 }
90
91 /**
92  * Start a decoding session.
93  *
94  * Decoders, instances and stack must have been prepared beforehand,
95  * and all SRD_CONF parameters set.
96  *
97  * @param sess The session to start.
98  *
99  * @return SRD_OK upon success, a (negative) error code otherwise.
100  *
101  * @since 0.3.0
102  */
103 SRD_API int srd_session_start(struct srd_session *sess)
104 {
105         GSList *d;
106         struct srd_decoder_inst *di;
107         int ret;
108
109         if (session_is_valid(sess) != SRD_OK) {
110                 srd_err("Invalid session pointer.");
111                 return SRD_ERR;
112         }
113
114         srd_dbg("Calling start() on all instances in session %d.", sess->session_id);
115
116         /* Run the start() method on all decoders receiving frontend data. */
117         ret = SRD_OK;
118         for (d = sess->di_list; d; d = d->next) {
119                 di = d->data;
120                 if ((ret = srd_inst_start(di)) != SRD_OK)
121                         break;
122         }
123
124         return ret;
125 }
126
127 /** @private */
128 SRD_PRIV int srd_inst_send_meta(struct srd_decoder_inst *di, int key,
129                 GVariant *data)
130 {
131         PyObject *py_ret;
132
133         if (key != SRD_CONF_SAMPLERATE)
134                 /* This is the only key we pass on to the decoder for now. */
135                 return SRD_OK;
136
137         if (!PyObject_HasAttrString(di->py_inst, "metadata"))
138                 /* This decoder doesn't want metadata, that's fine. */
139                 return SRD_OK;
140
141         py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK",
142                         (long)SRD_CONF_SAMPLERATE,
143                         (unsigned long long)g_variant_get_uint64(data));
144         Py_XDECREF(py_ret);
145
146         return SRD_OK;
147 }
148
149 /**
150  * Set a metadata configuration key in a session.
151  *
152  * @param sess The session to configure.
153  * @param key The configuration key (SRD_CONF_*).
154  * @param data The new value for the key, as a GVariant with GVariantType
155  *             appropriate to that key. A floating reference can be passed
156  *             in; its refcount will be sunk and unreferenced after use.
157  *
158  * @return SRD_OK upon success, a (negative) error code otherwise.
159  *
160  * @since 0.3.0
161  */
162 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
163                 GVariant *data)
164 {
165         GSList *l;
166         int ret;
167
168         if (session_is_valid(sess) != SRD_OK) {
169                 srd_err("Invalid session.");
170                 return SRD_ERR_ARG;
171         }
172
173         if (key != SRD_CONF_SAMPLERATE) {
174                 srd_err("Unknown config key %d.", key);
175                 return SRD_ERR_ARG;
176         }
177
178         srd_dbg("Setting session %d samplerate to %"PRIu64".",
179                         sess->session_id, g_variant_get_uint64(data));
180
181         ret = SRD_OK;
182         for (l = sess->di_list; l; l = l->next) {
183                 if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK)
184                         break;
185         }
186
187         g_variant_unref(data);
188
189         return ret;
190 }
191
192 /**
193  * Send a chunk of logic sample data to a running decoder session.
194  *
195  * The logic samples must be arranged in probe order, in the least
196  * amount of space possible. If no probes were configured, the default
197  * probe set consists of all required probes + all optional probes.
198  *
199  * The size of a sample in inbuf is the minimum number of bytes needed
200  * to store the configured (or default) probes.
201  *
202  * @param sess The session to use.
203  * @param start_samplenum The sample number of the first sample in this chunk.
204  * @param end_samplenum The sample number of the last sample in this chunk.
205  * @param inbuf Pointer to sample data.
206  * @param inbuflen Length in bytes of the buffer.
207  *
208  * @return SRD_OK upon success, a (negative) error code otherwise.
209  *
210  * @since 0.3.0
211  */
212 SRD_API int srd_session_send(struct srd_session *sess,
213                 uint64_t start_samplenum, uint64_t end_samplenum,
214                 const uint8_t *inbuf, uint64_t inbuflen)
215 {
216         GSList *d;
217         int ret;
218
219         if (session_is_valid(sess) != SRD_OK) {
220                 srd_err("Invalid session.");
221                 return SRD_ERR_ARG;
222         }
223
224         srd_dbg("Calling decode() on all instances with starting sample "
225                         "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
226                         start_samplenum, inbuflen, inbuf);
227
228         for (d = sess->di_list; d; d = d->next) {
229                 if ((ret = srd_inst_decode(d->data, start_samplenum,
230                                 end_samplenum, inbuf, inbuflen)) != SRD_OK)
231                         return ret;
232         }
233
234         return SRD_OK;
235 }
236
237 /**
238  * Destroy a decoding session.
239  *
240  * All decoder instances and output callbacks are properly released.
241  *
242  * @param sess The session to be destroyed.
243  *
244  * @return SRD_OK upon success, a (negative) error code otherwise.
245  *
246  * @since 0.3.0
247  */
248 SRD_API int srd_session_destroy(struct srd_session *sess)
249 {
250         int session_id;
251
252         if (!sess) {
253                 srd_err("Invalid session.");
254                 return SRD_ERR_ARG;
255         }
256
257         session_id = sess->session_id;
258         if (sess->di_list)
259                 srd_inst_free_all(sess, NULL);
260         if (sess->callbacks)
261                 g_slist_free_full(sess->callbacks, g_free);
262         sessions = g_slist_remove(sessions, sess);
263         g_free(sess);
264
265         srd_dbg("Destroyed session %d.", session_id);
266
267         return SRD_OK;
268 }
269
270 /**
271  * Register/add a decoder output callback function.
272  *
273  * The function will be called when a protocol decoder sends output back
274  * to the PD controller (except for Python objects, which only go up the
275  * stack).
276  *
277  * @param sess The output session in which to register the callback.
278  * @param output_type The output type this callback will receive. Only one
279  *                    callback per output type can be registered.
280  * @param cb The function to call. Must not be NULL.
281  * @param cb_data Private data for the callback function. Can be NULL.
282  *
283  * @since 0.3.0
284  */
285 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
286                 int output_type, srd_pd_output_callback_t cb, void *cb_data)
287 {
288         struct srd_pd_callback *pd_cb;
289
290         if (session_is_valid(sess) != SRD_OK) {
291                 srd_err("Invalid session.");
292                 return SRD_ERR_ARG;
293         }
294
295         srd_dbg("Registering new callback for output type %d.", output_type);
296
297         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
298                 srd_err("Failed to g_malloc() struct srd_pd_callback.");
299                 return SRD_ERR_MALLOC;
300         }
301
302         pd_cb->output_type = output_type;
303         pd_cb->cb = cb;
304         pd_cb->cb_data = cb_data;
305         sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
306
307         return SRD_OK;
308 }
309
310 /** @private */
311 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
312                 struct srd_session *sess, int output_type)
313 {
314         GSList *l;
315         struct srd_pd_callback *tmp, *pd_cb;
316
317         if (session_is_valid(sess) != SRD_OK) {
318                 srd_err("Invalid session.");
319                 return NULL;
320         }
321
322         pd_cb = NULL;
323         for (l = sess->callbacks; l; l = l->next) {
324                 tmp = l->data;
325                 if (tmp->output_type == output_type) {
326                         pd_cb = tmp;
327                         break;
328                 }
329         }
330
331         return pd_cb;
332 }
333
334 /** @} */