AgsSF2SynthGenerator

AgsSF2SynthGenerator — generate wave-form

Stability Level

Stable, unless otherwise indicated

Functions

#define AGS_SF2_SYNTH_GENERATOR_GET_OBJ_MUTEX()
GRecMutex * ags_sf2_synth_generator_get_obj_mutex ()
gboolean ags_sf2_synth_generator_test_flags ()
void ags_sf2_synth_generator_set_flags ()
void ags_sf2_synth_generator_unset_flags ()
gchar * ags_sf2_synth_generator_get_filename ()
void ags_sf2_synth_generator_set_filename ()
gchar * ags_sf2_synth_generator_get_preset ()
void ags_sf2_synth_generator_set_preset ()
gchar * ags_sf2_synth_generator_get_instrument ()
void ags_sf2_synth_generator_set_instrument ()
gint ags_sf2_synth_generator_get_bank ()
void ags_sf2_synth_generator_set_bank ()
gint ags_sf2_synth_generator_get_program ()
void ags_sf2_synth_generator_set_program ()
guint ags_sf2_synth_generator_get_samplerate ()
void ags_sf2_synth_generator_set_samplerate ()
guint ags_sf2_synth_generator_get_buffer_size ()
void ags_sf2_synth_generator_set_buffer_size ()
guint ags_sf2_synth_generator_get_format ()
void ags_sf2_synth_generator_set_format ()
guint ags_sf2_synth_generator_get_pitch_type ()
void ags_sf2_synth_generator_set_pitch_type ()
gdouble ags_sf2_synth_generator_get_delay ()
void ags_sf2_synth_generator_set_delay ()
guint ags_sf2_synth_generator_get_frame_count ()
void ags_sf2_synth_generator_set_frame_count ()
guint ags_sf2_synth_generator_get_loop_start ()
void ags_sf2_synth_generator_set_loop_start ()
guint ags_sf2_synth_generator_get_loop_end ()
void ags_sf2_synth_generator_set_loop_end ()
gdouble ags_sf2_synth_generator_get_base_key ()
void ags_sf2_synth_generator_set_base_key ()
gdouble ags_sf2_synth_generator_get_tuning ()
void ags_sf2_synth_generator_set_tuning ()
AgsTimestamp * ags_sf2_synth_generator_get_timestamp ()
void ags_sf2_synth_generator_set_timestamp ()
void ags_sf2_synth_generator_compute ()
void ags_sf2_synth_generator_compute_instrument ()
void ags_sf2_synth_generator_compute_midi_locale ()
AgsSF2SynthGenerator * ags_sf2_synth_generator_new ()

Properties

guint attack Read / Write
int bank Read / Write
double base-key Read / Write
guint buffer-size Read / Write
double delay Read / Write
char * filename Read / Write
guint format Read / Write
guint frame-count Read / Write
char * instrument Read / Write
guint loop-end Read / Write
guint loop-start Read / Write
guint pitch-type Read / Write
char * preset Read / Write
int program Read / Write
guint samplerate Read / Write
double tuning Read / Write
double volume Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsConversion
        ╰── AgsFunction
            ╰── AgsSF2SynthGenerator

Includes

#include <ags/file/ags_sf2_synth_generator.h>

Description

The AgsSF2SynthGenerator generates wave-forms with oscillators.

Functions

AGS_SF2_SYNTH_GENERATOR_GET_OBJ_MUTEX()

#define AGS_SF2_SYNTH_GENERATOR_GET_OBJ_MUTEX(obj) (&(((AgsSF2SynthGenerator *) obj)->obj_mutex))

ags_sf2_synth_generator_get_obj_mutex ()

GRecMutex *
ags_sf2_synth_generator_get_obj_mutex (AgsSF2SynthGenerator *sf2_synth_generator);

Get object mutex.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the GRecMutex to lock sf2_synth_generator

Since: 3.4.0


ags_sf2_synth_generator_test_flags ()

gboolean
ags_sf2_synth_generator_test_flags (AgsSF2SynthGenerator *sf2_synth_generator,
                                    guint flags);

Test flags to be set on sf2_synth_generator .

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.4.0


ags_sf2_synth_generator_set_flags ()

void
ags_sf2_synth_generator_set_flags (AgsSF2SynthGenerator *sf2_synth_generator,
                                   guint flags);

Set flags on sf2_synth_generator .

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

flags

the flags

 

Since: 3.4.0


ags_sf2_synth_generator_unset_flags ()

void
ags_sf2_synth_generator_unset_flags (AgsSF2SynthGenerator *sf2_synth_generator,
                                     guint flags);

Unset flags on sf2_synth_generator .

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

flags

the flags

 

Since: 3.4.0


ags_sf2_synth_generator_get_filename ()

gchar *
ags_sf2_synth_generator_get_filename (AgsSF2SynthGenerator *sf2_synth_generator);

Gets filename.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the filename

Since: 3.4.0


ags_sf2_synth_generator_set_filename ()

void
ags_sf2_synth_generator_set_filename (AgsSF2SynthGenerator *sf2_synth_generator,
                                      gchar *filename);

Set filename.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

filename

the filename

 

Since: 3.4.0


ags_sf2_synth_generator_get_preset ()

gchar *
ags_sf2_synth_generator_get_preset (AgsSF2SynthGenerator *sf2_synth_generator);

Gets preset.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the preset

Since: 3.4.0


ags_sf2_synth_generator_set_preset ()

void
ags_sf2_synth_generator_set_preset (AgsSF2SynthGenerator *sf2_synth_generator,
                                    gchar *preset);

Set preset.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

preset

the preset

 

Since: 3.4.0


ags_sf2_synth_generator_get_instrument ()

gchar *
ags_sf2_synth_generator_get_instrument
                               (AgsSF2SynthGenerator *sf2_synth_generator);

Gets instrument.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the instrument

Since: 3.4.0


ags_sf2_synth_generator_set_instrument ()

void
ags_sf2_synth_generator_set_instrument
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                gchar *instrument);

Set instrument.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

instrument

the instrument

 

Since: 3.4.0


ags_sf2_synth_generator_get_bank ()

gint
ags_sf2_synth_generator_get_bank (AgsSF2SynthGenerator *sf2_synth_generator);

Gets bank.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the bank

Since: 3.4.0


ags_sf2_synth_generator_set_bank ()

void
ags_sf2_synth_generator_set_bank (AgsSF2SynthGenerator *sf2_synth_generator,
                                  gint bank);

Set buffer size.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

bank

the buffer size

 

Since: 3.4.0


ags_sf2_synth_generator_get_program ()

gint
ags_sf2_synth_generator_get_program (AgsSF2SynthGenerator *sf2_synth_generator);

Gets program.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the program

Since: 3.4.0


ags_sf2_synth_generator_set_program ()

void
ags_sf2_synth_generator_set_program (AgsSF2SynthGenerator *sf2_synth_generator,
                                     gint program);

Set buffer size.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

program

the buffer size

 

Since: 3.4.0


ags_sf2_synth_generator_get_samplerate ()

guint
ags_sf2_synth_generator_get_samplerate
                               (AgsSF2SynthGenerator *sf2_synth_generator);

Gets samplerate.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the samplerate

Since: 3.4.0


ags_sf2_synth_generator_set_samplerate ()

void
ags_sf2_synth_generator_set_samplerate
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                guint samplerate);

Set samplerate.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

samplerate

the samplerate

 

Since: 3.4.0


ags_sf2_synth_generator_get_buffer_size ()

guint
ags_sf2_synth_generator_get_buffer_size
                               (AgsSF2SynthGenerator *sf2_synth_generator);

Gets buffer size.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the buffer size

Since: 3.4.0


ags_sf2_synth_generator_set_buffer_size ()

void
ags_sf2_synth_generator_set_buffer_size
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                guint buffer_size);

Set buffer size.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

buffer_size

the buffer size

 

Since: 3.4.0


ags_sf2_synth_generator_get_format ()

guint
ags_sf2_synth_generator_get_format (AgsSF2SynthGenerator *sf2_synth_generator);

Gets format.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the format

Since: 3.4.0


ags_sf2_synth_generator_set_format ()

void
ags_sf2_synth_generator_set_format (AgsSF2SynthGenerator *sf2_synth_generator,
                                    guint format);

Set format.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

format

the format

 

Since: 3.4.0


ags_sf2_synth_generator_get_pitch_type ()

guint
ags_sf2_synth_generator_get_pitch_type
                               (AgsSF2SynthGenerator *sf2_synth_generator);

Gets pitch type.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the pitch type

Since: 3.9.0


ags_sf2_synth_generator_set_pitch_type ()

void
ags_sf2_synth_generator_set_pitch_type
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                guint pitch_type);

Set pitch type.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

pitch_type

the pitch type

 

Since: 3.9.0


ags_sf2_synth_generator_get_delay ()

gdouble
ags_sf2_synth_generator_get_delay (AgsSF2SynthGenerator *sf2_synth_generator);

Gets delay.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the delay

Since: 3.4.0


ags_sf2_synth_generator_set_delay ()

void
ags_sf2_synth_generator_set_delay (AgsSF2SynthGenerator *sf2_synth_generator,
                                   gdouble delay);

Sets delay.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

delay

the delay

 

Since: 3.4.0


ags_sf2_synth_generator_get_frame_count ()

guint
ags_sf2_synth_generator_get_frame_count
                               (AgsSF2SynthGenerator *sf2_synth_generator);

Gets frame count.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the frame count

Since: 3.4.0


ags_sf2_synth_generator_set_frame_count ()

void
ags_sf2_synth_generator_set_frame_count
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                guint frame_count);

Sets frame count.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

frame_count

the frame count

 

Since: 3.4.0


ags_sf2_synth_generator_get_loop_start ()

guint
ags_sf2_synth_generator_get_loop_start
                               (AgsSF2SynthGenerator *sf2_synth_generator);

Gets loop start.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the loop start

Since: 3.4.0


ags_sf2_synth_generator_set_loop_start ()

void
ags_sf2_synth_generator_set_loop_start
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                guint loop_start);

Sets loop start.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

loop_start

the loop start

 

Since: 3.4.0


ags_sf2_synth_generator_get_loop_end ()

guint
ags_sf2_synth_generator_get_loop_end (AgsSF2SynthGenerator *sf2_synth_generator);

Gets loop end.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the loop end

Since: 3.4.0


ags_sf2_synth_generator_set_loop_end ()

void
ags_sf2_synth_generator_set_loop_end (AgsSF2SynthGenerator *sf2_synth_generator,
                                      guint loop_end);

Sets loop end.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

loop_end

the loop end

 

Since: 3.4.0


ags_sf2_synth_generator_get_base_key ()

gdouble
ags_sf2_synth_generator_get_base_key (AgsSF2SynthGenerator *sf2_synth_generator);

Gets base key.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the base key

Since: 3.4.0


ags_sf2_synth_generator_set_base_key ()

void
ags_sf2_synth_generator_set_base_key (AgsSF2SynthGenerator *sf2_synth_generator,
                                      gdouble base_key);

Sets base key.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

base_key

the base key

 

Since: 3.4.0


ags_sf2_synth_generator_get_tuning ()

gdouble
ags_sf2_synth_generator_get_tuning (AgsSF2SynthGenerator *sf2_synth_generator);

Gets tuning.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the tuning

Since: 3.4.0


ags_sf2_synth_generator_set_tuning ()

void
ags_sf2_synth_generator_set_tuning (AgsSF2SynthGenerator *sf2_synth_generator,
                                    gdouble tuning);

Sets tuning.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

tuning

the tuning

 

Since: 3.4.0


ags_sf2_synth_generator_get_timestamp ()

AgsTimestamp *
ags_sf2_synth_generator_get_timestamp (AgsSF2SynthGenerator *sf2_synth_generator);

Get timestamp.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

Returns

the AgsTimestamp.

[transfer full]

Since: 3.4.0


ags_sf2_synth_generator_set_timestamp ()

void
ags_sf2_synth_generator_set_timestamp (AgsSF2SynthGenerator *sf2_synth_generator,
                                       AgsTimestamp *timestamp);

Set timestamp.

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

timestamp

the AgsTimestamp

 

Since: 3.4.0


ags_sf2_synth_generator_compute ()

void
ags_sf2_synth_generator_compute (AgsSF2SynthGenerator *sf2_synth_generator,
                                 GObject *audio_signal,
                                 gdouble note);

Compute SF2 synth for note .

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

audio_signal

the AgsAudioSignal

 

note

the note to compute

 

Since: 3.4.0


ags_sf2_synth_generator_compute_instrument ()

void
ags_sf2_synth_generator_compute_instrument
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                GObject *audio_signal,
                                gchar *preset,
                                gchar *instrument,
                                gdouble note);

Compute instrument for note .

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

audio_signal

the AgsAudioSignal

 

preset

the preset

 

instrument

the instrument

 

note

the note to compute

 

Since: 3.4.0


ags_sf2_synth_generator_compute_midi_locale ()

void
ags_sf2_synth_generator_compute_midi_locale
                               (AgsSF2SynthGenerator *sf2_synth_generator,
                                GObject *audio_signal,
                                gint bank,
                                gint program,
                                gdouble note);

Compute synth for note .

Parameters

sf2_synth_generator

the AgsSF2SynthGenerator

 

audio_signal

the AgsAudioSignal

 

bank

the bank

 

program

the program

 

note

the note to compute

 

Since: 3.4.0


ags_sf2_synth_generator_new ()

AgsSF2SynthGenerator *
ags_sf2_synth_generator_new ();

Creates an AgsSF2SynthGenerator

Returns

a new AgsSF2SynthGenerator

Since: 3.4.0

Types and Values

AGS_SF2_SYNTH_GENERATOR_DEFAULT_BANK

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_BANK (0)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_PROGRAM

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_PROGRAM (0)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_SAMPLERATE

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_SAMPLERATE ((guint) AGS_SOUNDCARD_DEFAULT_SAMPLERATE)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_BUFFER_SIZE

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_BUFFER_SIZE (AGS_SOUNDCARD_DEFAULT_BUFFER_SIZE)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_FORMAT

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_FORMAT (AGS_SOUNDCARD_DEFAULT_FORMAT)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_VOLUME

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_VOLUME (1.0)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_BASE_KEY

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_BASE_KEY (-48.0)

AGS_SF2_SYNTH_GENERATOR_DEFAULT_TUNING

#define AGS_SF2_SYNTH_GENERATOR_DEFAULT_TUNING (0.0)

enum AgsSF2SynthGeneratorFlags

Members

AGS_SF2_SYNTH_GENERATOR_COMPUTE_INSTRUMENT

   

AGS_SF2_SYNTH_GENERATOR_COMPUTE_MIDI_LOCALE

   

Property Details

The “attack” property

  “attack”                   guint

The attack to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 0

Since: 3.4.11


The “bank” property

  “bank”                     int

The bank to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 3.4.0


The “base-key” property

  “base-key”                 double

The base_key to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Allowed values: [-65535,65535]

Default value: -48


The “buffer-size” property

  “buffer-size”              guint

The buffer size to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 1024

Since: 3.4.0


The “delay” property

  “delay”                    double

The delay to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Allowed values: [0,65535]

Default value: 0

Since: 3.4.11


The “filename” property

  “filename”                 char *

The assigned filename.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: NULL

Since: 3.4.0


The “format” property

  “format”                   guint

The format to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 16

Since: 3.4.0


The “frame-count” property

  “frame-count”              guint

The frame count to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 0

Since: 3.4.0


The “instrument” property

  “instrument”               char *

The assigned instrument.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: NULL

Since: 3.4.0


The “loop-end” property

  “loop-end”                 guint

The loop end to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 0

Since: 3.4.0


The “loop-start” property

  “loop-start”               guint

The loop start to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 0

Since: 3.4.0


The “pitch-type” property

  “pitch-type”               guint

The pitch type to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 4

Since: 3.9.0


The “preset” property

  “preset”                   char *

The assigned preset.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: NULL

Since: 3.4.0


The “program” property

  “program”                  int

The program to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 3.4.0


The “samplerate” property

  “samplerate”               guint

The samplerate to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Default value: 48000

Since: 3.4.0


The “tuning” property

  “tuning”                   double

The tuning to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Allowed values: [0,1200]

Default value: 0

Since: 3.4.0


The “volume” property

  “volume”                   double

The volume to be used.

Owner: AgsSF2SynthGenerator

Flags: Read / Write

Allowed values: [0,2]

Default value: 1

Since: 3.4.11