trunk/src/Sampler.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and 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_SAMPLER_H__
#define __LS_SAMPLER_H__

#include <vector>
#include <map>
#include "common/global.h"
#include "common/LinuxSamplerException.h"
#include "engines/common/Engine.h"
#include "mididriver/MidiInputDevice.h"
#include "audiodriver/AudioOutputDevice.h"

namespace LinuxSampler {

    // just symbol prototyping
    class Sampler;

    /** LinuxSampler sampler channel
     *
     * Encapsulates one sampler engine, one connection to a MIDI input
     * device and one connection to an audio output device. You cannot
     * create an instance of this class on your own, you have to use the
     * AddSamplerChannel() method of the Sampler object to create a new
     * sampler channel.
     */
    class SamplerChannel {
        public:
            /**
             * Deploy a sampler engine of the given type for this sampler
             * channnel. If there was already a sampler engine deployed on
             * this sampler channel, then the old engine will automatically
             * be destroyed.
             *
             * @param EngineType - type of the engine to deploy
             */
            void LoadEngine(Engine::type_t EngineType); // TODO: to be changed to 'void LoadEngine(String EngineType) throws (LinuxSamplerException);'

            /**
             * Connect this sampler channel to an audio output device, that
             * is an instance of an audio output driver. If this sampler
             * channel was already connected to an audio output device, then
             * the old connection will automatically be removed before.
             *
             * @param pDevice - audio output device to connect to
             */
            void SetAudioOutputDevice(AudioOutputDevice* pDevice);

            /**
             * Connect this sampler channel to and MIDI input port
             *
             * @param MidiInputDevice - MIDI input device to connect to
             * @param MidiInputPort - MIDI port to connect to
             * @param MidiChannel - optional: MIDI channel on which the
             *                      sampler channel should listen to
             *                      (default: listen on all MIDI channels)
             */
            void SetMidiInputPort(MidiInputDevice* pDevice, int midiPort, MidiInputDevice::MidiInputPort::midi_chan_t MidiChannel = MidiInputDevice::MidiInputPort::midi_chan_all);

            /**
             * Returns the engine that was deployed on this sampler channel.
             *
             * @returns  pointer to engine or NULL if no engine deployed
             */
            Engine* GetEngine();

            /**
             * Returns the MIDI input device to which this sampler channel
             * is currently connected to.
             *
             * @returns  pointer to MIDI input device or NULL if not
             *           connected
             */
            MidiInputDevice::MidiInputPort* GetMidiInputPort();

            /**
             * Returns the audio output device to which this sampler channel
             * is currently connected to.
             *
             * @returns  pointer to audio output device or NULL if not
             *           connected
             */
            AudioOutputDevice* GetAudioOutputDevice();

            /**
             * Returns the audio output device to which this sampler channel
             * is currently connected to.
             *
             * @returns  pointer to audio output device or NULL if not
             *           connected
             */
            MidiInputDevice* GetMidiInputDevice();

            /**
             * Returns the index number of this sampler channel within the
             * Sampler instance.
             */
            uint Index();

            /**
             * Returns midi channel
             */
            MidiInputDevice::MidiInputPort::midi_chan_t GetMidiInputChannel() { return midiChannel; }

        protected:
            SamplerChannel(Sampler* pS);
           ~SamplerChannel();

            Sampler*           pSampler;
            Engine*            pEngine;
            MidiInputDevice::MidiInputPort*     pMidiInputPort;
            AudioOutputDevice* pAudioOutputDevice;
            int                iIndex;
            MidiInputDevice::MidiInputPort::midi_chan_t midiChannel;

            friend class Sampler;
    };

    /** LinuxSampler main class
     *
     * This is the toplevel class for a LinuxSampler instance.
     *
     * LinuxSampler can have arbitrary numbers of sampler channels. Each
     * sampler channel can individually be deployed with it's own sampler
     * engine, connected to an arbitrary MIDI input device and connected to
     * an arbitrary audio output device. Here an example setup:
     *
     *  S.Channel.      MIDI in         S.Engine                Audio out
     *  -------------------------------------------------------------------
     *  0               Alsa    ->      gig::Engine     ->      Jack
     *  1               VSTi    ->      Akai::Engine    ->      VSTi
     *  2               Jack    ->      DLS::Engine     ->      Jack
     *  3               Jack    ->      SF::Engine      ->      Alsa
     *
     *  ... (and so on) ...
     *
     * Note that not all audio and MIDI backends and sampler engines listed
     * in the example above are already implemented!
     *
     * As you can see in the example setup, LinuxSampler is capable to use
     * several, different audio output and MIDI input systems
     * simultaniously at the same time. Here the example setup shown in the
     * ascpect of MIDI input and audio output devices / drivers:
     *
     *                            ######################### #########################
     *                            # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
     *                            ######################### #########################
     *                                          ^   ^           ^
     *    /------------>|Sampler Channel 0|-----/   |           |
     *    |  /--------->|Sampler Channel 1|---------------------/
     *    |  |    /---->|Sampler Channel 2|---------/
     *    |  |    |  /->|Sampler Channel 3|------------>#########################
     *    |  |    |  |  ... (and so on) ...             # AudioOutputDeviceAlsa #
     *    |  |    |  |                                  #########################
     *    |  |    |  \----------------------------------------------------\
     *    |  |    \-------------------------------------------\           |
     *    |  \--------------------\                           |           |
     *    |                       |                           |           |
     *  ####################### ####################### #######################
     *  # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
     *  ####################### ####################### #######################
     *
     * As you can see in this example setup, one device (that is midi input
     * driver / audio output driver) can be connected multiple times to
     * different sampler channels.
     */
    class Sampler {
        public:
            /**
             * Constructor. Create a LinuxSampler instance.
             */
            Sampler();

            /**
             * Destructor.
             */
           ~Sampler();

            /**
             * Returns the number of sampler channels currently allocated.
             */
            uint SamplerChannels();

            /**
             * Create and add a new sampler channel to this Sampler instance.
             *
             * @returns  pointer to new sampler channel
             */
            SamplerChannel* AddSamplerChannel();

            /**
             * Returns the sampler channel of the given sampler channel
             * index.
             *
             * @returns  pointer to sought sampler channel
             */
            SamplerChannel* GetSamplerChannel(uint uiSamplerChannel);

            /**
             * Destroy and remove the given sampler channel from this
             * Sampler instance.
             *
             * @param pSamplerChannel - pointer to sampler channel to remove
             */
            void RemoveSamplerChannel(SamplerChannel* pSamplerChannel);

            /**
             * Destroy and remove the given sampler channel from this
             * Sampler instance.
             *
             * @param uiSamplerChannel - index of the sampler channel to
             *                           remove
             */
            void RemoveSamplerChannel(uint uiSamplerChannel);

            std::vector<String> AvailableAudioOutputDrivers();

            /**
             * Create an audio output device.
             *
             * @param AudioDriver - name of the audio driver
             * @param Parameters - eventually needed driver parameters to
             *                     create the device
             * @returns  pointer to created audio output device
             * @throws LinuxSamplerException  if device could not be created
             */
            AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);

            /**
             * Create a midi input device.
             *
             * @param MidiDriver - name of the midi driver
             * @param Parameters - eventually needed driver parameters to
             *                     create the device
             * @returns  pointer to created midi input device
             * @throws LinuxSamplerException  if device could not be created
             */
            MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);

            uint AudioOutputDevices();
            uint MidiInputDevices();

            std::map<uint, AudioOutputDevice*> GetAudioOutputDevices();

            std::map<uint, MidiInputDevice*> GetMidiInputDevices();

            void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (LinuxSamplerException);
            void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (LinuxSamplerException);

        protected:
            typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;
            typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;

            std::vector<SamplerChannel*> vSamplerChannels;   ///< contains all created sampler channels
            AudioOutputDeviceMap         mAudioOutputDevices; ///< contains all created audio output devices
            MidiInputDeviceMap           mMidiInputDevices;

            template<class T> inline String ToString(T o) {
                std::stringstream ss;
                ss << o;
                return ss.str();
            }

            friend class SamplerChannel;
    };
}

#endif // __LS_SAMPLER_H__
1	schoenebeck	53	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5	schoenebeck	61	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	schoenebeck	53	* *
7			* This program is free software; you can redistribute it and/or modify *
8			* it under the terms of the GNU General Public License as published by *
9			* the Free Software Foundation; either version 2 of the License, or *
10			* (at your option) any later version. *
11			* *
12			* This program is distributed in the hope that it will be useful, *
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15			* GNU General Public License for more details. *
16			* *
17			* You should have received a copy of the GNU General Public License *
18			* along with this program; if not, write to the Free Software *
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20			* MA 02111-1307 USA *
21			***************************************************************************/
22
23			#ifndef __LS_SAMPLER_H__
24			#define __LS_SAMPLER_H__
25
26			#include <vector>
27			#include <map>
28			#include "common/global.h"
29			#include "common/LinuxSamplerException.h"
30			#include "engines/common/Engine.h"
31			#include "mididriver/MidiInputDevice.h"
32			#include "audiodriver/AudioOutputDevice.h"
33
34			namespace LinuxSampler {
35
36			// just symbol prototyping
37			class Sampler;
38
39	schoenebeck	57	/** LinuxSampler sampler channel
40			*
41			* Encapsulates one sampler engine, one connection to a MIDI input
42			* device and one connection to an audio output device. You cannot
43	schoenebeck	123	* create an instance of this class on your own, you have to use the
44	schoenebeck	57	* AddSamplerChannel() method of the Sampler object to create a new
45			* sampler channel.
46			*/
47	schoenebeck	53	class SamplerChannel {
48			public:
49	schoenebeck	57	/**
50			* Deploy a sampler engine of the given type for this sampler
51			* channnel. If there was already a sampler engine deployed on
52			* this sampler channel, then the old engine will automatically
53			* be destroyed.
54			*
55			* @param EngineType - type of the engine to deploy
56			*/
57	schoenebeck	123	void LoadEngine(Engine::type_t EngineType); // TODO: to be changed to 'void LoadEngine(String EngineType) throws (LinuxSamplerException);'
58	schoenebeck	57
59			/**
60	schoenebeck	123	* Connect this sampler channel to an audio output device, that
61			* is an instance of an audio output driver. If this sampler
62			* channel was already connected to an audio output device, then
63			* the old connection will automatically be removed before.
64	schoenebeck	57	*
65	schoenebeck	123	* @param pDevice - audio output device to connect to
66	schoenebeck	57	*/
67	schoenebeck	123	void SetAudioOutputDevice(AudioOutputDevice* pDevice);
68	schoenebeck	57
69			/**
70	senkov	155	* Connect this sampler channel to and MIDI input port
71	schoenebeck	57	*
72	senkov	155	* @param MidiInputDevice - MIDI input device to connect to
73			* @param MidiInputPort - MIDI port to connect to
74	schoenebeck	57	* @param MidiChannel - optional: MIDI channel on which the
75			* sampler channel should listen to
76			* (default: listen on all MIDI channels)
77			*/
78	senkov	155	void SetMidiInputPort(MidiInputDevice* pDevice, int midiPort, MidiInputDevice::MidiInputPort::midi_chan_t MidiChannel = MidiInputDevice::MidiInputPort::midi_chan_all);
79	schoenebeck	57
80			/**
81			* Returns the engine that was deployed on this sampler channel.
82			*
83			* @returns pointer to engine or NULL if no engine deployed
84			*/
85			Engine* GetEngine();
86
87			/**
88			* Returns the MIDI input device to which this sampler channel
89			* is currently connected to.
90			*
91			* @returns pointer to MIDI input device or NULL if not
92			* connected
93			*/
94	senkov	155	MidiInputDevice::MidiInputPort* GetMidiInputPort();
95	schoenebeck	57
96			/**
97			* Returns the audio output device to which this sampler channel
98			* is currently connected to.
99			*
100			* @returns pointer to audio output device or NULL if not
101			* connected
102			*/
103			AudioOutputDevice* GetAudioOutputDevice();
104
105			/**
106	senkov	155	* Returns the audio output device to which this sampler channel
107			* is currently connected to.
108			*
109			* @returns pointer to audio output device or NULL if not
110			* connected
111			*/
112			MidiInputDevice* GetMidiInputDevice();
113
114			/**
115	schoenebeck	57	* Returns the index number of this sampler channel within the
116			* Sampler instance.
117			*/
118			uint Index();
119
120	senkov	155	/**
121			* Returns midi channel
122			*/
123			MidiInputDevice::MidiInputPort::midi_chan_t GetMidiInputChannel() { return midiChannel; }
124
125	schoenebeck	57	protected:
126	schoenebeck	53	SamplerChannel(Sampler* pS);
127			~SamplerChannel();
128	schoenebeck	57
129	schoenebeck	53	Sampler* pSampler;
130			Engine* pEngine;
131	senkov	155	MidiInputDevice::MidiInputPort* pMidiInputPort;
132	schoenebeck	53	AudioOutputDevice* pAudioOutputDevice;
133			int iIndex;
134	senkov	155	MidiInputDevice::MidiInputPort::midi_chan_t midiChannel;
135	schoenebeck	57
136			friend class Sampler;
137	schoenebeck	53	};
138
139	schoenebeck	57	/** LinuxSampler main class
140			*
141			* This is the toplevel class for a LinuxSampler instance.
142			*
143			* LinuxSampler can have arbitrary numbers of sampler channels. Each
144			* sampler channel can individually be deployed with it's own sampler
145			* engine, connected to an arbitrary MIDI input device and connected to
146			* an arbitrary audio output device. Here an example setup:
147			*
148			* S.Channel. MIDI in S.Engine Audio out
149			* -------------------------------------------------------------------
150			* 0 Alsa -> gig::Engine -> Jack
151			* 1 VSTi -> Akai::Engine -> VSTi
152			* 2 Jack -> DLS::Engine -> Jack
153			* 3 Jack -> SF::Engine -> Alsa
154			*
155			* ... (and so on) ...
156			*
157			* Note that not all audio and MIDI backends and sampler engines listed
158			* in the example above are already implemented!
159			*
160			* As you can see in the example setup, LinuxSampler is capable to use
161			* several, different audio output and MIDI input systems
162			* simultaniously at the same time. Here the example setup shown in the
163			* ascpect of MIDI input and audio output devices / drivers:
164			*
165			* ######################### #########################
166			* # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
167			* ######################### #########################
168			* ^ ^ ^
169			* /------------>\|Sampler Channel 0\|-----/ \| \|
170			* \| /--------->\|Sampler Channel 1\|---------------------/
171			* \| \| /---->\|Sampler Channel 2\|---------/
172			* \| \| \| /->\|Sampler Channel 3\|------------>#########################
173			* \| \| \| \| ... (and so on) ... # AudioOutputDeviceAlsa #
174			* \| \| \| \| #########################
175			* \| \| \| \----------------------------------------------------\
176			* \| \| \-------------------------------------------\ \|
177			* \| \--------------------\ \| \|
178			* \| \| \| \|
179			* ####################### ####################### #######################
180			* # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
181			* ####################### ####################### #######################
182			*
183			* As you can see in this example setup, one device (that is midi input
184			* driver / audio output driver) can be connected multiple times to
185			* different sampler channels.
186			*/
187	schoenebeck	53	class Sampler {
188			public:
189	schoenebeck	57	/**
190			* Constructor. Create a LinuxSampler instance.
191			*/
192	schoenebeck	53	Sampler();
193	schoenebeck	57
194			/**
195			* Destructor.
196			*/
197	schoenebeck	53	~Sampler();
198	schoenebeck	57
199			/**
200			* Returns the number of sampler channels currently allocated.
201			*/
202			uint SamplerChannels();
203
204			/**
205			* Create and add a new sampler channel to this Sampler instance.
206			*
207			* @returns pointer to new sampler channel
208			*/
209			SamplerChannel* AddSamplerChannel();
210
211			/**
212			* Returns the sampler channel of the given sampler channel
213			* index.
214			*
215			* @returns pointer to sought sampler channel
216			*/
217			SamplerChannel* GetSamplerChannel(uint uiSamplerChannel);
218
219			/**
220			* Destroy and remove the given sampler channel from this
221			* Sampler instance.
222			*
223			* @param pSamplerChannel - pointer to sampler channel to remove
224			*/
225			void RemoveSamplerChannel(SamplerChannel* pSamplerChannel);
226
227			/**
228			* Destroy and remove the given sampler channel from this
229			* Sampler instance.
230			*
231			* @param uiSamplerChannel - index of the sampler channel to
232			* remove
233			*/
234			void RemoveSamplerChannel(uint uiSamplerChannel);
235
236	schoenebeck	123	std::vector<String> AvailableAudioOutputDrivers();
237
238	schoenebeck	57	/**
239	senkov	155	* Create an audio output device.
240	schoenebeck	57	*
241	schoenebeck	123	* @param AudioDriver - name of the audio driver
242			* @param Parameters - eventually needed driver parameters to
243			* create the device
244	schoenebeck	57	* @returns pointer to created audio output device
245	schoenebeck	123	* @throws LinuxSamplerException if device could not be created
246	schoenebeck	57	*/
247	schoenebeck	123	AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);
248	schoenebeck	57
249	senkov	155	/**
250			* Create a midi input device.
251			*
252			* @param MidiDriver - name of the midi driver
253			* @param Parameters - eventually needed driver parameters to
254			* create the device
255			* @returns pointer to created midi input device
256			* @throws LinuxSamplerException if device could not be created
257			*/
258			MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);
259
260	schoenebeck	123	uint AudioOutputDevices();
261	senkov	155	uint MidiInputDevices();
262	schoenebeck	57
263	schoenebeck	123	std::map<uint, AudioOutputDevice*> GetAudioOutputDevices();
264
265	senkov	155	std::map<uint, MidiInputDevice*> GetMidiInputDevices();
266
267	schoenebeck	123	void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (LinuxSamplerException);
268	senkov	155	void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (LinuxSamplerException);
269	schoenebeck	123
270	schoenebeck	53	protected:
271	schoenebeck	123	typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;
272	senkov	155	typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;
273	schoenebeck	53
274			std::vector<SamplerChannel*> vSamplerChannels; ///< contains all created sampler channels
275	schoenebeck	123	AudioOutputDeviceMap mAudioOutputDevices; ///< contains all created audio output devices
276	senkov	155	MidiInputDeviceMap mMidiInputDevices;
277	schoenebeck	53
278	schoenebeck	123	template<class T> inline String ToString(T o) {
279			std::stringstream ss;
280			ss << o;
281			return ss.str();
282			}
283
284	schoenebeck	53	friend class SamplerChannel;
285			};
286			}
287
288			#endif // __LS_SAMPLER_H__