trunk/src/Sampler.h

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

#include <vector>
#include <map>
#include "common/global.h"
#include "common/Exception.h"
#include "engines/EngineChannel.h"
#include "drivers/midi/MidiInputDevice.h"
#include "drivers/audio/AudioOutputDevice.h"

namespace LinuxSampler {

    // just symbol prototyping
    class Sampler;

    /** @brief LinuxSampler sampler channel
     *
     * Encapsulates a channel of a specific sampler engine type, 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:
            /**
             * Assign a sampler engine type to this sampler channel.
             *
             * @param EngineType - type of the engine to use
             * @throws Exception - if \a EngineType is invalid
             * @see Sampler::AvailableEngineTypes()
             */
            void SetEngineType(String EngineType) throw (Exception);

            /**
             * 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 a MIDI input device.
             *
             * @param pDevice - MIDI input device to connect to
             */
            void SetMidiInputDevice(MidiInputDevice *pDevice);

            /**
             * Connect this sampler channel to a MIDI input port.
             *
             * @param MidiPort - MIDI port to connect to
             */
            void SetMidiInputPort(int MidiPort);

            /**
             * Define on which MIDI channel(s) this sampler channel should
             * listen to. By default, that is after creation of a new
             * sampler channel, the sampler channel will listen to all MIDI
             * channels.
             *
             * @param MidiChannel - MIDI channel to listen
             */
            void SetMidiInputChannel(midi_chan_t MidiChannel);

            /**
             * Connect this sampler channel to a MIDI input triplet.
             *
             * @param pDevice - MIDI input device to connect to
             * @param iMidiPort - 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 SetMidiInput(MidiInputDevice* pDevice, int iMidiPort, midi_chan_t MidiChannel = midi_chan_all);

            /**
             * Returns the EngineChannel object that was deployed on this
             * sampler channel appropriate to the given sampler engine type.
             *
             * @returns  pointer to engine or NULL if no engine deployed
             */
            EngineChannel* GetEngineChannel();

            /**
             * Returns the MIDI input channel to which this sampler
             * channel is currently connected to.
             *
             * @returns  The MIDI input channel on which the sampler
             *           channel is listening to.
             */
            midi_chan_t GetMidiInputChannel();

            /**
             * Returns the MIDI input port number to which this sampler
             * channel is currently connected to.
             *
             * @returns  MIDI input port number or -1 if not connected
             */
            int 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 MIDI input device to which this sampler channel
             * is currently connected to.
             *
             * @returns  pointer to MIDI input device or NULL if not
             *           connected
             */
            MidiInputDevice* GetMidiInputDevice();

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

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

            /** Getting MIDI input device port given its index number. */
            MidiInputPort* __GetMidiInputDevicePort(int iMidiPort);

            Sampler*           pSampler;
            EngineChannel*     pEngineChannel;
            AudioOutputDevice* pAudioOutputDevice;
            MidiInputDevice*   pMidiInputDevice;
            int                iIndex;

            friend class Sampler;
        private:
            int                iMidiPort;   ///< Don't access directly, read GetMidiInputPort() instead !
            midi_chan_t        midiChannel; ///< Don't access directly, read GetMidiInputChannel() instead !
    };

    /** @brief 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:
     * @code
     * 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) ...
     * @endcode
     *
     * Note that not all audio and MIDI backends and sampler engines listed
     * in the example above might already been 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
     * aspect of MIDI input and audio output devices / drivers:
     * @code
     *                      ######################### #########################
     *                      # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
     *                      ######################### #########################
     *                                        ^   ^           ^
     *  /------------>|Sampler Channel 0|-----/   |           |
     *  |  /--------->|Sampler Channel 1|---------------------/
     *  |  |  /------>|Sampler Channel 2|---------/
     *  |  |  |  /--->|Sampler Channel 3|------------>#########################
     *  |  |  |  |    ... (and so on) ...             # AudioOutputDeviceAlsa #
     *  |  |  |  |                                    #########################
     *  |  |  |  \-----------------------------------------------------\
     *  |  |  \--------------------------------------------\           |
     *  |  \--------------------\                          |           |
     *  |                       |                          |           |
     * ####################### ####################### #######################
     * # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
     * ####################### ####################### #######################
     * @endcode
     *
     * 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.
     *
     * It's even possible to create multiple instances of the same driver, for
     * example multiple instances of the Alsa output driver to use multiple
     * sound cards at the same time, or multiple instances of the JACK audio
     * output driver to leverage SMP systems or boxes with several hard discs.
     */
    class Sampler {
        public:
            /**
             * Constructor. Create a LinuxSampler instance.
             */
            Sampler();

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

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

            /**
             * Create and add a new sampler channel to this Sampler
             * instance. For race condition reasons the new channel will use
             * an index past the last already existing sampler channel
             * index (in case the index limit was not reached yet, otherwise
             * a free index starting from 0 is searched).
             *
             * @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);

            /**
             * Returns all created sampler channels.
             */
            std::map<uint, SamplerChannel*> GetSamplerChannels();

            /**
             * 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);

            /**
             * Returns the names of all available audio output drivers.
             */
            std::vector<String> AvailableAudioOutputDrivers();

            /**
             * Returns the names of all available MIDI input drivers.
             */
            std::vector<String> AvailableMidiInputDrivers();

            /**
             * Returns the names of all available sampler engine types.
             * @see SamplerChannel::SetEngineType()
             */
            std::vector<String> AvailableEngineTypes();

            /**
             * 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 Exception  if device could not be created
             */
            AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (Exception);

            /**
             * 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 Exception  if device could not be created
             */
            MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (Exception);

            /**
             * Returns the number of all created audio output devices.
             */
            uint AudioOutputDevices();

            /**
             * Returns the number of all created MIDI input devices.
             */
            uint MidiInputDevices();

            /**
             * Returns all created audio output devices.
             */
            std::map<uint, AudioOutputDevice*> GetAudioOutputDevices();

            /**
             * Returns all created MIDI input devices.
             */
            std::map<uint, MidiInputDevice*> GetMidiInputDevices();

            /**
             * Destroy the given audio output device and takes care if there
             * are still sampler angines connected to this device, etc.
             *
             * @throws Exception  if sampler channels are still
             *                    connected to the device
             */
            void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (Exception);

            /**
             * Destroy the given MIDI input device and takes care if there
             * are still sampler angines connected to this device, etc.
             *
             * @throws Exception  if sampler channels are still
             *                    connected to the device
             */
            void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (Exception);

            /**
             * Gets the current number of all active voices.
             * @returns The current number of all active voices.
             */
            int GetVoiceCount();

            /**
             * Reset the whole sampler. Destroy all engines, sampler
             * channels, MIDI input devices and audio output devices.
             */
            void Reset();

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

            SamplerChannelMap     mSamplerChannels;    ///< contains all created sampler channels
            AudioOutputDeviceMap  mAudioOutputDevices; ///< contains all created audio output devices
            MidiInputDeviceMap    mMidiInputDevices;   ///< contains all created MIDI input devices

            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	880	* Copyright (C) 2005, 2006 Christian Schoenebeck *
7	schoenebeck	53	* *
8			* This program is free software; you can redistribute it and/or modify *
9			* it under the terms of the GNU General Public License as published by *
10			* the Free Software Foundation; either version 2 of the License, or *
11			* (at your option) any later version. *
12			* *
13			* This program is distributed in the hope that it will be useful, *
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16			* GNU General Public License for more details. *
17			* *
18			* You should have received a copy of the GNU General Public License *
19			* along with this program; if not, write to the Free Software *
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21			* MA 02111-1307 USA *
22			***************************************************************************/
23
24			#ifndef __LS_SAMPLER_H__
25			#define __LS_SAMPLER_H__
26
27			#include <vector>
28			#include <map>
29			#include "common/global.h"
30	schoenebeck	880	#include "common/Exception.h"
31	schoenebeck	890	#include "engines/EngineChannel.h"
32	schoenebeck	203	#include "drivers/midi/MidiInputDevice.h"
33			#include "drivers/audio/AudioOutputDevice.h"
34	schoenebeck	53
35			namespace LinuxSampler {
36
37			// just symbol prototyping
38			class Sampler;
39
40	schoenebeck	411	/** @brief LinuxSampler sampler channel
41	schoenebeck	57	*
42	persson	840	* Encapsulates a channel of a specific sampler engine type, one
43	schoenebeck	411	* connection to a MIDI input device and one connection to an audio
44			* output device. You cannot create an instance of this class on your
45			* own, you have to use the AddSamplerChannel() method of the Sampler
46			* object to create a new sampler channel.
47	schoenebeck	57	*/
48	schoenebeck	53	class SamplerChannel {
49			public:
50	schoenebeck	57	/**
51	schoenebeck	411	* Assign a sampler engine type to this sampler channel.
52	schoenebeck	57	*
53	schoenebeck	411	* @param EngineType - type of the engine to use
54	schoenebeck	880	* @throws Exception - if \a EngineType is invalid
55	schoenebeck	900	* @see Sampler::AvailableEngineTypes()
56	schoenebeck	57	*/
57	schoenebeck	880	void SetEngineType(String EngineType) throw (Exception);
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	schoenebeck	411	* Connect this sampler channel to a MIDI input device.
71	schoenebeck	57	*
72	capela	159	* @param pDevice - MIDI input device to connect to
73			*/
74			void SetMidiInputDevice(MidiInputDevice *pDevice);
75
76			/**
77	schoenebeck	411	* Connect this sampler channel to a MIDI input port.
78	capela	159	*
79			* @param MidiPort - MIDI port to connect to
80			*/
81			void SetMidiInputPort(int MidiPort);
82
83			/**
84	schoenebeck	411	* Define on which MIDI channel(s) this sampler channel should
85			* listen to. By default, that is after creation of a new
86			* sampler channel, the sampler channel will listen to all MIDI
87			* channels.
88	capela	159	*
89	schoenebeck	411	* @param MidiChannel - MIDI channel to listen
90	capela	159	*/
91	schoenebeck	675	void SetMidiInputChannel(midi_chan_t MidiChannel);
92	capela	159
93			/**
94			* Connect this sampler channel to a MIDI input triplet.
95			*
96			* @param pDevice - MIDI input device to connect to
97	schoenebeck	221	* @param iMidiPort - MIDI port to connect to
98	schoenebeck	57	* @param MidiChannel - optional: MIDI channel on which the
99			* sampler channel should listen to
100			* (default: listen on all MIDI channels)
101			*/
102	schoenebeck	675	void SetMidiInput(MidiInputDevice* pDevice, int iMidiPort, midi_chan_t MidiChannel = midi_chan_all);
103	schoenebeck	57
104			/**
105	schoenebeck	411	* Returns the EngineChannel object that was deployed on this
106			* sampler channel appropriate to the given sampler engine type.
107	schoenebeck	57	*
108			* @returns pointer to engine or NULL if no engine deployed
109			*/
110	schoenebeck	411	EngineChannel* GetEngineChannel();
111	schoenebeck	57
112			/**
113	capela	159	* Returns the MIDI input channel to which this sampler
114			* channel is currently connected to.
115	schoenebeck	57	*
116	capela	159	* @returns The MIDI input channel on which the sampler
117			* channel is listening to.
118	schoenebeck	57	*/
119	schoenebeck	675	midi_chan_t GetMidiInputChannel();
120	schoenebeck	57
121			/**
122	capela	159	* Returns the MIDI input port number to which this sampler
123			* channel is currently connected to.
124			*
125			* @returns MIDI input port number or -1 if not connected
126			*/
127			int GetMidiInputPort();
128
129			/**
130	schoenebeck	57	* Returns the audio output device to which this sampler channel
131			* is currently connected to.
132			*
133			* @returns pointer to audio output device or NULL if not
134			* connected
135			*/
136			AudioOutputDevice* GetAudioOutputDevice();
137
138			/**
139	capela	159	* Returns the MIDI input device to which this sampler channel
140	senkov	155	* is currently connected to.
141			*
142	capela	159	* @returns pointer to MIDI input device or NULL if not
143	senkov	155	* connected
144			*/
145			MidiInputDevice* GetMidiInputDevice();
146
147			/**
148	schoenebeck	57	* Returns the index number of this sampler channel within the
149			* Sampler instance.
150			*/
151			uint Index();
152
153			protected:
154	schoenebeck	53	SamplerChannel(Sampler* pS);
155	letz	502	virtual ~SamplerChannel();
156	schoenebeck	57
157	capela	159	/** Getting MIDI input device port given its index number. */
158	schoenebeck	675	MidiInputPort* __GetMidiInputDevicePort(int iMidiPort);
159	schoenebeck	203
160	schoenebeck	53	Sampler* pSampler;
161	schoenebeck	411	EngineChannel* pEngineChannel;
162	schoenebeck	53	AudioOutputDevice* pAudioOutputDevice;
163	capela	159	MidiInputDevice* pMidiInputDevice;
164	schoenebeck	53	int iIndex;
165	schoenebeck	57
166			friend class Sampler;
167	schoenebeck	675	private:
168			int iMidiPort; ///< Don't access directly, read GetMidiInputPort() instead !
169			midi_chan_t midiChannel; ///< Don't access directly, read GetMidiInputChannel() instead !
170	schoenebeck	53	};
171
172	schoenebeck	411	/** @brief LinuxSampler main class
173	schoenebeck	57	*
174			* This is the toplevel class for a LinuxSampler instance.
175			*
176			* LinuxSampler can have arbitrary numbers of sampler channels. Each
177			* sampler channel can individually be deployed with it's own sampler
178			* engine, connected to an arbitrary MIDI input device and connected to
179			* an arbitrary audio output device. Here an example setup:
180	schoenebeck	675	* @code
181	schoenebeck	898	* S.Channel MIDI in S.Engine Audio out
182	schoenebeck	675	* -------------------------------------------------------------------
183	schoenebeck	898	* 0 Alsa -> gig::Engine -> Jack
184			* 1 VSTi -> Akai::Engine -> VSTi
185			* 2 Jack -> DLS::Engine -> Jack
186			* 3 Jack -> SF::Engine -> Alsa
187	schoenebeck	57	*
188	schoenebeck	675	* ... (and so on) ...
189			* @endcode
190	schoenebeck	57	*
191			* Note that not all audio and MIDI backends and sampler engines listed
192	schoenebeck	898	* in the example above might already been implemented!
193	schoenebeck	57	*
194			* As you can see in the example setup, LinuxSampler is capable to use
195			* several, different audio output and MIDI input systems
196			* simultaniously at the same time. Here the example setup shown in the
197	schoenebeck	898	* aspect of MIDI input and audio output devices / drivers:
198	schoenebeck	675	* @code
199	schoenebeck	898	* ######################### #########################
200			* # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
201			* ######################### #########################
202			* ^ ^ ^
203			* /------------>\|Sampler Channel 0\|-----/ \| \|
204			* \| /--------->\|Sampler Channel 1\|---------------------/
205			* \| \| /------>\|Sampler Channel 2\|---------/
206			* \| \| \| /--->\|Sampler Channel 3\|------------>#########################
207			* \| \| \| \| ... (and so on) ... # AudioOutputDeviceAlsa #
208			* \| \| \| \| #########################
209			* \| \| \| \-----------------------------------------------------\
210			* \| \| \--------------------------------------------\ \|
211			* \| \--------------------\ \| \|
212			* \| \| \| \|
213	schoenebeck	675	* ####################### ####################### #######################
214			* # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
215			* ####################### ####################### #######################
216			* @endcode
217	schoenebeck	57	*
218			* As you can see in this example setup, one device (that is midi input
219			* driver / audio output driver) can be connected multiple times to
220			* different sampler channels.
221	schoenebeck	898	*
222			* It's even possible to create multiple instances of the same driver, for
223			* example multiple instances of the Alsa output driver to use multiple
224			* sound cards at the same time, or multiple instances of the JACK audio
225			* output driver to leverage SMP systems or boxes with several hard discs.
226	schoenebeck	57	*/
227	schoenebeck	53	class Sampler {
228			public:
229	schoenebeck	57	/**
230			* Constructor. Create a LinuxSampler instance.
231			*/
232	schoenebeck	53	Sampler();
233	schoenebeck	57
234			/**
235			* Destructor.
236			*/
237	letz	502	virtual ~Sampler();
238	schoenebeck	57
239			/**
240			* Returns the number of sampler channels currently allocated.
241			*/
242			uint SamplerChannels();
243
244			/**
245	schoenebeck	209	* Create and add a new sampler channel to this Sampler
246			* instance. For race condition reasons the new channel will use
247			* an index past the last already existing sampler channel
248			* index (in case the index limit was not reached yet, otherwise
249			* a free index starting from 0 is searched).
250	schoenebeck	57	*
251			* @returns pointer to new sampler channel
252			*/
253			SamplerChannel* AddSamplerChannel();
254
255			/**
256			* Returns the sampler channel of the given sampler channel
257			* index.
258			*
259			* @returns pointer to sought sampler channel
260			*/
261			SamplerChannel* GetSamplerChannel(uint uiSamplerChannel);
262
263			/**
264	schoenebeck	209	* Returns all created sampler channels.
265			*/
266			std::map<uint, SamplerChannel*> GetSamplerChannels();
267
268			/**
269	schoenebeck	57	* Destroy and remove the given sampler channel from this
270			* Sampler instance.
271			*
272			* @param pSamplerChannel - pointer to sampler channel to remove
273			*/
274			void RemoveSamplerChannel(SamplerChannel* pSamplerChannel);
275
276			/**
277			* Destroy and remove the given sampler channel from this
278			* Sampler instance.
279			*
280			* @param uiSamplerChannel - index of the sampler channel to
281			* remove
282			*/
283			void RemoveSamplerChannel(uint uiSamplerChannel);
284
285	schoenebeck	209	/**
286			* Returns the names of all available audio output drivers.
287			*/
288	schoenebeck	123	std::vector<String> AvailableAudioOutputDrivers();
289
290	schoenebeck	57	/**
291	schoenebeck	900	* Returns the names of all available MIDI input drivers.
292			*/
293			std::vector<String> AvailableMidiInputDrivers();
294
295			/**
296			* Returns the names of all available sampler engine types.
297			* @see SamplerChannel::SetEngineType()
298			*/
299			std::vector<String> AvailableEngineTypes();
300
301			/**
302	senkov	155	* Create an audio output device.
303	schoenebeck	57	*
304	schoenebeck	123	* @param AudioDriver - name of the audio driver
305			* @param Parameters - eventually needed driver parameters to
306			* create the device
307	schoenebeck	57	* @returns pointer to created audio output device
308	schoenebeck	880	* @throws Exception if device could not be created
309	schoenebeck	57	*/
310	schoenebeck	880	AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (Exception);
311	schoenebeck	57
312	senkov	155	/**
313			* Create a midi input device.
314			*
315			* @param MidiDriver - name of the midi driver
316			* @param Parameters - eventually needed driver parameters to
317			* create the device
318			* @returns pointer to created midi input device
319	schoenebeck	880	* @throws Exception if device could not be created
320	senkov	155	*/
321	schoenebeck	880	MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (Exception);
322	senkov	155
323	schoenebeck	209	/**
324			* Returns the number of all created audio output devices.
325			*/
326	schoenebeck	123	uint AudioOutputDevices();
327	schoenebeck	209
328			/**
329			* Returns the number of all created MIDI input devices.
330			*/
331	senkov	155	uint MidiInputDevices();
332	schoenebeck	57
333	schoenebeck	209	/**
334			* Returns all created audio output devices.
335			*/
336	schoenebeck	123	std::map<uint, AudioOutputDevice*> GetAudioOutputDevices();
337
338	schoenebeck	209	/**
339			* Returns all created MIDI input devices.
340			*/
341	senkov	155	std::map<uint, MidiInputDevice*> GetMidiInputDevices();
342
343	schoenebeck	209	/**
344			* Destroy the given audio output device and takes care if there
345			* are still sampler angines connected to this device, etc.
346			*
347	schoenebeck	880	* @throws Exception if sampler channels are still
348			* connected to the device
349	schoenebeck	209	*/
350	schoenebeck	880	void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (Exception);
351	schoenebeck	123
352	schoenebeck	209	/**
353			* Destroy the given MIDI input device and takes care if there
354			* are still sampler angines connected to this device, etc.
355			*
356	schoenebeck	880	* @throws Exception if sampler channels are still
357			* connected to the device
358	schoenebeck	209	*/
359	schoenebeck	880	void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (Exception);
360	schoenebeck	209
361	schoenebeck	212	/**
362	iliev	778	* Gets the current number of all active voices.
363			* @returns The current number of all active voices.
364			*/
365			int GetVoiceCount();
366
367			/**
368	schoenebeck	212	* Reset the whole sampler. Destroy all engines, sampler
369			* channels, MIDI input devices and audio output devices.
370			*/
371			void Reset();
372
373	schoenebeck	53	protected:
374	schoenebeck	123	typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;
375	senkov	155	typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;
376	schoenebeck	209	typedef std::map<uint, SamplerChannel*> SamplerChannelMap;
377	schoenebeck	53
378	schoenebeck	209	SamplerChannelMap mSamplerChannels; ///< contains all created sampler channels
379			AudioOutputDeviceMap mAudioOutputDevices; ///< contains all created audio output devices
380			MidiInputDeviceMap mMidiInputDevices; ///< contains all created MIDI input devices
381	schoenebeck	53
382			friend class SamplerChannel;
383			};
384			}
385
386			#endif // __LS_SAMPLER_H__