Chris@49: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@0: 
Chris@0: /*
Chris@52:     Sonic Visualiser
Chris@52:     An audio file viewer and annotation editor.
Chris@52:     Centre for Digital Music, Queen Mary, University of London.
Chris@0:     
Chris@52:     This program is free software; you can redistribute it and/or
Chris@52:     modify it under the terms of the GNU General Public License as
Chris@52:     published by the Free Software Foundation; either version 2 of the
Chris@52:     License, or (at your option) any later version.  See the file
Chris@52:     COPYING included with this distribution for more information.
Chris@0: */
Chris@0: 
Chris@0: /*
Chris@0:    This is a modified version of a source file from the 
Chris@0:    Rosegarden MIDI and audio sequencer and notation editor.
Chris@202:    This file copyright 2000-2006 Chris Cannam, Richard Bown, and QMUL.
Chris@0: */
Chris@0: 
Chris@0: #include <iostream>
Chris@0: #include <cassert>
Chris@0: 
Chris@0: #include "LADSPAPluginInstance.h"
Chris@0: #include "LADSPAPluginFactory.h"
Chris@0: 
Chris@166: #ifdef HAVE_LRDF
Chris@166: #include "lrdf.h"
Chris@166: #endif // HAVE_LRDF
Chris@166: 
Chris@117: //#define DEBUG_LADSPA 1
Chris@0: 
Chris@0: 
Chris@0: LADSPAPluginInstance::LADSPAPluginInstance(RealTimePluginFactory *factory,
Chris@0: 					   int clientId,
Chris@0: 					   QString identifier,
Chris@0:                                            int position,
Chris@0: 					   unsigned long sampleRate,
Chris@0: 					   size_t blockSize,
Chris@0: 					   int idealChannelCount,
Chris@0:                                            const LADSPA_Descriptor* descriptor) :
Chris@0:     RealTimePluginInstance(factory, identifier),
Chris@0:     m_client(clientId),
Chris@0:     m_position(position),
Chris@0:     m_instanceCount(0),
Chris@0:     m_descriptor(descriptor),
Chris@0:     m_blockSize(blockSize),
Chris@0:     m_sampleRate(sampleRate),
Chris@0:     m_latencyPort(0),
Chris@0:     m_run(false),
Chris@0:     m_bypassed(false)
Chris@0: {
Chris@0:     init(idealChannelCount);
Chris@0: 
Chris@176:     if (m_audioPortsIn.size() == 0) {
Chris@176:         m_inputBuffers = 0;
Chris@176:     } else {
Chris@176:         m_inputBuffers  = new sample_t*[m_instanceCount * m_audioPortsIn.size()];
Chris@176:     }
Chris@176: 
Chris@176:     if (m_audioPortsOut.size() == 0) {
Chris@176:         m_outputBuffers = 0;
Chris@176:     } else {
Chris@176:         m_outputBuffers = new sample_t*[m_instanceCount * m_audioPortsOut.size()];
Chris@176:     }
Chris@0: 
Chris@0:     for (size_t i = 0; i < m_instanceCount * m_audioPortsIn.size(); ++i) {
Chris@0: 	m_inputBuffers[i] = new sample_t[blockSize];
Chris@0:     }
Chris@0:     for (size_t i = 0; i < m_instanceCount * m_audioPortsOut.size(); ++i) {
Chris@0: 	m_outputBuffers[i] = new sample_t[blockSize];
Chris@0:     }
Chris@0: 
Chris@0:     m_ownBuffers = true;
Chris@0: 
Chris@0:     instantiate(sampleRate);
Chris@0:     if (isOK()) {
Chris@0: 	connectPorts();
Chris@0: 	activate();
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@51: std::string
Chris@51: LADSPAPluginInstance::getName() const
Chris@0: {
Chris@51:     return m_descriptor->Label;
Chris@0: }
Chris@0: 
Chris@51: std::string 
Chris@51: LADSPAPluginInstance::getDescription() const
Chris@51: {
Chris@51:     return m_descriptor->Name;
Chris@51: }
Chris@51: 
Chris@51: std::string
Chris@51: LADSPAPluginInstance::getMaker() const
Chris@51: {
Chris@51:     return m_descriptor->Maker;
Chris@51: }
Chris@51: 
Chris@51: int
Chris@51: LADSPAPluginInstance::getPluginVersion() const
Chris@51: {
Chris@51:     return 1;
Chris@51: }
Chris@51: 
Chris@51: std::string
Chris@51: LADSPAPluginInstance::getCopyright() const
Chris@51: {
Chris@51:     return m_descriptor->Copyright;
Chris@51: }
Chris@51: 
Chris@51: LADSPAPluginInstance::ParameterList
Chris@51: LADSPAPluginInstance::getParameterDescriptors() const
Chris@51: {
Chris@51:     ParameterList list;
Chris@51:     LADSPAPluginFactory *f = dynamic_cast<LADSPAPluginFactory *>(m_factory);
Chris@51:     
Chris@51:     for (unsigned int i = 0; i < m_controlPortsIn.size(); ++i) {
Chris@51:         
Chris@51:         ParameterDescriptor pd;
Chris@51:         unsigned int pn = m_controlPortsIn[i].first;
Chris@51: 
Chris@51:         pd.name = m_descriptor->PortNames[pn];
Chris@51:         pd.description = pd.name;
Chris@51:         pd.minValue = f->getPortMinimum(m_descriptor, pn);
Chris@51:         pd.maxValue = f->getPortMaximum(m_descriptor, pn);
Chris@51:         pd.defaultValue = f->getPortDefault(m_descriptor, pn);
Chris@57: 
Chris@57:         float q = f->getPortQuantization(m_descriptor, pn);
Chris@57:         if (q == 0.0) {
Chris@57:             pd.isQuantized = false;
Chris@57:         } else {
Chris@57:             pd.isQuantized = true;
Chris@57:             pd.quantizeStep = q;
Chris@57:         }
Chris@51: 
Chris@166:         bool haveLabels = false;
Chris@166: 
Chris@166: #ifdef HAVE_LRDF
Chris@166:         if (pd.isQuantized && pd.quantizeStep == 1.0) {
Chris@166: 
Chris@166:             lrdf_defaults *defaults =
Chris@166:                 lrdf_get_scale_values(m_descriptor->UniqueID, pn);
Chris@166: 
Chris@166:             if (defaults) {
Chris@166:                 if (defaults->count > 0) {
Chris@166:                     std::map<int, std::string> values;
Chris@166:                     int v = 0;
Chris@166:                     for (size_t i = 0; i < defaults->count; ++i) {
Chris@166:                         v = defaults->items[i].value;
Chris@166:                         values[v] = defaults->items[i].label;
Chris@166:                     }
Chris@166:                     for (size_t i = 0; i <= v; ++i) {
Chris@166:                         pd.valueNames.push_back(values[i]);
Chris@166:                     }
Chris@166:                     haveLabels = true;
Chris@166:                 }
Chris@166:                 lrdf_free_setting_values(defaults);
Chris@166:             }
Chris@166:         }
Chris@166: #endif
Chris@166: 
Chris@166:         if (haveLabels) {
Chris@166:             pd.description = QString(pd.description.c_str())
Chris@166:                 .replace(QRegExp("\\([^\\(\\)]+=[^\\(\\)]+\\)$"), "")
Chris@166:                 .toStdString();
Chris@166:         } else {
Chris@166:             static QRegExp unitRE("[\\[\\(]([A-Za-z0-9/]+)[\\)\\]]$");
Chris@166:             if (unitRE.indexIn(pd.name.c_str()) >= 0) {
Chris@166:                 pd.unit = unitRE.cap(1).toStdString();
Chris@166:                 pd.description = QString(pd.description.c_str())
Chris@166:                     .replace(unitRE, "").toStdString();
Chris@166:             }
Chris@166:         }
Chris@166: 
Chris@51:         list.push_back(pd);
Chris@51:     }
Chris@51: 
Chris@51:     return list;
Chris@51: }
Chris@51: 
Chris@51: float
Chris@51: LADSPAPluginInstance::getParameter(std::string name) const
Chris@51: {
Chris@51:     for (unsigned int i = 0; i < m_controlPortsIn.size(); ++i) {
Chris@51:         if (name == m_descriptor->PortNames[m_controlPortsIn[i].first]) {
Chris@51:             return getParameterValue(i);
Chris@51:         }
Chris@51:     }
Chris@51: 
Chris@51:     return 0.0;
Chris@51: }
Chris@51: 
Chris@51: void
Chris@51: LADSPAPluginInstance::setParameter(std::string name, float value)
Chris@51: {
Chris@51:     for (unsigned int i = 0; i < m_controlPortsIn.size(); ++i) {
Chris@51:         if (name == m_descriptor->PortNames[m_controlPortsIn[i].first]) {
Chris@51:             setParameterValue(i, value);
Chris@51:             break;
Chris@51:         }
Chris@51:     }
Chris@51: }    
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::init(int idealChannelCount)
Chris@0: {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0:     std::cerr << "LADSPAPluginInstance::init(" << idealChannelCount << "): plugin has "
Chris@0: 	      << m_descriptor->PortCount << " ports" << std::endl;
Chris@0: #endif
Chris@0: 
Chris@0:     // Discover ports numbers and identities
Chris@0:     //
Chris@0:     for (unsigned long i = 0; i < m_descriptor->PortCount; ++i)
Chris@0:     {
Chris@0:         if (LADSPA_IS_PORT_AUDIO(m_descriptor->PortDescriptors[i]))
Chris@0:         {
Chris@0:             if (LADSPA_IS_PORT_INPUT(m_descriptor->PortDescriptors[i])) {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0: 		std::cerr << "LADSPAPluginInstance::init: port " << i << " is audio in" << std::endl;
Chris@0: #endif
Chris@0:                 m_audioPortsIn.push_back(i);
Chris@0: 	    } else {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0: 		std::cerr << "LADSPAPluginInstance::init: port " << i << " is audio out" << std::endl;
Chris@0: #endif
Chris@0:                 m_audioPortsOut.push_back(i);
Chris@0: 	    }
Chris@0:         }
Chris@0:         else
Chris@0:         if (LADSPA_IS_PORT_CONTROL(m_descriptor->PortDescriptors[i]))
Chris@0:         {
Chris@0: 	    if (LADSPA_IS_PORT_INPUT(m_descriptor->PortDescriptors[i])) {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0: 		std::cerr << "LADSPAPluginInstance::init: port " << i << " is control in" << std::endl;
Chris@0: #endif
Chris@0: 		LADSPA_Data *data = new LADSPA_Data(0.0);
Chris@0: 		m_controlPortsIn.push_back(
Chris@0:                     std::pair<unsigned long, LADSPA_Data*>(i, data));
Chris@0: 	    } else {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0: 		std::cerr << "LADSPAPluginInstance::init: port " << i << " is control out" << std::endl;
Chris@0: #endif
Chris@0: 		LADSPA_Data *data = new LADSPA_Data(0.0);
Chris@0: 		m_controlPortsOut.push_back(
Chris@0:                     std::pair<unsigned long, LADSPA_Data*>(i, data));
Chris@0: 		if (!strcmp(m_descriptor->PortNames[i], "latency") ||
Chris@0: 		    !strcmp(m_descriptor->PortNames[i], "_latency")) {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0: 		    std::cerr << "Wooo! We have a latency port!" << std::endl;
Chris@0: #endif
Chris@0: 		    m_latencyPort = data;
Chris@0: 		}
Chris@0: 	    }
Chris@0:         }
Chris@0: #ifdef DEBUG_LADSPA
Chris@0:         else
Chris@0:             std::cerr << "LADSPAPluginInstance::init - "
Chris@0:                       << "unrecognised port type" << std::endl;
Chris@0: #endif
Chris@0:     }
Chris@0: 
Chris@0:     m_instanceCount = 1;
Chris@0: 
Chris@0:     if (idealChannelCount > 0) {
Chris@0: 	if (m_audioPortsIn.size() == 1) {
Chris@0: 	    // mono plugin: duplicate it if need be
Chris@0: 	    m_instanceCount = idealChannelCount;
Chris@0: 	}
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: size_t
Chris@0: LADSPAPluginInstance::getLatency()
Chris@0: {
Chris@0:     if (m_latencyPort) {
Chris@66: 	if (!m_run) run(Vamp::RealTime::zeroTime);
Chris@0: 	if (*m_latencyPort > 0) return (size_t)*m_latencyPort;
Chris@0:     }
Chris@0:     return 0;
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::silence()
Chris@0: {
Chris@0:     if (isOK()) {
Chris@0: 	deactivate();
Chris@0: 	activate();
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::setIdealChannelCount(size_t channels)
Chris@0: {
Chris@0:     if (m_audioPortsIn.size() != 1 || channels == m_instanceCount) {
Chris@0: 	silence();
Chris@0: 	return;
Chris@0:     }
Chris@0: 
Chris@0:     if (isOK()) {
Chris@0: 	deactivate();
Chris@0:     }
Chris@0: 
Chris@0:     //!!! don't we need to reallocate inputBuffers and outputBuffers?
Chris@0: 
Chris@0:     cleanup();
Chris@0:     m_instanceCount = channels;
Chris@0:     instantiate(m_sampleRate);
Chris@0:     if (isOK()) {
Chris@0: 	connectPorts();
Chris@0: 	activate();
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: 
Chris@0: LADSPAPluginInstance::~LADSPAPluginInstance()
Chris@0: {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0:     std::cerr << "LADSPAPluginInstance::~LADSPAPluginInstance" << std::endl;
Chris@0: #endif
Chris@0: 
Chris@0:     if (m_instanceHandles.size() != 0) { // "isOK()"
Chris@0: 	deactivate();
Chris@0:     }
Chris@0: 
Chris@0:     cleanup();
Chris@0: 
Chris@0:     for (unsigned int i = 0; i < m_controlPortsIn.size(); ++i)
Chris@0:         delete m_controlPortsIn[i].second;
Chris@0: 
Chris@0:     for (unsigned int i = 0; i < m_controlPortsOut.size(); ++i)
Chris@0:         delete m_controlPortsOut[i].second;
Chris@0: 
Chris@0:     m_controlPortsIn.clear();
Chris@0:     m_controlPortsOut.clear();
Chris@0: 
Chris@0:     if (m_ownBuffers) {
Chris@184: 	for (size_t i = 0; i < m_instanceCount * m_audioPortsIn.size(); ++i) {
Chris@0: 	    delete[] m_inputBuffers[i];
Chris@0: 	}
Chris@184: 	for (size_t i = 0; i < m_instanceCount * m_audioPortsOut.size(); ++i) {
Chris@0: 	    delete[] m_outputBuffers[i];
Chris@0: 	}
Chris@0: 
Chris@0: 	delete[] m_inputBuffers;
Chris@0: 	delete[] m_outputBuffers;
Chris@0:     }
Chris@0: 
Chris@0:     m_audioPortsIn.clear();
Chris@0:     m_audioPortsOut.clear();
Chris@0: }
Chris@0: 
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::instantiate(unsigned long sampleRate)
Chris@0: {
Chris@0: #ifdef DEBUG_LADSPA
Chris@0:     std::cout << "LADSPAPluginInstance::instantiate - plugin unique id = "
Chris@0:               << m_descriptor->UniqueID << std::endl;
Chris@0: #endif
Chris@0:     if (!m_descriptor) return;
Chris@0: 
Chris@0:     if (!m_descriptor->instantiate) {
Chris@0: 	std::cerr << "Bad plugin: plugin id " << m_descriptor->UniqueID
Chris@0: 		  << ":" << m_descriptor->Label
Chris@0: 		  << " has no instantiate method!" << std::endl;
Chris@0: 	return;
Chris@0:     }
Chris@0: 
Chris@0:     for (size_t i = 0; i < m_instanceCount; ++i) {
Chris@0: 	m_instanceHandles.push_back
Chris@0: 	    (m_descriptor->instantiate(m_descriptor, sampleRate));
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::activate()
Chris@0: {
Chris@0:     if (!m_descriptor || !m_descriptor->activate) return;
Chris@0: 
Chris@0:     for (std::vector<LADSPA_Handle>::iterator hi = m_instanceHandles.begin();
Chris@0: 	 hi != m_instanceHandles.end(); ++hi) {
Chris@0: 	m_descriptor->activate(*hi);
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::connectPorts()
Chris@0: {
Chris@0:     if (!m_descriptor || !m_descriptor->connect_port) return;
Chris@0: 
Chris@0:     assert(sizeof(LADSPA_Data) == sizeof(float));
Chris@0:     assert(sizeof(sample_t) == sizeof(float));
Chris@0: 
Chris@57:     LADSPAPluginFactory *f = dynamic_cast<LADSPAPluginFactory *>(m_factory);
Chris@0:     int inbuf = 0, outbuf = 0;
Chris@0: 
Chris@0:     for (std::vector<LADSPA_Handle>::iterator hi = m_instanceHandles.begin();
Chris@0: 	 hi != m_instanceHandles.end(); ++hi) {
Chris@0: 
Chris@0: 	for (unsigned int i = 0; i < m_audioPortsIn.size(); ++i) {
Chris@0: 	    m_descriptor->connect_port(*hi,
Chris@0: 				       m_audioPortsIn[i],
Chris@0: 				       (LADSPA_Data *)m_inputBuffers[inbuf]);
Chris@0: 	    ++inbuf;
Chris@0: 	}
Chris@0: 
Chris@0: 	for (unsigned int i = 0; i < m_audioPortsOut.size(); ++i) {
Chris@0: 	    m_descriptor->connect_port(*hi,
Chris@0: 				       m_audioPortsOut[i],
Chris@0: 				       (LADSPA_Data *)m_outputBuffers[outbuf]);
Chris@0: 	    ++outbuf;
Chris@0: 	}
Chris@0: 
Chris@0: 	// If there is more than one instance, they all share the same
Chris@0: 	// control port ins (and outs, for the moment, because we
Chris@0: 	// don't actually do anything with the outs anyway -- but they
Chris@0: 	// do have to be connected as the plugin can't know if they're
Chris@0: 	// not and will write to them anyway).
Chris@0: 
Chris@0: 	for (unsigned int i = 0; i < m_controlPortsIn.size(); ++i) {
Chris@0: 	    m_descriptor->connect_port(*hi,
Chris@0: 				       m_controlPortsIn[i].first,
Chris@0: 				       m_controlPortsIn[i].second);
Chris@57:             if (f) {
Chris@57:                 float defaultValue = f->getPortDefault
Chris@57:                     (m_descriptor, m_controlPortsIn[i].first);
Chris@57:                 *m_controlPortsIn[i].second = defaultValue;
Chris@57:             }
Chris@0: 	}
Chris@0: 
Chris@0: 	for (unsigned int i = 0; i < m_controlPortsOut.size(); ++i) {
Chris@0: 	    m_descriptor->connect_port(*hi,
Chris@0: 				       m_controlPortsOut[i].first,
Chris@0: 				       m_controlPortsOut[i].second);
Chris@0: 	}
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: unsigned int
Chris@0: LADSPAPluginInstance::getParameterCount() const
Chris@0: {
Chris@0:     return m_controlPortsIn.size();
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::setParameterValue(unsigned int parameter, float value)
Chris@0: {
Chris@0:     if (parameter >= m_controlPortsIn.size()) return;
Chris@0: 
Chris@0:     unsigned int portNumber = m_controlPortsIn[parameter].first;
Chris@0: 
Chris@0:     LADSPAPluginFactory *f = dynamic_cast<LADSPAPluginFactory *>(m_factory);
Chris@0:     if (f) {
Chris@0: 	if (value < f->getPortMinimum(m_descriptor, portNumber)) {
Chris@0: 	    value = f->getPortMinimum(m_descriptor, portNumber);
Chris@0: 	}
Chris@0: 	if (value > f->getPortMaximum(m_descriptor, portNumber)) {
Chris@0: 	    value = f->getPortMaximum(m_descriptor, portNumber);
Chris@0: 	}
Chris@0:     }
Chris@0: 
Chris@0:     (*m_controlPortsIn[parameter].second) = value;
Chris@0: }
Chris@0: 
Chris@0: float
Martin@62: LADSPAPluginInstance::getControlOutputValue(size_t output) const
Chris@60: {
Chris@60:     if (output > m_controlPortsOut.size()) return 0.0;
Chris@60:     return (*m_controlPortsOut[output].second);
Chris@60: }
Chris@60: 
Chris@60: float
Chris@0: LADSPAPluginInstance::getParameterValue(unsigned int parameter) const
Chris@0: {
Chris@0:     if (parameter >= m_controlPortsIn.size()) return 0.0;
Chris@0:     return (*m_controlPortsIn[parameter].second);
Chris@0: }
Chris@0: 
Chris@0: float
Chris@0: LADSPAPluginInstance::getParameterDefault(unsigned int parameter) const
Chris@0: {
Chris@0:     if (parameter >= m_controlPortsIn.size()) return 0.0;
Chris@0: 
Chris@0:     LADSPAPluginFactory *f = dynamic_cast<LADSPAPluginFactory *>(m_factory);
Chris@0:     if (f) {
Chris@0: 	return f->getPortDefault(m_descriptor, m_controlPortsIn[parameter].first);
Chris@0:     } else {
Chris@0: 	return 0.0f;
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: void
Chris@66: LADSPAPluginInstance::run(const Vamp::RealTime &)
Chris@0: {
Chris@0:     if (!m_descriptor || !m_descriptor->run) return;
Chris@0: 
Chris@0:     for (std::vector<LADSPA_Handle>::iterator hi = m_instanceHandles.begin();
Chris@0: 	 hi != m_instanceHandles.end(); ++hi) {
Chris@0:         m_descriptor->run(*hi, m_blockSize);
Chris@0:     }
Chris@0: 
Chris@0:     m_run = true;
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::deactivate()
Chris@0: {
Chris@0:     if (!m_descriptor || !m_descriptor->deactivate) return;
Chris@0: 
Chris@0:     for (std::vector<LADSPA_Handle>::iterator hi = m_instanceHandles.begin();
Chris@0: 	 hi != m_instanceHandles.end(); ++hi) {
Chris@0:         m_descriptor->deactivate(*hi);
Chris@0:     }
Chris@0: }
Chris@0: 
Chris@0: void
Chris@0: LADSPAPluginInstance::cleanup()
Chris@0: {
Chris@0:     if (!m_descriptor) return;
Chris@0: 
Chris@0:     if (!m_descriptor->cleanup) {
Chris@0: 	std::cerr << "Bad plugin: plugin id " << m_descriptor->UniqueID
Chris@0: 		  << ":" << m_descriptor->Label
Chris@0: 		  << " has no cleanup method!" << std::endl;
Chris@0: 	return;
Chris@0:     }
Chris@0: 
Chris@0:     for (std::vector<LADSPA_Handle>::iterator hi = m_instanceHandles.begin();
Chris@0: 	 hi != m_instanceHandles.end(); ++hi) {
Chris@0: 	m_descriptor->cleanup(*hi);
Chris@0:     }
Chris@0: 
Chris@0:     m_instanceHandles.clear();
Chris@0: }
Chris@0: 
Chris@0: