Build: Reduce autogen.sh to trivial stub
[libsigrokdecode.git] / libsigrokdecode.h
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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
22 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
23 #define LIBSIGROKDECODE_LIBSIGROKDECODE_H
24
25 #include <stdint.h>
26 #include <glib.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct srd_session;
33
34 /**
35  * @file
36  *
37  * The public libsigrokdecode header file to be used by frontends.
38  *
39  * This is the only file that libsigrokdecode users (frontends) are supposed
40  * to use and include. There are other header files which get installed with
41  * libsigrokdecode, but those are not meant to be used directly by frontends.
42  *
43  * The correct way to get/use the libsigrokdecode API functions is:
44  *
45  * @code{.c}
46  *   #include <libsigrokdecode/libsigrokdecode.h>
47  * @endcode
48  */
49
50 /*
51  * All possible return codes of libsigrokdecode functions must be listed here.
52  * Functions should never return hardcoded numbers as status, but rather
53  * use these enum values. All error codes are negative numbers.
54  *
55  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
56  * libsigrokdecode functions returns a "malloc error" it must be exactly the
57  * same return value as used by all other functions to indicate "malloc error".
58  * There must be no functions which indicate two different errors via the
59  * same return code.
60  *
61  * Also, for compatibility reasons, no defined return codes are ever removed
62  * or reused for different errors later. You can only add new entries and
63  * return codes, but never remove or redefine existing ones.
64  */
65
66 /** Status/error codes returned by libsigrokdecode functions. */
67 enum srd_error_code {
68         SRD_OK               =  0, /**< No error */
69         SRD_ERR              = -1, /**< Generic/unspecified error */
70         SRD_ERR_MALLOC       = -2, /**< Malloc/calloc/realloc error */
71         SRD_ERR_ARG          = -3, /**< Function argument error */
72         SRD_ERR_BUG          = -4, /**< Errors hinting at internal bugs */
73         SRD_ERR_PYTHON       = -5, /**< Python C API error */
74         SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
75
76         /*
77          * Note: When adding entries here, don't forget to also update the
78          * srd_strerror() and srd_strerror_name() functions in error.c.
79          */
80 };
81
82 /* libsigrokdecode loglevels. */
83 enum srd_loglevel {
84         SRD_LOG_NONE = 0, /**< Output no messages at all. */
85         SRD_LOG_ERR  = 1, /**< Output error messages. */
86         SRD_LOG_WARN = 2, /**< Output warnings. */
87         SRD_LOG_INFO = 3, /**< Output informational messages. */
88         SRD_LOG_DBG  = 4, /**< Output debug messages. */
89         SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
90 };
91
92 /*
93  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
94  *
95  * Variables and functions marked 'static' are private already and don't
96  * need SRD_PRIV. However, functions which are not static (because they need
97  * to be used in other libsigrokdecode-internal files) but are also not
98  * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
99  *
100  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
101  *
102  * This feature is not available on MinGW/Windows, as it is a feature of
103  * ELF files and MinGW/Windows uses PE files.
104  *
105  * Details: http://gcc.gnu.org/wiki/Visibility
106  */
107
108 /* Marks public libsigrokdecode API symbols. */
109 #ifndef _WIN32
110 #define SRD_API __attribute__((visibility("default")))
111 #else
112 #define SRD_API
113 #endif
114
115 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
116 #ifndef _WIN32
117 #define SRD_PRIV __attribute__((visibility("hidden")))
118 #else
119 #define SRD_PRIV
120 #endif
121
122 /*
123  * When adding an output type, don't forget to...
124  *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
125  *   - add a check in module_sigrokdecode.c:Decoder_put()
126  *   - add a debug string in type_decoder.c:OUTPUT_TYPES
127  */
128 enum srd_output_type {
129         SRD_OUTPUT_ANN,
130         SRD_OUTPUT_PYTHON,
131         SRD_OUTPUT_BINARY,
132         SRD_OUTPUT_META,
133 };
134
135 enum srd_configkey {
136         SRD_CONF_SAMPLERATE = 10000,
137 };
138
139 struct srd_decoder {
140         /** The decoder ID. Must be non-NULL and unique for all decoders. */
141         char *id;
142
143         /** The (short) decoder name. Must be non-NULL. */
144         char *name;
145
146         /** The (long) decoder name. Must be non-NULL. */
147         char *longname;
148
149         /** A (short, one-line) description of the decoder. Must be non-NULL. */
150         char *desc;
151
152         /**
153          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
154          * Other values are currently not allowed. Must be non-NULL.
155          */
156         char *license;
157
158         /** List of channels required by this decoder. */
159         GSList *channels;
160
161         /** List of optional channels for this decoder. */
162         GSList *opt_channels;
163
164         /**
165          * List of NULL-terminated char[], containing descriptions of the
166          * supported annotation output.
167          */
168         GSList *annotations;
169
170         /**
171          * List of annotation rows (row items: id, description, and a list
172          * of annotation classes belonging to this row).
173          */
174         GSList *annotation_rows;
175
176         /**
177          * List of NULL-terminated char[], containing descriptions of the
178          * supported binary output.
179          */
180         GSList *binary;
181
182         /** List of decoder options. */
183         GSList *options;
184
185         /** Python module. */
186         void *py_mod;
187
188         /** sigrokdecode.Decoder class. */
189         void *py_dec;
190 };
191
192 /**
193  * Structure which contains information about one protocol decoder channel.
194  * For example, I2C has two channels, SDA and SCL.
195  */
196 struct srd_channel {
197         /** The ID of the channel. Must be non-NULL. */
198         char *id;
199         /** The name of the channel. Must not be NULL. */
200         char *name;
201         /** The description of the channel. Must not be NULL. */
202         char *desc;
203         /** The index of the channel, i.e. its order in the list of channels. */
204         int order;
205 };
206
207 struct srd_decoder_option {
208         char *id;
209         char *desc;
210         GVariant *def;
211         GSList *values;
212 };
213
214 struct srd_decoder_annotation_row {
215         char *id;
216         char *desc;
217         GSList *ann_classes;
218 };
219
220 struct srd_decoder_inst {
221         struct srd_decoder *decoder;
222         struct srd_session *sess;
223         void *py_inst;
224         char *inst_id;
225         GSList *pd_output;
226         int dec_num_channels;
227         int *dec_channelmap;
228         int data_unitsize;
229         uint8_t *channel_samples;
230         GSList *next_di;
231 };
232
233 struct srd_pd_output {
234         int pdo_id;
235         int output_type;
236         struct srd_decoder_inst *di;
237         char *proto_id;
238         /* Only used for OUTPUT_META. */
239         const GVariantType *meta_type;
240         char *meta_name;
241         char *meta_descr;
242 };
243
244 struct srd_proto_data {
245         uint64_t start_sample;
246         uint64_t end_sample;
247         struct srd_pd_output *pdo;
248         void *data;
249 };
250 struct srd_proto_data_annotation {
251         int ann_class;
252         char **ann_text;
253 };
254 struct srd_proto_data_binary {
255         int bin_class;
256         uint64_t size;
257         const unsigned char *data;
258 };
259
260 typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
261                                         void *cb_data);
262
263 struct srd_pd_callback {
264         int output_type;
265         srd_pd_output_callback cb;
266         void *cb_data;
267 };
268
269 /* srd.c */
270 SRD_API int srd_init(const char *path);
271 SRD_API int srd_exit(void);
272
273 /* session.c */
274 SRD_API int srd_session_new(struct srd_session **sess);
275 SRD_API int srd_session_start(struct srd_session *sess);
276 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
277                 GVariant *data);
278 SRD_API int srd_session_send(struct srd_session *sess,
279                 uint64_t start_samplenum, uint64_t end_samplenum,
280                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
281 SRD_API int srd_session_destroy(struct srd_session *sess);
282 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
283                 int output_type, srd_pd_output_callback cb, void *cb_data);
284
285 /* decoder.c */
286 SRD_API const GSList *srd_decoder_list(void);
287 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
288 SRD_API int srd_decoder_load(const char *name);
289 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
290 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
291 SRD_API int srd_decoder_load_all(void);
292 SRD_API int srd_decoder_unload_all(void);
293
294 /* instance.c */
295 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
296                 GHashTable *options);
297 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
298                 GHashTable *channels);
299 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
300                 const char *id, GHashTable *options);
301 SRD_API int srd_inst_stack(struct srd_session *sess,
302                 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
303 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
304                 const char *inst_id);
305
306 /* log.c */
307 typedef int (*srd_log_callback)(void *cb_data, int loglevel,
308                                   const char *format, va_list args);
309 SRD_API int srd_log_loglevel_set(int loglevel);
310 SRD_API int srd_log_loglevel_get(void);
311 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
312 SRD_API int srd_log_callback_set_default(void);
313 SRD_API int srd_log_logdomain_set(const char *logdomain);
314 SRD_API char *srd_log_logdomain_get(void);
315
316 /* error.c */
317 SRD_API const char *srd_strerror(int error_code);
318 SRD_API const char *srd_strerror_name(int error_code);
319
320 /* version.c */
321 SRD_API int srd_package_version_major_get(void);
322 SRD_API int srd_package_version_minor_get(void);
323 SRD_API int srd_package_version_micro_get(void);
324 SRD_API const char *srd_package_version_string_get(void);
325 SRD_API int srd_lib_version_current_get(void);
326 SRD_API int srd_lib_version_revision_get(void);
327 SRD_API int srd_lib_version_age_get(void);
328 SRD_API const char *srd_lib_version_string_get(void);
329
330 #include "version.h"
331
332 #ifdef __cplusplus
333 }
334 #endif
335
336 #endif