/[svn]/linuxsampler/trunk/src/Sampler.h
ViewVC logotype

Diff of /linuxsampler/trunk/src/Sampler.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 57 by schoenebeck, Sun May 2 17:45:43 2004 UTC revision 900 by schoenebeck, Wed Jul 5 17:53:22 2006 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003 by Benno Senoner and Christian Schoenebeck         *   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
6     *   Copyright (C) 2005, 2006 Christian Schoenebeck                        *
7   *                                                                         *   *                                                                         *
8   *   This program is free software; you can redistribute it and/or modify  *   *   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  *   *   it under the terms of the GNU General Public License as published by  *
# Line 26  Line 27 
27  #include <vector>  #include <vector>
28  #include <map>  #include <map>
29  #include "common/global.h"  #include "common/global.h"
30  #include "common/LinuxSamplerException.h"  #include "common/Exception.h"
31  #include "engines/common/Engine.h"  #include "engines/EngineChannel.h"
32  #include "mididriver/MidiInputDevice.h"  #include "drivers/midi/MidiInputDevice.h"
33  #include "audiodriver/AudioOutputDevice.h"  #include "drivers/audio/AudioOutputDevice.h"
34    
35  namespace LinuxSampler {  namespace LinuxSampler {
36    
     /**  
      * Which sampler engine to be used.  
      */  
     enum engine_type_t {  
         engine_type_gig  
     };  
   
     /**  
      * Which audio output system to be used.  
      */  
     enum audio_output_type_t {  
         audio_output_type_alsa,  
         audio_output_type_jack  
     };  
   
     /**  
      * Which MIDI input system to be used.  
      */  
     enum midi_input_type_t {  
         midi_input_type_alsa  
     };  
   
37      // just symbol prototyping      // just symbol prototyping
38      class Sampler;      class Sampler;
39    
40      /** LinuxSampler sampler channel      /** @brief LinuxSampler sampler channel
41       *       *
42       * Encapsulates one sampler engine, one connection to a MIDI input       * Encapsulates a channel of a specific sampler engine type, one
43       * device and one connection to an audio output device. You cannot       * connection to a MIDI input device and one connection to an audio
44       * create an instance of this class on you own, you have to use the       * output device. You cannot create an instance of this class on your
45       * AddSamplerChannel() method of the Sampler object to create a new       * own, you have to use the AddSamplerChannel() method of the Sampler
46       * sampler channel.       * object to create a new sampler channel.
47       */       */
48      class SamplerChannel {      class SamplerChannel {
49          public:          public:
50              /**              /**
51               * Deploy a sampler engine of the given type for this sampler               * Assign a sampler engine type to this sampler channel.
52               * channnel. If there was already a sampler engine deployed on               *
53               * this sampler channel, then the old engine will automatically               * @param EngineType - type of the engine to use
54               * be destroyed.               * @throws Exception - if \a EngineType is invalid
55                 * @see Sampler::AvailableEngineTypes()
56                 */
57                void SetEngineType(String EngineType) throw (Exception);
58    
59                /**
60                 * 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                 *
65                 * @param pDevice - audio output device to connect to
66                 */
67                void SetAudioOutputDevice(AudioOutputDevice* pDevice);
68    
69                /**
70                 * Connect this sampler channel to a MIDI input device.
71                 *
72                 * @param pDevice - MIDI input device to connect to
73                 */
74                void SetMidiInputDevice(MidiInputDevice *pDevice);
75    
76                /**
77                 * Connect this sampler channel to a MIDI input port.
78               *               *
79               * @param EngineType - type of the engine to deploy               * @param MidiPort - MIDI port to connect to
80               */               */
81              void LoadEngine(engine_type_t EngineType);              void SetMidiInputPort(int MidiPort);
82    
83              /**              /**
84               * Connect this sampler channel to an audio output device (that               * Define on which MIDI channel(s) this sampler channel should
85               * is audio output driver) of the given type. If the audio               * listen to. By default, that is after creation of a new
86               * output for the desired audio output system is not yet               * sampler channel, the sampler channel will listen to all MIDI
87               * created, then it will be created automatically, but with               * channels.
              * default settings though. If this sampler channel was already  
              * connected to an audio output device, then the old connection  
              * will automatically be removed before.  
88               *               *
89               * @param AudioType - audio output system to connect to               * @param MidiChannel - MIDI channel to listen
90               */               */
91              void SetAudioOutputDevice(audio_output_type_t AudioType);              void SetMidiInputChannel(midi_chan_t MidiChannel);
92    
93              /**              /**
94               * Connect this sampler channel to and MIDI input device (that               * Connect this sampler channel to a MIDI input triplet.
              * is MIDI input driver) of the given type. If the MIDI input  
              * driver for the desired MIDI input system is not yet created,  
              * then it will be created automatically, but with default  
              * settings though. If this sampler channel was already  
              * connected to a MIDI input device, then the old connection  
              * will automatically be removed before.  
95               *               *
96               * @param MidiType    - MIDI input system to connect to               * @param pDevice - MIDI input device to connect to
97                 * @param iMidiPort - MIDI port to connect to
98               * @param MidiChannel - optional: MIDI channel on which the               * @param MidiChannel - optional: MIDI channel on which the
99               *                      sampler channel should listen to               *                      sampler channel should listen to
100               *                      (default: listen on all MIDI channels)               *                      (default: listen on all MIDI channels)
101               */               */
102              void SetMidiInputDevice(midi_input_type_t MidiType, MidiInputDevice::midi_chan_t MidiChannel = MidiInputDevice::midi_chan_all);              void SetMidiInput(MidiInputDevice* pDevice, int iMidiPort, midi_chan_t MidiChannel = midi_chan_all);
103    
104              /**              /**
105               * Returns the engine that was deployed on this sampler channel.               * Returns the EngineChannel object that was deployed on this
106                 * sampler channel appropriate to the given sampler engine type.
107               *               *
108               * @returns  pointer to engine or NULL if no engine deployed               * @returns  pointer to engine or NULL if no engine deployed
109               */               */
110              Engine* GetEngine();              EngineChannel* GetEngineChannel();
111    
112              /**              /**
113               * Returns the MIDI input device to which this sampler channel               * Returns the MIDI input channel to which this sampler
114               * is currently connected to.               * channel is currently connected to.
115               *               *
116               * @returns  pointer to MIDI input device or NULL if not               * @returns  The MIDI input channel on which the sampler
117               *           connected               *           channel is listening to.
118               */               */
119              MidiInputDevice* GetMidiInputDevice();              midi_chan_t GetMidiInputChannel();
120    
121                /**
122                 * 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               * Returns the audio output device to which this sampler channel               * Returns the audio output device to which this sampler channel
# Line 133  namespace LinuxSampler { Line 136  namespace LinuxSampler {
136              AudioOutputDevice* GetAudioOutputDevice();              AudioOutputDevice* GetAudioOutputDevice();
137    
138              /**              /**
139                 * Returns the MIDI input device to which this sampler channel
140                 * is currently connected to.
141                 *
142                 * @returns  pointer to MIDI input device or NULL if not
143                 *           connected
144                 */
145                MidiInputDevice* GetMidiInputDevice();
146    
147                /**
148               * Returns the index number of this sampler channel within the               * Returns the index number of this sampler channel within the
149               * Sampler instance.               * Sampler instance.
150               */               */
# Line 140  namespace LinuxSampler { Line 152  namespace LinuxSampler {
152    
153          protected:          protected:
154              SamplerChannel(Sampler* pS);              SamplerChannel(Sampler* pS);
155             ~SamplerChannel();              virtual ~SamplerChannel();
156    
157                /** Getting MIDI input device port given its index number. */
158                MidiInputPort* __GetMidiInputDevicePort(int iMidiPort);
159    
160              Sampler*           pSampler;              Sampler*           pSampler;
161              Engine*            pEngine;              EngineChannel*     pEngineChannel;
             MidiInputDevice*   pMidiInputDevice;  
162              AudioOutputDevice* pAudioOutputDevice;              AudioOutputDevice* pAudioOutputDevice;
163                MidiInputDevice*   pMidiInputDevice;
164              int                iIndex;              int                iIndex;
165    
166              friend class Sampler;              friend class Sampler;
167            private:
168                int                iMidiPort;   ///< Don't access directly, read GetMidiInputPort() instead !
169                midi_chan_t        midiChannel; ///< Don't access directly, read GetMidiInputChannel() instead !
170      };      };
171    
172      /** LinuxSampler main class      /** @brief LinuxSampler main class
173       *       *
174       * This is the toplevel class for a LinuxSampler instance.       * This is the toplevel class for a LinuxSampler instance.
175       *       *
# Line 159  namespace LinuxSampler { Line 177  namespace LinuxSampler {
177       * sampler channel can individually be deployed with it's own sampler       * sampler channel can individually be deployed with it's own sampler
178       * engine, connected to an arbitrary MIDI input device and connected to       * engine, connected to an arbitrary MIDI input device and connected to
179       * an arbitrary audio output device. Here an example setup:       * an arbitrary audio output device. Here an example setup:
180         * @code
181         * S.Channel    MIDI in    S.Engine         Audio out
182         * -------------------------------------------------------------------
183         *   0          Alsa   ->  gig::Engine  ->  Jack
184         *   1          VSTi   ->  Akai::Engine ->  VSTi
185         *   2          Jack   ->  DLS::Engine  ->  Jack
186         *   3          Jack   ->  SF::Engine   ->  Alsa
187       *       *
188       *  S.Channel.      MIDI in         S.Engine                Audio out       * ... (and so on) ...
189       *  -------------------------------------------------------------------       * @endcode
      *  0               Alsa    ->      gig::Engine     ->      Jack  
      *  1               VSTi    ->      Akai::Engine    ->      VSTi  
      *  2               Jack    ->      DLS::Engine     ->      Jack  
      *  3               Jack    ->      SF::Engine      ->      Alsa  
      *  
      *  ... (and so on) ...  
190       *       *
191       * Note that not all audio and MIDI backends and sampler engines listed       * Note that not all audio and MIDI backends and sampler engines listed
192       * in the example above are already implemented!       * in the example above might already been implemented!
193       *       *
194       * As you can see in the example setup, LinuxSampler is capable to use       * As you can see in the example setup, LinuxSampler is capable to use
195       * several, different audio output and MIDI input systems       * several, different audio output and MIDI input systems
196       * simultaniously at the same time. Here the example setup shown in the       * simultaniously at the same time. Here the example setup shown in the
197       * ascpect of MIDI input and audio output devices / drivers:       * aspect of MIDI input and audio output devices / drivers:
198       *       * @code
199       *                            ######################### #########################       *                      ######################### #########################
200       *                            # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #       *                      # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
201       *                            ######################### #########################       *                      ######################### #########################
202       *                                          ^   ^           ^       *                                        ^   ^           ^
203       *    /------------>|Sampler Channel 0|-----/   |           |       *  /------------>|Sampler Channel 0|-----/   |           |
204       *    |  /--------->|Sampler Channel 1|---------------------/       *  |  /--------->|Sampler Channel 1|---------------------/
205       *    |  |    /---->|Sampler Channel 2|---------/       *  |  |  /------>|Sampler Channel 2|---------/
206       *    |  |    |  /->|Sampler Channel 3|------------>#########################       *  |  |  |  /--->|Sampler Channel 3|------------>#########################
207       *    |  |    |  |  ... (and so on) ...             # AudioOutputDeviceAlsa #       *  |  |  |  |    ... (and so on) ...             # AudioOutputDeviceAlsa #
208       *    |  |    |  |                                  #########################       *  |  |  |  |                                    #########################
209       *    |  |    |  \----------------------------------------------------\       *  |  |  |  \-----------------------------------------------------\
210       *    |  |    \-------------------------------------------\           |       *  |  |  \--------------------------------------------\           |
211       *    |  \--------------------\                           |           |       *  |  \--------------------\                          |           |
212       *    |                       |                           |           |       *  |                       |                          |           |
213       *  ####################### ####################### #######################       * ####################### ####################### #######################
214       *  # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #       * # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
215       *  ####################### ####################### #######################       * ####################### ####################### #######################
216         * @endcode
217       *       *
218       * As you can see in this example setup, one device (that is midi input       * 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       * driver / audio output driver) can be connected multiple times to
220       * different sampler channels.       * different sampler channels.
221         *
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       */       */
227      class Sampler {      class Sampler {
228          public:          public:
# Line 209  namespace LinuxSampler { Line 234  namespace LinuxSampler {
234              /**              /**
235               * Destructor.               * Destructor.
236               */               */
237             ~Sampler();              virtual ~Sampler();
238    
239              /**              /**
240               * Returns the number of sampler channels currently allocated.               * Returns the number of sampler channels currently allocated.
# Line 217  namespace LinuxSampler { Line 242  namespace LinuxSampler {
242              uint SamplerChannels();              uint SamplerChannels();
243    
244              /**              /**
245               * Create and add a new sampler channel to this Sampler instance.               * 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               *               *
251               * @returns  pointer to new sampler channel               * @returns  pointer to new sampler channel
252               */               */
# Line 232  namespace LinuxSampler { Line 261  namespace LinuxSampler {
261              SamplerChannel* GetSamplerChannel(uint uiSamplerChannel);              SamplerChannel* GetSamplerChannel(uint uiSamplerChannel);
262    
263              /**              /**
264                 * Returns all created sampler channels.
265                 */
266                std::map<uint, SamplerChannel*> GetSamplerChannels();
267    
268                /**
269               * Destroy and remove the given sampler channel from this               * Destroy and remove the given sampler channel from this
270               * Sampler instance.               * Sampler instance.
271               *               *
# Line 249  namespace LinuxSampler { Line 283  namespace LinuxSampler {
283              void RemoveSamplerChannel(uint uiSamplerChannel);              void RemoveSamplerChannel(uint uiSamplerChannel);
284    
285              /**              /**
286               * Create an audio output device of the given type.               * Returns the names of all available audio output drivers.
287                 */
288                std::vector<String> AvailableAudioOutputDrivers();
289    
290                /**
291                 * 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                 * Create an audio output device.
303               *               *
304               * @param AudioType - desired audio output system to use               * @param AudioDriver - name of the audio driver
305                 * @param Parameters - eventually needed driver parameters to
306                 *                     create the device
307               * @returns  pointer to created audio output device               * @returns  pointer to created audio output device
308                 * @throws Exception  if device could not be created
309               */               */
310              AudioOutputDevice* CreateAudioOutputDevice(audio_output_type_t AudioType);              AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (Exception);
311    
312              /**              /**
313               * Returns the audio output device of the given type.               * Create a midi input device.
314               *               *
315               * @param AudioType - desired audio output system to use               * @param MidiDriver - name of the midi driver
316               * @returns  pointer to audio output device or NULL if device of               * @param Parameters - eventually needed driver parameters to
317               *           desired type is not yet created               *                     create the device
318                 * @returns  pointer to created midi input device
319                 * @throws Exception  if device could not be created
320               */               */
321              AudioOutputDevice* GetAudioOutputDevice(audio_output_type_t AudioType);              MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (Exception);
322    
323              /**              /**
324               * Create a MIDI input device of the given type.               * Returns the number of all created audio output devices.
325                 */
326                uint AudioOutputDevices();
327    
328                /**
329                 * Returns the number of all created MIDI input devices.
330                 */
331                uint MidiInputDevices();
332    
333                /**
334                 * Returns all created audio output devices.
335                 */
336                std::map<uint, AudioOutputDevice*> GetAudioOutputDevices();
337    
338                /**
339                 * Returns all created MIDI input devices.
340                 */
341                std::map<uint, MidiInputDevice*> GetMidiInputDevices();
342    
343                /**
344                 * Destroy the given audio output device and takes care if there
345                 * are still sampler angines connected to this device, etc.
346               *               *
347               * @param MidiType - desired MIDI input system to use               * @throws Exception  if sampler channels are still
348               * @returns  pointer to created MIDI input device               *                    connected to the device
349               */               */
350              MidiInputDevice* CreateMidiInputDevice(midi_input_type_t MidiType);              void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (Exception);
351    
352              /**              /**
353               * Returns the MIDI input device of the given type.               * Destroy the given MIDI input device and takes care if there
354                 * are still sampler angines connected to this device, etc.
355               *               *
356               * @param MidiType - desired MIDI input system to use               * @throws Exception  if sampler channels are still
357               * @returns  pointer to MIDI input device or NULL if device of               *                    connected to the device
              *           desired type is not yet created  
358               */               */
359              MidiInputDevice* GetMidiInputDevice(midi_input_type_t MidiType);              void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (Exception);
360    
361          protected:              /**
362              typedef std::map<audio_output_type_t, AudioOutputDevice*> AudioOutputDeviceMap;               * Gets the current number of all active voices.
363              typedef std::map<midi_input_type_t, MidiInputDevice*> MidiInputDeviceMap;               * @returns The current number of all active voices.
364                 */
365                int GetVoiceCount();
366    
367              std::vector<SamplerChannel*> vSamplerChannels;   ///< contains all created sampler channels              /**
368              AudioOutputDeviceMap         AudioOutputDevices; ///< contains all created audio output devices               * Reset the whole sampler. Destroy all engines, sampler
369              MidiInputDeviceMap           MidiInputDevices;               * channels, MIDI input devices and audio output devices.
370                 */
371                void Reset();
372    
373            protected:
374                typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;
375                typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;
376                typedef std::map<uint, SamplerChannel*> SamplerChannelMap;
377    
378                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    
382              friend class SamplerChannel;              friend class SamplerChannel;
383      };      };
Legend:
Removed from v.57  
changed lines
  Added in v.900
  ViewVC Help
Powered by ViewVC