[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.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include "libsigrokdecode-internal.h"
#include "config.h"
#include <inttypes.h>

/* 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_format;
	char **ann_text;

	/* Should be a list of [annotation format, [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 format.
	 */
	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_format = PyLong_AsLong(py_tmp);
	if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_format))) {
		srd_err("Protocol decoder %s submitted data to unregistered "
			"annotation format %d.", di->decoder->name, ann_format);
		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;
	}

	if (!(pda = g_try_malloc(sizeof(struct srd_proto_data_annotation))))
		return SRD_ERR_MALLOC;
	pda->ann_format = ann_format;
	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;
	}

	if (!(pdb = g_try_malloc(sizeof(struct srd_proto_data_binary))))
		return SRD_ERR_MALLOC;
	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);

	if (!(pdata = g_try_malloc0(sizeof(struct srd_proto_data)))) {
		srd_err("Failed to g_malloc() struct srd_proto_data.");
		return NULL;
	}
	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);

	if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
		PyErr_SetString(PyExc_MemoryError, "struct srd_pd_output");
		return NULL;
	}

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