AgsHQPitchUtil

AgsHQPitchUtil — hq pitch util

Stability Level

Stable, unless otherwise indicated

Functions

AgsHQPitchUtil * ags_hq_pitch_util_alloc ()
gpointer ags_hq_pitch_util_copy ()
void ags_hq_pitch_util_free ()
gpointer ags_hq_pitch_util_get_source ()
void ags_hq_pitch_util_set_source ()
guint ags_hq_pitch_util_get_source_stride ()
void ags_hq_pitch_util_set_source_stride ()
gpointer ags_hq_pitch_util_get_destination ()
void ags_hq_pitch_util_set_destination ()
guint ags_hq_pitch_util_get_destination_stride ()
void ags_hq_pitch_util_set_destination_stride ()
guint ags_hq_pitch_util_get_buffer_length ()
void ags_hq_pitch_util_set_buffer_length ()
AgsSoundcardFormat ags_hq_pitch_util_get_format ()
void ags_hq_pitch_util_set_format ()
guint ags_hq_pitch_util_get_samplerate ()
void ags_hq_pitch_util_set_samplerate ()
gdouble ags_hq_pitch_util_get_base_key ()
void ags_hq_pitch_util_set_base_key ()
gdouble ags_hq_pitch_util_get_tuning ()
void ags_hq_pitch_util_set_tuning ()
gboolean ags_hq_pitch_util_get_vibrato_enabled ()
void ags_hq_pitch_util_set_vibrato_enabled ()
gdouble ags_hq_pitch_util_get_vibrato_gain ()
void ags_hq_pitch_util_set_vibrato_gain ()
gdouble ags_hq_pitch_util_get_vibrato_lfo_depth ()
void ags_hq_pitch_util_set_vibrato_lfo_depth ()
gdouble ags_hq_pitch_util_get_vibrato_lfo_freq ()
void ags_hq_pitch_util_set_vibrato_lfo_freq ()
gdouble ags_hq_pitch_util_get_vibrato_tuning ()
void ags_hq_pitch_util_set_vibrato_tuning ()
guint ags_hq_pitch_util_get_vibrato_lfo_offset ()
void ags_hq_pitch_util_set_vibrato_lfo_offset ()
guint ags_hq_pitch_util_get_frame_count ()
void ags_hq_pitch_util_set_frame_count ()
guint ags_hq_pitch_util_get_offset ()
void ags_hq_pitch_util_set_offset ()
gboolean ags_hq_pitch_util_get_note_256th_mode ()
void ags_hq_pitch_util_set_note_256th_mode ()
guint ags_hq_pitch_util_get_offset_256th ()
void ags_hq_pitch_util_set_offset_256th ()
void ags_hq_pitch_util_pitch_s8 ()
void ags_hq_pitch_util_pitch_s16 ()
void ags_hq_pitch_util_pitch_s24 ()
void ags_hq_pitch_util_pitch_s32 ()
void ags_hq_pitch_util_pitch_s64 ()
void ags_hq_pitch_util_pitch_float ()
void ags_hq_pitch_util_pitch_double ()
void ags_hq_pitch_util_pitch_complex ()
void ags_hq_pitch_util_pitch ()

Types and Values

Object Hierarchy

    GBoxed
    ╰── AgsHQPitchUtil

Includes

#include <ags/audio/ags_hq_pitch_util.h>

Description

Utility functions to pitch.

Functions

ags_hq_pitch_util_alloc ()

AgsHQPitchUtil *
ags_hq_pitch_util_alloc ();

Allocate AgsHQPitchUtil.

Returns

the newly allocated AgsHQPitchUtil

Since: 3.9.6


ags_hq_pitch_util_copy ()

gpointer
ags_hq_pitch_util_copy (AgsHQPitchUtil *ptr);

Create a copy of ptr .

Parameters

ptr

the original AgsHQPitchUtil

 

Returns

a pointer of the new AgsHQPitchUtil

Since: 3.9.6


ags_hq_pitch_util_free ()

void
ags_hq_pitch_util_free (AgsHQPitchUtil *ptr);

Free the memory of ptr .

Parameters

ptr

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_get_source ()

gpointer
ags_hq_pitch_util_get_source (AgsHQPitchUtil *hq_pitch_util);

Get source buffer of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the source buffer

Since: 3.9.6


ags_hq_pitch_util_set_source ()

void
ags_hq_pitch_util_set_source (AgsHQPitchUtil *hq_pitch_util,
                              gpointer source);

Set source buffer of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

source

the source buffer

 

Since: 3.9.6


ags_hq_pitch_util_get_source_stride ()

guint
ags_hq_pitch_util_get_source_stride (AgsHQPitchUtil *hq_pitch_util);

Get source stride of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the source buffer stride

Since: 3.9.6


ags_hq_pitch_util_set_source_stride ()

void
ags_hq_pitch_util_set_source_stride (AgsHQPitchUtil *hq_pitch_util,
                                     guint source_stride);

Set source stride of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

source_stride

the source buffer stride

 

Since: 3.9.6


ags_hq_pitch_util_get_destination ()

gpointer
ags_hq_pitch_util_get_destination (AgsHQPitchUtil *hq_pitch_util);

Get destination buffer of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the destination buffer

Since: 3.9.6


ags_hq_pitch_util_set_destination ()

void
ags_hq_pitch_util_set_destination (AgsHQPitchUtil *hq_pitch_util,
                                   gpointer destination);

Set destination buffer of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

destination

the destination buffer

 

Since: 3.9.6


ags_hq_pitch_util_get_destination_stride ()

guint
ags_hq_pitch_util_get_destination_stride
                               (AgsHQPitchUtil *hq_pitch_util);

Get destination stride of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the destination buffer stride

Since: 3.9.6


ags_hq_pitch_util_set_destination_stride ()

void
ags_hq_pitch_util_set_destination_stride
                               (AgsHQPitchUtil *hq_pitch_util,
                                guint destination_stride);

Set destination stride of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

destination_stride

the destination buffer stride

 

Since: 3.9.6


ags_hq_pitch_util_get_buffer_length ()

guint
ags_hq_pitch_util_get_buffer_length (AgsHQPitchUtil *hq_pitch_util);

Get buffer length of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the buffer length

Since: 3.9.6


ags_hq_pitch_util_set_buffer_length ()

void
ags_hq_pitch_util_set_buffer_length (AgsHQPitchUtil *hq_pitch_util,
                                     guint buffer_length);

Set buffer_length of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

buffer_length

the buffer length

 

Since: 3.9.6


ags_hq_pitch_util_get_format ()

AgsSoundcardFormat
ags_hq_pitch_util_get_format (AgsHQPitchUtil *hq_pitch_util);

Get format of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the format

Since: 3.9.6


ags_hq_pitch_util_set_format ()

void
ags_hq_pitch_util_set_format (AgsHQPitchUtil *hq_pitch_util,
                              AgsSoundcardFormat format);

Set format of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

format

the format

 

Since: 3.9.6


ags_hq_pitch_util_get_samplerate ()

guint
ags_hq_pitch_util_get_samplerate (AgsHQPitchUtil *hq_pitch_util);

Get samplerate of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the samplerate

Since: 3.9.6


ags_hq_pitch_util_set_samplerate ()

void
ags_hq_pitch_util_set_samplerate (AgsHQPitchUtil *hq_pitch_util,
                                  guint samplerate);

Set samplerate of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

samplerate

the samplerate

 

Since: 3.9.6


ags_hq_pitch_util_get_base_key ()

gdouble
ags_hq_pitch_util_get_base_key (AgsHQPitchUtil *hq_pitch_util);

Get base key of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the base key

Since: 3.9.6


ags_hq_pitch_util_set_base_key ()

void
ags_hq_pitch_util_set_base_key (AgsHQPitchUtil *hq_pitch_util,
                                gdouble base_key);

Set base_key of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

base_key

the base key

 

Since: 3.9.6


ags_hq_pitch_util_get_tuning ()

gdouble
ags_hq_pitch_util_get_tuning (AgsHQPitchUtil *hq_pitch_util);

Get tuning of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the tuning

Since: 3.9.6


ags_hq_pitch_util_set_tuning ()

void
ags_hq_pitch_util_set_tuning (AgsHQPitchUtil *hq_pitch_util,
                              gdouble tuning);

Set tuning of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

tuning

the tuning

 

Since: 3.9.6


ags_hq_pitch_util_get_vibrato_enabled ()

gboolean
ags_hq_pitch_util_get_vibrato_enabled (AgsHQPitchUtil *hq_pitch_util);

Get vibrato enabled of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

TRUE if the vibrato is enabled, otherwise FALSE

Since: 5.2.0


ags_hq_pitch_util_set_vibrato_enabled ()

void
ags_hq_pitch_util_set_vibrato_enabled (AgsHQPitchUtil *hq_pitch_util,
                                       gboolean vibrato_enabled);

Set vibrato_enabled of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

vibrato_enabled

the vibrato enabled

 

Since: 5.2.0


ags_hq_pitch_util_get_vibrato_gain ()

gdouble
ags_hq_pitch_util_get_vibrato_gain (AgsHQPitchUtil *hq_pitch_util);

Get vibrato gain of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the vibrato gain

Since: 5.2.0


ags_hq_pitch_util_set_vibrato_gain ()

void
ags_hq_pitch_util_set_vibrato_gain (AgsHQPitchUtil *hq_pitch_util,
                                    gdouble vibrato_gain);

Set vibrato_gain of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

vibrato_gain

the vibrato gain

 

Since: 5.2.0


ags_hq_pitch_util_get_vibrato_lfo_depth ()

gdouble
ags_hq_pitch_util_get_vibrato_lfo_depth
                               (AgsHQPitchUtil *hq_pitch_util);

Get vibrato lfo_depth of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the vibrato lfo_depth

Since: 5.2.0


ags_hq_pitch_util_set_vibrato_lfo_depth ()

void
ags_hq_pitch_util_set_vibrato_lfo_depth
                               (AgsHQPitchUtil *hq_pitch_util,
                                gdouble vibrato_lfo_depth);

Set vibrato_lfo_depth of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

vibrato_lfo_depth

the vibrato lfo_depth

 

Since: 5.2.0


ags_hq_pitch_util_get_vibrato_lfo_freq ()

gdouble
ags_hq_pitch_util_get_vibrato_lfo_freq
                               (AgsHQPitchUtil *hq_pitch_util);

Get vibrato lfo_freq of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the vibrato lfo_freq

Since: 5.2.0


ags_hq_pitch_util_set_vibrato_lfo_freq ()

void
ags_hq_pitch_util_set_vibrato_lfo_freq
                               (AgsHQPitchUtil *hq_pitch_util,
                                gdouble vibrato_lfo_freq);

Set vibrato_lfo_freq of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

vibrato_lfo_freq

the vibrato lfo_freq

 

Since: 5.2.0


ags_hq_pitch_util_get_vibrato_tuning ()

gdouble
ags_hq_pitch_util_get_vibrato_tuning (AgsHQPitchUtil *hq_pitch_util);

Get vibrato tuning of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the vibrato tuning

Since: 5.2.0


ags_hq_pitch_util_set_vibrato_tuning ()

void
ags_hq_pitch_util_set_vibrato_tuning (AgsHQPitchUtil *hq_pitch_util,
                                      gdouble vibrato_tuning);

Set vibrato_tuning of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

vibrato_tuning

the vibrato tuning

 

Since: 5.2.0


ags_hq_pitch_util_get_vibrato_lfo_offset ()

guint
ags_hq_pitch_util_get_vibrato_lfo_offset
                               (AgsHQPitchUtil *hq_pitch_util);

ags_hq_pitch_util_get_vibrato_lfo_offset is deprecated and should not be used in newly-written code.

Get vibrato lfo_offset of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the vibrato lfo_offset

Since: 5.2.4


ags_hq_pitch_util_set_vibrato_lfo_offset ()

void
ags_hq_pitch_util_set_vibrato_lfo_offset
                               (AgsHQPitchUtil *hq_pitch_util,
                                guint vibrato_lfo_offset);

ags_hq_pitch_util_set_vibrato_lfo_offset is deprecated and should not be used in newly-written code.

Set vibrato_lfo_offset of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

vibrato_lfo_offset

the vibrato lfo_offset

 

Since: 5.2.4


ags_hq_pitch_util_get_frame_count ()

guint
ags_hq_pitch_util_get_frame_count (AgsHQPitchUtil *hq_pitch_util);

Get frame count of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the frame count

Since: 6.1.0


ags_hq_pitch_util_set_frame_count ()

void
ags_hq_pitch_util_set_frame_count (AgsHQPitchUtil *hq_pitch_util,
                                   guint frame_count);

Set frame_count of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

frame_count

the frame count

 

Since: 6.1.0


ags_hq_pitch_util_get_offset ()

guint
ags_hq_pitch_util_get_offset (AgsHQPitchUtil *hq_pitch_util);

Get offset of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the offset

Since: 6.1.0


ags_hq_pitch_util_set_offset ()

void
ags_hq_pitch_util_set_offset (AgsHQPitchUtil *hq_pitch_util,
                              guint offset);

Set offset of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

offset

the offset

 

Since: 6.1.0


ags_hq_pitch_util_get_note_256th_mode ()

gboolean
ags_hq_pitch_util_get_note_256th_mode (AgsHQPitchUtil *hq_pitch_util);

Get note 256th mode of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

TRUE if note 256th mode, otherwise FALSE

Since: 6.1.0


ags_hq_pitch_util_set_note_256th_mode ()

void
ags_hq_pitch_util_set_note_256th_mode (AgsHQPitchUtil *hq_pitch_util,
                                       gboolean note_256th_mode);

Set note_256th_mode of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

note_256th_mode

the note 256th mode

 

Since: 6.1.0


ags_hq_pitch_util_get_offset_256th ()

guint
ags_hq_pitch_util_get_offset_256th (AgsHQPitchUtil *hq_pitch_util);

Get offset as note 256th of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Returns

the offset as note 256th

Since: 6.1.0


ags_hq_pitch_util_set_offset_256th ()

void
ags_hq_pitch_util_set_offset_256th (AgsHQPitchUtil *hq_pitch_util,
                                    guint offset_256th);

Set offset_256th of hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

offset_256th

the offset as note 256th

 

Since: 6.1.0


ags_hq_pitch_util_pitch_s8 ()

void
ags_hq_pitch_util_pitch_s8 (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of signed 8 bit data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_s16 ()

void
ags_hq_pitch_util_pitch_s16 (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of signed 16 bit data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_s24 ()

void
ags_hq_pitch_util_pitch_s24 (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of signed 24 bit data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_s32 ()

void
ags_hq_pitch_util_pitch_s32 (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of signed 32 bit data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_s64 ()

void
ags_hq_pitch_util_pitch_s64 (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of signed 64 bit data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_float ()

void
ags_hq_pitch_util_pitch_float (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of floating point data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_double ()

void
ags_hq_pitch_util_pitch_double (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of double precision floating point data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch_complex ()

void
ags_hq_pitch_util_pitch_complex (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util of complex data.

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6


ags_hq_pitch_util_pitch ()

void
ags_hq_pitch_util_pitch (AgsHQPitchUtil *hq_pitch_util);

Pitch hq_pitch_util .

Parameters

hq_pitch_util

the AgsHQPitchUtil

 

Since: 3.9.6

Types and Values

AGS_HQ_PITCH_UTIL_DEFAULT_MAX_BUFFER_SIZE

#define AGS_HQ_PITCH_UTIL_DEFAULT_MAX_BUFFER_SIZE (65536)