2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "libardour-config.h"
29 #include "pbd/xml++.h"
30 #include "pbd/enumwriter.h"
31 #include "pbd/memento_command.h"
32 #include "pbd/stacktrace.h"
33 #include "pbd/convert.h"
34 #include "pbd/boost_debug.h"
36 #include "evoral/Curve.hpp"
38 #include "ardour/amp.h"
39 #include "ardour/audio_port.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/buffer.h"
42 #include "ardour/buffer_set.h"
43 #include "ardour/configuration.h"
44 #include "ardour/cycle_timer.h"
45 #include "ardour/debug.h"
46 #include "ardour/delivery.h"
47 #include "ardour/dB.h"
48 #include "ardour/internal_send.h"
49 #include "ardour/internal_return.h"
50 #include "ardour/ladspa_plugin.h"
51 #include "ardour/meter.h"
52 #include "ardour/mix.h"
53 #include "ardour/monitor_processor.h"
54 #include "ardour/pannable.h"
55 #include "ardour/panner.h"
56 #include "ardour/panner_shell.h"
57 #include "ardour/plugin_insert.h"
58 #include "ardour/port.h"
59 #include "ardour/port_insert.h"
60 #include "ardour/processor.h"
61 #include "ardour/profile.h"
62 #include "ardour/route.h"
63 #include "ardour/route_group.h"
64 #include "ardour/send.h"
65 #include "ardour/session.h"
66 #include "ardour/timestamps.h"
67 #include "ardour/utils.h"
68 #include "ardour/graph.h"
69 #include "ardour/unknown_processor.h"
70 #include "ardour/capturing_processor.h"
75 using namespace ARDOUR;
78 uint32_t Route::order_key_cnt = 0;
79 PBD::Signal1<void,string const&> Route::SyncOrderKeys;
80 PBD::Signal0<void> Route::RemoteControlIDChange;
82 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
83 : SessionObject (sess, name)
85 , GraphNode( sess.route_graph )
91 , _pending_declick (true)
92 , _meter_point (MeterPostFader)
94 , _soloed_by_others_upstream (0)
95 , _soloed_by_others_downstream (0)
97 , _denormal_protection (false)
100 , _declickable (false)
101 , _mute_master (new MuteMaster (sess, name))
102 , _have_internal_generator (false)
104 , _default_type (default_type)
105 , _remote_control_id (0)
106 , _in_configure_processors (false)
108 processor_max_streams.reset();
109 order_keys[N_("signal")] = order_key_cnt++;
115 /* add standard controls */
117 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
118 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
120 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
121 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
123 add_control (_solo_control);
124 add_control (_mute_control);
128 Pannable* p = new Pannable (_session);
129 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
130 boost_debug_shared_ptr_mark_interesting (p, "Pannable");
134 /* input and output objects */
136 _input.reset (new IO (_session, _name, IO::Input, _default_type));
137 _output.reset (new IO (_session, _name, IO::Output, _default_type));
139 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
140 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
142 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
144 /* add amp processor */
146 _amp.reset (new Amp (_session));
147 add_processor (_amp, PostFader);
149 /* create standard processors: meter, main outs, monitor out;
150 they will be added to _processors by setup_invisible_processors ()
153 _meter.reset (new PeakMeter (_session));
154 _meter->set_display_to_user (false);
157 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
158 _main_outs->activate ();
161 /* where we listen to tracks */
162 _intreturn.reset (new InternalReturn (_session));
163 _intreturn->activate ();
165 /* the thing that provides proper control over a control/monitor/listen bus
166 (such as per-channel cut, dim, solo, invert, etc).
168 _monitor_control.reset (new MonitorProcessor (_session));
169 _monitor_control->activate ();
172 if (is_master() || is_monitor() || is_hidden()) {
173 _mute_master->set_solo_ignore (true);
176 /* now that we have _meter, its safe to connect to this */
178 Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
181 /* run a configure so that the invisible processors get set up */
182 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
183 configure_processors (0);
191 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
193 /* do this early so that we don't get incoming signals as we are going through destruction
198 /* don't use clear_processors here, as it depends on the session which may
199 be half-destroyed by now
202 Glib::RWLock::WriterLock lm (_processor_lock);
203 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
204 (*i)->drop_references ();
207 _processors.clear ();
211 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
213 if (id != _remote_control_id) {
214 _remote_control_id = id;
215 RemoteControlIDChanged ();
216 if (notify_class_listeners) {
217 RemoteControlIDChange ();
223 Route::remote_control_id() const
225 return _remote_control_id;
229 Route::order_key (std::string const & name) const
231 OrderKeys::const_iterator i = order_keys.find (name);
232 if (i == order_keys.end()) {
240 Route::set_order_key (std::string const & name, int32_t n)
242 bool changed = false;
244 /* This method looks more complicated than it should, but
245 it's important that we don't emit order_key_changed unless
246 it actually has, as expensive things happen on receipt of that
250 if (order_keys.find(name) == order_keys.end() || order_keys[name] != n) {
251 order_keys[name] = n;
255 if (Config->get_sync_all_route_ordering()) {
256 for (OrderKeys::iterator x = order_keys.begin(); x != order_keys.end(); ++x) {
257 if (x->second != n) {
265 order_key_changed (); /* EMIT SIGNAL */
266 _session.set_dirty ();
270 /** Set all order keys to be the same as that for `base', if such a key
271 * exists in this route.
272 * @param base Base key.
275 Route::sync_order_keys (std::string const & base)
277 if (order_keys.empty()) {
281 OrderKeys::iterator i;
284 if ((i = order_keys.find (base)) == order_keys.end()) {
285 /* key doesn't exist, use the first existing key (during session initialization) */
286 i = order_keys.begin();
290 /* key exists - use it and reset all others (actually, itself included) */
292 i = order_keys.begin();
295 bool changed = false;
297 for (; i != order_keys.end(); ++i) {
298 if (i->second != key) {
305 order_key_changed (); /* EMIT SIGNAL */
310 Route::ensure_track_or_route_name(string name, Session &session)
312 string newname = name;
314 while (!session.io_name_is_legal (newname)) {
315 newname = bump_name_once (newname, '.');
323 Route::inc_gain (gain_t fraction, void *src)
325 _amp->inc_gain (fraction, src);
329 Route::set_gain (gain_t val, void *src)
331 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
333 if (_route_group->is_relative()) {
335 gain_t usable_gain = _amp->gain();
336 if (usable_gain < 0.000001f) {
337 usable_gain = 0.000001f;
341 if (delta < 0.000001f) {
345 delta -= usable_gain;
350 gain_t factor = delta / usable_gain;
353 factor = _route_group->get_max_factor(factor);
354 if (factor == 0.0f) {
355 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
359 factor = _route_group->get_min_factor(factor);
360 if (factor == 0.0f) {
361 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
366 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
370 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
376 if (val == _amp->gain()) {
380 _amp->set_gain (val, src);
384 Route::maybe_declick (BufferSet&, framecnt_t, int)
386 /* this is the "bus" implementation and they never declick.
391 /** Process this route for one (sub) cycle (process thread)
393 * @param bufs Scratch buffers to use for the signal path
394 * @param start_frame Initial transport frame
395 * @param end_frame Final transport frame
396 * @param nframes Number of frames to output (to ports)
398 * Note that (end_frame - start_frame) may not be equal to nframes when the
399 * transport speed isn't 1.0 (eg varispeed).
402 Route::process_output_buffers (BufferSet& bufs,
403 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
404 bool /*with_processors*/, int declick,
405 bool gain_automation_ok)
407 bool monitor = should_monitor ();
409 bufs.is_silent (false);
411 /* figure out if we're going to use gain automation */
412 if (gain_automation_ok) {
413 _amp->setup_gain_automation (start_frame, end_frame, nframes);
415 _amp->apply_gain_automation (false);
418 /* tell main outs what to do about monitoring */
419 _main_outs->no_outs_cuz_we_no_monitor (!monitor);
422 /* -------------------------------------------------------------------------------------------
423 GLOBAL DECLICK (for transport changes etc.)
424 ----------------------------------------------------------------------------------------- */
426 maybe_declick (bufs, nframes, declick);
427 _pending_declick = 0;
429 /* -------------------------------------------------------------------------------------------
430 DENORMAL CONTROL/PHASE INVERT
431 ----------------------------------------------------------------------------------------- */
433 if (_phase_invert.any ()) {
437 if (_denormal_protection || Config->get_denormal_protection()) {
439 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
440 Sample* const sp = i->data();
442 if (_phase_invert[chn]) {
443 for (pframes_t nx = 0; nx < nframes; ++nx) {
448 for (pframes_t nx = 0; nx < nframes; ++nx) {
456 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
457 Sample* const sp = i->data();
459 if (_phase_invert[chn]) {
460 for (pframes_t nx = 0; nx < nframes; ++nx) {
469 if (_denormal_protection || Config->get_denormal_protection()) {
471 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
472 Sample* const sp = i->data();
473 for (pframes_t nx = 0; nx < nframes; ++nx) {
481 /* -------------------------------------------------------------------------------------------
483 ----------------------------------------------------------------------------------------- */
485 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
487 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
492 /* if it has any inputs, make sure they match */
493 if ((*i)->input_streams() != ChanCount::ZERO) {
494 if (bufs.count() != (*i)->input_streams()) {
495 cerr << _name << " bufs = " << bufs.count()
496 << " input for " << (*i)->name() << " = " << (*i)->input_streams()
502 /* should we NOT run plugins here if the route is inactive?
503 do we catch route != active somewhere higher?
506 (*i)->run (bufs, start_frame, end_frame, nframes, *i != _processors.back());
507 bufs.set_count ((*i)->output_streams());
512 Route::n_process_buffers ()
514 return max (_input->n_ports(), processor_max_streams);
518 Route::passthru (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
520 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
524 assert (bufs.available() >= input_streams());
526 if (_input->n_ports() == ChanCount::ZERO) {
527 silence_unlocked (nframes);
530 bufs.set_count (input_streams());
532 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
534 /* control/monitor bus ignores input ports when something is
535 feeding the listen "stream". data will "arrive" into the
536 route from the intreturn processor element.
538 bufs.silence (nframes, 0);
542 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
544 BufferSet::iterator o = bufs.begin(*t);
545 PortSet& ports (_input->ports());
547 for (PortSet::iterator i = ports.begin(*t); i != ports.end(*t); ++i, ++o) {
548 o->read_from (i->get_buffer(nframes), nframes);
553 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
554 process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, true);
558 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
560 BufferSet& bufs (_session.get_silent_buffers (n_process_buffers()));
561 bufs.set_count (_input->n_ports());
562 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
563 process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, false);
567 Route::set_listen (bool yn, void* src)
574 if (yn != _monitor_send->active()) {
576 _monitor_send->activate ();
577 _mute_master->set_soloed (true);
579 _monitor_send->deactivate ();
580 _mute_master->set_soloed (false);
583 listen_changed (src); /* EMIT SIGNAL */
589 Route::listening_via_monitor () const
592 return _monitor_send->active ();
599 Route::set_solo_safe (bool yn, void *src)
601 if (_solo_safe != yn) {
603 solo_safe_changed (src);
608 Route::solo_safe() const
614 Route::set_solo (bool yn, void *src)
620 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
621 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
625 if (self_soloed() != yn) {
627 set_mute_master_solo ();
628 solo_changed (true, src); /* EMIT SIGNAL */
629 _solo_control->Changed (); /* EMIT SIGNAL */
634 Route::set_self_solo (bool yn)
640 Route::mod_solo_by_others_upstream (int32_t delta)
646 uint32_t old_sbu = _soloed_by_others_upstream;
649 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
650 _soloed_by_others_upstream += delta;
652 _soloed_by_others_upstream = 0;
655 _soloed_by_others_upstream += delta;
658 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
659 name(), delta, _soloed_by_others_upstream, old_sbu,
660 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
662 /* push the inverse solo change to everything that feeds us.
664 This is important for solo-within-group. When we solo 1 track out of N that
665 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
666 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
667 tracks that feed it. This will silence them if they were audible because
668 of a bus solo, but the newly soloed track will still be audible (because
671 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
675 if ((_self_solo || _soloed_by_others_downstream) &&
676 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
677 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
679 if (delta > 0 || !Config->get_exclusive_solo()) {
680 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
681 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
682 boost::shared_ptr<Route> sr = i->r.lock();
684 sr->mod_solo_by_others_downstream (-delta);
690 set_mute_master_solo ();
691 solo_changed (false, this);
695 Route::mod_solo_by_others_downstream (int32_t delta)
702 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
703 _soloed_by_others_downstream += delta;
705 _soloed_by_others_downstream = 0;
708 _soloed_by_others_downstream += delta;
711 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
713 set_mute_master_solo ();
714 solo_changed (false, this);
718 Route::set_mute_master_solo ()
720 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
724 Route::set_solo_isolated (bool yn, void *src)
726 if (is_master() || is_monitor() || is_hidden()) {
730 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
731 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
735 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
737 boost::shared_ptr<RouteList> routes = _session.get_routes ();
738 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
740 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
745 bool does_feed = direct_feeds (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
747 if (does_feed && !sends_only) {
748 (*i)->set_solo_isolated (yn, (*i)->route_group());
752 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
754 bool changed = false;
757 if (_solo_isolated == 0) {
758 _mute_master->set_solo_ignore (true);
763 if (_solo_isolated > 0) {
765 if (_solo_isolated == 0) {
766 _mute_master->set_solo_ignore (false);
773 solo_isolated_changed (src);
778 Route::solo_isolated () const
780 return _solo_isolated > 0;
784 Route::set_mute_points (MuteMaster::MutePoint mp)
786 _mute_master->set_mute_points (mp);
787 mute_points_changed (); /* EMIT SIGNAL */
789 if (_mute_master->muted_by_self()) {
790 mute_changed (this); /* EMIT SIGNAL */
791 _mute_control->Changed (); /* EMIT SIGNAL */
796 Route::set_mute (bool yn, void *src)
798 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
799 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
804 _mute_master->set_muted_by_self (yn);
805 mute_changed (src); /* EMIT SIGNAL */
806 _mute_control->Changed (); /* EMIT SIGNAL */
811 Route::muted () const
813 return _mute_master->muted_by_self();
818 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
820 cerr << name << " {" << endl;
821 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
822 p != procs.end(); ++p) {
823 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << endl;
830 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err)
832 ProcessorList::iterator loc;
834 /* XXX this is not thread safe - we don't hold the lock across determining the iter
835 to add before and actually doing the insertion. dammit.
838 if (placement == PreFader) {
839 /* generic pre-fader: insert immediately before the amp */
840 loc = find (_processors.begin(), _processors.end(), _amp);
842 /* generic post-fader: insert right before the main outs */
843 loc = find (_processors.begin(), _processors.end(), _main_outs);
846 return add_processor (processor, loc, err);
850 /** Add a processor to the route.
851 * @param iter an iterator in _processors; the new processor will be inserted immediately before this location.
854 Route::add_processor (boost::shared_ptr<Processor> processor, ProcessorList::iterator iter, ProcessorStreams* err, bool activation_allowed)
856 assert (processor != _meter);
857 assert (processor != _main_outs);
859 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1 adding processor %2\n", name(), processor->name()));
861 ChanCount old_pms = processor_max_streams;
863 if (!_session.engine().connected() || !processor) {
868 Glib::RWLock::WriterLock lm (_processor_lock);
869 ProcessorState pstate (this);
871 boost::shared_ptr<PluginInsert> pi;
872 boost::shared_ptr<PortInsert> porti;
874 ProcessorList::iterator loc = find(_processors.begin(), _processors.end(), processor);
876 if (processor == _amp) {
877 // Ensure only one amp is in the list at any time
878 if (loc != _processors.end()) {
879 if (iter == loc) { // Already in place, do nothing
881 } else { // New position given, relocate
882 _processors.erase (loc);
887 if (loc != _processors.end()) {
888 cerr << "ERROR: Processor added to route twice!" << endl;
895 _processors.insert (loc, processor);
897 // Set up processor list channels. This will set processor->[input|output]_streams(),
898 // configure redirect ports properly, etc.
901 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
903 if (configure_processors_unlocked (err)) {
905 configure_processors_unlocked (0); // it worked before we tried to add it ...
910 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
912 if (pi->natural_input_streams() == ChanCount::ZERO) {
913 /* generator plugin */
914 _have_internal_generator = true;
919 if (activation_allowed) {
920 processor->activate ();
923 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false, false, false));
925 _output->set_user_latency (0);
928 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
929 set_processor_positions ();
935 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
937 const XMLProperty *prop;
940 boost::shared_ptr<Processor> processor;
942 /* bit of a hack: get the `placement' property from the <Redirect> tag here
943 so that we can add the processor in the right place (pre/post-fader)
946 XMLNodeList const & children = node.children ();
947 XMLNodeList::const_iterator i = children.begin ();
949 while (i != children.end() && (*i)->name() != X_("Redirect")) {
953 Placement placement = PreFader;
955 if (i != children.end()) {
956 if ((prop = (*i)->property (X_("placement"))) != 0) {
957 placement = Placement (string_2_enum (prop->value(), placement));
961 if (node.name() == "Insert") {
963 if ((prop = node.property ("type")) != 0) {
965 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
966 prop->value() == "lv2" ||
967 prop->value() == "vst" ||
968 prop->value() == "audiounit") {
970 processor.reset (new PluginInsert (_session));
974 processor.reset (new PortInsert (_session, _pannable, _mute_master));
979 } else if (node.name() == "Send") {
981 processor.reset (new Send (_session, _pannable, _mute_master));
985 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
989 if (processor->set_state (node, version)) {
993 return (add_processor (processor, placement) == 0);
996 catch (failed_constructor &err) {
997 warning << _("processor could not be created. Ignored.") << endmsg;
1003 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1005 /* NOTE: this is intended to be used ONLY when copying
1006 processors from another Route. Hence the subtle
1007 differences between this and ::add_processor()
1010 ProcessorList::iterator loc;
1013 loc = find(_processors.begin(), _processors.end(), before);
1015 /* nothing specified - at end */
1016 loc = _processors.end ();
1019 ChanCount old_pms = processor_max_streams;
1021 if (!_session.engine().connected()) {
1025 if (others.empty()) {
1030 Glib::RWLock::WriterLock lm (_processor_lock);
1031 ProcessorState pstate (this);
1033 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1039 boost::shared_ptr<PluginInsert> pi;
1041 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1045 ProcessorList::iterator inserted = _processors.insert (loc, *i);
1047 if ((*i)->active()) {
1052 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1053 if (configure_processors_unlocked (err)) {
1055 configure_processors_unlocked (0); // it worked before we tried to add it ...
1060 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false, false, false));
1063 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1064 boost::shared_ptr<PluginInsert> pi;
1066 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1067 if (pi->is_generator()) {
1068 _have_internal_generator = true;
1074 _output->set_user_latency (0);
1077 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1078 set_processor_positions ();
1084 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1086 if (p == PreFader) {
1087 start = _processors.begin();
1088 end = find(_processors.begin(), _processors.end(), _amp);
1090 start = find(_processors.begin(), _processors.end(), _amp);
1092 end = _processors.end();
1096 /** Turn off all processors with a given placement
1097 * @param p Placement of processors to disable
1100 Route::disable_processors (Placement p)
1102 Glib::RWLock::ReaderLock lm (_processor_lock);
1104 ProcessorList::iterator start, end;
1105 placement_range(p, start, end);
1107 for (ProcessorList::iterator i = start; i != end; ++i) {
1108 (*i)->deactivate ();
1111 _session.set_dirty ();
1114 /** Turn off all redirects
1117 Route::disable_processors ()
1119 Glib::RWLock::ReaderLock lm (_processor_lock);
1121 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1122 (*i)->deactivate ();
1125 _session.set_dirty ();
1128 /** Turn off all redirects with a given placement
1129 * @param p Placement of redirects to disable
1132 Route::disable_plugins (Placement p)
1134 Glib::RWLock::ReaderLock lm (_processor_lock);
1136 ProcessorList::iterator start, end;
1137 placement_range(p, start, end);
1139 for (ProcessorList::iterator i = start; i != end; ++i) {
1140 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1141 (*i)->deactivate ();
1145 _session.set_dirty ();
1148 /** Turn off all plugins
1151 Route::disable_plugins ()
1153 Glib::RWLock::ReaderLock lm (_processor_lock);
1155 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1156 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1157 (*i)->deactivate ();
1161 _session.set_dirty ();
1166 Route::ab_plugins (bool forward)
1168 Glib::RWLock::ReaderLock lm (_processor_lock);
1172 /* forward = turn off all active redirects, and mark them so that the next time
1173 we go the other way, we will revert them
1176 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1177 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1181 if ((*i)->active()) {
1182 (*i)->deactivate ();
1183 (*i)->set_next_ab_is_active (true);
1185 (*i)->set_next_ab_is_active (false);
1191 /* backward = if the redirect was marked to go active on the next ab, do so */
1193 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1195 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1199 if ((*i)->get_next_ab_is_active()) {
1202 (*i)->deactivate ();
1207 _session.set_dirty ();
1211 /** Remove processors with a given placement.
1212 * @param p Placement of processors to remove.
1215 Route::clear_processors (Placement p)
1217 const ChanCount old_pms = processor_max_streams;
1219 if (!_session.engine().connected()) {
1223 bool already_deleting = _session.deletion_in_progress();
1224 if (!already_deleting) {
1225 _session.set_deletion_in_progress();
1229 Glib::RWLock::WriterLock lm (_processor_lock);
1230 ProcessorList new_list;
1231 ProcessorStreams err;
1232 bool seen_amp = false;
1234 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1240 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1242 /* you can't remove these */
1244 new_list.push_back (*i);
1251 new_list.push_back (*i);
1254 (*i)->drop_references ();
1262 (*i)->drop_references ();
1265 new_list.push_back (*i);
1272 _processors = new_list;
1275 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1276 configure_processors_unlocked (&err); // this can't fail
1280 processor_max_streams.reset();
1281 _have_internal_generator = false;
1282 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1283 set_processor_positions ();
1285 if (!already_deleting) {
1286 _session.clear_deletion_in_progress();
1291 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err)
1293 /* these can never be removed */
1295 if (processor == _amp || processor == _meter || processor == _main_outs) {
1299 ChanCount old_pms = processor_max_streams;
1301 if (!_session.engine().connected()) {
1305 processor_max_streams.reset();
1308 Glib::RWLock::WriterLock lm (_processor_lock);
1309 ProcessorState pstate (this);
1311 ProcessorList::iterator i;
1312 bool removed = false;
1314 for (i = _processors.begin(); i != _processors.end(); ) {
1315 if (*i == processor) {
1317 /* move along, see failure case for configure_processors()
1318 where we may need to reconfigure the processor.
1321 /* stop redirects that send signals to JACK ports
1322 from causing noise as a result of no longer being
1326 boost::shared_ptr<IOProcessor> iop;
1328 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1330 iop->input()->disconnect (this);
1332 if (iop->output()) {
1333 iop->output()->disconnect (this);
1337 i = _processors.erase (i);
1345 _output->set_user_latency (0);
1354 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1356 if (configure_processors_unlocked (err)) {
1358 /* we know this will work, because it worked before :) */
1359 configure_processors_unlocked (0);
1364 _have_internal_generator = false;
1366 for (i = _processors.begin(); i != _processors.end(); ++i) {
1367 boost::shared_ptr<PluginInsert> pi;
1369 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1370 if (pi->is_generator()) {
1371 _have_internal_generator = true;
1378 processor->drop_references ();
1379 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1380 set_processor_positions ();
1386 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1388 ProcessorList deleted;
1390 if (!_session.engine().connected()) {
1394 processor_max_streams.reset();
1397 Glib::RWLock::WriterLock lm (_processor_lock);
1398 ProcessorState pstate (this);
1400 ProcessorList::iterator i;
1401 boost::shared_ptr<Processor> processor;
1403 for (i = _processors.begin(); i != _processors.end(); ) {
1407 /* these can never be removed */
1409 if (processor == _amp || processor == _meter || processor == _main_outs) {
1414 /* see if its in the list of processors to delete */
1416 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1421 /* stop IOProcessors that send to JACK ports
1422 from causing noise as a result of no longer being
1426 boost::shared_ptr<IOProcessor> iop;
1428 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1432 deleted.push_back (processor);
1433 i = _processors.erase (i);
1436 if (deleted.empty()) {
1437 /* none of those in the requested list were found */
1441 _output->set_user_latency (0);
1444 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1446 if (configure_processors_unlocked (err)) {
1448 /* we know this will work, because it worked before :) */
1449 configure_processors_unlocked (0);
1454 _have_internal_generator = false;
1456 for (i = _processors.begin(); i != _processors.end(); ++i) {
1457 boost::shared_ptr<PluginInsert> pi;
1459 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1460 if (pi->is_generator()) {
1461 _have_internal_generator = true;
1468 /* now try to do what we need to so that those that were removed will be deleted */
1470 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1471 (*i)->drop_references ();
1474 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1475 set_processor_positions ();
1480 /** Caller must hold process lock */
1482 Route::configure_processors (ProcessorStreams* err)
1484 assert (!AudioEngine::instance()->process_lock().trylock());
1486 if (!_in_configure_processors) {
1487 Glib::RWLock::WriterLock lm (_processor_lock);
1488 return configure_processors_unlocked (err);
1495 Route::input_streams () const
1497 return _input->n_ports ();
1500 list<pair<ChanCount, ChanCount> >
1501 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1503 Glib::RWLock::ReaderLock lm (_processor_lock);
1505 return try_configure_processors_unlocked (in, err);
1508 list<pair<ChanCount, ChanCount> >
1509 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1511 // Check each processor in order to see if we can configure as requested
1513 list<pair<ChanCount, ChanCount> > configuration;
1516 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1517 DEBUG_TRACE (DEBUG::Processors, "{\n");
1519 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1521 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1522 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1526 if ((*p)->can_support_io_configuration(in, out)) {
1527 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1528 configuration.push_back(make_pair(in, out));
1535 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1536 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1537 DEBUG_TRACE (DEBUG::Processors, "}\n");
1538 return list<pair<ChanCount, ChanCount> > ();
1542 DEBUG_TRACE (DEBUG::Processors, "}\n");
1544 return configuration;
1547 /** Set the input/output configuration of each processor in the processors list.
1548 * Caller must hold process lock.
1549 * Return 0 on success, otherwise configuration is impossible.
1552 Route::configure_processors_unlocked (ProcessorStreams* err)
1554 assert (!AudioEngine::instance()->process_lock().trylock());
1556 if (_in_configure_processors) {
1560 /* put invisible processors where they should be */
1561 setup_invisible_processors ();
1563 _in_configure_processors = true;
1565 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1567 if (configuration.empty ()) {
1568 _in_configure_processors = false;
1574 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1575 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1577 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1581 (*p)->configure_io(c->first, c->second);
1582 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1583 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1588 _meter->reset_max_channels (processor_max_streams);
1591 /* make sure we have sufficient scratch buffers to cope with the new processor
1593 _session.ensure_buffers (n_process_buffers ());
1595 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1597 _in_configure_processors = false;
1602 Route::all_processors_flip ()
1604 Glib::RWLock::ReaderLock lm (_processor_lock);
1606 if (_processors.empty()) {
1610 bool first_is_on = _processors.front()->active();
1612 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1614 (*i)->deactivate ();
1620 _session.set_dirty ();
1623 /** Set all processors with a given placement to a given active state.
1624 * @param p Placement of processors to change.
1625 * @param state New active state for those processors.
1628 Route::all_processors_active (Placement p, bool state)
1630 Glib::RWLock::ReaderLock lm (_processor_lock);
1632 if (_processors.empty()) {
1635 ProcessorList::iterator start, end;
1636 placement_range(p, start, end);
1638 bool before_amp = true;
1639 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1644 if (p == PreFader && before_amp) {
1648 (*i)->deactivate ();
1653 _session.set_dirty ();
1657 Route::processor_is_prefader (boost::shared_ptr<Processor> p)
1659 bool pre_fader = true;
1660 Glib::RWLock::ReaderLock lm (_processor_lock);
1662 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1664 /* semantic note: if p == amp, we want to return true, so test
1665 for equality before checking if this is the amp
1682 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1684 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1685 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1686 processors in the current actual processor list that are hidden. Any visible processors
1687 in the current list but not in "new_order" will be assumed to be deleted.
1691 Glib::RWLock::WriterLock lm (_processor_lock);
1692 ProcessorState pstate (this);
1694 ProcessorList::iterator oiter;
1695 ProcessorList::const_iterator niter;
1696 ProcessorList as_it_will_be;
1698 oiter = _processors.begin();
1699 niter = new_order.begin();
1701 while (niter != new_order.end()) {
1703 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1704 then append it to the temp list.
1706 Otherwise, see if the next processor in the old list is in the new list. if not,
1707 its been deleted. If its there, append it to the temp list.
1710 if (oiter == _processors.end()) {
1712 /* no more elements in the old list, so just stick the rest of
1713 the new order onto the temp list.
1716 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1717 while (niter != new_order.end()) {
1724 if (!(*oiter)->display_to_user()) {
1726 as_it_will_be.push_back (*oiter);
1730 /* visible processor: check that its in the new order */
1732 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1733 /* deleted: do nothing, shared_ptr<> will clean up */
1735 /* ignore this one, and add the next item from the new order instead */
1736 as_it_will_be.push_back (*niter);
1741 /* now remove from old order - its taken care of no matter what */
1742 oiter = _processors.erase (oiter);
1747 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1750 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1752 if (configure_processors_unlocked (err)) {
1759 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1760 set_processor_positions ();
1772 Route::get_template()
1774 return state(false);
1778 Route::state(bool full_state)
1780 XMLNode *node = new XMLNode("Route");
1781 ProcessorList::iterator i;
1784 id().print (buf, sizeof (buf));
1785 node->add_property("id", buf);
1786 node->add_property ("name", _name);
1787 node->add_property("default-type", _default_type.to_string());
1790 node->add_property("flags", enum_2_string (_flags));
1793 node->add_property("active", _active?"yes":"no");
1795 boost::to_string (_phase_invert, p);
1796 node->add_property("phase-invert", p);
1797 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1798 node->add_property("meter-point", enum_2_string (_meter_point));
1801 node->add_property("route-group", _route_group->name());
1804 string order_string;
1805 OrderKeys::iterator x = order_keys.begin();
1807 while (x != order_keys.end()) {
1808 order_string += string ((*x).first);
1809 order_string += '=';
1810 snprintf (buf, sizeof(buf), "%ld", (*x).second);
1811 order_string += buf;
1815 if (x == order_keys.end()) {
1819 order_string += ':';
1821 node->add_property ("order-keys", order_string);
1822 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1823 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1824 node->add_property ("soloed-by-upstream", buf);
1825 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1826 node->add_property ("soloed-by-downstream", buf);
1827 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1828 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1830 node->add_child_nocopy (_input->state (full_state));
1831 node->add_child_nocopy (_output->state (full_state));
1832 node->add_child_nocopy (_solo_control->get_state ());
1833 node->add_child_nocopy (_mute_control->get_state ());
1834 node->add_child_nocopy (_mute_master->get_state ());
1836 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1837 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1838 remote_control_node->add_property (X_("id"), buf);
1839 node->add_child_nocopy (*remote_control_node);
1841 if (_comment.length()) {
1842 XMLNode *cmt = node->add_child ("Comment");
1843 cmt->add_content (_comment);
1846 node->add_child_nocopy (_pannable->state (full_state));
1848 for (i = _processors.begin(); i != _processors.end(); ++i) {
1849 node->add_child_nocopy((*i)->state (full_state));
1853 node->add_child_copy (*_extra_xml);
1860 Route::set_state (const XMLNode& node, int version)
1862 return _set_state (node, version, true);
1866 Route::_set_state (const XMLNode& node, int version, bool /*call_base*/)
1868 if (version < 3000) {
1869 return _set_state_2X (node, version);
1873 XMLNodeConstIterator niter;
1875 const XMLProperty *prop;
1877 if (node.name() != "Route"){
1878 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
1882 if ((prop = node.property (X_("name"))) != 0) {
1883 Route::set_name (prop->value());
1886 if ((prop = node.property ("id")) != 0) {
1887 _id = prop->value ();
1890 if ((prop = node.property (X_("flags"))) != 0) {
1891 _flags = Flag (string_2_enum (prop->value(), _flags));
1896 if (is_master() || is_monitor() || is_hidden()) {
1897 _mute_master->set_solo_ignore (true);
1900 /* add all processors (except amp, which is always present) */
1902 nlist = node.children();
1903 XMLNode processor_state (X_("processor_state"));
1905 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1909 if (child->name() == IO::state_node_name) {
1910 if ((prop = child->property (X_("direction"))) == 0) {
1914 if (prop->value() == "Input") {
1915 _input->set_state (*child, version);
1916 } else if (prop->value() == "Output") {
1917 _output->set_state (*child, version);
1921 if (child->name() == X_("Processor")) {
1922 processor_state.add_child_copy (*child);
1926 if (child->name() == X_("Pannable")) {
1927 _pannable->set_state (*child, version);
1931 set_processor_state (processor_state);
1933 if ((prop = node.property ("self-solo")) != 0) {
1934 set_self_solo (string_is_affirmative (prop->value()));
1937 if ((prop = node.property ("soloed-by-upstream")) != 0) {
1938 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
1939 mod_solo_by_others_upstream (atoi (prop->value()));
1942 if ((prop = node.property ("soloed-by-downstream")) != 0) {
1943 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
1944 mod_solo_by_others_downstream (atoi (prop->value()));
1947 if ((prop = node.property ("solo-isolated")) != 0) {
1948 set_solo_isolated (string_is_affirmative (prop->value()), this);
1951 if ((prop = node.property ("solo-safe")) != 0) {
1952 set_solo_safe (string_is_affirmative (prop->value()), this);
1955 if ((prop = node.property (X_("phase-invert"))) != 0) {
1956 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
1959 if ((prop = node.property (X_("denormal-protection"))) != 0) {
1960 set_denormal_protection (string_is_affirmative (prop->value()));
1963 if ((prop = node.property (X_("active"))) != 0) {
1964 bool yn = string_is_affirmative (prop->value());
1965 _active = !yn; // force switch
1966 set_active (yn, this);
1969 if ((prop = node.property (X_("meter-point"))) != 0) {
1970 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
1971 set_meter_point (mp, true);
1973 _meter->set_display_to_user (_meter_point == MeterCustom);
1977 if ((prop = node.property (X_("order-keys"))) != 0) {
1981 string::size_type colon, equal;
1982 string remaining = prop->value();
1984 while (remaining.length()) {
1986 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
1987 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
1990 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
1991 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
1994 set_order_key (remaining.substr (0, equal), n);
1998 colon = remaining.find_first_of (':');
2000 if (colon != string::npos) {
2001 remaining = remaining.substr (colon+1);
2008 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2011 if (child->name() == X_("Comment")) {
2013 /* XXX this is a terrible API design in libxml++ */
2015 XMLNode *cmt = *(child->children().begin());
2016 _comment = cmt->content();
2018 } else if (child->name() == X_("Extra")) {
2020 _extra_xml = new XMLNode (*child);
2022 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2023 if (prop->value() == "solo") {
2024 _solo_control->set_state (*child, version);
2027 } else if (child->name() == X_("RemoteControl")) {
2028 if ((prop = child->property (X_("id"))) != 0) {
2030 sscanf (prop->value().c_str(), "%d", &x);
2031 set_remote_control_id (x);
2034 } else if (child->name() == X_("MuteMaster")) {
2035 _mute_master->set_state (*child, version);
2043 Route::_set_state_2X (const XMLNode& node, int version)
2046 XMLNodeConstIterator niter;
2048 const XMLProperty *prop;
2050 /* 2X things which still remain to be handled:
2056 if (node.name() != "Route") {
2057 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2061 if ((prop = node.property (X_("flags"))) != 0) {
2062 _flags = Flag (string_2_enum (prop->value(), _flags));
2067 if ((prop = node.property (X_("phase-invert"))) != 0) {
2068 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2069 if (string_is_affirmative (prop->value ())) {
2072 set_phase_invert (p);
2075 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2076 set_denormal_protection (string_is_affirmative (prop->value()));
2079 if ((prop = node.property (X_("soloed"))) != 0) {
2080 bool yn = string_is_affirmative (prop->value());
2082 /* XXX force reset of solo status */
2084 set_solo (yn, this);
2087 if ((prop = node.property (X_("muted"))) != 0) {
2090 bool muted = string_is_affirmative (prop->value());
2096 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2098 if (string_is_affirmative (prop->value())){
2099 mute_point = mute_point + "PreFader";
2104 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2106 if (string_is_affirmative (prop->value())){
2109 mute_point = mute_point + ",";
2112 mute_point = mute_point + "PostFader";
2117 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2119 if (string_is_affirmative (prop->value())){
2122 mute_point = mute_point + ",";
2125 mute_point = mute_point + "Listen";
2130 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2132 if (string_is_affirmative (prop->value())){
2135 mute_point = mute_point + ",";
2138 mute_point = mute_point + "Main";
2142 _mute_master->set_mute_points (mute_point);
2143 _mute_master->set_muted_by_self (true);
2147 if ((prop = node.property (X_("meter-point"))) != 0) {
2148 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2151 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2152 don't mean the same thing.
2155 if ((prop = node.property (X_("order-keys"))) != 0) {
2159 string::size_type colon, equal;
2160 string remaining = prop->value();
2162 while (remaining.length()) {
2164 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2165 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2168 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2169 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2172 set_order_key (remaining.substr (0, equal), n);
2176 colon = remaining.find_first_of (':');
2178 if (colon != string::npos) {
2179 remaining = remaining.substr (colon+1);
2188 nlist = node.children ();
2189 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2193 if (child->name() == IO::state_node_name) {
2195 /* there is a note in IO::set_state_2X() about why we have to call
2199 _input->set_state_2X (*child, version, true);
2200 _output->set_state_2X (*child, version, false);
2202 if ((prop = child->property (X_("name"))) != 0) {
2203 Route::set_name (prop->value ());
2206 if ((prop = child->property (X_("id"))) != 0) {
2207 _id = prop->value ();
2210 if ((prop = child->property (X_("active"))) != 0) {
2211 bool yn = string_is_affirmative (prop->value());
2212 _active = !yn; // force switch
2213 set_active (yn, this);
2216 if ((prop = child->property (X_("gain"))) != 0) {
2219 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2220 _amp->gain_control()->set_value (val);
2224 /* Set up Panners in the IO */
2225 XMLNodeList io_nlist = child->children ();
2227 XMLNodeConstIterator io_niter;
2230 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2232 io_child = *io_niter;
2234 if (io_child->name() == X_("Panner")) {
2235 _main_outs->panner_shell()->set_state(*io_child, version);
2236 } else if (io_child->name() == X_("Automation")) {
2237 /* IO's automation is for the fader */
2238 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2244 XMLNodeList redirect_nodes;
2246 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2250 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2251 redirect_nodes.push_back(child);
2256 set_processor_state_2X (redirect_nodes, version);
2258 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2261 if (child->name() == X_("Comment")) {
2263 /* XXX this is a terrible API design in libxml++ */
2265 XMLNode *cmt = *(child->children().begin());
2266 _comment = cmt->content();
2268 } else if (child->name() == X_("extra")) {
2270 _extra_xml = new XMLNode (*child);
2272 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2273 if (prop->value() == X_("solo")) {
2274 _solo_control->set_state (*child, version);
2275 } else if (prop->value() == X_("mute")) {
2276 _mute_control->set_state (*child, version);
2279 } else if (child->name() == X_("RemoteControl")) {
2280 if ((prop = child->property (X_("id"))) != 0) {
2282 sscanf (prop->value().c_str(), "%d", &x);
2283 set_remote_control_id (x);
2293 Route::get_processor_state ()
2295 XMLNode* root = new XMLNode (X_("redirects"));
2296 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2297 root->add_child_nocopy ((*i)->state (true));
2304 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2306 /* We don't bother removing existing processors not in nList, as this
2307 method will only be called when creating a Route from scratch, not
2308 for undo purposes. Just put processors in at the appropriate place
2312 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2313 add_processor_from_xml_2X (**i, version);
2318 Route::set_processor_state (const XMLNode& node)
2320 const XMLNodeList &nlist = node.children();
2321 XMLNodeConstIterator niter;
2322 ProcessorList new_order;
2323 bool must_configure = false;
2325 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2327 XMLProperty* prop = (*niter)->property ("type");
2329 if (prop->value() == "amp") {
2330 _amp->set_state (**niter, Stateful::current_state_version);
2331 new_order.push_back (_amp);
2332 } else if (prop->value() == "meter") {
2333 _meter->set_state (**niter, Stateful::current_state_version);
2334 } else if (prop->value() == "main-outs") {
2335 _main_outs->set_state (**niter, Stateful::current_state_version);
2336 } else if (prop->value() == "intreturn") {
2338 _intreturn.reset (new InternalReturn (_session));
2339 must_configure = true;
2341 _intreturn->set_state (**niter, Stateful::current_state_version);
2342 } else if (is_monitor() && prop->value() == "monitor") {
2343 if (!_monitor_control) {
2344 _monitor_control.reset (new MonitorProcessor (_session));
2345 must_configure = true;
2347 _monitor_control->set_state (**niter, Stateful::current_state_version);
2348 } else if (prop->value() == "capture") {
2349 _capturing_processor.reset (new CapturingProcessor (_session));
2351 ProcessorList::iterator o;
2353 for (o = _processors.begin(); o != _processors.end(); ++o) {
2354 XMLProperty* id_prop = (*niter)->property(X_("id"));
2355 if (id_prop && (*o)->id() == id_prop->value()) {
2356 (*o)->set_state (**niter, Stateful::current_state_version);
2357 new_order.push_back (*o);
2362 // If the processor (*niter) is not on the route then create it
2364 if (o == _processors.end()) {
2366 boost::shared_ptr<Processor> processor;
2368 if (prop->value() == "intsend") {
2370 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2371 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2372 prop->value() == "lv2" ||
2373 prop->value() == "vst" ||
2374 prop->value() == "audiounit") {
2376 processor.reset (new PluginInsert(_session));
2378 } else if (prop->value() == "port") {
2380 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2382 } else if (prop->value() == "send") {
2384 processor.reset (new Send (_session, _pannable, _mute_master));
2387 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2391 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2392 /* This processor could not be configured. Turn it into a UnknownProcessor */
2393 processor.reset (new UnknownProcessor (_session, **niter));
2396 /* we have to note the monitor send here, otherwise a new one will be created
2397 and the state of this one will be lost.
2399 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2400 if (isend && isend->role() == Delivery::Listen) {
2401 _monitor_send = isend;
2404 /* it doesn't matter if invisible processors are added here, as they
2405 will be sorted out by setup_invisible_processors () shortly.
2408 new_order.push_back (processor);
2409 must_configure = true;
2415 Glib::RWLock::WriterLock lm (_processor_lock);
2416 _processors = new_order;
2418 if (must_configure) {
2419 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2420 configure_processors_unlocked (0);
2423 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2425 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false, false, false));
2427 boost::shared_ptr<PluginInsert> pi;
2429 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2430 if (pi->is_generator()) {
2431 _have_internal_generator = true;
2438 processors_changed (RouteProcessorChange ());
2439 set_processor_positions ();
2443 Route::curve_reallocate ()
2445 // _gain_automation_curve.finish_resize ();
2446 // _pan_automation_curve.finish_resize ();
2450 Route::silence (framecnt_t nframes)
2452 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2457 silence_unlocked (nframes);
2461 Route::silence_unlocked (framecnt_t nframes)
2463 /* Must be called with the processor lock held */
2467 _output->silence (nframes);
2469 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2470 boost::shared_ptr<PluginInsert> pi;
2472 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2473 // skip plugins, they don't need anything when we're not active
2477 (*i)->silence (nframes);
2480 if (nframes == _session.get_block_size()) {
2487 Route::add_internal_return ()
2490 _intreturn.reset (new InternalReturn (_session));
2491 add_processor (_intreturn, PreFader);
2496 Route::add_send_to_internal_return (InternalSend* send)
2498 Glib::RWLock::ReaderLock rm (_processor_lock);
2500 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2501 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2504 return d->add_send (send);
2510 Route::remove_send_from_internal_return (InternalSend* send)
2512 Glib::RWLock::ReaderLock rm (_processor_lock);
2514 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2515 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2518 return d->remove_send (send);
2523 /** Add a monitor send (if we don't already have one) but don't activate it */
2525 Route::listen_via_monitor ()
2527 /* master never sends to control outs */
2528 assert (!is_master ());
2530 /* make sure we have one */
2531 if (!_monitor_send) {
2532 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2533 _monitor_send->set_display_to_user (false);
2537 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2538 configure_processors (0);
2543 /** Add an internal send to a route.
2544 * @param route route to send to.
2545 * @param placement placement for the send.
2548 Route::listen_via (boost::shared_ptr<Route> route, Placement placement)
2550 assert (route != _session.monitor_out ());
2553 Glib::RWLock::ReaderLock rm (_processor_lock);
2555 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2557 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2559 if (d && d->target_route() == route) {
2560 /* already listening via the specified IO: do nothing */
2567 boost::shared_ptr<InternalSend> listener (new InternalSend (_session, _pannable, _mute_master, route, Delivery::Aux));
2568 add_processor (listener, placement);
2570 } catch (failed_constructor& err) {
2578 Route::drop_listen (boost::shared_ptr<Route> route)
2580 ProcessorStreams err;
2581 ProcessorList::iterator tmp;
2583 Glib::RWLock::ReaderLock rl(_processor_lock);
2587 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ) {
2589 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2591 if (d && d->target_route() == route) {
2593 remove_processor (*x, &err);
2596 /* list could have been demolished while we dropped the lock
2606 if (route == _session.monitor_out()) {
2607 _monitor_send.reset ();
2612 Route::set_comment (string cmt, void *src)
2615 comment_changed (src);
2616 _session.set_dirty ();
2620 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2622 FeedRecord fr (other, via_sends_only);
2624 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2626 if (!result.second) {
2628 /* already a record for "other" - make sure sends-only information is correct */
2629 if (!via_sends_only && result.first->sends_only) {
2630 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2631 frp->sends_only = false;
2635 return result.second;
2639 Route::clear_fed_by ()
2645 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2647 const FedBy& fed_by (other->fed_by());
2649 for (FedBy::iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2650 boost::shared_ptr<Route> sr = f->r.lock();
2652 if (sr && (sr.get() == this)) {
2654 if (via_sends_only) {
2655 *via_sends_only = f->sends_only;
2666 Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
2668 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2670 if (_output->connected_to (other->input())) {
2671 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2680 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2682 boost::shared_ptr<IOProcessor> iop;
2684 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2685 if (iop->feeds (other)) {
2686 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2692 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2695 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2700 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2704 /** Called from the (non-realtime) butler thread when the transport is stopped */
2706 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool did_locate, bool can_flush_processors)
2708 framepos_t now = _session.transport_frame();
2711 Glib::RWLock::ReaderLock lm (_processor_lock);
2714 automation_snapshot (now, true);
2717 Automatable::transport_stopped (now);
2719 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2721 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2725 (*i)->transport_stopped (now);
2729 _roll_delay = _initial_delay;
2732 /** Called with the process lock held if change contains ConfigurationChanged */
2734 Route::input_change_handler (IOChange change, void * /*src*/)
2736 if ((change.type & IOChange::ConfigurationChanged)) {
2737 configure_processors (0);
2738 _phase_invert.resize (_input->n_ports().n_audio ());
2739 io_changed (); /* EMIT SIGNAL */
2743 /** Called with the process lock held if change contains ConfigurationChanged */
2745 Route::output_change_handler (IOChange change, void * /*src*/)
2747 if ((change.type & IOChange::ConfigurationChanged)) {
2749 /* XXX resize all listeners to match _main_outs? */
2751 /* Auto-connect newly-created outputs, unless we're auto-connecting to master
2752 and we are master (as an auto-connect in this situation would cause a
2755 AutoConnectOption ac = Config->get_output_auto_connect ();
2756 if (ac == AutoConnectPhysical || (ac == AutoConnectMaster && !is_master ())) {
2758 ChanCount start = change.before;
2760 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
2761 if (change.before.get(*i) < change.after.get(*i)) {
2762 /* the existing ChanCounts don't matter for this call as they are only
2763 to do with matching input and output indices, and we are only changing
2768 /* only auto-connect the newly-created outputs, not the ones that were
2771 start.set (*i, start.get (*i) + 1);
2773 _session.auto_connect_route (this, dummy, dummy, false, ChanCount(), change.before);
2778 // configure_processors (0);
2783 Route::pans_required () const
2785 if (n_outputs().n_audio() < 2) {
2789 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
2793 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
2794 bool session_state_changing, bool /*can_record*/, bool /*rec_monitors_input*/)
2796 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2801 if (n_outputs().n_total() == 0) {
2805 if (!_active || n_inputs() == ChanCount::ZERO) {
2806 silence_unlocked (nframes);
2809 if (session_state_changing) {
2810 if (_session.transport_speed() != 0.0f) {
2811 /* we're rolling but some state is changing (e.g. our diskstream contents)
2812 so we cannot use them. Be silent till this is over.
2814 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
2816 silence_unlocked (nframes);
2819 /* we're really not rolling, so we're either delivery silence or actually
2820 monitoring, both of which are safe to do while session_state_changing is true.
2824 _amp->apply_gain_automation (false);
2825 passthru (start_frame, end_frame, nframes, 0);
2831 Route::check_initial_delay (framecnt_t nframes, framecnt_t& transport_frame)
2833 if (_roll_delay > nframes) {
2835 _roll_delay -= nframes;
2836 silence_unlocked (nframes);
2837 /* transport frame is not legal for caller to use */
2840 } else if (_roll_delay > 0) {
2842 nframes -= _roll_delay;
2843 silence_unlocked (_roll_delay);
2844 transport_frame += _roll_delay;
2846 /* shuffle all the port buffers for things that lead "out" of this Route
2847 to reflect that we just wrote _roll_delay frames of silence.
2850 Glib::RWLock::ReaderLock lm (_processor_lock);
2851 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2852 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
2854 iop->increment_port_buffer_offset (_roll_delay);
2857 _output->increment_port_buffer_offset (_roll_delay);
2867 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
2868 bool /*can_record*/, bool /*rec_monitors_input*/, bool& /* need_butler */)
2870 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2875 automation_snapshot (_session.transport_frame(), false);
2877 if (n_outputs().n_total() == 0) {
2881 if (!_active || n_inputs().n_total() == 0) {
2882 silence_unlocked (nframes);
2886 framecnt_t unused = 0;
2888 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
2894 passthru (start_frame, end_frame, nframes, declick);
2900 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
2901 bool /*can_record*/, bool /*rec_monitors_input*/, bool& /* need_butler */)
2908 Route::toggle_monitor_input ()
2910 for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
2911 i->ensure_monitor_input( ! i->monitoring_input());
2916 Route::has_external_redirects () const
2918 // FIXME: what about sends? - they don't return a signal back to ardour?
2920 boost::shared_ptr<const PortInsert> pi;
2922 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2924 if ((pi = boost::dynamic_pointer_cast<const PortInsert>(*i)) != 0) {
2926 for (PortSet::const_iterator port = pi->output()->ports().begin(); port != pi->output()->ports().end(); ++port) {
2928 string port_name = port->name();
2929 string client_name = port_name.substr (0, port_name.find(':'));
2931 /* only say "yes" if the redirect is actually in use */
2933 if (client_name != "ardour" && pi->active()) {
2944 Route::flush_processors ()
2946 /* XXX shouldn't really try to take this lock, since
2947 this is called from the RT audio thread.
2950 Glib::RWLock::ReaderLock lm (_processor_lock);
2952 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2958 Route::set_meter_point (MeterPoint p, bool force)
2960 /* CAN BE CALLED FROM PROCESS CONTEXT */
2962 if (_meter_point == p && !force) {
2968 bool meter_was_visible_to_user = _meter->display_to_user ();
2971 Glib::RWLock::WriterLock lm (_processor_lock);
2973 if (_meter_point != MeterCustom) {
2975 _meter->set_display_to_user (false);
2977 setup_invisible_processors ();
2979 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
2983 if (loc == _processors.begin()) {
2984 m_in = _input->n_ports();
2986 ProcessorList::iterator before = loc;
2988 m_in = (*before)->output_streams ();
2991 _meter->reflect_inputs (m_in);
2993 /* we do not need to reconfigure the processors, because the meter
2994 (a) is always ready to handle processor_max_streams
2995 (b) is always an N-in/N-out processor, and thus moving
2996 it doesn't require any changes to the other processors.
3001 // just make it visible and let the user move it
3003 _meter->set_display_to_user (true);
3007 meter_change (); /* EMIT SIGNAL */
3009 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
3011 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
3015 Route::listen_position_changed ()
3018 Glib::RWLock::WriterLock lm (_processor_lock);
3019 ProcessorState pstate (this);
3022 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3024 if (configure_processors_unlocked (0)) {
3026 configure_processors_unlocked (0); // it worked before we tried to add it ...
3032 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3033 _session.set_dirty ();
3036 boost::shared_ptr<CapturingProcessor>
3037 Route::add_export_point()
3039 if (!_capturing_processor) {
3041 _capturing_processor.reset (new CapturingProcessor (_session));
3042 _capturing_processor->activate ();
3045 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3046 configure_processors (0);
3051 return _capturing_processor;
3055 Route::update_signal_latency ()
3057 framecnt_t l = _output->user_latency();
3059 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3060 if ((*i)->active ()) {
3061 l += (*i)->signal_latency ();
3065 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3067 if (_signal_latency != l) {
3068 _signal_latency = l;
3069 signal_latency_changed (); /* EMIT SIGNAL */
3072 return _signal_latency;
3076 Route::set_user_latency (framecnt_t nframes)
3078 _output->set_user_latency (nframes);
3079 _session.update_latency_compensation (false, false);
3083 Route::set_latency_compensation (framecnt_t longest_session_latency)
3085 framecnt_t old = _initial_delay;
3087 if (_signal_latency < longest_session_latency) {
3088 _initial_delay = longest_session_latency - _signal_latency;
3093 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: compensate for maximum latency of %2, given own latency of %3, using initial delay of %4\n",
3094 name(), longest_session_latency, _signal_latency, _initial_delay));
3096 if (_initial_delay != old) {
3097 initial_delay_changed (); /* EMIT SIGNAL */
3100 if (_session.transport_stopped()) {
3101 _roll_delay = _initial_delay;
3106 Route::automation_snapshot (framepos_t now, bool force)
3108 _pannable->automation_snapshot (now, force);
3109 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3110 (*i)->automation_snapshot (now, force);
3114 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3115 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3116 boost::shared_ptr<AutomationList>(), name)
3119 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3124 Route::SoloControllable::set_value (double val)
3126 bool bval = ((val >= 0.5f) ? true: false);
3128 boost::shared_ptr<RouteList> rl (new RouteList);
3130 boost::shared_ptr<Route> r = _route.lock ();
3137 if (Config->get_solo_control_is_listen_control()) {
3138 _session.set_listen (rl, bval);
3140 _session.set_solo (rl, bval);
3145 Route::SoloControllable::get_value () const
3147 boost::shared_ptr<Route> r = _route.lock ();
3152 if (Config->get_solo_control_is_listen_control()) {
3153 return r->listening_via_monitor() ? 1.0f : 0.0f;
3155 return r->self_soloed() ? 1.0f : 0.0f;
3159 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3160 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3161 boost::shared_ptr<AutomationList>(), name)
3164 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3169 Route::MuteControllable::set_value (double val)
3171 bool bval = ((val >= 0.5f) ? true: false);
3173 boost::shared_ptr<RouteList> rl (new RouteList);
3175 boost::shared_ptr<Route> r = _route.lock ();
3181 _session.set_mute (rl, bval);
3185 Route::MuteControllable::get_value () const
3187 boost::shared_ptr<Route> r = _route.lock ();
3192 return r->muted() ? 1.0f : 0.0f;
3196 Route::set_block_size (pframes_t nframes)
3198 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3199 (*i)->set_block_size (nframes);
3202 _session.ensure_buffers (n_process_buffers ());
3206 Route::protect_automation ()
3208 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3209 (*i)->protect_automation();
3213 Route::set_pending_declick (int declick)
3216 /* this call is not allowed to turn off a pending declick unless "force" is true */
3218 _pending_declick = declick;
3220 // cerr << _name << ": after setting to " << declick << " pending declick = " << _pending_declick << endl;
3222 _pending_declick = 0;
3227 /** Shift automation forwards from a particular place, thereby inserting time.
3228 * Adds undo commands for any shifts that are performed.
3230 * @param pos Position to start shifting from.
3231 * @param frames Amount to shift forwards by.
3235 Route::shift (framepos_t pos, framecnt_t frames)
3237 /* gain automation */
3239 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3241 XMLNode &before = gc->alist()->get_state ();
3242 gc->alist()->shift (pos, frames);
3243 XMLNode &after = gc->alist()->get_state ();
3244 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3247 /* pan automation */
3249 ControlSet::Controls& c (_pannable->controls());
3251 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3252 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3254 boost::shared_ptr<AutomationList> al = pc->alist();
3255 XMLNode& before = al->get_state ();
3256 al->shift (pos, frames);
3257 XMLNode& after = al->get_state ();
3258 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3263 /* redirect automation */
3265 Glib::RWLock::ReaderLock lm (_processor_lock);
3266 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3268 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3270 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3271 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3273 boost::shared_ptr<AutomationList> al = ac->alist();
3274 XMLNode &before = al->get_state ();
3275 al->shift (pos, frames);
3276 XMLNode &after = al->get_state ();
3277 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3286 Route::save_as_template (const string& path, const string& name)
3288 XMLNode& node (state (false));
3291 IO::set_name_in_state (*node.children().front(), name);
3293 tree.set_root (&node);
3294 return tree.write (path.c_str());
3299 Route::set_name (const string& str)
3305 name = Route::ensure_track_or_route_name (str, _session);
3306 SessionObject::set_name (name);
3308 ret = (_input->set_name(name) && _output->set_name(name));
3312 Glib::RWLock::ReaderLock lm (_processor_lock);
3314 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3316 /* rename all I/O processors that have inputs or outputs */
3318 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
3320 if (iop && (iop->output() || iop->input())) {
3321 if (!iop->set_name (name)) {
3332 boost::shared_ptr<Send>
3333 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3335 Glib::RWLock::ReaderLock lm (_processor_lock);
3337 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3338 boost::shared_ptr<InternalSend> send;
3340 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3341 if (send->target_route() == target) {
3347 return boost::shared_ptr<Send>();
3350 /** @param c Audio channel index.
3351 * @param yn true to invert phase, otherwise false.
3354 Route::set_phase_invert (uint32_t c, bool yn)
3356 if (_phase_invert[c] != yn) {
3357 _phase_invert[c] = yn;
3358 phase_invert_changed (); /* EMIT SIGNAL */
3359 _session.set_dirty ();
3364 Route::set_phase_invert (boost::dynamic_bitset<> p)
3366 if (_phase_invert != p) {
3368 phase_invert_changed (); /* EMIT SIGNAL */
3369 _session.set_dirty ();
3374 Route::phase_invert (uint32_t c) const
3376 return _phase_invert[c];
3379 boost::dynamic_bitset<>
3380 Route::phase_invert () const
3382 return _phase_invert;
3386 Route::set_denormal_protection (bool yn)
3388 if (_denormal_protection != yn) {
3389 _denormal_protection = yn;
3390 denormal_protection_changed (); /* EMIT SIGNAL */
3395 Route::denormal_protection () const
3397 return _denormal_protection;
3401 Route::set_active (bool yn, void* src)
3403 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3404 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3408 if (_active != yn) {
3410 _input->set_active (yn);
3411 _output->set_active (yn);
3412 active_changed (); // EMIT SIGNAL
3419 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3425 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3427 boost::shared_ptr<Send> s;
3428 boost::shared_ptr<Return> r;
3430 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3431 s->meter()->meter();
3432 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3433 r->meter()->meter ();
3438 boost::shared_ptr<Pannable>
3439 Route::pannable() const
3444 boost::shared_ptr<Panner>
3445 Route::panner() const
3448 return _main_outs->panner_shell()->panner();
3451 boost::shared_ptr<PannerShell>
3452 Route::panner_shell() const
3454 return _main_outs->panner_shell();
3457 boost::shared_ptr<AutomationControl>
3458 Route::gain_control() const
3460 return _amp->gain_control();
3463 boost::shared_ptr<AutomationControl>
3464 Route::get_control (const Evoral::Parameter& param)
3466 /* either we own the control or .... */
3468 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3472 /* maybe one of our processors does or ... */
3474 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3475 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3476 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3484 /* nobody does so we'll make a new one */
3486 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3493 boost::shared_ptr<Processor>
3494 Route::nth_plugin (uint32_t n)
3496 Glib::RWLock::ReaderLock lm (_processor_lock);
3497 ProcessorList::iterator i;
3499 for (i = _processors.begin(); i != _processors.end(); ++i) {
3500 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3507 return boost::shared_ptr<Processor> ();
3510 boost::shared_ptr<Processor>
3511 Route::nth_send (uint32_t n)
3513 Glib::RWLock::ReaderLock lm (_processor_lock);
3514 ProcessorList::iterator i;
3516 for (i = _processors.begin(); i != _processors.end(); ++i) {
3517 if (boost::dynamic_pointer_cast<Send> (*i)) {
3524 return boost::shared_ptr<Processor> ();
3528 Route::has_io_processor_named (const string& name)
3530 Glib::RWLock::ReaderLock lm (_processor_lock);
3531 ProcessorList::iterator i;
3533 for (i = _processors.begin(); i != _processors.end(); ++i) {
3534 if (boost::dynamic_pointer_cast<Send> (*i) ||
3535 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3536 if ((*i)->name() == name) {
3545 MuteMaster::MutePoint
3546 Route::mute_points () const
3548 return _mute_master->mute_points ();
3552 Route::set_processor_positions ()
3554 Glib::RWLock::ReaderLock lm (_processor_lock);
3556 bool had_amp = false;
3557 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3558 (*i)->set_pre_fader (!had_amp);
3559 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3565 /** Called when there is a proposed change to the input port count */
3567 Route::input_port_count_changing (ChanCount to)
3569 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3571 /* The processors cannot be configured with the new input arrangement, so
3577 /* The change is ok */
3582 Route::unknown_processors () const
3586 Glib::RWLock::ReaderLock lm (_processor_lock);
3587 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3588 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3589 p.push_back ((*i)->name ());
3598 Route::update_port_latencies (const PortSet& from, const PortSet& to, bool playback, framecnt_t our_latency) const
3600 /* we assume that all our input ports feed all our output ports. its not
3601 universally true, but the alternative is way too corner-case to worry about.
3604 jack_latency_range_t all_connections;
3606 all_connections.min = ~((jack_nframes_t) 0);
3607 all_connections.max = 0;
3609 /* iterate over all "from" ports and determine the latency range for all of their
3610 connections to the "outside" (outside of this Route).
3613 for (PortSet::const_iterator p = from.begin(); p != from.end(); ++p) {
3615 jack_latency_range_t range;
3617 p->get_connected_latency_range (range, playback);
3619 all_connections.min = min (all_connections.min, range.min);
3620 all_connections.max = max (all_connections.max, range.max);
3623 /* set the "from" port latencies to the max/min range of all their connections */
3625 for (PortSet::const_iterator p = from.begin(); p != from.end(); ++p) {
3626 p->set_public_latency_range (all_connections, playback);
3629 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3631 all_connections.min += our_latency;
3632 all_connections.max += our_latency;
3634 for (PortSet::const_iterator p = to.begin(); p != to.end(); ++p) {
3635 p->set_public_latency_range (all_connections, playback);
3638 return all_connections.max;
3642 Route::set_private_port_latencies (bool playback) const
3644 framecnt_t own_latency = 0;
3646 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD OR
3649 This is called (early) from the latency callback. It computes the REAL latency associated
3650 with each port and stores the result as the "private" latency of the port. A later
3651 call to Route::set_public_port_latencies() sets all ports to the same value to reflect
3652 the fact that we do latency compensation and so all signals are delayed by the
3653 same amount as they flow through ardour.
3656 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3657 if ((*i)->active ()) {
3658 own_latency += (*i)->signal_latency ();
3663 /* playback: propagate latency from "outside the route" to outputs to inputs */
3664 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3666 /* capture: propagate latency from "outside the route" to inputs to outputs */
3667 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3672 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3674 /* this is called to set the JACK-visible port latencies, which take latency compensation
3678 jack_latency_range_t range;
3684 const PortSet& ports (_input->ports());
3685 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3686 p->set_public_latency_range (range, playback);
3691 const PortSet& ports (_output->ports());
3692 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3693 p->set_public_latency_range (range, playback);
3698 /** Put the invisible processors in the right place in _processors.
3699 * Must be called with a writer lock on _processor_lock held.
3702 Route::setup_invisible_processors ()
3705 Glib::RWLock::WriterLock lm (_processor_lock, Glib::TRY_LOCK);
3706 assert (!lm.locked ());
3710 /* too early to be doing this stuff */
3714 /* we'll build this new list here and then use it */
3716 ProcessorList new_processors;
3718 /* find visible processors */
3720 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3721 if ((*i)->display_to_user ()) {
3722 new_processors.push_back (*i);
3728 ProcessorList::iterator amp = new_processors.begin ();
3729 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3733 assert (amp != _processors.end ());
3735 /* and the processor after the amp */
3737 ProcessorList::iterator after_amp = amp;
3743 switch (_meter_point) {
3745 assert (!_meter->display_to_user ());
3746 new_processors.push_front (_meter);
3749 assert (!_meter->display_to_user ());
3750 new_processors.insert (amp, _meter);
3752 case MeterPostFader:
3753 /* do nothing here */
3756 /* do nothing here */
3759 /* the meter is visible, so we don't touch it here */
3766 assert (_main_outs);
3767 assert (!_main_outs->display_to_user ());
3768 new_processors.push_back (_main_outs);
3770 /* iterator for the main outs */
3772 ProcessorList::iterator main = new_processors.end();
3775 /* OUTPUT METERING */
3777 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3778 assert (!_meter->display_to_user ());
3780 /* add the processor just before or just after the main outs */
3782 ProcessorList::iterator meter_point = main;
3784 if (_meter_point == MeterOutput) {
3787 new_processors.insert (meter_point, _meter);
3792 if (_monitor_send && !is_monitor ()) {
3793 assert (!_monitor_send->display_to_user ());
3794 if (Config->get_solo_control_is_listen_control()) {
3795 switch (Config->get_listen_position ()) {
3796 case PreFaderListen:
3797 switch (Config->get_pfl_position ()) {
3798 case PFLFromBeforeProcessors:
3799 new_processors.push_front (_monitor_send);
3801 case PFLFromAfterProcessors:
3802 new_processors.insert (amp, _monitor_send);
3806 case AfterFaderListen:
3807 switch (Config->get_afl_position ()) {
3808 case AFLFromBeforeProcessors:
3809 new_processors.insert (after_amp, _monitor_send);
3811 case AFLFromAfterProcessors:
3812 new_processors.insert (new_processors.end(), _monitor_send);
3818 new_processors.insert (new_processors.end(), _monitor_send);
3822 /* MONITOR CONTROL */
3824 if (_monitor_control && is_monitor ()) {
3825 assert (!_monitor_control->display_to_user ());
3826 new_processors.push_front (_monitor_control);
3829 /* INTERNAL RETURN */
3831 /* doing this here means that any monitor control will come just after
3836 assert (!_intreturn->display_to_user ());
3837 new_processors.push_front (_intreturn);
3840 /* EXPORT PROCESSOR */
3842 if (_capturing_processor) {
3843 assert (!_capturing_processor->display_to_user ());
3844 new_processors.push_front (_capturing_processor);
3847 _processors = new_processors;
3849 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
3850 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3851 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
3856 Route::should_monitor () const
3858 switch (Config->get_monitoring_model()) {
3859 case HardwareMonitoring:
3860 case ExternalMonitoring:
3861 return !record_enabled() || (_session.config.get_auto_input() && !_session.actively_recording());