/*
- Copyright (C) 2000 Paul Davis
+ 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
+#include <iostream>
#include <algorithm>
-#include <pbd/xml++.h>
+#include "pbd/xml++.h"
+#include "pbd/boost_debug.h"
-#include <ardour/send.h>
-#include <ardour/session.h>
-#include <ardour/port.h>
+#include "ardour/amp.h"
+#include "ardour/send.h"
+#include "ardour/session.h"
+#include "ardour/buffer_set.h"
+#include "ardour/meter.h"
+#include "ardour/io.h"
#include "i18n.h"
+namespace ARDOUR {
+class AutomationControl;
+class MuteMaster;
+class Pannable;
+}
+
using namespace ARDOUR;
using namespace PBD;
+using namespace std;
-Send::Send (Session& s, Placement p)
- : Redirect (s, string_compose (_("send %1"), (bitslot = s.next_send_id()) + 1), p)
+string
+Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot)
{
- _metering = false;
- expected_inputs = 0;
- RedirectCreated (this); /* EMIT SIGNAL */
+ if (r == Role (0)) {
+ /* this happens during initial construction of sends from XML,
+ before they get ::set_state() called. lets not worry about
+ it.
+ */
+ bitslot = 0;
+ return string ();
+ }
+
+ switch (r) {
+ case Delivery::Aux:
+ return string_compose (_("aux %1"), (bitslot = s.next_aux_send_id ()) + 1);
+ case Delivery::Listen:
+ return _("listen"); // no ports, no need for numbering
+ case Delivery::Send:
+ return string_compose (_("send %1"), (bitslot = s.next_send_id ()) + 1);
+ default:
+ fatal << string_compose (_("programming error: send created using role %1"), enum_2_string (r)) << endmsg;
+ /*NOTREACHED*/
+ return string();
+ }
+
}
-Send::Send (Session& s, const XMLNode& node)
- : Redirect (s, "send", PreFader)
+Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r)
+ : Delivery (s, p, mm, name_and_id_new_send (s, r, _bitslot), r)
+ , _metering (false)
{
- _metering = false;
- expected_inputs = 0;
-
- if (set_state (node)) {
- throw failed_constructor();
+ if (_role == Listen) {
+ /* we don't need to do this but it keeps things looking clean
+ in a debugger. _bitslot is not used by listen sends.
+ */
+ _bitslot = 0;
}
- RedirectCreated (this); /* EMIT SIGNAL */
+ boost_debug_shared_ptr_mark_interesting (this, "send");
+
+ _amp.reset (new Amp (_session));
+ _meter.reset (new PeakMeter (_session));
+
+ add_control (_amp->gain_control ());
+}
+
+Send::~Send ()
+{
+ _session.unmark_send_id (_bitslot);
}
-Send::Send (const Send& other)
- : Redirect (other._session, string_compose (_("send %1"), (bitslot = other._session.next_send_id()) + 1), other.placement())
+void
+Send::activate ()
{
- _metering = false;
- expected_inputs = 0;
+ _amp->activate ();
+ _meter->activate ();
- RedirectCreated (this); /* EMIT SIGNAL */
+ Processor::activate ();
}
-Send::~Send ()
+void
+Send::deactivate ()
{
- GoingAway ();
+ _amp->deactivate ();
+ _meter->deactivate ();
+ _meter->reset ();
+
+ Processor::deactivate ();
+}
+
+void
+Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
+{
+ if (_output->n_ports() == ChanCount::ZERO) {
+ _meter->reset ();
+ _active = _pending_active;
+ return;
+ }
+
+ if (!_active && !_pending_active) {
+ _meter->reset ();
+ _output->silence (nframes);
+ _active = _pending_active;
+ return;
+ }
+
+ // we have to copy the input, because deliver_output() may alter the buffers
+ // in-place, which a send must never do.
+
+ BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
+ sendbufs.read_from (bufs, nframes);
+ assert(sendbufs.count() == bufs.count());
+
+ /* gain control */
+
+ // Can't automate gain for sends or returns yet because we need different buffers
+ // so that we don't overwrite the main automation data for the route amp
+ // _amp->setup_gain_automation (start_frame, end_frame, nframes);
+ _amp->run (sendbufs, start_frame, end_frame, nframes, true);
+
+ /* deliver to outputs */
+
+ Delivery::run (sendbufs, start_frame, end_frame, nframes, true);
+
+ /* consider metering */
+
+ if (_metering) {
+ if (_amp->gain_control()->get_value() == 0) {
+ _meter->reset();
+ } else {
+ _meter->run (*_output_buffers, start_frame, end_frame, nframes, true);
+ }
+ }
+
+ /* _active was set to _pending_active by Delivery::run() */
}
XMLNode&
}
XMLNode&
-Send::state(bool full)
+Send::state (bool full)
{
- XMLNode *node = new XMLNode("Send");
+ XMLNode& node = Delivery::state(full);
char buf[32];
- node->add_child_nocopy (Redirect::state (full));
- snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
- node->add_property ("bitslot", buf);
- return *node;
+
+ node.add_property ("type", "send");
+ snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
+
+ if (_role != Listen) {
+ node.add_property ("bitslot", buf);
+ }
+
+ node.add_child_nocopy (_amp->state (full));
+
+ return node;
}
int
-Send::set_state(const XMLNode& node)
+Send::set_state (const XMLNode& node, int version)
{
- XMLNodeList nlist = node.children();
- XMLNodeIterator niter;
+ if (version < 3000) {
+ return set_state_2X (node, version);
+ }
+
const XMLProperty* prop;
- if ((prop = node.property ("bitslot")) == 0) {
- bitslot = _session.next_send_id();
- } else {
- sscanf (prop->value().c_str(), "%" PRIu32, &bitslot);
- _session.mark_send_id (bitslot);
- }
+ Delivery::set_state (node, version);
- /* Send has regular IO automation (gain, pan) */
+ if (node.property ("ignore-bitslot") == 0) {
- for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
- if ((*niter)->name() == Redirect::state_node_name) {
- Redirect::set_state (**niter);
- break;
- } else if ((*niter)->name() == X_("Automation")) {
- IO::set_automation_state (*(*niter));
+ /* don't try to reset bitslot if there is a node for it already: this can cause
+ issues with the session's accounting of send ID's
+ */
+
+ if ((prop = node.property ("bitslot")) == 0) {
+ if (_role == Delivery::Aux) {
+ _bitslot = _session.next_aux_send_id ();
+ } else if (_role == Delivery::Send) {
+ _bitslot = _session.next_send_id ();
+ } else {
+ // bitslot doesn't matter but make it zero anyway
+ _bitslot = 0;
+ }
+ } else {
+ if (_role == Delivery::Aux) {
+ _session.unmark_aux_send_id (_bitslot);
+ sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+ _session.mark_aux_send_id (_bitslot);
+ } else if (_role == Delivery::Send) {
+ _session.unmark_send_id (_bitslot);
+ sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+ _session.mark_send_id (_bitslot);
+ } else {
+ // bitslot doesn't matter but make it zero anyway
+ _bitslot = 0;
+ }
+ }
+ }
+
+ XMLNodeList nlist = node.children();
+ for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
+ if ((*i)->name() == X_("Processor")) {
+ _amp->set_state (**i, version);
}
}
- if (niter == nlist.end()) {
- error << _("XML node describing a send is missing a Redirect node") << endmsg;
+ return 0;
+}
+
+int
+Send::set_state_2X (const XMLNode& node, int /* version */)
+{
+ /* use the IO's name for the name of the send */
+ XMLNodeList const & children = node.children ();
+
+ XMLNodeList::const_iterator i = children.begin();
+ while (i != children.end() && (*i)->name() != X_("Redirect")) {
+ ++i;
+ }
+
+ if (i == children.end()) {
+ return -1;
+ }
+
+ XMLNodeList const & grand_children = (*i)->children ();
+ XMLNodeList::const_iterator j = grand_children.begin ();
+ while (j != grand_children.end() && (*j)->name() != X_("IO")) {
+ ++j;
+ }
+
+ if (j == grand_children.end()) {
return -1;
}
+ XMLProperty const * prop = (*j)->property (X_("name"));
+ if (!prop) {
+ return -1;
+ }
+
+ set_name (prop->value ());
+
return 0;
}
-void
-Send::run (vector<Sample *>& bufs, uint32_t nbufs, nframes_t nframes, nframes_t offset)
+bool
+Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
{
- if (active()) {
+ /* sends have no impact at all on the channel configuration of the
+ streams passing through the route. so, out == in.
+ */
- // we have to copy the input, because IO::deliver_output may alter the buffers
- // in-place, which a send must never do.
+ out = in;
+ return true;
+}
- vector<Sample*>& sendbufs = _session.get_send_buffers();
+/** Caller must hold process lock */
+bool
+Send::configure_io (ChanCount in, ChanCount out)
+{
+ if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
+ return false;
+ }
- for (size_t i=0; i < nbufs; ++i) {
- memcpy (sendbufs[i], bufs[i], sizeof (Sample) * nframes);
- }
-
-
- IO::deliver_output (sendbufs, nbufs, nframes, offset);
+ if (!Processor::configure_io (in, out)) {
+ return false;
+ }
- if (_metering) {
- uint32_t n;
- uint32_t no = n_outputs();
+ reset_panner ();
- if (_gain == 0) {
+ return true;
+}
- for (n = 0; n < no; ++n) {
- _peak_power[n] = 0;
- }
+bool
+Send::set_name (const string& new_name)
+{
+ string unique_name;
- } else {
+ if (_role == Delivery::Send) {
+ char buf[32];
- for (n = 0; n < no; ++n) {
- _peak_power[n] = Session::compute_peak (output(n)->get_buffer(nframes) + offset, nframes, _peak_power[n]);
- }
- }
- }
+ /* rip any existing numeric part of the name, and append the bitslot
+ */
- } else {
- silence (nframes, offset);
-
- if (_metering) {
- uint32_t n;
- uint32_t no = n_outputs();
+ string::size_type last_letter = new_name.find_last_not_of ("0123456789");
- for (n = 0; n < no; ++n) {
- _peak_power[n] = 0;
- }
+ if (last_letter != string::npos) {
+ unique_name = new_name.substr (0, last_letter + 1);
+ } else {
+ unique_name = new_name;
}
+
+ snprintf (buf, sizeof (buf), "%u", (_bitslot + 1));
+ unique_name += buf;
+
+ } else {
+ unique_name = new_name;
}
+
+ return Delivery::set_name (unique_name);
}
-void
-Send::set_metering (bool yn)
+bool
+Send::display_to_user () const
{
- _metering = yn;
+ /* we ignore Deliver::_display_to_user */
- if (!_metering) {
- /* XXX possible thread hazard here */
- reset_peak_meters ();
+ if (_role == Listen) {
+ /* don't make the monitor/control/listen send visible */
+ return false;
}
+
+ return true;
}
-void
-Send::expect_inputs (uint32_t expected)
+string
+Send::value_as_string (boost::shared_ptr<AutomationControl> ac) const
{
- if (expected != expected_inputs) {
- expected_inputs = expected;
- reset_panner ();
- }
+ return _amp->value_as_string (ac);
}
+
+
projects / ardour.git / blobdiff