Reworked use of Plugin class in engine slightly (more RAII-ey)

git-svn-id: http://svn.drobilla.net/lad/grauph@56 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 263 insertions, 0 deletions

diff --git a/src/libs/engine/LV2Node.cpp b/src/libs/engine/LV2Node.cpp
new file mode 100644
index 00000000..34bbe61e
--- /dev/null
+++ b/src/libs/engine/LV2Node.cpp
@@ -0,0 +1,263 @@
+/* This file is part of Om.  Copyright (C) 2006 Dave Robillard.
+ * 
+ * Om is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ * 
+ * Om is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
+ * 
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#include "LV2Node.h"
+#include <iostream>
+#include <cassert>
+#include "float.h"
+#include <stdint.h>
+#include <cmath>
+#include "InputPort.h"
+#include "OutputPort.h"
+#include "Plugin.h"
+
+namespace Om {
+
+
+/** Partially construct a LV2Node.
+ *
+ * Object is not usable until instantiate() is called with success.
+ * (It _will_ crash!)
+ */
+LV2Node::LV2Node(const Plugin*      plugin,
+                 const string&      name,
+                 size_t             poly,
+                 Patch*             parent,
+                 samplerate         srate,
+                 size_t             buffer_size)
+: NodeBase(plugin, name, poly, parent, srate, buffer_size),
+  _lv2_plugin(plugin->slv2_plugin()),
+  _instances(NULL)
+{
+	assert(_lv2_plugin);
+}
+
+
+/** Instantiate self from LV2 plugin descriptor.
+ *
+ * Implemented as a seperate function (rather than in the constructor) to
+ * allow graceful error-catching of broken plugins.
+ * 
+ * Returns whether or not plugin was successfully instantiated.  If return
+ * value is false, this object may not be used.
+ */
+bool
+LV2Node::instantiate()
+{
+	size_t num_ports = slv2_plugin_get_num_ports(_lv2_plugin);
+	assert(num_ports > 0);
+	_ports->alloc(num_ports);
+	
+	_instances = new SLV2Instance*[_poly];
+	
+	size_t port_buffer_size = 0;
+	
+	for (size_t i=0; i < _poly; ++i) {
+		_instances[i] = slv2_plugin_instantiate(_lv2_plugin, _srate, NULL);
+		if (_instances[i] == NULL) {
+			cerr << "Failed to instantiate plugin!" << endl;
+			return false;
+		}
+	}
+	
+	string port_name;
+	string port_path;
+	
+	Port* port = NULL;
+	
+	for (size_t j=0; j < num_ports; ++j) {
+		// LV2 shortnames are guaranteed to be unique, valid C identifiers
+		port_name = (char*)slv2_port_get_symbol(_lv2_plugin, j);
+	
+		assert(port_name.find("/") == string::npos);
+
+		port_path = path() + "/" + port_name;
+		
+		// Assumes there is only the 4 classes
+
+		SLV2PortClass port_class = slv2_port_get_class(_lv2_plugin, j);
+		const bool is_control = (port_class == SLV2_CONTROL_RATE_INPUT
+			|| port_class == SLV2_CONTROL_RATE_OUTPUT);
+		const bool is_input = (port_class == SLV2_CONTROL_RATE_INPUT
+			|| port_class == SLV2_AUDIO_RATE_INPUT);
+
+		if (is_control)
+			port_buffer_size = 1;
+		else
+			port_buffer_size = _buffer_size;
+		
+		if (is_input) {
+			port = new InputPort<sample>(this, port_name, j, _poly, DataType::FLOAT, port_buffer_size);
+			_ports->at(j) = port;
+		} else /* output */ {
+			port = new OutputPort<sample>(this, port_name, j, _poly, DataType::FLOAT, port_buffer_size);
+			_ports->at(j) = port;
+		}
+
+		assert(_ports->at(j) != NULL);
+
+		//PortInfo* pi = port->port_info();
+		//get_port_vals(j, pi);
+
+		// Set default control val
+		/*if (pi->is_control())
+			((PortBase<sample>*)port)->set_value(pi->default_val(), 0);
+		else
+			((PortBase<sample>*)port)->set_value(0.0f, 0);*/
+	}
+	return true;
+}
+
+
+LV2Node::~LV2Node()
+{
+	for (size_t i=0; i < _poly; ++i)
+		slv2_instance_free(_instances[i]);
+
+	delete[] _instances;
+}
+
+
+void
+LV2Node::activate()
+{
+	NodeBase::activate();
+
+	PortBase<sample>* port = NULL;
+	
+	for (size_t i=0; i < _poly; ++i) {
+		for (unsigned long j=0; j < num_ports(); ++j) {
+			port = static_cast<PortBase<sample>*>(_ports->at(j));
+			set_port_buffer(i, j, ((PortBase<sample>*)_ports->at(j))->buffer(i)->data());
+			if (port->type() == DataType::FLOAT && port->buffer_size() == 1)
+				port->set_value(0.0f, 0); // FIXME
+			else if (port->type() == DataType::FLOAT && port->buffer_size() > 1)
+				port->set_value(0.0f, 0);
+		}
+		slv2_instance_activate(_instances[i]);
+	}
+}
+
+
+void
+LV2Node::deactivate()
+{
+	NodeBase::deactivate();
+	
+	for (size_t i=0; i < _poly; ++i)
+		slv2_instance_deactivate(_instances[i]);
+}
+
+
+void
+LV2Node::run(size_t nframes)
+{
+	NodeBase::run(nframes); // mixes down input ports
+	for (size_t i=0; i < _poly; ++i) 
+		slv2_instance_run(_instances[i], nframes);
+}
+
+
+void
+LV2Node::set_port_buffer(size_t voice, size_t port_num, void* buf)
+{
+	assert(voice < _poly);
+	
+	// Could be a MIDI port after this
+	if (port_num < num_ports()) {
+		slv2_instance_connect_port(_instances[voice], port_num, buf);
+	}
+}
+
+
+#if 0
+// Based on code stolen from jack-rack
+void
+LV2Node::get_port_vals(ulong port_index, PortInfo* info)
+{
+	LV2_Data upper = 0.0f;
+	LV2_Data lower = 0.0f;
+	LV2_Data normal = 0.0f;
+	LV2_PortRangeHintDescriptor hint_descriptor = _descriptor->PortRangeHints[port_index].HintDescriptor;
+
+	/* set upper and lower, possibly adjusted to the sample rate */
+	if (LV2_IS_HINT_SAMPLE_RATE(hint_descriptor)) {
+		upper = _descriptor->PortRangeHints[port_index].UpperBound * _srate;
+		lower = _descriptor->PortRangeHints[port_index].LowerBound * _srate;
+	} else {
+		upper = _descriptor->PortRangeHints[port_index].UpperBound;
+		lower = _descriptor->PortRangeHints[port_index].LowerBound;
+	}
+
+	if (LV2_IS_HINT_LOGARITHMIC(hint_descriptor)) {
+		/* FLT_EPSILON is defined as the different between 1.0 and the minimum
+		 * float greater than 1.0.  So, if lower is < FLT_EPSILON, it will be 1.0
+		 * and the logarithmic control will have a base of 1 and thus not change
+		 */
+		if (lower < FLT_EPSILON) lower = FLT_EPSILON;
+	}
+
+
+	if (LV2_IS_HINT_HAS_DEFAULT(hint_descriptor)) {
+
+		if (LV2_IS_HINT_DEFAULT_MINIMUM(hint_descriptor)) {
+			normal = lower;
+		} else if (LV2_IS_HINT_DEFAULT_LOW(hint_descriptor)) {
+			if (LV2_IS_HINT_LOGARITHMIC(hint_descriptor)) {
+				normal = exp(log(lower) * 0.75 + log(upper) * 0.25);
+			} else {
+				normal = lower * 0.75 + upper * 0.25;
+			}
+		} else if (LV2_IS_HINT_DEFAULT_MIDDLE(hint_descriptor)) {
+			if (LV2_IS_HINT_LOGARITHMIC(hint_descriptor)) {
+				normal = exp(log(lower) * 0.5 + log(upper) * 0.5);
+			} else {
+				normal = lower * 0.5 + upper * 0.5;
+			}
+		} else if (LV2_IS_HINT_DEFAULT_HIGH(hint_descriptor)) {
+			if (LV2_IS_HINT_LOGARITHMIC(hint_descriptor)) {
+				normal = exp(log(lower) * 0.25 + log(upper) * 0.75);
+			} else {
+				normal = lower * 0.25 + upper * 0.75;
+			}
+		} else if (LV2_IS_HINT_DEFAULT_MAXIMUM(hint_descriptor)) {
+			normal = upper;
+		} else if (LV2_IS_HINT_DEFAULT_0(hint_descriptor)) {
+			normal = 0.0;
+		} else if (LV2_IS_HINT_DEFAULT_1(hint_descriptor)) {
+			normal = 1.0;
+		} else if (LV2_IS_HINT_DEFAULT_100(hint_descriptor)) {
+			normal = 100.0;
+		} else if (LV2_IS_HINT_DEFAULT_440(hint_descriptor)) {
+			normal = 440.0;
+		}
+	} else {  // No default hint
+		if (LV2_IS_HINT_BOUNDED_BELOW(hint_descriptor)) {
+			normal = lower;
+		} else if (LV2_IS_HINT_BOUNDED_ABOVE(hint_descriptor)) {
+			normal = upper;
+		}
+	}
+
+	info->min_val(lower);
+	info->default_val(normal);
+	info->max_val(upper);
+}
+#endif
+
+
+} // namespace Om
+