OpenTTD Source  20241109-master-g5e4f8db7d6
MidiFile Struct Reference

Data Structures

struct  DataBlock
 
struct  TempoChange
 

Public Member Functions

bool LoadFile (const std::string &filename)
 Load a standard MIDI file. More...
 
bool LoadMpsData (const uint8_t *data, size_t length)
 Create MIDI data from song data for the original Microprose music drivers. More...
 
bool LoadSong (const MusicSongInfo &song)
 
void MoveFrom (MidiFile &other)
 Move data from other to this, and clears other. More...
 
bool WriteSMF (const std::string &filename)
 Write a Standard MIDI File containing the decoded music. More...
 

Static Public Member Functions

static std::string GetSMFFile (const MusicSongInfo &song)
 Get the name of a Standard MIDI File for a given song. More...
 
static bool ReadSMFHeader (const std::string &filename, SMFHeader &header)
 Read the header of a standard MIDI file. More...
 
static bool ReadSMFHeader (FileHandle &file, SMFHeader &header)
 Read the header of a standard MIDI file. More...
 

Data Fields

std::vector< DataBlockblocks
 sequential time-annotated data of file, merged to a single track
 
std::vector< TempoChangetempos
 list of tempo changes in file
 
uint16_t tickdiv
 ticks per quarter note
 

Detailed Description

Definition at line 19 of file midifile.hpp.

Member Function Documentation

◆ GetSMFFile()

std::string MidiFile::GetSMFFile ( const MusicSongInfo song)
static

Get the name of a Standard MIDI File for a given song.

For songs already in SMF format, just returns the original. Otherwise the song is converted, written to a temporary-ish file, and the written filename is returned.

Parameters
songSong definition to query
Returns
Full filename string, empty string if failed

Definition at line 1028 of file midifile.cpp.

References BASESET_DIR, MusicSongInfo::filename, MusicSongInfo::filetype, FioFindFullPath(), MTT_MPSMIDI, MTT_STANDARDMIDI, and OLD_GM_DIR.

Referenced by MusicDriver_BeMidi::PlaySong(), MusicDriver_ExtMidi::PlaySong(), and MusicDriver_FluidSynth::PlaySong().

◆ LoadFile()

bool MidiFile::LoadFile ( const std::string &  filename)

Load a standard MIDI file.

Parameters
filenamename of the file to load
Returns
true if loaded was successful

Definition at line 447 of file midifile.cpp.

References BASESET_DIR, blocks, FioFOpenFile(), ReadSMFHeader(), tempos, and tickdiv.

◆ LoadMpsData()

bool MidiFile::LoadMpsData ( const uint8_t *  data,
size_t  length 
)

Create MIDI data from song data for the original Microprose music drivers.

Parameters
datapointer to block of data
lengthsize of data in bytes
Returns
true if the data could be loaded

Definition at line 825 of file midifile.cpp.

References MpsMachine::PlayInto().

◆ MoveFrom()

void MidiFile::MoveFrom ( MidiFile other)

Move data from other to this, and clears other.

Parameters
otherobject containing loaded data to take over

Definition at line 857 of file midifile.cpp.

References blocks, tempos, and tickdiv.

◆ ReadSMFHeader() [1/2]

bool MidiFile::ReadSMFHeader ( const std::string &  filename,
SMFHeader header 
)
static

Read the header of a standard MIDI file.

Parameters
[in]filenamename of file to read from
[out]headerfilled with data read
Returns
true if the file could be opened and contained a header with correct format

Definition at line 406 of file midifile.cpp.

References BASESET_DIR, and FioFOpenFile().

Referenced by LoadFile().

◆ ReadSMFHeader() [2/2]

bool MidiFile::ReadSMFHeader ( FileHandle file,
SMFHeader header 
)
static

Read the header of a standard MIDI file.

The function will consume 14 bytes from the current file pointer position.

Parameters
[in]fileopen file to read from (should be in binary mode)
[out]headerfilled with data read
Returns
true if a header in correct format could be read from the file

Definition at line 421 of file midifile.cpp.

References MemCmpT().

◆ WriteSMF()

bool MidiFile::WriteSMF ( const std::string &  filename)

Write a Standard MIDI File containing the decoded music.

Parameters
filenameName of file to write to
Returns
True if the file was written to completion

Definition at line 901 of file midifile.cpp.

References blocks, MidiFile::DataBlock::data, FioFOpenFile(), NO_DIRECTORY, MidiFile::TempoChange::tempo, tempos, tickdiv, MidiFile::DataBlock::ticktime, and MidiFile::TempoChange::ticktime.


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