AgsAutomation: Advanced Gtk+ Sequencer Audio Reference Manual

AgsAutomation

AgsAutomation — Automation class supporting selection and clipboard.

Functions

#define	AGS_AUTOMATION_GET_OBJ_MUTEX()
pthread_mutex_t *	ags_automation_get_class_mutex ()
gboolean	ags_automation_test_flags ()
void	ags_automation_set_flags ()
void	ags_automation_unset_flags ()
GList *	ags_automation_find_port ()
GList *	ags_automation_find_near_timestamp ()
GList *	ags_automation_find_near_timestamp_extended ()
GList *	ags_automation_add ()
void	ags_automation_add_acceleration ()
void	ags_automation_remove_acceleration ()
gboolean	ags_automation_remove_acceleration_at_position ()
GList *	ags_automation_get_selection ()
gboolean	ags_automation_is_acceleration_selected ()
AgsAcceleration *	ags_automation_find_point ()
GList *	ags_automation_find_region ()
void	ags_automation_free_selection ()
void	ags_automation_add_point_to_selection ()
void	ags_automation_remove_point_from_selection ()
void	ags_automation_add_region_to_selection ()
void	ags_automation_remove_region_from_selection ()
void	ags_automation_add_all_to_selection ()
xmlNode *	ags_automation_copy_selection ()
xmlNode *	ags_automation_cut_selection ()
void	ags_automation_insert_from_clipboard ()
void	ags_automation_insert_from_clipboard_extended ()
gchar **	ags_automation_get_specifier_unique ()
gchar **	ags_automation_get_specifier_unique_with_channel_type ()
GList *	ags_automation_find_specifier ()
GList *	ags_automation_find_channel_type_with_control_name ()
GList *	ags_automation_find_specifier_with_type_and_line ()
guint	ags_automation_get_value ()
AgsAutomation *	ags_automation_new ()
#define	AGS_AUTOMATION()
#define	AGS_AUTOMATION_CLASS()
#define	AGS_AUTOMATION_GET_CLASS()
#define	AGS_IS_AUTOMATION()
GType	ags_automation_get_type ()

Properties

gpointer	acceleration	Read / Write
AgsAudio *	audio	Read / Write
GType *	channel-type	Read / Write
gchar *	control-name	Read / Write
gdouble	default-value	Read / Write
guint	line	Read / Write
gdouble	lower	Read / Write
AgsPort *	port	Read / Write
guint	steps	Read / Write
AgsTimestamp *	timestamp	Read / Write
gdouble	upper	Read / Write

Types and Values

#define	AGS_AUTOMATION_DEFAULT_BPM
#define	AGS_AUTOMATION_TICS_PER_BEAT
#define	AGS_AUTOMATION_MINIMUM_ACCELERATION_LENGTH
#define	AGS_AUTOMATION_MAXIMUM_ACCELERATION_LENGTH
#define	AGS_AUTOMATION_DEFAULT_LENGTH
#define	AGS_AUTOMATION_DEFAULT_JIFFIE
#define	AGS_AUTOMATION_DEFAULT_DURATION
#define	AGS_AUTOMATION_DEFAULT_OFFSET
#define	AGS_AUTOMATION_DEFAULT_PRECISION
#define	AGS_AUTOMATION_MAXIMUM_STEPS
#define	AGS_AUTOMATION_CLIPBOARD_VERSION
#define	AGS_AUTOMATION_CLIPBOARD_TYPE
#define	AGS_AUTOMATION_CLIPBOARD_FORMAT
#define	AGS_AUTOMATION_CLIPBOARD_LEGACY_FORMAT
enum	AgsAutomationFlags
#define	AGS_TYPE_AUTOMATION
struct	AgsAutomation
struct	AgsAutomationClass

Object Hierarchy

    GObject
    ╰── AgsAutomation

Includes

#include <ags/audio/ags_automation.h>

Description

AgsAutomation acts as a container of AgsAcceleration.

Functions

AGS_AUTOMATION_GET_OBJ_MUTEX()

#define AGS_AUTOMATION_GET_OBJ_MUTEX(obj) (((AgsAutomation *) obj)->obj_mutex)

ags_automation_get_class_mutex ()

pthread_mutex_t *
ags_automation_get_class_mutex ();

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

Returns

the class mutex

Since: 2.0.0

ags_automation_test_flags ()

gboolean
ags_automation_test_flags (AgsAutomation *automation,
                           guint flags);

Test flags to be set on automation .

Parameters

automation	the AgsAutomation
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 2.0.0

ags_automation_set_flags ()

void
ags_automation_set_flags (AgsAutomation *automation,
                          guint flags);

Set flags on automation .

Parameters

automation	the AgsAutomation
flags	the flags

Since: 2.0.0

ags_automation_unset_flags ()

void
ags_automation_unset_flags (AgsAutomation *automation,
                            guint flags);

Unset flags on automation .

Parameters

automation	the AgsAutomation
flags	the flags

Since: 2.0.0

ags_automation_find_port ()

GList *
ags_automation_find_port (GList *automation,
                          GObject *port);

Find automation by port.

Parameters

automation	the GList containing AgsAutomation
port	the AgsPort to match

Returns

next matching automation as GList or NULL if not found

Since: 2.0.0

ags_automation_find_near_timestamp ()

GList *
ags_automation_find_near_timestamp (GList *automation,
                                    guint line,
                                    AgsTimestamp *timestamp);

Retrieve appropriate automation for timestamp.

Parameters

automation	the GList containing AgsAutomation
line	the matching audio channel
timestamp	the matching timestamp

Returns

Next matching GList or NULL if not found

Since: 2.0.0

ags_automation_find_near_timestamp_extended ()

GList *
ags_automation_find_near_timestamp_extended
                               (GList *automation,
                                guint line,
                                GType channel_type,
                                gchar *control_name,
                                AgsTimestamp *timestamp);

Retrieve appropriate automation for timestamp.

Parameters

automation	the GList containing AgsAutomation
line	the matching audio channel
channel_type	the matching channel type
control_name	the matching control name
timestamp	the matching timestamp

Returns

Next matching GList or NULL if not found

Since: 2.0.0

ags_automation_add ()

GList *
ags_automation_add (GList *automation,
                    AgsAutomation *new_automation);

Add new_automation sorted to automation

Parameters

automation	the GList containing AgsAutomation
new_automation	the AgsAutomation to add

Returns

the new beginning of automation

Since: 2.0.0

ags_automation_add_acceleration ()

void
ags_automation_add_acceleration (AgsAutomation *automation,
                                 AgsAcceleration *acceleration,
                                 gboolean use_selection_list);

Adds acceleration to automation .

Parameters

automation	the AgsAutomation
acceleration	the AgsAcceleration to add
use_selection_list	if `TRUE` add to selection, else to default automation

Since: 2.0.0

ags_automation_remove_acceleration ()

void
ags_automation_remove_acceleration (AgsAutomation *automation,
                                    AgsAcceleration *acceleration,
                                    gboolean use_selection_list);

Removes acceleration from automation .

Parameters

automation	the AgsAutomation
acceleration	the AgsAcceleration to remove
use_selection_list	if `TRUE` remove from selection, else from default automation

Since: 2.0.0

ags_automation_remove_acceleration_at_position ()

gboolean
ags_automation_remove_acceleration_at_position
                               (AgsAutomation *automation,
                                guint x,
                                gdouble y);

Removes one AgsAcceleration of automation.

Parameters

automation	the AgsAutomation
x	x offset
y	y value of acceleration

Returns

TRUE if successfully removed acceleration, else FALSE

Since: 2.0.0

ags_automation_get_selection ()

GList *
ags_automation_get_selection (AgsAutomation *automation);

Retrieve selection.

Parameters

automation

the AgsAutomation

Returns

the selection.

Since: 2.0.0

ags_automation_is_acceleration_selected ()

gboolean
ags_automation_is_acceleration_selected
                               (AgsAutomation *automation,
                                AgsAcceleration *acceleration);

Check selection for acceleration.

Parameters

automation	the AgsAutomation
acceleration	the AgsAcceleration to check for

Returns

TRUE if selected, else FALSE

Since: 2.0.0

ags_automation_find_point ()

AgsAcceleration *
ags_automation_find_point (AgsAutomation *automation,
                           guint x,
                           gdouble y,
                           gboolean use_selection_list);

Find acceleration by offset and acceleration.

Parameters

automation	the AgsAutomation
x	x offset
y	y value acceleration, will be ignored
use_selection_list	if `TRUE` selection is searched

Returns

the matching acceleration.

Since: 2.0.0

ags_automation_find_region ()

GList *
ags_automation_find_region (AgsAutomation *automation,
                            guint x0,
                            gdouble y0,
                            guint x1,
                            gdouble y1,
                            gboolean use_selection_list);

Find acceleration by offset and value region.

Parameters

automation	the AgsAutomation
x0	start offset
y0	value start
x1	end offset
y1	value end
use_selection_list	if `TRUE` selection is searched

Returns

the matching accelerations as GList

Since: 2.0.0

ags_automation_free_selection ()

void
ags_automation_free_selection (AgsAutomation *automation);

Clear selection.

Parameters

automation

the AgsAutomation

Since: 2.0.0

ags_automation_add_point_to_selection ()

void
ags_automation_add_point_to_selection (AgsAutomation *automation,
                                       guint x,
                                       gdouble y,
                                       gboolean replace_current_selection);

Select acceleration at position.

Parameters

automation	the AgsAutomation
x	x offset
y	y acceleration value
replace_current_selection	if `TRUE` selection is replaced

Since: 2.0.0

ags_automation_remove_point_from_selection ()

void
ags_automation_remove_point_from_selection
                               (AgsAutomation *automation,
                                guint x,
                                gdouble y);

Remove acceleration at position of selection.

Parameters

automation	the AgsAutomation
x	x offset
y	y acceleration value

Since: 2.0.0

ags_automation_add_region_to_selection ()

void
ags_automation_add_region_to_selection
                               (AgsAutomation *automation,
                                guint x0,
                                gdouble y0,
                                guint x1,
                                gdouble y1,
                                gboolean replace_current_selection);

ags_automation_remove_region_from_selection ()

void
ags_automation_remove_region_from_selection
                               (AgsAutomation *automation,
                                guint x0,
                                gdouble y0,
                                guint x1,
                                gdouble y1);

Remove acceleration within region of selection.

Parameters

automation	the AgsAutomation
x0	x start offset
y0	y start acceleration
x1	x end offset
y1	y end acceleration

Since: 2.0.0

ags_automation_add_all_to_selection ()

void
ags_automation_add_all_to_selection (AgsAutomation *automation);

Add all acceleration to selection.

Parameters

automation

the AgsAutomation

Since: 2.0.0

ags_automation_copy_selection ()

xmlNode *
ags_automation_copy_selection (AgsAutomation *automation);

Copy selection to clipboard.

Parameters

automation

the AgsAutomation

Returns

the selection as xmlNode

Since: 2.0.0

ags_automation_cut_selection ()

xmlNode *
ags_automation_cut_selection (AgsAutomation *automation);

Cut selection to clipboard.

Parameters

automation

the AgsAutomation

Returns

the selection as xmlNod

Since: 2.0.0

ags_automation_insert_from_clipboard ()

void
ags_automation_insert_from_clipboard (AgsAutomation *automation,
                                      xmlNode *automation_node,
                                      gboolean reset_x_offset,
                                      guint x_offset,
                                      gboolean reset_y_offset,
                                      gdouble y_offset);

Insert clipboard automation_node to automation .

Parameters

automation	the AgsAutomation
automation_node	the xmlNode
reset_x_offset	if `TRUE` reset x offset
x_offset	the x offset to use
reset_y_offset	if `TRUE` reset y offset
y_offset	the y offset to use

Since: 2.0.0

ags_automation_insert_from_clipboard_extended ()

void
ags_automation_insert_from_clipboard_extended
                               (AgsAutomation *automation,
                                xmlNode *automation_node,
                                gboolean reset_x_offset,
                                guint x_offset,
                                gboolean reset_y_offset,
                                gdouble y_offset,
                                gboolean match_line,
                                gboolean no_duplicates);

Insert clipboard automation_node to automation .

Parameters

automation	the AgsAutomation
automation_node	the xmlNode
reset_x_offset	if `TRUE` reset x offset
x_offset	the x offset to use
reset_y_offset	if `TRUE` reset y offset
y_offset	the y offset to use
match_line	if `TRUE` match line or discard
no_duplicates	if `TRUE` eliminate duplicates

Since: 2.0.0

ags_automation_get_specifier_unique ()

gchar **
ags_automation_get_specifier_unique (GList *automation);

Retrieve automation port specifier.

Parameters

automation

the GList containing AgsAutomation

Returns

a NULL terminated string array

Since: 2.0.0

ags_automation_get_specifier_unique_with_channel_type ()

gchar **
ags_automation_get_specifier_unique_with_channel_type
                               (GList *automation,
                                GType channel_type);

Retrieve automation port specifier.

Parameters

automation	the GList containing AgsAutomation
channel_type	the channel's GType

Returns

a NULL terminated string array

Since: 2.0.0

ags_automation_find_specifier ()

GList *
ags_automation_find_specifier (GList *automation,
                               gchar *specifier);

Find port specifier.

Parameters

automation	the GList containing AgsAutomation
specifier	the string specifier to find

Returns

Next matching GList

Since: 2.0.0

ags_automation_find_channel_type_with_control_name ()

GList *
ags_automation_find_channel_type_with_control_name
                               (GList *automation,
                                GType channel_type,
                                gchar *specifier);

Find automation by channel_type .

Parameters

automation	the GList containing AgsAutomation
channel_type	the GType to match

Returns

next matching automation as GList or NULL if not found

Since: 2.0.0

ags_automation_find_specifier_with_type_and_line ()

GList *
ags_automation_find_specifier_with_type_and_line
                               (GList *automation,
                                gchar *specifier,
                                GType channel_type,
                                guint line);

Find port specifier with channel type and line.

Parameters

automation	the GList containing AgsAutomation
specifier	the string specifier to find
channel_type	the channel GType
line	the line

Returns

Next matching GList

Since: 2.0.0

ags_automation_get_value ()

guint
ags_automation_get_value (AgsAutomation *automation,
                          guint x,
                          guint x_end,
                          gboolean use_prev_on_failure,
                          GValue *value);

Get automation value.

Parameters

automation	the AgsAutomation
x	the x-offset
x_end	the x-end-offset
use_prev_on_failure	if `TRUE` use previous value, else return G_MAXUINT
value	the return location of value

Returns

the x_offset

Since: 2.0.0

ags_automation_new ()

AgsAutomation *
ags_automation_new (GObject *audio,
                    guint line,
                    GType channel_type,
                    gchar *control_name);

Creates a new instance of AgsAutomation.

Parameters

audio	the AgsAudio
line	the line to apply
channel_type	the channel type
control_name	the control name

Returns

the new AgsAutomation

Since: 2.0.0

AGS_AUTOMATION()

#define AGS_AUTOMATION(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_AUTOMATION, AgsAutomation))

AGS_AUTOMATION_CLASS()

#define AGS_AUTOMATION_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_AUTOMATION, AgsAutomationClass))

AGS_AUTOMATION_GET_CLASS()

#define AGS_AUTOMATION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS (obj, AGS_TYPE_AUTOMATION, AgsAutomationClass))

AGS_IS_AUTOMATION()

#define AGS_IS_AUTOMATION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_AUTOMATION))

ags_automation_get_type ()

GType
ags_automation_get_type (void);

Types and Values

AGS_AUTOMATION_DEFAULT_BPM

#define AGS_AUTOMATION_DEFAULT_BPM (120.0)

AGS_AUTOMATION_TICS_PER_BEAT

#define AGS_AUTOMATION_TICS_PER_BEAT (1.0)

AGS_AUTOMATION_MINIMUM_ACCELERATION_LENGTH

#define AGS_AUTOMATION_MINIMUM_ACCELERATION_LENGTH (1.0 / 16.0 / 64.0)

AGS_AUTOMATION_MAXIMUM_ACCELERATION_LENGTH

#define AGS_AUTOMATION_MAXIMUM_ACCELERATION_LENGTH (16.0)

AGS_AUTOMATION_DEFAULT_LENGTH

#define AGS_AUTOMATION_DEFAULT_LENGTH (64 * 16 * 1200 / AGS_AUTOMATION_TICS_PER_BEAT)

AGS_AUTOMATION_DEFAULT_JIFFIE

#define AGS_AUTOMATION_DEFAULT_JIFFIE (60.0 / AGS_AUTOMATION_DEFAULT_BPM / AGS_AUTOMATION_TICS_PER_BEAT)

AGS_AUTOMATION_DEFAULT_DURATION

#define AGS_AUTOMATION_DEFAULT_DURATION (AGS_AUTOMATION_DEFAULT_LENGTH * AGS_AUTOMATION_DEFAULT_JIFFIE * USEC_PER_SEC)

AGS_AUTOMATION_DEFAULT_OFFSET

#define AGS_AUTOMATION_DEFAULT_OFFSET (64 * (1 / AGS_AUTOMATION_MINIMUM_ACCELERATION_LENGTH))

AGS_AUTOMATION_DEFAULT_PRECISION

#define AGS_AUTOMATION_DEFAULT_PRECISION (8)

AGS_AUTOMATION_MAXIMUM_STEPS

#define AGS_AUTOMATION_MAXIMUM_STEPS (128)

AGS_AUTOMATION_CLIPBOARD_VERSION

#define AGS_AUTOMATION_CLIPBOARD_VERSION "1.3.0"

AGS_AUTOMATION_CLIPBOARD_TYPE

#define AGS_AUTOMATION_CLIPBOARD_TYPE "AgsAutomationClipboardXml"

AGS_AUTOMATION_CLIPBOARD_FORMAT

#define AGS_AUTOMATION_CLIPBOARD_FORMAT "AgsAutomationNativeScale"

AGS_AUTOMATION_CLIPBOARD_LEGACY_FORMAT

#define AGS_AUTOMATION_CLIPBOARD_LEGACY_FORMAT "AgsAutomationNativePiano"

enum AgsAutomationFlags

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

Members

AGS_AUTOMATION_BYPASS

ignore any automation data

AGS_TYPE_AUTOMATION

#define AGS_TYPE_AUTOMATION                (ags_automation_get_type())

struct AgsAutomation

struct AgsAutomation;

struct AgsAutomationClass

struct AgsAutomationClass {
  GObjectClass gobject;
};

Property Details

The `“acceleration”` property

  “acceleration”             gpointer

The acceleration list.

Flags: Read / Write

Since: 2.0.0

The `“audio”` property

  “audio”                    AgsAudio *

The assigned AgsAudio

Flags: Read / Write

Since: 2.0.0

The `“channel-type”` property

  “channel-type”             GType *

The effect's assigned channel type.

Flags: Read / Write

Allowed values: void

Since: 2.0.0

The `“control-name”` property

  “control-name”             gchar *

The effect's assigned control name.

Flags: Read / Write

Default value: NULL

Since: 2.0.0

The `“default-value”` property

  “default-value”            gdouble

The effect's default-value.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“line”` property

  “line”                     guint

The effect's line.

Flags: Read / Write

Allowed values: <= 65535

Default value: 0

Since: 2.0.0

The `“lower”` property

  “lower”                    gdouble

The effect's lower.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“port”` property

  “port”                     AgsPort *

The assigned AgsPort

Flags: Read / Write

Since: 2.0.0

The `“steps”` property

  “steps”                    guint

The effect's steps.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“timestamp”` property

  “timestamp”                AgsTimestamp *

The automation's timestamp.

Flags: Read / Write

Since: 2.0.0

The `“upper”` property

  “upper”                    gdouble

The effect's upper.

Flags: Read / Write

Default value: 0

Since: 2.0.0