AgsWave

AgsWave — Wave class supporting selection and clipboard.

Functions

void ags_wave_set_samplerate ()
void ags_wave_set_buffer_size ()
void ags_wave_set_format ()
GList * ags_wave_find_near_timestamp ()
GList * ags_wave_add ()
void ags_wave_add_buffer ()
void ags_wave_remove_buffer ()
GList * ags_wave_get_selection ()
gboolean ags_wave_is_buffer_selected ()
GList * ags_wave_find_region ()
void ags_wave_free_selection ()
void ags_wave_add_region_to_selection ()
void ags_wave_remove_region_from_selection ()
void ags_wave_add_all_to_selection ()
xmlNode * ags_wave_copy_selection ()
xmlNode * ags_wave_cut_selection ()
void ags_wave_insert_from_clipboard ()
void ags_wave_insert_from_clipboard_extended ()
AgsWave * ags_wave_new ()
#define AGS_IS_WAVE()
#define AGS_WAVE()
#define AGS_WAVE_CLASS()
#define AGS_WAVE_GET_CLASS()
GType ags_wave_get_type ()

Properties

AgsAudio * audio Read / Write
guint audio-channel Read / Write
AgsBuffer * buffer Read / Write
guint buffer-size Read / Write
guint format Read / Write
guint samplerate Read / Write
AgsTimestamp * timestamp Read / Write

Types and Values

#define AGS_WAVE_DEFAULT_BPM
#define AGS_WAVE_TICS_PER_BEAT
#define AGS_WAVE_MINIMUM_BUFFER_LENGTH
#define AGS_WAVE_DEFAULT_LENGTH
#define AGS_WAVE_DEFAULT_JIFFIE
#define AGS_WAVE_DEFAULT_DURATION
#define AGS_WAVE_DEFAULT_OFFSET
#define AGS_WAVE_CLIPBOARD_VERSION
#define AGS_WAVE_CLIPBOARD_TYPE
#define AGS_WAVE_CLIPBOARD_FORMAT
enum AgsWaveFlags
#define AGS_TYPE_WAVE
struct AgsWave
struct AgsWaveClass

Object Hierarchy

    GObject
    ╰── AgsWave

Implemented Interfaces

AgsWave implements AgsConnectable.

Includes

#include <ags/audio/ags_wave.h>

Description

AgsWave acts as a container of AgsBuffer.

Functions

ags_wave_set_samplerate ()

void
ags_wave_set_samplerate (AgsWave *wave,
                         guint samplerate);

Set samplerate.

Parameters

wave

the AgsWave

  

samplerate

the samplerate

  

Since: 1.4.0

ags_wave_set_buffer_size ()

void
ags_wave_set_buffer_size (AgsWave *wave,
                          guint buffer_size);

Set buffer size.

Parameters

wave

the AgsWave

  

Since: 1.4.0

ags_wave_set_format ()

void
ags_wave_set_format (AgsWave *wave,
                     guint format);

Set format.

Parameters

wave

the AgsWave

  

format

the format

  

Since: 1.4.0

ags_wave_find_near_timestamp ()

GList *
ags_wave_find_near_timestamp (GList *wave,
                              guint audio_channel,
                              AgsTimestamp *timestamp);

Retrieve appropriate wave for timestamp.

Parameters

wave

a GList containing AgsWave

  

audio_channel

the matching audio channel

  

timestamp

the matching timestamp, or NULL to match any timestamp.

[allow-none]

Returns

Next match.

Since: 1.4.0

ags_wave_add ()

GList *
ags_wave_add (GList *wave,
              AgsWave *new_wave);

Add new_wave sorted to wave

Parameters

wave

the GList containing AgsWave

  

new_wave

the wave to add

  

Returns

the new beginning of wave

Since: 1.4.0

ags_wave_add_buffer ()

void
ags_wave_add_buffer (AgsWave *wave,
                     AgsBuffer *buffer,
                     gboolean use_selection_list);

Adds a buffer to wave.

Parameters

wave

an AgsWave

  

buffer

the AgsBuffer to add

  

use_selection_list

if TRUE add to selection, else to default wave

  

Since: 1.4.0

ags_wave_remove_buffer ()

void
ags_wave_remove_buffer (AgsWave *wave,
                        AgsBuffer *buffer,
                        gboolean use_selection_list);

Removes a buffer from wave.

Parameters

wave

an AgsWave

  

buffer

the AgsBuffer to remove

  

use_selection_list

if TRUE remove from selection, else from default wave

  

Since: 1.4.0

ags_wave_get_selection ()

GList *
ags_wave_get_selection (AgsWave *wave);

Retrieve selection.

Parameters

wave

the AgsWave

  

Returns

the selection.

Since: 1.4.0

ags_wave_is_buffer_selected ()

gboolean
ags_wave_is_buffer_selected (AgsWave *wave,
                             AgsBuffer *buffer);

Check selection for buffer.

Parameters

wave

the AgsWave

  

buffer

the AgsBuffer to check for

  

Returns

TRUE if selected

Since: 1.4.0

ags_wave_find_region ()

GList *
ags_wave_find_region (AgsWave *wave,
                      guint x0,
                      guint x1,
                      gboolean use_selection_list);

Find buffers by offset and tone region.

Parameters

wave

an AgsWave

  

x0

start offset

  

x1

end offset

  

use_selection_list

if TRUE selection is searched

  

Returns

the matching buffers as GList.

Since: 1.4.0

ags_wave_free_selection ()

void
ags_wave_free_selection (AgsWave *wave);

Clear selection.

Parameters

wave

an AgsWave

  

Since: 1.4.0

ags_wave_add_region_to_selection ()

void
ags_wave_add_region_to_selection (AgsWave *wave,
                                  guint x0,
                                  guint x1,
                                  gboolean replace_current_selection);

Select buffers within region.

Parameters

wave

an AgsWave

  

x0

start offset

  

x1

end offset

  

replace_current_selection

if TRUE selection is replaced

  

Since: 1.4.0

ags_wave_remove_region_from_selection ()

void
ags_wave_remove_region_from_selection (AgsWave *wave,
                                       guint x0,
                                       guint x1);

Remove buffers within region of selection.

Parameters

wave

an AgsWave

  

x0

start offset

  

y0

start tone

  

x1

end offset

  

y1

end tone

  

Since: 1.4.0

ags_wave_add_all_to_selection ()

void
ags_wave_add_all_to_selection (AgsWave *wave);

Select all.

Parameters

wave

an AgsWave

  

Since: 1.4.0

ags_wave_copy_selection ()

xmlNode *
ags_wave_copy_selection (AgsWave *wave);

Copy selection to clipboard.

Parameters

wave

an AgsWave

  

Returns

the selection as XML.

Since: 1.4.0

ags_wave_cut_selection ()

xmlNode *
ags_wave_cut_selection (AgsWave *wave);

Cut selection to clipboard.

Parameters

wave

an AgsWave

  

Returns

the selection as XML.

Since: 1.4.0

ags_wave_insert_from_clipboard ()

void
ags_wave_insert_from_clipboard (AgsWave *wave,
                                xmlNode *wave_node,
                                gboolean reset_x_offset,
                                guint x_offset,
                                gdouble delay,
                                guint attack);

Paste previously copied buffers.

Parameters

wave

an AgsWave

  

wave_node

the clipboard XML data

  

reset_x_offset

if TRUE x_offset used as cursor

  

x_offset

region start cursor offset

  

delay

the delay to be used

  

attack

the attack to be used

  

Since: 1.4.0

ags_wave_insert_from_clipboard_extended ()

void
ags_wave_insert_from_clipboard_extended
                               (AgsWave *wave,
                                xmlNode *wave_node,
                                gboolean reset_x_offset,
                                guint x_offset,
                                gdouble delay,
                                guint attack,
                                gboolean match_audio_channel,
                                gboolean do_replace);

Paste previously copied buffers.

Parameters

wave

an AgsWave

  

wave_node

the clipboard XML data

  

reset_x_offset

if TRUE x_offset used as cursor

  

x_offset

region start cursor offset

  

delay

the delay to be used

  

attack

the attack to be used

  

match_channel

only paste if channel matches

  

do_replace

if TRUE current data is replaced, otherwise additive mixing is performed

 

Since: 1.4.0

ags_wave_new ()

AgsWave *
ags_wave_new (GObject *audio,
              guint audio_channel);

Creates a AgsWave, assigned to audio_channel .

Parameters

audio

the assigned AgsAudio

  

audio_channel

the audio channel to be used

  

Returns

a new AgsWave

Since: 1.4.0

AGS_IS_WAVE()

#define AGS_IS_WAVE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_WAVE))

AGS_WAVE()

#define AGS_WAVE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_WAVE, AgsWave))

AGS_WAVE_CLASS()

#define AGS_WAVE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_WAVE, AgsWaveClass))

AGS_WAVE_GET_CLASS()

#define AGS_WAVE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS (obj, AGS_TYPE_WAVE, AgsWaveClass))

ags_wave_get_type ()

GType
ags_wave_get_type (void);

Types and Values

AGS_WAVE_DEFAULT_BPM

#define AGS_WAVE_DEFAULT_BPM (120.0)

AGS_WAVE_TICS_PER_BEAT

#define AGS_WAVE_TICS_PER_BEAT (1.0)

AGS_WAVE_MINIMUM_BUFFER_LENGTH

#define AGS_WAVE_MINIMUM_BUFFER_LENGTH (1.0 / 16.0)

AGS_WAVE_DEFAULT_LENGTH

#define AGS_WAVE_DEFAULT_LENGTH (65535.0 / AGS_WAVE_TICS_PER_BEAT - AGS_WAVE_MINIMUM_BUFFER_LENGTH)

AGS_WAVE_DEFAULT_JIFFIE

#define AGS_WAVE_DEFAULT_JIFFIE (60.0 / AGS_WAVE_DEFAULT_BPM / AGS_WAVE_TICS_PER_BEAT)

AGS_WAVE_DEFAULT_DURATION

#define AGS_WAVE_DEFAULT_DURATION (AGS_WAVE_DEFAULT_LENGTH * AGS_WAVE_DEFAULT_JIFFIE * AGS_MICROSECONDS_PER_SECOND)

AGS_WAVE_DEFAULT_OFFSET

#define AGS_WAVE_DEFAULT_OFFSET (64 * (1 / AGS_WAVE_MINIMUM_BUFFER_LENGTH))

AGS_WAVE_CLIPBOARD_VERSION

#define AGS_WAVE_CLIPBOARD_VERSION "1.4.0"

AGS_WAVE_CLIPBOARD_TYPE

#define AGS_WAVE_CLIPBOARD_TYPE "AgsWaveClipboardXml"

AGS_WAVE_CLIPBOARD_FORMAT

#define AGS_WAVE_CLIPBOARD_FORMAT "AgsWaveNativeLevel"

enum AgsWaveFlags

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

Members

AGS_WAVE_CONNECTED

indicates the wave was connected by calling AgsConnectable::connect()

  

AGS_TYPE_WAVE

#define AGS_TYPE_WAVE                (ags_wave_get_type())

struct AgsWave

struct AgsWave;

struct AgsWaveClass

struct AgsWaveClass {
  GObjectClass gobject;
};

Property Details

The “audio” property

  “audio”                    AgsAudio *

The assigned AgsAudio

Flags: Read / Write

Since: 1.4.0

The “audio-channel” property

  “audio-channel”            guint

The effect's audio-channel.

Flags: Read / Write

Allowed values: <= 65535

Default value: 0

Since: 1.4.0

The “buffer” property

  “buffer”                   AgsBuffer *

The assigned AgsBuffer

Flags: Read / Write

Since: 1.4.0

The “buffer-size” property

  “buffer-size”              guint

The audio buffer's buffer size.

Flags: Read / Write

Default value: 1024

Since: 1.4.0

The “format” property

  “format”                   guint

The audio buffer's format.

Flags: Read / Write

Default value: 16

Since: 1.4.0

The “samplerate” property

  “samplerate”               guint

The audio buffer's samplerate.

Flags: Read / Write

Default value: 48000

Since: 1.4.0

The “timestamp” property

  “timestamp”                AgsTimestamp *

The timestamp of pattern.

Flags: Read / Write

Generated by GTK-Doc V1.27