engines/common/EngineChannel.h

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2005 Christian Schoenebeck                              *
 *                                                                         *
 *   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 __LS_ENGINECHANNEL_H__
#define __LS_ENGINECHANNEL_H__

#include "../../drivers/audio/AudioOutputDevice.h"
#include "../../drivers/midi/midi.h"
#include "../../drivers/midi/MidiInputDevice.h"
#include "../../drivers/midi/MidiInputPort.h"
#include "Engine.h"

namespace LinuxSampler {

    // just symbol prototyping
    class AudioOutputDevice;
    class MidiInputPort;

    /** @brief Channel Interface for LinuxSampler Sampler Engines
     *
     * Every sampler engine can be used on several sampler channels and
     * usually the same Engine instance is used on multiple sampler
     * channels. For this every sampler engine must also implement a class
     * which handles all channel dependant parameters and channel
     * dependant execution code.
     *
     * This abstract base interface class defines all mandatory methods
     * which have to be implemented by all engine channel implementations.
     */
    class EngineChannel {
        public:

            /////////////////////////////////////////////////////////////////
            // abstract methods
            //     (these have to be implemented by the descendant)

            virtual void    PrepareLoadInstrument(const char* FileName, uint Instrument) = 0;
            virtual void    LoadInstrument() = 0;
            virtual void    Reset() = 0;
            virtual void    SendNoteOn(uint8_t Key, uint8_t Velocity) = 0;
            virtual void    SendNoteOff(uint8_t Key, uint8_t Velocity) = 0;
            virtual void    SendPitchbend(int Pitch) = 0;
            virtual void    SendControlChange(uint8_t Controller, uint8_t Value) = 0;
            virtual bool    StatusChanged(bool bNewStatus = false) = 0;
            virtual float   Volume() = 0;
            virtual void    Volume(float f) = 0;
            virtual uint    Channels() = 0;
            virtual void    Connect(AudioOutputDevice* pAudioOut) = 0;
            virtual void    DisconnectAudioOutputDevice() = 0;
            virtual void    SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) = 0;
            virtual int     OutputChannel(uint EngineAudioChannel) = 0;
            virtual void    Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) = 0;
            virtual void    DisconnectMidiInputPort() = 0;
            virtual MidiInputPort* GetMidiInputPort() = 0;
            virtual midi_chan_t MidiChannel() = 0;
            virtual String  InstrumentFileName() = 0;
            virtual String  InstrumentName() = 0;
            virtual int     InstrumentIndex() = 0;
            virtual int     InstrumentStatus() = 0;
            virtual Engine* GetEngine() = 0;
            virtual String  EngineName() = 0;

            int iSamplerChannelIndex; ///< FIXME: nasty hack, might be removed (should be 'virtual EngineChannel* EngineChannel() = 0;', but due to cyclic dependencies only a void* solution would be possible ATM)

        protected:
            virtual ~EngineChannel() {}; // MUST only be destroyed by EngineChannelFactory
            friend class EngineChannelFactory;
    };

} // namespace LinuxSampler

#endif // __LS_ENGINECHANNEL_H__
1	schoenebeck	411	/***************************************************************************
2			* *
3			* Copyright (C) 2005 Christian Schoenebeck *
4			* *
5			* This program is free software; you can redistribute it and/or modify *
6			* it under the terms of the GNU General Public License as published by *
7			* the Free Software Foundation; either version 2 of the License, or *
8			* (at your option) any later version. *
9			* *
10			* This program is distributed in the hope that it will be useful, *
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13			* GNU General Public License for more details. *
14			* *
15			* You should have received a copy of the GNU General Public License *
16			* along with this program; if not, write to the Free Software *
17			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18			* MA 02111-1307 USA *
19			***************************************************************************/
20
21			#ifndef __LS_ENGINECHANNEL_H__
22			#define __LS_ENGINECHANNEL_H__
23
24			#include "../../drivers/audio/AudioOutputDevice.h"
25	schoenebeck	675	#include "../../drivers/midi/midi.h"
26			#include "../../drivers/midi/MidiInputDevice.h"
27			#include "../../drivers/midi/MidiInputPort.h"
28	schoenebeck	411	#include "Engine.h"
29
30			namespace LinuxSampler {
31
32			// just symbol prototyping
33			class AudioOutputDevice;
34	schoenebeck	675	class MidiInputPort;
35	schoenebeck	411
36			/** @brief Channel Interface for LinuxSampler Sampler Engines
37			*
38			* Every sampler engine can be used on several sampler channels and
39			* usually the same Engine instance is used on multiple sampler
40			* channels. For this every sampler engine must also implement a class
41			* which handles all channel dependant parameters and channel
42			* dependant execution code.
43			*
44			* This abstract base interface class defines all mandatory methods
45			* which have to be implemented by all engine channel implementations.
46			*/
47			class EngineChannel {
48			public:
49	schoenebeck	660
50	schoenebeck	411	/////////////////////////////////////////////////////////////////
51			// abstract methods
52			// (these have to be implemented by the descendant)
53	schoenebeck	660
54	schoenebeck	411	virtual void PrepareLoadInstrument(const char* FileName, uint Instrument) = 0;
55			virtual void LoadInstrument() = 0;
56	schoenebeck	670	virtual void Reset() = 0;
57	schoenebeck	411	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity) = 0;
58			virtual void SendNoteOff(uint8_t Key, uint8_t Velocity) = 0;
59			virtual void SendPitchbend(int Pitch) = 0;
60	schoenebeck	660	virtual void SendControlChange(uint8_t Controller, uint8_t Value) = 0;
61	schoenebeck	670	virtual bool StatusChanged(bool bNewStatus = false) = 0;
62	schoenebeck	411	virtual float Volume() = 0;
63			virtual void Volume(float f) = 0;
64	schoenebeck	660	virtual uint Channels() = 0;
65	schoenebeck	411	virtual void Connect(AudioOutputDevice* pAudioOut) = 0;
66			virtual void DisconnectAudioOutputDevice() = 0;
67			virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) = 0;
68	schoenebeck	660	virtual int OutputChannel(uint EngineAudioChannel) = 0;
69	schoenebeck	675	virtual void Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) = 0;
70			virtual void DisconnectMidiInputPort() = 0;
71			virtual MidiInputPort* GetMidiInputPort() = 0;
72			virtual midi_chan_t MidiChannel() = 0;
73	schoenebeck	411	virtual String InstrumentFileName() = 0;
74			virtual String InstrumentName() = 0;
75			virtual int InstrumentIndex() = 0;
76			virtual int InstrumentStatus() = 0;
77			virtual Engine* GetEngine() = 0;
78	schoenebeck	475	virtual String EngineName() = 0;
79	schoenebeck	411
80	schoenebeck	660	int iSamplerChannelIndex; ///< FIXME: nasty hack, might be removed (should be 'virtual EngineChannel* EngineChannel() = 0;', but due to cyclic dependencies only a void* solution would be possible ATM)
81
82			protected:
83			virtual ~EngineChannel() {}; // MUST only be destroyed by EngineChannelFactory
84			friend class EngineChannelFactory;
85	schoenebeck	411	};
86	schoenebeck	660
87	schoenebeck	411	} // namespace LinuxSampler
88	schoenebeck	660
89	schoenebeck	411	#endif // __LS_ENGINECHANNEL_H__