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

TrackBuilder that reads the bank files of the track named "BANK" into a BankLoader. More...

#include <bankloaderbuilder.h>

Inheritance diagram for BankLoaderBuilder:
Collaboration diagram for BankLoaderBuilder:

Public Member Functions

 BankLoaderBuilder (int nTrack, bool bValidate, ErrorHandler pfnError, int nIntroTicks, int nTicksPerBar, const String *pDirectory, BankLoader *pLoader)
 Construct a builder.
 ~BankLoaderBuilder () override
 Release the builder.
void OnNewTrack (unsigned char nTrack) override
 Ignore the start of the track.
void OnEndTrack () override
 Ignore the end of the track.
void OnAllDone () override
 Ignore the end of the file.
void OnMidi (int nTick, unsigned char nStatus, unsigned char nData1, unsigned char nData2) override
 Report a channel message, which the track must not have.
void OnTempo (int nTick, int nMicrosecondsPerBeat) override
 Ignore a tempo change.
void OnText (int nTick, const char *pszText, unsigned char nType) override
 Add the bank file of a text 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 reads the bank files of the track named "BANK" into a BankLoader.

The RTTI includes the class name and records TrackBuilder as the base. Each text event of the track gives a bank file. A file whose name ends in _p is a permanent bank, and one whose name ends in _s and a number is a swapped bank that plays from the bar of the event.

Constructor & Destructor Documentation

◆ BankLoaderBuilder()

BankLoaderBuilder::BankLoaderBuilder ( int nTrack,
bool bValidate,
ErrorHandler pfnError,
int nIntroTicks,
int nTicksPerBar,
const String * pDirectory,
BankLoader * pLoader )

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.
nIntroTicksThe length of the song intro.
nTicksPerBarThe song ticks in one bar.
pDirectoryThe directory of the bank files.
pLoaderThe loader to fill.
Ghidra address:
NTSC-U/C: 0x0014a458
Ghidra address:
PAL: 0x0014be18

◆ ~BankLoaderBuilder()

BankLoaderBuilder::~BankLoaderBuilder ( )
override

Release the builder.

Ghidra address:
NTSC-U/C: 0x0014a500
Ghidra address:
PAL: 0x0014bec0

Member Function Documentation

◆ OnNewTrack()

void BankLoaderBuilder::OnNewTrack ( unsigned char nTrack)
inlineoverridevirtual

Ignore the start of the track.

Parameters
nTrackThe track index.
Ghidra address:
NTSC-U/C: 0x00349ba0
Ghidra address:
PAL: 0x003b6fd0

Implements MidiReceiver.

◆ OnEndTrack()

void BankLoaderBuilder::OnEndTrack ( )
inlineoverridevirtual

Ignore the end of the track.

Ghidra address:
NTSC-U/C: 0x00349bc0
Ghidra address:
PAL: 0x003b6ff0

Implements MidiReceiver.

◆ OnAllDone()

void BankLoaderBuilder::OnAllDone ( )
inlineoverridevirtual

Ignore the end of the file.

Ghidra address:
NTSC-U/C: 0x00349ba8
Ghidra address:
PAL: 0x003b6fd8

Implements MidiReceiver.

◆ OnMidi()

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

Report a channel message, which the track must not have.

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

Implements MidiReceiver.

◆ OnTempo()

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

Ignore a tempo change.

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

Implements MidiReceiver.

◆ OnText()

void BankLoaderBuilder::OnText ( int nTick,
const char * pszText,
unsigned char nType )
overridevirtual

Add the bank file of a text event.

Parameters
nTickThe tick.
pszTextThe text.
nTypeThe meta event type. Only a plain text event gives a bank.
Ghidra address:
NTSC-U/C: 0x0014a570
Ghidra address:
PAL: 0x0014bf30

Implements MidiReceiver.

◆ OnTimeSignature()

void BankLoaderBuilder::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: 0x00349bb8
Ghidra address:
PAL: 0x003b6fe8

Implements MidiReceiver.


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