(1) do not write sequential same-value automation data into a ControlList (2) thin...
[ardour.git] / libs / ardour / route.cc
index 76b3f55d226904d6c6ddcbd6025b00db81d1de92..00507627b5ee353cb2c9d951af8e72c1a2e63a6e 100644 (file)
@@ -65,7 +65,6 @@
 #include "ardour/session.h"
 #include "ardour/timestamps.h"
 #include "ardour/utils.h"
-#include "ardour/graph.h"
 #include "ardour/unknown_processor.h"
 #include "ardour/capturing_processor.h"
 
@@ -82,7 +81,7 @@ PBD::Signal0<void> Route::RemoteControlIDChange;
 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
        : SessionObject (sess, name)
        , Automatable (sess)
-       , GraphNode( sess.route_graph )
+       , GraphNode (sess._process_graph)
        , _active (true)
        , _signal_latency (0)
        , _initial_delay (0)
@@ -104,6 +103,8 @@ Route::Route (Session& sess, string name, Flag flg, DataType default_type)
        , _default_type (default_type)
        , _remote_control_id (0)
        , _in_configure_processors (false)
+       , _custom_meter_position_noted (false)
+       , _last_custom_meter_was_at_end (false)
 {
        processor_max_streams.reset();
        order_keys[N_("signal")] = order_key_cnt++;
@@ -126,11 +127,7 @@ Route::init ()
        /* panning */
 
        if (!(_flags & Route::MonitorOut)) {
-               Pannable* p = new Pannable (_session);
-#ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
-               boost_debug_shared_ptr_mark_interesting (p, "Pannable");
-#endif
-               _pannable.reset (p);
+               _pannable.reset (new Pannable (_session));
        }
 
        /* input and output objects */
@@ -401,12 +398,9 @@ Route::maybe_declick (BufferSet&, framecnt_t, int)
 void
 Route::process_output_buffers (BufferSet& bufs,
                               framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
-                              bool /*with_processors*/, int declick,
-                               bool gain_automation_ok)
+                              int declick, bool gain_automation_ok)
 {
-       bool monitor = should_monitor ();
-
-       bufs.is_silent (false);
+       bufs.set_is_silent (false);
 
        /* figure out if we're going to use gain automation */
        if (gain_automation_ok) {
@@ -415,8 +409,11 @@ Route::process_output_buffers (BufferSet& bufs,
                _amp->apply_gain_automation (false);
        }
 
-       /* tell main outs what to do about monitoring */
-       _main_outs->no_outs_cuz_we_no_monitor (!monitor);
+       /* Tell main outs what to do about monitoring.  We do this so that
+          on a transition between monitoring states we get a de-clicking gain
+          change in the _main_outs delivery.
+       */
+       _main_outs->no_outs_cuz_we_no_monitor (monitoring_state () == MonitoringSilence);
 
 
        /* -------------------------------------------------------------------------------------------
@@ -482,12 +479,20 @@ Route::process_output_buffers (BufferSet& bufs,
           and go ....
           ----------------------------------------------------------------------------------------- */
 
+       /* set this to be true if the meter will already have been ::run() earlier */
+       bool const meter_already_run = metering_state() == MeteringInput;
+
        for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 
                if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
                        break;
                }
 
+               if (boost::dynamic_pointer_cast<PeakMeter> (*i) && meter_already_run) {
+                       /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
+                       continue;
+               }
+               
 #ifndef NDEBUG
                /* if it has any inputs, make sure they match */
                if ((*i)->input_streams() != ChanCount::ZERO) {
@@ -499,6 +504,7 @@ Route::process_output_buffers (BufferSet& bufs,
                        }
                }
 #endif
+
                /* should we NOT run plugins here if the route is inactive?
                   do we catch route != active somewhere higher?
                */
@@ -551,16 +557,17 @@ Route::passthru (framepos_t start_frame, framepos_t end_frame, pframes_t nframes
        }
 
        write_out_of_band_data (bufs, start_frame, end_frame, nframes);
-       process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, true);
+       process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
 }
 
 void
 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
 {
        BufferSet& bufs (_session.get_silent_buffers (n_process_buffers()));
+
        bufs.set_count (_input->n_ports());
        write_out_of_band_data (bufs, start_frame, end_frame, nframes);
-       process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, false);
+       process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
 }
 
 void
@@ -748,7 +755,7 @@ Route::set_solo_isolated (bool yn, void *src)
                }
 
                bool sends_only;
-               bool does_feed = direct_feeds (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
+               bool does_feed = direct_feeds_according_to_graph (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
 
                if (does_feed && !sends_only) {
                        (*i)->set_solo_isolated (yn, (*i)->route_group());
@@ -808,6 +815,11 @@ Route::set_mute (bool yn, void *src)
 
        if (muted() != yn) {
                _mute_master->set_muted_by_self (yn);
+               /* allow any derived classes to respond to the mute change
+                  before anybody else knows about it.
+               */
+               act_on_mute ();
+               /* tell everyone else */
                mute_changed (src); /* EMIT SIGNAL */
                _mute_control->Changed (); /* EMIT SIGNAL */
        }
@@ -1627,34 +1639,11 @@ Route::configure_processors_unlocked (ProcessorStreams* err)
        return 0;
 }
 
-void
-Route::all_processors_flip ()
-{
-       Glib::RWLock::ReaderLock lm (_processor_lock);
-
-       if (_processors.empty()) {
-               return;
-       }
-
-       bool first_is_on = _processors.front()->active();
-
-       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
-               if (first_is_on) {
-                       (*i)->deactivate ();
-               } else {
-                       (*i)->activate ();
-               }
-       }
-
-       _session.set_dirty ();
-}
-
-/** Set all processors with a given placement to a given active state.
- * @param p Placement of processors to change.
- * @param state New active state for those processors.
+/** Set all visible processors to a given active state (except Fader, whose state is not changed)
+ *  @param state New active state for those processors.
  */
 void
-Route::all_processors_active (Placement p, bool state)
+Route::all_visible_processors_active (bool state)
 {
        Glib::RWLock::ReaderLock lm (_processor_lock);
 
@@ -1662,10 +1651,11 @@ Route::all_processors_active (Placement p, bool state)
                return;
        }
        
-       ProcessorList::iterator start, end;
-       placement_range(p, start, end);
-
-       for (ProcessorList::iterator i = start; i != end; ++i) {
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
+                       continue;
+               }
+               
                if (state) {
                        (*i)->activate ();
                } else {
@@ -1676,31 +1666,6 @@ Route::all_processors_active (Placement p, bool state)
        _session.set_dirty ();
 }
 
-bool
-Route::processor_is_prefader (boost::shared_ptr<Processor> p)
-{
-       bool pre_fader = true;
-       Glib::RWLock::ReaderLock lm (_processor_lock);
-
-       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
-
-               /* semantic note: if p == amp, we want to return true, so test
-                  for equality before checking if this is the amp
-               */
-
-               if ((*i) == p) {
-                       break;
-               }
-
-               if ((*i) == _amp) {
-                       pre_fader = false;
-                       break;
-               }
-       }
-
-       return pre_fader;
-}
-
 int
 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
 {
@@ -1769,6 +1734,9 @@ Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err
 
                _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
 
+               /* If the meter is in a custom position, find it and make a rough note of its position */
+               maybe_note_meter_position ();
+
                {
                        Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
 
@@ -1874,24 +1842,28 @@ Route::state(bool full_state)
                node->add_child_nocopy((*i)->state (full_state));
        }
 
-       if (_extra_xml){
+       if (_extra_xml) {
                node->add_child_copy (*_extra_xml);
        }
 
+       if (_custom_meter_position_noted) {
+               boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
+               if (after) {
+                       after->id().print (buf, sizeof (buf));
+                       node->add_property (X_("processor-after-last-custom-meter"), buf);
+               }
+
+               node->add_property (X_("last-custom-meter-was-at-end"), _last_custom_meter_was_at_end ? "yes" : "no");
+       }
+
        return *node;
 }
 
 int
 Route::set_state (const XMLNode& node, int version)
-{
-       return _set_state (node, version);
-}
-
-int
-Route::_set_state (const XMLNode& node, int version)
 {
        if (version < 3000) {
-               return _set_state_2X (node, version);
+               return set_state_2X (node, version);
        }
 
        XMLNodeList nlist;
@@ -2042,6 +2014,24 @@ Route::_set_state (const XMLNode& node, int version)
                }
        }
 
+       if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
+               PBD::ID id (prop->value ());
+               Glib::RWLock::ReaderLock lm (_processor_lock);
+               ProcessorList::const_iterator i = _processors.begin ();
+               while (i != _processors.end() && (*i)->id() != id) {
+                       ++i;
+               }
+
+               if (i != _processors.end ()) {
+                       _processor_after_last_custom_meter = *i;
+                       _custom_meter_position_noted = true;
+               }
+       }
+
+       if ((prop = node.property (X_("last-custom-meter-was-at-end"))) != 0) {
+               _last_custom_meter_was_at_end = string_is_affirmative (prop->value ());
+       }
+
        for (niter = nlist.begin(); niter != nlist.end(); ++niter){
                child = *niter;
 
@@ -2073,7 +2063,7 @@ Route::_set_state (const XMLNode& node, int version)
 }
 
 int
-Route::_set_state_2X (const XMLNode& node, int version)
+Route::set_state_2X (const XMLNode& node, int version)
 {
        XMLNodeList nlist;
        XMLNodeConstIterator niter;
@@ -2695,14 +2685,14 @@ Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
 }
 
 bool
-Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
+Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
 {
        DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
 
        if (_output->connected_to (other->input())) {
                DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
-               if (only_send) {
-                       *only_send = false;
+               if (via_send_only) {
+                       *via_send_only = false;
                }
 
                return true;
@@ -2716,8 +2706,8 @@ Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
                if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
                        if (iop->feeds (other)) {
                                DEBUG_TRACE (DEBUG::Graph,  string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
-                               if (only_send) {
-                                       *only_send = true;
+                               if (via_send_only) {
+                                       *via_send_only = true;
                                }
                                return true;
                        } else {
@@ -2733,6 +2723,12 @@ Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
        return false;
 }
 
+bool
+Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
+{
+       return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
+}
+
 /** Called from the (non-realtime) butler thread when the transport is stopped */
 void
 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool did_locate, bool can_flush_processors)
@@ -2858,14 +2854,6 @@ Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*
        return 0;
 }
 
-void
-Route::toggle_monitor_input ()
-{
-       for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
-               i->ensure_monitor_input( ! i->monitoring_input());
-       }
-}
-
 bool
 Route::has_external_redirects () const
 {
@@ -2917,45 +2905,63 @@ Route::set_meter_point (MeterPoint p, bool force)
                return;
        }
 
-       _meter_point = p;
-
        bool meter_was_visible_to_user = _meter->display_to_user ();
 
        {
                Glib::RWLock::WriterLock lm (_processor_lock);
 
+               maybe_note_meter_position ();
+
+               _meter_point = p;
+
                if (_meter_point != MeterCustom) {
 
                        _meter->set_display_to_user (false);
 
                        setup_invisible_processors ();
 
-                       ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
+               } else {
 
-                       ChanCount m_in;
+                       _meter->set_display_to_user (true);
 
-                       if (loc == _processors.begin()) {
-                               m_in = _input->n_ports();
-                       } else {
-                               ProcessorList::iterator before = loc;
-                               --before;
-                               m_in = (*before)->output_streams ();
+                       /* If we have a previous position for the custom meter, try to put it there */
+                       if (_custom_meter_position_noted) {
+                               boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
+                               
+                               if (after) {
+                                       ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
+                                       if (i != _processors.end ()) {
+                                               _processors.remove (_meter);
+                                               _processors.insert (i, _meter);
+                                       }
+                               } else if (_last_custom_meter_was_at_end) {
+                                       _processors.remove (_meter);
+                                       _processors.push_back (_meter);
+                               }
                        }
+               }
 
-                       _meter->reflect_inputs (m_in);
-
-                       /* we do not need to reconfigure the processors, because the meter
-                          (a) is always ready to handle processor_max_streams
-                          (b) is always an N-in/N-out processor, and thus moving
-                          it doesn't require any changes to the other processors.
-                       */
+               /* Set up the meter for its new position */
 
+               ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
+               
+               ChanCount m_in;
+               
+               if (loc == _processors.begin()) {
+                       m_in = _input->n_ports();
                } else {
-
-                       // just make it visible and let the user move it
-
-                       _meter->set_display_to_user (true);
+                       ProcessorList::iterator before = loc;
+                       --before;
+                       m_in = (*before)->output_streams ();
                }
+               
+               _meter->reflect_inputs (m_in);
+               
+               /* we do not need to reconfigure the processors, because the meter
+                  (a) is always ready to handle processor_max_streams
+                  (b) is always an N-in/N-out processor, and thus moving
+                  it doesn't require any changes to the other processors.
+               */
        }
 
        meter_change (); /* EMIT SIGNAL */
@@ -3286,6 +3292,38 @@ Route::set_name (const string& str)
        return ret;
 }
 
+/** Set the name of a route in an XML description.
+ *  @param node XML <Route> node to set the name in.
+ *  @param name New name.
+ */
+void
+Route::set_name_in_state (XMLNode& node, string const & name)
+{
+       node.add_property (X_("name"), name);
+
+       XMLNodeList children = node.children();
+       for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
+               
+               if ((*i)->name() == X_("IO")) {
+
+                       IO::set_name_in_state (**i, name);
+
+               } else if ((*i)->name() == X_("Processor")) {
+
+                       XMLProperty* role = (*i)->property (X_("role"));
+                       if (role && role->value() == X_("Main")) {
+                               (*i)->add_property (X_("name"), name);
+                       }
+                       
+               } else if ((*i)->name() == X_("Diskstream")) {
+
+                       (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
+                       (*i)->add_property (X_("name"), name);
+                       
+               }
+       }
+}
+
 boost::shared_ptr<Send>
 Route::internal_send_for (boost::shared_ptr<const Route> target) const
 {
@@ -3818,21 +3856,6 @@ Route::setup_invisible_processors ()
        }
 }
 
-bool
-Route::should_monitor () const
-{
-       switch (Config->get_monitoring_model()) {
-       case HardwareMonitoring:
-       case ExternalMonitoring:
-               return !record_enabled() || (_session.config.get_auto_input() && !_session.actively_recording());
-               break;
-       default:
-               break;
-       }
-
-       return true;
-}
-
 void
 Route::unpan ()
 {
@@ -3848,3 +3871,63 @@ Route::unpan ()
                }
        }
 }
+
+/** If the meter point is `Custom', make a note of where the meter is.
+ *  This is so that if the meter point is subsequently set to something else,
+ *  and then back to custom, we can put the meter back where it was last time
+ *  custom was enabled.
+ *
+ *  Must be called with the _processor_lock held.
+ */
+void
+Route::maybe_note_meter_position ()
+{
+       if (_meter_point != MeterCustom) {
+               return;
+       }
+       
+       _custom_meter_position_noted = true;
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
+                       ProcessorList::iterator j = i;
+                       ++j;
+                       if (j != _processors.end ()) {
+                               _processor_after_last_custom_meter = *j;
+                               _last_custom_meter_was_at_end = false;
+                       } else {
+                               _last_custom_meter_was_at_end = true;
+                       }
+               }
+       }
+}
+
+boost::shared_ptr<Processor>
+Route::processor_by_id (PBD::ID id) const
+{
+       Glib::RWLock::ReaderLock lm (_processor_lock);
+       for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               if ((*i)->id() == id) {
+                       return *i;
+               }
+       }
+
+       return boost::shared_ptr<Processor> ();
+}
+
+/** @return the monitoring state, or in other words what data we are pushing
+ *  into the route (data from the inputs, data from disk or silence)
+ */
+MonitorState
+Route::monitoring_state () const
+{
+       return MonitoringInput;
+}
+
+/** @return what we should be metering; either the data coming from the input
+ *  IO or the data that is flowing through the route.
+ */
+MeterState
+Route::metering_state () const
+{
+       return MeteringRoute;
+}