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 0 upon success, non-zero 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. */
39 "sys.path.append('libsigrokdecode/scripts');"
40 "sys.path.append('../libsigrokdecode/scripts');"
41 "sys.path.append('/usr/local/share/sigrok');"
48 * Helper function to handle Python strings.
50 * TODO: @param entries.
52 * @return 0 upon success, non-zero otherwise. The 'outstr' argument will
53 * point to a malloc()ed string upon success.
55 static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod,
56 const char *key, char **outstr)
61 py_str = PyMapping_GetItemString(py_res, (char *)key);
62 if (!py_str || !PyString_Check(py_str)) {
67 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
70 if (!(str = PyString_AsString(py_str))) {
76 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
79 if (!(*outstr = strdup(str))) {
85 return SIGROKDECODE_ERR_MALLOC;
97 * @return 0 upon success, non-zero otherwise.
99 int sigrokdecode_load_decoder(const char *name,
100 struct sigrokdecode_decoder **dec)
102 struct sigrokdecode_decoder *d;
103 PyObject *py_name, *py_mod, *py_func, *py_res /* , *py_tuple */;
106 /* Get the name of the decoder module as Python string. */
107 if (!(py_name = PyString_FromString(name))) {
109 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
112 /* "Import" the Python module. */
113 if (!(py_mod = PyImport_Import(py_name))) {
116 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
120 /* Get the 'register' function name as Python callable object. */
121 py_func = PyObject_GetAttrString(py_mod, "register");
122 if (!py_func || !PyCallable_Check(py_func)) {
123 if (PyErr_Occurred())
126 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
129 /* Call the 'register' function without arguments, get the result. */
130 if (!(py_res = PyObject_CallFunction(py_func, NULL))) {
134 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
137 if (!(d = malloc(sizeof(struct sigrokdecode_decoder))))
138 return SIGROKDECODE_ERR_MALLOC;
140 if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0)
143 if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0)
146 if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0)
154 /* Get the 'decode' function name as Python callable object. */
155 py_func = PyObject_GetAttrString(py_mod, "decode");
156 if (!py_func || !PyCallable_Check(py_func)) {
157 if (PyErr_Occurred())
160 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
163 d->py_func = py_func;
165 /* TODO: Handle inputformats, outputformats. */
173 * Run the specified decoder function.
177 * @param inbuflen TODO
179 * @param outbuflen TODO
180 * @return 0 upon success, non-zero otherwise.
182 int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
183 uint8_t *inbuf, uint64_t inbuflen,
184 uint8_t **outbuf, uint64_t *outbuflen)
186 PyObject *py_mod, *py_func, *py_args, *py_value, *py_res;
189 /* TODO: Use #defines for the return codes. */
191 /* Return an error upon unusable input. */
193 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
195 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
196 if (inbuflen == 0) /* No point in working on empty buffers. */
197 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
199 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
200 if (outbuflen == NULL)
201 return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */
203 /* TODO: Error handling. */
204 py_mod = dec->py_mod;
205 py_func = dec->py_func;
207 /* TODO: Really run Py_DECREF on py_mod/py_func? */
209 /* Create a Python tuple of size 1. */
210 if (!(py_args = PyTuple_New(1))) {
214 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
217 /* Get the input buffer as Python "string" (byte array). */
218 /* TODO: int vs. uint64_t for 'inbuflen'? */
219 if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) {
224 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
227 if (PyTuple_SetItem(py_args, 0, py_value) != 0) {
233 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
236 if (!(py_res = PyObject_CallObject(py_func, py_args))) {
242 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
245 if ((ret = PyObject_AsCharBuffer(py_res, (const char **)outbuf,
246 (Py_ssize_t *)outbuflen))) {
253 return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */
257 // Py_DECREF(py_value);
266 * Shutdown libsigrokdecode.
268 * @return 0 upon success, non-zero otherwise.
270 int sigrokdecode_shutdown(void)
272 /* Py_Finalize() returns void, any finalization errors are ignored. */