src/engines/EngineChannel.h

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2005, 2006 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    SendNoteOn(uint8_t Key, uint8_t Velocity, int32_t FragmentPos) = 0;
            virtual void    SendNoteOff(uint8_t Key, uint8_t Velocity) = 0;
            virtual void    SendNoteOff(uint8_t Key, uint8_t Velocity, int32_t FragmentPos) = 0;
            virtual void    SendPitchbend(int Pitch) = 0;
            virtual void    SendPitchbend(int Pitch, int32_t FragmentPos) = 0;
            virtual void    SendControlChange(uint8_t Controller, uint8_t Value) = 0;
            virtual void    SendControlChange(uint8_t Controller, uint8_t Value, int32_t FragmentPos) = 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;

            /**
             * Sets the mute state of this channel.
             *
             * @param state - specifies the mute state of this sampler channel.
             * @throws Exception - if state does not contain valid
             * value.
             */
            void SetMute(int state) throw (Exception);

            /**
             * Determines whether this channel is muted.
             *
             * @returns 1 if the channel is muted, 0 if the channel is not muted
             * and -1 if the channel is muted because of presence of at least
             * one solo channel.
             */
            int GetMute();

            /**
             * Sets the solo state of this channel.
             *
             * @param solo - specifies whether this is a solo channel.
             */
            void SetSolo(bool solo);

            /**
             * Determines whether this is a solo channel.
             *
             * @returns true if this is a solo channel, false otherwise.
             */
            bool GetSolo();

            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:
            EngineChannel();
            virtual ~EngineChannel() {}; // MUST only be destroyed by EngineChannelFactory
            friend class EngineChannelFactory;

        private:
            int  iMute;
            bool bSolo;
    };

} // namespace LinuxSampler

#endif // __LS_ENGINECHANNEL_H__
1	/***************************************************************************
2	* *
3	* Copyright (C) 2005, 2006 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	#include "../drivers/midi/midi.h"
26	#include "../drivers/midi/MidiInputDevice.h"
27	#include "../drivers/midi/MidiInputPort.h"
28	#include "Engine.h"
29
30	namespace LinuxSampler {
31
32	// just symbol prototyping
33	class AudioOutputDevice;
34	class MidiInputPort;
35
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
50	/////////////////////////////////////////////////////////////////
51	// abstract methods
52	// (these have to be implemented by the descendant)
53
54	virtual void PrepareLoadInstrument(const char* FileName, uint Instrument) = 0;
55	virtual void LoadInstrument() = 0;
56	virtual void Reset() = 0;
57	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity) = 0;
58	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity, int32_t FragmentPos) = 0;
59	virtual void SendNoteOff(uint8_t Key, uint8_t Velocity) = 0;
60	virtual void SendNoteOff(uint8_t Key, uint8_t Velocity, int32_t FragmentPos) = 0;
61	virtual void SendPitchbend(int Pitch) = 0;
62	virtual void SendPitchbend(int Pitch, int32_t FragmentPos) = 0;
63	virtual void SendControlChange(uint8_t Controller, uint8_t Value) = 0;
64	virtual void SendControlChange(uint8_t Controller, uint8_t Value, int32_t FragmentPos) = 0;
65	virtual bool StatusChanged(bool bNewStatus = false) = 0;
66	virtual float Volume() = 0;
67	virtual void Volume(float f) = 0;
68	virtual uint Channels() = 0;
69	virtual void Connect(AudioOutputDevice* pAudioOut) = 0;
70	virtual void DisconnectAudioOutputDevice() = 0;
71	virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) = 0;
72	virtual int OutputChannel(uint EngineAudioChannel) = 0;
73	virtual void Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) = 0;
74	virtual void DisconnectMidiInputPort() = 0;
75	virtual MidiInputPort* GetMidiInputPort() = 0;
76	virtual midi_chan_t MidiChannel() = 0;
77	virtual String InstrumentFileName() = 0;
78	virtual String InstrumentName() = 0;
79	virtual int InstrumentIndex() = 0;
80	virtual int InstrumentStatus() = 0;
81	virtual Engine* GetEngine() = 0;
82	virtual String EngineName() = 0;
83
84	/**
85	* Sets the mute state of this channel.
86	*
87	* @param state - specifies the mute state of this sampler channel.
88	* @throws Exception - if state does not contain valid
89	* value.
90	*/
91	void SetMute(int state) throw (Exception);
92
93	/**
94	* Determines whether this channel is muted.
95	*
96	* @returns 1 if the channel is muted, 0 if the channel is not muted
97	* and -1 if the channel is muted because of presence of at least
98	* one solo channel.
99	*/
100	int GetMute();
101
102	/**
103	* Sets the solo state of this channel.
104	*
105	* @param solo - specifies whether this is a solo channel.
106	*/
107	void SetSolo(bool solo);
108
109	/**
110	* Determines whether this is a solo channel.
111	*
112	* @returns true if this is a solo channel, false otherwise.
113	*/
114	bool GetSolo();
115
116	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)
117
118	protected:
119	EngineChannel();
120	virtual ~EngineChannel() {}; // MUST only be destroyed by EngineChannelFactory
121	friend class EngineChannelFactory;
122
123	private:
124	int iMute;
125	bool bSolo;
126	};
127
128	} // namespace LinuxSampler
129
130	#endif // __LS_ENGINECHANNEL_H__