[libsigrokdecode.git] / type_decoder.c

/*
 * This file is part of the libsigrokdecode project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include "libsigrokdecode.h"
#include "config.h"
#include <inttypes.h>

typedef struct {
        PyObject_HEAD
} srd_Decoder;

/* This is only used for nicer srd_dbg() output. */
static const char *OUTPUT_TYPES[] = {
	"OUTPUT_ANN",
	"OUTPUT_PYTHON",
	"OUTPUT_BINARY",
	"OUTPUT_META",
};

static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
		struct srd_proto_data *pdata)
{
	PyObject *py_tmp;
	struct srd_pd_output *pdo;
	struct srd_proto_data_annotation *pda;
	int ann_class;
	char **ann_text;

	/* Should be a list of [annotation class, [string, ...]]. */
	if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
		srd_err("Protocol decoder %s submitted %s instead of list.",
			di->decoder->name, obj->ob_type->tp_name);
		return SRD_ERR_PYTHON;
	}

	/* Should have 2 elements. */
	if (PyList_Size(obj) != 2) {
		srd_err("Protocol decoder %s submitted annotation list with "
			"%d elements instead of 2", di->decoder->name,
			PyList_Size(obj));
		return SRD_ERR_PYTHON;
	}

	/*
	 * The first element should be an integer matching a previously
	 * registered annotation class.
	 */
	py_tmp = PyList_GetItem(obj, 0);
	if (!PyLong_Check(py_tmp)) {
		srd_err("Protocol decoder %s submitted annotation list, but "
			"first element was not an integer.", di->decoder->name);
		return SRD_ERR_PYTHON;
	}
	ann_class = PyLong_AsLong(py_tmp);
	if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
		srd_err("Protocol decoder %s submitted data to unregistered "
			"annotation class %d.", di->decoder->name, ann_class);
		return SRD_ERR_PYTHON;
	}

	/* Second element must be a list. */
	py_tmp = PyList_GetItem(obj, 1);
	if (!PyList_Check(py_tmp)) {
		srd_err("Protocol decoder %s submitted annotation list, but "
			"second element was not a list.", di->decoder->name);
		return SRD_ERR_PYTHON;
	}
	if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
		srd_err("Protocol decoder %s submitted annotation list, but "
			"second element was malformed.", di->decoder->name);
		return SRD_ERR_PYTHON;
	}

	pda = g_malloc(sizeof(struct srd_proto_data_annotation));
	pda->ann_class = ann_class;
	pda->ann_text = ann_text;
	pdata->data = pda;

	return SRD_OK;
}

static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
		struct srd_proto_data *pdata)
{
	struct srd_proto_data_binary *pdb;
	PyObject *py_tmp;
	Py_ssize_t size;
	int bin_class;
	char *class_name, *buf;

	/* Should be a tuple of (binary class, bytes). */
	if (!PyTuple_Check(obj)) {
		srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
				"%s instead of tuple.", di->decoder->name,
				obj->ob_type->tp_name);
		return SRD_ERR_PYTHON;
	}

	/* Should have 2 elements. */
	if (PyTuple_Size(obj) != 2) {
		srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple "
				"with %d elements instead of 2", di->decoder->name,
				PyList_Size(obj));
		return SRD_ERR_PYTHON;
	}

	/* The first element should be an integer. */
	py_tmp = PyTuple_GetItem(obj, 0);
	if (!PyLong_Check(py_tmp)) {
		srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple, "
			"but first element was not an integer.", di->decoder->name);
		return SRD_ERR_PYTHON;
	}
	bin_class = PyLong_AsLong(py_tmp);
	if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
		srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
			"unregistered binary class %d.", di->decoder->name, bin_class);
		return SRD_ERR_PYTHON;
	}

	/* Second element should be bytes. */
	py_tmp = PyTuple_GetItem(obj, 1);
	if (!PyBytes_Check(py_tmp)) {
		srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple, "
			"but second element was not bytes.", di->decoder->name);
		return SRD_ERR_PYTHON;
	}

	/* Consider an empty set of bytes a bug. */
	if (PyBytes_Size(py_tmp) == 0) {
		srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
				"with empty data set.", di->decoder->name);
		return SRD_ERR_PYTHON;
	}

	pdb = g_malloc(sizeof(struct srd_proto_data_binary));
	if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
		return SRD_ERR_PYTHON;
	pdb->bin_class = bin_class;
	pdb->size = size;
	if (!(pdb->data = g_try_malloc(pdb->size)))
		return SRD_ERR_MALLOC;
	memcpy((void *)pdb->data, (const void *)buf, pdb->size);
	pdata->data = pdb;

	return SRD_OK;
}

static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
{
	long long intvalue;
	double dvalue;

	if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) {
		if (!PyLong_Check(obj)) {
			PyErr_Format(PyExc_TypeError, "This output was registered "
					"as 'int', but '%s' was passed.", obj->ob_type->tp_name);
			return SRD_ERR_PYTHON;
		}
		intvalue = PyLong_AsLongLong(obj);
		if (PyErr_Occurred())
			return SRD_ERR_PYTHON;
		pdata->data = g_variant_new_int64(intvalue);
	} else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) {
		if (!PyFloat_Check(obj)) {
			PyErr_Format(PyExc_TypeError, "This output was registered "
					"as 'float', but '%s' was passed.", obj->ob_type->tp_name);
			return SRD_ERR_PYTHON;
		}
		dvalue = PyFloat_AsDouble(obj);
		if (PyErr_Occurred())
			return SRD_ERR_PYTHON;
		pdata->data = g_variant_new_double(dvalue);
	}

	return SRD_OK;
}

static PyObject *Decoder_put(PyObject *self, PyObject *args)
{
	GSList *l;
	PyObject *py_data, *py_res;
	struct srd_decoder_inst *di, *next_di;
	struct srd_pd_output *pdo;
	struct srd_proto_data *pdata;
	uint64_t start_sample, end_sample;
	int output_id;
	struct srd_pd_callback *cb;

	if (!(di = srd_inst_find_by_obj(NULL, self))) {
		/* Shouldn't happen. */
		srd_dbg("put(): self instance not found.");
		return NULL;
	}

	if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
		&output_id, &py_data)) {
		/*
		 * This throws an exception, but by returning NULL here we let
		 * Python raise it. This results in a much better trace in
		 * controller.c on the decode() method call.
		 */
		return NULL;
	}

	if (!(l = g_slist_nth(di->pd_output, output_id))) {
		srd_err("Protocol decoder %s submitted invalid output ID %d.",
			di->decoder->name, output_id);
		return NULL;
	}
	pdo = l->data;

	srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
		 di->inst_id, start_sample, end_sample,
		 OUTPUT_TYPES[pdo->output_type], output_id);

	pdata = g_malloc0(sizeof(struct srd_proto_data));
	pdata->start_sample = start_sample;
	pdata->end_sample = end_sample;
	pdata->pdo = pdo;

	switch (pdo->output_type) {
	case SRD_OUTPUT_ANN:
		/* Annotations are only fed to callbacks. */
		if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
			/* Convert from PyDict to srd_proto_data_annotation. */
			if (convert_annotation(di, py_data, pdata) != SRD_OK) {
				/* An error was already logged. */
				break;
			}
			cb->cb(pdata, cb->cb_data);
		}
		break;
	case SRD_OUTPUT_PYTHON:
		for (l = di->next_di; l; l = l->next) {
			next_di = l->data;
			srd_spew("Sending %d-%d to instance %s",
				 start_sample, end_sample, next_di->inst_id);
			if (!(py_res = PyObject_CallMethod(
				next_di->py_inst, "decode", "KKO", start_sample,
				end_sample, py_data))) {
				srd_exception_catch("Calling %s decode(): ",
							next_di->inst_id);
			}
			Py_XDECREF(py_res);
		}
		if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
			/* Frontends aren't really supposed to get Python
			 * callbacks, but it's useful for testing. */
			pdata->data = py_data;
			cb->cb(pdata, cb->cb_data);
		}
		break;
	case SRD_OUTPUT_BINARY:
		if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
			/* Convert from PyDict to srd_proto_data_binary. */
			if (convert_binary(di, py_data, pdata) != SRD_OK) {
				/* An error was already logged. */
				break;
			}
			cb->cb(pdata, cb->cb_data);
		}
		break;
	case SRD_OUTPUT_META:
		if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
			/* Annotations need converting from PyObject. */
			if (convert_meta(pdata, py_data) != SRD_OK) {
				/* An exception was already set up. */
				break;
			}
			cb->cb(pdata, cb->cb_data);
		}
		break;
	default:
		srd_err("Protocol decoder %s submitted invalid output type %d.",
			di->decoder->name, pdo->output_type);
		break;
	}

	g_free(pdata);

	Py_RETURN_NONE;
}

static PyObject *Decoder_register(PyObject *self, PyObject *args,
		PyObject *kwargs)
{
	struct srd_decoder_inst *di;
	struct srd_pd_output *pdo;
	PyObject *py_new_output_id;
	PyTypeObject *meta_type_py;
	const GVariantType *meta_type_gv;
	int output_type;
	char *proto_id, *meta_name, *meta_descr;
	char *keywords[] = {"output_type", "proto_id", "meta", NULL};

	meta_type_py = NULL;
	meta_type_gv = NULL;
	meta_name = meta_descr = NULL;

	if (!(di = srd_inst_find_by_obj(NULL, self))) {
		PyErr_SetString(PyExc_Exception, "decoder instance not found");
		return NULL;
	}

	/* Default to instance id, which defaults to class id. */
	proto_id = di->inst_id;
	if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
			&output_type, &proto_id,
			&meta_type_py, &meta_name, &meta_descr)) {
		/* Let Python raise this exception. */
		return NULL;
	}

	/* Check if the meta value's type is supported. */
	if (output_type == SRD_OUTPUT_META) {
		if (meta_type_py == &PyLong_Type)
			meta_type_gv = G_VARIANT_TYPE_INT64;
		else if (meta_type_py == &PyFloat_Type)
			meta_type_gv = G_VARIANT_TYPE_DOUBLE;
		else {
			PyErr_Format(PyExc_TypeError, "Unsupported type '%s'.",
					meta_type_py->tp_name);
			return NULL;
		}
	}

	srd_dbg("Instance %s creating new output type %d for %s.",
		di->inst_id, output_type, proto_id);

	pdo = g_malloc(sizeof(struct srd_pd_output));

	/* pdo_id is just a simple index, nothing is deleted from this list anyway. */
	pdo->pdo_id = g_slist_length(di->pd_output);
	pdo->output_type = output_type;
	pdo->di = di;
	pdo->proto_id = g_strdup(proto_id);

	if (output_type == SRD_OUTPUT_META) {
		pdo->meta_type = meta_type_gv;
		pdo->meta_name = g_strdup(meta_name);
		pdo->meta_descr = g_strdup(meta_descr);
	}

	di->pd_output = g_slist_append(di->pd_output, pdo);
	py_new_output_id = Py_BuildValue("i", pdo->pdo_id);

	return py_new_output_id;
}

static PyMethodDef Decoder_methods[] = {
	{"put", Decoder_put, METH_VARARGS,
	 "Accepts a dictionary with the following keys: startsample, endsample, data"},
	{"register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
			"Register a new output stream"},
	{NULL, NULL, 0, NULL}
};

/** @cond PRIVATE */
SRD_PRIV PyTypeObject srd_Decoder_type = {
	PyVarObject_HEAD_INIT(NULL, 0)
	.tp_name = "sigrokdecode.Decoder",
	.tp_basicsize = sizeof(srd_Decoder),
	.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
	.tp_doc = "sigrok Decoder base class",
	.tp_methods = Decoder_methods,
};
/** @endcond */
Commit	Line	Data
d0a0ed03	1	/*
50bd5d25	2	* This file is part of the libsigrokdecode project.
d0a0ed03 BV	3	*
	4	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
f6c7eade MC	20	#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
f6c7eade MC	21	#include "libsigrokdecode.h"
d0a0ed03	22	#include "config.h"
dbeaab27	23	#include <inttypes.h>
d0a0ed03	24
17475b09 UH	25	typedef struct {
	26	PyObject_HEAD
	27	} srd_Decoder;
	28
58572aed	29	/* This is only used for nicer srd_dbg() output. */
abeeed8b	30	static const char *OUTPUT_TYPES[] = {
58572aed	31	"OUTPUT_ANN",
f2a5df42	32	"OUTPUT_PYTHON",
58572aed	33	"OUTPUT_BINARY",
7ee0c40b	34	"OUTPUT_META",
58572aed BV	35	};
58572aed BV	36
4f75f1c1	37	static int convert_annotation(struct srd_decoder_inst di, PyObject obj,
0b922460	38	struct srd_proto_data *pdata)
d0a0ed03 BV	39	{
	40	PyObject *py_tmp;
	41	struct srd_pd_output *pdo;
0b922460	42	struct srd_proto_data_annotation *pda;
280d554c	43	int ann_class;
0b922460	44	char **ann_text;
d0a0ed03	45
280d554c	46	/* Should be a list of [annotation class, [string, ...]]. */
d0a0ed03	47	if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
d906d3f9	48	srd_err("Protocol decoder %s submitted %s instead of list.",
c9bfccc6	49	di->decoder->name, obj->ob_type->tp_name);
d0a0ed03 BV	50	return SRD_ERR_PYTHON;
	51	}
	52
361fdcaa	53	/* Should have 2 elements. */
d0a0ed03	54	if (PyList_Size(obj) != 2) {
c9bfccc6 UH	55	srd_err("Protocol decoder %s submitted annotation list with "
	56	"%d elements instead of 2", di->decoder->name,
	57	PyList_Size(obj));
d0a0ed03 BV	58	return SRD_ERR_PYTHON;
	59	}
	60
c9bfccc6 UH	61	/*
c9bfccc6 UH	62	* The first element should be an integer matching a previously
280d554c	63	* registered annotation class.
c9bfccc6	64	*/
d0a0ed03 BV	65	py_tmp = PyList_GetItem(obj, 0);
d0a0ed03 BV	66	if (!PyLong_Check(py_tmp)) {
c9bfccc6 UH	67	srd_err("Protocol decoder %s submitted annotation list, but "
c9bfccc6 UH	68	"first element was not an integer.", di->decoder->name);
d0a0ed03 BV	69	return SRD_ERR_PYTHON;
d0a0ed03 BV	70	}
280d554c UH	71	ann_class = PyLong_AsLong(py_tmp);
280d554c UH	72	if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
d906d3f9	73	srd_err("Protocol decoder %s submitted data to unregistered "
280d554c	74	"annotation class %d.", di->decoder->name, ann_class);
d0a0ed03 BV	75	return SRD_ERR_PYTHON;
d0a0ed03 BV	76	}
d0a0ed03	77
361fdcaa	78	/* Second element must be a list. */
d0a0ed03 BV	79	py_tmp = PyList_GetItem(obj, 1);
d0a0ed03 BV	80	if (!PyList_Check(py_tmp)) {
d906d3f9	81	srd_err("Protocol decoder %s submitted annotation list, but "
c9bfccc6	82	"second element was not a list.", di->decoder->name);
d0a0ed03 BV	83	return SRD_ERR_PYTHON;
d0a0ed03 BV	84	}
62a2b15c	85	if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
d906d3f9	86	srd_err("Protocol decoder %s submitted annotation list, but "
c9bfccc6	87	"second element was malformed.", di->decoder->name);
d0a0ed03 BV	88	return SRD_ERR_PYTHON;
	89	}
	90
077fa8ac	91	pda = g_malloc(sizeof(struct srd_proto_data_annotation));
280d554c	92	pda->ann_class = ann_class;
0b922460 BV	93	pda->ann_text = ann_text;
	94	pdata->data = pda;
	95
d0a0ed03 BV	96	return SRD_OK;
	97	}
	98
d75d8a7c BV	99	static int convert_binary(struct srd_decoder_inst di, PyObject obj,
	100	struct srd_proto_data *pdata)
	101	{
	102	struct srd_proto_data_binary *pdb;
	103	PyObject *py_tmp;
	104	Py_ssize_t size;
	105	int bin_class;
	106	char class_name, buf;
	107
	108	/* Should be a tuple of (binary class, bytes). */
	109	if (!PyTuple_Check(obj)) {
	110	srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
	111	"%s instead of tuple.", di->decoder->name,
	112	obj->ob_type->tp_name);
	113	return SRD_ERR_PYTHON;
	114	}
	115
	116	/* Should have 2 elements. */
	117	if (PyTuple_Size(obj) != 2) {
	118	srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple "
	119	"with %d elements instead of 2", di->decoder->name,
	120	PyList_Size(obj));
	121	return SRD_ERR_PYTHON;
	122	}
	123
	124	/* The first element should be an integer. */
	125	py_tmp = PyTuple_GetItem(obj, 0);
	126	if (!PyLong_Check(py_tmp)) {
	127	srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple, "
	128	"but first element was not an integer.", di->decoder->name);
	129	return SRD_ERR_PYTHON;
	130	}
	131	bin_class = PyLong_AsLong(py_tmp);
	132	if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
	133	srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
	134	"unregistered binary class %d.", di->decoder->name, bin_class);
	135	return SRD_ERR_PYTHON;
	136	}
	137
	138	/* Second element should be bytes. */
	139	py_tmp = PyTuple_GetItem(obj, 1);
	140	if (!PyBytes_Check(py_tmp)) {
	141	srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple, "
	142	"but second element was not bytes.", di->decoder->name);
	143	return SRD_ERR_PYTHON;
	144	}
	145
	146	/* Consider an empty set of bytes a bug. */
	147	if (PyBytes_Size(py_tmp) == 0) {
	148	srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
	149	"with empty data set.", di->decoder->name);
	150	return SRD_ERR_PYTHON;
	151	}
	152
077fa8ac	153	pdb = g_malloc(sizeof(struct srd_proto_data_binary));
d75d8a7c BV	154	if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
	155	return SRD_ERR_PYTHON;
	156	pdb->bin_class = bin_class;
	157	pdb->size = size;
	158	if (!(pdb->data = g_try_malloc(pdb->size)))
	159	return SRD_ERR_MALLOC;
	160	memcpy((void )pdb->data, (const void )buf, pdb->size);
	161	pdata->data = pdb;
	162
	163	return SRD_OK;
	164	}
	165
7ee0c40b BV	166	static int convert_meta(struct srd_proto_data pdata, PyObject obj)
	167	{
	168	long long intvalue;
	169	double dvalue;
	170
	171	if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) {
	172	if (!PyLong_Check(obj)) {
	173	PyErr_Format(PyExc_TypeError, "This output was registered "
	174	"as 'int', but '%s' was passed.", obj->ob_type->tp_name);
	175	return SRD_ERR_PYTHON;
	176	}
	177	intvalue = PyLong_AsLongLong(obj);
	178	if (PyErr_Occurred())
	179	return SRD_ERR_PYTHON;
	180	pdata->data = g_variant_new_int64(intvalue);
	181	} else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) {
	182	if (!PyFloat_Check(obj)) {
	183	PyErr_Format(PyExc_TypeError, "This output was registered "
	184	"as 'float', but '%s' was passed.", obj->ob_type->tp_name);
	185	return SRD_ERR_PYTHON;
	186	}
	187	dvalue = PyFloat_AsDouble(obj);
	188	if (PyErr_Occurred())
	189	return SRD_ERR_PYTHON;
	190	pdata->data = g_variant_new_double(dvalue);
	191	}
	192
	193	return SRD_OK;
	194	}
	195
d0a0ed03 BV	196	static PyObject Decoder_put(PyObject self, PyObject *args)
	197	{
	198	GSList *l;
4f75f1c1	199	PyObject py_data, py_res;
a8b72b05	200	struct srd_decoder_inst di, next_di;
d0a0ed03 BV	201	struct srd_pd_output *pdo;
	202	struct srd_proto_data *pdata;
	203	uint64_t start_sample, end_sample;
	204	int output_id;
2994587f	205	struct srd_pd_callback *cb;
d0a0ed03	206
a8b72b05	207	if (!(di = srd_inst_find_by_obj(NULL, self))) {
58572aed	208	/* Shouldn't happen. */
7a1712c4	209	srd_dbg("put(): self instance not found.");
d0a0ed03	210	return NULL;
58572aed	211	}
d0a0ed03	212
c9bfccc6	213	if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
3d14e7c9	214	&output_id, &py_data)) {
c9bfccc6 UH	215	/*
	216	* This throws an exception, but by returning NULL here we let
	217	* Python raise it. This results in a much better trace in
	218	* controller.c on the decode() method call.
	219	*/
d0a0ed03	220	return NULL;
c9bfccc6	221	}
d0a0ed03 BV	222
d0a0ed03 BV	223	if (!(l = g_slist_nth(di->pd_output, output_id))) {
d906d3f9	224	srd_err("Protocol decoder %s submitted invalid output ID %d.",
c9bfccc6	225	di->decoder->name, output_id);
d0a0ed03 BV	226	return NULL;
	227	}
	228	pdo = l->data;
	229
1c2b0d0b	230	srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
a8b72b05	231	di->inst_id, start_sample, end_sample,
1c2b0d0b	232	OUTPUT_TYPES[pdo->output_type], output_id);
58572aed	233
077fa8ac	234	pdata = g_malloc0(sizeof(struct srd_proto_data));
d0a0ed03 BV	235	pdata->start_sample = start_sample;
	236	pdata->end_sample = end_sample;
	237	pdata->pdo = pdo;
	238
	239	switch (pdo->output_type) {
	240	case SRD_OUTPUT_ANN:
	241	/* Annotations are only fed to callbacks. */
32cfb920	242	if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
d75d8a7c	243	/* Convert from PyDict to srd_proto_data_annotation. */
0b922460	244	if (convert_annotation(di, py_data, pdata) != SRD_OK) {
d0a0ed03 BV	245	/* An error was already logged. */
	246	break;
	247	}
2994587f	248	cb->cb(pdata, cb->cb_data);
d0a0ed03 BV	249	}
d0a0ed03 BV	250	break;
f2a5df42	251	case SRD_OUTPUT_PYTHON:
d0a0ed03 BV	252	for (l = di->next_di; l; l = l->next) {
d0a0ed03 BV	253	next_di = l->data;
7a1712c4	254	srd_spew("Sending %d-%d to instance %s",
3d14e7c9	255	start_sample, end_sample, next_di->inst_id);
c9bfccc6	256	if (!(py_res = PyObject_CallMethod(
3d14e7c9 BV	257	next_di->py_inst, "decode", "KKO", start_sample,
3d14e7c9 BV	258	end_sample, py_data))) {
aafeeaea	259	srd_exception_catch("Calling %s decode(): ",
3d14e7c9	260	next_di->inst_id);
d0a0ed03 BV	261	}
	262	Py_XDECREF(py_res);
	263	}
3d14e7c9 BV	264	if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
	265	/* Frontends aren't really supposed to get Python
	266	* callbacks, but it's useful for testing. */
	267	pdata->data = py_data;
	268	cb->cb(pdata, cb->cb_data);
	269	}
d0a0ed03 BV	270	break;
d0a0ed03 BV	271	case SRD_OUTPUT_BINARY:
d75d8a7c BV	272	if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
	273	/* Convert from PyDict to srd_proto_data_binary. */
	274	if (convert_binary(di, py_data, pdata) != SRD_OK) {
	275	/* An error was already logged. */
	276	break;
	277	}
	278	cb->cb(pdata, cb->cb_data);
	279	}
d0a0ed03	280	break;
7ee0c40b BV	281	case SRD_OUTPUT_META:
	282	if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
	283	/* Annotations need converting from PyObject. */
	284	if (convert_meta(pdata, py_data) != SRD_OK) {
	285	/* An exception was already set up. */
	286	break;
	287	}
	288	cb->cb(pdata, cb->cb_data);
	289	}
	290	break;
d0a0ed03	291	default:
d906d3f9	292	srd_err("Protocol decoder %s submitted invalid output type %d.",
c9bfccc6	293	di->decoder->name, pdo->output_type);
d0a0ed03 BV	294	break;
	295	}
	296
	297	g_free(pdata);
	298
	299	Py_RETURN_NONE;
	300	}
	301
7ee0c40b BV	302	static PyObject Decoder_register(PyObject self, PyObject *args,
7ee0c40b BV	303	PyObject *kwargs)
d0a0ed03	304	{
a8b72b05	305	struct srd_decoder_inst *di;
7ee0c40b BV	306	struct srd_pd_output *pdo;
	307	PyObject *py_new_output_id;
	308	PyTypeObject *meta_type_py;
	309	const GVariantType *meta_type_gv;
	310	int output_type;
	311	char proto_id, meta_name, *meta_descr;
	312	char *keywords[] = {"output_type", "proto_id", "meta", NULL};
	313
	314	meta_type_py = NULL;
	315	meta_type_gv = NULL;
	316	meta_name = meta_descr = NULL;
d0a0ed03	317
a8b72b05	318	if (!(di = srd_inst_find_by_obj(NULL, self))) {
d0a0ed03 BV	319	PyErr_SetString(PyExc_Exception, "decoder instance not found");
	320	return NULL;
	321	}
	322
7ee0c40b BV	323	/* Default to instance id, which defaults to class id. */
	324	proto_id = di->inst_id;
	325	if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i\|s(Oss)", keywords,
	326	&output_type, &proto_id,
	327	&meta_type_py, &meta_name, &meta_descr)) {
511e2123	328	/* Let Python raise this exception. */
d0a0ed03 BV	329	return NULL;
	330	}
	331
7ee0c40b BV	332	/* Check if the meta value's type is supported. */
	333	if (output_type == SRD_OUTPUT_META) {
	334	if (meta_type_py == &PyLong_Type)
	335	meta_type_gv = G_VARIANT_TYPE_INT64;
	336	else if (meta_type_py == &PyFloat_Type)
	337	meta_type_gv = G_VARIANT_TYPE_DOUBLE;
	338	else {
	339	PyErr_Format(PyExc_TypeError, "Unsupported type '%s'.",
	340	meta_type_py->tp_name);
	341	return NULL;
	342	}
	343	}
	344
	345	srd_dbg("Instance %s creating new output type %d for %s.",
	346	di->inst_id, output_type, proto_id);
	347
077fa8ac	348	pdo = g_malloc(sizeof(struct srd_pd_output));
7ee0c40b BV	349
	350	/* pdo_id is just a simple index, nothing is deleted from this list anyway. */
	351	pdo->pdo_id = g_slist_length(di->pd_output);
	352	pdo->output_type = output_type;
	353	pdo->di = di;
	354	pdo->proto_id = g_strdup(proto_id);
	355
	356	if (output_type == SRD_OUTPUT_META) {
	357	pdo->meta_type = meta_type_gv;
	358	pdo->meta_name = g_strdup(meta_name);
	359	pdo->meta_descr = g_strdup(meta_descr);
	360	}
	361
	362	di->pd_output = g_slist_append(di->pd_output, pdo);
	363	py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
	364
	365	return py_new_output_id;
	366	}
	367
d0a0ed03 BV	368	static PyMethodDef Decoder_methods[] = {
d0a0ed03 BV	369	{"put", Decoder_put, METH_VARARGS,
86528298	370	"Accepts a dictionary with the following keys: startsample, endsample, data"},
7ee0c40b BV	371	{"register", (PyCFunction)Decoder_register, METH_VARARGS\|METH_KEYWORDS,
7ee0c40b BV	372	"Register a new output stream"},
d0a0ed03 BV	373	{NULL, NULL, 0, NULL}
	374	};
	375
57790bc8	376	/** @cond PRIVATE */
55c3c5f4	377	SRD_PRIV PyTypeObject srd_Decoder_type = {
d0a0ed03 BV	378	PyVarObject_HEAD_INIT(NULL, 0)
	379	.tp_name = "sigrokdecode.Decoder",
	380	.tp_basicsize = sizeof(srd_Decoder),
	381	.tp_flags = Py_TPFLAGS_DEFAULT \| Py_TPFLAGS_BASETYPE,
361fdcaa	382	.tp_doc = "sigrok Decoder base class",
d0a0ed03 BV	383	.tp_methods = Decoder_methods,
d0a0ed03 BV	384	};
57790bc8	385	/** @endcond */