svcore  1.9
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
MIDIFileReader Class Reference

#include <MIDIFileReader.h>

Inheritance diagram for MIDIFileReader:
Inheritance graph
[legend]
Collaboration diagram for MIDIFileReader:
Collaboration graph
[legend]

Public Member Functions

 MIDIFileReader (QString path, MIDIFileImportPreferenceAcquirer *pref, int mainModelSampleRate)
 
virtual ~MIDIFileReader ()
 
virtual bool isOK () const
 Return true if the file appears to be of the correct type. More...
 
virtual QString getError () const
 
virtual Model * load () const
 Read the file and return the corresponding data model. More...
 

Protected Types

enum  MIDIFileFormatType { MIDI_SINGLE_TRACK_FILE = 0x00, MIDI_SIMULTANEOUS_TRACK_FILE = 0x01, MIDI_SEQUENTIAL_TRACK_FILE = 0x02, MIDI_FILE_BAD_FORMAT = 0xFF }
 
typedef std::vector< MIDIEvent * > MIDITrack
 
typedef std::map< unsigned int, MIDITrack > MIDIComposition
 
typedef std::pair< RealTime, double > TempoChange
 
typedef std::map< unsigned long, TempoChange > TempoMap
 

Protected Member Functions

bool parseFile ()
 
bool parseHeader (const std::string &midiHeader)
 
bool parseTrack (unsigned int &trackNum)
 
Model * loadTrack (unsigned int trackNum, Model *existingModel=0, int minProgress=0, int progressAmount=100) const
 
bool consolidateNoteOffEvents (unsigned int track)
 
void updateTempoMap (unsigned int track)
 
void calculateTempoTimestamps ()
 
RealTime getTimeForMIDITime (unsigned long midiTime) const
 
int midiBytesToInt (const std::string &bytes)
 
long midiBytesToLong (const std::string &bytes)
 
long getNumberFromMIDIBytes (int firstByte=-1)
 
MIDIByte getMIDIByte ()
 
std::string getMIDIBytes (unsigned long bytes)
 
bool skipToNextTrack ()
 

Protected Attributes

bool m_smpte
 
int m_timingDivision
 
int m_fps
 
int m_subframes
 
MIDIFileFormatType m_format
 
unsigned int m_numberOfTracks
 
long m_trackByteCount
 
bool m_decrementCount
 
std::map< int, QString > m_trackNames
 
std::set< unsigned int > m_loadableTracks
 
std::set< unsigned int > m_percussionTracks
 
MIDIComposition m_midiComposition
 
TempoMap m_tempoMap
 
QString m_path
 
std::ifstream * m_midiFile
 
int m_fileSize
 
QString m_error
 
int m_mainModelSampleRate
 
MIDIFileImportPreferenceAcquirer * m_acquirer
 

Detailed Description

Definition at line 58 of file MIDIFileReader.h.

Member Typedef Documentation

◆ MIDITrack

typedef std::vector<MIDIEvent *> MIDIFileReader::MIDITrack
protected

Definition at line 73 of file MIDIFileReader.h.

◆ MIDIComposition

typedef std::map<unsigned int, MIDITrack> MIDIFileReader::MIDIComposition
protected

Definition at line 74 of file MIDIFileReader.h.

◆ TempoChange

typedef std::pair<RealTime, double> MIDIFileReader::TempoChange
protected

Definition at line 75 of file MIDIFileReader.h.

◆ TempoMap

typedef std::map<unsigned long, TempoChange> MIDIFileReader::TempoMap
protected

Definition at line 76 of file MIDIFileReader.h.

Member Enumeration Documentation

◆ MIDIFileFormatType

enum MIDIFileReader::MIDIFileFormatType
protected
Enumerator
MIDI_SINGLE_TRACK_FILE 
MIDI_SIMULTANEOUS_TRACK_FILE 
MIDI_SEQUENTIAL_TRACK_FILE 
MIDI_FILE_BAD_FORMAT 

Definition at line 78 of file MIDIFileReader.h.

Constructor & Destructor Documentation

◆ MIDIFileReader()

MIDIFileReader::MIDIFileReader ( QString  path,
MIDIFileImportPreferenceAcquirer *  pref,
int  mainModelSampleRate 
)

Definition at line 58 of file MIDIFileReader.cpp.

References m_error, and parseFile().

◆ ~MIDIFileReader()

MIDIFileReader::~MIDIFileReader ( )
virtual

Definition at line 80 of file MIDIFileReader.cpp.

References m_midiComposition.

Member Function Documentation

◆ isOK()

bool MIDIFileReader::isOK ( ) const
virtual

Return true if the file appears to be of the correct type.

The DataFileReader will be constructed by passing a file path to its constructor. If the file can at that time be determined to be not of a type that this reader can read, it should return false in response to any subsequent call to isOK().

If the file is apparently of the correct type, isOK() should return true; if it turns out that the file cannot after all be read (because it's corrupted or the detection misfired), then the read() function may return NULL.

Implements DataFileReader.

Definition at line 97 of file MIDIFileReader.cpp.

References m_error.

Referenced by load().

◆ getError()

QString MIDIFileReader::getError ( ) const
virtual

Reimplemented from DataFileReader.

Definition at line 103 of file MIDIFileReader.cpp.

References m_error.

◆ load()

Model * MIDIFileReader::load ( ) const
virtual

Read the file and return the corresponding data model.

This function is not expected to be thread-safe or reentrant. This function may be interactive (i.e. it's permitted to pop up dialogs and windows and ask the user to specify any details that can't be automatically extracted from the file).

Return NULL if the file cannot be parsed at all (although it's preferable to return a partial model and warn the user).

Caller owns the returned model and must delete it after use.

Implements DataFileReader.

Definition at line 798 of file MIDIFileReader.cpp.

References MIDIFileImportPreferenceAcquirer::getTrackImportPreference(), MIDIFileImportPreferenceAcquirer::ImportNothing, isOK(), loadTrack(), m_acquirer, m_loadableTracks, m_path, m_percussionTracks, m_trackNames, MIDIFileImportPreferenceAcquirer::MergeAllNonPercussionTracks, MIDIFileImportPreferenceAcquirer::MergeAllTracks, and MIDIFileImportPreferenceAcquirer::showError().

◆ parseFile()

bool MIDIFileReader::parseFile ( )
protected

Definition at line 276 of file MIDIFileReader.cpp.

References calculateTempoTimestamps(), consolidateNoteOffEvents(), getMIDIBytes(), m_error, m_fileSize, m_format, m_loadableTracks, m_midiComposition, m_midiFile, m_numberOfTracks, m_path, m_trackByteCount, MIDI_FILE_BAD_FORMAT, parseHeader(), parseTrack(), skipToNextTrack(), SVDEBUG, updateTempoMap(), and MIDIException::what().

Referenced by MIDIFileReader().

◆ parseHeader()

bool MIDIFileReader::parseHeader ( const std::string &  midiHeader)
protected

Definition at line 391 of file MIDIFileReader.cpp.

References m_format, m_fps, m_numberOfTracks, m_smpte, m_subframes, m_timingDivision, MIDIConstants::MIDI_FILE_HEADER, midiBytesToInt(), midiBytesToLong(), and SVDEBUG.

Referenced by parseFile().

◆ parseTrack()

bool MIDIFileReader::parseTrack ( unsigned int &  trackNum)
protected

Definition at line 437 of file MIDIFileReader.cpp.

References MIDIEvent::getChannelNumber(), getMIDIByte(), getMIDIBytes(), getNumberFromMIDIBytes(), m_midiComposition, m_midiFile, m_percussionTracks, m_trackByteCount, m_trackNames, MIDIConstants::MIDI_CHANNEL_NUM_MASK, MIDIConstants::MIDI_CHNL_AFTERTOUCH, MIDIConstants::MIDI_CTRL_CHANGE, MIDIConstants::MIDI_END_OF_EXCLUSIVE, MIDIConstants::MIDI_FILE_META_EVENT, MIDIConstants::MIDI_MESSAGE_TYPE_MASK, MIDIConstants::MIDI_NOTE_OFF, MIDIConstants::MIDI_NOTE_ON, MIDIConstants::MIDI_PERCUSSION_CHANNEL, MIDIConstants::MIDI_PITCH_BEND, MIDIConstants::MIDI_POLY_AFTERTOUCH, MIDIConstants::MIDI_PROG_CHANGE, MIDIConstants::MIDI_STATUS_BYTE_MASK, MIDIConstants::MIDI_SYSTEM_EXCLUSIVE, MIDIConstants::MIDI_TRACK_NAME, and SVDEBUG.

Referenced by parseFile().

◆ loadTrack()

Model * MIDIFileReader::loadTrack ( unsigned int  trackNum,
Model *  existingModel = 0,
int  minProgress = 0,
int  progressAmount = 100 
) const
protected

Definition at line 914 of file MIDIFileReader.cpp.

References SparseValueModel< PointType >::addPoint(), RealTime::frame2RealTime(), Pitch::getPitchLabel(), SparseModel< PointType >::getSampleRate(), getTimeForMIDITime(), m_fps, m_mainModelSampleRate, m_midiComposition, m_smpte, m_subframes, MIDIConstants::MIDI_CHANNEL_PREFIX, MIDIConstants::MIDI_CHANNEL_PREFIX_OR_PORT, MIDIConstants::MIDI_CHNL_AFTERTOUCH, MIDIConstants::MIDI_COPYRIGHT_NOTICE, MIDIConstants::MIDI_CTRL_CHANGE, MIDIConstants::MIDI_CUE_POINT, MIDIConstants::MIDI_INSTRUMENT_NAME, MIDIConstants::MIDI_KEY_SIGNATURE, MIDIConstants::MIDI_LYRIC, MIDIConstants::MIDI_NOTE_OFF, MIDIConstants::MIDI_NOTE_ON, MIDIConstants::MIDI_PITCH_BEND, MIDIConstants::MIDI_POLY_AFTERTOUCH, MIDIConstants::MIDI_PROG_CHANGE, MIDIConstants::MIDI_SEQUENCE_NUMBER, MIDIConstants::MIDI_SEQUENCER_SPECIFIC, MIDIConstants::MIDI_SET_TEMPO, MIDIConstants::MIDI_SMPTE_OFFSET, MIDIConstants::MIDI_SYSTEM_EXCLUSIVE, MIDIConstants::MIDI_TEXT_EVENT, MIDIConstants::MIDI_TEXT_MARKER, MIDIConstants::MIDI_TIME_SIGNATURE, MIDIConstants::MIDI_TRACK_NAME, RealTime::realTime2Frame(), SparseModel< PointType >::setCompletion(), and NoteModel::setValueQuantization().

Referenced by load().

◆ consolidateNoteOffEvents()

bool MIDIFileReader::consolidateNoteOffEvents ( unsigned int  track)
protected

Definition at line 658 of file MIDIFileReader.cpp.

References m_midiComposition, MIDIConstants::MIDI_NOTE_OFF, and MIDIConstants::MIDI_NOTE_ON.

Referenced by parseFile().

◆ updateTempoMap()

void MIDIFileReader::updateTempoMap ( unsigned int  track)
protected

Definition at line 707 of file MIDIFileReader.cpp.

References m_midiComposition, m_tempoMap, MIDIConstants::MIDI_SET_TEMPO, and RealTime::zeroTime.

Referenced by parseFile().

◆ calculateTempoTimestamps()

void MIDIFileReader::calculateTempoTimestamps ( )
protected

Definition at line 735 of file MIDIFileReader.cpp.

References RealTime::fromSeconds(), m_tempoMap, m_timingDivision, and RealTime::zeroTime.

Referenced by parseFile().

◆ getTimeForMIDITime()

RealTime MIDIFileReader::getTimeForMIDITime ( unsigned long  midiTime) const
protected

Definition at line 761 of file MIDIFileReader.cpp.

References RealTime::fromSeconds(), m_tempoMap, m_timingDivision, and RealTime::zeroTime.

Referenced by loadTrack().

◆ midiBytesToInt()

int MIDIFileReader::midiBytesToInt ( const std::string &  bytes)
protected

Definition at line 124 of file MIDIFileReader.cpp.

Referenced by parseHeader().

◆ midiBytesToLong()

long MIDIFileReader::midiBytesToLong ( const std::string &  bytes)
protected

Definition at line 109 of file MIDIFileReader.cpp.

Referenced by parseHeader(), and skipToNextTrack().

◆ getNumberFromMIDIBytes()

long MIDIFileReader::getNumberFromMIDIBytes ( int  firstByte = -1)
protected

Definition at line 211 of file MIDIFileReader.cpp.

References getMIDIByte(), and m_midiFile.

Referenced by parseTrack().

◆ getMIDIByte()

MIDIByte MIDIFileReader::getMIDIByte ( )
protected

Definition at line 141 of file MIDIFileReader.cpp.

References m_decrementCount, m_midiFile, and m_trackByteCount.

Referenced by getNumberFromMIDIBytes(), and parseTrack().

◆ getMIDIBytes()

string MIDIFileReader::getMIDIBytes ( unsigned long  bytes)
protected

Definition at line 170 of file MIDIFileReader.cpp.

References m_decrementCount, m_midiFile, and m_trackByteCount.

Referenced by parseFile(), parseTrack(), and skipToNextTrack().

◆ skipToNextTrack()

bool MIDIFileReader::skipToNextTrack ( )
protected

Definition at line 245 of file MIDIFileReader.cpp.

References getMIDIBytes(), m_decrementCount, m_midiFile, m_trackByteCount, MIDIConstants::MIDI_TRACK_HEADER, and midiBytesToLong().

Referenced by parseFile().

Member Data Documentation

◆ m_smpte

bool MIDIFileReader::m_smpte
protected

Definition at line 111 of file MIDIFileReader.h.

Referenced by loadTrack(), and parseHeader().

◆ m_timingDivision

int MIDIFileReader::m_timingDivision
protected

Definition at line 112 of file MIDIFileReader.h.

Referenced by calculateTempoTimestamps(), getTimeForMIDITime(), and parseHeader().

◆ m_fps

int MIDIFileReader::m_fps
protected

Definition at line 113 of file MIDIFileReader.h.

Referenced by loadTrack(), and parseHeader().

◆ m_subframes

int MIDIFileReader::m_subframes
protected

Definition at line 114 of file MIDIFileReader.h.

Referenced by loadTrack(), and parseHeader().

◆ m_format

MIDIFileFormatType MIDIFileReader::m_format
protected

Definition at line 115 of file MIDIFileReader.h.

Referenced by parseFile(), and parseHeader().

◆ m_numberOfTracks

unsigned int MIDIFileReader::m_numberOfTracks
protected

Definition at line 116 of file MIDIFileReader.h.

Referenced by parseFile(), and parseHeader().

◆ m_trackByteCount

long MIDIFileReader::m_trackByteCount
protected

Definition at line 118 of file MIDIFileReader.h.

Referenced by getMIDIByte(), getMIDIBytes(), parseFile(), parseTrack(), and skipToNextTrack().

◆ m_decrementCount

bool MIDIFileReader::m_decrementCount
protected

Definition at line 119 of file MIDIFileReader.h.

Referenced by getMIDIByte(), getMIDIBytes(), and skipToNextTrack().

◆ m_trackNames

std::map<int, QString> MIDIFileReader::m_trackNames
protected

Definition at line 121 of file MIDIFileReader.h.

Referenced by load(), and parseTrack().

◆ m_loadableTracks

std::set<unsigned int> MIDIFileReader::m_loadableTracks
protected

Definition at line 122 of file MIDIFileReader.h.

Referenced by load(), and parseFile().

◆ m_percussionTracks

std::set<unsigned int> MIDIFileReader::m_percussionTracks
protected

Definition at line 123 of file MIDIFileReader.h.

Referenced by load(), and parseTrack().

◆ m_midiComposition

MIDIComposition MIDIFileReader::m_midiComposition
protected

Definition at line 124 of file MIDIFileReader.h.

Referenced by consolidateNoteOffEvents(), loadTrack(), parseFile(), parseTrack(), updateTempoMap(), and ~MIDIFileReader().

◆ m_tempoMap

TempoMap MIDIFileReader::m_tempoMap
protected

Definition at line 125 of file MIDIFileReader.h.

Referenced by calculateTempoTimestamps(), getTimeForMIDITime(), and updateTempoMap().

◆ m_path

QString MIDIFileReader::m_path
protected

Definition at line 127 of file MIDIFileReader.h.

Referenced by load(), and parseFile().

◆ m_midiFile

std::ifstream* MIDIFileReader::m_midiFile
protected

Definition at line 128 of file MIDIFileReader.h.

Referenced by getMIDIByte(), getMIDIBytes(), getNumberFromMIDIBytes(), parseFile(), parseTrack(), and skipToNextTrack().

◆ m_fileSize

int MIDIFileReader::m_fileSize
protected

Definition at line 129 of file MIDIFileReader.h.

Referenced by parseFile().

◆ m_error

QString MIDIFileReader::m_error
protected

Definition at line 130 of file MIDIFileReader.h.

Referenced by getError(), isOK(), MIDIFileReader(), and parseFile().

◆ m_mainModelSampleRate

int MIDIFileReader::m_mainModelSampleRate
protected

Definition at line 131 of file MIDIFileReader.h.

Referenced by loadTrack().

◆ m_acquirer

MIDIFileImportPreferenceAcquirer* MIDIFileReader::m_acquirer
protected

Definition at line 133 of file MIDIFileReader.h.

Referenced by load().

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