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/unknown_processor.h"
69 #include "ardour/capturing_processor.h"
74 using namespace ARDOUR;
77 uint32_t Route::order_key_cnt = 0;
78 PBD::Signal1<void,string const&> Route::SyncOrderKeys;
79 PBD::Signal0<void> Route::RemoteControlIDChange;
81 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
82 : SessionObject (sess, name)
84 , GraphNode (sess._process_graph)
90 , _pending_declick (true)
91 , _meter_point (MeterPostFader)
93 , _soloed_by_others_upstream (0)
94 , _soloed_by_others_downstream (0)
96 , _denormal_protection (false)
99 , _declickable (false)
100 , _mute_master (new MuteMaster (sess, name))
101 , _have_internal_generator (false)
103 , _default_type (default_type)
104 , _remote_control_id (0)
105 , _in_configure_processors (false)
106 , _custom_meter_position_noted (false)
107 , _last_custom_meter_was_at_end (false)
109 processor_max_streams.reset();
110 order_keys[N_("signal")] = order_key_cnt++;
113 set_remote_control_id (MasterBusRemoteControlID);
114 } else if (is_monitor()) {
115 set_remote_control_id (MonitorBusRemoteControlID);
123 /* add standard controls */
125 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
126 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
128 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
129 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
131 add_control (_solo_control);
132 add_control (_mute_control);
136 if (!(_flags & Route::MonitorOut)) {
137 _pannable.reset (new Pannable (_session));
140 /* input and output objects */
142 _input.reset (new IO (_session, _name, IO::Input, _default_type));
143 _output.reset (new IO (_session, _name, IO::Output, _default_type));
145 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
146 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
148 /* add amp processor */
150 _amp.reset (new Amp (_session));
151 add_processor (_amp, PostFader);
153 /* create standard processors: meter, main outs, monitor out;
154 they will be added to _processors by setup_invisible_processors ()
157 _meter.reset (new PeakMeter (_session));
158 _meter->set_display_to_user (false);
161 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
162 _main_outs->activate ();
165 /* where we listen to tracks */
166 _intreturn.reset (new InternalReturn (_session));
167 _intreturn->activate ();
169 /* the thing that provides proper control over a control/monitor/listen bus
170 (such as per-channel cut, dim, solo, invert, etc).
172 _monitor_control.reset (new MonitorProcessor (_session));
173 _monitor_control->activate ();
176 if (is_master() || is_monitor() || is_hidden()) {
177 _mute_master->set_solo_ignore (true);
180 /* now that we have _meter, its safe to connect to this */
182 Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
185 /* run a configure so that the invisible processors get set up */
186 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
187 configure_processors (0);
195 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
197 /* do this early so that we don't get incoming signals as we are going through destruction
202 /* don't use clear_processors here, as it depends on the session which may
203 be half-destroyed by now
206 Glib::RWLock::WriterLock lm (_processor_lock);
207 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
208 (*i)->drop_references ();
211 _processors.clear ();
215 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
217 /* force IDs for master/monitor busses and prevent
218 any other route from accidentally getting these IDs
219 (i.e. legacy sessions)
222 if (is_master() && id != MasterBusRemoteControlID) {
223 id = MasterBusRemoteControlID;
226 if (is_monitor() && id != MonitorBusRemoteControlID) {
227 id = MonitorBusRemoteControlID;
230 /* don't allow it to collide */
232 if (!is_master () && !is_monitor() &&
233 (id == MasterBusRemoteControlID || id == MonitorBusRemoteControlID)) {
234 id += MonitorBusRemoteControlID;
237 if (id != _remote_control_id) {
238 _remote_control_id = id;
239 RemoteControlIDChanged ();
240 if (notify_class_listeners) {
241 RemoteControlIDChange ();
247 Route::remote_control_id() const
249 return _remote_control_id;
253 Route::order_key (std::string const & name) const
255 OrderKeys::const_iterator i = order_keys.find (name);
256 if (i == order_keys.end()) {
264 Route::set_order_key (std::string const & name, int32_t n)
266 bool changed = false;
268 /* This method looks more complicated than it should, but
269 it's important that we don't emit order_key_changed unless
270 it actually has, as expensive things happen on receipt of that
274 if (order_keys.find(name) == order_keys.end() || order_keys[name] != n) {
275 order_keys[name] = n;
279 if (Config->get_sync_all_route_ordering()) {
280 for (OrderKeys::iterator x = order_keys.begin(); x != order_keys.end(); ++x) {
281 if (x->second != n) {
289 order_key_changed (); /* EMIT SIGNAL */
290 _session.set_dirty ();
294 /** Set all order keys to be the same as that for `base', if such a key
295 * exists in this route.
296 * @param base Base key.
299 Route::sync_order_keys (std::string const & base)
301 if (order_keys.empty()) {
305 OrderKeys::iterator i;
308 if ((i = order_keys.find (base)) == order_keys.end()) {
309 /* key doesn't exist, use the first existing key (during session initialization) */
310 i = order_keys.begin();
314 /* key exists - use it and reset all others (actually, itself included) */
316 i = order_keys.begin();
319 bool changed = false;
321 for (; i != order_keys.end(); ++i) {
322 if (i->second != key) {
329 order_key_changed (); /* EMIT SIGNAL */
334 Route::ensure_track_or_route_name(string name, Session &session)
336 string newname = name;
338 while (!session.io_name_is_legal (newname)) {
339 newname = bump_name_once (newname, '.');
347 Route::inc_gain (gain_t fraction, void *src)
349 _amp->inc_gain (fraction, src);
353 Route::set_gain (gain_t val, void *src)
355 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
357 if (_route_group->is_relative()) {
359 gain_t usable_gain = _amp->gain();
360 if (usable_gain < 0.000001f) {
361 usable_gain = 0.000001f;
365 if (delta < 0.000001f) {
369 delta -= usable_gain;
374 gain_t factor = delta / usable_gain;
377 factor = _route_group->get_max_factor(factor);
378 if (factor == 0.0f) {
379 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
383 factor = _route_group->get_min_factor(factor);
384 if (factor == 0.0f) {
385 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
390 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
394 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
400 if (val == _amp->gain()) {
404 _amp->set_gain (val, src);
408 Route::maybe_declick (BufferSet&, framecnt_t, int)
410 /* this is the "bus" implementation and they never declick.
415 /** Process this route for one (sub) cycle (process thread)
417 * @param bufs Scratch buffers to use for the signal path
418 * @param start_frame Initial transport frame
419 * @param end_frame Final transport frame
420 * @param nframes Number of frames to output (to ports)
422 * Note that (end_frame - start_frame) may not be equal to nframes when the
423 * transport speed isn't 1.0 (eg varispeed).
426 Route::process_output_buffers (BufferSet& bufs,
427 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
428 int declick, bool gain_automation_ok)
430 bufs.set_is_silent (false);
432 /* figure out if we're going to use gain automation */
433 if (gain_automation_ok) {
434 _amp->setup_gain_automation (start_frame, end_frame, nframes);
436 _amp->apply_gain_automation (false);
439 /* Tell main outs what to do about monitoring. We do this so that
440 on a transition between monitoring states we get a de-clicking gain
441 change in the _main_outs delivery.
443 _main_outs->no_outs_cuz_we_no_monitor (monitoring_state () == MonitoringSilence);
446 /* -------------------------------------------------------------------------------------------
447 GLOBAL DECLICK (for transport changes etc.)
448 ----------------------------------------------------------------------------------------- */
450 maybe_declick (bufs, nframes, declick);
451 _pending_declick = 0;
453 /* -------------------------------------------------------------------------------------------
454 DENORMAL CONTROL/PHASE INVERT
455 ----------------------------------------------------------------------------------------- */
457 if (_phase_invert.any ()) {
461 if (_denormal_protection || Config->get_denormal_protection()) {
463 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
464 Sample* const sp = i->data();
466 if (_phase_invert[chn]) {
467 for (pframes_t nx = 0; nx < nframes; ++nx) {
472 for (pframes_t nx = 0; nx < nframes; ++nx) {
480 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
481 Sample* const sp = i->data();
483 if (_phase_invert[chn]) {
484 for (pframes_t nx = 0; nx < nframes; ++nx) {
493 if (_denormal_protection || Config->get_denormal_protection()) {
495 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
496 Sample* const sp = i->data();
497 for (pframes_t nx = 0; nx < nframes; ++nx) {
505 /* -------------------------------------------------------------------------------------------
507 ----------------------------------------------------------------------------------------- */
509 /* set this to be true if the meter will already have been ::run() earlier */
510 bool const meter_already_run = metering_state() == MeteringInput;
512 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
514 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
518 if (boost::dynamic_pointer_cast<PeakMeter> (*i) && meter_already_run) {
519 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
524 /* if it has any inputs, make sure they match */
525 if ((*i)->input_streams() != ChanCount::ZERO) {
526 if (bufs.count() != (*i)->input_streams()) {
527 cerr << _name << " bufs = " << bufs.count()
528 << " input for " << (*i)->name() << " = " << (*i)->input_streams()
535 /* should we NOT run plugins here if the route is inactive?
536 do we catch route != active somewhere higher?
539 (*i)->run (bufs, start_frame, end_frame, nframes, *i != _processors.back());
540 bufs.set_count ((*i)->output_streams());
545 Route::n_process_buffers ()
547 return max (_input->n_ports(), processor_max_streams);
551 Route::passthru (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
553 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
557 assert (bufs.available() >= input_streams());
559 if (_input->n_ports() == ChanCount::ZERO) {
560 silence_unlocked (nframes);
563 bufs.set_count (input_streams());
565 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
567 /* control/monitor bus ignores input ports when something is
568 feeding the listen "stream". data will "arrive" into the
569 route from the intreturn processor element.
571 bufs.silence (nframes, 0);
575 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
577 BufferSet::iterator o = bufs.begin(*t);
578 PortSet& ports (_input->ports());
580 for (PortSet::iterator i = ports.begin(*t); i != ports.end(*t); ++i, ++o) {
581 o->read_from (i->get_buffer(nframes), nframes);
586 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
587 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
591 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
593 BufferSet& bufs (_session.get_silent_buffers (n_process_buffers()));
595 bufs.set_count (_input->n_ports());
596 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
597 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
601 Route::set_listen (bool yn, void* src)
607 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
608 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
613 if (yn != _monitor_send->active()) {
615 _monitor_send->activate ();
616 _mute_master->set_soloed (true);
618 _monitor_send->deactivate ();
619 _mute_master->set_soloed (false);
622 listen_changed (src); /* EMIT SIGNAL */
628 Route::listening_via_monitor () const
631 return _monitor_send->active ();
638 Route::set_solo_safe (bool yn, void *src)
640 if (_solo_safe != yn) {
642 solo_safe_changed (src);
647 Route::solo_safe() const
653 Route::set_solo (bool yn, void *src)
659 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
660 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
664 if (self_soloed() != yn) {
666 set_mute_master_solo ();
667 solo_changed (true, src); /* EMIT SIGNAL */
668 _solo_control->Changed (); /* EMIT SIGNAL */
673 Route::set_self_solo (bool yn)
679 Route::mod_solo_by_others_upstream (int32_t delta)
685 uint32_t old_sbu = _soloed_by_others_upstream;
688 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
689 _soloed_by_others_upstream += delta;
691 _soloed_by_others_upstream = 0;
694 _soloed_by_others_upstream += delta;
697 DEBUG_TRACE (DEBUG::Solo, string_compose (
698 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
699 name(), delta, _soloed_by_others_upstream, old_sbu,
700 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
702 /* push the inverse solo change to everything that feeds us.
704 This is important for solo-within-group. When we solo 1 track out of N that
705 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
706 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
707 tracks that feed it. This will silence them if they were audible because
708 of a bus solo, but the newly soloed track will still be audible (because
711 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
715 if ((_self_solo || _soloed_by_others_downstream) &&
716 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
717 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
719 if (delta > 0 || !Config->get_exclusive_solo()) {
720 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
721 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
722 boost::shared_ptr<Route> sr = i->r.lock();
724 sr->mod_solo_by_others_downstream (-delta);
730 set_mute_master_solo ();
731 solo_changed (false, this);
735 Route::mod_solo_by_others_downstream (int32_t delta)
742 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
743 _soloed_by_others_downstream += delta;
745 _soloed_by_others_downstream = 0;
748 _soloed_by_others_downstream += delta;
751 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
753 set_mute_master_solo ();
754 solo_changed (false, this);
758 Route::set_mute_master_solo ()
760 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
764 Route::set_solo_isolated (bool yn, void *src)
766 if (is_master() || is_monitor() || is_hidden()) {
770 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
771 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
775 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
777 boost::shared_ptr<RouteList> routes = _session.get_routes ();
778 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
780 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
785 bool does_feed = direct_feeds_according_to_graph (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
787 if (does_feed && !sends_only) {
788 (*i)->set_solo_isolated (yn, (*i)->route_group());
792 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
794 bool changed = false;
797 if (_solo_isolated == 0) {
798 _mute_master->set_solo_ignore (true);
803 if (_solo_isolated > 0) {
805 if (_solo_isolated == 0) {
806 _mute_master->set_solo_ignore (false);
813 solo_isolated_changed (src);
818 Route::solo_isolated () const
820 return _solo_isolated > 0;
824 Route::set_mute_points (MuteMaster::MutePoint mp)
826 _mute_master->set_mute_points (mp);
827 mute_points_changed (); /* EMIT SIGNAL */
829 if (_mute_master->muted_by_self()) {
830 mute_changed (this); /* EMIT SIGNAL */
831 _mute_control->Changed (); /* EMIT SIGNAL */
836 Route::set_mute (bool yn, void *src)
838 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
839 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
844 _mute_master->set_muted_by_self (yn);
845 /* allow any derived classes to respond to the mute change
846 before anybody else knows about it.
849 /* tell everyone else */
850 mute_changed (src); /* EMIT SIGNAL */
851 _mute_control->Changed (); /* EMIT SIGNAL */
856 Route::muted () const
858 return _mute_master->muted_by_self();
863 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
865 cerr << name << " {" << endl;
866 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
867 p != procs.end(); ++p) {
868 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
875 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
877 ProcessorList::iterator loc;
879 /* XXX this is not thread safe - we don't hold the lock across determining the iter
880 to add before and actually doing the insertion. dammit.
883 if (placement == PreFader) {
884 /* generic pre-fader: insert immediately before the amp */
885 loc = find (_processors.begin(), _processors.end(), _amp);
887 /* generic post-fader: insert right before the main outs */
888 loc = find (_processors.begin(), _processors.end(), _main_outs);
891 return add_processor (processor, loc, err, activation_allowed);
895 /** Add a processor to a route such that it ends up with a given index into the visible processors.
896 * @param index Index to add the processor at, or -1 to add at the end of the list.
900 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
902 /* XXX this is not thread safe - we don't hold the lock across determining the iter
903 to add before and actually doing the insertion. dammit.
907 return add_processor (processor, _processors.end(), err, activation_allowed);
910 ProcessorList::iterator i = _processors.begin ();
912 while (i != _processors.end() && j < index) {
913 if ((*i)->display_to_user()) {
920 return add_processor (processor, i, err, activation_allowed);
923 /** Add a processor to the route.
924 * @param iter an iterator in _processors; the new processor will be inserted immediately before this location.
927 Route::add_processor (boost::shared_ptr<Processor> processor, ProcessorList::iterator iter, ProcessorStreams* err, bool activation_allowed)
929 assert (processor != _meter);
930 assert (processor != _main_outs);
932 DEBUG_TRACE (DEBUG::Processors, string_compose (
933 "%1 adding processor %2\n", name(), processor->name()));
935 if (!_session.engine().connected() || !processor) {
940 Glib::RWLock::WriterLock lm (_processor_lock);
941 ProcessorState pstate (this);
943 boost::shared_ptr<PluginInsert> pi;
944 boost::shared_ptr<PortInsert> porti;
946 ProcessorList::iterator loc = find(_processors.begin(), _processors.end(), processor);
948 if (processor == _amp) {
949 // Ensure only one amp is in the list at any time
950 if (loc != _processors.end()) {
951 if (iter == loc) { // Already in place, do nothing
953 } else { // New position given, relocate
954 _processors.erase (loc);
959 if (loc != _processors.end()) {
960 cerr << "ERROR: Processor added to route twice!" << endl;
967 _processors.insert (loc, processor);
969 // Set up processor list channels. This will set processor->[input|output]_streams(),
970 // configure redirect ports properly, etc.
973 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
975 if (configure_processors_unlocked (err)) {
977 configure_processors_unlocked (0); // it worked before we tried to add it ...
982 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
984 if (pi->has_no_inputs ()) {
985 /* generator plugin */
986 _have_internal_generator = true;
991 if (activation_allowed) {
992 processor->activate ();
995 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
997 _output->set_user_latency (0);
1000 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1001 set_processor_positions ();
1007 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1009 const XMLProperty *prop;
1012 boost::shared_ptr<Processor> processor;
1014 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1015 so that we can add the processor in the right place (pre/post-fader)
1018 XMLNodeList const & children = node.children ();
1019 XMLNodeList::const_iterator i = children.begin ();
1021 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1025 Placement placement = PreFader;
1027 if (i != children.end()) {
1028 if ((prop = (*i)->property (X_("placement"))) != 0) {
1029 placement = Placement (string_2_enum (prop->value(), placement));
1033 if (node.name() == "Insert") {
1035 if ((prop = node.property ("type")) != 0) {
1037 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1038 prop->value() == "lv2" ||
1039 prop->value() == "vst" ||
1040 prop->value() == "lxvst" ||
1041 prop->value() == "audiounit") {
1043 processor.reset (new PluginInsert (_session));
1047 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1052 } else if (node.name() == "Send") {
1054 processor.reset (new Send (_session, _pannable, _mute_master));
1058 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1062 if (processor->set_state (node, version)) {
1066 return (add_processor (processor, placement) == 0);
1069 catch (failed_constructor &err) {
1070 warning << _("processor could not be created. Ignored.") << endmsg;
1076 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1078 /* NOTE: this is intended to be used ONLY when copying
1079 processors from another Route. Hence the subtle
1080 differences between this and ::add_processor()
1083 ProcessorList::iterator loc;
1086 loc = find(_processors.begin(), _processors.end(), before);
1088 /* nothing specified - at end */
1089 loc = _processors.end ();
1092 if (!_session.engine().connected()) {
1096 if (others.empty()) {
1101 Glib::RWLock::WriterLock lm (_processor_lock);
1102 ProcessorState pstate (this);
1104 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1110 boost::shared_ptr<PluginInsert> pi;
1112 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1116 _processors.insert (loc, *i);
1118 if ((*i)->active()) {
1123 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1124 if (configure_processors_unlocked (err)) {
1126 configure_processors_unlocked (0); // it worked before we tried to add it ...
1131 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1134 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1135 boost::shared_ptr<PluginInsert> pi;
1137 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1138 if (pi->has_no_inputs ()) {
1139 _have_internal_generator = true;
1145 _output->set_user_latency (0);
1148 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1149 set_processor_positions ();
1155 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1157 if (p == PreFader) {
1158 start = _processors.begin();
1159 end = find(_processors.begin(), _processors.end(), _amp);
1161 start = find(_processors.begin(), _processors.end(), _amp);
1163 end = _processors.end();
1167 /** Turn off all processors with a given placement
1168 * @param p Placement of processors to disable
1171 Route::disable_processors (Placement p)
1173 Glib::RWLock::ReaderLock lm (_processor_lock);
1175 ProcessorList::iterator start, end;
1176 placement_range(p, start, end);
1178 for (ProcessorList::iterator i = start; i != end; ++i) {
1179 (*i)->deactivate ();
1182 _session.set_dirty ();
1185 /** Turn off all redirects
1188 Route::disable_processors ()
1190 Glib::RWLock::ReaderLock lm (_processor_lock);
1192 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1193 (*i)->deactivate ();
1196 _session.set_dirty ();
1199 /** Turn off all redirects with a given placement
1200 * @param p Placement of redirects to disable
1203 Route::disable_plugins (Placement p)
1205 Glib::RWLock::ReaderLock lm (_processor_lock);
1207 ProcessorList::iterator start, end;
1208 placement_range(p, start, end);
1210 for (ProcessorList::iterator i = start; i != end; ++i) {
1211 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1212 (*i)->deactivate ();
1216 _session.set_dirty ();
1219 /** Turn off all plugins
1222 Route::disable_plugins ()
1224 Glib::RWLock::ReaderLock lm (_processor_lock);
1226 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1227 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1228 (*i)->deactivate ();
1232 _session.set_dirty ();
1237 Route::ab_plugins (bool forward)
1239 Glib::RWLock::ReaderLock lm (_processor_lock);
1243 /* forward = turn off all active redirects, and mark them so that the next time
1244 we go the other way, we will revert them
1247 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1248 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1252 if ((*i)->active()) {
1253 (*i)->deactivate ();
1254 (*i)->set_next_ab_is_active (true);
1256 (*i)->set_next_ab_is_active (false);
1262 /* backward = if the redirect was marked to go active on the next ab, do so */
1264 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1266 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1270 if ((*i)->get_next_ab_is_active()) {
1273 (*i)->deactivate ();
1278 _session.set_dirty ();
1282 /** Remove processors with a given placement.
1283 * @param p Placement of processors to remove.
1286 Route::clear_processors (Placement p)
1288 if (!_session.engine().connected()) {
1292 bool already_deleting = _session.deletion_in_progress();
1293 if (!already_deleting) {
1294 _session.set_deletion_in_progress();
1298 Glib::RWLock::WriterLock lm (_processor_lock);
1299 ProcessorList new_list;
1300 ProcessorStreams err;
1301 bool seen_amp = false;
1303 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1309 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1311 /* you can't remove these */
1313 new_list.push_back (*i);
1320 new_list.push_back (*i);
1323 (*i)->drop_references ();
1331 (*i)->drop_references ();
1334 new_list.push_back (*i);
1341 _processors = new_list;
1344 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1345 configure_processors_unlocked (&err); // this can't fail
1349 processor_max_streams.reset();
1350 _have_internal_generator = false;
1351 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1352 set_processor_positions ();
1354 if (!already_deleting) {
1355 _session.clear_deletion_in_progress();
1360 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1362 /* these can never be removed */
1364 if (processor == _amp || processor == _meter || processor == _main_outs) {
1368 if (!_session.engine().connected()) {
1372 processor_max_streams.reset();
1375 Glib::RWLock::WriterLock lm (_processor_lock);
1376 ProcessorState pstate (this);
1378 ProcessorList::iterator i;
1379 bool removed = false;
1381 for (i = _processors.begin(); i != _processors.end(); ) {
1382 if (*i == processor) {
1384 /* move along, see failure case for configure_processors()
1385 where we may need to reconfigure the processor.
1388 /* stop redirects that send signals to JACK ports
1389 from causing noise as a result of no longer being
1393 boost::shared_ptr<IOProcessor> iop;
1395 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1397 iop->input()->disconnect (this);
1399 if (iop->output()) {
1400 iop->output()->disconnect (this);
1404 i = _processors.erase (i);
1412 _output->set_user_latency (0);
1420 if (need_process_lock) {
1421 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1423 if (configure_processors_unlocked (err)) {
1425 /* we know this will work, because it worked before :) */
1426 configure_processors_unlocked (0);
1430 if (configure_processors_unlocked (err)) {
1432 /* we know this will work, because it worked before :) */
1433 configure_processors_unlocked (0);
1438 _have_internal_generator = false;
1440 for (i = _processors.begin(); i != _processors.end(); ++i) {
1441 boost::shared_ptr<PluginInsert> pi;
1443 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1444 if (pi->has_no_inputs ()) {
1445 _have_internal_generator = true;
1452 processor->drop_references ();
1453 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1454 set_processor_positions ();
1460 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1462 ProcessorList deleted;
1464 if (!_session.engine().connected()) {
1468 processor_max_streams.reset();
1471 Glib::RWLock::WriterLock lm (_processor_lock);
1472 ProcessorState pstate (this);
1474 ProcessorList::iterator i;
1475 boost::shared_ptr<Processor> processor;
1477 for (i = _processors.begin(); i != _processors.end(); ) {
1481 /* these can never be removed */
1483 if (processor == _amp || processor == _meter || processor == _main_outs) {
1488 /* see if its in the list of processors to delete */
1490 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1495 /* stop IOProcessors that send to JACK ports
1496 from causing noise as a result of no longer being
1500 boost::shared_ptr<IOProcessor> iop;
1502 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1506 deleted.push_back (processor);
1507 i = _processors.erase (i);
1510 if (deleted.empty()) {
1511 /* none of those in the requested list were found */
1515 _output->set_user_latency (0);
1518 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1520 if (configure_processors_unlocked (err)) {
1522 /* we know this will work, because it worked before :) */
1523 configure_processors_unlocked (0);
1528 _have_internal_generator = false;
1530 for (i = _processors.begin(); i != _processors.end(); ++i) {
1531 boost::shared_ptr<PluginInsert> pi;
1533 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1534 if (pi->has_no_inputs ()) {
1535 _have_internal_generator = true;
1542 /* now try to do what we need to so that those that were removed will be deleted */
1544 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1545 (*i)->drop_references ();
1548 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1549 set_processor_positions ();
1554 /** Caller must hold process lock */
1556 Route::configure_processors (ProcessorStreams* err)
1558 assert (!AudioEngine::instance()->process_lock().trylock());
1560 if (!_in_configure_processors) {
1561 Glib::RWLock::WriterLock lm (_processor_lock);
1562 return configure_processors_unlocked (err);
1569 Route::input_streams () const
1571 return _input->n_ports ();
1574 list<pair<ChanCount, ChanCount> >
1575 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1577 Glib::RWLock::ReaderLock lm (_processor_lock);
1579 return try_configure_processors_unlocked (in, err);
1582 list<pair<ChanCount, ChanCount> >
1583 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1585 // Check each processor in order to see if we can configure as requested
1587 list<pair<ChanCount, ChanCount> > configuration;
1590 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1591 DEBUG_TRACE (DEBUG::Processors, "{\n");
1593 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1595 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1596 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1600 if ((*p)->can_support_io_configuration(in, out)) {
1601 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1602 configuration.push_back(make_pair(in, out));
1609 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1610 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1611 DEBUG_TRACE (DEBUG::Processors, "}\n");
1612 return list<pair<ChanCount, ChanCount> > ();
1616 DEBUG_TRACE (DEBUG::Processors, "}\n");
1618 return configuration;
1621 /** Set the input/output configuration of each processor in the processors list.
1622 * Caller must hold process lock.
1623 * Return 0 on success, otherwise configuration is impossible.
1626 Route::configure_processors_unlocked (ProcessorStreams* err)
1628 assert (!AudioEngine::instance()->process_lock().trylock());
1630 if (_in_configure_processors) {
1634 /* put invisible processors where they should be */
1635 setup_invisible_processors ();
1637 _in_configure_processors = true;
1639 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1641 if (configuration.empty ()) {
1642 _in_configure_processors = false;
1648 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1649 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1651 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1655 (*p)->configure_io(c->first, c->second);
1656 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1657 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1662 _meter->reset_max_channels (processor_max_streams);
1665 /* make sure we have sufficient scratch buffers to cope with the new processor
1668 _session.ensure_buffers (n_process_buffers ());
1670 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1672 _in_configure_processors = false;
1676 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1677 * @param state New active state for those processors.
1680 Route::all_visible_processors_active (bool state)
1682 Glib::RWLock::ReaderLock lm (_processor_lock);
1684 if (_processors.empty()) {
1688 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1689 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1696 (*i)->deactivate ();
1700 _session.set_dirty ();
1704 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1706 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1707 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1708 processors in the current actual processor list that are hidden. Any visible processors
1709 in the current list but not in "new_order" will be assumed to be deleted.
1713 Glib::RWLock::WriterLock lm (_processor_lock);
1714 ProcessorState pstate (this);
1716 ProcessorList::iterator oiter;
1717 ProcessorList::const_iterator niter;
1718 ProcessorList as_it_will_be;
1720 oiter = _processors.begin();
1721 niter = new_order.begin();
1723 while (niter != new_order.end()) {
1725 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1726 then append it to the temp list.
1728 Otherwise, see if the next processor in the old list is in the new list. if not,
1729 its been deleted. If its there, append it to the temp list.
1732 if (oiter == _processors.end()) {
1734 /* no more elements in the old list, so just stick the rest of
1735 the new order onto the temp list.
1738 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1739 while (niter != new_order.end()) {
1746 if (!(*oiter)->display_to_user()) {
1748 as_it_will_be.push_back (*oiter);
1752 /* visible processor: check that its in the new order */
1754 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1755 /* deleted: do nothing, shared_ptr<> will clean up */
1757 /* ignore this one, and add the next item from the new order instead */
1758 as_it_will_be.push_back (*niter);
1763 /* now remove from old order - its taken care of no matter what */
1764 oiter = _processors.erase (oiter);
1769 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1771 /* If the meter is in a custom position, find it and make a rough note of its position */
1772 maybe_note_meter_position ();
1775 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1777 if (configure_processors_unlocked (err)) {
1784 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1785 set_processor_positions ();
1797 Route::get_template()
1799 return state(false);
1803 Route::state(bool full_state)
1805 XMLNode *node = new XMLNode("Route");
1806 ProcessorList::iterator i;
1809 id().print (buf, sizeof (buf));
1810 node->add_property("id", buf);
1811 node->add_property ("name", _name);
1812 node->add_property("default-type", _default_type.to_string());
1815 node->add_property("flags", enum_2_string (_flags));
1818 node->add_property("active", _active?"yes":"no");
1820 boost::to_string (_phase_invert, p);
1821 node->add_property("phase-invert", p);
1822 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1823 node->add_property("meter-point", enum_2_string (_meter_point));
1826 node->add_property("route-group", _route_group->name());
1829 string order_string;
1830 OrderKeys::iterator x = order_keys.begin();
1832 while (x != order_keys.end()) {
1833 order_string += string ((*x).first);
1834 order_string += '=';
1835 snprintf (buf, sizeof(buf), "%ld", (*x).second);
1836 order_string += buf;
1840 if (x == order_keys.end()) {
1844 order_string += ':';
1846 node->add_property ("order-keys", order_string);
1847 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1848 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1849 node->add_property ("soloed-by-upstream", buf);
1850 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1851 node->add_property ("soloed-by-downstream", buf);
1852 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1853 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1855 node->add_child_nocopy (_input->state (full_state));
1856 node->add_child_nocopy (_output->state (full_state));
1857 node->add_child_nocopy (_solo_control->get_state ());
1858 node->add_child_nocopy (_mute_control->get_state ());
1859 node->add_child_nocopy (_mute_master->get_state ());
1861 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1862 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1863 remote_control_node->add_property (X_("id"), buf);
1864 node->add_child_nocopy (*remote_control_node);
1866 if (_comment.length()) {
1867 XMLNode *cmt = node->add_child ("Comment");
1868 cmt->add_content (_comment);
1872 node->add_child_nocopy (_pannable->state (full_state));
1875 for (i = _processors.begin(); i != _processors.end(); ++i) {
1876 node->add_child_nocopy((*i)->state (full_state));
1880 node->add_child_copy (*_extra_xml);
1883 if (_custom_meter_position_noted) {
1884 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
1886 after->id().print (buf, sizeof (buf));
1887 node->add_property (X_("processor-after-last-custom-meter"), buf);
1890 node->add_property (X_("last-custom-meter-was-at-end"), _last_custom_meter_was_at_end ? "yes" : "no");
1897 Route::set_state (const XMLNode& node, int version)
1899 if (version < 3000) {
1900 return set_state_2X (node, version);
1904 XMLNodeConstIterator niter;
1906 const XMLProperty *prop;
1908 if (node.name() != "Route"){
1909 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
1913 if ((prop = node.property (X_("name"))) != 0) {
1914 Route::set_name (prop->value());
1919 if ((prop = node.property (X_("flags"))) != 0) {
1920 _flags = Flag (string_2_enum (prop->value(), _flags));
1925 if (is_master() || is_monitor() || is_hidden()) {
1926 _mute_master->set_solo_ignore (true);
1930 /* monitor bus does not get a panner, but if (re)created
1931 via XML, it will already have one by the time we
1932 call ::set_state(). so ... remove it.
1937 /* add all processors (except amp, which is always present) */
1939 nlist = node.children();
1940 XMLNode processor_state (X_("processor_state"));
1942 Stateful::save_extra_xml (node);
1944 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1948 if (child->name() == IO::state_node_name) {
1949 if ((prop = child->property (X_("direction"))) == 0) {
1953 if (prop->value() == "Input") {
1954 _input->set_state (*child, version);
1955 } else if (prop->value() == "Output") {
1956 _output->set_state (*child, version);
1960 if (child->name() == X_("Processor")) {
1961 processor_state.add_child_copy (*child);
1965 if (child->name() == X_("Pannable")) {
1967 _pannable->set_state (*child, version);
1969 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
1974 if ((prop = node.property (X_("meter-point"))) != 0) {
1975 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
1976 set_meter_point (mp, true);
1978 _meter->set_display_to_user (_meter_point == MeterCustom);
1982 set_processor_state (processor_state);
1984 if ((prop = node.property ("self-solo")) != 0) {
1985 set_self_solo (string_is_affirmative (prop->value()));
1988 if ((prop = node.property ("soloed-by-upstream")) != 0) {
1989 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
1990 mod_solo_by_others_upstream (atoi (prop->value()));
1993 if ((prop = node.property ("soloed-by-downstream")) != 0) {
1994 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
1995 mod_solo_by_others_downstream (atoi (prop->value()));
1998 if ((prop = node.property ("solo-isolated")) != 0) {
1999 set_solo_isolated (string_is_affirmative (prop->value()), this);
2002 if ((prop = node.property ("solo-safe")) != 0) {
2003 set_solo_safe (string_is_affirmative (prop->value()), this);
2006 if ((prop = node.property (X_("phase-invert"))) != 0) {
2007 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2010 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2011 set_denormal_protection (string_is_affirmative (prop->value()));
2014 if ((prop = node.property (X_("active"))) != 0) {
2015 bool yn = string_is_affirmative (prop->value());
2016 _active = !yn; // force switch
2017 set_active (yn, this);
2020 if ((prop = node.property (X_("order-keys"))) != 0) {
2024 string::size_type colon, equal;
2025 string remaining = prop->value();
2027 while (remaining.length()) {
2029 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2030 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2033 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2034 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2037 set_order_key (remaining.substr (0, equal), n);
2041 colon = remaining.find_first_of (':');
2043 if (colon != string::npos) {
2044 remaining = remaining.substr (colon+1);
2051 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2052 PBD::ID id (prop->value ());
2053 Glib::RWLock::ReaderLock lm (_processor_lock);
2054 ProcessorList::const_iterator i = _processors.begin ();
2055 while (i != _processors.end() && (*i)->id() != id) {
2059 if (i != _processors.end ()) {
2060 _processor_after_last_custom_meter = *i;
2061 _custom_meter_position_noted = true;
2065 if ((prop = node.property (X_("last-custom-meter-was-at-end"))) != 0) {
2066 _last_custom_meter_was_at_end = string_is_affirmative (prop->value ());
2069 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2072 if (child->name() == X_("Comment")) {
2074 /* XXX this is a terrible API design in libxml++ */
2076 XMLNode *cmt = *(child->children().begin());
2077 _comment = cmt->content();
2079 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2080 if (prop->value() == "solo") {
2081 _solo_control->set_state (*child, version);
2084 } else if (child->name() == X_("RemoteControl")) {
2085 if ((prop = child->property (X_("id"))) != 0) {
2087 sscanf (prop->value().c_str(), "%d", &x);
2088 set_remote_control_id (x);
2091 } else if (child->name() == X_("MuteMaster")) {
2092 _mute_master->set_state (*child, version);
2100 Route::set_state_2X (const XMLNode& node, int version)
2103 XMLNodeConstIterator niter;
2105 const XMLProperty *prop;
2107 /* 2X things which still remain to be handled:
2113 if (node.name() != "Route") {
2114 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2118 if ((prop = node.property (X_("flags"))) != 0) {
2119 _flags = Flag (string_2_enum (prop->value(), _flags));
2124 if ((prop = node.property (X_("phase-invert"))) != 0) {
2125 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2126 if (string_is_affirmative (prop->value ())) {
2129 set_phase_invert (p);
2132 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2133 set_denormal_protection (string_is_affirmative (prop->value()));
2136 if ((prop = node.property (X_("soloed"))) != 0) {
2137 bool yn = string_is_affirmative (prop->value());
2139 /* XXX force reset of solo status */
2141 set_solo (yn, this);
2144 if ((prop = node.property (X_("muted"))) != 0) {
2147 bool muted = string_is_affirmative (prop->value());
2153 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2155 if (string_is_affirmative (prop->value())){
2156 mute_point = mute_point + "PreFader";
2161 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2163 if (string_is_affirmative (prop->value())){
2166 mute_point = mute_point + ",";
2169 mute_point = mute_point + "PostFader";
2174 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2176 if (string_is_affirmative (prop->value())){
2179 mute_point = mute_point + ",";
2182 mute_point = mute_point + "Listen";
2187 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2189 if (string_is_affirmative (prop->value())){
2192 mute_point = mute_point + ",";
2195 mute_point = mute_point + "Main";
2199 _mute_master->set_mute_points (mute_point);
2200 _mute_master->set_muted_by_self (true);
2204 if ((prop = node.property (X_("meter-point"))) != 0) {
2205 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2208 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2209 don't mean the same thing.
2212 if ((prop = node.property (X_("order-keys"))) != 0) {
2216 string::size_type colon, equal;
2217 string remaining = prop->value();
2219 while (remaining.length()) {
2221 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2222 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2225 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2226 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2229 set_order_key (remaining.substr (0, equal), n);
2233 colon = remaining.find_first_of (':');
2235 if (colon != string::npos) {
2236 remaining = remaining.substr (colon+1);
2245 nlist = node.children ();
2246 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2250 if (child->name() == IO::state_node_name) {
2252 /* there is a note in IO::set_state_2X() about why we have to call
2256 _input->set_state_2X (*child, version, true);
2257 _output->set_state_2X (*child, version, false);
2259 if ((prop = child->property (X_("name"))) != 0) {
2260 Route::set_name (prop->value ());
2265 if ((prop = child->property (X_("active"))) != 0) {
2266 bool yn = string_is_affirmative (prop->value());
2267 _active = !yn; // force switch
2268 set_active (yn, this);
2271 if ((prop = child->property (X_("gain"))) != 0) {
2274 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2275 _amp->gain_control()->set_value (val);
2279 /* Set up Panners in the IO */
2280 XMLNodeList io_nlist = child->children ();
2282 XMLNodeConstIterator io_niter;
2285 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2287 io_child = *io_niter;
2289 if (io_child->name() == X_("Panner")) {
2290 _main_outs->panner_shell()->set_state(*io_child, version);
2291 } else if (io_child->name() == X_("Automation")) {
2292 /* IO's automation is for the fader */
2293 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2299 XMLNodeList redirect_nodes;
2301 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2305 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2306 redirect_nodes.push_back(child);
2311 set_processor_state_2X (redirect_nodes, version);
2313 Stateful::save_extra_xml (node);
2315 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2318 if (child->name() == X_("Comment")) {
2320 /* XXX this is a terrible API design in libxml++ */
2322 XMLNode *cmt = *(child->children().begin());
2323 _comment = cmt->content();
2325 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2326 if (prop->value() == X_("solo")) {
2327 _solo_control->set_state (*child, version);
2328 } else if (prop->value() == X_("mute")) {
2329 _mute_control->set_state (*child, version);
2332 } else if (child->name() == X_("RemoteControl")) {
2333 if ((prop = child->property (X_("id"))) != 0) {
2335 sscanf (prop->value().c_str(), "%d", &x);
2336 set_remote_control_id (x);
2346 Route::get_processor_state ()
2348 XMLNode* root = new XMLNode (X_("redirects"));
2349 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2350 root->add_child_nocopy ((*i)->state (true));
2357 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2359 /* We don't bother removing existing processors not in nList, as this
2360 method will only be called when creating a Route from scratch, not
2361 for undo purposes. Just put processors in at the appropriate place
2365 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2366 add_processor_from_xml_2X (**i, version);
2371 Route::set_processor_state (const XMLNode& node)
2373 const XMLNodeList &nlist = node.children();
2374 XMLNodeConstIterator niter;
2375 ProcessorList new_order;
2376 bool must_configure = false;
2378 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2380 XMLProperty* prop = (*niter)->property ("type");
2382 if (prop->value() == "amp") {
2383 _amp->set_state (**niter, Stateful::current_state_version);
2384 new_order.push_back (_amp);
2385 } else if (prop->value() == "meter") {
2386 _meter->set_state (**niter, Stateful::current_state_version);
2387 new_order.push_back (_meter);
2388 } else if (prop->value() == "main-outs") {
2389 _main_outs->set_state (**niter, Stateful::current_state_version);
2390 } else if (prop->value() == "intreturn") {
2392 _intreturn.reset (new InternalReturn (_session));
2393 must_configure = true;
2395 _intreturn->set_state (**niter, Stateful::current_state_version);
2396 } else if (is_monitor() && prop->value() == "monitor") {
2397 if (!_monitor_control) {
2398 _monitor_control.reset (new MonitorProcessor (_session));
2399 must_configure = true;
2401 _monitor_control->set_state (**niter, Stateful::current_state_version);
2402 } else if (prop->value() == "capture") {
2403 _capturing_processor.reset (new CapturingProcessor (_session));
2405 ProcessorList::iterator o;
2407 for (o = _processors.begin(); o != _processors.end(); ++o) {
2408 XMLProperty* id_prop = (*niter)->property(X_("id"));
2409 if (id_prop && (*o)->id() == id_prop->value()) {
2410 (*o)->set_state (**niter, Stateful::current_state_version);
2411 new_order.push_back (*o);
2416 // If the processor (*niter) is not on the route then create it
2418 if (o == _processors.end()) {
2420 boost::shared_ptr<Processor> processor;
2422 if (prop->value() == "intsend") {
2424 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2426 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2427 prop->value() == "lv2" ||
2428 prop->value() == "vst" ||
2429 prop->value() == "lxvst" ||
2430 prop->value() == "audiounit") {
2432 processor.reset (new PluginInsert(_session));
2434 } else if (prop->value() == "port") {
2436 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2438 } else if (prop->value() == "send") {
2440 processor.reset (new Send (_session, _pannable, _mute_master));
2443 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2447 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2448 /* This processor could not be configured. Turn it into a UnknownProcessor */
2449 processor.reset (new UnknownProcessor (_session, **niter));
2452 /* we have to note the monitor send here, otherwise a new one will be created
2453 and the state of this one will be lost.
2455 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2456 if (isend && isend->role() == Delivery::Listen) {
2457 _monitor_send = isend;
2460 /* it doesn't matter if invisible processors are added here, as they
2461 will be sorted out by setup_invisible_processors () shortly.
2464 new_order.push_back (processor);
2465 must_configure = true;
2471 Glib::RWLock::WriterLock lm (_processor_lock);
2472 _processors = new_order;
2474 if (must_configure) {
2475 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2476 configure_processors_unlocked (0);
2479 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2481 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2483 boost::shared_ptr<PluginInsert> pi;
2485 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2486 if (pi->has_no_inputs ()) {
2487 _have_internal_generator = true;
2494 processors_changed (RouteProcessorChange ());
2495 set_processor_positions ();
2499 Route::curve_reallocate ()
2501 // _gain_automation_curve.finish_resize ();
2502 // _pan_automation_curve.finish_resize ();
2506 Route::silence (framecnt_t nframes)
2508 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2513 silence_unlocked (nframes);
2517 Route::silence_unlocked (framecnt_t nframes)
2519 /* Must be called with the processor lock held */
2523 _output->silence (nframes);
2525 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2526 boost::shared_ptr<PluginInsert> pi;
2528 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2529 // skip plugins, they don't need anything when we're not active
2533 (*i)->silence (nframes);
2536 if (nframes == _session.get_block_size()) {
2543 Route::add_internal_return ()
2546 _intreturn.reset (new InternalReturn (_session));
2547 add_processor (_intreturn, PreFader);
2552 Route::add_send_to_internal_return (InternalSend* send)
2554 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2555 Glib::RWLock::ReaderLock rm (_processor_lock);
2557 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2558 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2561 return d->add_send (send);
2567 Route::remove_send_from_internal_return (InternalSend* send)
2569 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2570 Glib::RWLock::ReaderLock rm (_processor_lock);
2572 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2573 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2576 return d->remove_send (send);
2582 Route::enable_monitor_send ()
2584 /* Caller must hold process lock */
2585 assert (!AudioEngine::instance()->process_lock().trylock());
2587 /* master never sends to monitor section via the normal mechanism */
2588 assert (!is_master ());
2590 /* make sure we have one */
2591 if (!_monitor_send) {
2592 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2593 _monitor_send->set_display_to_user (false);
2597 configure_processors (0);
2600 /** Add an aux send to a route.
2601 * @param route route to send to.
2602 * @param placement placement for the send.
2605 Route::add_aux_send (boost::shared_ptr<Route> route, Placement placement)
2607 assert (route != _session.monitor_out ());
2610 Glib::RWLock::ReaderLock rm (_processor_lock);
2612 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2614 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2616 if (d && d->target_route() == route) {
2617 /* already listening via the specified IO: do nothing */
2625 boost::shared_ptr<InternalSend> listener;
2628 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2629 listener.reset (new InternalSend (_session, _pannable, _mute_master, route, Delivery::Aux));
2632 add_processor (listener, placement);
2634 } catch (failed_constructor& err) {
2642 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
2644 ProcessorStreams err;
2645 ProcessorList::iterator tmp;
2648 Glib::RWLock::ReaderLock rl(_processor_lock);
2650 /* have to do this early because otherwise processor reconfig
2651 * will put _monitor_send back in the list
2654 if (route == _session.monitor_out()) {
2655 _monitor_send.reset ();
2659 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2661 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2663 if (d && d->target_route() == route) {
2665 remove_processor (*x, &err, false);
2668 /* list could have been demolished while we dropped the lock
2679 Route::set_comment (string cmt, void *src)
2682 comment_changed (src);
2683 _session.set_dirty ();
2687 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2689 FeedRecord fr (other, via_sends_only);
2691 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2693 if (!result.second) {
2695 /* already a record for "other" - make sure sends-only information is correct */
2696 if (!via_sends_only && result.first->sends_only) {
2697 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2698 frp->sends_only = false;
2702 return result.second;
2706 Route::clear_fed_by ()
2712 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2714 const FedBy& fed_by (other->fed_by());
2716 for (FedBy::iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2717 boost::shared_ptr<Route> sr = f->r.lock();
2719 if (sr && (sr.get() == this)) {
2721 if (via_sends_only) {
2722 *via_sends_only = f->sends_only;
2733 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
2735 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2737 if (_output->connected_to (other->input())) {
2738 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2739 if (via_send_only) {
2740 *via_send_only = false;
2747 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2749 boost::shared_ptr<IOProcessor> iop;
2751 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2752 if (iop->feeds (other)) {
2753 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2754 if (via_send_only) {
2755 *via_send_only = true;
2759 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2762 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2767 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2772 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
2774 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
2777 /** Called from the (non-realtime) butler thread when the transport is stopped */
2779 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool did_locate, bool can_flush_processors)
2781 framepos_t now = _session.transport_frame();
2784 Glib::RWLock::ReaderLock lm (_processor_lock);
2787 automation_snapshot (now, true);
2790 Automatable::transport_stopped (now);
2792 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2794 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2798 (*i)->transport_stopped (now);
2802 _roll_delay = _initial_delay;
2805 /** Called with the process lock held if change contains ConfigurationChanged */
2807 Route::input_change_handler (IOChange change, void * /*src*/)
2809 if ((change.type & IOChange::ConfigurationChanged)) {
2810 configure_processors (0);
2811 _phase_invert.resize (_input->n_ports().n_audio ());
2812 io_changed (); /* EMIT SIGNAL */
2817 Route::pans_required () const
2819 if (n_outputs().n_audio() < 2) {
2823 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
2827 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
2829 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2834 if (n_outputs().n_total() == 0) {
2838 if (!_active || n_inputs() == ChanCount::ZERO) {
2839 silence_unlocked (nframes);
2842 if (session_state_changing) {
2843 if (_session.transport_speed() != 0.0f) {
2844 /* we're rolling but some state is changing (e.g. our diskstream contents)
2845 so we cannot use them. Be silent till this is over.
2847 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
2849 silence_unlocked (nframes);
2852 /* we're really not rolling, so we're either delivery silence or actually
2853 monitoring, both of which are safe to do while session_state_changing is true.
2857 _amp->apply_gain_automation (false);
2858 passthru (start_frame, end_frame, nframes, 0);
2864 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
2866 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2871 automation_snapshot (_session.transport_frame(), false);
2873 if (n_outputs().n_total() == 0) {
2877 if (!_active || n_inputs().n_total() == 0) {
2878 silence_unlocked (nframes);
2882 framecnt_t unused = 0;
2884 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
2890 passthru (start_frame, end_frame, nframes, declick);
2896 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
2903 Route::has_external_redirects () const
2905 // FIXME: what about sends? - they don't return a signal back to ardour?
2907 boost::shared_ptr<const PortInsert> pi;
2909 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2911 if ((pi = boost::dynamic_pointer_cast<const PortInsert>(*i)) != 0) {
2913 for (PortSet::const_iterator port = pi->output()->ports().begin(); port != pi->output()->ports().end(); ++port) {
2915 string port_name = port->name();
2916 string client_name = port_name.substr (0, port_name.find(':'));
2918 /* only say "yes" if the redirect is actually in use */
2920 if (client_name != "ardour" && pi->active()) {
2931 Route::flush_processors ()
2933 /* XXX shouldn't really try to take this lock, since
2934 this is called from the RT audio thread.
2937 Glib::RWLock::ReaderLock lm (_processor_lock);
2939 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2945 Route::set_meter_point (MeterPoint p, bool force)
2947 /* CAN BE CALLED FROM PROCESS CONTEXT */
2949 if (_meter_point == p && !force) {
2953 bool meter_was_visible_to_user = _meter->display_to_user ();
2956 Glib::RWLock::WriterLock lm (_processor_lock);
2958 maybe_note_meter_position ();
2962 if (_meter_point != MeterCustom) {
2964 _meter->set_display_to_user (false);
2966 setup_invisible_processors ();
2970 _meter->set_display_to_user (true);
2972 /* If we have a previous position for the custom meter, try to put it there */
2973 if (_custom_meter_position_noted) {
2974 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2977 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
2978 if (i != _processors.end ()) {
2979 _processors.remove (_meter);
2980 _processors.insert (i, _meter);
2982 } else if (_last_custom_meter_was_at_end) {
2983 _processors.remove (_meter);
2984 _processors.push_back (_meter);
2989 /* Set up the meter for its new position */
2991 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
2995 if (loc == _processors.begin()) {
2996 m_in = _input->n_ports();
2998 ProcessorList::iterator before = loc;
3000 m_in = (*before)->output_streams ();
3003 _meter->reflect_inputs (m_in);
3005 /* we do not need to reconfigure the processors, because the meter
3006 (a) is always ready to handle processor_max_streams
3007 (b) is always an N-in/N-out processor, and thus moving
3008 it doesn't require any changes to the other processors.
3012 meter_change (); /* EMIT SIGNAL */
3014 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
3016 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
3020 Route::listen_position_changed ()
3023 Glib::RWLock::WriterLock lm (_processor_lock);
3024 ProcessorState pstate (this);
3027 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3029 if (configure_processors_unlocked (0)) {
3031 configure_processors_unlocked (0); // it worked before we tried to add it ...
3037 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3038 _session.set_dirty ();
3041 boost::shared_ptr<CapturingProcessor>
3042 Route::add_export_point()
3044 if (!_capturing_processor) {
3046 _capturing_processor.reset (new CapturingProcessor (_session));
3047 _capturing_processor->activate ();
3050 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3051 configure_processors (0);
3056 return _capturing_processor;
3060 Route::update_signal_latency ()
3062 framecnt_t l = _output->user_latency();
3064 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3065 if ((*i)->active ()) {
3066 l += (*i)->signal_latency ();
3070 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3072 if (_signal_latency != l) {
3073 _signal_latency = l;
3074 signal_latency_changed (); /* EMIT SIGNAL */
3077 return _signal_latency;
3081 Route::set_user_latency (framecnt_t nframes)
3083 _output->set_user_latency (nframes);
3084 _session.update_latency_compensation ();
3088 Route::set_latency_compensation (framecnt_t longest_session_latency)
3090 framecnt_t old = _initial_delay;
3092 if (_signal_latency < longest_session_latency) {
3093 _initial_delay = longest_session_latency - _signal_latency;
3098 DEBUG_TRACE (DEBUG::Latency, string_compose (
3099 "%1: compensate for maximum latency of %2,"
3100 "given own latency of %3, using initial delay of %4\n",
3101 name(), longest_session_latency, _signal_latency, _initial_delay));
3103 if (_initial_delay != old) {
3104 initial_delay_changed (); /* EMIT SIGNAL */
3107 if (_session.transport_stopped()) {
3108 _roll_delay = _initial_delay;
3113 Route::automation_snapshot (framepos_t now, bool force)
3116 _pannable->automation_snapshot (now, force);
3119 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3120 (*i)->automation_snapshot (now, force);
3124 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3125 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3126 boost::shared_ptr<AutomationList>(), name)
3129 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3134 Route::SoloControllable::set_value (double val)
3136 bool bval = ((val >= 0.5f) ? true: false);
3138 boost::shared_ptr<RouteList> rl (new RouteList);
3140 boost::shared_ptr<Route> r = _route.lock ();
3147 if (Config->get_solo_control_is_listen_control()) {
3148 _session.set_listen (rl, bval);
3150 _session.set_solo (rl, bval);
3155 Route::SoloControllable::get_value () const
3157 boost::shared_ptr<Route> r = _route.lock ();
3162 if (Config->get_solo_control_is_listen_control()) {
3163 return r->listening_via_monitor() ? 1.0f : 0.0f;
3165 return r->self_soloed() ? 1.0f : 0.0f;
3169 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3170 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3171 boost::shared_ptr<AutomationList>(), name)
3174 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3179 Route::MuteControllable::set_value (double val)
3181 bool bval = ((val >= 0.5f) ? true: false);
3183 boost::shared_ptr<RouteList> rl (new RouteList);
3185 boost::shared_ptr<Route> r = _route.lock ();
3191 _session.set_mute (rl, bval);
3195 Route::MuteControllable::get_value () const
3197 boost::shared_ptr<Route> r = _route.lock ();
3202 return r->muted() ? 1.0f : 0.0f;
3206 Route::set_block_size (pframes_t nframes)
3208 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3209 (*i)->set_block_size (nframes);
3212 _session.ensure_buffers (n_process_buffers ());
3216 Route::protect_automation ()
3218 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3219 (*i)->protect_automation();
3223 Route::set_pending_declick (int declick)
3226 /* this call is not allowed to turn off a pending declick unless "force" is true */
3228 _pending_declick = declick;
3230 // cerr << _name << ": after setting to " << declick << " pending declick = " << _pending_declick << endl;
3232 _pending_declick = 0;
3237 /** Shift automation forwards from a particular place, thereby inserting time.
3238 * Adds undo commands for any shifts that are performed.
3240 * @param pos Position to start shifting from.
3241 * @param frames Amount to shift forwards by.
3245 Route::shift (framepos_t pos, framecnt_t frames)
3247 /* gain automation */
3249 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3251 XMLNode &before = gc->alist()->get_state ();
3252 gc->alist()->shift (pos, frames);
3253 XMLNode &after = gc->alist()->get_state ();
3254 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3257 /* pan automation */
3259 ControlSet::Controls& c (_pannable->controls());
3261 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3262 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3264 boost::shared_ptr<AutomationList> al = pc->alist();
3265 XMLNode& before = al->get_state ();
3266 al->shift (pos, frames);
3267 XMLNode& after = al->get_state ();
3268 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3273 /* redirect automation */
3275 Glib::RWLock::ReaderLock lm (_processor_lock);
3276 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3278 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3280 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3281 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3283 boost::shared_ptr<AutomationList> al = ac->alist();
3284 XMLNode &before = al->get_state ();
3285 al->shift (pos, frames);
3286 XMLNode &after = al->get_state ();
3287 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3296 Route::save_as_template (const string& path, const string& name)
3298 XMLNode& node (state (false));
3301 IO::set_name_in_state (*node.children().front(), name);
3303 tree.set_root (&node);
3304 return tree.write (path.c_str());
3309 Route::set_name (const string& str)
3315 name = Route::ensure_track_or_route_name (str, _session);
3316 SessionObject::set_name (name);
3318 ret = (_input->set_name(name) && _output->set_name(name));
3321 /* rename the main outs. Leave other IO processors
3322 * with whatever name they already have, because its
3323 * just fine as it is (it will not contain the route
3324 * name if its a port insert, port send or port return).
3328 if (_main_outs->set_name (name)) {
3329 /* XXX returning false here is stupid because
3330 we already changed the route name.
3340 /** Set the name of a route in an XML description.
3341 * @param node XML <Route> node to set the name in.
3342 * @param name New name.
3345 Route::set_name_in_state (XMLNode& node, string const & name)
3347 node.add_property (X_("name"), name);
3349 XMLNodeList children = node.children();
3350 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3352 if ((*i)->name() == X_("IO")) {
3354 IO::set_name_in_state (**i, name);
3356 } else if ((*i)->name() == X_("Processor")) {
3358 XMLProperty* role = (*i)->property (X_("role"));
3359 if (role && role->value() == X_("Main")) {
3360 (*i)->add_property (X_("name"), name);
3363 } else if ((*i)->name() == X_("Diskstream")) {
3365 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3366 (*i)->add_property (X_("name"), name);
3372 boost::shared_ptr<Send>
3373 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3375 Glib::RWLock::ReaderLock lm (_processor_lock);
3377 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3378 boost::shared_ptr<InternalSend> send;
3380 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3381 if (send->target_route() == target) {
3387 return boost::shared_ptr<Send>();
3390 /** @param c Audio channel index.
3391 * @param yn true to invert phase, otherwise false.
3394 Route::set_phase_invert (uint32_t c, bool yn)
3396 if (_phase_invert[c] != yn) {
3397 _phase_invert[c] = yn;
3398 phase_invert_changed (); /* EMIT SIGNAL */
3399 _session.set_dirty ();
3404 Route::set_phase_invert (boost::dynamic_bitset<> p)
3406 if (_phase_invert != p) {
3408 phase_invert_changed (); /* EMIT SIGNAL */
3409 _session.set_dirty ();
3414 Route::phase_invert (uint32_t c) const
3416 return _phase_invert[c];
3419 boost::dynamic_bitset<>
3420 Route::phase_invert () const
3422 return _phase_invert;
3426 Route::set_denormal_protection (bool yn)
3428 if (_denormal_protection != yn) {
3429 _denormal_protection = yn;
3430 denormal_protection_changed (); /* EMIT SIGNAL */
3435 Route::denormal_protection () const
3437 return _denormal_protection;
3441 Route::set_active (bool yn, void* src)
3443 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3444 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3448 if (_active != yn) {
3450 _input->set_active (yn);
3451 _output->set_active (yn);
3452 active_changed (); // EMIT SIGNAL
3459 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3465 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3467 boost::shared_ptr<Send> s;
3468 boost::shared_ptr<Return> r;
3470 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3471 s->meter()->meter();
3472 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3473 r->meter()->meter ();
3478 boost::shared_ptr<Pannable>
3479 Route::pannable() const
3484 boost::shared_ptr<Panner>
3485 Route::panner() const
3488 return _main_outs->panner_shell()->panner();
3491 boost::shared_ptr<PannerShell>
3492 Route::panner_shell() const
3494 return _main_outs->panner_shell();
3497 boost::shared_ptr<AutomationControl>
3498 Route::gain_control() const
3500 return _amp->gain_control();
3503 boost::shared_ptr<AutomationControl>
3504 Route::get_control (const Evoral::Parameter& param)
3506 /* either we own the control or .... */
3508 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3512 /* maybe one of our processors does or ... */
3514 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3515 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3516 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3524 /* nobody does so we'll make a new one */
3526 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3533 boost::shared_ptr<Processor>
3534 Route::nth_plugin (uint32_t n)
3536 Glib::RWLock::ReaderLock lm (_processor_lock);
3537 ProcessorList::iterator i;
3539 for (i = _processors.begin(); i != _processors.end(); ++i) {
3540 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3547 return boost::shared_ptr<Processor> ();
3550 boost::shared_ptr<Processor>
3551 Route::nth_send (uint32_t n)
3553 Glib::RWLock::ReaderLock lm (_processor_lock);
3554 ProcessorList::iterator i;
3556 for (i = _processors.begin(); i != _processors.end(); ++i) {
3557 if (boost::dynamic_pointer_cast<Send> (*i)) {
3564 return boost::shared_ptr<Processor> ();
3568 Route::has_io_processor_named (const string& name)
3570 Glib::RWLock::ReaderLock lm (_processor_lock);
3571 ProcessorList::iterator i;
3573 for (i = _processors.begin(); i != _processors.end(); ++i) {
3574 if (boost::dynamic_pointer_cast<Send> (*i) ||
3575 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3576 if ((*i)->name() == name) {
3585 MuteMaster::MutePoint
3586 Route::mute_points () const
3588 return _mute_master->mute_points ();
3592 Route::set_processor_positions ()
3594 Glib::RWLock::ReaderLock lm (_processor_lock);
3596 bool had_amp = false;
3597 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3598 (*i)->set_pre_fader (!had_amp);
3599 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3605 /** Called when there is a proposed change to the input port count */
3607 Route::input_port_count_changing (ChanCount to)
3609 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3611 /* The processors cannot be configured with the new input arrangement, so
3617 /* The change is ok */
3622 Route::unknown_processors () const
3626 Glib::RWLock::ReaderLock lm (_processor_lock);
3627 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3628 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3629 p.push_back ((*i)->name ());
3638 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3640 /* we assume that all our input ports feed all our output ports. its not
3641 universally true, but the alternative is way too corner-case to worry about.
3644 jack_latency_range_t all_connections;
3647 all_connections.min = 0;
3648 all_connections.max = 0;
3650 all_connections.min = ~((jack_nframes_t) 0);
3651 all_connections.max = 0;
3653 /* iterate over all "from" ports and determine the latency range for all of their
3654 connections to the "outside" (outside of this Route).
3657 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3659 jack_latency_range_t range;
3661 p->get_connected_latency_range (range, playback);
3663 all_connections.min = min (all_connections.min, range.min);
3664 all_connections.max = max (all_connections.max, range.max);
3668 /* set the "from" port latencies to the max/min range of all their connections */
3670 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3671 p->set_private_latency_range (all_connections, playback);
3674 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3676 all_connections.min += our_latency;
3677 all_connections.max += our_latency;
3679 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3680 p->set_private_latency_range (all_connections, playback);
3683 return all_connections.max;
3687 Route::set_private_port_latencies (bool playback) const
3689 framecnt_t own_latency = 0;
3691 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3692 OR LATENCY CALLBACK.
3694 This is called (early) from the latency callback. It computes the REAL
3695 latency associated with each port and stores the result as the "private"
3696 latency of the port. A later call to Route::set_public_port_latencies()
3697 sets all ports to the same value to reflect the fact that we do latency
3698 compensation and so all signals are delayed by the same amount as they
3699 flow through ardour.
3702 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3703 if ((*i)->active ()) {
3704 own_latency += (*i)->signal_latency ();
3709 /* playback: propagate latency from "outside the route" to outputs to inputs */
3710 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3712 /* capture: propagate latency from "outside the route" to inputs to outputs */
3713 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3718 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3720 /* this is called to set the JACK-visible port latencies, which take
3721 latency compensation into account.
3724 jack_latency_range_t range;
3730 const PortSet& ports (_input->ports());
3731 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3732 p->set_public_latency_range (range, playback);
3737 const PortSet& ports (_output->ports());
3738 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3739 p->set_public_latency_range (range, playback);
3744 /** Put the invisible processors in the right place in _processors.
3745 * Must be called with a writer lock on _processor_lock held.
3748 Route::setup_invisible_processors ()
3751 Glib::RWLock::WriterLock lm (_processor_lock, Glib::TRY_LOCK);
3752 assert (!lm.locked ());
3756 /* too early to be doing this stuff */
3760 /* we'll build this new list here and then use it */
3762 ProcessorList new_processors;
3764 /* find visible processors */
3766 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3767 if ((*i)->display_to_user ()) {
3768 new_processors.push_back (*i);
3774 ProcessorList::iterator amp = new_processors.begin ();
3775 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3779 assert (amp != _processors.end ());
3781 /* and the processor after the amp */
3783 ProcessorList::iterator after_amp = amp;
3789 switch (_meter_point) {
3791 assert (!_meter->display_to_user ());
3792 new_processors.push_front (_meter);
3795 assert (!_meter->display_to_user ());
3796 new_processors.insert (amp, _meter);
3798 case MeterPostFader:
3799 /* do nothing here */
3802 /* do nothing here */
3805 /* the meter is visible, so we don't touch it here */
3812 assert (_main_outs);
3813 assert (!_main_outs->display_to_user ());
3814 new_processors.push_back (_main_outs);
3816 /* iterator for the main outs */
3818 ProcessorList::iterator main = new_processors.end();
3821 /* OUTPUT METERING */
3823 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3824 assert (!_meter->display_to_user ());
3826 /* add the processor just before or just after the main outs */
3828 ProcessorList::iterator meter_point = main;
3830 if (_meter_point == MeterOutput) {
3833 new_processors.insert (meter_point, _meter);
3838 if (_monitor_send && !is_monitor ()) {
3839 assert (!_monitor_send->display_to_user ());
3840 if (Config->get_solo_control_is_listen_control()) {
3841 switch (Config->get_listen_position ()) {
3842 case PreFaderListen:
3843 switch (Config->get_pfl_position ()) {
3844 case PFLFromBeforeProcessors:
3845 new_processors.push_front (_monitor_send);
3847 case PFLFromAfterProcessors:
3848 new_processors.insert (amp, _monitor_send);
3851 _monitor_send->set_can_pan (false);
3853 case AfterFaderListen:
3854 switch (Config->get_afl_position ()) {
3855 case AFLFromBeforeProcessors:
3856 new_processors.insert (after_amp, _monitor_send);
3858 case AFLFromAfterProcessors:
3859 new_processors.insert (new_processors.end(), _monitor_send);
3862 _monitor_send->set_can_pan (true);
3866 new_processors.insert (new_processors.end(), _monitor_send);
3867 _monitor_send->set_can_pan (false);
3871 /* MONITOR CONTROL */
3873 if (_monitor_control && is_monitor ()) {
3874 assert (!_monitor_control->display_to_user ());
3875 new_processors.push_front (_monitor_control);
3878 /* INTERNAL RETURN */
3880 /* doing this here means that any monitor control will come just after
3885 assert (!_intreturn->display_to_user ());
3886 new_processors.push_front (_intreturn);
3889 /* EXPORT PROCESSOR */
3891 if (_capturing_processor) {
3892 assert (!_capturing_processor->display_to_user ());
3893 new_processors.push_front (_capturing_processor);
3896 _processors = new_processors;
3898 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
3899 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3900 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
3907 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3908 Glib::RWLock::ReaderLock lp (_processor_lock);
3912 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3913 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
3920 /** If the meter point is `Custom', make a note of where the meter is.
3921 * This is so that if the meter point is subsequently set to something else,
3922 * and then back to custom, we can put the meter back where it was last time
3923 * custom was enabled.
3925 * Must be called with the _processor_lock held.
3928 Route::maybe_note_meter_position ()
3930 if (_meter_point != MeterCustom) {
3934 _custom_meter_position_noted = true;
3935 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3936 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
3937 ProcessorList::iterator j = i;
3939 if (j != _processors.end ()) {
3940 _processor_after_last_custom_meter = *j;
3941 _last_custom_meter_was_at_end = false;
3943 _last_custom_meter_was_at_end = true;
3949 boost::shared_ptr<Processor>
3950 Route::processor_by_id (PBD::ID id) const
3952 Glib::RWLock::ReaderLock lm (_processor_lock);
3953 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3954 if ((*i)->id() == id) {
3959 return boost::shared_ptr<Processor> ();
3962 /** @return the monitoring state, or in other words what data we are pushing
3963 * into the route (data from the inputs, data from disk or silence)
3966 Route::monitoring_state () const
3968 return MonitoringInput;
3971 /** @return what we should be metering; either the data coming from the input
3972 * IO or the data that is flowing through the route.
3975 Route::metering_state () const
3977 return MeteringRoute;