MidiDriver.h

Go to the documentation of this file.

/*
Copyright (C) 2003-2005  The Pentagram Team

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.

This program 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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/

#ifndef MIDIDRIVER_H_INCLUDED
#define MIDIDRIVER_H_INCLUDED

class XMidiEventList;
class IDataSource;

class   MidiDriver
{
protected:
        bool                                    initialized;
        MidiDriver() : initialized(false) { }

public:
        struct MidiDriverDesc {
                MidiDriverDesc(const char * const n, MidiDriver * (*c)()) :
                        name(n), createInstance(c) { }
                const char * const name;                        
                MidiDriver * (*createInstance)();       
        };

        enum TimbreLibraryType {
                TIMBRE_LIBRARY_U7VOICE_AD       = 0,    // U7Voice for Adlib
                TIMBRE_LIBRARY_U7VOICE_MT       = 1,    // U7Voice for MT32
                TIMBRE_LIBRARY_XMIDI_AD         = 2,    // XMIDI.AD
                TIMBRE_LIBRARY_XMIDI_MT         = 3,    // XMIDI.MT
                TIMBRE_LIBRARY_SYX_FILE         = 4,    // .SYX
                TIMBRE_LIBRARY_XMIDI_FILE       = 5,    // Timbre is Sysex Data in MID/RMI/XMI file
                TIMBRE_LIBRARY_FMOPL_SETGM      = 6             // Special to set FMOPL into GM mode
        };

        virtual int                     initMidiDriver(uint32 sample_rate, bool stereo) = 0;

        virtual void            destroyMidiDriver() = 0;

        bool                            isInitialized() { return initialized; }

        virtual int                     maxSequences() = 0;

        virtual void            setGlobalVolume(int vol) = 0;

        virtual void            startSequence(int seq_num, XMidiEventList *list, bool repeat, int vol, int branch = -1) = 0;

        virtual void            finishSequence(int seq_num) = 0;

        virtual void            pauseSequence(int seq_num) = 0;

        virtual void            unpauseSequence(int seq_num) = 0;

        virtual void            setSequenceVolume(int seq_num, int vol) = 0;

        virtual void            setSequenceSpeed(int seq_num, int speed) = 0;

        virtual bool            isSequencePlaying(int seq_num) = 0;

        virtual uint32          getSequenceCallbackData(int seq_num) { return 0; }

        virtual bool            isSampleProducer() { return false; }

        virtual void            produceSamples(sint16 *samples, uint32 bytes) { }

        virtual bool            isFMSynth() { return false; }

        virtual bool            isMT32() { return false; }

        virtual bool            noTimbreSupport() { return false; }

        virtual void            loadTimbreLibrary(IDataSource*, TimbreLibraryType type) { };

        virtual ~MidiDriver() { };

        //
        // Statics to Initialize Midi Drivers and to get info
        //
        
        static int                      getDriverCount();

        static std::string      getDriverName(uint32 index);

        static MidiDriver       *createInstance(std::string driverName,uint32 sample_rate,bool stereo);

protected:
        std::string getConfigSetting(std::string name, std::string defaultval);
};

#endif //MIDIDRIVER_H_INCLUDED

---