BSE Interface Reference

/opt/src/beast/bse/bsesource.h

SYNOPSIS

struct  BseAutomationProperty;
struct  _BseSource;
struct  _BseSourceChannelDefs;
struct  _BseSourceClass;
struct  _BseSourceOutput;
   
void  bse_source_access_modules  (source, access_func, data, data_free_func, trans);
void  bse_source_backup_ichannels_to_undo  (source);
void  bse_source_backup_ochannels_to_undo  (source);
BseErrorType  bse_source_check_input  (source, ichannel, osource, ochannel);
guint  bse_source_class_add_ichannel  (source_class, ident, label, blurb);
guint  bse_source_class_add_jchannel  (source_class, ident, label, blurb);
guint  bse_source_class_add_ochannel  (source_class, ident, label, blurb);
void  bse_source_class_add_probe_signals  (klass);
void  bse_source_class_cache_engine_class  (source_class, engine_class);
void  bse_source_class_inherit_channels  (source_class);
void  bse_source_clear_ichannels  (source);
void  bse_source_clear_ochannels  (source);
void  bse_source_clear_probes  (source);
SfiRing*  bse_source_collect_inputs_flat  (source);
SfiRing*  bse_source_collect_inputs_recursive  (source);
void  bse_source_connect_context  (source, context_handle, trans);
guint*  bse_source_context_ids  (source, n_ids);
void  bse_source_create_context  (source, context_handle, trans);
void  bse_source_create_context_with_data  (source, context_handle, data, free_data, trans);
void  bse_source_dismiss_context  (source, context_handle, trans);
guint  bse_source_find_ichannel  (source, ichannel_ident);
guint  bse_source_find_ochannel  (source, ochannel_ident);
void  bse_source_flow_access_module  (source, context_handle, tick_stamp, access_func, data, data_free_func, trans);
void  bse_source_flow_access_modules  (source, tick_stamp, access_func, data, data_free_func, trans);
void  bse_source_free_collection  (ring);
BseAutomationProperty*  bse_source_get_automation_properties  (source, n_props);
void  bse_source_get_automation_property  (source, prop_name, pmidi_channel, psignal_type);
gpointer  bse_source_get_context_data  (source, context_handle);
BseModule*  bse_source_get_context_imodule  (source, context_handle);
BseModule*  bse_source_get_context_omodule  (source, context_handle);
gboolean  bse_source_get_input  (source, ichannel, osourcep, ochannelp);
gboolean  bse_source_has_context  (source, context_handle);
gboolean  bse_source_has_output  (source, ochannel);
void  bse_source_input_backup_to_undo  (source, ichannel, osource, ochannel);
SfiRing*  bse_source_list_omodules  (source);
void  bse_source_must_set_input_loc  (source, ichannel, osource, ochannel, strloc);
void  bse_source_prepare  (source);
BseMusicalTuningType  bse_source_prepared_musical_tuning  (source);
void  bse_source_probes_modules_changed  (source);
void  bse_source_recreate_context  (source, context_handle, trans);
void  bse_source_reset  (source);
BseErrorType  bse_source_set_automation_property  (source, prop_name, midi_channel, signal_type);
void  bse_source_set_context_imodule  (source, context_handle, imodule);
void  bse_source_set_context_module  (source, context_handle, module);
void  bse_source_set_context_omodule  (source, context_handle, omodule);
BseErrorType  bse_source_set_input  (source, ichannel, osource, ochannel);
gboolean  bse_source_test_input_recursive  (source, test);
BseErrorType  bse_source_unset_input  (source, ichannel, osource, ochannel);
void  bse_source_update_modules  (source, member_offset, member_data, member_size, trans);

DESCRIPTION

BseAutomationProperty

 /opt/src/beast/bse/bsesource.h:256
struct BseAutomationProperty
{
  GParamSpec       *pspec;
  guint             midi_channel;
  BseMidiSignalType signal_type;
};

_BseSource

 /opt/src/beast/bse/bsesource.h:99
struct _BseSource
{
  BseItem               parent_object;
  BseSourceChannelDefs *channel_defs;
  BseSourceInput       *inputs;
  GSList               *outputs;
  gpointer              contexts;
  SfiReal               pos_x;
  SfiReal               pos_y;
  BseSourceProbes      *probes;
};

_BseSourceChannelDefs

 /opt/src/beast/bse/bsesource.h:110
struct _BseSourceChannelDefs
{
  guint   n_ichannels;
  gchar **ichannel_idents;
  gchar **ichannel_labels;
  gchar **ichannel_blurbs;
  guint  *ijstreams;
  guint   n_jstreams;
  guint   n_ochannels;
  gchar **ochannel_idents;
  gchar **ochannel_labels;
  gchar **ochannel_blurbs;
};

_BseSourceClass

 /opt/src/beast/bse/bsesource.h:123
struct _BseSourceClass
{
  BseItemClass         parent_class;
  BseSourceChannelDefs channel_defs;
  void               (*property_updated)     (BseSource*source, guint property_id, guint64 tick_stamp, double value, GParamSpec*pspec);
  void               (*prepare)              (BseSource*source);
  void               (*context_create)       (BseSource*source, guint context_handle, BseTrans*trans);
  void               (*context_connect)      (BseSource*source, guint context_handle, BseTrans*trans);
  void               (*context_dismiss)      (BseSource*source, guint context_handle, BseTrans*trans);
  void               (*reset)                (BseSource*source);
  void               (*add_input)            (BseSource*source, guint ichannel, BseSource*osource, guint ochannel);
  void               (*remove_input)         (BseSource*source, guint ichannel, BseSource*osource, guint ochannel);
  BseModuleClass      *engine_class;
  gboolean             filtered_properties;
  SfiRing             *unprepared_properties;
  SfiRing             *automation_properties;
};

_BseSourceOutput

 /opt/src/beast/bse/bsesource.h:86
struct _BseSourceOutput
{
  BseSource *osource;
  guint      ochannel;
};

bse_source_access_modules

 /opt/src/beast/bse/bsesource.h:227
void  bse_source_access_modules  
(BseSource          *source,
 BseEngineAccessFunc access_func,
 gpointer            data,
 BseFreeFunc         data_free_func,
 BseTrans           *trans);

bse_source_backup_ichannels_to_undo

 /opt/src/beast/bse/bsesource.h:234
void  bse_source_backup_ichannels_to_undo  
(BseSource *source);

bse_source_backup_ochannels_to_undo

 /opt/src/beast/bse/bsesource.h:235
void  bse_source_backup_ochannels_to_undo  
(BseSource *source);

bse_source_check_input

 /opt/src/beast/bse/bsesource.h:231
BseErrorType  bse_source_check_input  
(BseSource *source,
 guint      ichannel,
 BseSource *osource,
 guint      ochannel);

bse_source_class_add_ichannel

 /opt/src/beast/bse/bsesource.h:190
guint  bse_source_class_add_ichannel  
(BseSourceClass *source_class,
 const gchar    *ident,
 const gchar    *label,
 const gchar    *blurb);

bse_source_class_add_jchannel

 /opt/src/beast/bse/bsesource.h:194
guint  bse_source_class_add_jchannel  
(BseSourceClass *source_class,
 const gchar    *ident,
 const gchar    *label,
 const gchar    *blurb);

bse_source_class_add_ochannel

 /opt/src/beast/bse/bsesource.h:198
guint  bse_source_class_add_ochannel  
(BseSourceClass *source_class,
 const gchar    *ident,
 const gchar    *label,
 const gchar    *blurb);

bse_source_class_add_probe_signals

 /opt/src/beast/bse/bsesource.h:306
void  bse_source_class_add_probe_signals  
(BseSourceClass *klass);

bse_source_class_cache_engine_class

 /opt/src/beast/bse/bsesource.h:242
void  bse_source_class_cache_engine_class  
(BseSourceClass       *source_class,
 const BseModuleClass *engine_class);

bse_source_class_inherit_channels

 /opt/src/beast/bse/bsesource.h:199
void  bse_source_class_inherit_channels  
(BseSourceClass *source_class);

bse_source_clear_ichannels

 /opt/src/beast/bse/bsesource.h:251
void  bse_source_clear_ichannels  
(BseSource *source);

bse_source_clear_ochannels

 /opt/src/beast/bse/bsesource.h:252
void  bse_source_clear_ochannels  
(BseSource *source);

bse_source_clear_probes

 /opt/src/beast/bse/bsesource.h:305
void  bse_source_clear_probes  
(BseSource *source);

bse_source_collect_inputs_flat

 /opt/src/beast/bse/bsesource.h:273
SfiRing*  bse_source_collect_inputs_flat  
(BseSource *source);

bse_source_collect_inputs_recursive

 /opt/src/beast/bse/bsesource.h:274
SfiRing*  bse_source_collect_inputs_recursive  
(BseSource *source);

bse_source_connect_context

 /opt/src/beast/bse/bsesource.h:290
void  bse_source_connect_context  
(BseSource *source,
 guint      context_handle,
 BseTrans  *trans);

bse_source_context_ids

 /opt/src/beast/bse/bsesource.h:300
guint*  bse_source_context_ids  
(BseSource *source,
 guint     *n_ids);

bse_source_create_context

 /opt/src/beast/bse/bsesource.h:287
void  bse_source_create_context  
(BseSource *source,
 guint      context_handle,
 BseTrans  *trans);

bse_source_create_context_with_data

 /opt/src/beast/bse/bsesource.h:284
void  bse_source_create_context_with_data  
(BseSource               *source,
 guint                    context_handle,
 gpointer                 data,
 BseSourceFreeContextData free_data,
 BseTrans                *trans);

bse_source_dismiss_context

 /opt/src/beast/bse/bsesource.h:293
void  bse_source_dismiss_context  
(BseSource *source,
 guint      context_handle,
 BseTrans  *trans);

bse_source_find_ichannel

 /opt/src/beast/bse/bsesource.h:162
guint  bse_source_find_ichannel  
(BseSource   *source,
 const gchar *ichannel_ident);

bse_source_find_ochannel

 /opt/src/beast/bse/bsesource.h:164
guint  bse_source_find_ochannel  
(BseSource   *source,
 const gchar *ochannel_ident);

bse_source_flow_access_module

 /opt/src/beast/bse/bsesource.h:216
void  bse_source_flow_access_module  
(BseSource          *source,
 guint               context_handle,
 guint64             tick_stamp,
 BseEngineAccessFunc access_func,
 gpointer            data,
 BseFreeFunc         data_free_func,
 BseTrans           *trans);

bse_source_flow_access_modules

 /opt/src/beast/bse/bsesource.h:222
void  bse_source_flow_access_modules  
(BseSource          *source,
 guint64             tick_stamp,
 BseEngineAccessFunc access_func,
 gpointer            data,
 BseFreeFunc         data_free_func,
 BseTrans           *trans);

bse_source_free_collection

 /opt/src/beast/bse/bsesource.h:275
void  bse_source_free_collection  
(SfiRing *ring);

bse_source_get_automation_properties

 /opt/src/beast/bse/bsesource.h:270
BseAutomationProperty*  bse_source_get_automation_properties  
(BseSource *source,
 guint     *n_props);

bse_source_get_automation_property

 /opt/src/beast/bse/bsesource.h:268
void  bse_source_get_automation_property  
(BseSource         *source,
 const gchar       *prop_name,
 guint             *pmidi_channel,
 BseMidiSignalType *psignal_type);

bse_source_get_context_data

 /opt/src/beast/bse/bsesource.h:279
gpointer  bse_source_get_context_data  
(BseSource *source,
 guint      context_handle);

bse_source_get_context_imodule

 /opt/src/beast/bse/bsesource.h:207
BseModule*  bse_source_get_context_imodule  
(BseSource *source,
 guint      context_handle);

bse_source_get_context_omodule

 /opt/src/beast/bse/bsesource.h:209
BseModule*  bse_source_get_context_omodule  
(BseSource *source,
 guint      context_handle);

bse_source_get_input

 /opt/src/beast/bse/bsesource.h:176
gboolean  bse_source_get_input  
(BseSource  *source,
 guint       ichannel,
 BseSource **osourcep,
 guint      *ochannelp);

bse_source_has_context

 /opt/src/beast/bse/bsesource.h:302
gboolean  bse_source_has_context  
(BseSource *source,
 guint      context_handle);

bse_source_has_output

 /opt/src/beast/bse/bsesource.h:233
gboolean  bse_source_has_output  
(BseSource *source,
 guint      ochannel);

bse_source_input_backup_to_undo

 /opt/src/beast/bse/bsesource.h:239
void  bse_source_input_backup_to_undo  
(BseSource *source,
 guint      ichannel,
 BseSource *osource,
 guint      ochannel);

bse_source_list_omodules

 /opt/src/beast/bse/bsesource.h:303
SfiRing*  bse_source_list_omodules  
(BseSource *source);

bse_source_must_set_input_loc

 /opt/src/beast/bse/bsesource.h:181
void  bse_source_must_set_input_loc  
(BseSource   *source,
 guint        ichannel,
 BseSource   *osource,
 guint        ochannel,
 const gchar *strloc);

bse_source_prepare

 /opt/src/beast/bse/bsesource.h:297
void  bse_source_prepare  
(BseSource *source);

bse_source_prepared_musical_tuning

 /opt/src/beast/bse/bsesource.h:253
BseMusicalTuningType  bse_source_prepared_musical_tuning  
(BseSource *source);

bse_source_probes_modules_changed

 /opt/src/beast/bse/bsesource.h:307
void  bse_source_probes_modules_changed  
(BseSource *source);

bse_source_recreate_context

 /opt/src/beast/bse/bsesource.h:296
void  bse_source_recreate_context  
(BseSource *source,
 guint      context_handle,
 BseTrans  *trans);

bse_source_reset

 /opt/src/beast/bse/bsesource.h:298
void  bse_source_reset  
(BseSource *source);

bse_source_set_automation_property

 /opt/src/beast/bse/bsesource.h:264
BseErrorType  bse_source_set_automation_property  
(BseSource        *source,
 const gchar      *prop_name,
 guint             midi_channel,
 BseMidiSignalType signal_type);

bse_source_set_context_imodule

 /opt/src/beast/bse/bsesource.h:202
void  bse_source_set_context_imodule  
(BseSource *source,
 guint      context_handle,
 BseModule *imodule);

bse_source_set_context_module

 /opt/src/beast/bse/bsesource.h:245
void  bse_source_set_context_module  
(BseSource *source,
 guint      context_handle,
 BseModule *module);

bse_source_set_context_omodule

 /opt/src/beast/bse/bsesource.h:205
void  bse_source_set_context_omodule  
(BseSource *source,
 guint      context_handle,
 BseModule *omodule);

bse_source_set_input

 /opt/src/beast/bse/bsesource.h:168
BseErrorType  bse_source_set_input  
(BseSource *source,
 guint      ichannel,
 BseSource *osource,
 guint      ochannel);

bse_source_test_input_recursive

 /opt/src/beast/bse/bsesource.h:277
gboolean  bse_source_test_input_recursive  
(BseSource *source,
 BseSource *test);

bse_source_unset_input

 /opt/src/beast/bse/bsesource.h:172
BseErrorType  bse_source_unset_input  
(BseSource *source,
 guint      ichannel,
 BseSource *osource,
 guint      ochannel);

bse_source_update_modules

 /opt/src/beast/bse/bsesource.h:250
void  bse_source_update_modules  
(BseSource *source,
 guint      member_offset,
 gpointer   member_data,
 guint      member_size,
 BseTrans  *trans);