2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
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 2 of the License, or
9 * (at your option) any later version.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
26 * Initialize libsigrokdecode.
28 * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise.
30 int sigrokdecode_init(void)
32 /* Py_Initialize() returns void and usually cannot fail. */
35 /* Add some more search directories for convenience. */
36 /* FIXME: Check error code. */
37 /* FIXME: What happens if this function is called multiple times? */
40 "sys.path.append('libsigrokdecode/scripts');"
41 "sys.path.append('../libsigrokdecode/scripts');"
42 "sys.path.append('/usr/local/share/sigrok');"
45 return SIGROKDECODE_OK;
49 * Helper function to handle Python strings.
51 * TODO: @param entries.
53 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
54 * The 'outstr' argument points to a malloc()ed string upon success.
56 static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
57 const char *key, char **outstr)
62 py_str = PyMapping_GetItemString(py_res, (char *)key);
63 if (!py_str || !PyString_Check(py_str)) {
68 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
71 if (!(str = PyString_AsString(py_str))) {
77 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
80 if (!(*outstr = strdup(str))) {
86 return SIGROKDECODE_ERR_MALLOC;
91 return SIGROKDECODE_OK;
99 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
101 int sigrokdecode_load_decoder(const char *name,
102 struct sigrokdecode_decoder **dec)
104 struct sigrokdecode_decoder *d;
105 PyObject *py_name, *py_mod, *py_func, *py_res /* , *py_tuple */;
108 /* Get the name of the decoder module as Python string. */
109 if (!(py_name = PyString_FromString(name))) {
111 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
114 /* "Import" the Python module. */
115 if (!(py_mod = PyImport_Import(py_name))) {
118 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
122 /* Get the 'register' function name as Python callable object. */
123 py_func = PyObject_GetAttrString(py_mod, "register");
124 if (!py_func || !PyCallable_Check(py_func)) {
125 if (PyErr_Occurred())
128 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
131 /* Call the 'register' function without arguments, get the result. */
132 if (!(py_res = PyObject_CallFunction(py_func, NULL))) {
136 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
139 if (!(d = malloc(sizeof(struct sigrokdecode_decoder))))
140 return SIGROKDECODE_ERR_MALLOC;
142 if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0)
145 if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
148 if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
156 /* Get the 'decode' function name as Python callable object. */
157 py_func = PyObject_GetAttrString(py_mod, "decode");
158 if (!py_func || !PyCallable_Check(py_func)) {
159 if (PyErr_Occurred())
162 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
165 d->py_func = py_func;
167 /* TODO: Handle inputformats, outputformats. */
171 return SIGROKDECODE_OK;
175 * Run the specified decoder function.
179 * @param inbuflen TODO
181 * @param outbuflen TODO
183 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
185 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
186 uint8_t *inbuf, uint64_t inbuflen,
187 uint8_t **outbuf, uint64_t *outbuflen)
189 PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
192 /* TODO: Use #defines for the return codes. */
194 /* Return an error upon unusable input. */
196 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
198 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
199 if (inbuflen == 0) /* No point in working on empty buffers. */
200 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
202 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
203 if (outbuflen == NULL)
204 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
206 /* TODO: Error handling. */
207 py_mod = dec->py_mod;
208 py_func = dec->py_func;
210 /* TODO: Really run Py_DECREF on py_mod/py_func? */
212 /* Create a Python tuple of size 1. */
213 if (!(py_args = PyTuple_New(1))) {
217 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
220 /* Get the input buffer as Python "string" (byte array). */
221 /* TODO: int vs. uint64_t for 'inbuflen'? */
222 if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) {
227 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
230 if (PyTuple_SetItem(py_args, 0, py_value) != 0) {
236 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
239 if (!(py_res = PyObject_CallObject(py_func, py_args))) {
245 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
248 if ((ret = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
249 (Py_ssize_t *)outbuflen))) {
256 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
260 // Py_DECREF(py_value);
265 return SIGROKDECODE_OK;
269 * Shutdown libsigrokdecode.
271 * @return LIBSIGROKDECODE_OK upon success, a (negative) error code otherwise.
273 int sigrokdecode_shutdown(void)
275 /* Py_Finalize() returns void, any finalization errors are ignored. */
278 return SIGROKDECODE_OK;