srd: Initialise struct members by name. Minor other fixes.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 4c30c34b7ffb9fd257538d06aecae5631b868ff0..5afb90c3280113b63a11172a2a3df113bfe3d7e3 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -23,6 +23,11 @@
 
 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include <stdint.h>
+#include <glib.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 /*
  * Status/error codes returned by libsigrokdecode functions.
@@ -41,15 +46,87 @@
  * or reused for different #defines later. You can only add new #defines and
  * return codes, but never remove or redefine existing ones.
  */
-#define SIGROKDECODE_OK                         0 /* No error */
-#define SIGROKDECODE_ERR               -1 /* Generic/unspecified error */
-#define SIGROKDECODE_ERR_MALLOC                -2 /* Malloc/calloc/realloc error */
-
-int sigrokdecode_init(void);
-int sigrokdecode_load_decoder_file(const char *name);
-int sigrokdecode_run_decoder(const char *modulename, const char *decodername,
-                            uint8_t *inbuf, uint64_t inbuflen,
-                            uint8_t **outbuf, uint64_t *outbuflen);
-int sigrokdecode_shutdown(void);
+#define SRD_OK                  0 /**< No error */
+#define SRD_ERR                        -1 /**< Generic/unspecified error */
+#define SRD_ERR_MALLOC         -2 /**< Malloc/calloc/realloc error */
+#define SRD_ERR_ARGS           -3 /**< Function argument error */
+#define SRD_ERR_PYTHON         -4 /**< Python C API error */
+#define SRD_ERR_DECODERS_DIR   -5 /**< Protocol decoder path invalid */
+
+/* TODO: Documentation. */
+struct srd_decoder {
+       /** The decoder ID. Must be non-NULL and unique for all decoders. */
+       char *id;
+
+       /** The (short) decoder name. */
+       char *name;
+
+       /** The (long) decoder name. May be NULL. */
+       char *longname;
+
+       /** A (short, one-line) description of the decoder. */
+       char *desc;
+
+       /** A (long, multi-line) description of the decoder. May be NULL. */
+       char *longdesc;
+
+       /** The author of the decoder. May be NULL. */
+       char *author;
+
+       /** An email address of the decoder's author. May be NULL. */
+       char *email;
+
+       /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
+       char *license;
+
+       /** TODO */
+       char *func;
+
+       /** TODO */
+       GSList *inputformats;
+
+       /** TODO */
+       GSList *outputformats;
+
+       /** TODO */
+       PyObject *py_mod;
+
+       /** Python object that performs the decoding */
+       PyObject *py_decobj;
+};
+
+struct srd_decoder_instance {
+       struct srd_decoder *decoder;
+       PyObject *py_instance;
+       GSList *pd_output;
+};
+
+int srd_init(void);
+int srd_exit(void);
+int set_modulepath(void);
+struct srd_decoder_instance *srd_instance_new(const char *id);
+int srd_instance_set_probe(struct srd_decoder_instance *di,
+                               const char *probename, int num);
+int srd_instance_start(struct srd_decoder_instance *di,
+                       const char *driver, int unitsize, uint64_t starttime);
+int srd_session_start(const char *driver, int unitsize, uint64_t starttime,
+               uint64_t samplerate);
+int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen);
+
+/* decoder.c */
+GSList *srd_list_decoders(void);
+struct srd_decoder *srd_get_decoder_by_id(const char *id);
+int srd_load_decoder(const char *name, struct srd_decoder **dec);
+int srd_unload_decoder(struct srd_decoder *dec);
+int srd_load_all_decoders(void);
+int srd_unload_all_decoders(void);
+
+/* util.c */
+int h_str(PyObject *py_res, PyObject *py_mod, const char *key, char **outstr);
+
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif