qwrk.h

Go to the documentation of this file.

/*
    WRK File component
    Copyright (C) 2010-2023, Pedro Lopez-Cabanillas <plcl@users.sf.net>
 
    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_QWRK_H
#define DRUMSTICK_QWRK_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 {
 
enum WrkChunkType {
    TRACK_CHUNK = 1,     
    STREAM_CHUNK = 2,    
    VARS_CHUNK = 3,      
    TEMPO_CHUNK = 4,     
    METER_CHUNK = 5,     
    SYSEX_CHUNK = 6,     
    MEMRGN_CHUNK = 7,    
    COMMENTS_CHUNK = 8,  
    TRKOFFS_CHUNK = 9,   
    TIMEBASE_CHUNK = 10, 
    TIMEFMT_CHUNK = 11,  
    TRKREPS_CHUNK = 12,  
    TRKPATCH_CHUNK = 14, 
    NTEMPO_CHUNK = 15,   
    THRU_CHUNK = 16,     
    LYRICS_CHUNK = 18,   
    TRKVOL_CHUNK = 19,   
    SYSEX2_CHUNK = 20,   
    MARKERS_CHUNK = 21,  
    STRTAB_CHUNK = 22,   
    METERKEY_CHUNK = 23, 
    TRKNAME_CHUNK = 24,  
    VARIABLE_CHUNK = 26, 
    NTRKOFS_CHUNK = 27,  
    TRKBANK_CHUNK = 30,  
    NTRACK_CHUNK = 36,   
    NSYSEX_CHUNK = 44,   
    NSTREAM_CHUNK = 45,  
    SGMNT_CHUNK = 49,    
    SOFTVER_CHUNK = 74,  
    END_CHUNK = 255      
};
 
class DRUMSTICK_FILE_EXPORT QWrk : public QObject
{
    Q_OBJECT
    Q_ENUM(WrkChunkType)
public:
    explicit QWrk(QObject * parent = nullptr);
    virtual ~QWrk();
 
    void readFromStream(QDataStream *stream);
    void readFromFile(const QString& fileName);
    Q_DECL_DEPRECATED QTextCodec* getTextCodec();
    Q_DECL_DEPRECATED void setTextCodec(QTextCodec *codec);
    long getFilePos();
 
    int getNow() const;
    int getFrom() const;
    int getThru() const;
    int getKeySig() const;
    int getClock() const;
    int getAutoSave() const;
    int getPlayDelay() const;
    bool getZeroCtrls() const;
    bool getSendSPP() const;
    bool getSendCont() const;
    bool getPatchSearch() const;
    bool getAutoStop() const;
    unsigned int getStopTime() const;
    bool getAutoRewind() const;
    int getRewindTime() const;
    bool getMetroPlay() const;
    bool getMetroRecord() const;
    bool getMetroAccent() const;
    int getCountIn() const;
    bool getThruOn() const;
    bool getAutoRestart() const;
    int getCurTempoOfs() const;
    int getTempoOfs1() const;
    int getTempoOfs2() const;
    int getTempoOfs3() const;
    bool getPunchEnabled() const;
    int getPunchInTime() const;
    int getPunchOutTime() const;
    int getEndAllTime() const;
 
    QByteArray getLastChunkRawData() const;
    double getRealTime(long ticks) const;
 
    static const QByteArray HEADER; 
 
Q_SIGNALS:
 
    void signalWRKError(const QString& errorStr);
 
    void signalWRKUnknownChunk(int type, const QByteArray& data);
 
    void signalWRKHeader(int verh, int verl);
 
    void signalWRKEnd();
 
    void signalWRKStreamEnd(long time);
 
    void signalWRKNote(int track, long time, int chan, int pitch, int vol, int dur);
 
    void signalWRKKeyPress(int track, long time, int chan, int pitch, int press);
 
    void signalWRKCtlChange(int track, long time, int chan, int ctl, int value);
 
    void signalWRKPitchBend(int track, long time, int chan, int value);
 
    void signalWRKProgram(int track, long time, int chan, int patch);
 
    void signalWRKChanPress(int track, long time, int chan, int press);
 
    void signalWRKSysexEvent(int track, long time, int bank);
 
    void signalWRKSysex(int bank, const QString& name, bool autosend, int port, const QByteArray& data);
 
    Q_DECL_DEPRECATED void signalWRKText(int track, long time, int type, const QString& data);
 
    void signalWRKTimeSig(int bar, int num, int den);
 
    void signalWRKKeySig(int bar, int alt);
 
    void signalWRKTempo(long time, int tempo);
 
    Q_DECL_DEPRECATED
    void signalWRKTrack(const QString& name1,
                        const QString& name2,
                        int trackno, int channel, int pitch,
                        int velocity, int port,
                        bool selected, bool muted, bool loop );
 
    void signalWRKTimeBase(int timebase);
 
    void signalWRKGlobalVars();
 
    void signalWRKThru(int mode, int port, int channel, int keyPlus, int velPlus, int localPort);
 
    void signalWRKTrackOffset(int track, int offset);
 
    void signalWRKTrackReps(int track, int reps);
 
    void signalWRKTrackPatch(int track, int patch);
 
    void signalWRKTrackBank(int track, int bank);
 
    void signalWRKTimeFormat(int frames, int offset);
 
    Q_DECL_DEPRECATED void signalWRKComments(const QString& data);
 
    void signalWRKVariableRecord(const QString& name, const QByteArray& data);
 
    void signalWRKTrackVol(int track, int vol);
 
    Q_DECL_DEPRECATED
    void signalWRKNewTrack( const QString& name,
                            int trackno, int channel, int pitch,
                            int velocity, int port,
                            bool selected, bool muted, bool loop );
 
    void signalWRKSoftVer(const QString& version);
 
    Q_DECL_DEPRECATED void signalWRKTrackName(int track, const QString& name);
 
    Q_DECL_DEPRECATED void signalWRKStringTable(const QStringList& strs);
 
    Q_DECL_DEPRECATED void signalWRKSegment(int track, long time, const QString& name);
 
    void signalWRKChord(int track, long time, const QString& name, const QByteArray& data);
 
    Q_DECL_DEPRECATED void signalWRKExpression(int track, long time, int code, const QString& text);
 
    void signalWRKHairpin(int track, long time, int code, int dur);
 
    void signalWRKText2(int track, long time, int type, const QByteArray& data);
 
    void signalWRKTrack2(const QByteArray& name1,
                        const QByteArray& name2,
                        int trackno, int channel, int pitch,
                        int velocity, int port,
                        bool selected, bool muted, bool loop );
 
    void signalWRKComments2(const QByteArray& data);
 
    void signalWRKNewTrack2(const QByteArray& name,
                            int trackno, int channel, int pitch,
                            int velocity, int port,
                            bool selected, bool muted, bool loop );
    void signalWRKTrackName2(int track, const QByteArray& name);
 
    void signalWRKStringTable2(const QList<QByteArray>& strs);
 
    void signalWRKSegment2(int track, long time, const QByteArray& name);
 
    void signalWRKExpression2(int track, long time, int code, const QByteArray& text);
 
    Q_DECL_DEPRECATED void signalWRKMarker(long time, int type, const QString& data);
 
    void signalWRKMarker2(long time, int type, const QByteArray& data);
 
private:
    quint8 readByte();
    quint16 to16bit(quint8 c1, quint8 c2);
    quint32 to32bit(quint8 c1, quint8 c2, quint8 c3, quint8 c4);
    quint16 read16bit();
    quint32 read24bit();
    quint32 read32bit();
    QString readString(int len);
    QString readVarString();
    void readRawData(int size);
    void readGap(int size);
    bool atEnd();
    void seek(qint64 pos);
 
    int readChunk();
    void processTrackChunk();
    void processVarsChunk();
    void processTimebaseChunk();
    void processNoteArray(int track, int events);
    void processStreamChunk();
    void processMeterChunk();
    void processTempoChunk(int factor = 1);
    void processSysexChunk();
    void processSysex2Chunk();
    void processNewSysexChunk();
    void processThruChunk();
    void processTrackOffset();
    void processTrackReps();
    void processTrackPatch();
    void processTrackBank();
    void processTimeFormat();
    void processComments();
    void processVariableRecord(int max);
    void processNewTrack();
    void processSoftVer();
    void processTrackName();
    void processStringTable();
    void processLyricsStream();
    void processTrackVol();
    void processNewTrackOffset();
    void processMeterKeyChunk();
    void processSegmentChunk();
    void processNewStream();
    void processUnknown(int id);
    void processEndChunk();
    void wrkRead();
    QByteArray readByteArray(int len);
    QByteArray readVarByteArray();
    void processMarkers();
 
    struct RecTempo {
        long time;
        double tempo;
        double seconds;
    };
 
    class QWrkPrivate;
    QScopedPointer<QWrkPrivate> d;
};
 
}} // namespace drumstick::File
 
#endif // DRUMSTICK_QWRK_H