drumstick  2.7.2
qsmf.h
Go to the documentation of this file.
1 /*
2  Standard MIDI File component
3  Copyright (C) 2006-2022, Pedro Lopez-Cabanillas <plcl@users.sf.net>
4 
5  Based on midifile.c by Tim Thompson, M.Czeiszperger and Greg Lee
6 
7  This library is free software; you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation; either version 3 of the License, or
10  (at your option) any later version.
11 
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  GNU General Public License for more details.
16 
17  You should have received a copy of the GNU General Public License
18  along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20 
21 #ifndef DRUMSTICK_QSMF_H
22 #define DRUMSTICK_QSMF_H
23 
24 #include "macros.h"
25 #include <QObject>
26 #include <QScopedPointer>
27 
28 class QTextCodec;
29 class QDataStream;
30 
36 namespace drumstick {
41 namespace File {
42 
48 const quint32 MThd = 0x4d546864;
49 const quint32 MTrk = 0x4d54726b;
51 /* Standard MIDI Files meta event definitions */
52 const quint8 meta_event = 0xff;
53 const quint8 sequence_number = 0x00;
54 const quint8 text_event = 0x01;
55 const quint8 copyright_notice = 0x02;
56 const quint8 sequence_name = 0x03;
57 const quint8 instrument_name = 0x04;
58 const quint8 lyric = 0x05;
59 const quint8 marker = 0x06;
60 const quint8 cue_point = 0x07;
61 const quint8 forced_channel = 0x20;
62 const quint8 forced_port = 0x21;
63 const quint8 end_of_track = 0x2f;
64 const quint8 set_tempo = 0x51;
65 const quint8 smpte_offset = 0x54;
66 const quint8 time_signature = 0x58;
67 const quint8 key_signature = 0x59;
68 const quint8 sequencer_specific = 0x7f;
70 /* MIDI status commands most significant bit is 1 */
71 const quint8 note_off = 0x80;
72 const quint8 note_on = 0x90;
73 const quint8 poly_aftertouch = 0xa0;
74 const quint8 control_change = 0xb0;
75 const quint8 program_chng = 0xc0;
76 const quint8 channel_aftertouch = 0xd0;
77 const quint8 pitch_wheel = 0xe0;
78 const quint8 system_exclusive = 0xf0;
79 const quint8 end_of_sysex = 0xf7;
81 const quint8 midi_command_mask = 0xf0;
82 const quint8 midi_channel_mask = 0x0f;
84 const quint8 major_mode = 0;
85 const quint8 minor_mode = 1;
92 class DRUMSTICK_EXPORT QSmf : public QObject
93 {
94  Q_OBJECT
95 
96 public:
97  explicit QSmf(QObject * parent = nullptr);
98  virtual ~QSmf();
99 
100  void readFromStream(QDataStream *stream);
101  void readFromFile(const QString& fileName);
102  void writeToStream(QDataStream *stream);
103  void writeToFile(const QString& fileName);
104 
105  void writeMetaEvent(long deltaTime, int type, const QByteArray& data);
106  void writeMetaEvent(long deltaTime, int type, const QString& data);
107  void writeMetaEvent(long deltaTime, int type, int data);
108  void writeMetaEvent(long deltaTime, int type);
109 
110  void writeMidiEvent(long deltaTime, int type, int chan, int b1);
111  void writeMidiEvent(long deltaTime, int type, int chan, int b1, int b2);
112  void writeMidiEvent(long deltaTime, int type, int chan, const QByteArray& data);
113  void writeMidiEvent(long deltaTime, int type, long len, char* data);
114 
115  void writeTempo(long deltaTime, long tempo);
116  void writeBpmTempo(long deltaTime, int tempo);
117  void writeTimeSignature(long deltaTime, int num, int den, int cc, int bb);
118  void writeKeySignature(long deltaTime, int tone, int mode);
119  void writeSequenceNumber(long deltaTime, int seqnum);
120 
121  long getCurrentTime();
122  long getCurrentTempo();
123  long getRealTime();
124  long getFilePos();
125  int getDivision();
126  void setDivision(int division);
127  int getTracks();
128  void setTracks(int tracks);
129  int getFileFormat();
130  void setFileFormat(int fileFormat);
131  Q_DECL_DEPRECATED QTextCodec* getTextCodec();
132  Q_DECL_DEPRECATED void setTextCodec(QTextCodec *codec);
133 
134 signals:
139  void signalSMFError(const QString& errorStr);
146  void signalSMFHeader(int format, int ntrks, int division);
153  void signalSMFNoteOn(int chan, int pitch, int vol);
160  void signalSMFNoteOff(int chan, int pitch, int vol);
167  void signalSMFKeyPress(int chan, int pitch, int press);
174  void signalSMFCtlChange(int chan, int ctl, int value);
180  void signalSMFPitchBend(int chan, int value);
186  void signalSMFProgram(int chan, int patch);
192  void signalSMFChanPress(int chan, int press);
197  void signalSMFSysex(const QByteArray& data);
202  void signalSMFSeqSpecific(const QByteArray& data);
209  void signalSMFMetaUnregistered(int typ, const QByteArray& data);
215  void signalSMFMetaMisc(int typ, const QByteArray& data);
220  void signalSMFSequenceNum(int seq);
225  void signalSMFforcedChannel(int channel);
230  void signalSMFforcedPort(int port);
238  Q_DECL_DEPRECATED void signalSMFText(int typ, const QString& data);
244  void signalSMFText2(int typ, const QByteArray& data);
253  void signalSMFSmpte(int b0, int b1, int b2, int b3, int b4);
261  void signalSMFTimeSig(int b0, int b1, int b2, int b3);
267  void signalSMFKeySig(int b0, int b1);
272  void signalSMFTempo(int tempo);
276  void signalSMFendOfTrack();
280  void signalSMFTrackStart();
284  void signalSMFTrackEnd();
295  void signalSMFWriteTempoTrack();
300  void signalSMFWriteTrack(int track);
301 
302 private:
306  struct QSmfRecTempo
307  {
308  quint64 tempo;
309  quint64 time;
310  };
311 
312  class QSmfPrivate;
313  QScopedPointer<QSmfPrivate> d;
314 
315  void SMFRead();
316  void SMFWrite();
317  quint8 getByte();
318  void putByte(quint8 value);
319  void readHeader();
320  void readTrack();
321  quint16 to16bit(quint8 c1, quint8 c2);
322  quint32 to32bit(quint8 c1, quint8 c2, quint8 c3, quint8 c4);
323  quint16 read16bit();
324  quint32 read32bit();
325  void write16bit(quint16 data);
326  void write32bit(quint32 data);
327  void writeVarLen(quint64 value);
328  double ticksToSecs(quint64 ticks, quint16 division, quint64 tempo);
329  long readVarLen();
330  void readExpected(const QString& s);
331  void addTempo(quint64 tempo, quint64 time);
332  quint64 findTempo();
333  void SMFError(const QString& s);
334  void channelMessage(quint8 status, quint8 c1, quint8 c2);
335  void msgInit();
336  void msgAdd(quint8 b);
337  void metaEvent(quint8 b);
338  void sysEx();
339  void badByte(quint8 b, int p);
340  quint8 lowerByte(quint16 x);
341  quint8 upperByte(quint16 x);
342  bool endOfSmf();
343  void writeHeaderChunk(int format, int ntracks, int division);
344  void writeTrackChunk(int track);
345 };
346 
347 QString DRUMSTICK_EXPORT drumstickLibraryVersion();
348 
351 }} /* namespace drumstick::File */
352 
353 #endif /* DRUMSTICK_QSMF_H */
const quint8 text_event
SMF Text event.
Definition: qsmf.h:54
const quint8 control_change
MIDI event Control change.
Definition: qsmf.h:74
const quint8 lyric
SMF Lyric.
Definition: qsmf.h:58
const quint8 key_signature
SMF Key signature.
Definition: qsmf.h:67
const quint8 meta_event
SMF Meta Event prefix.
Definition: qsmf.h:52
const quint8 midi_command_mask
Mask to extract the command from the status byte.
Definition: qsmf.h:81
The QObject class is the base class of all Qt objects.
const quint8 forced_channel
SMF Forced MIDI channel.
Definition: qsmf.h:61
const quint8 note_on
MIDI event Note On.
Definition: qsmf.h:72
Drumstick visibility macros.
const quint8 sequencer_specific
SMF Sequencer specific.
Definition: qsmf.h:68
const quint8 instrument_name
SMF Instrument name.
Definition: qsmf.h:57
const quint8 marker
SMF Marker.
Definition: qsmf.h:59
const quint32 MThd
SMF Header prefix.
Definition: qsmf.h:48
Drumstick common.
Definition: alsaclient.cpp:68
const quint8 poly_aftertouch
MIDI event Polyphonic pressure.
Definition: qsmf.h:73
const quint8 sequence_name
SMF Sequence name.
Definition: qsmf.h:56
const quint8 end_of_track
SMF End of track.
Definition: qsmf.h:63
const quint8 major_mode
Major mode scale.
Definition: qsmf.h:84
const quint8 minor_mode
Minor mode scale.
Definition: qsmf.h:85
const quint8 set_tempo
SMF Tempo change.
Definition: qsmf.h:64
const quint8 program_chng
MIDI event Program change.
Definition: qsmf.h:75
const quint8 midi_channel_mask
Mask to extract the channel from the status byte.
Definition: qsmf.h:82
const quint32 MTrk
SMF Track prefix.
Definition: qsmf.h:49
const quint8 note_off
MIDI event Note Off.
Definition: qsmf.h:71
const quint8 forced_port
SMF Forced MIDI port.
Definition: qsmf.h:62
const quint8 copyright_notice
SMF Copyright notice.
Definition: qsmf.h:55
Standard MIDI Files input/output.
Definition: qsmf.h:92
const quint8 end_of_sysex
MIDI event System Exclusive end.
Definition: qsmf.h:79
const quint8 smpte_offset
SMF SMPTE offset.
Definition: qsmf.h:65
const quint8 pitch_wheel
MIDI event Bender.
Definition: qsmf.h:77
const quint8 time_signature
SMF Time signature.
Definition: qsmf.h:66
const quint8 sequence_number
SMF Sequence number.
Definition: qsmf.h:53
const quint8 channel_aftertouch
MIDI event Channel after-touch.
Definition: qsmf.h:76
const quint8 system_exclusive
MIDI event System Exclusive begin.
Definition: qsmf.h:78
QString drumstickLibraryVersion()
drumstickLibraryVersion provides the Drumstick version as an edited QString
Definition: qsmf.cpp:1242
const quint8 cue_point
SMF Cue point.
Definition: qsmf.h:60