enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / libs / ardour / internal_send.cc
index db0390e813f8290a96fe891a505c7a1bf2c5acc1..1746b00847e49a739f19293de18269fa3fb4ed62 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2009 Paul Davis 
+    Copyright (C) 2009 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
 
 */
 
-#include <iostream>
-
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
 
 #include "ardour/amp.h"
+#include "ardour/audio_buffer.h"
+#include "ardour/internal_return.h"
 #include "ardour/internal_send.h"
 #include "ardour/meter.h"
+#include "ardour/panner_shell.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
+#include "ardour/audioengine.h"
+
+#include "pbd/i18n.h"
 
-#include "i18n.h"
+namespace ARDOUR { class MuteMaster; class Pannable; }
 
 using namespace PBD;
 using namespace ARDOUR;
-
-InternalSend::InternalSend (Session& s, boost::shared_ptr<MuteMaster> mm, boost::shared_ptr<Route> sendto)
-       : Send (s, mm, true)
-       , _send_to (sendto)
+using namespace std;
+
+PBD::Signal1<void, pframes_t> InternalSend::CycleStart;
+
+InternalSend::InternalSend (Session& s,
+               boost::shared_ptr<Pannable> p,
+               boost::shared_ptr<MuteMaster> mm,
+               boost::shared_ptr<Route> sendfrom,
+               boost::shared_ptr<Route> sendto,
+               Delivery::Role role,
+               bool ignore_bitslot)
+       : Send (s, p, mm, role, ignore_bitslot)
+       , _send_from (sendfrom)
 {
-       if ((target = _send_to->get_return_buffer ()) == 0) {
-               throw failed_constructor();
+       if (sendto) {
+               if (use_target (sendto)) {
+                       throw failed_constructor();
+               }
        }
 
-       _send_to->GoingAway.connect (mem_fun (*this, &InternalSend::send_to_going_away));
+       init_gain ();
+
+       _send_from->DropReferences.connect_same_thread (source_connection, boost::bind (&InternalSend::send_from_going_away, this));
+       CycleStart.connect_same_thread (*this, boost::bind (&InternalSend::cycle_start, this, _1));
 }
 
-InternalSend::InternalSend (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
-       : Send (s, mm, node, true)
+InternalSend::~InternalSend ()
 {
-       set_state (node);
+       if (_send_to) {
+               _send_to->remove_send_from_internal_return (this);
+       }
 }
 
-InternalSend::~InternalSend ()
+void
+InternalSend::init_gain ()
+{
+       if (_role == Listen) {
+               /* send to monitor bus is always at unity */
+               _gain_control->set_value (GAIN_COEFF_UNITY, PBD::Controllable::NoGroup);
+       } else {
+               /* aux sends start at -inf dB */
+               _gain_control->set_value (GAIN_COEFF_ZERO, PBD::Controllable::NoGroup);
+       }
+}
+
+int
+InternalSend::use_target (boost::shared_ptr<Route> sendto)
 {
        if (_send_to) {
-               _send_to->release_return_buffer ();
+               _send_to->remove_send_from_internal_return (this);
        }
 
-       connect_c.disconnect ();
+        _send_to = sendto;
+
+        _send_to->add_send_to_internal_return (this);
+
+       mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
+       mixbufs.set_count (_send_to->internal_return()->input_streams());
+
+       reset_panner ();
+
+        set_name (sendto->name());
+        _send_to_id = _send_to->id();
+
+        target_connections.drop_connections ();
+
+        _send_to->DropReferences.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_going_away, this));
+        _send_to->PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_property_changed, this, _1));
+        _send_to->io_changed.connect_same_thread (target_connections, boost::bind (&InternalSend::target_io_changed, this));
+
+        return 0;
+}
+
+void
+InternalSend::target_io_changed ()
+{
+       assert (_send_to);
+       mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
+       mixbufs.set_count (_send_to->internal_return()->input_streams());
+       reset_panner();
+}
+
+void
+InternalSend::send_from_going_away ()
+{
+       _send_from.reset();
 }
 
 void
 InternalSend::send_to_going_away ()
 {
-       target = 0;
+        target_connections.drop_connections ();
        _send_to.reset ();
        _send_to_id = "0";
 }
 
 void
-InternalSend::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+InternalSend::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool)
 {
-       if (!_active || !target || !_send_to) {
+       if ((!_active && !_pending_active) || !_send_to) {
                _meter->reset ();
                return;
        }
 
        // we have to copy the input, because we may alter the buffers with the amp
        // 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());
-       
+
+       if (_panshell && !_panshell->bypassed() && role() != Listen) {
+               if (mixbufs.count ().n_audio () > 0) {
+                       _panshell->run (bufs, mixbufs, start_frame, end_frame, nframes);
+               }
+
+               /* non-audio data will not have been copied by the panner, do it now
+                * if there are more buffers available than send buffers, ignore them,
+                * if there are less, copy the last as IO::copy_to_output does. */
+
+               for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
+                       if (*t != DataType::AUDIO) {
+                               BufferSet::iterator o = mixbufs.begin(*t);
+                               BufferSet::iterator i = bufs.begin(*t);
+
+                               while (i != bufs.end(*t) && o != mixbufs.end(*t)) {
+                                       o->read_from (*i, nframes);
+                                       ++i;
+                                       ++o;
+                               }
+                               while (o != mixbufs.end(*t)) {
+                                       o->silence(nframes, 0);
+                                       ++o;
+                               }
+                       }
+               }
+       } else {
+               if (role() == Listen) {
+                       /* We're going to the monitor bus, so discard MIDI data */
+
+                       uint32_t const bufs_audio = bufs.count().get (DataType::AUDIO);
+                       uint32_t const mixbufs_audio = mixbufs.count().get (DataType::AUDIO);
+
+                       /* monitor-section has same number of channels as master-bus (on creation).
+                        *
+                        * There is no clear answer what should happen when trying to PFL or AFL
+                        * a track that has more channels (bufs_audio from source-track is
+                        * larger than mixbufs).
+                        *
+                        * There are two options:
+                        *  1: discard additional channels    (current)
+                        * OR
+                        *  2: require the monitor-section to have at least as many channels
+                        * as the largest count of any route
+                        */
+                       //assert (mixbufs.available().get (DataType::AUDIO) >= bufs_audio);
+
+                       /* Copy bufs into mixbufs, going round bufs more than once if necessary
+                          to ensure that every mixbuf gets some data.
+                       */
+
+                       uint32_t j = 0;
+                       for (uint32_t i = 0; i < mixbufs_audio; ++i) {
+                               mixbufs.get_audio(i).read_from (bufs.get_audio(j), nframes);
+                               ++j;
+
+                               if (j == bufs_audio) {
+                                       j = 0;
+                               }
+                       }
+
+               } else {
+                       assert (mixbufs.available() >= bufs.count());
+                       mixbufs.read_from (bufs, nframes);
+               }
+       }
+
        /* gain control */
 
        gain_t tgain = target_gain ();
-       
+
        if (tgain != _current_gain) {
-               
+
                /* target gain has changed */
 
-               Amp::apply_gain (sendbufs, nframes, _current_gain, tgain);
-               _current_gain = tgain;
+               _current_gain = Amp::apply_gain (mixbufs, _session.nominal_frame_rate(), nframes, _current_gain, tgain);
 
-       } else if (tgain == 0.0) {
+       } else if (tgain == GAIN_COEFF_ZERO) {
 
                /* we were quiet last time, and we're still supposed to be quiet.
                */
 
                _meter->reset ();
-               Amp::apply_simple_gain (sendbufs, nframes, 0.0);
-               
-               return;
+               Amp::apply_simple_gain (mixbufs, nframes, GAIN_COEFF_ZERO);
+               goto out;
 
-       } else if (tgain != 1.0) {
+       } else if (tgain != GAIN_COEFF_UNITY) {
 
-               /* target gain has not changed, but is not unity */
-               Amp::apply_simple_gain (sendbufs, nframes, tgain);
+               /* target gain has not changed, but is not zero or unity */
+               Amp::apply_simple_gain (mixbufs, nframes, tgain);
        }
-       
-       // 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);
+       _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
+       _amp->setup_gain_automation (start_frame, end_frame, nframes);
+       _amp->run (mixbufs, start_frame, end_frame, speed, nframes, true);
+
+       _delayline->run (mixbufs, start_frame, end_frame, speed, nframes, true);
 
        /* consider metering */
-       
+
        if (_metering) {
-               if (_amp->gain_control()->get_value() == 0) {
+               if (_amp->gain_control()->get_value() == GAIN_COEFF_ZERO) {
                        _meter->reset();
                } else {
-                       _meter->run (sendbufs, start_frame, end_frame, nframes);
+                       _meter->run (mixbufs, start_frame, end_frame, speed, nframes, true);
                }
        }
 
-       /* deliver to target */
+       /* target will pick up our output when it is ready */
 
-       target->merge_from (sendbufs, nframes);
+  out:
+       _active = _pending_active;
+}
+
+int
+InternalSend::set_block_size (pframes_t nframes)
+{
+       if (_send_to) {
+               mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), nframes);
+       }
+
+        return 0;
 }
 
 bool
@@ -141,14 +277,14 @@ InternalSend::state (bool full)
 {
        XMLNode& node (Send::state (full));
 
-       /* this replaces any existing property */
+       /* this replaces any existing "type" property */
 
        node.add_property ("type", "intsend");
 
        if (_send_to) {
                node.add_property ("target", _send_to->id().to_s());
        }
-       
+
        return node;
 }
 
@@ -159,11 +295,13 @@ InternalSend::get_state()
 }
 
 int
-InternalSend::set_state (const XMLNode& node)
+InternalSend::set_state (const XMLNode& node, int version)
 {
-       const XMLProperty* prop;
+       XMLProperty const * prop;
+
+       init_gain ();
 
-       Send::set_state (node);
+       Send::set_state (node, version);
 
        if ((prop = node.property ("target")) != 0) {
 
@@ -175,12 +313,12 @@ InternalSend::set_state (const XMLNode& node)
                */
 
                if (!IO::connecting_legal) {
-                       connect_c = IO::ConnectingLegal.connect (mem_fun (*this, &InternalSend::connect_when_legal));
+                       IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
                } else {
                        connect_when_legal ();
                }
        }
-       
+
        return 0;
 }
 
@@ -194,22 +332,95 @@ InternalSend::connect_when_legal ()
                return 0;
        }
 
-       if ((_send_to = _session.route_by_id (_send_to_id)) == 0) {
-               error << X_("cannot find route to connect to") << endmsg;
-               return -1;
-       } 
-       
-       if ((target = _send_to->get_return_buffer ()) == 0) {
-               error << X_("target for internal send has no return buffer") << endmsg;
+        boost::shared_ptr<Route> sendto;
+
+       if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
+               error << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endmsg;
+               cerr << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endl;
                return -1;
        }
 
-       return 0;
+        return use_target (sendto);
 }
 
-bool 
-InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+bool
+InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 {
        out = in;
        return true;
 }
+
+uint32_t
+InternalSend::pan_outs () const
+{
+       /* the number of targets for our panner is determined by what we are
+          sending to, if anything.
+       */
+
+       if (_send_to) {
+               return _send_to->internal_return()->input_streams().n_audio();
+       }
+
+       return 1; /* zero is more accurate, but 1 is probably safer as a way to
+                  * say "don't pan"
+                  */
+}
+
+bool
+InternalSend::configure_io (ChanCount in, ChanCount out)
+{
+       bool ret = Send::configure_io (in, out);
+       set_block_size (_session.engine().samples_per_cycle());
+       return ret;
+}
+
+bool
+InternalSend::set_name (const string& str)
+{
+       /* rules for external sends don't apply to us */
+       return IOProcessor::set_name (str);
+}
+
+string
+InternalSend::display_name () const
+{
+       if (_role == Aux) {
+               return string_compose (X_("%1"), _name);
+       } else {
+               return _name;
+       }
+}
+
+bool
+InternalSend::visible () const
+{
+       if (_role == Aux) {
+               return true;
+       }
+
+       return false;
+}
+
+void
+InternalSend::send_to_property_changed (const PropertyChange& what_changed)
+{
+       if (what_changed.contains (Properties::name)) {
+               set_name (_send_to->name ());
+       }
+}
+
+void
+InternalSend::set_can_pan (bool yn)
+{
+       if (_panshell) {
+               _panshell->set_bypassed (!yn);
+       }
+}
+
+void
+InternalSend::cycle_start (pframes_t /*nframes*/)
+{
+       for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {
+               b->prepare ();
+       }
+}