AgsAudioSignal: Advanced Gtk+ Sequencer Audio Reference Manual

AgsAudioSignal

AgsAudioSignal — Contains the audio data and its alignment

Functions

#define	AGS_AUDIO_SIGNAL_GET_OBJ_MUTEX()
#define	AGS_AUDIO_SIGNAL_GET_STREAM_MUTEX()
pthread_mutex_t *	ags_audio_signal_get_class_mutex ()
gboolean	ags_audio_signal_test_flags ()
void	ags_audio_signal_set_flags ()
void	ags_audio_signal_unset_flags ()
void *	ags_stream_alloc ()
void	ags_stream_free ()
void	ags_audio_signal_set_output_soundcard ()
void	ags_audio_signal_set_input_soundcard ()
void	ags_audio_signal_set_samplerate ()
void	ags_audio_signal_set_buffer_size ()
void	ags_audio_signal_set_format ()
void	ags_audio_signal_add_note ()
void	ags_audio_signal_remove_note ()
void	ags_audio_signal_refresh_data ()
void	ags_audio_signal_add_stream ()
void	ags_audio_signal_stream_resize ()
void	ags_audio_signal_stream_safe_resize ()
void	ags_audio_signal_duplicate_stream ()
void	ags_audio_signal_feed ()
guint	ags_audio_signal_get_length_till_current ()
AgsAudioSignal *	ags_audio_signal_get_template ()
GList *	ags_audio_signal_get_rt_template ()
GList *	ags_audio_signal_find_stream_current ()
GList *	ags_audio_signal_find_by_recall_id ()
gboolean	ags_audio_signal_is_active ()
AgsAudioSignal *	ags_audio_signal_new ()
AgsAudioSignal *	ags_audio_signal_new_with_length ()
#define	AGS_AUDIO_SIGNAL()
#define	AGS_AUDIO_SIGNAL_CLASS()
#define	AGS_AUDIO_SIGNAL_GET_CLASS()
#define	AGS_IS_AUDIO_SIGNAL()
GType	ags_audio_signal_get_type ()

Properties

guint	attack	Read / Write
guint	buffer-size	Read / Write
AgsComplex *	damping	Read / Write
gdouble	delay	Read / Write
guint	first-frame	Read / Write
guint	format	Read / Write
guint	frame-count	Read / Write
GObject *	input-soundcard	Read / Write
gint	input-soundcard-channel	Read / Write
guint	last-frame	Read / Write
guint	length	Read / Write
guint	loop-end	Read / Write
guint	loop-start	Read / Write
gpointer	note	Read / Write
GObject *	output-soundcard	Read / Write
gint	output-soundcard-channel	Read / Write
AgsRecallID *	recall-id	Read / Write
AgsRecycling *	recycling	Read / Write
AgsAudioSignal *	rt-template	Read / Write
guint	samplerate	Read / Write
gpointer	stream	Read
gpointer	stream-current	Read
gpointer	stream-end	Read
AgsAudioSignal *	template	Read / Write
guint	timbre-end	Read / Write
guint	timbre-start	Read / Write
AgsComplex *	vibration	Read / Write
guint	word-size	Read

Signals

void	add-note	Run Last
void	refresh-data	Run Last
void	remove-note	Run Last

Types and Values

enum	AgsAudioSignalFlags
#define	AGS_TYPE_AUDIO_SIGNAL
struct	AgsAudioSignal
struct	AgsAudioSignalClass

Object Hierarchy

    GObject
    ╰── AgsAudioSignal

Implemented Interfaces

AgsAudioSignal implements AgsConnectable.

Includes

#include <ags/audio/ags_audio_signal.h>

Description

AgsAudioSignal organizes audio data within a GList whereby data pointing to the buffer.

Functions

AGS_AUDIO_SIGNAL_GET_OBJ_MUTEX()

#define AGS_AUDIO_SIGNAL_GET_OBJ_MUTEX(obj) (((AgsAudioSignal *) obj)->obj_mutex)

AGS_AUDIO_SIGNAL_GET_STREAM_MUTEX()

#define AGS_AUDIO_SIGNAL_GET_STREAM_MUTEX(obj) (((AgsAudioSignal *) obj)->stream_mutex)

ags_audio_signal_get_class_mutex ()

pthread_mutex_t *
ags_audio_signal_get_class_mutex ();

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

Returns

the class mutex

Since: 2.0.0

ags_audio_signal_test_flags ()

gboolean
ags_audio_signal_test_flags (AgsAudioSignal *audio_signal,
                             guint flags);

Test flags to be set on audio_signal .

Parameters

audio_signal	the AgsAudioSignal
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 2.0.0

ags_audio_signal_set_flags ()

void
ags_audio_signal_set_flags (AgsAudioSignal *audio_signal,
                            guint flags);

Enable a feature of audio_signal .

Parameters

audio_signal	the AgsAudioSignal
flags	see AgsAudioSignalFlags

Since: 2.0.0

ags_audio_signal_unset_flags ()

void
ags_audio_signal_unset_flags (AgsAudioSignal *audio_signal,
                              guint flags);

Disable a feature of audio_signal .

Parameters

audio_signal	the AgsAudioSignal
flags	see AgsAudioSignalFlags

Since: 2.0.0

ags_stream_alloc ()

void *
ags_stream_alloc (guint buffer_size,
                  guint format);

Allocs an audio buffer.

Parameters

buffer_size	the buffer size
format	the format

Returns

the audio data array

Since: 2.0.0

ags_stream_free ()

void
ags_stream_free (void *buffer);

Frees an audio buffer.

Parameters

buffer_size

the buffer size

Since: 2.0.0

ags_audio_signal_set_output_soundcard ()

void
ags_audio_signal_set_output_soundcard (AgsAudioSignal *audio_signal,
                                       GObject *output_soundcard);

Set output soundcarod of audio_signal .

Parameters

audio_signal	the AgsAudioSignal
output_soundcard	the GObject implementing AgsSoundcard

Since: 2.0.0

ags_audio_signal_set_input_soundcard ()

void
ags_audio_signal_set_input_soundcard (AgsAudioSignal *audio_signal,
                                      GObject *input_soundcard);

Set input soundcarod of audio_signal .

Parameters

audio_signal	the AgsAudioSignal
input_soundcard	the GObject implementing AgsSoundcard

Since: 2.0.0

ags_audio_signal_set_samplerate ()

void
ags_audio_signal_set_samplerate (AgsAudioSignal *audio_signal,
                                 guint samplerate);

Set samplerate.

Parameters

audio_signal	the AgsAudioSignal
samplerate	the samplerate

Since: 2.0.0

ags_audio_signal_set_buffer_size ()

void
ags_audio_signal_set_buffer_size (AgsAudioSignal *audio_signal,
                                  guint buffer_size);

Set buffer size.

Parameters

audio_signal	the AgsAudioSignal
buffer_size	the buffer size

Since: 2.0.0

ags_audio_signal_set_format ()

void
ags_audio_signal_set_format (AgsAudioSignal *audio_signal,
                             guint format);

Set format.

Parameters

audio_signal	the AgsAudioSignal
format	the format

Since: 2.0.0

ags_audio_signal_add_note ()

void
ags_audio_signal_add_note (AgsAudioSignal *audio_signal,
                           GObject *note);

Add note to audio_signal .

Parameters

audio_signal	the AgsAudioSignal
note	the AgsNote

Since: 2.0.0

ags_audio_signal_remove_note ()

void
ags_audio_signal_remove_note (AgsAudioSignal *audio_signal,
                              GObject *note);

Remove note from audio_signal .

Parameters

audio_signal	the AgsAudioSignal
note	the AgsNote

Since: 2.0.0

ags_audio_signal_refresh_data ()

void
ags_audio_signal_refresh_data (AgsAudioSignal *audio_signal);

ags_audio_signal_add_stream ()

void
ags_audio_signal_add_stream (AgsAudioSignal *audio_signal);

Adds a buffer at the end of the stream.

Parameters

audio_signal

the AgsAudioSignal

Since: 2.0.0

ags_audio_signal_stream_resize ()

void
ags_audio_signal_stream_resize (AgsAudioSignal *audio_signal,
                                guint length);

Resize stream of audio_signal to length number of buffers.

Parameters

audio_signal	the AgsAudioSignal
length	the new length

Since: 2.0.0

ags_audio_signal_stream_safe_resize ()

void
ags_audio_signal_stream_safe_resize (AgsAudioSignal *audio_signal,
                                     guint length);

Resize stream of audio_signal to length number of buffers. But doesn't shrink more than the current stream position.

Parameters

audio_signal	the AgsAudioSignal
length	the new length

Since: 2.0.0

ags_audio_signal_duplicate_stream ()

void
ags_audio_signal_duplicate_stream (AgsAudioSignal *audio_signal,
                                   AgsAudioSignal *template);

Apply template audio data to audio_signal . Note should only be invoked by proper recall context because only the stream of template is locked.

Parameters

audio_signal	the AgsAudioSignal
template	the template AgsAudioSignal

Since: 2.0.0

ags_audio_signal_feed ()

void
ags_audio_signal_feed (AgsAudioSignal *audio_signal,
                       AgsAudioSignal *template,
                       guint frame_count);

Feed audio signal to grow upto frame count.

Parameters

audio_signal	the AgsAudioSignal
template	the template AgsAudioSignal
frame_count	the new frame count

Since: 2.0.0

ags_audio_signal_get_length_till_current ()

guint
ags_audio_signal_get_length_till_current
                               (AgsAudioSignal *audio_signal);

Counts the buffers from :stream upto :stream-current.

Parameters

audio_signal

the AgsAudioSignal

Returns

the counted length.

Since: 2.0.0

ags_audio_signal_get_template ()

AgsAudioSignal *
ags_audio_signal_get_template (GList *audio_signal);

Retrieve the template audio signal.

Parameters

audio_signal

the GList containing AgsAudioSignal

Returns

the template AgsAudioSignal or NULL if not found

Since: 2.0.0

ags_audio_signal_get_rt_template ()

GList *
ags_audio_signal_get_rt_template (GList *audio_signal);

Retrieve the realtime template audio signal.

Parameters

audio_signal

a GList containing AgsAudioSignal

Returns

the rt-templates as GList containing AgsAudioSignal

Since: 2.0.0

ags_audio_signal_find_stream_current ()

GList *
ags_audio_signal_find_stream_current (GList *audio_signal,
                                      GObject *recall_id);

Retrieve next current stream of AgsAudioSignal list. Warning this function does not lock the stream mutex.

Parameters

audio_signal	the GList containing AgsAudioSignal
recall_id	the matching AgsRecallID

Returns

next GList matching AgsRecallID

Since: 2.0.0

ags_audio_signal_find_by_recall_id ()

GList *
ags_audio_signal_find_by_recall_id (GList *audio_signal,
                                    GObject *recall_id);

Retrieve next audio signal refering to recall_id

Parameters

audio_signal	a GList containing AgsAudioSignal
recall_id	matching AgsRecallID

Returns

matching AgsAudioSignal

Since: 2.0.0

ags_audio_signal_is_active ()

gboolean
ags_audio_signal_is_active (GList *audio_signal,
                            GObject *recall_id);

Check if is active.

Parameters

audio_signal	the GList containing AgsAudioSignal
recall_id	the AgsRecallID

Returns

TRUE if related audio signal to recall id is available, otherwise FALSE

Since: 2.0.0

ags_audio_signal_new ()

AgsAudioSignal *
ags_audio_signal_new (GObject *output_soundcard,
                      GObject *recycling,
                      GObject *recall_id);

Creates a AgsAudioSignal, with defaults of output_soundcard , linking recycling tree and refering to recall_id .

Parameters

output_soundcard	the assigned output AgsSoundcard
recycling	the AgsRecycling
recall_id	the AgsRecallID, it can be NULL if `AGS_AUDIO_SIGNAL_TEMPLATE` is set

Returns

a new AgsAudioSignal

Since: 2.0.0

ags_audio_signal_new_with_length ()

AgsAudioSignal *
ags_audio_signal_new_with_length (GObject *output_soundcard,
                                  GObject *recycling,
                                  GObject *recall_id,
                                  guint length);

Creates a AgsAudioSignal, with defaults of soundcard , linking recycling tree and refering to recall_id . The audio data is tiled to length frame count.

Parameters

output_soundcard	the assigned output AgsSoundcard
recycling	the AgsRecycling
recall_id	the AgsRecallID, it can be NULL if `AGS_AUDIO_SIGNAL_TEMPLATE` is set
length	audio data frame count

Returns

a new AgsAudioSignal

Since: 2.0.0

AGS_AUDIO_SIGNAL()

#define AGS_AUDIO_SIGNAL(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_AUDIO_SIGNAL, AgsAudioSignal))

AGS_AUDIO_SIGNAL_CLASS()

#define AGS_AUDIO_SIGNAL_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_AUDIO_SIGNAL, AgsAudioSignalClass))

AGS_AUDIO_SIGNAL_GET_CLASS()

#define AGS_AUDIO_SIGNAL_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_AUDIO_SIGNAL, AgsAudioSignalClass))

AGS_IS_AUDIO_SIGNAL()

#define AGS_IS_AUDIO_SIGNAL(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_AUDIO_SIGNAL))

ags_audio_signal_get_type ()

GType
ags_audio_signal_get_type ();

Types and Values

enum AgsAudioSignalFlags

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

Members

AGS_AUDIO_SIGNAL_ADDED_TO_REGISTRY	the audio signal was added to registry, see `AgsConnectable::add_to_registry()`
AGS_AUDIO_SIGNAL_CONNECTED	indicates the audio signal was connected by calling `AgsConnectable::connect()`
AGS_AUDIO_SIGNAL_TEMPLATE	the audio signal acts as a template
AGS_AUDIO_SIGNAL_RT_TEMPLATE	the audio signal acts as a realtime template

AGS_TYPE_AUDIO_SIGNAL

#define AGS_TYPE_AUDIO_SIGNAL                (ags_audio_signal_get_type())

struct AgsAudioSignal

struct AgsAudioSignal;

struct AgsAudioSignalClass

struct AgsAudioSignalClass {
  GObjectClass object;

  void (*add_note)(AgsAudioSignal *audio_signal,
		   GObject *note);
  void (*remove_note)(AgsAudioSignal *audio_signal,
		      GObject *note);

  void (*refresh_data)(AgsAudioSignal *audio_signal);
};

Property Details

The `“attack”` property

  “attack”                   guint

The attack to be used.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“buffer-size”` property

  “buffer-size”              guint

The buffer size to be used.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“damping”` property

  “damping”                  AgsComplex *

Damping of timbre.

Flags: Read / Write

Since: 2.0.0

The `“delay”` property

  “delay”                    gdouble

The delay to be used.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 2.0.0

The `“first-frame”` property

  “first-frame”              guint

The first frame of stream.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“format”` property

  “format”                   guint

The format to be used.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“frame-count”` property

  “frame-count”              guint

The initial size of audio data.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“input-soundcard”` property

  “input-soundcard”          GObject *

The assigned input AgsSoundcard.

Flags: Read / Write

Since: 2.0.0

The `“input-soundcard-channel”` property

  “input-soundcard-channel”  gint

The input soundcard channel.

Flags: Read / Write

Allowed values: >= -1

Default value: 0

Since: 2.0.0

The `“last-frame”` property

  “last-frame”               guint

The last frame of stream.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“length”` property

  “length”                   guint

The length of the stream.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“loop-end”` property

  “loop-end”                 guint

The loop end of stream.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“loop-start”` property

  “loop-start”               guint

The loop start of stream.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“note”` property

  “note”                     gpointer

The assigned AgsNote providing default settings.

Flags: Read / Write

Since: 2.0.0

The `“output-soundcard”` property

  “output-soundcard”         GObject *

The assigned output AgsSoundcard providing default settings.

Flags: Read / Write

Since: 2.0.0

The `“output-soundcard-channel”` property

  “output-soundcard-channel” gint

The output soundcard channel.

Flags: Read / Write

Allowed values: >= -1

Default value: 0

Since: 2.0.0

The `“recall-id”` property

  “recall-id”                AgsRecallID *

The assigned AgsRecallID providing context.

Flags: Read / Write

Since: 2.0.0

The `“recycling”` property

  “recycling”                AgsRecycling *

The assigned AgsRecycling linking tree.

Flags: Read / Write

Since: 2.0.0

The `“rt-template”` property

  “rt-template”              AgsAudioSignal *

The assigned AgsAudioSignal realtime template.

Flags: Read / Write

Since: 2.0.0

The `“samplerate”` property

  “samplerate”               guint

The samplerate to be used.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“stream”` property

  “stream”                   gpointer

The stream it contains.

Flags: Read

Since: 2.0.0

The `“stream-current”` property

  “stream-current”           gpointer

The current stream.

Flags: Read

Since: 2.0.0

The `“stream-end”` property

  “stream-end”               gpointer

The end of stream.

Flags: Read

Since: 2.0.0

The `“template”` property

  “template”                 AgsAudioSignal *

The assigned AgsAudioSignal template.

Flags: Read / Write

Since: 2.0.0

The `“timbre-end”` property

  “timbre-end”               guint

The timbre's end frame.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“timbre-start”` property

  “timbre-start”             guint

The timbre's start frame.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“vibration”` property

  “vibration”                AgsComplex *

Vibration of timbre.

Flags: Read / Write

Since: 2.0.0

The `“word-size”` property

  “word-size”                guint

The word size of frame.

Flags: Read

Default value: 0

Since: 2.0.0

Signal Details

The `“add-note”` signal

void
user_function (AgsAudioSignal *audio_signal,
               GObject        *note,
               gpointer        user_data)

The ::add-note signal notifies about adding note .

Parameters

audio_signal	the AgsAudioSignal
note	the AgsNote
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0

The `“refresh-data”` signal

void
user_function (AgsAudioSignal *audio_signal,
               gpointer        user_data)

The ::refresh-data signal notifies about requesting to refresh data.

Parameters

audio_signal	the AgsAudioSignal
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0

The `“remove-note”` signal

void
user_function (AgsAudioSignal *audio_signal,
               GObject        *note,
               gpointer        user_data)

The ::remove-note signal notifies about removing note .

Parameters

audio_signal	the AgsAudioSignal
note	the AgsNote
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 2.0.0