X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=sigrokdecode.h;h=ccfb6c156e6b36dc6504e22b5ada66092aa0d7e3;hb=58d1fb8f967468abdbf58cd85e967c6d94043295;hp=228fc1f261e4a1123523ad35957b8e180cdb370f;hpb=a4898be72e8018462f02e117376625454974cd99;p=libsigrokdecode.git diff --git a/sigrokdecode.h b/sigrokdecode.h index 228fc1f..ccfb6c1 100644 --- a/sigrokdecode.h +++ b/sigrokdecode.h @@ -18,11 +18,16 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef LIBSIGROKDECODE_SIGROKDECODE_H -#define LIBSIGROKDECODE_SIGROKDECODE_H +#ifndef SIGROKDECODE_SIGROKDECODE_H +#define SIGROKDECODE_SIGROKDECODE_H #include /* First, so we avoid a _POSIX_C_SOURCE warning. */ #include +#include + +#ifdef __cplusplus +extern "C" { +#endif /* * Status/error codes returned by libsigrokdecode functions. @@ -41,15 +46,42 @@ * or reused for different #defines later. You can only add new #defines and * return codes, but never remove or redefine existing ones. */ -#define SIGROKDECODE_OK 0 /* No error */ -#define SIGROKDECODE_ERR -1 /* Generic/unspecified error */ -#define SIGROKDECODE_ERR_MALLOC -2 /* Malloc/calloc/realloc error */ - -int sigrokdecode_init(void); -int sigrokdecode_load_decoder_file(const char *name); -int sigrokdecode_run_decoder(const char *decodername, uint8_t *inbuf, - uint64_t inbuflen, uint8_t **outbuf, - uint64_t *outbuflen); -int sigrokdecode_shutdown(void); +#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_ARGS -3 /* Function argument error */ +#define SRD_ERR_PYTHON -4 /* Python C API error */ +#define SRD_ERR_DECODERS_DIR -5 /* Protocol decoder path invalid */ + +/* TODO: Documentation. */ +struct srd_decoder { + char *id; + char *name; + char *longname; + char *desc; + char *longdesc; + char *author; + char *email; + char *license; + + char *func; + + GSList *inputformats; + GSList *outputformats; + + PyObject *py_mod; + PyObject *py_func; +}; + +int srd_init(void); +GSList *srd_list_decoders(void); +struct srd_decoder *srd_get_decoder_by_id(const char *id); +int srd_run_decoder(struct srd_decoder *dec, uint8_t *inbuf, uint64_t inbuflen, + uint8_t **outbuf, uint64_t *outbuflen); +int srd_exit(void); + +#ifdef __cplusplus +} +#endif #endif