resonance 1.0.1
Loading...
Searching...
No Matches
Sch::Tick Class Reference

Song position in MIDI ticks, printed as measure, beat, and tick. More...

#include <tick.h>

Public Member Functions

 Tick ()
 Start the position at kTickInfinity.
 Tick (int nTick)
 Wrap a tick count, checking that it is finite.
OBStream & saveGuts (OBStream &stream) const
 Write the position.
IBStream & restoreGuts (IBStream &stream)
 Read the position back.
void Print (std::ostream &stream) const
 Write the position to a diagnostic stream as measure, beat, and tick.

Static Public Member Functions

static int IsInRange (int nTick)
 Report whether a position is finite.

Public Attributes

int mTick
 The position, in MIDI ticks at 480 per quarter note.

Detailed Description

Song position in MIDI ticks, printed as measure, beat, and tick.

Its name comes from the debugging symbols of the North American demo release. The demo's Print(), saveGuts(), restoreGuts(), and IsInRange() have the same instructions as this class's.

The object is four bytes and the class is not polymorphic, so it emits no vtable and no RTTI. The anonymous-namespace marker for the file-local commands of Catcher records the constructor signature Catcher(PhraseMgr *, Quantizer *, const TrackData *, Sch::TickClock *, int, Sch::Tick), and that constructor stores the last parameter with one sw.

The image's RTTI descriptor for Mid::MBT belongs to a different, unused class. That class is 0x10 bytes, with a one-based measure at +0x0, a one-based beat at +0x4, the tick within the beat at +0x8, and a vptr at +0xc. Its vtable at 0x008110e8 has the accessor at 0x003d63f8 in slot 0 and a Print() at 0x003d67f0 in slot 1 that writes [measure:beat:tick]. Its inline constructor at 0x003d6798 splits a tick count by beats per measure and ticks per beat. No code refers to the constructor, the Print(), or the vtable.

Print() fixes the units. It divides the word by 1920 for a measure, divides the remainder by 480 for a beat, and prints the second remainder as the tick, then appends tk. Measure and beat are both incremented before printing and are therefore one-based, and 480 ticks per beat with four beats per measure agrees with Sch::TickClock, which reports a song position as MIDI ticks at 480 per quarter note.

Two sentinels bound the range. A word above 0x2aaaaaa8 prints [inf]tk and a word at or below -715827881 prints [-inf]tk, so a position outside those bounds is infinite rather than numeric. GemPacket initialises its own member to 0x2aaaaaab, which is inside the positive sentinel range.

Sch::CmdID and Sch::Time are both distinct from this class and are easy to confuse with it, because all three stream through WriteLE() and ReadLE() with the same three-function shape. The three Print() bodies separate them. CmdID::Print writes {cmdID , Sch::Time::Print divides by 1000000000.0 and appends s, and this class writes the three-part form above. CatchProgressPacket and TrackSelectPacket each stream a member through the emission at 0x004acf28 and print the same member through Print() here. Both members are therefore this class.

The three addresses below are the emission the scheduler translation unit uses, and a second emission of saveGuts() exists elsewhere, which is the shape of an inline member rather than of an ordinary out-of-line one. The bodies are defined out of line here, keeping the two stream classes forward-declared for the many headers that include this one.

The one member is public, because the readers of a position apply arithmetic to it directly and the image exposes no accessor.

Constructor & Destructor Documentation

◆ Tick() [1/2]

Sch::Tick::Tick ( )
inline

Start the position at kTickInfinity.

Inline, and expanded wherever an object holding a position is constructed. Every New() factory whose class has a member of this type stores 0x2aaaaaab into that member and into no other field. NoteMsg::New() at 0x003d6d80, EraseMsg::New() at 0x003d6b28, and SeekerMsg::New() at 0x003d6f10 are three of them, at three different member offsets.

◆ Tick() [2/2]

Sch::Tick::Tick ( int nTick)
inlineexplicit

Wrap a tick count, checking that it is finite.

Inline. The check is an IsInRange() call whose result is discarded, the shape of an assertion compiled without its report, and it sits beside the store of the same value at every site that builds a position from a plain count. NoteMsg::restoreGuts() at 0x003e3890 is one, and the gameplay classes Phrase, GsPeriodical, TrackData, Catcher, and PhraseMaker show the same pairing.

Parameters
nTickThe position, in MIDI ticks.

Member Function Documentation

◆ IsInRange()

int Sch::Tick::IsInRange ( int nTick)
static

Report whether a position is finite.

The body adds 0x2aaaaaaa to the position and compares the sum against 0x55555554 as an unsigned value. The one test accepts the closed range from kTickMinimum to kTickMaximum. Several callers discard the result, the shape of an assertion compiled without its report.

The bound here and the bound Print() applies differ by two. Print() renders any value above 0x2aaaaaa8 as infinite while this test accepts up to 0x2aaaaaaa. Two positions are therefore finite by this test and infinite to the printer.

The one emission sits in the unit at 0x00100040, between the Sequencer template and SequencerCmd, and every caller calls that copy.

Parameters
nTickThe position, in MIDI ticks.
Returns
Non-zero for a finite position.
Ghidra address:
NTSC-U/C: 0x00100ab8
Ghidra address:
PAL: 0x00100ab8

◆ saveGuts()

OBStream & Sch::Tick::saveGuts ( OBStream & stream) const

Write the position.

Parameters
streamThe stream to write to.
Returns
The stream, allowing calls to be chained.
Ghidra address:
NTSC-U/C: 0x004acf28
Ghidra address:
PAL: 0x004eb0c8

◆ restoreGuts()

IBStream & Sch::Tick::restoreGuts ( IBStream & stream)

Read the position back.

Parameters
streamThe stream to read from.
Returns
The stream, allowing calls to be chained.
Ghidra address:
NTSC-U/C: 0x004acf68
Ghidra address:
PAL: 0x004eb108

◆ Print()

void Sch::Tick::Print ( std::ostream & stream) const

Write the position to a diagnostic stream as measure, beat, and tick.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x004ace18
Ghidra address:
PAL: 0x004eafb8

Member Data Documentation

◆ mTick

int Sch::Tick::mTick

The position, in MIDI ticks at 480 per quarter note.

+0x00


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