wavelength 1.0.0
Loading...
Searching...
No Matches
MixMidiBuilder Class Reference

Reader of the MIDI file of a menu song that builds a piece of music for each track a mix of the song lists. More...

#include <mixmidibuilder.h>

Classes

class  BuilderReceiver
 Receiver that hands every event of the file to its builder. More...
struct  TrackData
 One piece of music built from a track of the file. More...

Public Member Functions

 MixMidiBuilder (DataArray *pConfig)
 Collect the track names of the mix entry of a menu song.
 ~MixMidiBuilder ()
 Release the pieces and the reader.
void StartLoad ()
 Start reading the file the music_shared_midi_file entry of the metagame configuration specifies into a buffer.
void Poll ()
 Read more of the file, or parse more of its events once it has been read.
int IsDone () const
 Report whether every event has been parsed.
int NumTracks () const
 Report the number of pieces built.
Muse * TrackMuse (int nTrack) const
 Report a piece.
unsigned char TrackChannel (int nTrack) const
 Report the MIDI channel of a piece.
const String & TrackName (int nTrack) const
 Report the name of the track of a piece.

Detailed Description

Reader of the MIDI file of a menu song that builds a piece of music for each track a mix of the song lists.

The RTTI includes the class name in the nested classes MixMidiBuilder::BuilderReceiver and MixMidiBuilder::TrackData. The class is not polymorphic. The object is 0x7c bytes. The file is read a part at a time.

Constructor & Destructor Documentation

◆ MixMidiBuilder()

MixMidiBuilder::MixMidiBuilder ( DataArray * pConfig)
explicit

Collect the track names of the mix entry of a menu song.

Parameters
pConfigThe entry of the song.
Ghidra address:
NTSC-U/C: 0x0016aab0
Ghidra address:
PAL: 0x0016dc38

◆ ~MixMidiBuilder()

MixMidiBuilder::~MixMidiBuilder ( )

Release the pieces and the reader.

Ghidra address:
NTSC-U/C: 0x0016acf0
Ghidra address:
PAL: 0x0016de78

Member Function Documentation

◆ StartLoad()

void MixMidiBuilder::StartLoad ( )

Start reading the file the music_shared_midi_file entry of the metagame configuration specifies into a buffer.

Ghidra address:
NTSC-U/C: 0x0016ae78
Ghidra address:
PAL: 0x0016e000

◆ Poll()

void MixMidiBuilder::Poll ( )

Read more of the file, or parse more of its events once it has been read.

Ghidra address:
NTSC-U/C: 0x0016af58
Ghidra address:
PAL: 0x0016e0e0

◆ IsDone()

int MixMidiBuilder::IsDone ( ) const

Report whether every event has been parsed.

Returns
Non-zero when the pieces are built.
Ghidra address:
NTSC-U/C: 0x0016b048
Ghidra address:
PAL: 0x0016e1d0

◆ NumTracks()

int MixMidiBuilder::NumTracks ( ) const

Report the number of pieces built.

Returns
The number of pieces.
Ghidra address:
NTSC-U/C: 0x0016b050
Ghidra address:
PAL: 0x0016e1d8

◆ TrackMuse()

Muse * MixMidiBuilder::TrackMuse ( int nTrack) const

Report a piece.

Parameters
nTrackThe index of the piece.
Returns
The piece.
Ghidra address:
NTSC-U/C: 0x0016b070
Ghidra address:
PAL: 0x0016e1f8

◆ TrackChannel()

unsigned char MixMidiBuilder::TrackChannel ( int nTrack) const

Report the MIDI channel of a piece.

Parameters
nTrackThe index of the piece.
Returns
The channel.
Ghidra address:
NTSC-U/C: 0x0016b098
Ghidra address:
PAL: 0x0016e220

◆ TrackName()

const String & MixMidiBuilder::TrackName ( int nTrack) const

Report the name of the track of a piece.

Parameters
nTrackThe index of the piece.
Returns
The name.
Ghidra address:
NTSC-U/C: 0x0016b0b0
Ghidra address:
PAL: 0x0016e238

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