Returns (i.e. sidechains).

And lo, upon the revision of our hoarde 5061, was the last Big Feature
committed to Three Poino, who, now more than ever, lurks imposingly on
the sidelines, heir to the throne, and eventual ruler of the realm.
His eventual succession all but guaranteed, only time and the number
of heads that must roll remain mysteries.


git-svn-id: svn://localhost/ardour2/branches/3.0@5061 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 164 insertions, 0 deletions

diff --git a/libs/ardour/return.cc b/libs/ardour/return.cc
new file mode 100644
index 0000000000..fdc2b259e1
--- /dev/null
+++ b/libs/ardour/return.cc
@@ -0,0 +1,164 @@
+/*
+    Copyright (C) 2000 Paul Davis 
+
+    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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program 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 more 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+#include <algorithm>
+
+#include "pbd/xml++.h"
+
+#include "ardour/return.h"
+#include "ardour/session.h"
+#include "ardour/port.h"
+#include "ardour/audio_port.h"
+#include "ardour/buffer_set.h"
+#include "ardour/meter.h"
+#include "ardour/panner.h"
+#include "ardour/io.h"
+
+#include "i18n.h"
+
+using namespace ARDOUR;
+using namespace PBD;
+
+Return::Return (Session& s)
+	: IOProcessor (s, string_compose (_("return %1"), (_bitslot = s.next_return_id()) + 1))
+{
+	ProcessorCreated (this); /* EMIT SIGNAL */
+}
+
+Return::Return (Session& s, const XMLNode& node)
+	: IOProcessor (s, "return")
+{
+	if (set_state (node)) {
+		throw failed_constructor();
+	}
+
+	ProcessorCreated (this); /* EMIT SIGNAL */
+}
+
+Return::~Return ()
+{
+	GoingAway ();
+}
+
+XMLNode&
+Return::get_state(void)
+{
+	return state (true);
+}
+
+XMLNode&
+Return::state(bool full)
+{
+	XMLNode& node = IOProcessor::state(full);
+	char buf[32];
+	node.add_property ("type", "return");
+	snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
+	node.add_property ("bitslot", buf);
+
+	return node;
+}
+
+int
+Return::set_state(const XMLNode& node)
+{
+	XMLNodeList nlist = node.children();
+	XMLNodeIterator niter;
+	const XMLProperty* prop;
+
+	if ((prop = node.property ("bitslot")) == 0) {
+		_bitslot = _session.next_return_id();
+	} else {
+		sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+		_session.mark_return_id (_bitslot);
+	}
+
+	const XMLNode* insert_node = &node;
+
+	/* Return has regular IO automation (gain, pan) */
+
+	for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+		if ((*niter)->name() == "IOProcessor") {
+			insert_node = *niter;
+		} else if ((*niter)->name() == X_("Automation")) {
+			// _io->set_automation_state (*(*niter), Evoral::Parameter(GainAutomation));
+		}
+	}
+	
+	IOProcessor::set_state (*insert_node);
+
+	return 0;
+}
+
+void
+Return::run_in_place (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes)
+{
+	if (active()) {
+		_io->collect_input (bufs, nframes, _configured_input);
+		bufs.set_count(_configured_output);
+	}
+}
+
+bool
+Return::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+{
+	out = in + _io->n_inputs();
+	return true;
+}
+
+bool
+Return::configure_io (ChanCount in, ChanCount out)
+{
+	if (out != in + _io->n_inputs()) {
+		return false;
+	}
+
+	// Ensure there are enough buffers (since we add some)
+	if (_session.get_scratch_buffers(in).count() < out) {
+		Glib::Mutex::Lock em (_session.engine().process_lock());
+		IO::PortCountChanged(out);
+	}
+
+	Processor::configure_io(in, out);
+
+	return true;
+}
+
+/** Set up the XML description of a return so that its name is unique.
+ *  @param state XML return state.
+ *  @param session Session.
+ */
+void
+Return::make_unique (XMLNode &state, Session &session)
+{
+	uint32_t const bitslot = session.next_return_id() + 1;
+
+	char buf[32];
+	snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
+	state.property("bitslot")->set_value (buf);
+
+	std::string const name = string_compose (_("return %1"), bitslot);
+	
+	state.property("name")->set_value (name);
+
+	XMLNode* io = state.child ("IO");
+	if (io) {
+		io->property("name")->set_value (name);
+	}
+}
+