AgsAudioFile: Advanced Gtk+ Sequencer Audio Reference Manual

AgsAudioFile

AgsAudioFile — Audio file input/output

Functions

#define	AGS_AUDIO_FILE_GET_OBJ_MUTEX()
pthread_mutex_t *	ags_audio_file_get_class_mutex ()
gboolean	ags_audio_file_test_flags ()
void	ags_audio_file_set_flags ()
void	ags_audio_file_unset_flags ()
gboolean	ags_audio_file_check_suffix ()
void	ags_audio_file_add_audio_signal ()
void	ags_audio_file_remove_audio_signal ()
void	ags_audio_file_add_wave ()
void	ags_audio_file_remove_wave ()
gboolean	ags_audio_file_open ()
gboolean	ags_audio_file_open_from_data ()
gboolean	ags_audio_file_rw_open ()
void	ags_audio_file_close ()
void *	ags_audio_file_read ()
void	ags_audio_file_read_audio_signal ()
void	ags_audio_file_read_wave ()
void	ags_audio_file_seek ()
void	ags_audio_file_write ()
void	ags_audio_file_flush ()
AgsAudioFile *	ags_audio_file_new ()
#define	AGS_AUDIO_FILE()
#define	AGS_AUDIO_FILE_CLASS()
#define	AGS_AUDIO_FILE_GET_CLASS()
#define	AGS_IS_AUDIO_FILE()
GType	ags_audio_file_get_type ()

Properties

gint	audio-channel	Read / Write
gpointer	audio-signal	Read / Write
guint	buffer-size	Read / Write
guint	file-audio-channels	Read / Write
guint	file-frame-count	Read / Write
guint	file-samplerate	Read / Write
gchar *	filename	Read / Write
guint	format	Read / Write
guint	samplerate	Read / Write
GObject *	soundcard	Read / Write
gpointer	wave	Read / Write

Types and Values

enum	AgsAudioFileFlags
#define	AGS_TYPE_AUDIO_FILE
struct	AgsAudioFile
struct	AgsAudioFileClass

Object Hierarchy

    GObject
    ╰── AgsAudioFile

Implemented Interfaces

AgsAudioFile implements AgsConnectable.

Includes

#include <ags/audio/file/ags_audio_file.h>

Description

AgsAudioFile is the base object to read/write audio data.

Functions

AGS_AUDIO_FILE_GET_OBJ_MUTEX()

#define AGS_AUDIO_FILE_GET_OBJ_MUTEX(obj) (((AgsAudioFile *) obj)->obj_mutex)

ags_audio_file_get_class_mutex ()

pthread_mutex_t *
ags_audio_file_get_class_mutex ();

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

Returns

the class mutex

Since: 2.0.36

ags_audio_file_test_flags ()

gboolean
ags_audio_file_test_flags (AgsAudioFile *audio_file,
                           guint flags);

Test flags to be set on audio_file .

Parameters

audio_file	the AgsAudioFile
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 2.0.36

ags_audio_file_set_flags ()

void
ags_audio_file_set_flags (AgsAudioFile *audio_file,
                          guint flags);

Enable a feature of audio_file .

Parameters

audio_file	the AgsAudioFile
flags	see AgsAudioFileFlags

Since: 2.0.36

ags_audio_file_unset_flags ()

void
ags_audio_file_unset_flags (AgsAudioFile *audio_file,
                            guint flags);

Disable a feature of audio_file .

Parameters

audio_file	the AgsAudioFile
flags	see AgsAudioFileFlags

Since: 2.0.36

ags_audio_file_check_suffix ()

gboolean
ags_audio_file_check_suffix (gchar *filename);

Check suffix.

Parameters

filename

the filename

Returns

TRUE if suffix supported, else FALSE

Since: 2.0.0

ags_audio_file_add_audio_signal ()

void
ags_audio_file_add_audio_signal (AgsAudioFile *audio_file,
                                 GObject *audio_signal);

Add audio_signal to audio_file .

Parameters

audio_file	the AgsAudioFile
audio_signal	the AgsAudioSignal

Since: 2.0.0

ags_audio_file_remove_audio_signal ()

void
ags_audio_file_remove_audio_signal (AgsAudioFile *audio_file,
                                    GObject *audio_signal);

Remove audio_signal from audio_file .

Parameters

audio_file	the AgsAudioFile
audio_signal	the AgsAudioSignal

Since: 2.0.0

ags_audio_file_add_wave ()

void
ags_audio_file_add_wave (AgsAudioFile *audio_file,
                         GObject *wave);

Add wave to audio_file .

Parameters

audio_file	the AgsAudioFile
wave	the AgsWave

Since: 2.0.0

ags_audio_file_remove_wave ()

void
ags_audio_file_remove_wave (AgsAudioFile *audio_file,
                            GObject *wave);

Remove wave from audio_file .

Parameters

audio_file	the AgsAudioFile
wave	the AgsWave

Since: 2.0.0

ags_audio_file_open ()

gboolean
ags_audio_file_open (AgsAudioFile *audio_file);

Open the AgsAudioFile in read mode.

Parameters

audio_file

the AgsAudioFile

Returns

TRUE on success, otherwise FALSE

Since: 2.0.0

ags_audio_file_open_from_data ()

gboolean
ags_audio_file_open_from_data (AgsAudioFile *audio_file,
                               gchar *data);

Open AgsAudioFile using virtual functions.

Parameters

audio_file	the AgsAudioFile
data	the audio data

Returns

TRUE on success, otherwise FALSE

Since: 2.0.0

ags_audio_file_rw_open ()

gboolean
ags_audio_file_rw_open (AgsAudioFile *audio_file,
                        gboolean create);

Open the AgsAudioFile in read/write mode.

Parameters

audio_file	the AgsAudioFile
create	create the file

Returns

TRUE on success, otherwise FALSE

Since: 2.0.0

ags_audio_file_close ()

void
ags_audio_file_close (AgsAudioFile *audio_file);

Close the AgsAudioFile.

Parameters

audio_file

the AgsAudioFile

Since: 2.0.0

ags_audio_file_read ()

void *
ags_audio_file_read (AgsAudioFile *audio_file,
                     guint audio_channel,
                     guint format,
                     GError **error);

Read audio buffer.

Parameters

audio_file	the AgsAudioFile
audio_channel	nth channel
format	the format
error	returned error

Since: 2.0.0

ags_audio_file_read_audio_signal ()

void
ags_audio_file_read_audio_signal (AgsAudioFile *audio_file);

Convert the AgsAudioFile to a GList of AgsAudioSignal.

Parameters

audio_file

the AgsAudioFile

Since: 2.0.0

ags_audio_file_read_wave ()

void
ags_audio_file_read_wave (AgsAudioFile *audio_file,
                          guint64 x_offset,
                          gdouble delay,
                          guint attack);

Convert the AgsAudioFile to a GList of buffers.

Parameters

audio_file

the AgsAudioFile

Since: 2.0.0

ags_audio_file_seek ()

void
ags_audio_file_seek (AgsAudioFile *audio_file,
                     guint frames,
                     gint whence);

Position the AgsAudioFile's internal data address.

Parameters

audio_file	the AgsAudioFile
frames	number of frames to seek
whence	SEEK_SET, SEEK_CUR, or SEEK_END

Since: 2.0.0

ags_audio_file_write ()

void
ags_audio_file_write (AgsAudioFile *audio_file,
                      void *buffer,
                      guint buffer_size,
                      guint format);

Write the buffer to AgsAudioFile.

Parameters

audio_file	the AgsAudioFile
buffer	the audio data
buffer_size	the count of frames to write
format	the format

Since: 2.0.0

ags_audio_file_flush ()

void
ags_audio_file_flush (AgsAudioFile *audio_file);

Flushes the AgsAudioFile's internal buffer.

Parameters

audio_file

the AgsAudioFile

Since: 2.0.0

ags_audio_file_new ()

AgsAudioFile *
ags_audio_file_new (gchar *filename,
                    GObject *soundcard,
                    gint audio_channel);

Create a new instance of AgsAudioFile.

Parameters

filename	the filename
soundcard	defaults of AgsSoundcard
audio_channel	the audio channel to read

Returns

the new AgsAudioFile.

Since: 2.0.0

AGS_AUDIO_FILE()

#define AGS_AUDIO_FILE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_AUDIO_FILE, AgsAudioFile))

AGS_AUDIO_FILE_CLASS()

#define AGS_AUDIO_FILE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_AUDIO_FILE, AgsAudioFileClass))

AGS_AUDIO_FILE_GET_CLASS()

#define AGS_AUDIO_FILE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_AUDIO_FILE, AgsAudioFileClass))

AGS_IS_AUDIO_FILE()

#define AGS_IS_AUDIO_FILE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_AUDIO_FILE))

ags_audio_file_get_type ()

GType
ags_audio_file_get_type ();

Types and Values

enum AgsAudioFileFlags

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

Members

AGS_AUDIO_FILE_ADDED_TO_REGISTRY	the audio file was added to registry, see `AgsConnectable::add_to_registry()`
AGS_AUDIO_FILE_CONNECTED	indicates the audio file was connected by calling `AgsConnectable::connect()`

AGS_TYPE_AUDIO_FILE

#define AGS_TYPE_AUDIO_FILE                (ags_audio_file_get_type())

struct AgsAudioFile

struct AgsAudioFile;

struct AgsAudioFileClass

struct AgsAudioFileClass {
  GObjectClass object;
};

Property Details

The `“audio-channel”` property

  “audio-channel”            gint

The audio channel to be read.

Flags: Read / Write

Allowed values: >= -1

Default value: 0

Since: 2.0.0

The `“audio-signal”` property

  “audio-signal”             gpointer

The containing AgsAudioSignal.

Flags: Read / Write

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 `“file-audio-channels”` property

  “file-audio-channels”      guint

The audio channel count of this file.

Flags: Read / Write

Default value: 0

Since: 2.0.0

The `“file-frame-count”` property

  “file-frame-count”         guint

The frame count of the file.

Flags: Read / Write

Default value: 0

The `“file-samplerate”` property

  “file-samplerate”          guint

The samplerate of this file.

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 `“format”` property

  “format”                   guint

The format to be used.

Flags: Read / Write

Default value: 0

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 `“soundcard”` property

  “soundcard”                GObject *

The assigned soundcard.

Flags: Read / Write

Since: 2.0.0

The `“wave”` property

  “wave”                     gpointer

The containing AgsWave.

Flags: Read / Write

Since: 2.0.0

AgsAudioFile

Functions

Properties

Types and Values

Object Hierarchy

Implemented Interfaces

Includes

Description

Functions

AGS_AUDIO_FILE_GET_OBJ_MUTEX()

ags_audio_file_get_class_mutex ()

Returns

ags_audio_file_test_flags ()

Parameters

Returns

ags_audio_file_set_flags ()

Parameters

ags_audio_file_unset_flags ()

Parameters

ags_audio_file_check_suffix ()

Parameters

Returns

ags_audio_file_add_audio_signal ()

Parameters

ags_audio_file_remove_audio_signal ()

Parameters

ags_audio_file_add_wave ()

Parameters

ags_audio_file_remove_wave ()

Parameters

ags_audio_file_open ()

Parameters

Returns

ags_audio_file_open_from_data ()

Parameters

Returns

ags_audio_file_rw_open ()

Parameters

Returns

ags_audio_file_close ()

Parameters

ags_audio_file_read ()

Parameters

ags_audio_file_read_audio_signal ()

Parameters

ags_audio_file_read_wave ()

Parameters

ags_audio_file_seek ()

Parameters

ags_audio_file_write ()

Parameters

ags_audio_file_flush ()

Parameters

ags_audio_file_new ()

Parameters

Returns

AGS_AUDIO_FILE()

AGS_AUDIO_FILE_CLASS()

AGS_AUDIO_FILE_GET_CLASS()

AGS_IS_AUDIO_FILE()

ags_audio_file_get_type ()

Types and Values

enum AgsAudioFileFlags

Members

AGS_TYPE_AUDIO_FILE

struct AgsAudioFile

struct AgsAudioFileClass

Property Details

The “audio-channel” property

The “audio-signal” property

The “buffer-size” property

The “file-audio-channels” property

The “file-frame-count” property

The “file-samplerate” property

The “filename” property

The “format” property

The “samplerate” property

The “soundcard” property

The “wave” property

The `“audio-channel”` property

The `“audio-signal”` property

The `“buffer-size”` property

The `“file-audio-channels”` property

The `“file-frame-count”` property

The `“file-samplerate”` property

The `“filename”` property

The `“format”` property

The `“samplerate”` property

The `“soundcard”` property

The `“wave”` property