/usr/include/bse/bseengine.hh is in libbse-dev 0.7.8-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 207 208 209 210 211 | // Licensed GNU LGPL v2.1 or later: http://www.gnu.org/licenses/lgpl.html
#ifndef __BSE_ENGINE_H__
#define __BSE_ENGINE_H__
#include <bse/bsedefs.hh>
G_BEGIN_DECLS
/* --- constants --- */
#define BSE_STREAM_MAX_VALUES (1024 /* power of 2 and <= 16384 */)
#define BSE_MODULE_N_OSTREAMS(module) ((module)->klass->n_ostreams)
#define BSE_MODULE_N_ISTREAMS(module) ((module)->klass->n_istreams)
#define BSE_MODULE_N_JSTREAMS(module) ((module)->klass->n_jstreams)
#define BSE_MODULE_ISTREAM(module, stream) ((module)->istreams[(stream)])
#define BSE_MODULE_JSTREAM(module, stream) ((module)->jstreams[(stream)])
#define BSE_MODULE_OSTREAM(module, stream) ((module)->ostreams[(stream)])
#define BSE_MODULE_IBUFFER(module, stream) (BSE_MODULE_ISTREAM ((module), (stream)).values)
#define BSE_MODULE_JBUFFER(module, stream, con) (BSE_MODULE_JSTREAM ((module), (stream)).values[con])
#define BSE_MODULE_OBUFFER(module, stream) (BSE_MODULE_OSTREAM ((module), (stream)).values)
#define BSE_ENGINE_MAX_POLLFDS (128)
/* --- typedefs --- */
typedef struct _BseJob BseJob;
/* bsedefs.hh:
* typedef void (*BseEngineAccessFunc) (BseModule *module,
* gpointer data);
* typedef void (*BseFreeFunc) (gpointer data);
*/
typedef gboolean (*BseEnginePollFunc) (gpointer data,
guint n_values,
glong *timeout_p,
guint n_fds,
const GPollFD *fds,
gboolean revents_filled);
typedef gboolean (*BseEngineTimerFunc) (gpointer data,
guint64 tick_stamp);
typedef void (*BseEngineProbeFunc) (gpointer data,
guint n_values, /* bse_engine_block_size() */
guint64 tick_stamp,
guint n_ostreams, /* ENGINE_NODE_N_OSTREAMS() */
BseOStream **ostreams_p);
typedef void (*BseProcessFunc) (BseModule *module,
guint n_values);
typedef guint (*BseProcessDeferFunc) (BseModule *module,
guint n_ivalues,
guint n_ovalues);
typedef void (*BseModuleResetFunc) (BseModule *module);
typedef void (*BseModuleFreeFunc) (gpointer data,
const BseModuleClass *klass);
typedef enum /*< skip >*/
{
BSE_COST_NORMAL = 0,
BSE_COST_CHEAP = 1 << 0,
BSE_COST_EXPENSIVE = 1 << 1
} BseCostType;
/* class, filled out by user */
struct _BseModuleClass
{
guint n_istreams;
guint n_jstreams;
guint n_ostreams;
BseProcessFunc process; /* EngineThread */
BseProcessDeferFunc process_defer; /* EngineThread */
BseModuleResetFunc reset; /* EngineThread */
BseModuleFreeFunc free; /* UserThread */
BseCostType mflags;
};
/* module, constructed by engine */
struct _BseModule
{
const BseModuleClass *klass;
gpointer user_data;
BseIStream *istreams; /* input streams */
BseJStream *jstreams; /* joint (multiconnect) input streams */
BseOStream *ostreams; /* output streams */
};
/* streams, constructed by engine */
struct _BseJStream
{
const gfloat **values;
guint n_connections; /* scheduler update */
/*< private >*/
guint jcount; /* internal field */
};
struct _BseIStream
{
const gfloat *values;
gboolean connected; /* scheduler update */
};
struct _BseOStream
{
gfloat *values;
gboolean connected;
};
/* --- interface (UserThread functions) --- */
BseModule* bse_module_new (const BseModuleClass *klass,
gpointer user_data);
BseModule* bse_module_new_virtual (guint n_iostreams,
gpointer user_data,
BseFreeFunc free_data);
guint64 bse_module_tick_stamp (BseModule *module);
gboolean bse_module_has_source (BseModule *module,
guint istream);
gboolean bse_module_is_scheduled (BseModule *module);
BseJob* bse_job_connect (BseModule *src_module,
guint src_ostream,
BseModule *dest_module,
guint dest_istream);
BseJob* bse_job_jconnect (BseModule *src_module,
guint src_ostream,
BseModule *dest_module,
guint dest_jstream);
BseJob* bse_job_disconnect (BseModule *dest_module,
guint dest_istream);
BseJob* bse_job_jdisconnect (BseModule *dest_module,
guint dest_jstream,
BseModule *src_module,
guint src_ostream);
BseJob* bse_job_kill_inputs (BseModule *module);
BseJob* bse_job_kill_outputs (BseModule *module);
BseJob* bse_job_integrate (BseModule *module);
BseJob* bse_job_discard (BseModule *module);
BseJob* bse_job_force_reset (BseModule *module);
BseJob* bse_job_set_consumer (BseModule *module,
gboolean is_toplevel_consumer);
BseJob* bse_job_suspend_now (BseModule *module);
BseJob* bse_job_resume_at (BseModule *module,
guint64 tick_stamp);
BseJob* bse_job_debug (const gchar *debug);
BseJob* bse_job_nop (void);
BseJob* bse_job_add_poll (BseEnginePollFunc poll_func,
gpointer data,
BseFreeFunc free_func,
guint n_fds,
const GPollFD *fds);
BseJob* bse_job_remove_poll (BseEnginePollFunc poll_func,
gpointer data);
BseJob* bse_job_add_timer (BseEngineTimerFunc timer_func,
gpointer data,
BseFreeFunc free_func);
BseJob* bse_job_access (BseModule *module,
BseEngineAccessFunc access_func, /* EngineThread */
gpointer data,
BseFreeFunc free_func); /* UserThread */
BseJob* bse_job_probe_request (BseModule *module,
BseEngineProbeFunc probe, /* UserThread */
gpointer data);
BseJob* bse_job_flow_access (BseModule *module,
guint64 tick_stamp,
BseEngineAccessFunc access_func, /* EngineThread */
gpointer data,
BseFreeFunc free_func); /* UserThread */
BseJob* bse_job_boundary_access (BseModule *module,
guint64 tick_stamp,
BseEngineAccessFunc access_func, /* EngineThread */
gpointer data,
BseFreeFunc free_func); /* UserThread */
BseJob* bse_job_boundary_discard (BseModule *module);
BseTrans* bse_trans_open (void);
void bse_trans_add (BseTrans *trans,
BseJob *job);
BseTrans* bse_trans_merge (BseTrans *trans1,
BseTrans *trans2);
guint64 bse_trans_commit (BseTrans *trans);
void bse_trans_commit_delayed (BseTrans *trans,
guint64 tick_stamp);
void bse_trans_dismiss (BseTrans *trans);
void bse_transact (BseJob *job,
...) G_GNUC_NULL_TERMINATED;
/* --- module utilities (EngineThread functions) --- */
gfloat* bse_engine_const_values (gfloat value);
/* --- initialization & main loop --- */
void bse_engine_constrain (guint latency_ms,
guint sample_freq,
guint control_freq,
guint *block_size_p,
guint *control_raster_p);
void bse_engine_init (gboolean threaded);
gboolean bse_engine_configure (guint latency_ms,
guint sample_freq,
guint control_freq);
/* --- miscellaneous --- */
gfloat* bse_engine_const_zeros (guint smaller_than_BSE_STREAM_MAX_VALUES);
gboolean bse_engine_has_garbage (void);
void bse_engine_user_thread_collect (void);
void bse_engine_free_ostreams (guint n_ostreams,
BseOStream *ostreams);
void bse_engine_add_user_callback (gpointer data,
BseFreeFunc free_func); /* UserThread */
void bse_engine_wait_on_trans (void);
guint64 bse_engine_tick_stamp_from_systime (guint64 systime);
#define bse_engine_block_size() (0 + (const guint) bse_engine_exvar_block_size)
#define bse_engine_sample_freq() (0 + (const guint) bse_engine_exvar_sample_freq)
#define bse_engine_control_raster() (1 + (const guint) bse_engine_exvar_control_mask)
#define bse_engine_control_mask() (0 + (const guint) bse_engine_exvar_control_mask)
#define BSE_CONTROL_CHECK(index) ((bse_engine_control_mask() & (index)) == 0)
/* --- thread handling --- */
typedef struct
{
glong timeout;
gboolean fds_changed;
guint n_fds;
GPollFD *fds;
gboolean revents_filled;
} BseEngineLoop;
BirnetThread** bse_engine_get_threads (guint *n_threads);
gboolean bse_engine_prepare (BseEngineLoop *loop);
gboolean bse_engine_check (const BseEngineLoop *loop);
void bse_engine_dispatch (void);
/*< private >*/
extern guint bse_engine_exvar_block_size;
extern guint bse_engine_exvar_sample_freq;
extern guint bse_engine_exvar_control_mask;
G_END_DECLS
#endif /* __BSE_ENGINE_H__ */
|