/[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 502 by letz, Fri Apr 29 14:20:22 2005 UTC revision 1686 by schoenebeck, Thu Feb 14 14:58:50 2008 UTC
# Line 3  Line 3 
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
6   *   Copyright (C) 2005 Christian Schoenebeck                              *   *   Copyright (C) 2005 - 2008 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 26 
26    
27  #include <vector>  #include <vector>
28  #include <map>  #include <map>
29    #include "EventListeners.h"
30  #include "common/global.h"  #include "common/global.h"
31  #include "common/LinuxSamplerException.h"  #include "common/Exception.h"
32  #include "engines/common/EngineChannel.h"  #include "engines/EngineChannel.h"
33  #include "drivers/midi/MidiInputDevice.h"  #include "drivers/midi/MidiInputDevice.h"
34  #include "drivers/audio/AudioOutputDevice.h"  #include "drivers/audio/AudioOutputDevice.h"
35    
# Line 39  namespace LinuxSampler { Line 40  namespace LinuxSampler {
40    
41      /** @brief LinuxSampler sampler channel      /** @brief LinuxSampler sampler channel
42       *       *
43       * Encapsulates a channel of a specific sampler engine typ, one       * Encapsulates a channel of a specific sampler engine type, one
44       * connection to a MIDI input device and one connection to an audio       * connection to a MIDI input device and one connection to an audio
45       * output device. You cannot create an instance of this class on your       * output device. You cannot create an instance of this class on your
46       * own, you have to use the AddSamplerChannel() method of the Sampler       * own, you have to use the AddSamplerChannel() method of the Sampler
# Line 51  namespace LinuxSampler { Line 52  namespace LinuxSampler {
52               * Assign a sampler engine type to this sampler channel.               * Assign a sampler engine type to this sampler channel.
53               *               *
54               * @param EngineType - type of the engine to use               * @param EngineType - type of the engine to use
55               * @throws LinuxSamplerException - if \a EngineType is invalid               * @throws Exception - if \a EngineType is invalid
56                 * @see Sampler::AvailableEngineTypes()
57               */               */
58              void SetEngineType(String EngineType) throw (LinuxSamplerException);              void SetEngineType(String EngineType) throw (Exception);
59    
60              /**              /**
61               * Connect this sampler channel to an audio output device, that               * Connect this sampler channel to an audio output device, that
# Line 87  namespace LinuxSampler { Line 89  namespace LinuxSampler {
89               *               *
90               * @param MidiChannel - MIDI channel to listen               * @param MidiChannel - MIDI channel to listen
91               */               */
92              void SetMidiInputChannel(MidiInputPort::midi_chan_t MidiChannel);              void SetMidiInputChannel(midi_chan_t MidiChannel);
93    
94              /**              /**
95               * Connect this sampler channel to a MIDI input triplet.               * Connect this sampler channel to a MIDI input triplet.
# Line 98  namespace LinuxSampler { Line 100  namespace LinuxSampler {
100               *                      sampler channel should listen to               *                      sampler channel should listen to
101               *                      (default: listen on all MIDI channels)               *                      (default: listen on all MIDI channels)
102               */               */
103              void SetMidiInput(MidiInputDevice* pDevice, int iMidiPort, MidiInputPort::midi_chan_t MidiChannel = MidiInputPort::midi_chan_all);              void SetMidiInput(MidiInputDevice* pDevice, int iMidiPort, midi_chan_t MidiChannel = midi_chan_all);
104    
105              /**              /**
106               * Returns the EngineChannel object that was deployed on this               * Returns the EngineChannel object that was deployed on this
# Line 115  namespace LinuxSampler { Line 117  namespace LinuxSampler {
117               * @returns  The MIDI input channel on which the sampler               * @returns  The MIDI input channel on which the sampler
118               *           channel is listening to.               *           channel is listening to.
119               */               */
120              MidiInputPort::midi_chan_t GetMidiInputChannel();              midi_chan_t GetMidiInputChannel();
121    
122              /**              /**
123               * Returns the MIDI input port number to which this sampler               * Returns the MIDI input port number to which this sampler
# Line 148  namespace LinuxSampler { Line 150  namespace LinuxSampler {
150               * Sampler instance.               * Sampler instance.
151               */               */
152              uint Index();              uint Index();
153                
154                /**
155                 * Registers the specified listener to be notified
156                 * when the engine type of this sampler channel is changed.
157                 */
158                void AddEngineChangeListener(EngineChangeListener* l);
159    
160                /**
161                 * Removes the specified listener.
162                 */
163                void RemoveEngineChangeListener(EngineChangeListener* l);
164    
165                /**
166                 * Removes the specified listener.
167                 */
168                void RemoveAllEngineChangeListeners();
169    
170                /**
171                 * Notifies listeners that the engine type of this sampler
172                 * channel is going to be changed soon.
173                 */
174                void fireEngineToBeChanged();
175    
176                /**
177                 * Notifies listeners that the engine
178                 * type of this sampler channel is changed.
179                 */
180                void fireEngineChanged();
181    
182    
183          protected:          protected:
184              SamplerChannel(Sampler* pS);              SamplerChannel(Sampler* pS);
185              virtual ~SamplerChannel();              virtual ~SamplerChannel();
186    
187              /** Getting MIDI input device port given its index number. */              /** Getting MIDI input device port given its index number. */
188              MidiInputPort* GetMidiInputDevicePort(int iMidiPort);              MidiInputPort* __GetMidiInputDevicePort(int iMidiPort);
189    
190              Sampler*           pSampler;              Sampler*           pSampler;
191              EngineChannel*     pEngineChannel;              EngineChannel*     pEngineChannel;
192              AudioOutputDevice* pAudioOutputDevice;              AudioOutputDevice* pAudioOutputDevice;
193              MidiInputDevice*   pMidiInputDevice;              MidiInputDevice*   pMidiInputDevice;
             int                midiPort;  
             MidiInputPort::midi_chan_t midiChannel;  
194              int                iIndex;              int                iIndex;
195    
196              friend class Sampler;              friend class Sampler;
197            private:
198                int                iMidiPort;   ///< Don't access directly, read GetMidiInputPort() instead !
199                midi_chan_t        midiChannel; ///< Don't access directly, read GetMidiInputChannel() instead !
200                ListenerList<EngineChangeListener*> llEngineChangeListeners;
201      };      };
202    
203      /** @brief LinuxSampler main class      /** @brief LinuxSampler main class
# Line 175  namespace LinuxSampler { Line 208  namespace LinuxSampler {
208       * sampler channel can individually be deployed with it's own sampler       * sampler channel can individually be deployed with it's own sampler
209       * engine, connected to an arbitrary MIDI input device and connected to       * engine, connected to an arbitrary MIDI input device and connected to
210       * an arbitrary audio output device. Here an example setup:       * an arbitrary audio output device. Here an example setup:
211         * @code
212         * S.Channel    MIDI in    S.Engine         Audio out
213         * -------------------------------------------------------------------
214         *   0          Alsa   ->  gig::Engine  ->  Jack
215         *   1          VSTi   ->  Akai::Engine ->  VSTi
216         *   2          Jack   ->  DLS::Engine  ->  Jack
217         *   3          Jack   ->  SF::Engine   ->  Alsa
218       *       *
219       *  S.Channel.      MIDI in         S.Engine                Audio out       * ... (and so on) ...
220       *  -------------------------------------------------------------------       * @endcode
      *  0               Alsa    ->      gig::Engine     ->      Jack  
      *  1               VSTi    ->      Akai::Engine    ->      VSTi  
      *  2               Jack    ->      DLS::Engine     ->      Jack  
      *  3               Jack    ->      SF::Engine      ->      Alsa  
      *  
      *  ... (and so on) ...  
221       *       *
222       * Note that not all audio and MIDI backends and sampler engines listed       * Note that not all audio and MIDI backends and sampler engines listed
223       * in the example above are already implemented!       * in the example above might already been implemented!
224       *       *
225       * 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
226       * several, different audio output and MIDI input systems       * several, different audio output and MIDI input systems
227       * simultaniously at the same time. Here the example setup shown in the       * simultaniously at the same time. Here the example setup shown in the
228       * ascpect of MIDI input and audio output devices / drivers:       * aspect of MIDI input and audio output devices / drivers:
229       *       * @code
230       *                            ######################### #########################       *                      ######################### #########################
231       *                            # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #       *                      # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
232       *                            ######################### #########################       *                      ######################### #########################
233       *                                          ^   ^           ^       *                                        ^   ^           ^
234       *    /------------>|Sampler Channel 0|-----/   |           |       *  /------------>|Sampler Channel 0|-----/   |           |
235       *    |  /--------->|Sampler Channel 1|---------------------/       *  |  /--------->|Sampler Channel 1|---------------------/
236       *    |  |    /---->|Sampler Channel 2|---------/       *  |  |  /------>|Sampler Channel 2|---------/
237       *    |  |    |  /->|Sampler Channel 3|------------>#########################       *  |  |  |  /--->|Sampler Channel 3|------------>#########################
238       *    |  |    |  |  ... (and so on) ...             # AudioOutputDeviceAlsa #       *  |  |  |  |    ... (and so on) ...             # AudioOutputDeviceAlsa #
239       *    |  |    |  |                                  #########################       *  |  |  |  |                                    #########################
240       *    |  |    |  \----------------------------------------------------\       *  |  |  |  \-----------------------------------------------------\
241       *    |  |    \-------------------------------------------\           |       *  |  |  \--------------------------------------------\           |
242       *    |  \--------------------\                           |           |       *  |  \--------------------\                          |           |
243       *    |                       |                           |           |       *  |                       |                          |           |
244       *  ####################### ####################### #######################       * ####################### ####################### #######################
245       *  # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #       * # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
246       *  ####################### ####################### #######################       * ####################### ####################### #######################
247         * @endcode
248       *       *
249       * 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
250       * driver / audio output driver) can be connected multiple times to       * driver / audio output driver) can be connected multiple times to
251       * different sampler channels.       * different sampler channels.
252         *
253         * It's even possible to create multiple instances of the same driver, for
254         * example multiple instances of the Alsa output driver to use multiple
255         * sound cards at the same time, or multiple instances of the JACK audio
256         * output driver to leverage SMP systems or boxes with several hard discs.
257       */       */
258      class Sampler {      class Sampler {
259          public:          public:
# Line 274  namespace LinuxSampler { Line 314  namespace LinuxSampler {
314              void RemoveSamplerChannel(uint uiSamplerChannel);              void RemoveSamplerChannel(uint uiSamplerChannel);
315    
316              /**              /**
317                 * Registers the specified listener to be notified
318                 * when the number of sampler chanels is changed.
319                 */
320                void AddChannelCountListener(ChannelCountListener* l);
321    
322                /**
323                 * Removes the specified listener.
324                 */
325                void RemoveChannelCountListener(ChannelCountListener* l);
326    
327                /**
328                 * Registers the specified listener to be notified
329                 * when the number of audio output devices is changed.
330                 */
331                void AddAudioDeviceCountListener(AudioDeviceCountListener* l);
332    
333                /**
334                 * Removes the specified listener.
335                 */
336                void RemoveAudioDeviceCountListener(AudioDeviceCountListener* l);
337    
338                
339                /**
340                 * Registers the specified listener to be notified
341                 * when the number of MIDI input devices is changed.
342                 */
343                void AddMidiDeviceCountListener(MidiDeviceCountListener* l);
344    
345                /**
346                 * Removes the specified listener.
347                 */
348                void RemoveMidiDeviceCountListener(MidiDeviceCountListener* l);
349    
350                /**
351                 * Registers the specified listener to be notified when the number
352                 * of active voices in a particular sampler channel is changed.
353                 */
354                void AddVoiceCountListener(VoiceCountListener* l);
355    
356                /**
357                 * Removes the specified listener.
358                 */
359                void RemoveVoiceCountListener(VoiceCountListener* l);
360    
361                /**
362                 * Notifies listeners that the number of active voices
363                 * on the specified sampler channel is changed.
364                 * @param ChannelId The numerical ID of the sampler channel.
365                 * @param NewCount The new number of active voices.
366                 */
367                void fireVoiceCountChanged(int ChannelId, int NewCount);
368    
369                /**
370                 * Registers the specified listener to be notified when the number
371                 * of active disk streams in a particular sampler channel is changed.
372                 */
373                void AddStreamCountListener(StreamCountListener* l);
374    
375                /**
376                 * Removes the specified listener.
377                 */
378                void RemoveStreamCountListener(StreamCountListener* l);
379    
380                /**
381                 * Notifies listeners that the number of active disk streams
382                 * on the specified sampler channel is changed.
383                 * @param ChannelId The numerical ID of the sampler channel.
384                 * @param NewCount The new number of active disk streams.
385                 */
386                void fireStreamCountChanged(int ChannelId, int NewCount);
387    
388                /**
389                 * Registers the specified listener to be
390                 * notified when the fill state of the disk stream
391                 * buffers on a specific sampler channel is changed.
392                 */
393                void AddBufferFillListener(BufferFillListener* l);
394    
395                /**
396                 * Removes the specified listener.
397                 */
398                void RemoveBufferFillListener(BufferFillListener* l);
399    
400                /**
401                 * Notifies listeners that the fill state of the disk stream
402                 * buffers on the specified sampler channel is changed.
403                 * @param ChannelId The numerical ID of the sampler channel.
404                 * @param FillData The buffer fill data for the specified sampler channel.
405                 */
406                void fireBufferFillChanged(int ChannelId, String FillData);
407    
408                /**
409                 * Registers the specified listener to be notified
410                 * when total number of active voices is changed.
411                 */
412                void AddTotalVoiceCountListener(TotalVoiceCountListener* l);
413    
414                /**
415                 * Removes the specified listener.
416                 */
417                void RemoveTotalVoiceCountListener(TotalVoiceCountListener* l);
418    
419                /**
420                 * Notifies listeners that the total number of active voices is changed.
421                 * @param NewCount The new number of active voices.
422                 */
423                void fireTotalVoiceCountChanged(int NewCount);
424                
425                void AddTotalStreamCountListener(TotalStreamCountListener* l);
426                void RemoveTotalStreamCountListener(TotalStreamCountListener* l);
427                void fireTotalStreamCountChanged(int NewCount);
428    
429                /**
430                 * Registers the specified listener to be notified when the number
431                 * of effect sends on a particular sampler channel is changed.
432                 */
433                void AddFxSendCountListener(FxSendCountListener* l);
434    
435                /**
436                 * Removes the specified listener.
437                 */
438                void RemoveFxSendCountListener(FxSendCountListener* l);
439    
440                /**
441               * Returns the names of all available audio output drivers.               * Returns the names of all available audio output drivers.
442               */               */
443              std::vector<String> AvailableAudioOutputDrivers();              std::vector<String> AvailableAudioOutputDrivers();
444    
445              /**              /**
446                 * Returns the names of all available MIDI input drivers.
447                 */
448                std::vector<String> AvailableMidiInputDrivers();
449    
450                /**
451                 * Returns the names of all available sampler engine types.
452                 * @see SamplerChannel::SetEngineType()
453                 */
454                std::vector<String> AvailableEngineTypes();
455    
456                /**
457               * Create an audio output device.               * Create an audio output device.
458               *               *
459               * @param AudioDriver - name of the audio driver               * @param AudioDriver - name of the audio driver
460               * @param Parameters - eventually needed driver parameters to               * @param Parameters - eventually needed driver parameters to
461               *                     create the device               *                     create the device
462               * @returns  pointer to created audio output device               * @returns  pointer to created audio output device
463               * @throws LinuxSamplerException  if device could not be created               * @throws Exception  if device could not be created
464               */               */
465              AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);              AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (Exception);
466    
467              /**              /**
468               * Create a midi input device.               * Create a midi input device.
# Line 296  namespace LinuxSampler { Line 471  namespace LinuxSampler {
471               * @param Parameters - eventually needed driver parameters to               * @param Parameters - eventually needed driver parameters to
472               *                     create the device               *                     create the device
473               * @returns  pointer to created midi input device               * @returns  pointer to created midi input device
474               * @throws LinuxSamplerException  if device could not be created               * @throws Exception  if device could not be created
475               */               */
476              MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);              MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (Exception);
477    
478              /**              /**
479               * Returns the number of all created audio output devices.               * Returns the number of all created audio output devices.
# Line 324  namespace LinuxSampler { Line 499  namespace LinuxSampler {
499               * Destroy the given audio output device and takes care if there               * Destroy the given audio output device and takes care if there
500               * are still sampler angines connected to this device, etc.               * are still sampler angines connected to this device, etc.
501               *               *
502               * @throws LinuxSamplerException  if sampler channels are still               * @throws Exception  if sampler channels are still
503               *                                connected to the device               *                    connected to the device
504               */               */
505              void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (LinuxSamplerException);              void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (Exception);
506    
507              /**              /**
508               * Destroy the given MIDI input device and takes care if there               * Destroy the given MIDI input device and takes care if there
509               * are still sampler angines connected to this device, etc.               * are still sampler angines connected to this device, etc.
510               *               *
511               * @throws LinuxSamplerException  if sampler channels are still               * @throws Exception  if sampler channels are still
512               *                                connected to the device               *                    connected to the device
513                 */
514                void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (Exception);
515    
516                 /**
517                 * Gets the current number of all active streams.
518                 * @returns The current number of all active streams.
519                 */
520                int GetDiskStreamCount();
521    
522                /**
523                 * Gets the current number of all active voices.
524                 * @returns The current number of all active voices.
525               */               */
526              void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (LinuxSamplerException);              int GetVoiceCount();
527    
528              /**              /**
529               * Reset the whole sampler. Destroy all engines, sampler               * Reset the whole sampler. Destroy all engines, sampler
# Line 345  namespace LinuxSampler { Line 532  namespace LinuxSampler {
532              void Reset();              void Reset();
533    
534          protected:          protected:
535                /**
536                 * Notifies listeners that the number of sampler channels has been changed.
537                 * @param NewCount The new number of sampler channels.
538                 */
539                void fireChannelCountChanged(int NewCount);
540    
541                /**
542                 * Notifies listeners that the specified sampler channel has just
543                 * been added.
544                 * @param pChannel The new sampler channel.
545                 */
546                void fireChannelAdded(SamplerChannel* pChannel);
547    
548                /**
549                 * Notifies listeners that the specified sampler channel is
550                 * going to be removed soon.
551                 * @param pChannel sampler channel to be removed.
552                 */
553                void fireChannelToBeRemoved(SamplerChannel* pChannel);
554    
555                /**
556                 * Notifies listeners that the number of audio output devices has been changed.
557                 * @param NewCount The new number of audio output devices.
558                 */
559                void fireAudioDeviceCountChanged(int NewCount);
560    
561                /**
562                 * Notifies listeners that the number of MIDI input devices has been changed.
563                 * @param NewCount The new number of MIDI input devices.
564                 */
565                void fireMidiDeviceCountChanged(int NewCount);
566    
567                /**
568                 * Notifies listeners that the number of effect sends
569                 * on a particular sampler channel is changed.
570                 * @param ChannelId The numerical ID of the sampler channel.
571                 * @param NewCount The new number of sampler channels.
572                 */
573                void fireFxSendCountChanged(int ChannelId, int NewCount);
574    
575              typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;              typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;
576              typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;              typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;
577              typedef std::map<uint, SamplerChannel*> SamplerChannelMap;              typedef std::map<uint, SamplerChannel*> SamplerChannelMap;
# Line 354  namespace LinuxSampler { Line 581  namespace LinuxSampler {
581              MidiInputDeviceMap    mMidiInputDevices;   ///< contains all created MIDI input devices              MidiInputDeviceMap    mMidiInputDevices;   ///< contains all created MIDI input devices
582    
583              friend class SamplerChannel;              friend class SamplerChannel;
584    
585            private:
586                ListenerList<ChannelCountListener*> llChannelCountListeners;
587                ListenerList<AudioDeviceCountListener*> llAudioDeviceCountListeners;
588                ListenerList<MidiDeviceCountListener*> llMidiDeviceCountListeners;
589                ListenerList<VoiceCountListener*> llVoiceCountListeners;
590                ListenerList<StreamCountListener*> llStreamCountListeners;
591                ListenerList<BufferFillListener*> llBufferFillListeners;
592                ListenerList<TotalStreamCountListener*> llTotalStreamCountListeners;
593                ListenerList<TotalVoiceCountListener*> llTotalVoiceCountListeners;
594                ListenerList<FxSendCountListener*> llFxSendCountListeners;
595    
596                class EventHandler : public EngineChangeListener, public FxSendCountListener {
597                    public:
598                        void SetSampler(Sampler* pSampler) { this->pSampler = pSampler; }
599    
600                        /**
601                         * Invoked when the engine type of the specified sampler
602                         * channel is going to be changed soon.
603                         * @param ChannelId The numerical ID of the sampler channel
604                         */
605                        virtual void EngineToBeChanged(int ChannelId);
606    
607                        /**
608                         * Invoked when the engine type of the
609                         * specified sampler channel is changed.
610                         * @param ChannelId The numerical ID of the sampler
611                         * channel, which engine type has been changed.
612                         */
613                        virtual void EngineChanged(int ChannelId);
614    
615                        /**
616                         * Invoked when the number of effect sends
617                         * on the specified sampler channel has changed.
618                         * @param ChannelId The numerical ID of the sampler channel.
619                         * @param NewCount The new number of effect sends.
620                         */
621                        virtual void FxSendCountChanged(int ChannelId, int NewCount);
622    
623                    private:
624                        Sampler* pSampler;
625                } eventHandler;
626      };      };
627  }  }
628    
Legend:
Removed from v.502  
changed lines
  Added in v.1686
  ViewVC Help
Powered by ViewVC