/[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 675 by schoenebeck, Wed Jun 22 22:09:28 2005 UTC revision 1761 by iliev, Fri Aug 29 15:42:06 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 149  namespace LinuxSampler { Line 151  namespace LinuxSampler {
151               */               */
152              uint Index();              uint Index();
153    
154                /** Returns the sampler to which this channel belongs */
155                Sampler* GetSampler();
156                
157                /**
158                 * Registers the specified listener to be notified
159                 * when the engine type of this sampler channel is changed.
160                 */
161                void AddEngineChangeListener(EngineChangeListener* l);
162    
163                /**
164                 * Removes the specified listener.
165                 */
166                void RemoveEngineChangeListener(EngineChangeListener* l);
167    
168                /**
169                 * Removes the specified listener.
170                 */
171                void RemoveAllEngineChangeListeners();
172    
173                /**
174                 * Notifies listeners that the engine type of this sampler
175                 * channel is going to be changed soon.
176                 */
177                void fireEngineToBeChanged();
178    
179                /**
180                 * Notifies listeners that the engine
181                 * type of this sampler channel is changed.
182                 */
183                void fireEngineChanged();
184    
185    
186          protected:          protected:
187              SamplerChannel(Sampler* pS);              SamplerChannel(Sampler* pS);
188              virtual ~SamplerChannel();              virtual ~SamplerChannel();
189    
190              /** Getting MIDI input device port given its index number. */              /** Getting MIDI input device port given its index number. */
191              MidiInputPort* __GetMidiInputDevicePort(int iMidiPort);              MidiInputPort* __GetMidiInputDevicePort(int iMidiPort);
             midi_chan_t    __GetMidiChannel();  
192    
193              Sampler*           pSampler;              Sampler*           pSampler;
194              EngineChannel*     pEngineChannel;              EngineChannel*     pEngineChannel;
# Line 167  namespace LinuxSampler { Line 200  namespace LinuxSampler {
200          private:          private:
201              int                iMidiPort;   ///< Don't access directly, read GetMidiInputPort() instead !              int                iMidiPort;   ///< Don't access directly, read GetMidiInputPort() instead !
202              midi_chan_t        midiChannel; ///< Don't access directly, read GetMidiInputChannel() instead !              midi_chan_t        midiChannel; ///< Don't access directly, read GetMidiInputChannel() instead !
203                ListenerList<EngineChangeListener*> llEngineChangeListeners;
204      };      };
205    
206      /** @brief LinuxSampler main class      /** @brief LinuxSampler main class
# Line 178  namespace LinuxSampler { Line 212  namespace LinuxSampler {
212       * engine, connected to an arbitrary MIDI input device and connected to       * engine, connected to an arbitrary MIDI input device and connected to
213       * an arbitrary audio output device. Here an example setup:       * an arbitrary audio output device. Here an example setup:
214       * @code       * @code
215       * S.Channel.       MIDI in         S.Engine                Audio out       * S.Channel    MIDI in    S.Engine         Audio out
216       * -------------------------------------------------------------------       * -------------------------------------------------------------------
217       * 0                Alsa    ->      gig::Engine     ->      Jack       *   0          Alsa   ->  gig::Engine  ->  Jack
218       * 1                VSTi    ->      Akai::Engine    ->      VSTi       *   1          VSTi   ->  Akai::Engine ->  VSTi
219       * 2                Jack    ->      DLS::Engine     ->      Jack       *   2          Jack   ->  DLS::Engine  ->  Jack
220       * 3                Jack    ->      SF::Engine      ->      Alsa       *   3          Jack   ->  SF::Engine   ->  Alsa
221       *       *
222       * ... (and so on) ...       * ... (and so on) ...
223       * @endcode       * @endcode
224       *       *
225       * Note that not all audio and MIDI backends and sampler engines listed       * Note that not all audio and MIDI backends and sampler engines listed
226       * in the example above are already implemented!       * in the example above might already been implemented!
227       *       *
228       * 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
229       * several, different audio output and MIDI input systems       * several, different audio output and MIDI input systems
230       * simultaniously at the same time. Here the example setup shown in the       * simultaniously at the same time. Here the example setup shown in the
231       * ascpect of MIDI input and audio output devices / drivers:       * aspect of MIDI input and audio output devices / drivers:
232       * @code       * @code
233       *                    ######################### #########################       *                      ######################### #########################
234       *                    # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #       *                      # AudioOutputDeviceJack # # AudioOutputDeviceVSTi #
235       *                    ######################### #########################       *                      ######################### #########################
236       *                                   ^   ^           ^       *                                        ^   ^           ^
237       *   /------------>|Sampler Channel 0|-----/   |             |       *  /------------>|Sampler Channel 0|-----/   |           |
238       *   |  /--------->|Sampler Channel 1|---------------------/       *  |  /--------->|Sampler Channel 1|---------------------/
239       *   |  |    /------>|Sampler Channel 2|---------/       *  |  |  /------>|Sampler Channel 2|---------/
240       *   |  |    |  /--->|Sampler Channel 3|------------>#########################       *  |  |  |  /--->|Sampler Channel 3|------------>#########################
241       *   |  |    |  |    ... (and so on) ...             # AudioOutputDeviceAlsa #       *  |  |  |  |    ... (and so on) ...             # AudioOutputDeviceAlsa #
242       *   |  |    |  |                                    #########################       *  |  |  |  |                                    #########################
243       *   |  |    |  \-----------------------------------------------------\       *  |  |  |  \-----------------------------------------------------\
244       *   |  |    \--------------------------------------------\           |       *  |  |  \--------------------------------------------\           |
245       *   |  \--------------------\                            |           |       *  |  \--------------------\                          |           |
246       *   |                         |                          |           |       *  |                       |                          |           |
247       * ####################### ####################### #######################       * ####################### ####################### #######################
248       * # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #       * # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack #
249       * ####################### ####################### #######################       * ####################### ####################### #######################
# Line 218  namespace LinuxSampler { Line 252  namespace LinuxSampler {
252       * 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
253       * driver / audio output driver) can be connected multiple times to       * driver / audio output driver) can be connected multiple times to
254       * different sampler channels.       * different sampler channels.
255         *
256         * It's even possible to create multiple instances of the same driver, for
257         * example multiple instances of the Alsa output driver to use multiple
258         * sound cards at the same time, or multiple instances of the JACK audio
259         * output driver to leverage SMP systems or boxes with several hard discs.
260       */       */
261      class Sampler {      class Sampler {
262          public:          public:
# Line 278  namespace LinuxSampler { Line 317  namespace LinuxSampler {
317              void RemoveSamplerChannel(uint uiSamplerChannel);              void RemoveSamplerChannel(uint uiSamplerChannel);
318    
319              /**              /**
320                 * Registers the specified listener to be notified
321                 * when the number of sampler chanels is changed.
322                 */
323                void AddChannelCountListener(ChannelCountListener* l);
324    
325                /**
326                 * Removes the specified listener.
327                 */
328                void RemoveChannelCountListener(ChannelCountListener* l);
329    
330                /**
331                 * Registers the specified listener to be notified
332                 * when the number of audio output devices is changed.
333                 */
334                void AddAudioDeviceCountListener(AudioDeviceCountListener* l);
335    
336                /**
337                 * Removes the specified listener.
338                 */
339                void RemoveAudioDeviceCountListener(AudioDeviceCountListener* l);
340    
341                
342                /**
343                 * Registers the specified listener to be notified
344                 * when the number of MIDI input devices is changed.
345                 */
346                void AddMidiDeviceCountListener(MidiDeviceCountListener* l);
347    
348                /**
349                 * Removes the specified listener.
350                 */
351                void RemoveMidiDeviceCountListener(MidiDeviceCountListener* l);
352    
353                /**
354                 * Registers the specified listener to be notified when the number
355                 * of active voices in a particular sampler channel is changed.
356                 */
357                void AddVoiceCountListener(VoiceCountListener* l);
358    
359                /**
360                 * Removes the specified listener.
361                 */
362                void RemoveVoiceCountListener(VoiceCountListener* l);
363    
364                /**
365                 * Notifies listeners that the number of active voices
366                 * on the specified sampler channel is changed.
367                 * @param ChannelId The numerical ID of the sampler channel.
368                 * @param NewCount The new number of active voices.
369                 */
370                void fireVoiceCountChanged(int ChannelId, int NewCount);
371    
372                /**
373                 * Registers the specified listener to be notified when the number
374                 * of active disk streams in a particular sampler channel is changed.
375                 */
376                void AddStreamCountListener(StreamCountListener* l);
377    
378                /**
379                 * Removes the specified listener.
380                 */
381                void RemoveStreamCountListener(StreamCountListener* l);
382    
383                /**
384                 * Notifies listeners that the number of active disk streams
385                 * on the specified sampler channel is changed.
386                 * @param ChannelId The numerical ID of the sampler channel.
387                 * @param NewCount The new number of active disk streams.
388                 */
389                void fireStreamCountChanged(int ChannelId, int NewCount);
390    
391                /**
392                 * Registers the specified listener to be
393                 * notified when the fill state of the disk stream
394                 * buffers on a specific sampler channel is changed.
395                 */
396                void AddBufferFillListener(BufferFillListener* l);
397    
398                /**
399                 * Removes the specified listener.
400                 */
401                void RemoveBufferFillListener(BufferFillListener* l);
402    
403                /**
404                 * Notifies listeners that the fill state of the disk stream
405                 * buffers on the specified sampler channel is changed.
406                 * @param ChannelId The numerical ID of the sampler channel.
407                 * @param FillData The buffer fill data for the specified sampler channel.
408                 */
409                void fireBufferFillChanged(int ChannelId, String FillData);
410    
411                /**
412                 * Registers the specified listener to be notified
413                 * when total number of active voices is changed.
414                 */
415                void AddTotalVoiceCountListener(TotalVoiceCountListener* l);
416    
417                /**
418                 * Removes the specified listener.
419                 */
420                void RemoveTotalVoiceCountListener(TotalVoiceCountListener* l);
421    
422                /**
423                 * Notifies listeners that the total number of active voices is changed.
424                 * @param NewCount The new number of active voices.
425                 */
426                void fireTotalVoiceCountChanged(int NewCount);
427                
428                void AddTotalStreamCountListener(TotalStreamCountListener* l);
429                void RemoveTotalStreamCountListener(TotalStreamCountListener* l);
430                void fireTotalStreamCountChanged(int NewCount);
431    
432                /**
433                 * Registers the specified listener to be notified when the number
434                 * of effect sends on a particular sampler channel is changed.
435                 */
436                void AddFxSendCountListener(FxSendCountListener* l);
437    
438                /**
439                 * Removes the specified listener.
440                 */
441                void RemoveFxSendCountListener(FxSendCountListener* l);
442    
443                /**
444               * Returns the names of all available audio output drivers.               * Returns the names of all available audio output drivers.
445               */               */
446              std::vector<String> AvailableAudioOutputDrivers();              std::vector<String> AvailableAudioOutputDrivers();
447    
448              /**              /**
449                 * Returns the names of all available MIDI input drivers.
450                 */
451                std::vector<String> AvailableMidiInputDrivers();
452    
453                /**
454                 * Returns the names of all available sampler engine types.
455                 * @see SamplerChannel::SetEngineType()
456                 */
457                std::vector<String> AvailableEngineTypes();
458    
459                /**
460               * Create an audio output device.               * Create an audio output device.
461               *               *
462               * @param AudioDriver - name of the audio driver               * @param AudioDriver - name of the audio driver
463               * @param Parameters - eventually needed driver parameters to               * @param Parameters - eventually needed driver parameters to
464               *                     create the device               *                     create the device
465               * @returns  pointer to created audio output device               * @returns  pointer to created audio output device
466               * @throws LinuxSamplerException  if device could not be created               * @throws Exception  if device could not be created
467               */               */
468              AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);              AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map<String,String> Parameters) throw (Exception);
469    
470              /**              /**
471               * Create a midi input device.               * Create a midi input device.
# Line 300  namespace LinuxSampler { Line 474  namespace LinuxSampler {
474               * @param Parameters - eventually needed driver parameters to               * @param Parameters - eventually needed driver parameters to
475               *                     create the device               *                     create the device
476               * @returns  pointer to created midi input device               * @returns  pointer to created midi input device
477               * @throws LinuxSamplerException  if device could not be created               * @throws Exception  if device could not be created
478               */               */
479              MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (LinuxSamplerException);              MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map<String,String> Parameters) throw (Exception);
480    
481              /**              /**
482               * Returns the number of all created audio output devices.               * Returns the number of all created audio output devices.
# Line 328  namespace LinuxSampler { Line 502  namespace LinuxSampler {
502               * Destroy the given audio output device and takes care if there               * Destroy the given audio output device and takes care if there
503               * are still sampler angines connected to this device, etc.               * are still sampler angines connected to this device, etc.
504               *               *
505               * @throws LinuxSamplerException  if sampler channels are still               * @throws Exception  if sampler channels are still
506               *                                connected to the device               *                    connected to the device
507               */               */
508              void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (LinuxSamplerException);              void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (Exception);
509    
510              /**              /**
511               * Destroy the given MIDI input device and takes care if there               * Destroy the given MIDI input device and takes care if there
512               * are still sampler angines connected to this device, etc.               * are still sampler angines connected to this device, etc.
513               *               *
514               * @throws LinuxSamplerException  if sampler channels are still               * @throws Exception  if sampler channels are still
515               *                                connected to the device               *                    connected to the device
516                 */
517                void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (Exception);
518    
519                 /**
520                 * Gets the current number of all active streams.
521                 * @returns The current number of all active streams.
522               */               */
523              void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (LinuxSamplerException);              int GetDiskStreamCount();
524    
525                /**
526                 * Gets the current number of all active voices.
527                 * @returns The current number of all active voices.
528                 */
529                int GetVoiceCount();
530    
531              /**              /**
532               * Reset the whole sampler. Destroy all engines, sampler               * Reset the whole sampler. Destroy all engines, sampler
# Line 348  namespace LinuxSampler { Line 534  namespace LinuxSampler {
534               */               */
535              void Reset();              void Reset();
536    
537                /**
538                 * Advise the FPU to treat denormal floating point numbers as
539                 * zero, to avoid severe performance penalty when dealing with
540                 * such extreme floating point values.
541                 *
542                 * @returns @c true if FPU supports it, @c false otherwise
543                 */
544                static bool EnableDenormalsAreZeroMode();
545    
546          protected:          protected:
547                /**
548                 * Notifies listeners that the number of sampler channels has been changed.
549                 * @param NewCount The new number of sampler channels.
550                 */
551                void fireChannelCountChanged(int NewCount);
552    
553                /**
554                 * Notifies listeners that the specified sampler channel has just
555                 * been added.
556                 * @param pChannel The new sampler channel.
557                 */
558                void fireChannelAdded(SamplerChannel* pChannel);
559    
560                /**
561                 * Notifies listeners that the specified sampler channel is
562                 * going to be removed soon.
563                 * @param pChannel sampler channel to be removed.
564                 */
565                void fireChannelToBeRemoved(SamplerChannel* pChannel);
566    
567                /**
568                 * Notifies listeners that the number of audio output devices has been changed.
569                 * @param NewCount The new number of audio output devices.
570                 */
571                void fireAudioDeviceCountChanged(int NewCount);
572    
573                /**
574                 * Notifies listeners that the number of MIDI input devices has been changed.
575                 * @param NewCount The new number of MIDI input devices.
576                 */
577                void fireMidiDeviceCountChanged(int NewCount);
578    
579                /**
580                 * Notifies listeners that the supplied MIDI input device is
581                 * going to be destroyed soon.
582                 * @param pDevice MIDI input device to be destroyed
583                 */
584                void fireMidiDeviceToBeDestroyed(MidiInputDevice* pDevice);
585    
586                /**
587                 * Notifies listeners that the supplied MIDI input device was
588                 * just created.
589                 * @param pDevice new MIDI input device
590                 */
591                void fireMidiDeviceCreated(MidiInputDevice* pDevice);
592    
593                /**
594                 * Notifies listeners that the number of effect sends
595                 * on a particular sampler channel is changed.
596                 * @param ChannelId The numerical ID of the sampler channel.
597                 * @param NewCount The new number of sampler channels.
598                 */
599                void fireFxSendCountChanged(int ChannelId, int NewCount);
600    
601              typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;              typedef std::map<uint, AudioOutputDevice*> AudioOutputDeviceMap;
602              typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;              typedef std::map<uint, MidiInputDevice*> MidiInputDeviceMap;
603              typedef std::map<uint, SamplerChannel*> SamplerChannelMap;              typedef std::map<uint, SamplerChannel*> SamplerChannelMap;
# Line 358  namespace LinuxSampler { Line 607  namespace LinuxSampler {
607              MidiInputDeviceMap    mMidiInputDevices;   ///< contains all created MIDI input devices              MidiInputDeviceMap    mMidiInputDevices;   ///< contains all created MIDI input devices
608    
609              friend class SamplerChannel;              friend class SamplerChannel;
610    
611            private:
612                ListenerList<ChannelCountListener*> llChannelCountListeners;
613                ListenerList<AudioDeviceCountListener*> llAudioDeviceCountListeners;
614                ListenerList<MidiDeviceCountListener*> llMidiDeviceCountListeners;
615                ListenerList<VoiceCountListener*> llVoiceCountListeners;
616                ListenerList<StreamCountListener*> llStreamCountListeners;
617                ListenerList<BufferFillListener*> llBufferFillListeners;
618                ListenerList<TotalStreamCountListener*> llTotalStreamCountListeners;
619                ListenerList<TotalVoiceCountListener*> llTotalVoiceCountListeners;
620                ListenerList<FxSendCountListener*> llFxSendCountListeners;
621    
622                class EventHandler : public EngineChangeListener, public FxSendCountListener {
623                    public:
624                        void SetSampler(Sampler* pSampler) { this->pSampler = pSampler; }
625    
626                        /**
627                         * Invoked when the engine type of the specified sampler
628                         * channel is going to be changed soon.
629                         * @param ChannelId The numerical ID of the sampler channel
630                         */
631                        virtual void EngineToBeChanged(int ChannelId);
632    
633                        /**
634                         * Invoked when the engine type of the
635                         * specified sampler channel is changed.
636                         * @param ChannelId The numerical ID of the sampler
637                         * channel, which engine type has been changed.
638                         */
639                        virtual void EngineChanged(int ChannelId);
640    
641                        /**
642                         * Invoked when the number of effect sends
643                         * on the specified sampler channel has changed.
644                         * @param ChannelId The numerical ID of the sampler channel.
645                         * @param NewCount The new number of effect sends.
646                         */
647                        virtual void FxSendCountChanged(int ChannelId, int NewCount);
648    
649                    private:
650                        Sampler* pSampler;
651                } eventHandler;
652      };      };
653  }  }
654    
Legend:
Removed from v.675  
changed lines
  Added in v.1761
  ViewVC Help
Powered by ViewVC