Pass multiple samples to the protocol decoder and adapt transitioncounter.py to work...

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 7805d8545de86cdf60bd99c28a9391592f1b14ee..c455acfc56c7bd00d67760909963895ddf5b7a3a 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -18,17 +18,92 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
-#define LIBSIGROKDECODE_SIGROKDECODE_H
+#ifndef SIGROKDECODE_SIGROKDECODE_H
+#define SIGROKDECODE_SIGROKDECODE_H
 
 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include <stdint.h>
+#include <glib.h>
 
-int sigrokdecode_init(void);
-int sigrokdecode_load_decoder_file(const char *name);
-int sigrokdecode_run_decoder(const char *decodername, uint8_t *inbuf,
-                            uint64_t inbuflen, uint8_t **outbuf,
-                            uint64_t *outbuflen);
-int sigrokdecode_shutdown(void);
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Status/error codes returned by libsigrokdecode functions.
+ *
+ * All possible return codes of libsigrokdecode functions must be listed here.
+ * Functions should never return hardcoded numbers as status, but rather
+ * use these #defines instead. All error codes are negative numbers.
+ *
+ * The error codes are globally unique in libsigrokdecode, i.e. if one of the
+ * libsigrokdecode functions returns a "malloc error" it must be exactly the
+ * same return value as used by all other functions to indicate "malloc error".
+ * There must be no functions which indicate two different errors via the
+ * same return code.
+ *
+ * Also, for compatibility reasons, no defined return codes are ever removed
+ * or reused for different #defines later. You can only add new #defines and
+ * return codes, but never remove or redefine existing ones.
+ */
+#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 function that performs the decoding */
+       PyObject *py_decodefunc;
+};
+
+int srd_init(void);
+GSList *srd_list_decoders(void);
+struct srd_decoder *srd_get_decoder_by_id(const char *id);
+int srd_run_decoder(struct srd_decoder *dec, uint8_t *inbuf, uint64_t inbuflen,
+                   uint8_t **outbuf, uint64_t *outbuflen);
+int srd_exit(void);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif