qsmf.h

Go to the documentation of this file.

/*
    Standard MIDI File component
    Copyright (C) 2006-2023, Pedro Lopez-Cabanillas <plcl@users.sf.net>
 
    Based on midifile.c by Tim Thompson, M.Czeiszperger and Greg Lee
 
    This library is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DRUMSTICK_QSMF_H
#define DRUMSTICK_QSMF_H
 
#include "macros.h"
#include <QObject>
#include <QScopedPointer>
 
class QTextCodec;
class QDataStream;
 
#if defined(DRUMSTICK_STATIC)
#define DRUMSTICK_FILE_EXPORT
#else
#if defined(drumstick_file_EXPORTS)
#define DRUMSTICK_FILE_EXPORT Q_DECL_EXPORT
#else
#define DRUMSTICK_FILE_EXPORT Q_DECL_IMPORT
#endif
#endif
 
namespace drumstick {
namespace File {
 
const quint32 MThd = 0x4d546864; 
const quint32 MTrk = 0x4d54726b; 
/* Standard MIDI Files meta event definitions */
const quint8 meta_event =         0xff; 
const quint8 sequence_number =    0x00; 
const quint8 text_event =         0x01; 
const quint8 copyright_notice =   0x02; 
const quint8 sequence_name =      0x03; 
const quint8 instrument_name =    0x04; 
const quint8 lyric =              0x05; 
const quint8 marker =             0x06; 
const quint8 cue_point =          0x07; 
const quint8 forced_channel =     0x20; 
const quint8 forced_port =        0x21; 
const quint8 end_of_track =       0x2f; 
const quint8 set_tempo =          0x51; 
const quint8 smpte_offset =       0x54; 
const quint8 time_signature =     0x58; 
const quint8 key_signature =      0x59; 
const quint8 sequencer_specific = 0x7f; 
/* MIDI status commands most significant bit is 1 */
const quint8 note_off =           0x80; 
const quint8 note_on =            0x90; 
const quint8 poly_aftertouch =    0xa0; 
const quint8 control_change =     0xb0; 
const quint8 program_chng =       0xc0; 
const quint8 channel_aftertouch = 0xd0; 
const quint8 pitch_wheel =        0xe0; 
const quint8 system_exclusive =   0xf0; 
const quint8 end_of_sysex =       0xf7; 
const quint8 midi_command_mask =  0xf0; 
const quint8 midi_channel_mask =  0x0f; 
const quint8 major_mode =         0; 
const quint8 minor_mode =         1; 
class DRUMSTICK_FILE_EXPORT QSmf : public QObject
{
    Q_OBJECT
 
public:
    explicit QSmf(QObject * parent = nullptr);
    virtual ~QSmf();
 
    void readFromStream(QDataStream *stream);
    void readFromFile(const QString& fileName);
    void writeToStream(QDataStream *stream);
    void writeToFile(const QString& fileName);
 
    void writeMetaEvent(long deltaTime, int type, const QByteArray& data);
    void writeMetaEvent(long deltaTime, int type, const QString& data);
    void writeMetaEvent(long deltaTime, int type, int data);
    void writeMetaEvent(long deltaTime, int type);
 
    void writeMidiEvent(long deltaTime, int type, int chan, int b1);
    void writeMidiEvent(long deltaTime, int type, int chan, int b1, int b2);
    void writeMidiEvent(long deltaTime, int type, int chan, const QByteArray& data);
    void writeMidiEvent(long deltaTime, int type, long len, char* data);
 
    void writeTempo(long deltaTime, long tempo);
    void writeBpmTempo(long deltaTime, int tempo);
    void writeTimeSignature(long deltaTime, int num, int den, int cc, int bb);
    void writeKeySignature(long deltaTime, int tone, int mode);
    void writeSequenceNumber(long deltaTime, int seqnum);
 
    long getCurrentTime();
    long getCurrentTempo();
    long getRealTime();
    long getFilePos();
    int  getDivision();
    void setDivision(int division);
    int  getTracks();
    void setTracks(int tracks);
    int  getFileFormat();
    void setFileFormat(int fileFormat);
    Q_DECL_DEPRECATED QTextCodec* getTextCodec();
    Q_DECL_DEPRECATED void setTextCodec(QTextCodec *codec);
 
Q_SIGNALS:
    void signalSMFError(const QString& errorStr);
    void signalSMFHeader(int format, int ntrks, int division);
    void signalSMFNoteOn(int chan, int pitch, int vol);
    void signalSMFNoteOff(int chan, int pitch, int vol);
    void signalSMFKeyPress(int chan, int pitch, int press);
    void signalSMFCtlChange(int chan, int ctl, int value);
    void signalSMFPitchBend(int chan, int value);
    void signalSMFProgram(int chan, int patch);
    void signalSMFChanPress(int chan, int press);
    void signalSMFSysex(const QByteArray& data);
    void signalSMFSeqSpecific(const QByteArray& data);
    void signalSMFMetaUnregistered(int typ, const QByteArray& data);
    void signalSMFMetaMisc(int typ, const QByteArray& data);
    void signalSMFSequenceNum(int seq);
    void signalSMFforcedChannel(int channel);
    void signalSMFforcedPort(int port);
    Q_DECL_DEPRECATED void signalSMFText(int typ, const QString& data);
    void signalSMFText2(int typ, const QByteArray& data);
    void signalSMFSmpte(int b0, int b1, int b2, int b3, int b4);
    void signalSMFTimeSig(int b0, int b1, int b2, int b3);
    void signalSMFKeySig(int b0, int b1);
    void signalSMFTempo(int tempo);
    void signalSMFendOfTrack();
    void signalSMFTrackStart();
    void signalSMFTrackEnd();
    void signalSMFWriteTempoTrack();
    void signalSMFWriteTrack(int track);
 
private:
    struct QSmfRecTempo
    {
        quint64 tempo;
        quint64 time;
    };
 
    class QSmfPrivate;
    QScopedPointer<QSmfPrivate> d;
 
    void SMFRead();
    void SMFWrite();
    quint8 getByte();
    void putByte(quint8 value);
    void readHeader();
    void readTrack();
    quint16 to16bit(quint8 c1, quint8 c2);
    quint32 to32bit(quint8 c1, quint8 c2, quint8 c3, quint8 c4);
    quint16 read16bit();
    quint32 read32bit();
    void write16bit(quint16 data);
    void write32bit(quint32 data);
    void writeVarLen(quint64 value);
    double ticksToSecs(quint64 ticks, quint16 division, quint64 tempo);
    long readVarLen();
    void readExpected(const QString& s);
    void addTempo(quint64 tempo, quint64 time);
    quint64 findTempo();
    void SMFError(const QString& s);
    void channelMessage(quint8 status, quint8 c1, quint8 c2);
    void msgInit();
    void msgAdd(quint8 b);
    void metaEvent(quint8 b);
    void sysEx();
    void badByte(quint8 b, int p);
    quint8 lowerByte(quint16 x);
    quint8 upperByte(quint16 x);
    bool endOfSmf();
    void writeHeaderChunk(int format, int ntracks, int division);
    void writeTrackChunk(int track);
};
 
QString DRUMSTICK_FILE_EXPORT drumstickLibraryVersion();
 
}} /* namespace drumstick::File */
 
#endif /* DRUMSTICK_QSMF_H */