X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h;h=dfddb1383aaddfcac9ee4e452aa192de9ab62ec4;hp=85845c94e565cb1dbcb529f845b331f169325a56;hb=ec871a279893cfe0ab378eddc0a9f9bcccc44925;hpb=983cb0f5b49167328864d0878148a7407becd1c0

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 85845c9..dfddb13 100644
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -64,8 +64,8 @@ extern "C" {
 #define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
 
 enum {
-	SRD_OUTPUT_ANNOTATION,
-	SRD_OUTPUT_PROTOCOL,
+	SRD_OUTPUT_ANN,
+	SRD_OUTPUT_PROTO,
 	SRD_OUTPUT_BINARY,
 	/* When adding an output type, don't forget to expose it to PDs in:
 	 *     controller.c:PyInit_sigrokdecode()
@@ -90,112 +90,132 @@ struct srd_decoder {
 	/** 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;
 
+	/** Probes */
+	GSList *probes;
+
+	/** Optional probes */
+	GSList *extra_probes;
+
 	/* List of NULL-terminated char[], containing descriptions of the
 	 * supported annotation output.
 	 */
-	GSList *annotation;
+	GSList *annotations;
 
-	/** TODO */
+	/** Python module */
 	PyObject *py_mod;
 
-	/** Python object that performs the decoding */
-	PyObject *py_decobj;
+	/** sigrokdecode.Decoder class */
+	PyObject *py_dec;
+};
+
+struct srd_probe {
+	char *id;
+	char *name;
+	char *desc;
+	int order;
 };
 
 struct srd_decoder_instance {
 	struct srd_decoder *decoder;
 	PyObject *py_instance;
+	char *instance_id;
 	GSList *pd_output;
-	int num_probes;
-	int unitsize;
-	uint64_t samplerate;
+	int dec_num_probes;
+	int *dec_probemap;
+	int data_num_probes;
+	int data_unitsize;
+	uint64_t data_samplerate;
+	GSList *next_di;
 };
 
 struct srd_pd_output {
 	int pdo_id;
 	int output_type;
 	struct srd_decoder *decoder;
-	char *protocol_id;
+	char *proto_id;
 };
 
-typedef struct {
-	PyObject_HEAD
-	struct srd_decoder_instance *di;
-	unsigned int itercnt;
-	uint8_t *inbuf;
-	uint64_t inbuflen;
-	PyObject *sample;
-} srd_logic;
-
-struct srd_protocol_data {
+struct srd_proto_data {
 	uint64_t start_sample;
 	uint64_t end_sample;
 	struct srd_pd_output *pdo;
-	int annotation_format;
+	int ann_format;
 	void *data;
 };
 
 struct srd_pd_callback {
 	int output_type;
-	void (*callback)(struct srd_protocol_data *);
+	void (*callback)(struct srd_proto_data *);
 };
 
 
-/*--- controller.c ----------------------------------------------------------*/
+/* custom python types */
+typedef struct {
+	PyObject_HEAD
+} srd_Decoder;
+
+typedef struct {
+	PyObject_HEAD
+	struct srd_decoder_instance *di;
+	uint64_t start_samplenum;
+	unsigned int itercnt;
+	uint8_t *inbuf;
+	uint64_t inbuflen;
+	PyObject *sample;
+} srd_logic;
 
+
+/*--- controller.c ----------------------------------------------------------*/
 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_session_start(int num_probes, int unitsize, uint64_t samplerate);
-int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
+int srd_instance_set_options(struct srd_decoder_instance *di,
+		GHashTable *options);
+int srd_instance_set_probes(struct srd_decoder_instance *di,
+		GHashTable *probes);
+struct srd_decoder_instance *srd_instance_new(const char *id,
+		GHashTable *options);
+int srd_instance_stack(struct srd_decoder_instance *di_from,
+		struct srd_decoder_instance *di_to);
+struct srd_decoder_instance *srd_instance_find(char *instance_id);
+int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
+int srd_instance_decode(uint64_t start_samplenum,
 		struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
-int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
-		uint64_t inbuflen);
-int pd_output_new(struct srd_decoder_instance *di, int output_type,
-		char *output_id);
+int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
+int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen);
+int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id);
 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
 int srd_register_callback(int output_type, void *cb);
 void *srd_find_callback(int output_type);
 
 /*--- 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);
+char *srd_decoder_doc(struct srd_decoder *dec);
+
+/*--- exception.c -----------------------------------------------------------*/
+void catch_exception(const char *format, ...);
 
 /*--- util.c ----------------------------------------------------------------*/
-int h_str(PyObject *py_res, const char *key, char **outstr);
+int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
+int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
+int py_str_as_str(PyObject *py_str, char **outstr);
 int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
 
 /*--- log.c -----------------------------------------------------------------*/
-
 int srd_set_loglevel(int loglevel);
 int srd_get_loglevel(void);