AgsMidiUtil: Advanced Gtk+ Sequencer Audio Reference Manual

AgsMidiUtil

AgsMidiUtil — MIDI util

Stability Level

Stable, unless otherwise indicated

Functions

gboolean	ags_midi_util_is_key_on ()
gboolean	ags_midi_util_is_key_off ()
gboolean	ags_midi_util_is_key_pressure ()
gboolean	ags_midi_util_is_change_parameter ()
gboolean	ags_midi_util_is_pitch_bend ()
gboolean	ags_midi_util_is_change_program ()
gboolean	ags_midi_util_is_change_pressure ()
gboolean	ags_midi_util_is_sysex ()
gboolean	ags_midi_util_is_quarter_frame ()
gboolean	ags_midi_util_is_song_position ()
gboolean	ags_midi_util_is_song_select ()
gboolean	ags_midi_util_is_tune_request ()
gboolean	ags_midi_util_is_meta_event ()
gboolean	ags_midi_util_get_key_on ()
gboolean	ags_midi_util_get_key_off ()
gboolean	ags_midi_util_get_key_pressure ()
gboolean	ags_midi_util_get_change_parameter ()
gboolean	ags_midi_util_get_pitch_bend ()
gboolean	ags_midi_util_get_change_program ()
gboolean	ags_midi_util_get_change_pressure ()
gboolean	ags_midi_util_get_sysex ()
gboolean	ags_midi_util_get_quarter_frame ()
gboolean	ags_midi_util_get_song_position ()
gboolean	ags_midi_util_get_song_select ()
guchar *	ags_midi_util_to_smf ()
guint	ags_midi_util_delta_time_to_offset ()
glong	ags_midi_util_offset_to_delta_time ()

Object Hierarchy

    GBoxed
    ╰── AgsMidiUtil

Includes

#include <ags/audio/midi/ags_midi_util.h>

Description

Utility functions for MIDI.

Functions

ags_midi_util_is_key_on ()

gboolean
ags_midi_util_is_key_on (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_key_off ()

gboolean
ags_midi_util_is_key_off (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_key_pressure ()

gboolean
ags_midi_util_is_key_pressure (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_change_parameter ()

gboolean
ags_midi_util_is_change_parameter (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_pitch_bend ()

gboolean
ags_midi_util_is_pitch_bend (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_change_program ()

gboolean
ags_midi_util_is_change_program (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_change_pressure ()

gboolean
ags_midi_util_is_change_pressure (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_sysex ()

gboolean
ags_midi_util_is_sysex (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_quarter_frame ()

gboolean
ags_midi_util_is_quarter_frame (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_song_position ()

gboolean
ags_midi_util_is_song_position (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_song_select ()

gboolean
ags_midi_util_is_song_select (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_tune_request ()

gboolean
ags_midi_util_is_tune_request (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_is_meta_event ()

gboolean
ags_midi_util_is_meta_event (guchar *buffer);

Parameters

buffer

the midi buffer

Returns

TRUE on success, otherwise FALSE

Since: 3.0.0

ags_midi_util_get_key_on ()

gboolean
ags_midi_util_get_key_on (guchar *buffer,
                          gint *channel,
                          gint *key,
                          gint *velocity);

Get key on fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
key	the return location of key.	[out]
velocity	the return location of velocity.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_key_off ()

gboolean
ags_midi_util_get_key_off (guchar *buffer,
                           gint *channel,
                           gint *key,
                           gint *velocity);

Get key off fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
key	the return location of key.	[out]
velocity	the return location of velocity.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_key_pressure ()

gboolean
ags_midi_util_get_key_pressure (guchar *buffer,
                                gint *channel,
                                gint *key,
                                gint *pressure);

Get key pressure fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
key	the return location of key.	[out]
pressure	the return location of pressure.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_change_parameter ()

gboolean
ags_midi_util_get_change_parameter (guchar *buffer,
                                    gint *channel,
                                    gint *control,
                                    gint *value);

Get change parameter fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
control	the return location of control.	[out]
value	the return location of value.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_pitch_bend ()

gboolean
ags_midi_util_get_pitch_bend (guchar *buffer,
                              gint *channel,
                              gint *pitch,
                              gint *transmitter);

Get pitch bend fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
pitch	the return location of pitch.	[out]
transmitter	the return location of transmitter.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_change_program ()

gboolean
ags_midi_util_get_change_program (guchar *buffer,
                                  gint *channel,
                                  gint *program);

Get change program fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
program	the return location of program.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_change_pressure ()

gboolean
ags_midi_util_get_change_pressure (guchar *buffer,
                                   gint *channel,
                                   gint *pressure);

Get change pressure fields of buffer .

Parameters

buffer	the MIDI buffer
channel	the return location of channel.	[out]
pressure	the return location of pressure.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_sysex ()

gboolean
ags_midi_util_get_sysex (guchar *buffer,
                         guchar **data,
                         gint *length);

Get sysex fields of buffer .

Parameters

buffer	the MIDI buffer
data	the return location of data.	[out][transfer full]
length	the return location of length.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_quarter_frame ()

gboolean
ags_midi_util_get_quarter_frame (guchar *buffer,
                                 gint *message_type,
                                 gint *values);

Get quarter frame fields of buffer .

Parameters

buffer	the MIDI buffer
message_type	the return location of message type.	[out]
values	the return location of values.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_song_position ()

gboolean
ags_midi_util_get_song_position (guchar *buffer,
                                 gint *song_position);

Get song position fields of buffer .

Parameters

buffer	the MIDI buffer
song_position	the return location of song position.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_get_song_select ()

gboolean
ags_midi_util_get_song_select (guchar *buffer,
                               gint *song_select);

Get song select fields of buffer .

Parameters

buffer	the MIDI buffer
song_select	the return location of song select.	[out]

Returns

TRUE if successful, otherwise FALSE

Since: 3.13.0

ags_midi_util_to_smf ()

guchar *
ags_midi_util_to_smf (guchar *midi_buffer,
                      guint buffer_length,
                      glong delta_time,
                      guint *smf_buffer_length);

Convert real-time MIDI to SMF.

Parameters

midi_buffer	the midi buffer
buffer_length	the buffer length
delta_time	the delta time
smf_buffer_length	the return location of resulting length

Returns

the SMF buffer

Since: 3.0.0

ags_midi_util_delta_time_to_offset ()

guint
ags_midi_util_delta_time_to_offset (gdouble delay_factor,
                                    glong division,
                                    glong tempo,
                                    glong bpm,
                                    glong delta_time);

Delta time to offset

Parameters

delay_factor	delay factor
division	division
tempo	tempo
bpm	bpm
delta_time	delta time

Returns

the offset

Since: 3.0.0

ags_midi_util_offset_to_delta_time ()

glong
ags_midi_util_offset_to_delta_time (gdouble delay_factor,
                                    glong division,
                                    glong tempo,
                                    glong bpm,
                                    guint x);

Offset to delta time

Parameters

delay_factor	delay factor
division	division
tempo	tempo
bpm	bpm
x	note offset

Returns

the delta time

Since: 3.0.0