AgsBasePlugin

AgsBasePlugin — The base plugin class

Functions

#define AGS_PORT_DESCRIPTOR()
AgsPortDescriptor * ags_port_descriptor_alloc ()
void ags_port_descriptor_free ()
GList * ags_base_plugin_find_filename ()
GList * ags_base_plugin_find_effect ()
void ags_base_plugin_apply_port_group_by_prefix ()
gpointer ags_base_plugin_instantiate ()
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 ()

Properties

gchar * effect Read / Write
guint effect-index Read / Write
gchar * filename Read / Write
AgsBasePlugin * ui-plugin Read / Write

Signals

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

Types and Values

enum AgsBasePluginFlags
enum AgsPortDescriptorFlags
struct AgsPortDescriptor

Object Hierarchy

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

Includes

#include <ags/object/ags_base_plugin.h>

Description

The AgsBasePlugin loads/unloads plugins on a abstraction level.

Functions

AGS_PORT_DESCRIPTOR()

#define AGS_PORT_DESCRIPTOR(ptr) ((AgsPortDescriptor *)(ptr))

ags_port_descriptor_alloc ()

AgsPortDescriptor *
ags_port_descriptor_alloc ();

Alloc the AgsPortDescriptor

Returns

the AgsPortDescriptor

Since: 0.7.6

ags_port_descriptor_free ()

void
ags_port_descriptor_free (AgsPortDescriptor *port_descriptor);

Free the AgsPortDescriptor

Parameters

port_descriptor

the AgsPortDescriptor

  

Since: 0.7.6

ags_base_plugin_find_filename ()

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

ags_base_plugin_find_effect ()

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

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);

Instantiate the plugin

Parameters

base_plugin

the AgsBasePlugin

  

samplerate

the samplerate

  

Returns

the new plugin instance handle

Since: 0.7.6

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: 0.7.6

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: 0.7.6

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: 0.7.6

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: 0.7.6

ags_base_plugin_load_plugin ()

void
ags_base_plugin_load_plugin (AgsBasePlugin *base_plugin);

Load the plugin

Parameters

base_plugin

the AgsBasePlugin

  

Since: 0.7.6

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: 0.7.6

Types and Values

enum AgsBasePluginFlags

Members

AGS_BASE_PLUGIN_IS_INSTRUMENT

    

enum AgsPortDescriptorFlags

Members

AGS_PORT_DESCRIPTOR_ATOM

    

AGS_PORT_DESCRIPTOR_AUDIO

    

AGS_PORT_DESCRIPTOR_CONTROL

    

AGS_PORT_DESCRIPTOR_MIDI

    

AGS_PORT_DESCRIPTOR_EVENT

    

AGS_PORT_DESCRIPTOR_OUTPUT

    

AGS_PORT_DESCRIPTOR_INPUT

    

AGS_PORT_DESCRIPTOR_TOGGLED

    

AGS_PORT_DESCRIPTOR_ENUMERATION

    

AGS_PORT_DESCRIPTOR_LOGARITHMIC

    

AGS_PORT_DESCRIPTOR_INTEGER

    

AGS_PORT_DESCRIPTOR_SAMPLERATE

    

AGS_PORT_DESCRIPTOR_BOUNDED_BELOW

    

AGS_PORT_DESCRIPTOR_BOUNDED_ABOVE

    

struct AgsPortDescriptor

struct AgsPortDescriptor {
  guint flags;
  
  guint port_index;

  gchar *port_name;
  gchar *port_symbol;

  guint scale_steps;
  gchar **scale_points;
  float *scale_value;
  
  GValue *lower_value;
  GValue *upper_value;

  GValue *default_value;  
  
  gpointer user_data;
};

Property Details

The “effect” property

  “effect”                   gchar *

The effect this plugin is assigned with.

Flags: Read / Write

Default value: NULL

Since: 0.7.6

The “effect-index” property

  “effect-index”             guint

The effect-index this plugin is assigned with.

Flags: Read / Write

Default value: 0

Since: 0.7.6

The “filename” property

  “filename”                 gchar *

The filename this plugin is located in.

Flags: Read / Write

Default value: NULL

Since: 0.7.6

The “ui-plugin” property

  “ui-plugin”                AgsBasePlugin *

The ui-plugin this plugin is assigned with.

Flags: Read / Write

Since: 0.7.6

Signal Details

The “activate” signal

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

Flags: Run Last

The “connect-port” signal

void
user_function (AgsBasePlugin *base_plugin,
               gpointer       arg1,
               guint          arg2,
               gpointer       arg3,
               gpointer       user_data)

Flags: Run Last

The “deactivate” signal

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

Flags: Run Last

The “instantiate” signal

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

Flags: Run Last

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       arg1,
               gpointer       arg2,
               guint          arg3,
               gpointer       user_data)

Flags: Run Last

Generated by GTK-Doc V1.25