srd: Finish consistency rename to ANN/PROTO.

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index d58aea271cc0f299dbe4553b9418255868768f5b..a4b5c2cd43b0a6b4aafec72a6a2748e518c94501 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -50,9 +50,10 @@ extern "C" {
 #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_ARG               -3 /**< Function argument error */
-#define SRD_ERR_PYTHON        -4 /**< Python C API error */
-#define SRD_ERR_DECODERS_DIR  -5 /**< Protocol decoder path invalid */
+#define SRD_ERR_ARG           -3 /**< Function argument error */
+#define SRD_ERR_BUG           -4 /**< Errors hinting at internal bugs */
+#define SRD_ERR_PYTHON        -5 /**< Python C API error */
+#define SRD_ERR_DECODERS_DIR  -6 /**< Protocol decoder path invalid */
 
 /* libsigrokdecode loglevels. */
 #define SRD_LOG_NONE   0 /**< Output no messages at all. */
@@ -63,9 +64,14 @@ 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()
+        * and add a check in:
+        *     module_sigrokdecode.c:Decoder_put()
+        */
 };
 
 #define SRD_MAX_NUM_PROBES   64
@@ -90,9 +96,6 @@ struct srd_decoder {
        /** 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;
 
@@ -120,17 +123,19 @@ struct srd_decoder {
 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;
+       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 {
@@ -142,14 +147,18 @@ typedef struct {
        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_type;
-       unsigned char **data;
+       int ann_format;
+       void *data;
 };
 
+struct srd_pd_callback {
+       int output_type;
+       void (*callback)(struct srd_proto_data *);
+};
 
 
 /*--- controller.c ----------------------------------------------------------*/
@@ -157,17 +166,24 @@ struct srd_protocol_data {
 int srd_init(void);
 int srd_exit(void);
 int set_modulepath(void);
-struct srd_decoder_instance *srd_instance_new(const char *id);
+struct srd_decoder_instance *srd_instance_new(const char *id,
+               const char *instance_id);
+int srd_instance_stack(struct srd_decoder_instance *di_from,
+               struct srd_decoder_instance *di_to);
 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,
+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 timeoffset, uint64_t duration,
                struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
+int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
 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,
+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 -------------------------------------------------------------*/