lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:    This is a modified version of a source file from the 
lbajardsilogic@0:    Rosegarden MIDI and audio sequencer and notation editor.
lbajardsilogic@0:    This file copyright 2000-2006 Chris Cannam.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _DSSIPLUGININSTANCE_H_
lbajardsilogic@0: #define _DSSIPLUGININSTANCE_H_
lbajardsilogic@0: 
lbajardsilogic@0: #define DSSI_API_LEVEL 2
lbajardsilogic@0: 
lbajardsilogic@0: #include <vector>
lbajardsilogic@0: #include <set>
lbajardsilogic@0: #include <map>
lbajardsilogic@0: #include <QString>
lbajardsilogic@0: #include <QMutex>
lbajardsilogic@0: 
lbajardsilogic@0: #include "api/dssi.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include "base/RingBuffer.h"
lbajardsilogic@0: #include "base/Thread.h"
lbajardsilogic@0: #include "RealTimePluginInstance.h"
lbajardsilogic@0: #include "base/Scavenger.h"
lbajardsilogic@0: 
lbajardsilogic@0: class DSSIPluginInstance : public RealTimePluginInstance
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     virtual ~DSSIPluginInstance();
lbajardsilogic@0: 
lbajardsilogic@0:     virtual bool isOK() const { return m_instanceHandle != 0; }
lbajardsilogic@0: 
lbajardsilogic@0:     int getClientId() const { return m_client; }
lbajardsilogic@0:     virtual QString getPluginIdentifier() const { return m_identifier; }
lbajardsilogic@0:     int getPosition() const { return m_position; }
lbajardsilogic@0: 
lbajardsilogic@0:     virtual std::string getIdentifier() const;
lbajardsilogic@0:     virtual std::string getName() const;
lbajardsilogic@0:     virtual std::string getDescription() const;
lbajardsilogic@0:     virtual std::string getMaker() const;
lbajardsilogic@0:     virtual int getPluginVersion() const;
lbajardsilogic@0:     virtual std::string getCopyright() const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual void run(const Vamp::RealTime &);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual unsigned int getParameterCount() const;
lbajardsilogic@0:     virtual void setParameterValue(unsigned int parameter, float value);
lbajardsilogic@0:     virtual float getParameterValue(unsigned int parameter) const;
lbajardsilogic@0:     virtual float getParameterDefault(unsigned int parameter) const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual ParameterList getParameterDescriptors() const;
lbajardsilogic@0:     virtual float getParameter(std::string) const;
lbajardsilogic@0:     virtual void setParameter(std::string, float);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual std::string configure(std::string key, std::string value);
lbajardsilogic@0:     virtual void sendEvent(const Vamp::RealTime &eventTime,
lbajardsilogic@0: 			   const void *event);
lbajardsilogic@0:     virtual void clearEvents();
lbajardsilogic@0: 
lbajardsilogic@0:     virtual size_t getBufferSize() const { return m_blockSize; }
lbajardsilogic@0:     virtual size_t getAudioInputCount() const { return m_audioPortsIn.size(); }
lbajardsilogic@0:     virtual size_t getAudioOutputCount() const { return m_idealChannelCount; }
lbajardsilogic@0:     virtual sample_t **getAudioInputBuffers() { return m_inputBuffers; }
lbajardsilogic@0:     virtual sample_t **getAudioOutputBuffers() { return m_outputBuffers; }
lbajardsilogic@0: 
lbajardsilogic@0:     virtual size_t getControlOutputCount() const { return m_controlPortsOut.size(); }
lbajardsilogic@0:     virtual float getControlOutputValue(size_t n) const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual ProgramList getPrograms() const;
lbajardsilogic@0:     virtual std::string getCurrentProgram() const;
lbajardsilogic@0:     virtual std::string getProgram(int bank, int program) const;
lbajardsilogic@0:     virtual unsigned long getProgram(std::string name) const;
lbajardsilogic@0:     virtual void selectProgram(std::string program);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual bool isBypassed() const { return m_bypassed; }
lbajardsilogic@0:     virtual void setBypassed(bool bypassed) { m_bypassed = bypassed; }
lbajardsilogic@0: 
lbajardsilogic@0:     virtual size_t getLatency();
lbajardsilogic@0: 
lbajardsilogic@0:     virtual void silence();
lbajardsilogic@0:     virtual void discardEvents();
lbajardsilogic@0:     virtual void setIdealChannelCount(size_t channels); // may re-instantiate
lbajardsilogic@0: 
lbajardsilogic@0:     virtual bool isInGroup() const { return m_grouped; }
lbajardsilogic@0:     virtual void detachFromGroup();
lbajardsilogic@0: 
lbajardsilogic@0:     virtual std::string getType() const { return "DSSI Real-Time Plugin"; }
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     // To be constructed only by DSSIPluginFactory
lbajardsilogic@0:     friend class DSSIPluginFactory;
lbajardsilogic@0: 
lbajardsilogic@0:     // Constructor that creates the buffers internally
lbajardsilogic@0:     // 
lbajardsilogic@0:     DSSIPluginInstance(RealTimePluginFactory *factory,
lbajardsilogic@0: 		       int client,
lbajardsilogic@0: 		       QString identifier,
lbajardsilogic@0: 		       int position,
lbajardsilogic@0: 		       unsigned long sampleRate,
lbajardsilogic@0: 		       size_t blockSize,
lbajardsilogic@0: 		       int idealChannelCount,
lbajardsilogic@0: 		       const DSSI_Descriptor* descriptor);
lbajardsilogic@0:     
lbajardsilogic@0:     void init();
lbajardsilogic@0:     void instantiate(unsigned long sampleRate);
lbajardsilogic@0:     void cleanup();
lbajardsilogic@0:     void activate();
lbajardsilogic@0:     void deactivate();
lbajardsilogic@0:     void connectPorts();
lbajardsilogic@0: 
lbajardsilogic@0:     bool handleController(snd_seq_event_t *ev);
lbajardsilogic@0:     void setPortValueFromController(unsigned int portNumber, int controlValue);
lbajardsilogic@0:     void selectProgramAux(std::string program, bool backupPortValues);
lbajardsilogic@0:     void checkProgramCache() const;
lbajardsilogic@0: 
lbajardsilogic@0:     void initialiseGroupMembership();
lbajardsilogic@0:     void runGrouped(const Vamp::RealTime &);
lbajardsilogic@0: 
lbajardsilogic@0:     // For use in DSSIPluginFactory (set in the DSSI_Host_Descriptor):
lbajardsilogic@0:     static int requestMidiSend(LADSPA_Handle instance,
lbajardsilogic@0: 			       unsigned char ports,
lbajardsilogic@0: 			       unsigned char channels);
lbajardsilogic@0:     static void midiSend(LADSPA_Handle instance,
lbajardsilogic@0: 			 snd_seq_event_t *events,
lbajardsilogic@0: 			 unsigned long eventCount);
lbajardsilogic@0:     static int requestNonRTThread(LADSPA_Handle instance,
lbajardsilogic@0: 				  void (*runFunction)(LADSPA_Handle));
lbajardsilogic@0: 
lbajardsilogic@0:     int                        m_client;
lbajardsilogic@0:     int                        m_position;
lbajardsilogic@0:     LADSPA_Handle              m_instanceHandle;
lbajardsilogic@0:     const DSSI_Descriptor     *m_descriptor;
lbajardsilogic@0: 
lbajardsilogic@0:     std::vector<std::pair<unsigned long, LADSPA_Data*> > m_controlPortsIn;
lbajardsilogic@0:     std::vector<std::pair<unsigned long, LADSPA_Data*> > m_controlPortsOut;
lbajardsilogic@0: 
lbajardsilogic@0:     std::vector<LADSPA_Data>  m_backupControlPortsIn;
lbajardsilogic@0: 
lbajardsilogic@0:     std::map<int, int>        m_controllerMap;
lbajardsilogic@0: 
lbajardsilogic@0:     std::vector<int>          m_audioPortsIn;
lbajardsilogic@0:     std::vector<int>          m_audioPortsOut;
lbajardsilogic@0: 
lbajardsilogic@0:     struct ProgramControl {
lbajardsilogic@0: 	int msb;
lbajardsilogic@0: 	int lsb;
lbajardsilogic@0: 	int program;
lbajardsilogic@0:     };
lbajardsilogic@0:     ProgramControl m_pending;
lbajardsilogic@0: 
lbajardsilogic@0:     struct ProgramDescriptor {
lbajardsilogic@0: 	int bank;
lbajardsilogic@0: 	int program;
lbajardsilogic@0: 	std::string name;
lbajardsilogic@0:     };
lbajardsilogic@0:     mutable std::vector<ProgramDescriptor> m_cachedPrograms;
lbajardsilogic@0:     mutable bool m_programCacheValid;
lbajardsilogic@0: 
lbajardsilogic@0:     RingBuffer<snd_seq_event_t> m_eventBuffer;
lbajardsilogic@0: 
lbajardsilogic@0:     size_t                    m_blockSize;
lbajardsilogic@0:     sample_t                **m_inputBuffers;
lbajardsilogic@0:     sample_t                **m_outputBuffers;
lbajardsilogic@0:     bool                      m_ownBuffers;
lbajardsilogic@0:     size_t                    m_idealChannelCount;
lbajardsilogic@0:     size_t                    m_outputBufferCount;
lbajardsilogic@0:     size_t                    m_sampleRate;
lbajardsilogic@0:     float                    *m_latencyPort;
lbajardsilogic@0:     bool                      m_run;
lbajardsilogic@0:     
lbajardsilogic@0:     bool                      m_bypassed;
lbajardsilogic@0:     std::string               m_program;
lbajardsilogic@0:     bool                      m_grouped;
lbajardsilogic@0:     Vamp::RealTime            m_lastRunTime;
lbajardsilogic@0: 
lbajardsilogic@0:     Vamp::RealTime            m_lastEventSendTime;
lbajardsilogic@0:     bool                      m_haveLastEventSendTime;
lbajardsilogic@0: 
lbajardsilogic@0:     QMutex                    m_processLock;
lbajardsilogic@0: 
lbajardsilogic@0:     typedef std::set<DSSIPluginInstance *> PluginSet;
lbajardsilogic@0:     typedef std::map<QString, PluginSet> GroupMap;
lbajardsilogic@0:     static GroupMap m_groupMap;
lbajardsilogic@0:     static snd_seq_event_t **m_groupLocalEventBuffers;
lbajardsilogic@0:     static size_t m_groupLocalEventBufferCount;
lbajardsilogic@0: 
lbajardsilogic@0:     static Scavenger<ScavengerArrayWrapper<snd_seq_event_t *> > m_bufferScavenger;
lbajardsilogic@0: 
lbajardsilogic@0:     class NonRTPluginThread : public Thread
lbajardsilogic@0:     {
lbajardsilogic@0:     public:
lbajardsilogic@0: 	NonRTPluginThread(LADSPA_Handle handle,
lbajardsilogic@0: 			  void (*runFunction)(LADSPA_Handle)) :
lbajardsilogic@0: 	    m_handle(handle),
lbajardsilogic@0: 	    m_runFunction(runFunction),
lbajardsilogic@0: 	    m_exiting(false) { }
lbajardsilogic@0: 
lbajardsilogic@0: 	virtual void run();
lbajardsilogic@0: 	void setExiting() { m_exiting = true; }
lbajardsilogic@0: 
lbajardsilogic@0:     protected:
lbajardsilogic@0: 	LADSPA_Handle m_handle;
lbajardsilogic@0: 	void (*m_runFunction)(LADSPA_Handle);
lbajardsilogic@0: 	bool m_exiting;
lbajardsilogic@0:     };
lbajardsilogic@0:     static std::map<LADSPA_Handle, std::set<NonRTPluginThread *> > m_threads;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif // _DSSIPLUGININSTANCE_H_
lbajardsilogic@0: