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

TrackBuilder that cuts the channel messages of a background music track into one muse per bar. More...

#include <backmusicbuilder.h>

Inheritance diagram for BackMusicBuilder:
Collaboration diagram for BackMusicBuilder:

Public Member Functions

 BackMusicBuilder (int nTrack, bool bValidate, ErrorHandler pfnError, int nIntroBars, int nNumBars, int nTicksPerBar, BackMusic *pMusic)
 Construct a builder.
 ~BackMusicBuilder () override
 Release the builder.
void OnNewTrack (unsigned char nTrack) override
 Ignore the start of the track.
void OnEndTrack () override
 Give the music the muse of every bar.
void OnAllDone () override
 Ignore the end of the file.
void OnMidi (int nTick, unsigned char nStatus, unsigned char nData1, unsigned char nData2) override
 Collect a channel message.
void OnTempo (int nTick, int nMicrosecondsPerBeat) override
 Ignore a tempo change.
void OnText (int nTick, const char *pszText, unsigned char nType) override
 Ignore a text meta event.
void OnTimeSignature (int nTick, int nNumerator, int nDenominator) override
 Ignore a time signature.
Public Member Functions inherited from TrackBuilder
 TrackBuilder (int nTrack, bool bValidate, ErrorHandler pfnError)
 Construct a builder.
 ~TrackBuilder () override
 Release the builder.
void Error (int nTick, const char *pszMessage)
 Report a build error at a tick.
Public Member Functions inherited from MidiReceiver
virtual ~MidiReceiver ()
 Release the receiver.

Additional Inherited Members

Public Types inherited from TrackBuilder
typedef void(* ErrorHandler) (String &message)
 Routine that reports a build error.
Protected Attributes inherited from TrackBuilder
int mTrack
int mValidate
ErrorHandler mErrorHandler

Detailed Description

TrackBuilder that cuts the channel messages of a background music track into one muse per bar.

The RTTI includes the class name and records TrackBuilder as the base. The object is 0x98 bytes.

Constructor & Destructor Documentation

◆ BackMusicBuilder()

BackMusicBuilder::BackMusicBuilder ( int nTrack,
bool bValidate,
ErrorHandler pfnError,
int nIntroBars,
int nNumBars,
int nTicksPerBar,
BackMusic * pMusic )

Construct a builder.

Parameters
nTrackThe number of the MIDI track the error messages give.
bValidateCheck the events for authoring errors.
pfnErrorThe routine that reports an error, or null to print it.
nIntroBarsThe bars before bar 0.
nNumBarsThe length of the song in bars.
nTicksPerBarThe song ticks in one bar.
pMusicThe music to fill.
Ghidra address:
NTSC-U/C: 0x00149950
Ghidra address:
PAL: 0x0014b310

◆ ~BackMusicBuilder()

BackMusicBuilder::~BackMusicBuilder ( )
override

Release the builder.

Ghidra address:
NTSC-U/C: 0x00149a00
Ghidra address:
PAL: 0x0014b3c0

Member Function Documentation

◆ OnNewTrack()

void BackMusicBuilder::OnNewTrack ( unsigned char nTrack)
inlineoverridevirtual

Ignore the start of the track.

Parameters
nTrackThe track index.
Ghidra address:
NTSC-U/C: 0x00349a48
Ghidra address:
PAL: 0x003b6e78

Implements MidiReceiver.

◆ OnEndTrack()

void BackMusicBuilder::OnEndTrack ( )
overridevirtual

Give the music the muse of every bar.

Ghidra address:
NTSC-U/C: 0x00149a60
Ghidra address:
PAL: 0x0014b420

Implements MidiReceiver.

◆ OnAllDone()

void BackMusicBuilder::OnAllDone ( )
inlineoverridevirtual

Ignore the end of the file.

Ghidra address:
NTSC-U/C: 0x00349a50
Ghidra address:
PAL: 0x003b6e80

Implements MidiReceiver.

◆ OnMidi()

void BackMusicBuilder::OnMidi ( int nTick,
unsigned char nStatus,
unsigned char nData1,
unsigned char nData2 )
overridevirtual

Collect a channel message.

Parameters
nTickThe tick.
nStatusThe status byte.
nData1The first data byte.
nData2The second data byte.
Ghidra address:
NTSC-U/C: 0x00149af8
Ghidra address:
PAL: 0x0014b4b8

Implements MidiReceiver.

◆ OnTempo()

void BackMusicBuilder::OnTempo ( int nTick,
int nMicrosecondsPerBeat )
inlineoverridevirtual

Ignore a tempo change.

Parameters
nTickThe tick.
nMicrosecondsPerBeatThe new tempo.
Ghidra address:
NTSC-U/C: 0x00349a58
Ghidra address:
PAL: 0x003b6e88

Implements MidiReceiver.

◆ OnText()

void BackMusicBuilder::OnText ( int nTick,
const char * pszText,
unsigned char nType )
inlineoverridevirtual

Ignore a text meta event.

Parameters
nTickThe tick.
pszTextThe text.
nTypeThe meta event type.
Ghidra address:
NTSC-U/C: 0x00349a60
Ghidra address:
PAL: 0x003b6e90

Implements MidiReceiver.

◆ OnTimeSignature()

void BackMusicBuilder::OnTimeSignature ( int nTick,
int nNumerator,
int nDenominator )
inlineoverridevirtual

Ignore a time signature.

Parameters
nTickThe tick.
nNumeratorThe beats per bar.
nDenominatorThe beat unit.
Ghidra address:
NTSC-U/C: 0x00349a68
Ghidra address:
PAL: 0x003b6e98

Implements MidiReceiver.


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