srd: change output_new() API call to add()

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index d58aea271cc0f299dbe4553b9418255868768f5b..14739698f91189935db782a4d5775395d7bddbbe 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. */
@@ -66,6 +67,11 @@ enum {
        SRD_OUTPUT_ANNOTATION,
        SRD_OUTPUT_PROTOCOL,
        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
@@ -146,10 +152,14 @@ struct srd_protocol_data {
        uint64_t start_sample;
        uint64_t end_sample;
        struct srd_pd_output *pdo;
-       int annotation_type;
-       unsigned char **data;
+       int annotation_format;
+       void *data;
 };
 
+struct srd_pd_callback {
+       int output_type;
+       void (*callback)(struct srd_protocol_data *);
+};
 
 
 /*--- controller.c ----------------------------------------------------------*/
@@ -165,9 +175,11 @@ int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
                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,
+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 -------------------------------------------------------------*/