/home/maxime/Projets/Mixxx/1.10/mixxx/src/midi/mididevice.h

Go to the documentation of this file.

/***************************************************************************
                             mididevice.h
                           MIDI Device Class
                           -------------------
    begin                : Thu Dec 18 2008
    copyright            : (C) 2008 Albert Santoni
    email                : alberts@mixxx.org

    This class represents a physical or virtual MIDI device. A MIDI device
    processes MIDI messages that are received from it in the receive()
    function and MIDI messages can be sent back to it using the send*()
    functions. This is a base class that cannot be instantiated on its own,
    it must be inherited by a class that implements it on top of some API.
    (See MidiDevicePortMidi, as of Nov 2009.)

    This class is thread safe and must remain thread safe because parts of
    it may be accessed by the MIDI script engine thread as well as the
    MIDI thread concurrently.

***************************************************************************/

/***************************************************************************
*                                                                         *
*   This program 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 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
***************************************************************************/

#ifndef MIDIDEVICE_H
#define MIDIDEVICE_H

#include <QtCore>
#include "midimessage.h"
#include "softtakeover.h"

//Forward declarations
class MidiMapping;
#ifdef __MIDISCRIPT__
class MidiScriptEngine;
#endif

class MidiDevice : public QThread
{
Q_OBJECT
    public:
        MidiDevice(MidiMapping* mapping);
        virtual ~MidiDevice();
        virtual int open() = 0;
        virtual int close() = 0;
        virtual void run() = 0;
        void startup();
        void shutdown();
        bool isOpen() { return m_bIsOpen; };
        bool isOutputDevice() { return m_bIsOutputDevice; };
        bool isInputDevice() { return m_bIsInputDevice; };
        QString getName() { return m_strDeviceName; };
        void setMidiMapping(MidiMapping* mapping);
        MidiMapping* getMidiMapping() { return m_pMidiMapping; };
        Q_INVOKABLE void sendShortMsg(unsigned char status, unsigned char byte1, unsigned char byte2);
        virtual void sendShortMsg(unsigned int word);
        virtual void sendSysexMsg(unsigned char data[], unsigned int length);
        Q_INVOKABLE void sendSysexMsg(QList<int> data, unsigned int length);
        bool getMidiLearnStatus();
        void receive(MidiStatusByte status, char channel, char control, char value);
#ifdef __MIDISCRIPT__

        void receive(const unsigned char data[], unsigned int length);
#endif

        bool midiDebugging();
        void setReceiveInhibit(bool inhibit);
    public slots:
        void disableMidiLearn();
        void enableMidiLearn();

    signals:
        void midiEvent(MidiMessage message);
        void callMidiScriptFunction(QString function, char channel, char control, char value, MidiStatusByte status, QString group);

    protected:
        QString m_strDeviceName;
        bool m_bIsOutputDevice;
        bool m_bIsInputDevice;
        MidiMapping* m_pMidiMapping;
        bool m_bIsOpen;
        bool m_bMidiLearn;
        MidiDevice* m_pCorrespondingOutputDevice;
        bool m_midiDebug;
        QMutex m_mutex;
        QMutex m_mappingPtrMutex;
        bool m_bReceiveInhibit;
        SoftTakeover m_st;
};

#endif