[libsigrokdecode.git] / libsigrokdecode.h.in

/*
 * This file is part of the libsigrokdecode 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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
#define LIBSIGROKDECODE_SIGROKDECODE_H

#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include <stdint.h>
#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

struct srd_session;

/**
 * @file
 *
 * The public libsigrokdecode header file to be used by frontends.
 *
 * This is the only file that libsigrokdecode users (frontends) are supposed
 * to use and include. There are other header files which get installed with
 * libsigrokdecode, but those are not meant to be used directly by frontends.
 *
 * The correct way to get/use the libsigrokdecode API functions is:
 *
 * @code{.c}
 *   #include <libsigrokdecode/libsigrokdecode.h>
 * @endcode
 */

/*
 * Package version macros (can be used for conditional compilation).
 */

/** The libsigrokdecode package 'major' version number. */
#define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@

/** The libsigrokdecode package 'minor' version number. */
#define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@

/** The libsigrokdecode package 'micro' version number. */
#define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@

/** The libsigrokdecode package version ("major.minor.micro") as string. */
#define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"

/*
 * Library/libtool version macros (can be used for conditional compilation).
 */

/** The libsigrokdecode libtool 'current' version number. */
#define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@

/** The libsigrokdecode libtool 'revision' version number. */
#define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@

/** The libsigrokdecode libtool 'age' version number. */
#define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@

/** The libsigrokdecode libtool version ("current:revision:age") as string. */
#define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"

/*
 * All possible return codes of libsigrokdecode functions must be listed here.
 * Functions should never return hardcoded numbers as status, but rather
 * use these enum values. All error codes are negative numbers.
 *
 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
 * libsigrokdecode functions returns a "malloc error" it must be exactly the
 * same return value as used by all other functions to indicate "malloc error".
 * There must be no functions which indicate two different errors via the
 * same return code.
 *
 * Also, for compatibility reasons, no defined return codes are ever removed
 * or reused for different errors later. You can only add new entries and
 * return codes, but never remove or redefine existing ones.
 */

/** Status/error codes returned by libsigrokdecode functions. */
enum {
	SRD_OK               =  0, /**< No error */
	SRD_ERR              = -1, /**< Generic/unspecified error */
	SRD_ERR_MALLOC       = -2, /**< Malloc/calloc/realloc error */
	SRD_ERR_ARG          = -3, /**< Function argument error */
	SRD_ERR_BUG          = -4, /**< Errors hinting at internal bugs */
	SRD_ERR_PYTHON       = -5, /**< Python C API error */
	SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */

	/*
	 * Note: When adding entries here, don't forget to also update the
	 * srd_strerror() and srd_strerror_name() functions in error.c.
	 */
};

/* libsigrokdecode loglevels. */
enum {
	SRD_LOG_NONE = 0, /**< Output no messages at all. */
	SRD_LOG_ERR  = 1, /**< Output error messages. */
	SRD_LOG_WARN = 2, /**< Output warnings. */
	SRD_LOG_INFO = 3, /**< Output informational messages. */
	SRD_LOG_DBG  = 4, /**< Output debug messages. */
	SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
};

/*
 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
 *
 * Variables and functions marked 'static' are private already and don't
 * need SRD_PRIV. However, functions which are not static (because they need
 * to be used in other libsigrokdecode-internal files) but are also not
 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
 *
 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 *
 * This feature is not available on MinGW/Windows, as it is a feature of
 * ELF files and MinGW/Windows uses PE files.
 *
 * Details: http://gcc.gnu.org/wiki/Visibility
 */

/* Marks public libsigrokdecode API symbols. */
#ifndef _WIN32
#define SRD_API __attribute__((visibility("default")))
#else
#define SRD_API
#endif

/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
#ifndef _WIN32
#define SRD_PRIV __attribute__((visibility("hidden")))
#else
#define SRD_PRIV
#endif

/*
 * When adding an output type, don't forget to...
 *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
 *   - add a check in module_sigrokdecode.c:Decoder_put()
 *   - add a debug string in type_decoder.c:OUTPUT_TYPES
 */
enum {
	SRD_OUTPUT_ANN,
	SRD_OUTPUT_PYTHON,
	SRD_OUTPUT_BINARY,
	SRD_OUTPUT_META,
};

#define SRD_MAX_NUM_PROBES 64

enum {
	SRD_CONF_SAMPLERATE = 10000,
};

struct srd_decoder {
	/** The decoder ID. Must be non-NULL and unique for all decoders. */
	char *id;

	/** The (short) decoder name. Must be non-NULL. */
	char *name;

	/** The (long) decoder name. Must be non-NULL. */
	char *longname;

	/** A (short, one-line) description of the decoder. Must be non-NULL. */
	char *desc;

	/**
	 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
	 * Other values are currently not allowed. Must be non-NULL.
	 */
	char *license;

	/** List of probes required by this decoder. */
	GSList *probes;

	/** List of optional probes for this decoder. */
	GSList *opt_probes;

	/**
	 * List of NULL-terminated char[], containing descriptions of the
	 * supported annotation output.
	 */
	GSList *annotations;

	/** List of decoder options.  */
	GSList *options;

	/** Python module. */
	PyObject *py_mod;

	/** sigrokdecode.Decoder class. */
	PyObject *py_dec;
};

/**
 * Structure which contains information about one protocol decoder probe.
 * For example, I2C has two probes, SDA and SCL.
 */
struct srd_probe {
	/** The ID of the probe. Must be non-NULL. */
	char *id;
	/** The name of the probe. Must not be NULL. */
	char *name;
	/** The description of the probe. Must not be NULL. */
	char *desc;
	/** The index of the probe, i.e. its order in the list of probes. */
	int order;
};

struct srd_decoder_option {
	char *id;
	char *desc;
	GVariant *def;
};

struct srd_decoder_inst {
	struct srd_decoder *decoder;
	struct srd_session *sess;
	PyObject *py_inst;
	char *inst_id;
	GSList *pd_output;
	int dec_num_probes;
	int *dec_probemap;
	int data_unitsize;
	GSList *next_di;
};

struct srd_pd_output {
	int pdo_id;
	int output_type;
	struct srd_decoder_inst *di;
	char *proto_id;
	/* Only used for OUTPUT_META. */
	const GVariantType *meta_type;
	char *meta_name;
	char *meta_descr;
};

struct srd_proto_data {
	uint64_t start_sample;
	uint64_t end_sample;
	struct srd_pd_output *pdo;
	void *data;
};
struct srd_proto_data_annotation {
	int ann_format;
	char **ann_text;
};

typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
					 void *cb_data);

struct srd_pd_callback {
	int output_type;
	srd_pd_output_callback_t cb;
	void *cb_data;
};

/* Custom Python types: */

typedef struct {
	PyObject_HEAD
} srd_Decoder;

typedef struct {
	PyObject_HEAD
	struct srd_decoder_inst *di;
	uint64_t start_samplenum;
	unsigned int itercnt;
	uint8_t *inbuf;
	uint64_t inbuflen;
	PyObject *sample;
} srd_logic;

/*--- controller.c ----------------------------------------------------------*/

SRD_API int srd_init(const char *path);
SRD_API int srd_exit(void);
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
		GHashTable *options);
SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
		GHashTable *probes);
SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
		const char *id, GHashTable *options);
SRD_API int srd_inst_stack(struct srd_session *sess,
		struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
		const char *inst_id);
SRD_API int srd_session_new(struct srd_session **sess);
SRD_API int srd_session_start(struct srd_session *sess);
SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
		GVariant *data);
SRD_API int srd_session_send(struct srd_session *sess,
		uint64_t start_samplenum, uint64_t end_samplenum,
		const uint8_t *inbuf, uint64_t inbuflen);
SRD_API int srd_session_destroy(struct srd_session *sess);
SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
		int output_type, srd_pd_output_callback_t cb, void *cb_data);

/*--- decoder.c -------------------------------------------------------------*/

SRD_API const GSList *srd_decoder_list(void);
SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
SRD_API int srd_decoder_load(const char *name);
SRD_API int srd_decoder_unload(struct srd_decoder *dec);
SRD_API int srd_decoder_load_all(void);
SRD_API int srd_decoder_unload_all(void);
SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);

/*--- log.c -----------------------------------------------------------------*/

typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
				  const char *format, va_list args);

SRD_API int srd_log_loglevel_set(int loglevel);
SRD_API int srd_log_loglevel_get(void);
SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
SRD_API int srd_log_callback_set_default(void);
SRD_API int srd_log_logdomain_set(const char *logdomain);
SRD_API char *srd_log_logdomain_get(void);

/*--- version.c -------------------------------------------------------------*/

SRD_API int srd_package_version_major_get(void);
SRD_API int srd_package_version_minor_get(void);
SRD_API int srd_package_version_micro_get(void);
SRD_API const char *srd_package_version_string_get(void);

SRD_API int srd_lib_version_current_get(void);
SRD_API int srd_lib_version_revision_get(void);
SRD_API int srd_lib_version_age_get(void);
SRD_API const char *srd_lib_version_string_get(void);

/*--- error.c ---------------------------------------------------------------*/

SRD_API const char *srd_strerror(int error_code);
SRD_API const char *srd_strerror_name(int error_code);

#ifdef __cplusplus
}
#endif

#endif
Commit	Line	Data
1c6fa20f	1	/*
50bd5d25	2	* This file is part of the libsigrokdecode project.
1c6fa20f UH	3	*
1c6fa20f UH	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
bc5f5a43	5	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
1c6fa20f UH	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	20	*/
	21
3b5839d5 UH	22	#ifndef LIBSIGROKDECODE_SIGROKDECODE_H
3b5839d5 UH	23	#define LIBSIGROKDECODE_SIGROKDECODE_H
1c6fa20f UH	24
	25	#include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
	26	#include <stdint.h>
5c55017c	27	#include <glib.h>
1c6fa20f	28
253f9603 UH	29	#ifdef __cplusplus
	30	extern "C" {
	31	#endif
	32
32cfb920 BV	33	struct srd_session;
32cfb920 BV	34
54fdeeef UH	35	/**
	36	* @file
	37	*
	38	* The public libsigrokdecode header file to be used by frontends.
	39	*
	40	* This is the only file that libsigrokdecode users (frontends) are supposed
	41	* to use and include. There are other header files which get installed with
	42	* libsigrokdecode, but those are not meant to be used directly by frontends.
	43	*
	44	* The correct way to get/use the libsigrokdecode API functions is:
	45	*
	46	* @code{.c}
c1f86f02	47	* #include <libsigrokdecode/libsigrokdecode.h>
54fdeeef UH	48	* @endcode
	49	*/
	50
03a66522 UH	51	/*
	52	* Package version macros (can be used for conditional compilation).
	53	*/
	54
	55	/** The libsigrokdecode package 'major' version number. */
14b42dad	56	#define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
03a66522 UH	57
03a66522 UH	58	/** The libsigrokdecode package 'minor' version number. */
14b42dad	59	#define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
03a66522 UH	60
03a66522 UH	61	/** The libsigrokdecode package 'micro' version number. */
14b42dad	62	#define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
03a66522 UH	63
03a66522 UH	64	/** The libsigrokdecode package version ("major.minor.micro") as string. */
14b42dad	65	#define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
03a66522 UH	66
	67	/*
	68	* Library/libtool version macros (can be used for conditional compilation).
	69	*/
	70
	71	/** The libsigrokdecode libtool 'current' version number. */
14b42dad	72	#define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
03a66522 UH	73
03a66522 UH	74	/** The libsigrokdecode libtool 'revision' version number. */
14b42dad	75	#define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
03a66522 UH	76
03a66522 UH	77	/** The libsigrokdecode libtool 'age' version number. */
14b42dad	78	#define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
03a66522 UH	79
03a66522 UH	80	/** The libsigrokdecode libtool version ("current:revision:age") as string. */
14b42dad	81	#define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
03a66522	82
a4898be7	83	/*
a4898be7 UH	84	* All possible return codes of libsigrokdecode functions must be listed here.
a4898be7 UH	85	* Functions should never return hardcoded numbers as status, but rather
47dfa77d	86	* use these enum values. All error codes are negative numbers.
a4898be7 UH	87	*
	88	* The error codes are globally unique in libsigrokdecode, i.e. if one of the
	89	* libsigrokdecode functions returns a "malloc error" it must be exactly the
	90	* same return value as used by all other functions to indicate "malloc error".
	91	* There must be no functions which indicate two different errors via the
	92	* same return code.
	93	*
	94	* Also, for compatibility reasons, no defined return codes are ever removed
47dfa77d	95	* or reused for different errors later. You can only add new entries and
a4898be7 UH	96	* return codes, but never remove or redefine existing ones.
a4898be7 UH	97	*/
47dfa77d UH	98
	99	/** Status/error codes returned by libsigrokdecode functions. */
	100	enum {
	101	SRD_OK = 0, /*< No error /
	102	SRD_ERR = -1, /*< Generic/unspecified error /
	103	SRD_ERR_MALLOC = -2, /*< Malloc/calloc/realloc error /
	104	SRD_ERR_ARG = -3, /*< Function argument error /
	105	SRD_ERR_BUG = -4, /*< Errors hinting at internal bugs /
	106	SRD_ERR_PYTHON = -5, /*< Python C API error /
	107	SRD_ERR_DECODERS_DIR = -6, /*< Protocol decoder path invalid /
	108
	109	/*
	110	* Note: When adding entries here, don't forget to also update the
	111	* srd_strerror() and srd_strerror_name() functions in error.c.
	112	*/
	113	};
7c24d086	114
43c0a640	115	/* libsigrokdecode loglevels. */
47dfa77d UH	116	enum {
	117	SRD_LOG_NONE = 0, /*< Output no messages at all. /
	118	SRD_LOG_ERR = 1, /*< Output error messages. /
	119	SRD_LOG_WARN = 2, /*< Output warnings. /
	120	SRD_LOG_INFO = 3, /*< Output informational messages. /
	121	SRD_LOG_DBG = 4, /*< Output debug messages. /
	122	SRD_LOG_SPEW = 5, /*< Output very noisy debug messages. /
	123	};
43c0a640	124
55c3c5f4 UH	125	/*
	126	* Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
	127	*
	128	* Variables and functions marked 'static' are private already and don't
d523eae6	129	* need SRD_PRIV. However, functions which are not static (because they need
55c3c5f4 UH	130	* to be used in other libsigrokdecode-internal files) but are also not
	131	* meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
	132	*
	133	* This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
	134	*
a4cb05f7 UH	135	* This feature is not available on MinGW/Windows, as it is a feature of
	136	* ELF files and MinGW/Windows uses PE files.
	137	*
55c3c5f4 UH	138	* Details: http://gcc.gnu.org/wiki/Visibility
	139	*/
	140
	141	/* Marks public libsigrokdecode API symbols. */
a4cb05f7	142	#ifndef _WIN32
55c3c5f4	143	#define SRD_API __attribute__((visibility("default")))
a4cb05f7 UH	144	#else
	145	#define SRD_API
	146	#endif
55c3c5f4 UH	147
55c3c5f4 UH	148	/* Marks private, non-public libsigrokdecode symbols (not part of the API). */
a4cb05f7	149	#ifndef _WIN32
55c3c5f4	150	#define SRD_PRIV __attribute__((visibility("hidden")))
a4cb05f7 UH	151	#else
	152	#define SRD_PRIV
	153	#endif
55c3c5f4	154
c9bfccc6 UH	155	/*
	156	* When adding an output type, don't forget to...
	157	* - expose it to PDs in controller.c:PyInit_sigrokdecode()
	158	* - add a check in module_sigrokdecode.c:Decoder_put()
	159	* - add a debug string in type_decoder.c:OUTPUT_TYPES
	160	*/
e5080882	161	enum {
94d43b37	162	SRD_OUTPUT_ANN,
f2a5df42	163	SRD_OUTPUT_PYTHON,
15969949	164	SRD_OUTPUT_BINARY,
7ee0c40b	165	SRD_OUTPUT_META,
e5080882 BV	166	};
e5080882 BV	167
a61ece20	168	#define SRD_MAX_NUM_PROBES 64
bc5f5a43	169
32cfb920	170	enum {
ed416497	171	SRD_CONF_SAMPLERATE = 10000,
32cfb920 BV	172	};
32cfb920 BV	173
d752b12b	174	struct srd_decoder {
775dda7a	175	/** The decoder ID. Must be non-NULL and unique for all decoders. */
31b82285	176	char *id;
775dda7a	177
361fdcaa	178	/** The (short) decoder name. Must be non-NULL. */
31b82285	179	char *name;
775dda7a	180
122e9a90	181	/** The (long) decoder name. Must be non-NULL. */
75a282e5	182	char *longname;
775dda7a	183
361fdcaa	184	/** A (short, one-line) description of the decoder. Must be non-NULL. */
5c55017c	185	char *desc;
775dda7a	186
361fdcaa UH	187	/**
	188	* The license of the decoder. Valid values: "gplv2+", "gplv3+".
	189	* Other values are currently not allowed. Must be non-NULL.
	190	*/
75a282e5 UH	191	char *license;
75a282e5 UH	192
361fdcaa	193	/** List of probes required by this decoder. */
f38ec285 BV	194	GSList *probes;
f38ec285 BV	195
361fdcaa	196	/** List of optional probes for this decoder. */
dcdf4883	197	GSList *opt_probes;
f38ec285	198
361fdcaa	199	/**
c9bfccc6	200	* List of NULL-terminated char[], containing descriptions of the
15969949 BV	201	* supported annotation output.
15969949 BV	202	*/
e97b6ef5	203	GSList *annotations;
15969949	204
2f395bff BV	205	/** List of decoder options. */
	206	GSList *options;
	207
361fdcaa	208	/** Python module. */
b2c19614 BV	209	PyObject *py_mod;
b2c19614 BV	210
361fdcaa	211	/** sigrokdecode.Decoder class. */
451680f1	212	PyObject *py_dec;
74911b4c GM	213	};
74911b4c GM	214
361fdcaa UH	215	/**
	216	* Structure which contains information about one protocol decoder probe.
	217	* For example, I2C has two probes, SDA and SCL.
	218	*/
f38ec285	219	struct srd_probe {
361fdcaa	220	/** The ID of the probe. Must be non-NULL. */
f38ec285	221	char *id;
361fdcaa	222	/** The name of the probe. Must not be NULL. */
f38ec285	223	char *name;
361fdcaa	224	/** The description of the probe. Must not be NULL. */
f38ec285	225	char *desc;
361fdcaa	226	/** The index of the probe, i.e. its order in the list of probes. */
f38ec285 BV	227	int order;
	228	};
	229
2f395bff BV	230	struct srd_decoder_option {
	231	char *id;
	232	char *desc;
	233	GVariant *def;
	234	};
	235
a8b72b05	236	struct srd_decoder_inst {
b2c19614	237	struct srd_decoder *decoder;
32cfb920	238	struct srd_session *sess;
a8b72b05 BV	239	PyObject *py_inst;
a8b72b05 BV	240	char *inst_id;
b2c19614	241	GSList *pd_output;
f38ec285 BV	242	int dec_num_probes;
f38ec285 BV	243	int *dec_probemap;
f38ec285	244	int data_unitsize;
7ce7775c	245	GSList *next_di;
31b82285	246	};
31b82285	247
e5080882 BV	248	struct srd_pd_output {
	249	int pdo_id;
	250	int output_type;
a8b72b05	251	struct srd_decoder_inst *di;
94d43b37	252	char *proto_id;
7ee0c40b BV	253	/* Only used for OUTPUT_META. */
	254	const GVariantType *meta_type;
	255	char *meta_name;
	256	char *meta_descr;
e5080882 BV	257	};
e5080882 BV	258
94d43b37	259	struct srd_proto_data {
15969949 BV	260	uint64_t start_sample;
	261	uint64_t end_sample;
	262	struct srd_pd_output *pdo;
983cb0f5	263	void *data;
15969949	264	};
0b922460 BV	265	struct srd_proto_data_annotation {
	266	int ann_format;
	267	char **ann_text;
	268	};
15969949	269
ae53d0a5	270	typedef void (srd_pd_output_callback_t)(struct srd_proto_data pdata,
41a5d962	271	void *cb_data);
ae53d0a5	272
983cb0f5 BV	273	struct srd_pd_callback {
983cb0f5 BV	274	int output_type;
4c1d0670	275	srd_pd_output_callback_t cb;
41a5d962	276	void *cb_data;
983cb0f5	277	};
bc5f5a43	278
361fdcaa UH	279	/* Custom Python types: */
361fdcaa UH	280
f8e45857 BV	281	typedef struct {
	282	PyObject_HEAD
	283	} srd_Decoder;
43c0a640	284
f8e45857 BV	285	typedef struct {
f8e45857 BV	286	PyObject_HEAD
a8b72b05	287	struct srd_decoder_inst *di;
86528298	288	uint64_t start_samplenum;
f8e45857 BV	289	unsigned int itercnt;
	290	uint8_t *inbuf;
	291	uint64_t inbuflen;
	292	PyObject *sample;
	293	} srd_logic;
	294
f8e45857	295	/--- controller.c ----------------------------------------------------------/
c9bfccc6	296
abeeed8b	297	SRD_API int srd_init(const char *path);
55c3c5f4	298	SRD_API int srd_exit(void);
b33b8aa5	299	SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
0ff2d191	300	GHashTable *options);
b33b8aa5	301	SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
0ff2d191	302	GHashTable *probes);
32cfb920 BV	303	SRD_API struct srd_decoder_inst srd_inst_new(struct srd_session sess,
	304	const char id, GHashTable options);
	305	SRD_API int srd_inst_stack(struct srd_session *sess,
	306	struct srd_decoder_inst di_from, struct srd_decoder_inst di_to);
	307	SRD_API struct srd_decoder_inst srd_inst_find_by_id(struct srd_session sess,
	308	const char *inst_id);
	309	SRD_API int srd_session_new(struct srd_session **sess);
	310	SRD_API int srd_session_start(struct srd_session *sess);
ed416497	311	SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
32cfb920 BV	312	GVariant *data);
32cfb920 BV	313	SRD_API int srd_session_send(struct srd_session *sess,
ed416497 BV	314	uint64_t start_samplenum, uint64_t end_samplenum,
ed416497 BV	315	const uint8_t *inbuf, uint64_t inbuflen);
32cfb920 BV	316	SRD_API int srd_session_destroy(struct srd_session *sess);
	317	SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
	318	int output_type, srd_pd_output_callback_t cb, void *cb_data);
b2c19614	319
43c0a640	320	/--- decoder.c -------------------------------------------------------------/
c9bfccc6	321
38ff5046	322	SRD_API const GSList *srd_decoder_list(void);
9d122fd5 BV	323	SRD_API struct srd_decoder srd_decoder_get_by_id(const char id);
	324	SRD_API int srd_decoder_load(const char *name);
	325	SRD_API int srd_decoder_unload(struct srd_decoder *dec);
8ad6e500 UH	326	SRD_API int srd_decoder_load_all(void);
8ad6e500 UH	327	SRD_API int srd_decoder_unload_all(void);
b33b8aa5	328	SRD_API char srd_decoder_doc_get(const struct srd_decoder dec);
b2c19614	329
43c0a640	330	/--- log.c -----------------------------------------------------------------/
c9bfccc6	331
0082d592 UH	332	typedef int (srd_log_callback_t)(void cb_data, int loglevel,
0082d592 UH	333	const char *format, va_list args);
c9bfccc6	334
55c3c5f4 UH	335	SRD_API int srd_log_loglevel_set(int loglevel);
55c3c5f4 UH	336	SRD_API int srd_log_loglevel_get(void);
0082d592 UH	337	SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
0082d592 UH	338	SRD_API int srd_log_callback_set_default(void);
55c3c5f4 UH	339	SRD_API int srd_log_logdomain_set(const char *logdomain);
55c3c5f4 UH	340	SRD_API char *srd_log_logdomain_get(void);
1c6fa20f	341
0c081c63 UH	342	/--- version.c -------------------------------------------------------------/
	343
	344	SRD_API int srd_package_version_major_get(void);
	345	SRD_API int srd_package_version_minor_get(void);
	346	SRD_API int srd_package_version_micro_get(void);
	347	SRD_API const char *srd_package_version_string_get(void);
	348
	349	SRD_API int srd_lib_version_current_get(void);
	350	SRD_API int srd_lib_version_revision_get(void);
	351	SRD_API int srd_lib_version_age_get(void);
	352	SRD_API const char *srd_lib_version_string_get(void);
	353
cdf156ba UH	354	/--- error.c ---------------------------------------------------------------/
	355
	356	SRD_API const char *srd_strerror(int error_code);
	357	SRD_API const char *srd_strerror_name(int error_code);
	358
253f9603 UH	359	#ifdef __cplusplus
	360	}
	361	#endif
	362
1c6fa20f	363	#endif