1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/* GSL Engine - Flow module operation engine
* Copyright (C) 2001 Tim Janik
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __GSL_ENGINE_H__
#define __GSL_ENGINE_H__
#include <gsl/gsldefs.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* --- constants --- */
#define GSL_STREAM_MAX_VALUES (8192 /* power of 2, <= 16384 */) /* FIXME */
#define GSL_MODULE_N_OSTREAMS(module) ((module)->klass->n_ostreams)
#define GSL_MODULE_N_ISTREAMS(module) ((module)->klass->n_istreams)
#define GSL_MODULE_N_JSTREAMS(module) ((module)->klass->n_jstreams)
#define GSL_MODULE_ISTREAM(module, stream) ((module)->istreams[(stream)])
#define GSL_MODULE_JSTREAM(module, stream) ((module)->jstreams[(stream)])
#define GSL_MODULE_OSTREAM(module, stream) ((module)->ostreams[(stream)])
#define GSL_MODULE_IBUFFER(module, stream) (GSL_MODULE_ISTREAM ((module), (stream)).values)
#define GSL_MODULE_JBUFFER(module, stream, con) (GSL_MODULE_JSTREAM ((module), (stream)).values[con])
#define GSL_MODULE_OBUFFER(module, stream) (GSL_MODULE_OSTREAM ((module), (stream)).values)
/* --- typedefs --- */
typedef gboolean (*GslPollFunc) (gpointer data,
guint n_values,
glong *timeout_p,
guint n_fds,
const GPollFD *fds,
gboolean revents_filled);
typedef void (*GslProcessFunc) (GslModule *module,
guint n_values);
typedef guint (*GslProcessDeferFunc) (GslModule *module,
guint n_ivalues,
guint n_ovalues);
typedef void (*GslReconnectFunc) (GslModule *module);
/* gsldefs.h:
* typedef void (*GslAccessFunc) (GslModule *module,
* gpointer data);
* typedef void (*GslFreeFunc) (gpointer data);
* typedef void (*GslModuleFreeFunc) (gpointer data,
* const GslClass *klass);
*/
typedef enum /*< skip >*/
{
GSL_COST_NORMAL = 0,
GSL_COST_CHEAP = 1 << 0,
GSL_COST_EXPENSIVE = 1 << 1
} GslModuleFlags;
/* class, filled out by user */
struct _GslClass
{
guint n_istreams;
guint n_jstreams;
guint n_ostreams;
GslProcessFunc process; /* EngineThread */
GslProcessDeferFunc process_defer; /* EngineThread */
GslReconnectFunc reconnect; /* EngineThread */
GslModuleFreeFunc free; /* UserThread */
GslModuleFlags mflags;
};
/* module, constructed by engine */
struct _GslModule
{
const GslClass *klass;
gpointer user_data;
GslIStream *istreams; /* input streams */
GslJStream *jstreams; /* joint (multiconnect) input streams */
GslOStream *ostreams; /* output streams */
};
/* streams, constructed by engine */
struct _GslJStream
{
const gfloat **values;
guint n_connections;
guint reserved : 16;
};
struct _GslIStream
{
const gfloat *values;
guint reserved : 16;
guint connected : 1;
};
struct _GslOStream
{
gfloat *values;
guint sub_sample_pattern : 16;
guint connected : 1;
};
/* --- interface (UserThread functions) --- */
GslModule* gsl_module_new (const GslClass *klass,
gpointer user_data);
guint64 gsl_module_tick_stamp (GslModule *module);
GslJob* gsl_job_connect (GslModule *src_module,
guint src_ostream,
GslModule *dest_module,
guint dest_istream);
GslJob* gsl_job_jconnect (GslModule *src_module,
guint src_ostream,
GslModule *dest_module,
guint dest_jstream);
GslJob* gsl_job_disconnect (GslModule *dest_module,
guint dest_istream);
GslJob* gsl_job_jdisconnect (GslModule *dest_module,
guint dest_jstream,
GslModule *src_module,
guint src_ostream);
GslJob* gsl_job_integrate (GslModule *module);
GslJob* gsl_job_discard (GslModule *module);
GslJob* gsl_job_access (GslModule *module,
GslAccessFunc access_func, /* EngineThread */
gpointer data,
GslFreeFunc free_func); /* UserThread */
GslJob* gsl_job_set_consumer (GslModule *module,
gboolean is_toplevel_consumer);
GslJob* gsl_job_debug (const gchar *debug);
GslJob* gsl_job_add_poll (GslPollFunc poll_func,
gpointer data,
GslFreeFunc free_func,
guint n_fds,
const GPollFD *fds);
GslJob* gsl_job_remove_poll (GslPollFunc poll_func,
gpointer data);
GslTrans* gsl_trans_open (void);
void gsl_trans_add (GslTrans *trans,
GslJob *job);
void gsl_trans_commit (GslTrans *trans);
void gsl_trans_dismiss (GslTrans *trans);
void gsl_transact (GslJob *job,
...);
GslJob* gsl_flow_job_access (GslModule *module,
guint64 tick_stamp,
GslAccessFunc access_func, /* EngineThread */
gpointer data,
GslFreeFunc free_func); /* UserThread */
GslJob* gsl_flow_job_suspend (GslModule *module,
guint64 tick_stamp);
GslJob* gsl_flow_job_resume (GslModule *module,
guint64 tick_stamp);
/* --- module utilities --- */
gfloat* gsl_engine_const_values (gfloat value);
/* --- initialization & main loop --- */
void gsl_engine_init (gboolean threaded,
guint block_size,
guint sample_freq,
guint sub_sample_tqmask);
typedef struct
{
glong timeout;
gboolean fds_changed;
guint n_fds;
GPollFD *fds;
gboolean revents_filled;
} GslEngineLoop;
gboolean gsl_engine_prepare (GslEngineLoop *loop);
gboolean gsl_engine_check (const GslEngineLoop *loop);
void gsl_engine_dispatch (void);
/* --- miscellaneous --- */
void gsl_engine_garbage_collect (void);
void gsl_engine_wait_on_trans (void);
#define gsl_engine_block_size() ((const guint) gsl_externvar_bsize + 0)
#define gsl_engine_sample_freq() ((const guint) gsl_externvar_sample_freq + 0)
#define gsl_engine_sub_sample_tqmask() ((const guint) gsl_externvar_sub_sample_tqmask + 0)
#define gsl_engine_sub_sample_steps() ((const guint) gsl_externvar_sub_sample_steps + 0)
#define gsl_engine_sub_sample_test(ptr) (((guint) (ptr)) & gsl_engine_sub_sample_tqmask ())
#define GSL_SUB_SAMPLE_MATCH(ptr,sspatrn) (gsl_engine_sub_sample_test (ptr) == (sspatrn))
/*< private >*/
extern guint gsl_externvar_bsize;
extern guint gsl_externvar_sample_freq;
extern guint gsl_externvar_sub_sample_tqmask;
extern guint gsl_externvar_sub_sample_steps;
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __GSL_ENGINE_H__ */
|
