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 if (!(_flags & Route::MonitorOut)) {
129 Pannable* p = new Pannable (_session);
130 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
131 boost_debug_shared_ptr_mark_interesting (p, "Pannable");
136 /* input and output objects */
138 _input.reset (new IO (_session, _name, IO::Input, _default_type));
139 _output.reset (new IO (_session, _name, IO::Output, _default_type));
141 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_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)
573 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
574 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
579 if (yn != _monitor_send->active()) {
581 _monitor_send->activate ();
582 _mute_master->set_soloed (true);
584 _monitor_send->deactivate ();
585 _mute_master->set_soloed (false);
588 listen_changed (src); /* EMIT SIGNAL */
594 Route::listening_via_monitor () const
597 return _monitor_send->active ();
604 Route::set_solo_safe (bool yn, void *src)
606 if (_solo_safe != yn) {
608 solo_safe_changed (src);
613 Route::solo_safe() const
619 Route::set_solo (bool yn, void *src)
625 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
626 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
630 if (self_soloed() != yn) {
632 set_mute_master_solo ();
633 solo_changed (true, src); /* EMIT SIGNAL */
634 _solo_control->Changed (); /* EMIT SIGNAL */
639 Route::set_self_solo (bool yn)
645 Route::mod_solo_by_others_upstream (int32_t delta)
651 uint32_t old_sbu = _soloed_by_others_upstream;
654 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
655 _soloed_by_others_upstream += delta;
657 _soloed_by_others_upstream = 0;
660 _soloed_by_others_upstream += delta;
663 DEBUG_TRACE (DEBUG::Solo, string_compose (
664 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
665 name(), delta, _soloed_by_others_upstream, old_sbu,
666 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
668 /* push the inverse solo change to everything that feeds us.
670 This is important for solo-within-group. When we solo 1 track out of N that
671 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
672 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
673 tracks that feed it. This will silence them if they were audible because
674 of a bus solo, but the newly soloed track will still be audible (because
677 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
681 if ((_self_solo || _soloed_by_others_downstream) &&
682 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
683 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
685 if (delta > 0 || !Config->get_exclusive_solo()) {
686 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
687 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
688 boost::shared_ptr<Route> sr = i->r.lock();
690 sr->mod_solo_by_others_downstream (-delta);
696 set_mute_master_solo ();
697 solo_changed (false, this);
701 Route::mod_solo_by_others_downstream (int32_t delta)
708 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
709 _soloed_by_others_downstream += delta;
711 _soloed_by_others_downstream = 0;
714 _soloed_by_others_downstream += delta;
717 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
719 set_mute_master_solo ();
720 solo_changed (false, this);
724 Route::set_mute_master_solo ()
726 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
730 Route::set_solo_isolated (bool yn, void *src)
732 if (is_master() || is_monitor() || is_hidden()) {
736 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
737 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
741 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
743 boost::shared_ptr<RouteList> routes = _session.get_routes ();
744 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
746 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
751 bool does_feed = direct_feeds (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
753 if (does_feed && !sends_only) {
754 (*i)->set_solo_isolated (yn, (*i)->route_group());
758 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
760 bool changed = false;
763 if (_solo_isolated == 0) {
764 _mute_master->set_solo_ignore (true);
769 if (_solo_isolated > 0) {
771 if (_solo_isolated == 0) {
772 _mute_master->set_solo_ignore (false);
779 solo_isolated_changed (src);
784 Route::solo_isolated () const
786 return _solo_isolated > 0;
790 Route::set_mute_points (MuteMaster::MutePoint mp)
792 _mute_master->set_mute_points (mp);
793 mute_points_changed (); /* EMIT SIGNAL */
795 if (_mute_master->muted_by_self()) {
796 mute_changed (this); /* EMIT SIGNAL */
797 _mute_control->Changed (); /* EMIT SIGNAL */
802 Route::set_mute (bool yn, void *src)
804 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
805 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
810 _mute_master->set_muted_by_self (yn);
811 mute_changed (src); /* EMIT SIGNAL */
812 _mute_control->Changed (); /* EMIT SIGNAL */
817 Route::muted () const
819 return _mute_master->muted_by_self();
824 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
826 cerr << name << " {" << endl;
827 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
828 p != procs.end(); ++p) {
829 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
836 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
838 ProcessorList::iterator loc;
840 /* XXX this is not thread safe - we don't hold the lock across determining the iter
841 to add before and actually doing the insertion. dammit.
844 if (placement == PreFader) {
845 /* generic pre-fader: insert immediately before the amp */
846 loc = find (_processors.begin(), _processors.end(), _amp);
848 /* generic post-fader: insert right before the main outs */
849 loc = find (_processors.begin(), _processors.end(), _main_outs);
852 return add_processor (processor, loc, err, activation_allowed);
856 /** Add a processor to the route.
857 * @param iter an iterator in _processors; the new processor will be inserted immediately before this location.
860 Route::add_processor (boost::shared_ptr<Processor> processor, ProcessorList::iterator iter, ProcessorStreams* err, bool activation_allowed)
862 assert (processor != _meter);
863 assert (processor != _main_outs);
865 DEBUG_TRACE (DEBUG::Processors, string_compose (
866 "%1 adding processor %2\n", name(), processor->name()));
868 if (!_session.engine().connected() || !processor) {
873 Glib::RWLock::WriterLock lm (_processor_lock);
874 ProcessorState pstate (this);
876 boost::shared_ptr<PluginInsert> pi;
877 boost::shared_ptr<PortInsert> porti;
879 ProcessorList::iterator loc = find(_processors.begin(), _processors.end(), processor);
881 if (processor == _amp) {
882 // Ensure only one amp is in the list at any time
883 if (loc != _processors.end()) {
884 if (iter == loc) { // Already in place, do nothing
886 } else { // New position given, relocate
887 _processors.erase (loc);
892 if (loc != _processors.end()) {
893 cerr << "ERROR: Processor added to route twice!" << endl;
900 _processors.insert (loc, processor);
902 // Set up processor list channels. This will set processor->[input|output]_streams(),
903 // configure redirect ports properly, etc.
906 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
908 if (configure_processors_unlocked (err)) {
910 configure_processors_unlocked (0); // it worked before we tried to add it ...
915 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
917 if (pi->has_no_inputs ()) {
918 /* generator plugin */
919 _have_internal_generator = true;
924 if (activation_allowed) {
925 processor->activate ();
928 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
930 _output->set_user_latency (0);
933 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
934 set_processor_positions ();
940 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
942 const XMLProperty *prop;
945 boost::shared_ptr<Processor> processor;
947 /* bit of a hack: get the `placement' property from the <Redirect> tag here
948 so that we can add the processor in the right place (pre/post-fader)
951 XMLNodeList const & children = node.children ();
952 XMLNodeList::const_iterator i = children.begin ();
954 while (i != children.end() && (*i)->name() != X_("Redirect")) {
958 Placement placement = PreFader;
960 if (i != children.end()) {
961 if ((prop = (*i)->property (X_("placement"))) != 0) {
962 placement = Placement (string_2_enum (prop->value(), placement));
966 if (node.name() == "Insert") {
968 if ((prop = node.property ("type")) != 0) {
970 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
971 prop->value() == "lv2" ||
972 prop->value() == "vst" ||
973 prop->value() == "lxvst" ||
974 prop->value() == "audiounit") {
976 processor.reset (new PluginInsert (_session));
980 processor.reset (new PortInsert (_session, _pannable, _mute_master));
985 } else if (node.name() == "Send") {
987 processor.reset (new Send (_session, _pannable, _mute_master));
991 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
995 if (processor->set_state (node, version)) {
999 return (add_processor (processor, placement) == 0);
1002 catch (failed_constructor &err) {
1003 warning << _("processor could not be created. Ignored.") << endmsg;
1009 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1011 /* NOTE: this is intended to be used ONLY when copying
1012 processors from another Route. Hence the subtle
1013 differences between this and ::add_processor()
1016 ProcessorList::iterator loc;
1019 loc = find(_processors.begin(), _processors.end(), before);
1021 /* nothing specified - at end */
1022 loc = _processors.end ();
1025 if (!_session.engine().connected()) {
1029 if (others.empty()) {
1034 Glib::RWLock::WriterLock lm (_processor_lock);
1035 ProcessorState pstate (this);
1037 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1043 boost::shared_ptr<PluginInsert> pi;
1045 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1049 _processors.insert (loc, *i);
1051 if ((*i)->active()) {
1056 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1057 if (configure_processors_unlocked (err)) {
1059 configure_processors_unlocked (0); // it worked before we tried to add it ...
1064 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1067 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1068 boost::shared_ptr<PluginInsert> pi;
1070 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1071 if (pi->has_no_inputs ()) {
1072 _have_internal_generator = true;
1078 _output->set_user_latency (0);
1081 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1082 set_processor_positions ();
1088 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1090 if (p == PreFader) {
1091 start = _processors.begin();
1092 end = find(_processors.begin(), _processors.end(), _amp);
1094 start = find(_processors.begin(), _processors.end(), _amp);
1096 end = _processors.end();
1100 /** Turn off all processors with a given placement
1101 * @param p Placement of processors to disable
1104 Route::disable_processors (Placement p)
1106 Glib::RWLock::ReaderLock lm (_processor_lock);
1108 ProcessorList::iterator start, end;
1109 placement_range(p, start, end);
1111 for (ProcessorList::iterator i = start; i != end; ++i) {
1112 (*i)->deactivate ();
1115 _session.set_dirty ();
1118 /** Turn off all redirects
1121 Route::disable_processors ()
1123 Glib::RWLock::ReaderLock lm (_processor_lock);
1125 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1126 (*i)->deactivate ();
1129 _session.set_dirty ();
1132 /** Turn off all redirects with a given placement
1133 * @param p Placement of redirects to disable
1136 Route::disable_plugins (Placement p)
1138 Glib::RWLock::ReaderLock lm (_processor_lock);
1140 ProcessorList::iterator start, end;
1141 placement_range(p, start, end);
1143 for (ProcessorList::iterator i = start; i != end; ++i) {
1144 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1145 (*i)->deactivate ();
1149 _session.set_dirty ();
1152 /** Turn off all plugins
1155 Route::disable_plugins ()
1157 Glib::RWLock::ReaderLock lm (_processor_lock);
1159 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1160 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1161 (*i)->deactivate ();
1165 _session.set_dirty ();
1170 Route::ab_plugins (bool forward)
1172 Glib::RWLock::ReaderLock lm (_processor_lock);
1176 /* forward = turn off all active redirects, and mark them so that the next time
1177 we go the other way, we will revert them
1180 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1181 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1185 if ((*i)->active()) {
1186 (*i)->deactivate ();
1187 (*i)->set_next_ab_is_active (true);
1189 (*i)->set_next_ab_is_active (false);
1195 /* backward = if the redirect was marked to go active on the next ab, do so */
1197 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1199 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1203 if ((*i)->get_next_ab_is_active()) {
1206 (*i)->deactivate ();
1211 _session.set_dirty ();
1215 /** Remove processors with a given placement.
1216 * @param p Placement of processors to remove.
1219 Route::clear_processors (Placement p)
1221 if (!_session.engine().connected()) {
1225 bool already_deleting = _session.deletion_in_progress();
1226 if (!already_deleting) {
1227 _session.set_deletion_in_progress();
1231 Glib::RWLock::WriterLock lm (_processor_lock);
1232 ProcessorList new_list;
1233 ProcessorStreams err;
1234 bool seen_amp = false;
1236 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1242 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1244 /* you can't remove these */
1246 new_list.push_back (*i);
1253 new_list.push_back (*i);
1256 (*i)->drop_references ();
1264 (*i)->drop_references ();
1267 new_list.push_back (*i);
1274 _processors = new_list;
1277 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1278 configure_processors_unlocked (&err); // this can't fail
1282 processor_max_streams.reset();
1283 _have_internal_generator = false;
1284 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1285 set_processor_positions ();
1287 if (!already_deleting) {
1288 _session.clear_deletion_in_progress();
1293 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err)
1295 /* these can never be removed */
1297 if (processor == _amp || processor == _meter || processor == _main_outs) {
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->has_no_inputs ()) {
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->has_no_inputs ()) {
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
1594 _session.ensure_buffers (n_process_buffers ());
1596 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1598 _in_configure_processors = false;
1603 Route::all_processors_flip ()
1605 Glib::RWLock::ReaderLock lm (_processor_lock);
1607 if (_processors.empty()) {
1611 bool first_is_on = _processors.front()->active();
1613 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1615 (*i)->deactivate ();
1621 _session.set_dirty ();
1624 /** Set all processors with a given placement to a given active state.
1625 * @param p Placement of processors to change.
1626 * @param state New active state for those processors.
1629 Route::all_processors_active (Placement p, bool state)
1631 Glib::RWLock::ReaderLock lm (_processor_lock);
1633 if (_processors.empty()) {
1636 ProcessorList::iterator start, end;
1637 placement_range(p, start, end);
1639 bool before_amp = true;
1640 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1645 if (p == PreFader && before_amp) {
1649 (*i)->deactivate ();
1654 _session.set_dirty ();
1658 Route::processor_is_prefader (boost::shared_ptr<Processor> p)
1660 bool pre_fader = true;
1661 Glib::RWLock::ReaderLock lm (_processor_lock);
1663 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1665 /* semantic note: if p == amp, we want to return true, so test
1666 for equality before checking if this is the amp
1683 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1685 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1686 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1687 processors in the current actual processor list that are hidden. Any visible processors
1688 in the current list but not in "new_order" will be assumed to be deleted.
1692 Glib::RWLock::WriterLock lm (_processor_lock);
1693 ProcessorState pstate (this);
1695 ProcessorList::iterator oiter;
1696 ProcessorList::const_iterator niter;
1697 ProcessorList as_it_will_be;
1699 oiter = _processors.begin();
1700 niter = new_order.begin();
1702 while (niter != new_order.end()) {
1704 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1705 then append it to the temp list.
1707 Otherwise, see if the next processor in the old list is in the new list. if not,
1708 its been deleted. If its there, append it to the temp list.
1711 if (oiter == _processors.end()) {
1713 /* no more elements in the old list, so just stick the rest of
1714 the new order onto the temp list.
1717 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1718 while (niter != new_order.end()) {
1725 if (!(*oiter)->display_to_user()) {
1727 as_it_will_be.push_back (*oiter);
1731 /* visible processor: check that its in the new order */
1733 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1734 /* deleted: do nothing, shared_ptr<> will clean up */
1736 /* ignore this one, and add the next item from the new order instead */
1737 as_it_will_be.push_back (*niter);
1742 /* now remove from old order - its taken care of no matter what */
1743 oiter = _processors.erase (oiter);
1748 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1751 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1753 if (configure_processors_unlocked (err)) {
1760 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1761 set_processor_positions ();
1773 Route::get_template()
1775 return state(false);
1779 Route::state(bool full_state)
1781 XMLNode *node = new XMLNode("Route");
1782 ProcessorList::iterator i;
1785 id().print (buf, sizeof (buf));
1786 node->add_property("id", buf);
1787 node->add_property ("name", _name);
1788 node->add_property("default-type", _default_type.to_string());
1791 node->add_property("flags", enum_2_string (_flags));
1794 node->add_property("active", _active?"yes":"no");
1796 boost::to_string (_phase_invert, p);
1797 node->add_property("phase-invert", p);
1798 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1799 node->add_property("meter-point", enum_2_string (_meter_point));
1802 node->add_property("route-group", _route_group->name());
1805 string order_string;
1806 OrderKeys::iterator x = order_keys.begin();
1808 while (x != order_keys.end()) {
1809 order_string += string ((*x).first);
1810 order_string += '=';
1811 snprintf (buf, sizeof(buf), "%ld", (*x).second);
1812 order_string += buf;
1816 if (x == order_keys.end()) {
1820 order_string += ':';
1822 node->add_property ("order-keys", order_string);
1823 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1824 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1825 node->add_property ("soloed-by-upstream", buf);
1826 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1827 node->add_property ("soloed-by-downstream", buf);
1828 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1829 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1831 node->add_child_nocopy (_input->state (full_state));
1832 node->add_child_nocopy (_output->state (full_state));
1833 node->add_child_nocopy (_solo_control->get_state ());
1834 node->add_child_nocopy (_mute_control->get_state ());
1835 node->add_child_nocopy (_mute_master->get_state ());
1837 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1838 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1839 remote_control_node->add_property (X_("id"), buf);
1840 node->add_child_nocopy (*remote_control_node);
1842 if (_comment.length()) {
1843 XMLNode *cmt = node->add_child ("Comment");
1844 cmt->add_content (_comment);
1848 node->add_child_nocopy (_pannable->state (full_state));
1851 for (i = _processors.begin(); i != _processors.end(); ++i) {
1852 node->add_child_nocopy((*i)->state (full_state));
1856 node->add_child_copy (*_extra_xml);
1863 Route::set_state (const XMLNode& node, int version)
1865 return _set_state (node, version, true);
1869 Route::_set_state (const XMLNode& node, int version, bool /*call_base*/)
1871 if (version < 3000) {
1872 return _set_state_2X (node, version);
1876 XMLNodeConstIterator niter;
1878 const XMLProperty *prop;
1880 if (node.name() != "Route"){
1881 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
1885 if ((prop = node.property (X_("name"))) != 0) {
1886 Route::set_name (prop->value());
1889 if ((prop = node.property ("id")) != 0) {
1890 _id = prop->value ();
1893 if ((prop = node.property (X_("flags"))) != 0) {
1894 _flags = Flag (string_2_enum (prop->value(), _flags));
1899 if (is_master() || is_monitor() || is_hidden()) {
1900 _mute_master->set_solo_ignore (true);
1904 /* monitor bus does not get a panner, but if (re)created
1905 via XML, it will already have one by the time we
1906 call ::set_state(). so ... remove it.
1911 /* add all processors (except amp, which is always present) */
1913 nlist = node.children();
1914 XMLNode processor_state (X_("processor_state"));
1916 Stateful::save_extra_xml (node);
1918 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1922 if (child->name() == IO::state_node_name) {
1923 if ((prop = child->property (X_("direction"))) == 0) {
1927 if (prop->value() == "Input") {
1928 _input->set_state (*child, version);
1929 } else if (prop->value() == "Output") {
1930 _output->set_state (*child, version);
1934 if (child->name() == X_("Processor")) {
1935 processor_state.add_child_copy (*child);
1939 if (child->name() == X_("Pannable")) {
1941 _pannable->set_state (*child, version);
1943 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
1948 set_processor_state (processor_state);
1950 if ((prop = node.property ("self-solo")) != 0) {
1951 set_self_solo (string_is_affirmative (prop->value()));
1954 if ((prop = node.property ("soloed-by-upstream")) != 0) {
1955 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
1956 mod_solo_by_others_upstream (atoi (prop->value()));
1959 if ((prop = node.property ("soloed-by-downstream")) != 0) {
1960 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
1961 mod_solo_by_others_downstream (atoi (prop->value()));
1964 if ((prop = node.property ("solo-isolated")) != 0) {
1965 set_solo_isolated (string_is_affirmative (prop->value()), this);
1968 if ((prop = node.property ("solo-safe")) != 0) {
1969 set_solo_safe (string_is_affirmative (prop->value()), this);
1972 if ((prop = node.property (X_("phase-invert"))) != 0) {
1973 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
1976 if ((prop = node.property (X_("denormal-protection"))) != 0) {
1977 set_denormal_protection (string_is_affirmative (prop->value()));
1980 if ((prop = node.property (X_("active"))) != 0) {
1981 bool yn = string_is_affirmative (prop->value());
1982 _active = !yn; // force switch
1983 set_active (yn, this);
1986 if ((prop = node.property (X_("meter-point"))) != 0) {
1987 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
1988 set_meter_point (mp, true);
1990 _meter->set_display_to_user (_meter_point == MeterCustom);
1994 if ((prop = node.property (X_("order-keys"))) != 0) {
1998 string::size_type colon, equal;
1999 string remaining = prop->value();
2001 while (remaining.length()) {
2003 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2004 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2007 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2008 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2011 set_order_key (remaining.substr (0, equal), n);
2015 colon = remaining.find_first_of (':');
2017 if (colon != string::npos) {
2018 remaining = remaining.substr (colon+1);
2025 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2028 if (child->name() == X_("Comment")) {
2030 /* XXX this is a terrible API design in libxml++ */
2032 XMLNode *cmt = *(child->children().begin());
2033 _comment = cmt->content();
2035 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2036 if (prop->value() == "solo") {
2037 _solo_control->set_state (*child, version);
2040 } else if (child->name() == X_("RemoteControl")) {
2041 if ((prop = child->property (X_("id"))) != 0) {
2043 sscanf (prop->value().c_str(), "%d", &x);
2044 set_remote_control_id (x);
2047 } else if (child->name() == X_("MuteMaster")) {
2048 _mute_master->set_state (*child, version);
2056 Route::_set_state_2X (const XMLNode& node, int version)
2059 XMLNodeConstIterator niter;
2061 const XMLProperty *prop;
2063 /* 2X things which still remain to be handled:
2069 if (node.name() != "Route") {
2070 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2074 if ((prop = node.property (X_("flags"))) != 0) {
2075 _flags = Flag (string_2_enum (prop->value(), _flags));
2080 if ((prop = node.property (X_("phase-invert"))) != 0) {
2081 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2082 if (string_is_affirmative (prop->value ())) {
2085 set_phase_invert (p);
2088 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2089 set_denormal_protection (string_is_affirmative (prop->value()));
2092 if ((prop = node.property (X_("soloed"))) != 0) {
2093 bool yn = string_is_affirmative (prop->value());
2095 /* XXX force reset of solo status */
2097 set_solo (yn, this);
2100 if ((prop = node.property (X_("muted"))) != 0) {
2103 bool muted = string_is_affirmative (prop->value());
2109 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2111 if (string_is_affirmative (prop->value())){
2112 mute_point = mute_point + "PreFader";
2117 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2119 if (string_is_affirmative (prop->value())){
2122 mute_point = mute_point + ",";
2125 mute_point = mute_point + "PostFader";
2130 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2132 if (string_is_affirmative (prop->value())){
2135 mute_point = mute_point + ",";
2138 mute_point = mute_point + "Listen";
2143 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2145 if (string_is_affirmative (prop->value())){
2148 mute_point = mute_point + ",";
2151 mute_point = mute_point + "Main";
2155 _mute_master->set_mute_points (mute_point);
2156 _mute_master->set_muted_by_self (true);
2160 if ((prop = node.property (X_("meter-point"))) != 0) {
2161 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2164 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2165 don't mean the same thing.
2168 if ((prop = node.property (X_("order-keys"))) != 0) {
2172 string::size_type colon, equal;
2173 string remaining = prop->value();
2175 while (remaining.length()) {
2177 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2178 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2181 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2182 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2185 set_order_key (remaining.substr (0, equal), n);
2189 colon = remaining.find_first_of (':');
2191 if (colon != string::npos) {
2192 remaining = remaining.substr (colon+1);
2201 nlist = node.children ();
2202 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2206 if (child->name() == IO::state_node_name) {
2208 /* there is a note in IO::set_state_2X() about why we have to call
2212 _input->set_state_2X (*child, version, true);
2213 _output->set_state_2X (*child, version, false);
2215 if ((prop = child->property (X_("name"))) != 0) {
2216 Route::set_name (prop->value ());
2219 if ((prop = child->property (X_("id"))) != 0) {
2220 _id = prop->value ();
2223 if ((prop = child->property (X_("active"))) != 0) {
2224 bool yn = string_is_affirmative (prop->value());
2225 _active = !yn; // force switch
2226 set_active (yn, this);
2229 if ((prop = child->property (X_("gain"))) != 0) {
2232 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2233 _amp->gain_control()->set_value (val);
2237 /* Set up Panners in the IO */
2238 XMLNodeList io_nlist = child->children ();
2240 XMLNodeConstIterator io_niter;
2243 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2245 io_child = *io_niter;
2247 if (io_child->name() == X_("Panner")) {
2248 _main_outs->panner_shell()->set_state(*io_child, version);
2249 } else if (io_child->name() == X_("Automation")) {
2250 /* IO's automation is for the fader */
2251 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2257 XMLNodeList redirect_nodes;
2259 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2263 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2264 redirect_nodes.push_back(child);
2269 set_processor_state_2X (redirect_nodes, version);
2271 Stateful::save_extra_xml (node);
2273 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2276 if (child->name() == X_("Comment")) {
2278 /* XXX this is a terrible API design in libxml++ */
2280 XMLNode *cmt = *(child->children().begin());
2281 _comment = cmt->content();
2283 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2284 if (prop->value() == X_("solo")) {
2285 _solo_control->set_state (*child, version);
2286 } else if (prop->value() == X_("mute")) {
2287 _mute_control->set_state (*child, version);
2290 } else if (child->name() == X_("RemoteControl")) {
2291 if ((prop = child->property (X_("id"))) != 0) {
2293 sscanf (prop->value().c_str(), "%d", &x);
2294 set_remote_control_id (x);
2304 Route::get_processor_state ()
2306 XMLNode* root = new XMLNode (X_("redirects"));
2307 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2308 root->add_child_nocopy ((*i)->state (true));
2315 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2317 /* We don't bother removing existing processors not in nList, as this
2318 method will only be called when creating a Route from scratch, not
2319 for undo purposes. Just put processors in at the appropriate place
2323 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2324 add_processor_from_xml_2X (**i, version);
2329 Route::set_processor_state (const XMLNode& node)
2331 const XMLNodeList &nlist = node.children();
2332 XMLNodeConstIterator niter;
2333 ProcessorList new_order;
2334 bool must_configure = false;
2336 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2338 XMLProperty* prop = (*niter)->property ("type");
2340 if (prop->value() == "amp") {
2341 _amp->set_state (**niter, Stateful::current_state_version);
2342 new_order.push_back (_amp);
2343 } else if (prop->value() == "meter") {
2344 _meter->set_state (**niter, Stateful::current_state_version);
2345 } else if (prop->value() == "main-outs") {
2346 _main_outs->set_state (**niter, Stateful::current_state_version);
2347 } else if (prop->value() == "intreturn") {
2349 _intreturn.reset (new InternalReturn (_session));
2350 must_configure = true;
2352 _intreturn->set_state (**niter, Stateful::current_state_version);
2353 } else if (is_monitor() && prop->value() == "monitor") {
2354 if (!_monitor_control) {
2355 _monitor_control.reset (new MonitorProcessor (_session));
2356 must_configure = true;
2358 _monitor_control->set_state (**niter, Stateful::current_state_version);
2359 } else if (prop->value() == "capture") {
2360 _capturing_processor.reset (new CapturingProcessor (_session));
2362 ProcessorList::iterator o;
2364 for (o = _processors.begin(); o != _processors.end(); ++o) {
2365 XMLProperty* id_prop = (*niter)->property(X_("id"));
2366 if (id_prop && (*o)->id() == id_prop->value()) {
2367 (*o)->set_state (**niter, Stateful::current_state_version);
2368 new_order.push_back (*o);
2373 // If the processor (*niter) is not on the route then create it
2375 if (o == _processors.end()) {
2377 boost::shared_ptr<Processor> processor;
2379 if (prop->value() == "intsend") {
2381 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2383 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2384 prop->value() == "lv2" ||
2385 prop->value() == "vst" ||
2386 prop->value() == "lxvst" ||
2387 prop->value() == "audiounit") {
2389 processor.reset (new PluginInsert(_session));
2391 } else if (prop->value() == "port") {
2393 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2395 } else if (prop->value() == "send") {
2397 processor.reset (new Send (_session, _pannable, _mute_master));
2400 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2404 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2405 /* This processor could not be configured. Turn it into a UnknownProcessor */
2406 processor.reset (new UnknownProcessor (_session, **niter));
2409 /* we have to note the monitor send here, otherwise a new one will be created
2410 and the state of this one will be lost.
2412 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2413 if (isend && isend->role() == Delivery::Listen) {
2414 _monitor_send = isend;
2417 /* it doesn't matter if invisible processors are added here, as they
2418 will be sorted out by setup_invisible_processors () shortly.
2421 new_order.push_back (processor);
2422 must_configure = true;
2428 Glib::RWLock::WriterLock lm (_processor_lock);
2429 _processors = new_order;
2431 if (must_configure) {
2432 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2433 configure_processors_unlocked (0);
2436 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2438 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2440 boost::shared_ptr<PluginInsert> pi;
2442 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2443 if (pi->has_no_inputs ()) {
2444 _have_internal_generator = true;
2451 processors_changed (RouteProcessorChange ());
2452 set_processor_positions ();
2456 Route::curve_reallocate ()
2458 // _gain_automation_curve.finish_resize ();
2459 // _pan_automation_curve.finish_resize ();
2463 Route::silence (framecnt_t nframes)
2465 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2470 silence_unlocked (nframes);
2474 Route::silence_unlocked (framecnt_t nframes)
2476 /* Must be called with the processor lock held */
2480 _output->silence (nframes);
2482 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2483 boost::shared_ptr<PluginInsert> pi;
2485 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2486 // skip plugins, they don't need anything when we're not active
2490 (*i)->silence (nframes);
2493 if (nframes == _session.get_block_size()) {
2500 Route::add_internal_return ()
2503 _intreturn.reset (new InternalReturn (_session));
2504 add_processor (_intreturn, PreFader);
2509 Route::add_send_to_internal_return (InternalSend* send)
2511 Glib::RWLock::ReaderLock rm (_processor_lock);
2513 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2514 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2517 return d->add_send (send);
2523 Route::remove_send_from_internal_return (InternalSend* send)
2525 Glib::RWLock::ReaderLock rm (_processor_lock);
2527 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2528 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2531 return d->remove_send (send);
2536 /** Add a monitor send (if we don't already have one) but don't activate it */
2538 Route::listen_via_monitor ()
2540 /* master never sends to control outs */
2541 assert (!is_master ());
2543 /* make sure we have one */
2544 if (!_monitor_send) {
2545 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2546 _monitor_send->set_display_to_user (false);
2550 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2551 configure_processors (0);
2556 /** Add an internal send to a route.
2557 * @param route route to send to.
2558 * @param placement placement for the send.
2561 Route::listen_via (boost::shared_ptr<Route> route, Placement placement)
2563 assert (route != _session.monitor_out ());
2566 Glib::RWLock::ReaderLock rm (_processor_lock);
2568 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2570 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2572 if (d && d->target_route() == route) {
2573 /* already listening via the specified IO: do nothing */
2580 boost::shared_ptr<InternalSend> listener (new InternalSend (_session, _pannable, _mute_master, route, Delivery::Aux));
2581 add_processor (listener, placement);
2583 } catch (failed_constructor& err) {
2591 Route::drop_listen (boost::shared_ptr<Route> route)
2593 ProcessorStreams err;
2594 ProcessorList::iterator tmp;
2596 Glib::RWLock::ReaderLock rl(_processor_lock);
2600 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ) {
2602 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2604 if (d && d->target_route() == route) {
2606 remove_processor (*x, &err);
2609 /* list could have been demolished while we dropped the lock
2619 if (route == _session.monitor_out()) {
2620 _monitor_send.reset ();
2625 Route::set_comment (string cmt, void *src)
2628 comment_changed (src);
2629 _session.set_dirty ();
2633 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2635 FeedRecord fr (other, via_sends_only);
2637 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2639 if (!result.second) {
2641 /* already a record for "other" - make sure sends-only information is correct */
2642 if (!via_sends_only && result.first->sends_only) {
2643 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2644 frp->sends_only = false;
2648 return result.second;
2652 Route::clear_fed_by ()
2658 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2660 const FedBy& fed_by (other->fed_by());
2662 for (FedBy::iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2663 boost::shared_ptr<Route> sr = f->r.lock();
2665 if (sr && (sr.get() == this)) {
2667 if (via_sends_only) {
2668 *via_sends_only = f->sends_only;
2679 Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
2681 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2683 if (_output->connected_to (other->input())) {
2684 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2693 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2695 boost::shared_ptr<IOProcessor> iop;
2697 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2698 if (iop->feeds (other)) {
2699 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2705 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2708 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2713 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2717 /** Called from the (non-realtime) butler thread when the transport is stopped */
2719 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool did_locate, bool can_flush_processors)
2721 framepos_t now = _session.transport_frame();
2724 Glib::RWLock::ReaderLock lm (_processor_lock);
2727 automation_snapshot (now, true);
2730 Automatable::transport_stopped (now);
2732 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2734 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2738 (*i)->transport_stopped (now);
2742 _roll_delay = _initial_delay;
2745 /** Called with the process lock held if change contains ConfigurationChanged */
2747 Route::input_change_handler (IOChange change, void * /*src*/)
2749 if ((change.type & IOChange::ConfigurationChanged)) {
2750 configure_processors (0);
2751 _phase_invert.resize (_input->n_ports().n_audio ());
2752 io_changed (); /* EMIT SIGNAL */
2757 Route::pans_required () const
2759 if (n_outputs().n_audio() < 2) {
2763 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
2767 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
2768 bool session_state_changing, bool /*can_record*/)
2770 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2775 if (n_outputs().n_total() == 0) {
2779 if (!_active || n_inputs() == ChanCount::ZERO) {
2780 silence_unlocked (nframes);
2783 if (session_state_changing) {
2784 if (_session.transport_speed() != 0.0f) {
2785 /* we're rolling but some state is changing (e.g. our diskstream contents)
2786 so we cannot use them. Be silent till this is over.
2788 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
2790 silence_unlocked (nframes);
2793 /* we're really not rolling, so we're either delivery silence or actually
2794 monitoring, both of which are safe to do while session_state_changing is true.
2798 _amp->apply_gain_automation (false);
2799 passthru (start_frame, end_frame, nframes, 0);
2805 Route::check_initial_delay (framecnt_t nframes, framecnt_t& transport_frame)
2807 if (_roll_delay > nframes) {
2809 _roll_delay -= nframes;
2810 silence_unlocked (nframes);
2811 /* transport frame is not legal for caller to use */
2814 } else if (_roll_delay > 0) {
2816 nframes -= _roll_delay;
2817 silence_unlocked (_roll_delay);
2818 transport_frame += _roll_delay;
2820 /* shuffle all the port buffers for things that lead "out" of this Route
2821 to reflect that we just wrote _roll_delay frames of silence.
2824 Glib::RWLock::ReaderLock lm (_processor_lock);
2825 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2826 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
2828 iop->increment_port_buffer_offset (_roll_delay);
2831 _output->increment_port_buffer_offset (_roll_delay);
2841 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
2842 bool /*can_record*/, bool& /* need_butler */)
2844 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2849 automation_snapshot (_session.transport_frame(), false);
2851 if (n_outputs().n_total() == 0) {
2855 if (!_active || n_inputs().n_total() == 0) {
2856 silence_unlocked (nframes);
2860 framecnt_t unused = 0;
2862 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
2868 passthru (start_frame, end_frame, nframes, declick);
2874 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
2875 bool /*can_record*/, bool& /* need_butler */)
2882 Route::toggle_monitor_input ()
2884 for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
2885 i->ensure_monitor_input( ! i->monitoring_input());
2890 Route::has_external_redirects () const
2892 // FIXME: what about sends? - they don't return a signal back to ardour?
2894 boost::shared_ptr<const PortInsert> pi;
2896 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2898 if ((pi = boost::dynamic_pointer_cast<const PortInsert>(*i)) != 0) {
2900 for (PortSet::const_iterator port = pi->output()->ports().begin(); port != pi->output()->ports().end(); ++port) {
2902 string port_name = port->name();
2903 string client_name = port_name.substr (0, port_name.find(':'));
2905 /* only say "yes" if the redirect is actually in use */
2907 if (client_name != "ardour" && pi->active()) {
2918 Route::flush_processors ()
2920 /* XXX shouldn't really try to take this lock, since
2921 this is called from the RT audio thread.
2924 Glib::RWLock::ReaderLock lm (_processor_lock);
2926 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2932 Route::set_meter_point (MeterPoint p, bool force)
2934 /* CAN BE CALLED FROM PROCESS CONTEXT */
2936 if (_meter_point == p && !force) {
2942 bool meter_was_visible_to_user = _meter->display_to_user ();
2945 Glib::RWLock::WriterLock lm (_processor_lock);
2947 if (_meter_point != MeterCustom) {
2949 _meter->set_display_to_user (false);
2951 setup_invisible_processors ();
2953 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
2957 if (loc == _processors.begin()) {
2958 m_in = _input->n_ports();
2960 ProcessorList::iterator before = loc;
2962 m_in = (*before)->output_streams ();
2965 _meter->reflect_inputs (m_in);
2967 /* we do not need to reconfigure the processors, because the meter
2968 (a) is always ready to handle processor_max_streams
2969 (b) is always an N-in/N-out processor, and thus moving
2970 it doesn't require any changes to the other processors.
2975 // just make it visible and let the user move it
2977 _meter->set_display_to_user (true);
2981 meter_change (); /* EMIT SIGNAL */
2983 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
2985 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
2989 Route::listen_position_changed ()
2992 Glib::RWLock::WriterLock lm (_processor_lock);
2993 ProcessorState pstate (this);
2996 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2998 if (configure_processors_unlocked (0)) {
3000 configure_processors_unlocked (0); // it worked before we tried to add it ...
3006 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3007 _session.set_dirty ();
3010 boost::shared_ptr<CapturingProcessor>
3011 Route::add_export_point()
3013 if (!_capturing_processor) {
3015 _capturing_processor.reset (new CapturingProcessor (_session));
3016 _capturing_processor->activate ();
3019 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3020 configure_processors (0);
3025 return _capturing_processor;
3029 Route::update_signal_latency ()
3031 framecnt_t l = _output->user_latency();
3033 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3034 if ((*i)->active ()) {
3035 l += (*i)->signal_latency ();
3039 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3041 if (_signal_latency != l) {
3042 _signal_latency = l;
3043 signal_latency_changed (); /* EMIT SIGNAL */
3046 return _signal_latency;
3050 Route::set_user_latency (framecnt_t nframes)
3052 _output->set_user_latency (nframes);
3053 _session.update_latency_compensation ();
3057 Route::set_latency_compensation (framecnt_t longest_session_latency)
3059 framecnt_t old = _initial_delay;
3061 if (_signal_latency < longest_session_latency) {
3062 _initial_delay = longest_session_latency - _signal_latency;
3067 DEBUG_TRACE (DEBUG::Latency, string_compose (
3068 "%1: compensate for maximum latency of %2,"
3069 "given own latency of %3, using initial delay of %4\n",
3070 name(), longest_session_latency, _signal_latency, _initial_delay));
3072 if (_initial_delay != old) {
3073 initial_delay_changed (); /* EMIT SIGNAL */
3076 if (_session.transport_stopped()) {
3077 _roll_delay = _initial_delay;
3082 Route::automation_snapshot (framepos_t now, bool force)
3085 _pannable->automation_snapshot (now, force);
3088 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3089 (*i)->automation_snapshot (now, force);
3093 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3094 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3095 boost::shared_ptr<AutomationList>(), name)
3098 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3103 Route::SoloControllable::set_value (double val)
3105 bool bval = ((val >= 0.5f) ? true: false);
3107 boost::shared_ptr<RouteList> rl (new RouteList);
3109 boost::shared_ptr<Route> r = _route.lock ();
3116 if (Config->get_solo_control_is_listen_control()) {
3117 _session.set_listen (rl, bval);
3119 _session.set_solo (rl, bval);
3124 Route::SoloControllable::get_value () const
3126 boost::shared_ptr<Route> r = _route.lock ();
3131 if (Config->get_solo_control_is_listen_control()) {
3132 return r->listening_via_monitor() ? 1.0f : 0.0f;
3134 return r->self_soloed() ? 1.0f : 0.0f;
3138 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3139 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3140 boost::shared_ptr<AutomationList>(), name)
3143 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3148 Route::MuteControllable::set_value (double val)
3150 bool bval = ((val >= 0.5f) ? true: false);
3152 boost::shared_ptr<RouteList> rl (new RouteList);
3154 boost::shared_ptr<Route> r = _route.lock ();
3160 _session.set_mute (rl, bval);
3164 Route::MuteControllable::get_value () const
3166 boost::shared_ptr<Route> r = _route.lock ();
3171 return r->muted() ? 1.0f : 0.0f;
3175 Route::set_block_size (pframes_t nframes)
3177 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3178 (*i)->set_block_size (nframes);
3181 _session.ensure_buffers (n_process_buffers ());
3185 Route::protect_automation ()
3187 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3188 (*i)->protect_automation();
3192 Route::set_pending_declick (int declick)
3195 /* this call is not allowed to turn off a pending declick unless "force" is true */
3197 _pending_declick = declick;
3199 // cerr << _name << ": after setting to " << declick << " pending declick = " << _pending_declick << endl;
3201 _pending_declick = 0;
3206 /** Shift automation forwards from a particular place, thereby inserting time.
3207 * Adds undo commands for any shifts that are performed.
3209 * @param pos Position to start shifting from.
3210 * @param frames Amount to shift forwards by.
3214 Route::shift (framepos_t pos, framecnt_t frames)
3216 /* gain automation */
3218 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3220 XMLNode &before = gc->alist()->get_state ();
3221 gc->alist()->shift (pos, frames);
3222 XMLNode &after = gc->alist()->get_state ();
3223 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3226 /* pan automation */
3228 ControlSet::Controls& c (_pannable->controls());
3230 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3231 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3233 boost::shared_ptr<AutomationList> al = pc->alist();
3234 XMLNode& before = al->get_state ();
3235 al->shift (pos, frames);
3236 XMLNode& after = al->get_state ();
3237 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3242 /* redirect automation */
3244 Glib::RWLock::ReaderLock lm (_processor_lock);
3245 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3247 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3249 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3250 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3252 boost::shared_ptr<AutomationList> al = ac->alist();
3253 XMLNode &before = al->get_state ();
3254 al->shift (pos, frames);
3255 XMLNode &after = al->get_state ();
3256 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3265 Route::save_as_template (const string& path, const string& name)
3267 XMLNode& node (state (false));
3270 IO::set_name_in_state (*node.children().front(), name);
3272 tree.set_root (&node);
3273 return tree.write (path.c_str());
3278 Route::set_name (const string& str)
3284 name = Route::ensure_track_or_route_name (str, _session);
3285 SessionObject::set_name (name);
3287 ret = (_input->set_name(name) && _output->set_name(name));
3290 /* rename the main outs. Leave other IO processors
3291 * with whatever name they already have, because its
3292 * just fine as it is (it will not contain the route
3293 * name if its a port insert, port send or port return).
3297 if (_main_outs->set_name (name)) {
3298 /* XXX returning false here is stupid because
3299 we already changed the route name.
3309 boost::shared_ptr<Send>
3310 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3312 Glib::RWLock::ReaderLock lm (_processor_lock);
3314 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3315 boost::shared_ptr<InternalSend> send;
3317 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3318 if (send->target_route() == target) {
3324 return boost::shared_ptr<Send>();
3327 /** @param c Audio channel index.
3328 * @param yn true to invert phase, otherwise false.
3331 Route::set_phase_invert (uint32_t c, bool yn)
3333 if (_phase_invert[c] != yn) {
3334 _phase_invert[c] = yn;
3335 phase_invert_changed (); /* EMIT SIGNAL */
3336 _session.set_dirty ();
3341 Route::set_phase_invert (boost::dynamic_bitset<> p)
3343 if (_phase_invert != p) {
3345 phase_invert_changed (); /* EMIT SIGNAL */
3346 _session.set_dirty ();
3351 Route::phase_invert (uint32_t c) const
3353 return _phase_invert[c];
3356 boost::dynamic_bitset<>
3357 Route::phase_invert () const
3359 return _phase_invert;
3363 Route::set_denormal_protection (bool yn)
3365 if (_denormal_protection != yn) {
3366 _denormal_protection = yn;
3367 denormal_protection_changed (); /* EMIT SIGNAL */
3372 Route::denormal_protection () const
3374 return _denormal_protection;
3378 Route::set_active (bool yn, void* src)
3380 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3381 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3385 if (_active != yn) {
3387 _input->set_active (yn);
3388 _output->set_active (yn);
3389 active_changed (); // EMIT SIGNAL
3396 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3402 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3404 boost::shared_ptr<Send> s;
3405 boost::shared_ptr<Return> r;
3407 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3408 s->meter()->meter();
3409 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3410 r->meter()->meter ();
3415 boost::shared_ptr<Pannable>
3416 Route::pannable() const
3421 boost::shared_ptr<Panner>
3422 Route::panner() const
3425 return _main_outs->panner_shell()->panner();
3428 boost::shared_ptr<PannerShell>
3429 Route::panner_shell() const
3431 return _main_outs->panner_shell();
3434 boost::shared_ptr<AutomationControl>
3435 Route::gain_control() const
3437 return _amp->gain_control();
3440 boost::shared_ptr<AutomationControl>
3441 Route::get_control (const Evoral::Parameter& param)
3443 /* either we own the control or .... */
3445 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3449 /* maybe one of our processors does or ... */
3451 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3452 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3453 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3461 /* nobody does so we'll make a new one */
3463 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3470 boost::shared_ptr<Processor>
3471 Route::nth_plugin (uint32_t n)
3473 Glib::RWLock::ReaderLock lm (_processor_lock);
3474 ProcessorList::iterator i;
3476 for (i = _processors.begin(); i != _processors.end(); ++i) {
3477 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3484 return boost::shared_ptr<Processor> ();
3487 boost::shared_ptr<Processor>
3488 Route::nth_send (uint32_t n)
3490 Glib::RWLock::ReaderLock lm (_processor_lock);
3491 ProcessorList::iterator i;
3493 for (i = _processors.begin(); i != _processors.end(); ++i) {
3494 if (boost::dynamic_pointer_cast<Send> (*i)) {
3501 return boost::shared_ptr<Processor> ();
3505 Route::has_io_processor_named (const string& name)
3507 Glib::RWLock::ReaderLock lm (_processor_lock);
3508 ProcessorList::iterator i;
3510 for (i = _processors.begin(); i != _processors.end(); ++i) {
3511 if (boost::dynamic_pointer_cast<Send> (*i) ||
3512 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3513 if ((*i)->name() == name) {
3522 MuteMaster::MutePoint
3523 Route::mute_points () const
3525 return _mute_master->mute_points ();
3529 Route::set_processor_positions ()
3531 Glib::RWLock::ReaderLock lm (_processor_lock);
3533 bool had_amp = false;
3534 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3535 (*i)->set_pre_fader (!had_amp);
3536 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3542 /** Called when there is a proposed change to the input port count */
3544 Route::input_port_count_changing (ChanCount to)
3546 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3548 /* The processors cannot be configured with the new input arrangement, so
3554 /* The change is ok */
3559 Route::unknown_processors () const
3563 Glib::RWLock::ReaderLock lm (_processor_lock);
3564 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3565 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3566 p.push_back ((*i)->name ());
3575 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3577 /* we assume that all our input ports feed all our output ports. its not
3578 universally true, but the alternative is way too corner-case to worry about.
3581 jack_latency_range_t all_connections;
3583 all_connections.min = ~((jack_nframes_t) 0);
3584 all_connections.max = 0;
3586 /* iterate over all "from" ports and determine the latency range for all of their
3587 connections to the "outside" (outside of this Route).
3590 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3592 jack_latency_range_t range;
3594 p->get_connected_latency_range (range, playback);
3596 all_connections.min = min (all_connections.min, range.min);
3597 all_connections.max = max (all_connections.max, range.max);
3600 /* set the "from" port latencies to the max/min range of all their connections */
3602 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3603 p->set_private_latency_range (all_connections, playback);
3606 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3608 all_connections.min += our_latency;
3609 all_connections.max += our_latency;
3611 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3612 p->set_private_latency_range (all_connections, playback);
3615 return all_connections.max;
3619 Route::set_private_port_latencies (bool playback) const
3621 framecnt_t own_latency = 0;
3623 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3624 OR LATENCY CALLBACK.
3626 This is called (early) from the latency callback. It computes the REAL
3627 latency associated with each port and stores the result as the "private"
3628 latency of the port. A later call to Route::set_public_port_latencies()
3629 sets all ports to the same value to reflect the fact that we do latency
3630 compensation and so all signals are delayed by the same amount as they
3631 flow through ardour.
3634 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3635 if ((*i)->active ()) {
3636 own_latency += (*i)->signal_latency ();
3641 /* playback: propagate latency from "outside the route" to outputs to inputs */
3642 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3644 /* capture: propagate latency from "outside the route" to inputs to outputs */
3645 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3650 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3652 /* this is called to set the JACK-visible port latencies, which take
3653 latency compensation into account.
3656 jack_latency_range_t range;
3662 const PortSet& ports (_input->ports());
3663 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3664 p->set_public_latency_range (range, playback);
3669 const PortSet& ports (_output->ports());
3670 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3671 p->set_public_latency_range (range, playback);
3676 /** Put the invisible processors in the right place in _processors.
3677 * Must be called with a writer lock on _processor_lock held.
3680 Route::setup_invisible_processors ()
3683 Glib::RWLock::WriterLock lm (_processor_lock, Glib::TRY_LOCK);
3684 assert (!lm.locked ());
3688 /* too early to be doing this stuff */
3692 /* we'll build this new list here and then use it */
3694 ProcessorList new_processors;
3696 /* find visible processors */
3698 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3699 if ((*i)->display_to_user ()) {
3700 new_processors.push_back (*i);
3706 ProcessorList::iterator amp = new_processors.begin ();
3707 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3711 assert (amp != _processors.end ());
3713 /* and the processor after the amp */
3715 ProcessorList::iterator after_amp = amp;
3721 switch (_meter_point) {
3723 assert (!_meter->display_to_user ());
3724 new_processors.push_front (_meter);
3727 assert (!_meter->display_to_user ());
3728 new_processors.insert (amp, _meter);
3730 case MeterPostFader:
3731 /* do nothing here */
3734 /* do nothing here */
3737 /* the meter is visible, so we don't touch it here */
3744 assert (_main_outs);
3745 assert (!_main_outs->display_to_user ());
3746 new_processors.push_back (_main_outs);
3748 /* iterator for the main outs */
3750 ProcessorList::iterator main = new_processors.end();
3753 /* OUTPUT METERING */
3755 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3756 assert (!_meter->display_to_user ());
3758 /* add the processor just before or just after the main outs */
3760 ProcessorList::iterator meter_point = main;
3762 if (_meter_point == MeterOutput) {
3765 new_processors.insert (meter_point, _meter);
3770 if (_monitor_send && !is_monitor ()) {
3771 assert (!_monitor_send->display_to_user ());
3772 if (Config->get_solo_control_is_listen_control()) {
3773 switch (Config->get_listen_position ()) {
3774 case PreFaderListen:
3775 switch (Config->get_pfl_position ()) {
3776 case PFLFromBeforeProcessors:
3777 new_processors.push_front (_monitor_send);
3779 case PFLFromAfterProcessors:
3780 new_processors.insert (amp, _monitor_send);
3783 _monitor_send->set_can_pan (false);
3785 case AfterFaderListen:
3786 switch (Config->get_afl_position ()) {
3787 case AFLFromBeforeProcessors:
3788 new_processors.insert (after_amp, _monitor_send);
3790 case AFLFromAfterProcessors:
3791 new_processors.insert (new_processors.end(), _monitor_send);
3794 _monitor_send->set_can_pan (true);
3798 new_processors.insert (new_processors.end(), _monitor_send);
3799 _monitor_send->set_can_pan (false);
3803 /* MONITOR CONTROL */
3805 if (_monitor_control && is_monitor ()) {
3806 assert (!_monitor_control->display_to_user ());
3807 new_processors.push_front (_monitor_control);
3810 /* INTERNAL RETURN */
3812 /* doing this here means that any monitor control will come just after
3817 assert (!_intreturn->display_to_user ());
3818 new_processors.push_front (_intreturn);
3821 /* EXPORT PROCESSOR */
3823 if (_capturing_processor) {
3824 assert (!_capturing_processor->display_to_user ());
3825 new_processors.push_front (_capturing_processor);
3828 _processors = new_processors;
3830 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
3831 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3832 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
3837 Route::should_monitor () const
3839 switch (Config->get_monitoring_model()) {
3840 case HardwareMonitoring:
3841 case ExternalMonitoring:
3842 return !record_enabled() || (_session.config.get_auto_input() && !_session.actively_recording());
3854 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3855 Glib::RWLock::ReaderLock lp (_processor_lock);
3859 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3860 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);