rgb_led_ws281x: emit annotations for individual colour components
[libsigrokdecode/gsi.git] / libsigrokdecode-internal.h
blob0e3cb64231c3af30431056293fc6b60cf28288dd
1 /*
2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
22 #define LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
24 /* Use the stable ABI subset as per PEP 384. */
25 #define Py_LIMITED_API 0x03020000
27 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
28 #include "libsigrokdecode.h"
31 * Static definition of tables ending with an all-zero sentinel entry
32 * may raise warnings when compiling with -Wmissing-field-initializers.
33 * GCC suppresses the warning only with { 0 }, clang wants { } instead.
35 #ifdef __clang__
36 # define ALL_ZERO { }
37 #else
38 # define ALL_ZERO { 0 }
39 #endif
41 enum {
42 SRD_TERM_ALWAYS_FALSE,
43 SRD_TERM_HIGH,
44 SRD_TERM_LOW,
45 SRD_TERM_RISING_EDGE,
46 SRD_TERM_FALLING_EDGE,
47 SRD_TERM_EITHER_EDGE,
48 SRD_TERM_NO_EDGE,
49 SRD_TERM_SKIP,
52 struct srd_term {
53 int type;
54 int channel;
55 uint64_t num_samples_to_skip;
56 uint64_t num_samples_already_skipped;
59 /* Custom Python types: */
61 typedef struct {
62 PyObject_HEAD
63 struct srd_decoder_inst *di;
64 uint64_t abs_start_samplenum;
65 unsigned int itercnt;
66 uint8_t *inbuf;
67 uint64_t inbuflen;
68 PyObject *sample;
69 } srd_logic;
71 struct srd_session {
72 int session_id;
74 /* List of decoder instances. */
75 GSList *di_list;
77 /* List of frontend callbacks to receive decoder output. */
78 GSList *callbacks;
81 /* srd.c */
82 SRD_PRIV int srd_decoder_searchpath_add(const char *path);
84 /* session.c */
85 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(struct srd_session *sess,
86 int output_type);
88 /* instance.c */
89 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di);
90 SRD_PRIV void match_array_free(struct srd_decoder_inst *di);
91 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di);
92 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
93 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
94 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
95 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match);
96 SRD_PRIV int srd_inst_flush(struct srd_decoder_inst *di);
97 SRD_PRIV int srd_inst_send_eof(struct srd_decoder_inst *di);
98 SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di);
99 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di);
100 SRD_PRIV void srd_inst_free_all(struct srd_session *sess);
102 /* log.c */
103 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
105 * On MinGW, we need to specify the gnu_printf format flavor or GCC
106 * will assume non-standard Microsoft printf syntax.
108 SRD_PRIV int srd_log(int loglevel, const char *format, ...)
109 __attribute__((__format__ (__gnu_printf__, 2, 3)));
110 #else
111 SRD_PRIV int srd_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3);
112 #endif
114 #define srd_spew(...) srd_log(SRD_LOG_SPEW, __VA_ARGS__)
115 #define srd_dbg(...) srd_log(SRD_LOG_DBG, __VA_ARGS__)
116 #define srd_info(...) srd_log(SRD_LOG_INFO, __VA_ARGS__)
117 #define srd_warn(...) srd_log(SRD_LOG_WARN, __VA_ARGS__)
118 #define srd_err(...) srd_log(SRD_LOG_ERR, __VA_ARGS__)
120 /* decoder.c */
121 SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d);
123 /* type_decoder.c */
124 SRD_PRIV PyObject *srd_Decoder_type_new(void);
125 SRD_PRIV const char *output_type_name(unsigned int idx);
127 /* type_logic.c */
128 SRD_PRIV PyObject *srd_logic_type_new(void);
130 /* module_sigrokdecode.c */
131 PyMODINIT_FUNC PyInit_sigrokdecode(void);
133 /* util.c */
134 SRD_PRIV PyObject *py_import_by_name(const char *name);
135 SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr);
136 SRD_PRIV int py_attr_as_strlist(PyObject *py_obj, const char *attr, GSList **outstrlist);
137 SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr);
138 SRD_PRIV int py_listitem_as_str(PyObject *py_obj, Py_ssize_t idx, char **outstr);
139 SRD_PRIV int py_pydictitem_as_str(PyObject *py_obj, PyObject *py_key, char **outstr);
140 SRD_PRIV int py_pydictitem_as_long(PyObject *py_obj, PyObject *py_key, int64_t *out);
141 SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr);
142 SRD_PRIV int py_strseq_to_char(PyObject *py_strseq, char ***out_strv);
143 SRD_PRIV GVariant *py_obj_to_variant(PyObject *py_obj);
145 /* exception.c */
146 #if defined(G_OS_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
148 * On MinGW, we need to specify the gnu_printf format flavor or GCC
149 * will assume non-standard Microsoft printf syntax.
151 SRD_PRIV void srd_exception_catch(const char *format, ...)
152 __attribute__((__format__ (__gnu_printf__, 1, 2)));
153 #else
154 SRD_PRIV void srd_exception_catch(const char *format, ...) G_GNUC_PRINTF(1, 2);
155 #endif
157 #endif