--- linuxsampler/trunk/src/Sampler.h 2004/08/20 17:25:19 221 +++ linuxsampler/trunk/src/Sampler.h 2009/07/12 10:35:55 1934 @@ -3,6 +3,7 @@ * LinuxSampler - modular, streaming capable sampler * * * * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * + * Copyright (C) 2005 - 2009 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 * @@ -25,9 +26,10 @@ #include #include +#include "EventListeners.h" #include "common/global.h" -#include "common/LinuxSamplerException.h" -#include "engines/common/Engine.h" +#include "common/Exception.h" +#include "engines/EngineChannel.h" #include "drivers/midi/MidiInputDevice.h" #include "drivers/audio/AudioOutputDevice.h" @@ -36,25 +38,24 @@ // just symbol prototyping class Sampler; - /** LinuxSampler sampler channel + /** @brief LinuxSampler sampler channel * - * Encapsulates one sampler engine, one connection to a MIDI input - * device and one connection to an audio output device. You cannot - * create an instance of this class on your own, you have to use the - * AddSamplerChannel() method of the Sampler object to create a new - * sampler channel. + * 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: /** - * Deploy a sampler engine of the given type for this sampler - * channnel. If there was already a sampler engine deployed on - * this sampler channel, then the old engine will automatically - * be destroyed. + * Assign a sampler engine type to this sampler channel. * - * @param EngineType - type of the engine to deploy + * @param EngineType - type of the engine to use + * @throws Exception - if \a EngineType is invalid + * @see Sampler::AvailableEngineTypes() */ - void LoadEngine(Engine::type_t EngineType); // TODO: to be changed to 'void LoadEngine(String EngineType) throws (LinuxSamplerException);' + void SetEngineType(String EngineType) throw (Exception); /** * Connect this sampler channel to an audio output device, that @@ -67,25 +68,28 @@ void SetAudioOutputDevice(AudioOutputDevice* pDevice); /** - * Connect this sampler channel to and MIDI input device. + * 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 and MIDI input port. + * Connect this sampler channel to a MIDI input port. * * @param MidiPort - MIDI port to connect to */ void SetMidiInputPort(int MidiPort); /** - * Connect this sampler channel to and MIDI input channel. + * 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 connect to + * @param MidiChannel - MIDI channel to listen */ - void SetMidiInputChannel(MidiInputPort::midi_chan_t MidiChannel); + void SetMidiInputChannel(midi_chan_t MidiChannel); /** * Connect this sampler channel to a MIDI input triplet. @@ -96,14 +100,15 @@ * sampler channel should listen to * (default: listen on all MIDI channels) */ - 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); /** - * Returns the engine that was deployed on this sampler channel. + * 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 */ - Engine* GetEngine(); + EngineChannel* GetEngineChannel(); /** * Returns the MIDI input channel to which this sampler @@ -112,7 +117,7 @@ * @returns The MIDI input channel on which the sampler * channel is listening to. */ - MidiInputPort::midi_chan_t GetMidiInputChannel(); + midi_chan_t GetMidiInputChannel(); /** * Returns the MIDI input port number to which this sampler @@ -146,25 +151,62 @@ */ uint Index(); + /** Returns the sampler to which this channel belongs */ + Sampler* GetSampler(); + + /////////////////////////////////////////////////////////////// + // Event Listener methods + + /** + * Registers the specified listener to be notified + * when the engine type of this sampler channel is changed. + */ + void AddEngineChangeListener(EngineChangeListener* l); + + /** + * Removes the specified listener. + */ + void RemoveEngineChangeListener(EngineChangeListener* l); + + /** + * Removes the specified listener. + */ + void RemoveAllEngineChangeListeners(); + + /** + * Notifies listeners that the engine type of this sampler + * channel is going to be changed soon. + */ + void fireEngineToBeChanged(); + + /** + * Notifies listeners that the engine + * type of this sampler channel is changed. + */ + void fireEngineChanged(); + + protected: SamplerChannel(Sampler* pS); - ~SamplerChannel(); + virtual ~SamplerChannel(); /** Getting MIDI input device port given its index number. */ - MidiInputPort* GetMidiInputDevicePort(int iMidiPort); + MidiInputPort* __GetMidiInputDevicePort(int iMidiPort); Sampler* pSampler; - Engine* pEngine; + EngineChannel* pEngineChannel; AudioOutputDevice* pAudioOutputDevice; MidiInputDevice* pMidiInputDevice; - int midiPort; - MidiInputPort::midi_chan_t midiChannel; 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 ! + ListenerList llEngineChangeListeners; }; - /** LinuxSampler main class + /** @brief LinuxSampler main class * * This is the toplevel class for a LinuxSampler instance. * @@ -172,45 +214,52 @@ * 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 * - * 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) ... + * ... (and so on) ... + * @endcode * * Note that not all audio and MIDI backends and sampler engines listed - * in the example above are already implemented! + * 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 - * ascpect of MIDI input and audio output devices / drivers: - * - * ######################### ######################### - * # AudioOutputDeviceJack # # AudioOutputDeviceVSTi # - * ######################### ######################### - * ^ ^ ^ - * /------------>|Sampler Channel 0|-----/ | | - * | /--------->|Sampler Channel 1|---------------------/ - * | | /---->|Sampler Channel 2|---------/ - * | | | /->|Sampler Channel 3|------------>######################### - * | | | | ... (and so on) ... # AudioOutputDeviceAlsa # - * | | | | ######################### - * | | | \----------------------------------------------------\ - * | | \-------------------------------------------\ | - * | \--------------------\ | | - * | | | | - * ####################### ####################### ####################### - * # MidiInputDeviceAlsa # # MidiInputDeviceVSTi # # MidiInputDeviceJack # - * ####################### ####################### ####################### + * 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: @@ -222,7 +271,7 @@ /** * Destructor. */ - ~Sampler(); + virtual ~Sampler(); /** * Returns the number of sampler channels currently allocated. @@ -271,20 +320,37 @@ void RemoveSamplerChannel(uint uiSamplerChannel); /** + * Destroy and remove all sampler channels from this + * Sampler instance. + */ + void RemoveAllSamplerChannels(); + + /** * Returns the names of all available audio output drivers. */ std::vector AvailableAudioOutputDrivers(); /** + * Returns the names of all available MIDI input drivers. + */ + std::vector AvailableMidiInputDrivers(); + + /** + * Returns the names of all available sampler engine types. + * @see SamplerChannel::SetEngineType() + */ + std::vector 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 LinuxSamplerException if device could not be created + * @throws Exception if device could not be created */ - AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map Parameters) throw (LinuxSamplerException); + AudioOutputDevice* CreateAudioOutputDevice(String AudioDriver, std::map Parameters) throw (Exception); /** * Create a midi input device. @@ -293,9 +359,9 @@ * @param Parameters - eventually needed driver parameters to * create the device * @returns pointer to created midi input device - * @throws LinuxSamplerException if device could not be created + * @throws Exception if device could not be created */ - MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map Parameters) throw (LinuxSamplerException); + MidiInputDevice* CreateMidiInputDevice(String MidiDriver, std::map Parameters) throw (Exception); /** * Returns the number of all created audio output devices. @@ -319,21 +385,59 @@ /** * Destroy the given audio output device and takes care if there - * are still sampler angines connected to this device, etc. + * are still sampler engines connected to this device, etc. * - * @throws LinuxSamplerException if sampler channels are still - * connected to the device + * @throws Exception if sampler channels are still + * connected to the device */ - void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (LinuxSamplerException); + void DestroyAudioOutputDevice(AudioOutputDevice* pDevice) throw (Exception); + + /** + * Destroy all audio output devices and takes care if there + * are still sampler engines connected to devices, etc. + * + * Note: non-autonomous devices, that is devices associated with + * host plugin instances like VST, AU, DSSI, LV2 are not + * destroyed by this method. + * + * @throws Exception if sampler channels are still + * connected to device + */ + void DestroyAllAudioOutputDevices() throw (Exception); /** * Destroy the given MIDI input device and takes care if there - * are still sampler angines connected to this device, etc. + * are still sampler engines connected to this device, etc. + * + * @throws Exception if sampler channels are still + * connected to the device + */ + void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (Exception); + + /** + * Destroy all MIDI input devices and take care if there + * are still sampler engines connected to device, etc. + * + * Note: non-autonomous devices, that is devices associated with + * host plugin instances like VST, AU, DSSI, LV2 are not + * destroyed by this method. * - * @throws LinuxSamplerException if sampler channels are still - * connected to the device + * @throws Exception if sampler channels are still + * connected to device + */ + void DestroyAllMidiInputDevices() throw (Exception); + + /** + * Gets the current number of all active streams. + * @returns The current number of all active streams. */ - void DestroyMidiInputDevice(MidiInputDevice* pDevice) throw (LinuxSamplerException); + int GetDiskStreamCount(); + + /** + * 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 @@ -341,16 +445,280 @@ */ void Reset(); + /////////////////////////////////////////////////////////////// + // Event Listener methods + + /** + * Registers the specified listener to be notified + * when the number of sampler chanels is changed. + */ + void AddChannelCountListener(ChannelCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveChannelCountListener(ChannelCountListener* l); + + /** + * Registers the specified listener to be notified + * when the number of audio output devices is changed. + */ + void AddAudioDeviceCountListener(AudioDeviceCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveAudioDeviceCountListener(AudioDeviceCountListener* l); + + /** + * Registers the specified listener to be notified + * when the number of MIDI input devices is changed. + */ + void AddMidiDeviceCountListener(MidiDeviceCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveMidiDeviceCountListener(MidiDeviceCountListener* l); + + /** + * Registers the specified listener to be notified when the number + * of active voices in a particular sampler channel is changed. + */ + void AddVoiceCountListener(VoiceCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveVoiceCountListener(VoiceCountListener* l); + + /** + * Notifies listeners that the number of active voices + * on the specified sampler channel is changed. + * @param ChannelId The numerical ID of the sampler channel. + * @param NewCount The new number of active voices. + */ + void fireVoiceCountChanged(int ChannelId, int NewCount); + + /** + * Registers the specified listener to be notified when the number + * of active disk streams in a particular sampler channel is changed. + */ + void AddStreamCountListener(StreamCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveStreamCountListener(StreamCountListener* l); + + /** + * Notifies listeners that the number of active disk streams + * on the specified sampler channel is changed. + * @param ChannelId The numerical ID of the sampler channel. + * @param NewCount The new number of active disk streams. + */ + void fireStreamCountChanged(int ChannelId, int NewCount); + + /** + * Registers the specified listener to be + * notified when the fill state of the disk stream + * buffers on a specific sampler channel is changed. + */ + void AddBufferFillListener(BufferFillListener* l); + + /** + * Removes the specified listener. + */ + void RemoveBufferFillListener(BufferFillListener* l); + + /** + * Notifies listeners that the fill state of the disk stream + * buffers on the specified sampler channel is changed. + * @param ChannelId The numerical ID of the sampler channel. + * @param FillData The buffer fill data for the specified sampler channel. + */ + void fireBufferFillChanged(int ChannelId, String FillData); + + /** + * Registers the specified listener to be notified + * when total number of active voices is changed. + */ + void AddTotalVoiceCountListener(TotalVoiceCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveTotalVoiceCountListener(TotalVoiceCountListener* l); + + /** + * Notifies listeners that the total number of active voices is changed. + * @param NewCount The new number of active voices. + */ + void fireTotalVoiceCountChanged(int NewCount); + + /** + * Registers the specified listener to be notified when the number + * of total streams is changed. + */ + void AddTotalStreamCountListener(TotalStreamCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveTotalStreamCountListener(TotalStreamCountListener* l); + + /** + * Notifies listeners that the total number of total streams changed. + * @param NewCount The new number of total streams. + */ + void fireTotalStreamCountChanged(int NewCount); + + /** + * Registers the specified listener to be notified when the number + * of effect sends on a particular sampler channel is changed. + */ + void AddFxSendCountListener(FxSendCountListener* l); + + /** + * Removes the specified listener. + */ + void RemoveFxSendCountListener(FxSendCountListener* l); + + /** + * Notifies listeners about the current number of voices, + * streams and total voices, and the current fill state of + * the disk stream buffers. + */ + void fireStatistics(); + + /////////////////////////////////////////////////////////////// + // system specific methods + + /** + * Advise the FPU to treat denormal floating point numbers as + * zero, to avoid severe performance penalty when dealing with + * such extreme floating point values. + * + * @returns @c true if FPU supports it, @c false otherwise + */ + static bool EnableDenormalsAreZeroMode(); + +#if defined(WIN32) + /** + * Gets the directory where the liblinuxsampler dll is located. + * Note: this method is currently only available for Windows. + * @returns installation directory + */ + static String GetInstallDir(); +#endif protected: - typedef std::map AudioOutputDeviceMap; - typedef std::map MidiInputDeviceMap; + /** + * Notifies listeners that the number of sampler channels has been changed. + * @param NewCount The new number of sampler channels. + */ + void fireChannelCountChanged(int NewCount); + + /** + * Notifies listeners that the specified sampler channel has just + * been added. + * @param pChannel The new sampler channel. + */ + void fireChannelAdded(SamplerChannel* pChannel); + + /** + * Notifies listeners that the specified sampler channel is + * going to be removed soon. + * @param pChannel sampler channel to be removed. + */ + void fireChannelToBeRemoved(SamplerChannel* pChannel); + + /** + * Notifies listeners that the number of audio output devices has been changed. + * @param NewCount The new number of audio output devices. + */ + void fireAudioDeviceCountChanged(int NewCount); + + /** + * Notifies listeners that the number of MIDI input devices has been changed. + * @param NewCount The new number of MIDI input devices. + */ + void fireMidiDeviceCountChanged(int NewCount); + + /** + * Notifies listeners that the supplied MIDI input device is + * going to be destroyed soon. + * @param pDevice MIDI input device to be destroyed + */ + void fireMidiDeviceToBeDestroyed(MidiInputDevice* pDevice); + + /** + * Notifies listeners that the supplied MIDI input device was + * just created. + * @param pDevice new MIDI input device + */ + void fireMidiDeviceCreated(MidiInputDevice* pDevice); + + /** + * Notifies listeners that the number of effect sends + * on a particular sampler channel is changed. + * @param ChannelId The numerical ID of the sampler channel. + * @param NewCount The new number of sampler channels. + */ + void fireFxSendCountChanged(int ChannelId, int NewCount); + typedef std::map SamplerChannelMap; - SamplerChannelMap mSamplerChannels; ///< contains all created sampler channels - AudioOutputDeviceMap mAudioOutputDevices; ///< contains all created audio output devices - MidiInputDeviceMap mMidiInputDevices; ///< contains all created MIDI input devices + SamplerChannelMap mSamplerChannels; ///< contains all created sampler channels + + // statistics cache + uint uiOldTotalVoiceCount; + uint uiOldTotalStreamCount; + std::map mOldVoiceCounts; + std::map mOldStreamCounts; friend class SamplerChannel; + + private: + ListenerList llChannelCountListeners; + ListenerList llAudioDeviceCountListeners; + ListenerList llMidiDeviceCountListeners; + ListenerList llVoiceCountListeners; + ListenerList llStreamCountListeners; + ListenerList llBufferFillListeners; + ListenerList llTotalStreamCountListeners; + ListenerList llTotalVoiceCountListeners; + ListenerList llFxSendCountListeners; + + class EventHandler : public EngineChangeListener, public FxSendCountListener { + public: + void SetSampler(Sampler* pSampler) { this->pSampler = pSampler; } + + /** + * Invoked when the engine type of the specified sampler + * channel is going to be changed soon. + * @param ChannelId The numerical ID of the sampler channel + */ + virtual void EngineToBeChanged(int ChannelId); + + /** + * Invoked when the engine type of the + * specified sampler channel is changed. + * @param ChannelId The numerical ID of the sampler + * channel, which engine type has been changed. + */ + virtual void EngineChanged(int ChannelId); + + /** + * Invoked when the number of effect sends + * on the specified sampler channel has changed. + * @param ChannelId The numerical ID of the sampler channel. + * @param NewCount The new number of effect sends. + */ + virtual void FxSendCountChanged(int ChannelId, int NewCount); + + private: + Sampler* pSampler; + } eventHandler; }; }