* Then, it searches for sigrok protocol decoder files (*.py) in the
* "decoders" subdirectory of the the sigrok installation directory.
* All decoders that are found are loaded into memory and added to an
- * internal list of decoders, which can be queried via srd_list_decoders().
+ * internal list of decoders, which can be queried via srd_decoders_list().
*
* The caller is responsible for calling the clean-up function srd_exit(),
* which will properly shut down libsigrokdecode and free its allocated memory.
* Multiple calls to srd_init(), without calling srd_exit() in between,
* are not allowed.
*
+ * @param path Path to an extra directory containing protocol decoders
+ * which will be added to the python sys.path, or NULL.
+ *
* @return SRD_OK upon success, a (negative) error code otherwise.
* Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
* directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
* If not enough memory could be allocated, return SRD_ERR_MALLOC.
*/
-SRD_API int srd_init(void)
+SRD_API int srd_init(char *path)
{
int ret;
+ char *env_path;
srd_dbg("Initializing libsigrokdecode.");
/* Initialize the Python interpreter. */
Py_Initialize();
- if ((ret = set_modulepath()) != SRD_OK) {
+ /* Installed decoders. */
+ if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) {
Py_Finalize();
return ret;
}
- if ((ret = srd_load_all_decoders()) != SRD_OK) {
- Py_Finalize();
- return ret;
+ /* Path specified by the user. */
+ if (path) {
+ if ((ret = add_modulepath(path)) != SRD_OK) {
+ Py_Finalize();
+ return ret;
+ }
+ }
+
+ /* Environment variable overrides everything, for debugging. */
+ if ((env_path = getenv("SIGROKDECODE_DIR"))) {
+ if ((ret = add_modulepath(env_path)) != SRD_OK) {
+ Py_Finalize();
+ return ret;
+ }
}
return SRD_OK;
{
srd_dbg("Exiting libsigrokdecode.");
- srd_unload_all_decoders();
+ srd_decoders_unload_all();
g_slist_free(pd_list);
/* Py_Finalize() returns void, any finalization errors are ignored. */
* Python modules which have the same name as a sigrok protocol decoder in
* sys.path or in the current working directory.
*
- * TODO: add path from env var SIGROKDECODE_PATH, config etc
- * TODO: Should take directoryname/path as input.
+ * @param path Path to an extra directory containing protocol decoders
+ * which will be added to the python sys.path, or NULL.
*
- * @return TODO.
+ * @return SRD_OK upon success, a (negative) error code otherwise.
*/
-SRD_API int set_modulepath(void)
+SRD_PRIV int add_modulepath(const char *path)
{
- int ret;
- gchar *path, *s;
-
-#ifdef _WIN32
- gchar **splitted;
-
- /*
- * On Windows/MinGW, Python's sys.path needs entries of the form
- * 'C:\\foo\\bar' instead of '/foo/bar'.
- */
-
- splitted = g_strsplit(DECODERS_DIR, "/", 0);
- path = g_build_pathv("\\\\", splitted);
- g_strfreev(splitted);
-#else
- path = g_strdup(DECODERS_DIR);
-#endif
-
- /* TODO: Sanity check on 'path' (length, escape special chars, ...). */
- s = g_strdup_printf("import sys; sys.path.insert(0, r'%s')", path);
-
- ret = PyRun_SimpleString(s);
-
- g_free(path);
- g_free(s);
+ PyObject *py_cur_path, *py_item;
+ GString *new_path;
+ int wc_len, i;
+ wchar_t *wc_new_path;
+ char *item;
+
+ srd_dbg("adding %s to module path", path);
+
+ new_path = g_string_sized_new(256);
+ g_string_assign(new_path, g_strdup(path));
+ py_cur_path = PySys_GetObject("path");
+ for (i = 0; i < PyList_Size(py_cur_path); i++) {
+ g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S));
+ py_item = PyList_GetItem(py_cur_path, i);
+ if (!PyUnicode_Check(py_item))
+ /* Shouldn't happen. */
+ continue;
+ if (py_str_as_str(py_item, &item) != SRD_OK)
+ continue;
+ g_string_append(new_path, item);
+ }
+
+ /* Convert to wide chars. */
+ wc_len = sizeof(wchar_t) * (new_path->len + 1);
+ if (!(wc_new_path = g_try_malloc(wc_len))) {
+ srd_dbg("malloc failed");
+ return SRD_ERR_MALLOC;
+ }
+ mbstowcs(wc_new_path, new_path->str, wc_len);
+ PySys_SetPath(wc_new_path);
+ g_string_free(new_path, TRUE);
+ g_free(wc_new_path);
+
+//#ifdef _WIN32
+// gchar **splitted;
+//
+// /*
+// * On Windows/MinGW, Python's sys.path needs entries of the form
+// * 'C:\\foo\\bar' instead of '/foo/bar'.
+// */
+//
+// splitted = g_strsplit(DECODERS_DIR, "/", 0);
+// path = g_build_pathv("\\\\", splitted);
+// g_strfreev(splitted);
+//#else
+// path = g_strdup(DECODERS_DIR);
+//#endif
- return ret;
+ return SRD_OK;
}
/**
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-SRD_API int srd_inst_set_options(struct srd_decoder_inst *di,
+SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
GHashTable *options)
{
PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
return ret;
}
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_set_probes() */
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */
static gint compare_probe_id(struct srd_probe *a, char *probe_id)
{
return strcmp(a->id, probe_id);
* @param probes A GHashTable of probes to set. Key is probe name, value is
* the probe number. Samples passed to this instance will be
* arranged in this order.
+ *
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di,
+SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
GHashTable *new_probes)
{
GList *l;
* @param id Decoder 'id' field.
* @param options GHashtable of options which override the defaults set in
* the decoder class.
+ *
* @return Pointer to a newly allocated struct srd_decoder_inst, or
* NULL in case of failure.
*/
srd_dbg("Creating new %s instance.", decoder_id);
- if (!(dec = srd_get_decoder_by_id(decoder_id))) {
+ if (!(dec = srd_decoder_get_by_id(decoder_id))) {
srd_err("Protocol decoder %s not found.", decoder_id);
return NULL;
}
return NULL;
}
- if (srd_inst_set_options(di, options) != SRD_OK) {
+ if (srd_inst_options_set(di, options) != SRD_OK) {
g_free(di->dec_probemap);
g_free(di);
return NULL;
return di;
}
+/**
+ * Stack a decoder instance on top of another.
+ *
+ * @param di_from The instance to move.
+ * @param di_to The instance on top of which di_from will be stacked.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
struct srd_decoder_inst *di_to)
{
}
/**
- * Finds a decoder instance by its instance id, but only in the bottom
+ * Finds a decoder instance by its instance ID, but only in the bottom
* level of instances -- instances already stacked on top of another one
* will not be found.
*
- * @param inst_id The instance id to be found.
+ * @param inst_id The instance ID to be found.
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
*/
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
*/
-SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
+SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
PyObject *obj)
{
GSList *l;
return di;
}
-SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
+SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
{
PyObject *py_name, *py_res;
GSList *l;
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-SRD_API int srd_inst_decode(uint64_t start_samplenum,
+SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
struct srd_decoder_inst *di,
uint8_t *inbuf, uint64_t inbuflen)
{
return SRD_OK;
}
-SRD_API void srd_inst_free(struct srd_decoder_inst *di)
+SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
{
GSList *l;
struct srd_pd_output *pdo;
g_slist_free(di->pd_output);
}
-SRD_API void srd_inst_free_all(GSList *stack)
+SRD_PRIV void srd_inst_free_all(GSList *stack)
{
GSList *l;
struct srd_decoder_inst *di;
}
}
+/**
+ * Start a decoding session.
+ *
+ * Decoders, instances and stack must have been prepared beforehand.
+ *
+ * @param num_probes The number of probes which the incoming feed will contain.
+ * @param unitsize The number of bytes per sample in the incoming feed.
+ * @param The samplerate of the incoming feed.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
{
PyObject *args;
return ret;
}
-/* Feed logic samples to decoder session. */
-SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
+/**
+ * Feed a chunk of logic sample data to a running decoder session.
+ *
+ * @param start_samplenum The sample number of the first sample in this chunk.
+ * @param inbuf Pointer to sample data.
+ * @param inbuf Length in bytes of the buffer.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
+SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
uint64_t inbuflen)
{
GSList *d;
return SRD_OK;
}
+/**
+ * Register a decoder output callback function.
+ *
+ * The function will be called when a protocol decoder sends output back
+ * to the PD controller (except for Python objects, which only go up the
+ * stack).
+ *
+ * @param output_type The output type this callback will receive. Only one
+ * callback per output type can be registered.
+ * @param cb The function to call.
+ * @param cb_data Unused.
+ */
SRD_API int srd_register_callback(int output_type,
- srd_pd_output_callback_t cb, void *user_data)
+ srd_pd_output_callback_t cb, void *cb_data)
{
struct srd_pd_callback *pd_cb;
}
pd_cb->output_type = output_type;
- pd_cb->callback = cb;
- pd_cb->user_data = user_data;
+ pd_cb->cb = cb;
+ pd_cb->cb_data = cb_data;
callbacks = g_slist_append(callbacks, pd_cb);
return SRD_OK;
}
-SRD_API void *srd_find_callback(int output_type)
+SRD_PRIV void *srd_find_callback(int output_type)
{
GSList *l;
struct srd_pd_callback *pd_cb;
for (l = callbacks; l; l = l->next) {
pd_cb = l->data;
if (pd_cb->output_type == output_type) {
- cb = pd_cb->callback;
+ cb = pd_cb->cb;
break;
}
}
projects / libsigrokdecode.git / blobdiff