ModMusic Struct Reference

Music. More...

#include <modplay.h>

Data Fields
char	title [32]
	Music title.
int	sample_num
	Number of samples in the music.
int	channel_num
	Number of channels used by the music.
int	instrument_num
	Number of instruments used by the music.
ModSample *	sample
	Pointer to an array of ModSample structures.
ModInstrument *	instrument
	Pointer to an array of ModInstrument structures.
unsigned char	song_pos_num
	Number of song positions.
unsigned char	pattern_tbl [256]
	Pattern table.
unsigned char	pattern_row_num [256]
	Number of rows for each pattern.
char	id [4]
	ID, such as "M!K!","M.K.","FLT4", etc.
int	pattern_num
	Number of patterns.
unsigned char *	pattern_data
	Pointer to pattern data.
int	fmt
	Format of music.
unsigned char	song_pos
	[Runtime] Current song position
unsigned char	pat_pos
	[Runtime] Position inside the pattern currently being played
int	divisions_sec
	[Runtime] Divisions per second
unsigned char	beats_minute
	[Runtime] Beats per minute
unsigned char	ticks_division
	[Runtime] Ticks per division
unsigned char	cur_tick
	[Runtime] Current tick count
unsigned short	old_periods [8]
	[Runtime] Old periods for each channel.
unsigned char	old_samples [8]
	[Runtime] Old sample numbers for each channel.
short	transpose
	[Runtime] In PlayStation pitch, this is added to the original sample pitch and can be used to change the pitch of the music for special effects

Detailed Description

Music.

Field Documentation

unsigned char ModMusic::beats_minute

[Runtime] Beats per minute

int ModMusic::channel_num

Number of channels used by the music.

unsigned char ModMusic::cur_tick

[Runtime] Current tick count

int ModMusic::divisions_sec

[Runtime] Divisions per second

int ModMusic::fmt

Format of music.

char ModMusic::id[4]

ID, such as "M!K!","M.K.","FLT4", etc.

ModInstrument* ModMusic::instrument

Pointer to an array of ModInstrument structures.

int ModMusic::instrument_num

Number of instruments used by the music.

unsigned short ModMusic::old_periods[8]

[Runtime] Old periods for each channel.

unsigned char ModMusic::old_samples[8]

[Runtime] Old sample numbers for each channel.

unsigned char ModMusic::pat_pos

[Runtime] Position inside the pattern currently being played

unsigned char* ModMusic::pattern_data

Pointer to pattern data.

int ModMusic::pattern_num

Number of patterns.

unsigned char ModMusic::pattern_row_num[256]

Number of rows for each pattern.

unsigned char ModMusic::pattern_tbl[256]

Pattern table.

ModSample* ModMusic::sample

Pointer to an array of ModSample structures.

int ModMusic::sample_num

Number of samples in the music.

unsigned char ModMusic::song_pos

[Runtime] Current song position

unsigned char ModMusic::song_pos_num

Number of song positions.

unsigned char ModMusic::ticks_division

[Runtime] Ticks per division

char ModMusic::title[32]

Music title.

short ModMusic::transpose

[Runtime] In PlayStation pitch, this is added to the original sample pitch and can be used to change the pitch of the music for special effects

---

The documentation for this struct was generated from the following file:

• libmodplay/modplay.h