X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=session.c;h=cec97cf727d6aea602899b1a6256d39ce86f484f;hp=e1bb4f9880d36a8f64f8603827a7df8585d088bc;hb=7969d8035530d40753c4f880c90a4e90f9679ccc;hpb=e27347a42f06d4ff19b061f89a2257df1fc13098 diff --git a/session.c b/session.c index e1bb4f9..cec97cf 100644 --- a/session.c +++ b/session.c @@ -48,7 +48,6 @@ SRD_PRIV int max_session_id = -1; /** @private */ SRD_PRIV int session_is_valid(struct srd_session *sess) { - if (!sess || sess->session_id < 1) return SRD_ERR; @@ -70,7 +69,6 @@ SRD_PRIV int session_is_valid(struct srd_session *sess) */ SRD_API int srd_session_new(struct srd_session **sess) { - if (!sess) { srd_err("Invalid session pointer."); return SRD_ERR_ARG; @@ -131,11 +129,14 @@ static int srd_inst_send_meta(struct srd_decoder_inst *di, int key, GSList *l; struct srd_decoder_inst *next_di; int ret; + PyGILState_STATE gstate; if (key != SRD_CONF_SAMPLERATE) /* This is the only key we pass on to the decoder for now. */ return SRD_OK; + gstate = PyGILState_Ensure(); + if (PyObject_HasAttrString(di->py_inst, "metadata")) { py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK", (long)SRD_CONF_SAMPLERATE, @@ -143,6 +144,8 @@ static int srd_inst_send_meta(struct srd_decoder_inst *di, int key, Py_XDECREF(py_ret); } + PyGILState_Release(gstate); + /* Push metadata to all the PDs stacked on top of this one. */ for (l = di->next_di; l; l = l->next) { next_di = l->data; @@ -199,7 +202,7 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, return SRD_ERR_ARG; } - srd_dbg("Setting session %d samplerate to %"PRIu64".", + srd_dbg("Setting session %d samplerate to %"G_GUINT64_FORMAT".", sess->session_id, g_variant_get_uint64(data)); ret = SRD_OK; @@ -224,9 +227,45 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, * has been configured, it is the minimum number of bytes needed to store * the default channels. * + * The calls to this function must provide the samples that shall be + * used by the protocol decoder + * - in the correct order ([...]5, 6, 4, 7, 8[...] is a bug), + * - starting from sample zero (2, 3, 4, 5, 6[...] is a bug), + * - consecutively, with no gaps (0, 1, 2, 4, 5[...] is a bug). + * + * The start- and end-sample numbers are absolute sample numbers (relative + * to the start of the whole capture/file/stream), i.e. they are not relative + * sample numbers within the chunk specified by 'inbuf' and 'inbuflen'. + * + * Correct example (4096 samples total, 4 chunks @ 1024 samples each): + * srd_session_send(s, 0, 1023, inbuf, 1024, 1); + * srd_session_send(s, 1024, 2047, inbuf, 1024, 1); + * srd_session_send(s, 2048, 3071, inbuf, 1024, 1); + * srd_session_send(s, 3072, 4095, inbuf, 1024, 1); + * + * The chunk size ('inbuflen') can be arbitrary and can differ between calls. + * + * Correct example (4096 samples total, 7 chunks @ various samples each): + * srd_session_send(s, 0, 1023, inbuf, 1024, 1); + * srd_session_send(s, 1024, 1123, inbuf, 100, 1); + * srd_session_send(s, 1124, 1423, inbuf, 300, 1); + * srd_session_send(s, 1424, 1642, inbuf, 219, 1); + * srd_session_send(s, 1643, 2047, inbuf, 405, 1); + * srd_session_send(s, 2048, 3071, inbuf, 1024, 1); + * srd_session_send(s, 3072, 4095, inbuf, 1024, 1); + * + * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but + * the start- and end-samplenumbers are not absolute): + * srd_session_send(s, 0, 1023, inbuf, 1024, 1); + * srd_session_send(s, 0, 1023, inbuf, 1024, 1); + * srd_session_send(s, 0, 1023, inbuf, 1024, 1); + * srd_session_send(s, 0, 1023, inbuf, 1024, 1); + * * @param sess The session to use. Must not be NULL. - * @param start_samplenum The sample number of the first sample in this chunk. - * @param end_samplenum The sample number of the last sample in this chunk. + * @param abs_start_samplenum The absolute starting sample number for the + * buffer's sample set, relative to the start of capture. + * @param abs_end_samplenum The absolute ending sample number for the + * buffer's sample set, relative to the start of capture. * @param inbuf Pointer to sample data. Must not be NULL. * @param inbuflen Length in bytes of the buffer. Must be > 0. * @param unitsize The number of bytes per sample. Must be > 0. @@ -236,7 +275,7 @@ SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, * @since 0.4.0 */ SRD_API int srd_session_send(struct srd_session *sess, - uint64_t start_samplenum, uint64_t end_samplenum, + uint64_t abs_start_samplenum, uint64_t abs_end_samplenum, const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize) { GSList *d; @@ -248,8 +287,48 @@ SRD_API int srd_session_send(struct srd_session *sess, } for (d = sess->di_list; d; d = d->next) { - if ((ret = srd_inst_decode(d->data, start_samplenum, - end_samplenum, inbuf, inbuflen, unitsize)) != SRD_OK) + if ((ret = srd_inst_decode(d->data, abs_start_samplenum, + abs_end_samplenum, inbuf, inbuflen, unitsize)) != SRD_OK) + return ret; + } + + return SRD_OK; +} + +/** + * Terminate currently executing decoders in a session, reset internal state. + * + * All decoder instances have their .wait() method terminated, which + * shall terminate .decode() as well. Afterwards the decoders' optional + * .reset() method gets executed. + * + * This routine allows callers to abort pending expensive operations, + * when they are no longer interested in the decoders' results. Note + * that the decoder state is lost and aborted work cannot resume. + * + * This routine also allows callers to re-use previously created decoder + * stacks to process new input data which is not related to previously + * processed input data. This avoids the necessity to re-construct the + * decoder stack. + * + * @param sess The session in which to terminate decoders. + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.6.0 + */ +SRD_API int srd_session_terminate_reset(struct srd_session *sess) +{ + GSList *d; + int ret; + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return SRD_ERR_ARG; + } + + for (d = sess->di_list; d; d = d->next) { + ret = srd_inst_terminate_reset(d->data); + if (ret != SRD_OK) return ret; } @@ -278,7 +357,7 @@ SRD_API int srd_session_destroy(struct srd_session *sess) session_id = sess->session_id; if (sess->di_list) - srd_inst_free_all(sess, NULL); + srd_inst_free_all(sess); if (sess->callbacks) g_slist_free_full(sess->callbacks, g_free); sessions = g_slist_remove(sessions, sess);