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

[libsigrokdecode.git] / sigrokdecode.h

diff --git a/sigrokdecode.h b/sigrokdecode.h
index 6005ad984613d7872f719ae77861ae9153091149..14739698f91189935db782a4d5775395d7bddbbe 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -2,6 +2,7 @@
  * This file is part of the sigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -46,27 +47,35 @@ 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 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_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_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. */
-#define SRD_LOG_ERR    1 /**< Output error messages. */
-#define SRD_LOG_WARN   2 /**< Output warnings. */
-#define SRD_LOG_INFO   3 /**< Output informational messages. */
-#define SRD_LOG_DBG    4 /**< Output debug messages. */
-#define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
+#define SRD_LOG_NONE   0 /**< Output no messages at all. */
+#define SRD_LOG_ERR    1 /**< Output error messages. */
+#define SRD_LOG_WARN   2 /**< Output warnings. */
+#define SRD_LOG_INFO   3 /**< Output informational messages. */
+#define SRD_LOG_DBG    4 /**< Output debug messages. */
+#define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
 
 enum {
-       SRD_OUTPUT_LOGIC = 1,
        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
+
 /* TODO: Documentation. */
 struct srd_decoder {
        /** The decoder ID. Must be non-NULL and unique for all decoders. */
@@ -102,6 +111,11 @@ struct srd_decoder {
        /** TODO */
        GSList *outputformats;
 
+       /* List of NULL-terminated char[], containing descriptions of the
+        * supported annotation output.
+        */
+       GSList *annotation;
+
        /** TODO */
        PyObject *py_mod;
 
@@ -113,15 +127,41 @@ struct srd_decoder_instance {
        struct srd_decoder *decoder;
        PyObject *py_instance;
        GSList *pd_output;
+       int num_probes;
+       int unitsize;
+       uint64_t samplerate;
 };
 
 struct srd_pd_output {
        int pdo_id;
        int output_type;
+       struct srd_decoder *decoder;
        char *protocol_id;
-       char *description;
 };
 
+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 {
+       uint64_t start_sample;
+       uint64_t end_sample;
+       struct srd_pd_output *pdo;
+       int annotation_format;
+       void *data;
+};
+
+struct srd_pd_callback {
+       int output_type;
+       void (*callback)(struct srd_protocol_data *);
+};
+
+
 /*--- controller.c ----------------------------------------------------------*/
 
 int srd_init(void);
@@ -130,16 +170,16 @@ 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_start(int num_probes, int unitsize, uint64_t samplerate);
 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,
-               char *output_id, char *description);
+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 -------------------------------------------------------------*/
 
@@ -151,8 +191,8 @@ 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);
+int h_str(PyObject *py_res, const char *key, char **outstr);
+int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
 
 /*--- log.c -----------------------------------------------------------------*/