#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()
/** 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;
-
/** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
char *license;
- /** TODO */
- char *func;
-
/** TODO */
GSList *inputformats;
/* 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_decoder_instance {
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;
+ 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);
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);
/*--- 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_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);