X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=5afb90c3280113b63a11172a2a3df113bfe3d7e3;hp=4876b5bd7f8c1480ccc344f0cb3fe01319240e26;hb=6efe1e1106bd648705f6f704ed2f267c86035dac;hpb=253f9603f8d022b2a948be0f2f572f5281f1b4e6

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 4876b5b..5afb90c 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -46,33 +46,84 @@ extern "C" {
  * 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 */
-#define SIGROKDECODE_ERR_ARGS		-3 /* Function argument error */
-#define SIGROKDECODE_ERR_PYTHON		-4 /* Python C API error */
-#define SIGROKDECODE_ERR_DECODERS_DIR	-5 /* Protocol decoder path invalid */
+#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 sigrokdecode_decoder {
+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;
-	PyObject *py_func;
+
+	/** Python object that performs the decoding */
+	PyObject *py_decobj;
+};
+
+struct srd_decoder_instance {
+	struct srd_decoder *decoder;
+	PyObject *py_instance;
+	GSList *pd_output;
 };
 
-int sigrokdecode_init(void);
-GSList *sigrokdecode_list_decoders(void);
-int sigrokdecode_load_decoder(const char *name, struct sigrokdecode_decoder **dec);
-int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec,
-			     uint8_t *inbuf, uint64_t inbuflen,
-			     uint8_t **outbuf, uint64_t *outbuflen);
-int sigrokdecode_shutdown(void);
+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
 }