AgsBasePlugin: Advanced Gtk+ Sequencer Audio Reference Manual

AgsBasePlugin

AgsBasePlugin — The base plugin class

Functions

#define	AGS_BASE_PLUGIN_GET_OBJ_MUTEX()
pthread_mutex_t *	ags_base_plugin_get_class_mutex ()
gboolean	ags_base_plugin_test_flags ()
void	ags_base_plugin_set_flags ()
void	ags_base_plugin_unset_flags ()
GList *	ags_base_plugin_find_filename ()
GList *	ags_base_plugin_find_effect ()
GList *	ags_base_plugin_find_ui_effect_index ()
GList *	ags_base_plugin_sort ()
void	ags_base_plugin_apply_port_group_by_prefix ()
gpointer	ags_base_plugin_instantiate ()
gpointer	ags_base_plugin_instantiate_with_params ()
void	ags_base_plugin_connect_port ()
void	ags_base_plugin_activate ()
void	ags_base_plugin_deactivate ()
void	ags_base_plugin_run ()
void	ags_base_plugin_load_plugin ()
AgsBasePlugin *	ags_base_plugin_new ()
#define	AGS_BASE_PLUGIN()
#define	AGS_BASE_PLUGIN_CLASS()
#define	AGS_BASE_PLUGIN_GET_CLASS()
#define	AGS_IS_BASE_PLUGIN()
GType	ags_base_plugin_get_type ()

Properties

gchar *	effect	Read / Write
guint	effect-index	Read / Write
gchar *	filename	Read / Write
gpointer	plugin-port	Read / Write
gpointer	plugin-so	Read / Write
gchar *	ui-effect	Read / Write
guint	ui-effect-index	Read / Write
gchar *	ui-filename	Read / Write
AgsBasePlugin *	ui-plugin	Read / Write
gpointer	ui-plugin-so	Read / Write
gpointer	uuid	Read / Write

Signals

void	activate	Run Last
void	connect-port	Run Last
void	deactivate	Run Last
gpointer	instantiate	Run Last
gpointer	instantiate-with-params	Run Last
void	load-plugin	Run Last
void	run	Run Last

Types and Values

enum	AgsBasePluginFlags
#define	AGS_TYPE_BASE_PLUGIN
struct	AgsBasePlugin
struct	AgsBasePluginClass

Object Hierarchy

    GObject
    ╰── AgsBasePlugin
        ├── AgsDssiPlugin
        ├── AgsLadspaPlugin
        ├── AgsLv2Plugin
        ╰── AgsLv2uiPlugin

Includes

#include <ags/plugin/ags_base_plugin.h>

Description

The AgsBasePlugin loads/unloads plugins on a abstraction level.

Functions

AGS_BASE_PLUGIN_GET_OBJ_MUTEX()

#define AGS_BASE_PLUGIN_GET_OBJ_MUTEX(obj) (((AgsBasePlugin *) obj)->obj_mutex)

ags_base_plugin_get_class_mutex ()

pthread_mutex_t *
ags_base_plugin_get_class_mutex ();

Use this function's returned mutex to access mutex fields.

Returns

the class mutex

Since: 2.0.0

ags_base_plugin_test_flags ()

gboolean
ags_base_plugin_test_flags (AgsBasePlugin *base_plugin,
                            guint flags);

Test flags to be set on recall .

Parameters

base_plugin	the AgsBasePlugin
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 2.0.0

ags_base_plugin_set_flags ()

void
ags_base_plugin_set_flags (AgsBasePlugin *base_plugin,
                           guint flags);

Set flags.

Parameters

base_plugin	the AgsBasePlugin
flags	the flags

Since: 2.0.0

ags_base_plugin_unset_flags ()

void
ags_base_plugin_unset_flags (AgsBasePlugin *base_plugin,
                             guint flags);

Unset flags.

Parameters

base_plugin	the AgsBasePlugin
flags	the flags

Since: 2.0.0

ags_base_plugin_find_filename ()

GList *
ags_base_plugin_find_filename (GList *base_plugin,
                               gchar *filename);

Find filename in base_plugin GList of AgsBasePlugin.

Parameters

base_plugin	the GList containing AgsBasePlugin
filename	the filename as string

Returns

the next matching GList

Since: 2.0.0

ags_base_plugin_find_effect ()

GList *
ags_base_plugin_find_effect (GList *base_plugin,
                             gchar *filename,
                             gchar *effect);

Find filename and effect in base_plugin GList of AgsBasePlugin.

Parameters

base_plugin	the GList containing AgsBasePlugin
filename	the filename as string
effect	the effect as string

Returns

the next matching GList

Since: 2.0.0

ags_base_plugin_find_ui_effect_index ()

GList *
ags_base_plugin_find_ui_effect_index (GList *base_plugin,
                                      gchar *ui_filename,
                                      guint ui_effect_index);

Find ui_filename and ui_effect_index in base_plugin GList of AgsBasePlugin.

Parameters

base_plugin	the GList containing AgsBasePlugin
ui_filename	the UI filename as string
ui_effect_index	the UI effect index

Returns

the next matching GList

Since: 2.0.0

ags_base_plugin_sort ()

GList *
ags_base_plugin_sort (GList *base_plugin);

Sort base_plugin alphabetically.

Parameters

base_plugin

the GList containing AgsBasePlugin

Returns

the sorted GList

Since: 2.0.0

ags_base_plugin_apply_port_group_by_prefix ()

void
ags_base_plugin_apply_port_group_by_prefix
                               (AgsBasePlugin *base_plugin);

ags_base_plugin_instantiate ()

gpointer
ags_base_plugin_instantiate (AgsBasePlugin *base_plugin,
                             guint samplerate,
                             guint buffer_size);

Instantiate the plugin

Parameters

base_plugin	the AgsBasePlugin
samplerate	the samplerate
buffer_size	the fixed buffer size

Returns

the new plugin instance handle

Since: 2.0.0

ags_base_plugin_instantiate_with_params ()

gpointer
ags_base_plugin_instantiate_with_params
                               (AgsBasePlugin *base_plugin,
                                guint *n_params,
                                gchar ***parameter_name,
                                GValue **value);

Instantiate the plugin

Parameters

base_plugin	the AgsBasePlugin
n_params	guint pointer to parameter count
parameter_name	string vector containing parameter names
value	the GValue array

Returns

the new plugin instance handle

Since: 2.2.18

ags_base_plugin_connect_port ()

void
ags_base_plugin_connect_port (AgsBasePlugin *base_plugin,
                              gpointer plugin_handle,
                              guint port_index,
                              gpointer data_location);

Connect a plugin instance.

Parameters

base_plugin	the AgsBasePlugin
plugin_handle	the plugin instance handle
port_index	the port's index to connect
data_location	the data location to connect

Since: 2.0.0

ags_base_plugin_activate ()

void
ags_base_plugin_activate (AgsBasePlugin *base_plugin,
                          gpointer plugin_handle);

Activate a plugin instance

Parameters

base_plugin	the AgsBasePlugin
plugin_handle	the plugin instance handle

Since: 2.0.0

ags_base_plugin_deactivate ()

void
ags_base_plugin_deactivate (AgsBasePlugin *base_plugin,
                            gpointer plugin_handle);

Deactivat a plugin instance

Parameters

base_plugin	the AgsBasePlugin
plugin_handle	the plugin instance handle

Since: 2.0.0

ags_base_plugin_run ()

void
ags_base_plugin_run (AgsBasePlugin *base_plugin,
                     gpointer plugin_handle,
                     snd_seq_event_t *seq_event,
                     guint frame_count);

Deactivat a plugin instance

Parameters

base_plugin	the AgsBasePlugin
plugin_handle	the plugin instance handle
seq_event	the alsa sequencer events
frame_count	the frame counts

Since: 2.0.0

ags_base_plugin_load_plugin ()

void
ags_base_plugin_load_plugin (AgsBasePlugin *base_plugin);

Load the plugin

Parameters

base_plugin

the AgsBasePlugin

Since: 2.0.0

ags_base_plugin_new ()

AgsBasePlugin *
ags_base_plugin_new (gchar *filename,
                     gchar *effect,
                     guint effect_index);

Creates an AgsBasePlugin

Parameters

filename	the plugin .so
effect	the effect's string representation
effect_index	the effect's index

Returns

a new AgsBasePlugin

Since: 2.0.0

AGS_BASE_PLUGIN()

#define AGS_BASE_PLUGIN(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_BASE_PLUGIN, AgsBasePlugin))

AGS_BASE_PLUGIN_CLASS()

#define AGS_BASE_PLUGIN_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_BASE_PLUGIN, AgsBasePluginClass))

AGS_BASE_PLUGIN_GET_CLASS()

#define AGS_BASE_PLUGIN_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_BASE_PLUGIN, AgsBasePluginClass))

AGS_IS_BASE_PLUGIN()

#define AGS_IS_BASE_PLUGIN(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_BASE_PLUGIN))

ags_base_plugin_get_type ()

GType
ags_base_plugin_get_type (void);

Types and Values

enum AgsBasePluginFlags

Enum values to control the behavior or indicate internal state of AgsBasePlugin by enable/disable as flags.

Members

AGS_BASE_PLUGIN_IS_INSTRUMENT

plugin is instrument

AGS_TYPE_BASE_PLUGIN

#define AGS_TYPE_BASE_PLUGIN                (ags_base_plugin_get_type())

struct AgsBasePlugin

struct AgsBasePlugin;

struct AgsBasePluginClass

struct AgsBasePluginClass {
  GObjectClass gobject;

  gpointer (*instantiate)(AgsBasePlugin *base_plugin,
			  guint samplerate, guint buffer_size);

  gpointer (*instantiate_with_params)(AgsBasePlugin *base_plugin,
				      guint *n_params,
				      gchar ***parameter_name,
				      GValue **value);
  
  void (*connect_port)(AgsBasePlugin *base_plugin, gpointer plugin_handle, guint port_index, gpointer data_location);
  
  void (*activate)(AgsBasePlugin *base_plugin, gpointer plugin_handle);
  void (*deactivate)(AgsBasePlugin *base_plugin, gpointer plugin_handle);

  void (*run)(AgsBasePlugin *base_plugin,
	      gpointer plugin_handle,
	      snd_seq_event_t *seq_event,
	      guint frame_count);
  
  void (*load_plugin)(AgsBasePlugin *base_plugin);
};

Property Details

The `“effect”` property

  “effect”                   gchar *

The assigned effect.

Flags: Read / Write

Default value: NULL

Since: 2.0.0

The `“effect-index”` property

  “effect-index”             guint

The assigned effect-index.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“filename”` property

  “filename”                 gchar *

The assigned filename.

Flags: Read / Write

Default value: NULL

Since: 2.0.0

The `“plugin-port”` property

  “plugin-port”              gpointer

The assigned GList containing AgsPluginPort

Flags: Read / Write

Since: 2.0.0

The `“plugin-so”` property

  “plugin-so”                gpointer

The assigned plugin.so

Flags: Read / Write

Since: 2.0.0

The `“ui-effect”` property

  “ui-effect”                gchar *

The assigned ui-effect.

Flags: Read / Write

Default value: NULL

Since: 2.0.0

The `“ui-effect-index”` property

  “ui-effect-index”          guint

The assigned ui-effect-index.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“ui-filename”` property

  “ui-filename”              gchar *

The assigned UI filename.

Flags: Read / Write

Default value: NULL

Since: 2.0.0

The `“ui-plugin”` property

  “ui-plugin”                AgsBasePlugin *

The assigned ui-plugin.

Flags: Read / Write

Since: 2.0.0

The `“ui-plugin-so”` property

  “ui-plugin-so”             gpointer

The assigned ui_plugin.so

Flags: Read / Write

Since: 2.0.0

The `“uuid”` property

  “uuid”                     gpointer

The assigned AgsUUID

Flags: Read / Write

Since: 2.0.0

Signal Details

The `“activate”` signal

void
user_function (AgsBasePlugin *base_plugin,
               gpointer       plugin_handle,
               gpointer       user_data)

The ::activate signal creates a new instance of plugin.

Parameters

base_plugin	the plugin to activate
plugin_handle	the plugin handle
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0

The `“connect-port”` signal

void
user_function (AgsBasePlugin *base_plugin,
               gpointer       plugin_handle,
               guint          port_index,
               gpointer       data_location,
               gpointer       user_data)

The ::connect-port signal creates a new instance of plugin.

Parameters

base_plugin	the plugin to connect-port
plugin_handle	the plugin handle
port_index	the port index
data_location	the data location
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0

The `“deactivate”` signal

void
user_function (AgsBasePlugin *base_plugin,
               gpointer       plugin_handle,
               gpointer       user_data)

The ::deactivate signal creates a new instance of plugin.

Parameters

base_plugin	the plugin to deactivate
plugin_handle	the plugin handle
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0

The `“instantiate”` signal

gpointer
user_function (AgsBasePlugin *base_plugin,
               guint          samplerate,
               guint          buffer_size,
               gpointer       user_data)

The ::instantiate signal creates a new instance of plugin.

Parameters

base_plugin	the plugin to instantiate
samplerate	the samplerate
buffer_size	the fixed buffer size
user_data	user data set when the signal handler was connected.

Returns

the new plugin instance

Flags: Run Last

Since: 2.0.0

The `“instantiate-with-params”` signal

gpointer
user_function (AgsBasePlugin *base_plugin,
               gpointer       n_params,
               gpointer       parameter_name,
               gpointer       value,
               gpointer       user_data)

The ::instantiate-with-params signal creates a new instance of plugin.

Parameters

base_plugin	the plugin to instantiate
n_params	pointer to array length
parameter_name	parameter name string vector
value	the GValue array
user_data	user data set when the signal handler was connected.

Returns

the new plugin instance

Flags: Run Last

Since: 2.2.18

The `“load-plugin”` signal

void
user_function (AgsBasePlugin *agsbaseplugin,
               gpointer       user_data)

Flags: Run Last

The `“run”` signal

void
user_function (AgsBasePlugin *base_plugin,
               gpointer       plugin_handle,
               gpointer       seq_event,
               guint          frame_count,
               gpointer       user_data)

The ::run signal creates a new instance of plugin.

Parameters

base_plugin	the plugin to run
plugin_handle	the plugin handle
seq_event	the MIDI data
frame_count	the frame count
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0

AgsBasePlugin

Functions

Properties

Signals

Types and Values

Object Hierarchy

Includes

Description

Functions

AGS_BASE_PLUGIN_GET_OBJ_MUTEX()

ags_base_plugin_get_class_mutex ()

Returns

ags_base_plugin_test_flags ()

Parameters

Returns

ags_base_plugin_set_flags ()

Parameters

ags_base_plugin_unset_flags ()

Parameters

ags_base_plugin_find_filename ()

Parameters

Returns

ags_base_plugin_find_effect ()

Parameters

Returns

ags_base_plugin_find_ui_effect_index ()

Parameters

Returns

ags_base_plugin_sort ()

Parameters

Returns

ags_base_plugin_apply_port_group_by_prefix ()

ags_base_plugin_instantiate ()

Parameters

Returns

ags_base_plugin_instantiate_with_params ()

Parameters

Returns

ags_base_plugin_connect_port ()

Parameters

ags_base_plugin_activate ()

Parameters

ags_base_plugin_deactivate ()

Parameters

ags_base_plugin_run ()

Parameters

ags_base_plugin_load_plugin ()

Parameters

ags_base_plugin_new ()

Parameters

Returns

AGS_BASE_PLUGIN()

AGS_BASE_PLUGIN_CLASS()

AGS_BASE_PLUGIN_GET_CLASS()

AGS_IS_BASE_PLUGIN()

ags_base_plugin_get_type ()

Types and Values

enum AgsBasePluginFlags

Members

AGS_TYPE_BASE_PLUGIN

struct AgsBasePlugin

struct AgsBasePluginClass

Property Details

The “effect” property

The “effect-index” property

The “filename” property

The “plugin-port” property

The “plugin-so” property

The “ui-effect” property

The “ui-effect-index” property

The “ui-filename” property

The “ui-plugin” property

The “ui-plugin-so” property

The “uuid” property

Signal Details

The “activate” signal

Parameters

The “connect-port” signal

Parameters

The “deactivate” signal

The `“effect”` property

The `“effect-index”` property

The `“filename”` property

The `“plugin-port”` property

The `“plugin-so”` property

The `“ui-effect”` property

The `“ui-effect-index”` property

The `“ui-filename”` property

The `“ui-plugin”` property

The `“ui-plugin-so”` property

The `“uuid”` property

The `“activate”` signal

The `“connect-port”` signal

The `“deactivate”` signal

The `“instantiate”` signal

The `“instantiate-with-params”` signal

The `“load-plugin”` signal

The `“run”` signal