AgsMidiBufferUtil: Advanced Gtk+ Sequencer Audio Reference Manual

AgsMidiBufferUtil

AgsMidiBufferUtil — MIDI buffer util

Stability Level

Stable, unless otherwise indicated

Functions

guint	ags_midi_buffer_util_get_varlength_size ()
void	ags_midi_buffer_util_put_varlength ()
guint	ags_midi_buffer_util_get_varlength ()
void	ags_midi_buffer_util_put_int16 ()
void	ags_midi_buffer_util_get_int16 ()
void	ags_midi_buffer_util_put_int24 ()
void	ags_midi_buffer_util_get_int24 ()
void	ags_midi_buffer_util_put_int32 ()
void	ags_midi_buffer_util_get_int32 ()
void	ags_midi_buffer_util_put_header ()
guint	ags_midi_buffer_util_get_header ()
void	ags_midi_buffer_util_put_track ()
guint	ags_midi_buffer_util_get_track ()
void	ags_midi_buffer_util_put_key_on ()
guint	ags_midi_buffer_util_get_key_on ()
void	ags_midi_buffer_util_put_key_off ()
guint	ags_midi_buffer_util_get_key_off ()
void	ags_midi_buffer_util_put_key_pressure ()
guint	ags_midi_buffer_util_get_key_pressure ()
void	ags_midi_buffer_util_put_change_parameter ()
guint	ags_midi_buffer_util_get_change_parameter ()
void	ags_midi_buffer_util_put_pitch_bend ()
guint	ags_midi_buffer_util_get_pitch_bend ()
void	ags_midi_buffer_util_put_change_program ()
guint	ags_midi_buffer_util_get_change_program ()
void	ags_midi_buffer_util_put_change_pressure ()
guint	ags_midi_buffer_util_get_change_pressure ()
void	ags_midi_buffer_util_put_sysex ()
guint	ags_midi_buffer_util_get_sysex ()
void	ags_midi_buffer_util_put_quarter_frame ()
guint	ags_midi_buffer_util_get_quarter_frame ()
void	ags_midi_buffer_util_put_song_position ()
guint	ags_midi_buffer_util_get_song_position ()
void	ags_midi_buffer_util_put_song_select ()
guint	ags_midi_buffer_util_get_song_select ()
void	ags_midi_buffer_util_put_tune_request ()
guint	ags_midi_buffer_util_get_tune_request ()
void	ags_midi_buffer_util_put_sequence_number ()
guint	ags_midi_buffer_util_get_sequence_number ()
void	ags_midi_buffer_util_put_smtpe ()
guint	ags_midi_buffer_util_get_smtpe ()
void	ags_midi_buffer_util_put_tempo ()
guint	ags_midi_buffer_util_get_tempo ()
void	ags_midi_buffer_util_put_time_signature ()
guint	ags_midi_buffer_util_get_time_signature ()
void	ags_midi_buffer_util_put_key_signature ()
guint	ags_midi_buffer_util_get_key_signature ()
void	ags_midi_buffer_util_put_sequencer_meta_event ()
guint	ags_midi_buffer_util_get_sequencer_meta_event ()
void	ags_midi_buffer_util_put_text_event ()
guint	ags_midi_buffer_util_get_text_event ()
void	ags_midi_buffer_util_put_end_of_track ()
guint	ags_midi_buffer_util_get_end_of_track ()
guchar *	ags_midi_buffer_util_seek_message ()
guint	ags_midi_buffer_util_decode ()

Types and Values

enum	AgsMidiBufferUtilMtcQuarterFrameMessageType
enum	AgsMidiBufferUtilSmtpeFrameRate

Object Hierarchy

    GBoxed
    ╰── AgsMidiBufferUtil

Includes

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

Description

Utility functions for MIDI buffers.

Functions

ags_midi_buffer_util_get_varlength_size ()

guint
ags_midi_buffer_util_get_varlength_size
                               (glong varlength);

Retrieve the size needed to store the variable length.

Parameters

varlength

the variable length

Returns

the size needed to be allocated

Since: 3.0.0

ags_midi_buffer_util_put_varlength ()

void
ags_midi_buffer_util_put_varlength (guchar *buffer,
                                    glong varlength);

Put the variable lenght value to buffer .

Parameters

buffer	the character buffer
varlength	the value to put

Since: 3.0.0

ags_midi_buffer_util_get_varlength ()

guint
ags_midi_buffer_util_get_varlength (guchar *buffer,
                                    glong *varlength);

Get the variable lenght value from buffer .

Parameters

buffer	the character buffer
varlength	the return location

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_int16 ()

void
ags_midi_buffer_util_put_int16 (guchar *buffer,
                                glong val);

Put signed 16 bit integer.

Parameters

buffer	the character buffer
val	the integer

Since: 3.0.0

ags_midi_buffer_util_get_int16 ()

void
ags_midi_buffer_util_get_int16 (guchar *buffer,
                                glong *val);

Get signed 32 bit integer.

Parameters

buffer	the character buffer
val	return location of the integer

Since: 3.0.0

ags_midi_buffer_util_put_int24 ()

void
ags_midi_buffer_util_put_int24 (guchar *buffer,
                                glong val);

Put signed 24 bit integer.

Parameters

buffer	the character buffer
val	the integer

Since: 3.0.0

ags_midi_buffer_util_get_int24 ()

void
ags_midi_buffer_util_get_int24 (guchar *buffer,
                                glong *val);

Get signed 24 bit integer.

Parameters

buffer	the character buffer
val	return location of the integer

Since: 3.0.0

ags_midi_buffer_util_put_int32 ()

void
ags_midi_buffer_util_put_int32 (guchar *buffer,
                                glong val);

Put signed 32 bit integer.

Parameters

buffer	the character buffer
val	the integer

Since: 3.0.0

ags_midi_buffer_util_get_int32 ()

void
ags_midi_buffer_util_get_int32 (guchar *buffer,
                                glong *val);

Get signed 32 bit integer.

Parameters

buffer	the character buffer
val	return location of the integer

Since: 3.0.0

ags_midi_buffer_util_put_header ()

void
ags_midi_buffer_util_put_header (guchar *buffer,
                                 glong offset,
                                 glong format,
                                 glong track_count,
                                 glong division);

Puts the midi header.

Parameters

buffer	the character buffer
offset	start delta-time
format	either 0, 1 or 2.
track_count	the number of tracks
division	timing division

Since: 3.0.0

ags_midi_buffer_util_get_header ()

guint
ags_midi_buffer_util_get_header (guchar *buffer,
                                 glong *offset,
                                 glong *format,
                                 glong *track_count,
                                 glong *division);

Gets the midi header

Parameters

buffer	the character buffer
offset	start delta-time
format	either 0, 1 or 2.
track_count	the number of tracks
division	timing division

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_track ()

void
ags_midi_buffer_util_put_track (guchar *buffer,
                                glong offset);

Put track.

Parameters

buffer	the midi buffer
offset	start delta-time

Since: 3.0.0

ags_midi_buffer_util_get_track ()

guint
ags_midi_buffer_util_get_track (guchar *buffer,
                                glong *offset);

Get track

Parameters

buffer	the midi buffer
offset	start delta-time

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_key_on ()

void
ags_midi_buffer_util_put_key_on (guchar *buffer,
                                 glong delta_time,
                                 glong channel,
                                 glong key,
                                 glong velocity);

Puts the given values to buffer with appropriate channel message.

Parameters

buffer	the character buffer
delta_time	timing information
channel	valid channels from 0-15
key	valid keys to play 0-128
velocity	the key dynamics

Since: 3.0.0

ags_midi_buffer_util_get_key_on ()

guint
ags_midi_buffer_util_get_key_on (guchar *buffer,
                                 glong *delta_time,
                                 glong *channel,
                                 glong *key,
                                 glong *velocity);

Get the key-on message from buffer .

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
key	the return location of key
velocity	the return location of velocity

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_key_off ()

void
ags_midi_buffer_util_put_key_off (guchar *buffer,
                                  glong delta_time,
                                  glong channel,
                                  glong key,
                                  glong velocity);

Puts the given values to buffer with appropriate channel message.

Parameters

buffer	the character buffer
delta_time	timing information
channel	valid channels from 0-15
key	valid keys to play 0-128
velocity	the key dynamics

Since: 3.0.0

ags_midi_buffer_util_get_key_off ()

guint
ags_midi_buffer_util_get_key_off (guchar *buffer,
                                  glong *delta_time,
                                  glong *channel,
                                  glong *key,
                                  glong *velocity);

Get the key-off message from buffer .

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
key	the return location of key
velocity	the return location of velocity

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_key_pressure ()

void
ags_midi_buffer_util_put_key_pressure (guchar *buffer,
                                       glong delta_time,
                                       glong channel,
                                       glong key,
                                       glong pressure);

Puts the given values to buffer with appropriate channel message.

Parameters

buffer	the character buffer
delta_time	timing information
channel	valid channels from 0-15
key	valid keys to play 0-128
pressure	the key dynamics

Since: 3.0.0

ags_midi_buffer_util_get_key_pressure ()

guint
ags_midi_buffer_util_get_key_pressure (guchar *buffer,
                                       glong *delta_time,
                                       glong *channel,
                                       glong *key,
                                       glong *pressure);

Get the key-pressure message from buffer .

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
key	the return location of key
pressure	the return location of pressure

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_change_parameter ()

void
ags_midi_buffer_util_put_change_parameter
                               (guchar *buffer,
                                glong delta_time,
                                glong channel,
                                glong control,
                                glong value);

Put change parameter.

Parameters

buffer	the character buffer
delta_time	timing information
channel	channel
control	the control
value	the value

Since: 3.0.0

ags_midi_buffer_util_get_change_parameter ()

guint
ags_midi_buffer_util_get_change_parameter
                               (guchar *buffer,
                                glong *delta_time,
                                glong *channel,
                                glong *control,
                                glong *value);

Get change parameter.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
control	the return location of the control
value	the return location the value

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_pitch_bend ()

void
ags_midi_buffer_util_put_pitch_bend (guchar *buffer,
                                     glong delta_time,
                                     glong channel,
                                     glong pitch,
                                     glong transmitter);

Put pitch bend.

Parameters

buffer	the character buffer
delta_time	timing information
channel	channel
pitch	the pitch
transmitter	the transmitter

Since: 3.0.0

ags_midi_buffer_util_get_pitch_bend ()

guint
ags_midi_buffer_util_get_pitch_bend (guchar *buffer,
                                     glong *delta_time,
                                     glong *channel,
                                     glong *pitch,
                                     glong *transmitter);

Get pitch bend.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
pitch	the return location of the pitch
transmitter	the return location the transmitter

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_change_program ()

void
ags_midi_buffer_util_put_change_program
                               (guchar *buffer,
                                glong delta_time,
                                glong channel,
                                glong program);

Put change program.

Parameters

buffer	the character buffer
delta_time	timing information
channel	channel
program	the program

Since: 3.0.0

ags_midi_buffer_util_get_change_program ()

guint
ags_midi_buffer_util_get_change_program
                               (guchar *buffer,
                                glong *delta_time,
                                glong *channel,
                                glong *program);

Get change program.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
program	the return location of the program

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_change_pressure ()

void
ags_midi_buffer_util_put_change_pressure
                               (guchar *buffer,
                                glong delta_time,
                                glong channel,
                                glong pressure);

Put change pressure.

Parameters

buffer	the character buffer
delta_time	timing information
channel	channel
pressure	the pressure

Since: 3.0.0

ags_midi_buffer_util_get_change_pressure ()

guint
ags_midi_buffer_util_get_change_pressure
                               (guchar *buffer,
                                glong *delta_time,
                                glong *channel,
                                glong *pressure);

Get change pressure.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
channel	the return location of channel
pressure	the return location of the pressure

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_sysex ()

void
ags_midi_buffer_util_put_sysex (guchar *buffer,
                                glong delta_time,
                                guchar *data,
                                glong length);

Put sysex.

Parameters

buffer	the character buffer
delta_time	timing information
data	the data
length	the data's length

Since: 3.0.0

ags_midi_buffer_util_get_sysex ()

guint
ags_midi_buffer_util_get_sysex (guchar *buffer,
                                glong *delta_time,
                                guchar **data,
                                glong *length);

Get sysex.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
data	the return location of data
length	the return location of length

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_quarter_frame ()

void
ags_midi_buffer_util_put_quarter_frame
                               (guchar *buffer,
                                glong delta_time,
                                glong message_type,
                                glong values);

Put quarter frame.

Parameters

buffer	the character buffer
delta_time	timing information
message_type	the message type
values	the values

Since: 3.0.0

ags_midi_buffer_util_get_quarter_frame ()

guint
ags_midi_buffer_util_get_quarter_frame
                               (guchar *buffer,
                                glong *delta_time,
                                glong *message_type,
                                glong *values);

Get quarter frame.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
message_type	the return location of the message type
values	the return location of the values

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_song_position ()

void
ags_midi_buffer_util_put_song_position
                               (guchar *buffer,
                                glong delta_time,
                                glong song_position);

Put song position.

Parameters

buffer	the character buffer
delta_time	timing information
song_position	the song position

Since: 3.0.0

ags_midi_buffer_util_get_song_position ()

guint
ags_midi_buffer_util_get_song_position
                               (guchar *buffer,
                                glong *delta_time,
                                glong *song_position);

Get song position.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
song_position	the return location of the song position

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_song_select ()

void
ags_midi_buffer_util_put_song_select (guchar *buffer,
                                      glong delta_time,
                                      glong song_select);

Put song select.

Parameters

buffer	the character buffer
delta_time	timing information
song_select	the song select

Since: 3.0.0

ags_midi_buffer_util_get_song_select ()

guint
ags_midi_buffer_util_get_song_select (guchar *buffer,
                                      glong *delta_time,
                                      glong *song_select);

Get song select.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
song_select	the return location of the song select

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_tune_request ()

void
ags_midi_buffer_util_put_tune_request (guchar *buffer,
                                       glong delta_time);

Put tune request

Parameters

buffer	the character buffer
delta_time	timing information

Since: 3.0.0

ags_midi_buffer_util_get_tune_request ()

guint
ags_midi_buffer_util_get_tune_request (guchar *buffer,
                                       glong *delta_time);

Get tune request.

Parameters

buffer	the character buffer
delta_time	the return location of timing information

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_sequence_number ()

void
ags_midi_buffer_util_put_sequence_number
                               (guchar *buffer,
                                glong delta_time,
                                glong sequence);

Put sequence number.

Parameters

buffer	the character buffer
delta_time	timing information
sequence	the sequence

Since: 3.0.0

ags_midi_buffer_util_get_sequence_number ()

guint
ags_midi_buffer_util_get_sequence_number
                               (guchar *buffer,
                                glong *delta_time,
                                glong *sequence);

Get sequence number.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
sequence	the return location of the sequence

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_smtpe ()

void
ags_midi_buffer_util_put_smtpe (guchar *buffer,
                                glong delta_time,
                                glong rr,
                                glong hr,
                                glong mn,
                                glong se,
                                glong fr);

Put smtpe timestamp.

Parameters

buffer	the character buffer
delta_time	timing information
rr	frame rate
hr	hour
mn	minute
se	second
fr	frame number

Since: 3.0.0

ags_midi_buffer_util_get_smtpe ()

guint
ags_midi_buffer_util_get_smtpe (guchar *buffer,
                                glong *delta_time,
                                glong *rr,
                                glong *hr,
                                glong *mn,
                                glong *se,
                                glong *fr);

Get smtpe timestamp.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
rr	the return location of frame rate
hr	the return location of hour
mn	the return location of minute
se	the return location of second
fr	the return location of frame number

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_tempo ()

void
ags_midi_buffer_util_put_tempo (guchar *buffer,
                                glong delta_time,
                                glong tempo);

Put tempo.

Parameters

buffer	the character buffer
delta_time	timing information
tempo	the tempo

Since: 3.0.0

ags_midi_buffer_util_get_tempo ()

guint
ags_midi_buffer_util_get_tempo (guchar *buffer,
                                glong *delta_time,
                                glong *tempo);

Get tempo.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
tempo	the tempo

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_time_signature ()

void
ags_midi_buffer_util_put_time_signature
                               (guchar *buffer,
                                glong delta_time,
                                glong nn,
                                glong dd,
                                glong cc,
                                glong bb);

Put time signature

Parameters

buffer	the character buffer
delta_time	timing information
nn	numerator
dd	denominator
cc	clocks
bb	beats

Since: 3.0.0

ags_midi_buffer_util_get_time_signature ()

guint
ags_midi_buffer_util_get_time_signature
                               (guchar *buffer,
                                glong *delta_time,
                                glong *nn,
                                glong *dd,
                                glong *cc,
                                glong *bb);

Get time signature.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
nn	the return location of numerator
dd	the return location of denominator
cc	the return location of clocks
bb	the return location of beats

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_key_signature ()

void
ags_midi_buffer_util_put_key_signature
                               (guchar *buffer,
                                glong delta_time,
                                glong sf,
                                glong mi);

Put key signature.

Parameters

buffer	the character buffer
delta_time	timing information
sf	flats or sharps
mi	1 equals minor or 0 means major

Since: 3.0.0

ags_midi_buffer_util_get_key_signature ()

guint
ags_midi_buffer_util_get_key_signature
                               (guchar *buffer,
                                glong *delta_time,
                                glong *sf,
                                glong *mi);

Get key signature.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
sf	the return location of flats or sharps
mi	the return location of minor or major

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_sequencer_meta_event ()

void
ags_midi_buffer_util_put_sequencer_meta_event
                               (guchar *buffer,
                                glong delta_time,
                                glong len,
                                glong id,
                                glong data);

Put sequencer meta event.

Parameters

buffer	the character buffer
delta_time	timing information
len	the length of data
id	the manufacturer id
data	the data

Since: 3.0.0

ags_midi_buffer_util_get_sequencer_meta_event ()

guint
ags_midi_buffer_util_get_sequencer_meta_event
                               (guchar *buffer,
                                glong *delta_time,
                                glong *len,
                                glong *id,
                                glong *data);

Get sequencer meta event.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
len	the return location of the length of data
id	the return location of the manufacturer id
data	the return location of the data

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_text_event ()

void
ags_midi_buffer_util_put_text_event (guchar *buffer,
                                     glong delta_time,
                                     gchar *text,
                                     glong length);

Put text event.

Parameters

buffer	the character buffer
delta_time	timing information
text	the text
length	the length

Since: 3.0.0

ags_midi_buffer_util_get_text_event ()

guint
ags_midi_buffer_util_get_text_event (guchar *buffer,
                                     glong *delta_time,
                                     gchar **text,
                                     glong *length);

Get text event.

Parameters

buffer	the character buffer
delta_time	the return location of timing information
text	the return location of the text
length	the return location of the length

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_put_end_of_track ()

void
ags_midi_buffer_util_put_end_of_track (guchar *buffer,
                                       glong delta_time);

Put end of track.

Parameters

buffer	the character buffer
delta_time	timing information

Since: 3.0.0

ags_midi_buffer_util_get_end_of_track ()

guint
ags_midi_buffer_util_get_end_of_track (guchar *buffer,
                                       glong *delta_time);

Get end of track.

Parameters

buffer	the character buffer
delta_time	the return location of timing information

Returns

the number of bytes read.

Since: 3.0.0

ags_midi_buffer_util_seek_message ()

guchar *
ags_midi_buffer_util_seek_message (guchar *buffer,
                                   guint message_count,
                                   glong *delta_time);

Seek MIDI messages from buffer

Parameters

buffer	the buffer to seek
message_count	seek count messages
delta_time	the return location of current delta time

Returns

the buffer at offset at message_count ahead

Since: 3.0.0

ags_midi_buffer_util_decode ()

guint
ags_midi_buffer_util_decode (guchar *buffer,
                             snd_seq_event_t *event);

Decode event to buffer

Parameters

buffer	the midi buffer
event	the ALSA sequencer event

Returns

the bytes written

Since: 3.0.0

Types and Values

enum AgsMidiBufferUtilMtcQuarterFrameMessageType

Members

AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_FRAME_NUMBER_LSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_FRAME_NUMBER_MSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_SECONDS_LSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_SECONDS_MSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_MINUTES_LSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_MINUTES_MSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_HOURS_LSB
AGS_MIDI_BUFFER_UTIL_MTC_QUARTER_FRAME_HOURS_MSB

enum AgsMidiBufferUtilSmtpeFrameRate

Members

AGS_MIDI_BUFFER_UTIL_SMTPE_FRAME_RATE_24_FPS
AGS_MIDI_BUFFER_UTIL_SMTPE_FRAME_RATE_25_FPS
AGS_MIDI_BUFFER_UTIL_SMTPE_FRAME_RATE_30_FPS
AGS_MIDI_BUFFER_UTIL_SMTPE_FRAME_RATE_30_FPS_DROP_FRAME