carl's wondrous DnD VBox patch - processor boxes are now vboxes and not listviews...
[ardour.git] / libs / ardour / send.cc
index c67e0fcdbeff619b2dbf99f76b09b98e5d41a3a5..91e6827e6166435a2e0e040b46b9813fe9adb27b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    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 "ardour/amp.h"
+#include "ardour/send.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 <ardour/send.h>
-#include <ardour/session.h>
-#include <ardour/port.h>
-#include <ardour/audio_port.h>
-#include <ardour/buffer_set.h>
-#include <ardour/meter.h>
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
+using namespace std;
 
-Send::Send (Session& s, Placement p)
-       : Redirect (s, s.next_send_name(), p)
+Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, Role r)
+       : Delivery (s, mm, string_compose (_("send %1"), (_bitslot = s.next_send_id()) + 1), r)
+       , _metering (false)
 {
-       _metering = false;
-       save_state (_("initial state"));
-        RedirectCreated (this); /* EMIT SIGNAL */
+       _amp.reset (new Amp (_session, _mute_master));
+       _meter.reset (new PeakMeter (_session));
+
+       ProcessorCreated (this); /* EMIT SIGNAL */
 }
 
-Send::Send (Session& s, const XMLNode& node)
-       : Redirect (s,  "send", PreFader)
+Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node, int version, Role r)
+        : Delivery (s, mm, "send", r)
+       , _metering (false)
 {
-       _metering = false;
+       _amp.reset (new Amp (_session, _mute_master));
+       _meter.reset (new PeakMeter (_session));
 
-       if (set_state (node)) {
+       if (set_state (node, version)) {
                throw failed_constructor();
        }
 
-       save_state (_("initial state"));
-        RedirectCreated (this); /* EMIT SIGNAL */
+       ProcessorCreated (this); /* EMIT SIGNAL */
 }
 
-Send::Send (const Send& other)
-       : Redirect (other._session, other._session.next_send_name(), other.placement())
+Send::~Send ()
 {
-       _metering = false;
-       save_state (_("initial state"));
-       RedirectCreated (this); /* EMIT SIGNAL */
+       GoingAway ();
 }
 
-Send::~Send ()
+void
+Send::activate ()
 {
-       GoingAway (this);
+       _amp->activate ();
+       _meter->activate ();
+
+       Processor::activate ();
+}
+
+void
+Send::deactivate ()
+{
+       _amp->deactivate ();
+       _meter->deactivate ();
+       _meter->reset ();
+       
+       Processor::deactivate ();
+}
+
+void
+Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+{
+       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);
+
+       /* deliver to outputs */
+
+       Delivery::run (sendbufs, start_frame, end_frame, nframes);
+
+       /* consider metering */
+
+       if (_metering) {
+               if (_amp->gain_control()->get_value() == 0) {
+                       _meter->reset();
+               } else {
+                       _meter->run (*_output_buffers, start_frame, end_frame, nframes);
+               }
+       }
+
+       /* _active was set to _pending_active by Delivery::run() */
 }
 
 XMLNode&
@@ -76,81 +142,128 @@ Send::get_state(void)
 XMLNode&
 Send::state(bool full)
 {
-       XMLNode *node = new XMLNode("Send");
-       node->add_child_nocopy (Redirect::state(full));
-       return *node;
+       XMLNode& node = Delivery::state(full);
+       char buf[32];
+
+       node.add_property ("type", "send");
+       snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
+       node.add_property ("bitslot", buf);
+
+       return node;
 }
 
 int
-Send::set_state(const XMLNode& node)
+Send::set_state (const XMLNode& node, int version)
 {
        XMLNodeList nlist = node.children();
        XMLNodeIterator niter;
-       
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() == Redirect::state_node_name) {
-                       Redirect::set_state (**niter);
-                       break;
-               }
-       }
+       const XMLProperty* prop;
 
-       if (niter == nlist.end()) {
-               error << _("XML node describing a send is missing a Redirect node") << endmsg;
-               return -1;
+       if ((prop = node.property ("bitslot")) == 0) {
+               _bitslot = _session.next_send_id();
+       } else {
+               sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+               cerr << this << " scanned " << prop->value() << " to get " << _bitslot << endl;
+               _session.mark_send_id (_bitslot);
        }
 
+       const XMLNode* insert_node = &node;
+
+       /* XXX need to load automation state & data for amp */
+
+       Delivery::set_state (*insert_node, version);
+
        return 0;
 }
 
-void
-Send::run (BufferSet& bufs, jack_nframes_t start_frame, jack_nframes_t end_frame, jack_nframes_t nframes, jack_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;
+}
 
-               BufferSet& sendbufs = _session.get_send_buffers(bufs.count());
+bool
+Send::configure_io (ChanCount in, ChanCount out)
+{
+       if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
+               return false;
+       }
 
-               sendbufs.read_from(bufs, nframes);
-               assert(sendbufs.count() == bufs.count());
-               assert(sendbufs.count() == _outputs.count());
+       if (!Processor::configure_io (in, out)) {
+               return false;
+       }
 
-               IO::deliver_output (sendbufs, start_frame, end_frame, nframes, offset);
+       reset_panner ();
 
-               if (_metering) {
-                       if (_gain == 0) {
-                               _meter->reset();
-                       } else {
-                               _meter->run(output_buffers(), nframes, offset);
-                       }
-               }
+       return true;
+}
 
-       } else {
-               silence (nframes, offset);
-               
-               if (_metering) {
-                       _meter->reset();
-               }
+/** Set up the XML description of a send so that its name is unique.
+ *  @param state XML send state.
+ *  @param session Session.
+ */
+void
+Send::make_unique (XMLNode &state, Session &session)
+{
+       uint32_t const bitslot = session.next_send_id() + 1;
+
+       char buf[32];
+       snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
+       state.property("bitslot")->set_value (buf);
+
+       string const name = string_compose (_("send %1"), bitslot);
+
+       state.property("name")->set_value (name);
+
+       XMLNode* io = state.child ("IO");
+
+       if (io) {
+               io->property("name")->set_value (name);
        }
 }
 
-void
-Send::set_metering (bool yn)
+bool
+Send::set_name (const string& new_name)
 {
-       _metering = yn;
+       string unique_name;
+
+       if (_role == Delivery::Send) {
+               char buf[32];
+
+               /* rip any existing numeric part of the name, and append the bitslot
+                */
+
+               string::size_type last_letter = new_name.find_last_not_of ("0123456789");
 
-       if (!_metering) {
-               /* XXX possible thread hazard here */
-               peak_meter().reset();
+               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::expect_inputs (const ChanCount& expected)
+bool
+Send::display_to_user () const
 {
-       if (expected != _expected_inputs) {
-               _expected_inputs = expected;
-               reset_panner ();
+       /* we ignore Deliver::_display_to_user */
+
+       if (_role == Listen) {
+               return false;
        }
+
+       return true;
 }