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.reset (new Pannable (_session));
132 /* input and output objects */
134 _input.reset (new IO (_session, _name, IO::Input, _default_type));
135 _output.reset (new IO (_session, _name, IO::Output, _default_type));
137 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
138 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
140 /* add amp processor */
142 _amp.reset (new Amp (_session));
143 add_processor (_amp, PostFader);
145 /* create standard processors: meter, main outs, monitor out;
146 they will be added to _processors by setup_invisible_processors ()
149 _meter.reset (new PeakMeter (_session));
150 _meter->set_display_to_user (false);
153 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
154 _main_outs->activate ();
157 /* where we listen to tracks */
158 _intreturn.reset (new InternalReturn (_session));
159 _intreturn->activate ();
161 /* the thing that provides proper control over a control/monitor/listen bus
162 (such as per-channel cut, dim, solo, invert, etc).
164 _monitor_control.reset (new MonitorProcessor (_session));
165 _monitor_control->activate ();
168 if (is_master() || is_monitor() || is_hidden()) {
169 _mute_master->set_solo_ignore (true);
172 /* now that we have _meter, its safe to connect to this */
174 Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
177 /* run a configure so that the invisible processors get set up */
178 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
179 configure_processors (0);
187 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
189 /* do this early so that we don't get incoming signals as we are going through destruction
194 /* don't use clear_processors here, as it depends on the session which may
195 be half-destroyed by now
198 Glib::RWLock::WriterLock lm (_processor_lock);
199 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
200 (*i)->drop_references ();
203 _processors.clear ();
207 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
209 if (id != _remote_control_id) {
210 _remote_control_id = id;
211 RemoteControlIDChanged ();
212 if (notify_class_listeners) {
213 RemoteControlIDChange ();
219 Route::remote_control_id() const
221 return _remote_control_id;
225 Route::order_key (std::string const & name) const
227 OrderKeys::const_iterator i = order_keys.find (name);
228 if (i == order_keys.end()) {
236 Route::set_order_key (std::string const & name, int32_t n)
238 bool changed = false;
240 /* This method looks more complicated than it should, but
241 it's important that we don't emit order_key_changed unless
242 it actually has, as expensive things happen on receipt of that
246 if (order_keys.find(name) == order_keys.end() || order_keys[name] != n) {
247 order_keys[name] = n;
251 if (Config->get_sync_all_route_ordering()) {
252 for (OrderKeys::iterator x = order_keys.begin(); x != order_keys.end(); ++x) {
253 if (x->second != n) {
261 order_key_changed (); /* EMIT SIGNAL */
262 _session.set_dirty ();
266 /** Set all order keys to be the same as that for `base', if such a key
267 * exists in this route.
268 * @param base Base key.
271 Route::sync_order_keys (std::string const & base)
273 if (order_keys.empty()) {
277 OrderKeys::iterator i;
280 if ((i = order_keys.find (base)) == order_keys.end()) {
281 /* key doesn't exist, use the first existing key (during session initialization) */
282 i = order_keys.begin();
286 /* key exists - use it and reset all others (actually, itself included) */
288 i = order_keys.begin();
291 bool changed = false;
293 for (; i != order_keys.end(); ++i) {
294 if (i->second != key) {
301 order_key_changed (); /* EMIT SIGNAL */
306 Route::ensure_track_or_route_name(string name, Session &session)
308 string newname = name;
310 while (!session.io_name_is_legal (newname)) {
311 newname = bump_name_once (newname, '.');
319 Route::inc_gain (gain_t fraction, void *src)
321 _amp->inc_gain (fraction, src);
325 Route::set_gain (gain_t val, void *src)
327 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
329 if (_route_group->is_relative()) {
331 gain_t usable_gain = _amp->gain();
332 if (usable_gain < 0.000001f) {
333 usable_gain = 0.000001f;
337 if (delta < 0.000001f) {
341 delta -= usable_gain;
346 gain_t factor = delta / usable_gain;
349 factor = _route_group->get_max_factor(factor);
350 if (factor == 0.0f) {
351 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
355 factor = _route_group->get_min_factor(factor);
356 if (factor == 0.0f) {
357 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
362 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
366 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
372 if (val == _amp->gain()) {
376 _amp->set_gain (val, src);
380 Route::maybe_declick (BufferSet&, framecnt_t, int)
382 /* this is the "bus" implementation and they never declick.
387 /** Process this route for one (sub) cycle (process thread)
389 * @param bufs Scratch buffers to use for the signal path
390 * @param start_frame Initial transport frame
391 * @param end_frame Final transport frame
392 * @param nframes Number of frames to output (to ports)
394 * Note that (end_frame - start_frame) may not be equal to nframes when the
395 * transport speed isn't 1.0 (eg varispeed).
398 Route::process_output_buffers (BufferSet& bufs,
399 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
400 bool /*with_processors*/, int declick,
401 bool gain_automation_ok)
403 bool monitor = should_monitor ();
405 bufs.is_silent (false);
407 /* figure out if we're going to use gain automation */
408 if (gain_automation_ok) {
409 _amp->setup_gain_automation (start_frame, end_frame, nframes);
411 _amp->apply_gain_automation (false);
414 /* tell main outs what to do about monitoring */
415 _main_outs->no_outs_cuz_we_no_monitor (!monitor);
418 /* -------------------------------------------------------------------------------------------
419 GLOBAL DECLICK (for transport changes etc.)
420 ----------------------------------------------------------------------------------------- */
422 maybe_declick (bufs, nframes, declick);
423 _pending_declick = 0;
425 /* -------------------------------------------------------------------------------------------
426 DENORMAL CONTROL/PHASE INVERT
427 ----------------------------------------------------------------------------------------- */
429 if (_phase_invert.any ()) {
433 if (_denormal_protection || Config->get_denormal_protection()) {
435 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
436 Sample* const sp = i->data();
438 if (_phase_invert[chn]) {
439 for (pframes_t nx = 0; nx < nframes; ++nx) {
444 for (pframes_t nx = 0; nx < nframes; ++nx) {
452 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
453 Sample* const sp = i->data();
455 if (_phase_invert[chn]) {
456 for (pframes_t nx = 0; nx < nframes; ++nx) {
465 if (_denormal_protection || Config->get_denormal_protection()) {
467 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
468 Sample* const sp = i->data();
469 for (pframes_t nx = 0; nx < nframes; ++nx) {
477 /* -------------------------------------------------------------------------------------------
479 ----------------------------------------------------------------------------------------- */
481 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
483 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
488 /* if it has any inputs, make sure they match */
489 if ((*i)->input_streams() != ChanCount::ZERO) {
490 if (bufs.count() != (*i)->input_streams()) {
491 cerr << _name << " bufs = " << bufs.count()
492 << " input for " << (*i)->name() << " = " << (*i)->input_streams()
498 /* should we NOT run plugins here if the route is inactive?
499 do we catch route != active somewhere higher?
502 (*i)->run (bufs, start_frame, end_frame, nframes, *i != _processors.back());
503 bufs.set_count ((*i)->output_streams());
508 Route::n_process_buffers ()
510 return max (_input->n_ports(), processor_max_streams);
514 Route::passthru (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
516 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
520 assert (bufs.available() >= input_streams());
522 if (_input->n_ports() == ChanCount::ZERO) {
523 silence_unlocked (nframes);
526 bufs.set_count (input_streams());
528 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
530 /* control/monitor bus ignores input ports when something is
531 feeding the listen "stream". data will "arrive" into the
532 route from the intreturn processor element.
534 bufs.silence (nframes, 0);
538 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
540 BufferSet::iterator o = bufs.begin(*t);
541 PortSet& ports (_input->ports());
543 for (PortSet::iterator i = ports.begin(*t); i != ports.end(*t); ++i, ++o) {
544 o->read_from (i->get_buffer(nframes), nframes);
549 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
550 process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, true);
554 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
556 BufferSet& bufs (_session.get_silent_buffers (n_process_buffers()));
557 bufs.set_count (_input->n_ports());
558 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
559 process_output_buffers (bufs, start_frame, end_frame, nframes, true, declick, false);
563 Route::set_listen (bool yn, void* src)
569 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
570 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
575 if (yn != _monitor_send->active()) {
577 _monitor_send->activate ();
578 _mute_master->set_soloed (true);
580 _monitor_send->deactivate ();
581 _mute_master->set_soloed (false);
584 listen_changed (src); /* EMIT SIGNAL */
590 Route::listening_via_monitor () const
593 return _monitor_send->active ();
600 Route::set_solo_safe (bool yn, void *src)
602 if (_solo_safe != yn) {
604 solo_safe_changed (src);
609 Route::solo_safe() const
615 Route::set_solo (bool yn, void *src)
621 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
622 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
626 if (self_soloed() != yn) {
628 set_mute_master_solo ();
629 solo_changed (true, src); /* EMIT SIGNAL */
630 _solo_control->Changed (); /* EMIT SIGNAL */
635 Route::set_self_solo (bool yn)
641 Route::mod_solo_by_others_upstream (int32_t delta)
647 uint32_t old_sbu = _soloed_by_others_upstream;
650 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
651 _soloed_by_others_upstream += delta;
653 _soloed_by_others_upstream = 0;
656 _soloed_by_others_upstream += delta;
659 DEBUG_TRACE (DEBUG::Solo, string_compose (
660 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
661 name(), delta, _soloed_by_others_upstream, old_sbu,
662 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
664 /* push the inverse solo change to everything that feeds us.
666 This is important for solo-within-group. When we solo 1 track out of N that
667 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
668 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
669 tracks that feed it. This will silence them if they were audible because
670 of a bus solo, but the newly soloed track will still be audible (because
673 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
677 if ((_self_solo || _soloed_by_others_downstream) &&
678 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
679 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
681 if (delta > 0 || !Config->get_exclusive_solo()) {
682 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
683 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
684 boost::shared_ptr<Route> sr = i->r.lock();
686 sr->mod_solo_by_others_downstream (-delta);
692 set_mute_master_solo ();
693 solo_changed (false, this);
697 Route::mod_solo_by_others_downstream (int32_t delta)
704 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
705 _soloed_by_others_downstream += delta;
707 _soloed_by_others_downstream = 0;
710 _soloed_by_others_downstream += delta;
713 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
715 set_mute_master_solo ();
716 solo_changed (false, this);
720 Route::set_mute_master_solo ()
722 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
726 Route::set_solo_isolated (bool yn, void *src)
728 if (is_master() || is_monitor() || is_hidden()) {
732 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
733 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
737 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
739 boost::shared_ptr<RouteList> routes = _session.get_routes ();
740 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
742 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_hidden()) {
747 bool does_feed = direct_feeds (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
749 if (does_feed && !sends_only) {
750 (*i)->set_solo_isolated (yn, (*i)->route_group());
754 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
756 bool changed = false;
759 if (_solo_isolated == 0) {
760 _mute_master->set_solo_ignore (true);
765 if (_solo_isolated > 0) {
767 if (_solo_isolated == 0) {
768 _mute_master->set_solo_ignore (false);
775 solo_isolated_changed (src);
780 Route::solo_isolated () const
782 return _solo_isolated > 0;
786 Route::set_mute_points (MuteMaster::MutePoint mp)
788 _mute_master->set_mute_points (mp);
789 mute_points_changed (); /* EMIT SIGNAL */
791 if (_mute_master->muted_by_self()) {
792 mute_changed (this); /* EMIT SIGNAL */
793 _mute_control->Changed (); /* EMIT SIGNAL */
798 Route::set_mute (bool yn, void *src)
800 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
801 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
806 _mute_master->set_muted_by_self (yn);
807 mute_changed (src); /* EMIT SIGNAL */
808 _mute_control->Changed (); /* EMIT SIGNAL */
813 Route::muted () const
815 return _mute_master->muted_by_self();
820 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
822 cerr << name << " {" << endl;
823 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
824 p != procs.end(); ++p) {
825 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
832 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
834 ProcessorList::iterator loc;
836 /* XXX this is not thread safe - we don't hold the lock across determining the iter
837 to add before and actually doing the insertion. dammit.
840 if (placement == PreFader) {
841 /* generic pre-fader: insert immediately before the amp */
842 loc = find (_processors.begin(), _processors.end(), _amp);
844 /* generic post-fader: insert right before the main outs */
845 loc = find (_processors.begin(), _processors.end(), _main_outs);
848 return add_processor (processor, loc, err, activation_allowed);
852 /** Add a processor to a route such that it ends up with a given index into the visible processors.
853 * @param index Index to add the processor at, or -1 to add at the end of the list.
857 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
859 /* XXX this is not thread safe - we don't hold the lock across determining the iter
860 to add before and actually doing the insertion. dammit.
864 return add_processor (processor, _processors.end(), err, activation_allowed);
867 ProcessorList::iterator i = _processors.begin ();
869 while (i != _processors.end() && j < index) {
870 if ((*i)->display_to_user()) {
877 return add_processor (processor, i, err, activation_allowed);
880 /** Add a processor to the route.
881 * @param iter an iterator in _processors; the new processor will be inserted immediately before this location.
884 Route::add_processor (boost::shared_ptr<Processor> processor, ProcessorList::iterator iter, ProcessorStreams* err, bool activation_allowed)
886 assert (processor != _meter);
887 assert (processor != _main_outs);
889 DEBUG_TRACE (DEBUG::Processors, string_compose (
890 "%1 adding processor %2\n", name(), processor->name()));
892 if (!_session.engine().connected() || !processor) {
897 Glib::RWLock::WriterLock lm (_processor_lock);
898 ProcessorState pstate (this);
900 boost::shared_ptr<PluginInsert> pi;
901 boost::shared_ptr<PortInsert> porti;
903 ProcessorList::iterator loc = find(_processors.begin(), _processors.end(), processor);
905 if (processor == _amp) {
906 // Ensure only one amp is in the list at any time
907 if (loc != _processors.end()) {
908 if (iter == loc) { // Already in place, do nothing
910 } else { // New position given, relocate
911 _processors.erase (loc);
916 if (loc != _processors.end()) {
917 cerr << "ERROR: Processor added to route twice!" << endl;
924 _processors.insert (loc, processor);
926 // Set up processor list channels. This will set processor->[input|output]_streams(),
927 // configure redirect ports properly, etc.
930 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
932 if (configure_processors_unlocked (err)) {
934 configure_processors_unlocked (0); // it worked before we tried to add it ...
939 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
941 if (pi->has_no_inputs ()) {
942 /* generator plugin */
943 _have_internal_generator = true;
948 if (activation_allowed) {
949 processor->activate ();
952 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
954 _output->set_user_latency (0);
957 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
958 set_processor_positions ();
964 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
966 const XMLProperty *prop;
969 boost::shared_ptr<Processor> processor;
971 /* bit of a hack: get the `placement' property from the <Redirect> tag here
972 so that we can add the processor in the right place (pre/post-fader)
975 XMLNodeList const & children = node.children ();
976 XMLNodeList::const_iterator i = children.begin ();
978 while (i != children.end() && (*i)->name() != X_("Redirect")) {
982 Placement placement = PreFader;
984 if (i != children.end()) {
985 if ((prop = (*i)->property (X_("placement"))) != 0) {
986 placement = Placement (string_2_enum (prop->value(), placement));
990 if (node.name() == "Insert") {
992 if ((prop = node.property ("type")) != 0) {
994 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
995 prop->value() == "lv2" ||
996 prop->value() == "vst" ||
997 prop->value() == "lxvst" ||
998 prop->value() == "audiounit") {
1000 processor.reset (new PluginInsert (_session));
1004 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1009 } else if (node.name() == "Send") {
1011 processor.reset (new Send (_session, _pannable, _mute_master));
1015 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1019 if (processor->set_state (node, version)) {
1023 return (add_processor (processor, placement) == 0);
1026 catch (failed_constructor &err) {
1027 warning << _("processor could not be created. Ignored.") << endmsg;
1033 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1035 /* NOTE: this is intended to be used ONLY when copying
1036 processors from another Route. Hence the subtle
1037 differences between this and ::add_processor()
1040 ProcessorList::iterator loc;
1043 loc = find(_processors.begin(), _processors.end(), before);
1045 /* nothing specified - at end */
1046 loc = _processors.end ();
1049 if (!_session.engine().connected()) {
1053 if (others.empty()) {
1058 Glib::RWLock::WriterLock lm (_processor_lock);
1059 ProcessorState pstate (this);
1061 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1067 boost::shared_ptr<PluginInsert> pi;
1069 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1073 _processors.insert (loc, *i);
1075 if ((*i)->active()) {
1080 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1081 if (configure_processors_unlocked (err)) {
1083 configure_processors_unlocked (0); // it worked before we tried to add it ...
1088 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1091 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1092 boost::shared_ptr<PluginInsert> pi;
1094 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1095 if (pi->has_no_inputs ()) {
1096 _have_internal_generator = true;
1102 _output->set_user_latency (0);
1105 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1106 set_processor_positions ();
1112 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1114 if (p == PreFader) {
1115 start = _processors.begin();
1116 end = find(_processors.begin(), _processors.end(), _amp);
1118 start = find(_processors.begin(), _processors.end(), _amp);
1120 end = _processors.end();
1124 /** Turn off all processors with a given placement
1125 * @param p Placement of processors to disable
1128 Route::disable_processors (Placement p)
1130 Glib::RWLock::ReaderLock lm (_processor_lock);
1132 ProcessorList::iterator start, end;
1133 placement_range(p, start, end);
1135 for (ProcessorList::iterator i = start; i != end; ++i) {
1136 (*i)->deactivate ();
1139 _session.set_dirty ();
1142 /** Turn off all redirects
1145 Route::disable_processors ()
1147 Glib::RWLock::ReaderLock lm (_processor_lock);
1149 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1150 (*i)->deactivate ();
1153 _session.set_dirty ();
1156 /** Turn off all redirects with a given placement
1157 * @param p Placement of redirects to disable
1160 Route::disable_plugins (Placement p)
1162 Glib::RWLock::ReaderLock lm (_processor_lock);
1164 ProcessorList::iterator start, end;
1165 placement_range(p, start, end);
1167 for (ProcessorList::iterator i = start; i != end; ++i) {
1168 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1169 (*i)->deactivate ();
1173 _session.set_dirty ();
1176 /** Turn off all plugins
1179 Route::disable_plugins ()
1181 Glib::RWLock::ReaderLock lm (_processor_lock);
1183 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1184 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1185 (*i)->deactivate ();
1189 _session.set_dirty ();
1194 Route::ab_plugins (bool forward)
1196 Glib::RWLock::ReaderLock lm (_processor_lock);
1200 /* forward = turn off all active redirects, and mark them so that the next time
1201 we go the other way, we will revert them
1204 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1205 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1209 if ((*i)->active()) {
1210 (*i)->deactivate ();
1211 (*i)->set_next_ab_is_active (true);
1213 (*i)->set_next_ab_is_active (false);
1219 /* backward = if the redirect was marked to go active on the next ab, do so */
1221 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1223 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1227 if ((*i)->get_next_ab_is_active()) {
1230 (*i)->deactivate ();
1235 _session.set_dirty ();
1239 /** Remove processors with a given placement.
1240 * @param p Placement of processors to remove.
1243 Route::clear_processors (Placement p)
1245 if (!_session.engine().connected()) {
1249 bool already_deleting = _session.deletion_in_progress();
1250 if (!already_deleting) {
1251 _session.set_deletion_in_progress();
1255 Glib::RWLock::WriterLock lm (_processor_lock);
1256 ProcessorList new_list;
1257 ProcessorStreams err;
1258 bool seen_amp = false;
1260 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1266 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1268 /* you can't remove these */
1270 new_list.push_back (*i);
1277 new_list.push_back (*i);
1280 (*i)->drop_references ();
1288 (*i)->drop_references ();
1291 new_list.push_back (*i);
1298 _processors = new_list;
1301 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1302 configure_processors_unlocked (&err); // this can't fail
1306 processor_max_streams.reset();
1307 _have_internal_generator = false;
1308 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1309 set_processor_positions ();
1311 if (!already_deleting) {
1312 _session.clear_deletion_in_progress();
1317 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err)
1319 /* these can never be removed */
1321 if (processor == _amp || processor == _meter || processor == _main_outs) {
1325 if (!_session.engine().connected()) {
1329 processor_max_streams.reset();
1332 Glib::RWLock::WriterLock lm (_processor_lock);
1333 ProcessorState pstate (this);
1335 ProcessorList::iterator i;
1336 bool removed = false;
1338 for (i = _processors.begin(); i != _processors.end(); ) {
1339 if (*i == processor) {
1341 /* move along, see failure case for configure_processors()
1342 where we may need to reconfigure the processor.
1345 /* stop redirects that send signals to JACK ports
1346 from causing noise as a result of no longer being
1350 boost::shared_ptr<IOProcessor> iop;
1352 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1354 iop->input()->disconnect (this);
1356 if (iop->output()) {
1357 iop->output()->disconnect (this);
1361 i = _processors.erase (i);
1369 _output->set_user_latency (0);
1378 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1380 if (configure_processors_unlocked (err)) {
1382 /* we know this will work, because it worked before :) */
1383 configure_processors_unlocked (0);
1388 _have_internal_generator = false;
1390 for (i = _processors.begin(); i != _processors.end(); ++i) {
1391 boost::shared_ptr<PluginInsert> pi;
1393 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1394 if (pi->has_no_inputs ()) {
1395 _have_internal_generator = true;
1402 processor->drop_references ();
1403 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1404 set_processor_positions ();
1410 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1412 ProcessorList deleted;
1414 if (!_session.engine().connected()) {
1418 processor_max_streams.reset();
1421 Glib::RWLock::WriterLock lm (_processor_lock);
1422 ProcessorState pstate (this);
1424 ProcessorList::iterator i;
1425 boost::shared_ptr<Processor> processor;
1427 for (i = _processors.begin(); i != _processors.end(); ) {
1431 /* these can never be removed */
1433 if (processor == _amp || processor == _meter || processor == _main_outs) {
1438 /* see if its in the list of processors to delete */
1440 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1445 /* stop IOProcessors that send to JACK ports
1446 from causing noise as a result of no longer being
1450 boost::shared_ptr<IOProcessor> iop;
1452 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1456 deleted.push_back (processor);
1457 i = _processors.erase (i);
1460 if (deleted.empty()) {
1461 /* none of those in the requested list were found */
1465 _output->set_user_latency (0);
1468 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1470 if (configure_processors_unlocked (err)) {
1472 /* we know this will work, because it worked before :) */
1473 configure_processors_unlocked (0);
1478 _have_internal_generator = false;
1480 for (i = _processors.begin(); i != _processors.end(); ++i) {
1481 boost::shared_ptr<PluginInsert> pi;
1483 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1484 if (pi->has_no_inputs ()) {
1485 _have_internal_generator = true;
1492 /* now try to do what we need to so that those that were removed will be deleted */
1494 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1495 (*i)->drop_references ();
1498 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1499 set_processor_positions ();
1504 /** Caller must hold process lock */
1506 Route::configure_processors (ProcessorStreams* err)
1508 assert (!AudioEngine::instance()->process_lock().trylock());
1510 if (!_in_configure_processors) {
1511 Glib::RWLock::WriterLock lm (_processor_lock);
1512 return configure_processors_unlocked (err);
1519 Route::input_streams () const
1521 return _input->n_ports ();
1524 list<pair<ChanCount, ChanCount> >
1525 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1527 Glib::RWLock::ReaderLock lm (_processor_lock);
1529 return try_configure_processors_unlocked (in, err);
1532 list<pair<ChanCount, ChanCount> >
1533 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1535 // Check each processor in order to see if we can configure as requested
1537 list<pair<ChanCount, ChanCount> > configuration;
1540 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1541 DEBUG_TRACE (DEBUG::Processors, "{\n");
1543 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1545 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1546 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1550 if ((*p)->can_support_io_configuration(in, out)) {
1551 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1552 configuration.push_back(make_pair(in, out));
1559 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1560 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1561 DEBUG_TRACE (DEBUG::Processors, "}\n");
1562 return list<pair<ChanCount, ChanCount> > ();
1566 DEBUG_TRACE (DEBUG::Processors, "}\n");
1568 return configuration;
1571 /** Set the input/output configuration of each processor in the processors list.
1572 * Caller must hold process lock.
1573 * Return 0 on success, otherwise configuration is impossible.
1576 Route::configure_processors_unlocked (ProcessorStreams* err)
1578 assert (!AudioEngine::instance()->process_lock().trylock());
1580 if (_in_configure_processors) {
1584 /* put invisible processors where they should be */
1585 setup_invisible_processors ();
1587 _in_configure_processors = true;
1589 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1591 if (configuration.empty ()) {
1592 _in_configure_processors = false;
1598 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1599 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1601 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1605 (*p)->configure_io(c->first, c->second);
1606 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1607 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1612 _meter->reset_max_channels (processor_max_streams);
1615 /* make sure we have sufficient scratch buffers to cope with the new processor
1618 _session.ensure_buffers (n_process_buffers ());
1620 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1622 _in_configure_processors = false;
1626 /** Set all processors with a given placement to a given active state.
1627 * @param p Placement of processors to change.
1628 * @param state New active state for those processors.
1631 Route::all_processors_active (Placement p, bool state)
1633 Glib::RWLock::ReaderLock lm (_processor_lock);
1635 if (_processors.empty()) {
1639 ProcessorList::iterator start, end;
1640 placement_range(p, start, end);
1642 for (ProcessorList::iterator i = start; i != end; ++i) {
1646 (*i)->deactivate ();
1650 _session.set_dirty ();
1654 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1656 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1657 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1658 processors in the current actual processor list that are hidden. Any visible processors
1659 in the current list but not in "new_order" will be assumed to be deleted.
1663 Glib::RWLock::WriterLock lm (_processor_lock);
1664 ProcessorState pstate (this);
1666 ProcessorList::iterator oiter;
1667 ProcessorList::const_iterator niter;
1668 ProcessorList as_it_will_be;
1670 oiter = _processors.begin();
1671 niter = new_order.begin();
1673 while (niter != new_order.end()) {
1675 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1676 then append it to the temp list.
1678 Otherwise, see if the next processor in the old list is in the new list. if not,
1679 its been deleted. If its there, append it to the temp list.
1682 if (oiter == _processors.end()) {
1684 /* no more elements in the old list, so just stick the rest of
1685 the new order onto the temp list.
1688 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1689 while (niter != new_order.end()) {
1696 if (!(*oiter)->display_to_user()) {
1698 as_it_will_be.push_back (*oiter);
1702 /* visible processor: check that its in the new order */
1704 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1705 /* deleted: do nothing, shared_ptr<> will clean up */
1707 /* ignore this one, and add the next item from the new order instead */
1708 as_it_will_be.push_back (*niter);
1713 /* now remove from old order - its taken care of no matter what */
1714 oiter = _processors.erase (oiter);
1719 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1722 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1724 if (configure_processors_unlocked (err)) {
1731 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1732 set_processor_positions ();
1744 Route::get_template()
1746 return state(false);
1750 Route::state(bool full_state)
1752 XMLNode *node = new XMLNode("Route");
1753 ProcessorList::iterator i;
1756 id().print (buf, sizeof (buf));
1757 node->add_property("id", buf);
1758 node->add_property ("name", _name);
1759 node->add_property("default-type", _default_type.to_string());
1762 node->add_property("flags", enum_2_string (_flags));
1765 node->add_property("active", _active?"yes":"no");
1767 boost::to_string (_phase_invert, p);
1768 node->add_property("phase-invert", p);
1769 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1770 node->add_property("meter-point", enum_2_string (_meter_point));
1773 node->add_property("route-group", _route_group->name());
1776 string order_string;
1777 OrderKeys::iterator x = order_keys.begin();
1779 while (x != order_keys.end()) {
1780 order_string += string ((*x).first);
1781 order_string += '=';
1782 snprintf (buf, sizeof(buf), "%ld", (*x).second);
1783 order_string += buf;
1787 if (x == order_keys.end()) {
1791 order_string += ':';
1793 node->add_property ("order-keys", order_string);
1794 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1795 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1796 node->add_property ("soloed-by-upstream", buf);
1797 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1798 node->add_property ("soloed-by-downstream", buf);
1799 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1800 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1802 node->add_child_nocopy (_input->state (full_state));
1803 node->add_child_nocopy (_output->state (full_state));
1804 node->add_child_nocopy (_solo_control->get_state ());
1805 node->add_child_nocopy (_mute_control->get_state ());
1806 node->add_child_nocopy (_mute_master->get_state ());
1808 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1809 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1810 remote_control_node->add_property (X_("id"), buf);
1811 node->add_child_nocopy (*remote_control_node);
1813 if (_comment.length()) {
1814 XMLNode *cmt = node->add_child ("Comment");
1815 cmt->add_content (_comment);
1819 node->add_child_nocopy (_pannable->state (full_state));
1822 for (i = _processors.begin(); i != _processors.end(); ++i) {
1823 node->add_child_nocopy((*i)->state (full_state));
1827 node->add_child_copy (*_extra_xml);
1834 Route::set_state (const XMLNode& node, int version)
1836 return _set_state (node, version);
1840 Route::_set_state (const XMLNode& node, int version)
1842 if (version < 3000) {
1843 return _set_state_2X (node, version);
1847 XMLNodeConstIterator niter;
1849 const XMLProperty *prop;
1851 if (node.name() != "Route"){
1852 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
1856 if ((prop = node.property (X_("name"))) != 0) {
1857 Route::set_name (prop->value());
1862 if ((prop = node.property (X_("flags"))) != 0) {
1863 _flags = Flag (string_2_enum (prop->value(), _flags));
1868 if (is_master() || is_monitor() || is_hidden()) {
1869 _mute_master->set_solo_ignore (true);
1873 /* monitor bus does not get a panner, but if (re)created
1874 via XML, it will already have one by the time we
1875 call ::set_state(). so ... remove it.
1880 /* add all processors (except amp, which is always present) */
1882 nlist = node.children();
1883 XMLNode processor_state (X_("processor_state"));
1885 Stateful::save_extra_xml (node);
1887 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1891 if (child->name() == IO::state_node_name) {
1892 if ((prop = child->property (X_("direction"))) == 0) {
1896 if (prop->value() == "Input") {
1897 _input->set_state (*child, version);
1898 } else if (prop->value() == "Output") {
1899 _output->set_state (*child, version);
1903 if (child->name() == X_("Processor")) {
1904 processor_state.add_child_copy (*child);
1908 if (child->name() == X_("Pannable")) {
1910 _pannable->set_state (*child, version);
1912 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
1917 if ((prop = node.property (X_("meter-point"))) != 0) {
1918 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
1919 set_meter_point (mp, true);
1921 _meter->set_display_to_user (_meter_point == MeterCustom);
1925 set_processor_state (processor_state);
1927 if ((prop = node.property ("self-solo")) != 0) {
1928 set_self_solo (string_is_affirmative (prop->value()));
1931 if ((prop = node.property ("soloed-by-upstream")) != 0) {
1932 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
1933 mod_solo_by_others_upstream (atoi (prop->value()));
1936 if ((prop = node.property ("soloed-by-downstream")) != 0) {
1937 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
1938 mod_solo_by_others_downstream (atoi (prop->value()));
1941 if ((prop = node.property ("solo-isolated")) != 0) {
1942 set_solo_isolated (string_is_affirmative (prop->value()), this);
1945 if ((prop = node.property ("solo-safe")) != 0) {
1946 set_solo_safe (string_is_affirmative (prop->value()), this);
1949 if ((prop = node.property (X_("phase-invert"))) != 0) {
1950 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
1953 if ((prop = node.property (X_("denormal-protection"))) != 0) {
1954 set_denormal_protection (string_is_affirmative (prop->value()));
1957 if ((prop = node.property (X_("active"))) != 0) {
1958 bool yn = string_is_affirmative (prop->value());
1959 _active = !yn; // force switch
1960 set_active (yn, this);
1963 if ((prop = node.property (X_("order-keys"))) != 0) {
1967 string::size_type colon, equal;
1968 string remaining = prop->value();
1970 while (remaining.length()) {
1972 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
1973 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
1976 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
1977 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
1980 set_order_key (remaining.substr (0, equal), n);
1984 colon = remaining.find_first_of (':');
1986 if (colon != string::npos) {
1987 remaining = remaining.substr (colon+1);
1994 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1997 if (child->name() == X_("Comment")) {
1999 /* XXX this is a terrible API design in libxml++ */
2001 XMLNode *cmt = *(child->children().begin());
2002 _comment = cmt->content();
2004 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2005 if (prop->value() == "solo") {
2006 _solo_control->set_state (*child, version);
2009 } else if (child->name() == X_("RemoteControl")) {
2010 if ((prop = child->property (X_("id"))) != 0) {
2012 sscanf (prop->value().c_str(), "%d", &x);
2013 set_remote_control_id (x);
2016 } else if (child->name() == X_("MuteMaster")) {
2017 _mute_master->set_state (*child, version);
2025 Route::_set_state_2X (const XMLNode& node, int version)
2028 XMLNodeConstIterator niter;
2030 const XMLProperty *prop;
2032 /* 2X things which still remain to be handled:
2038 if (node.name() != "Route") {
2039 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2043 if ((prop = node.property (X_("flags"))) != 0) {
2044 _flags = Flag (string_2_enum (prop->value(), _flags));
2049 if ((prop = node.property (X_("phase-invert"))) != 0) {
2050 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2051 if (string_is_affirmative (prop->value ())) {
2054 set_phase_invert (p);
2057 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2058 set_denormal_protection (string_is_affirmative (prop->value()));
2061 if ((prop = node.property (X_("soloed"))) != 0) {
2062 bool yn = string_is_affirmative (prop->value());
2064 /* XXX force reset of solo status */
2066 set_solo (yn, this);
2069 if ((prop = node.property (X_("muted"))) != 0) {
2072 bool muted = string_is_affirmative (prop->value());
2078 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2080 if (string_is_affirmative (prop->value())){
2081 mute_point = mute_point + "PreFader";
2086 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2088 if (string_is_affirmative (prop->value())){
2091 mute_point = mute_point + ",";
2094 mute_point = mute_point + "PostFader";
2099 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2101 if (string_is_affirmative (prop->value())){
2104 mute_point = mute_point + ",";
2107 mute_point = mute_point + "Listen";
2112 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2114 if (string_is_affirmative (prop->value())){
2117 mute_point = mute_point + ",";
2120 mute_point = mute_point + "Main";
2124 _mute_master->set_mute_points (mute_point);
2125 _mute_master->set_muted_by_self (true);
2129 if ((prop = node.property (X_("meter-point"))) != 0) {
2130 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2133 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2134 don't mean the same thing.
2137 if ((prop = node.property (X_("order-keys"))) != 0) {
2141 string::size_type colon, equal;
2142 string remaining = prop->value();
2144 while (remaining.length()) {
2146 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2147 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2150 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2151 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2154 set_order_key (remaining.substr (0, equal), n);
2158 colon = remaining.find_first_of (':');
2160 if (colon != string::npos) {
2161 remaining = remaining.substr (colon+1);
2170 nlist = node.children ();
2171 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2175 if (child->name() == IO::state_node_name) {
2177 /* there is a note in IO::set_state_2X() about why we have to call
2181 _input->set_state_2X (*child, version, true);
2182 _output->set_state_2X (*child, version, false);
2184 if ((prop = child->property (X_("name"))) != 0) {
2185 Route::set_name (prop->value ());
2190 if ((prop = child->property (X_("active"))) != 0) {
2191 bool yn = string_is_affirmative (prop->value());
2192 _active = !yn; // force switch
2193 set_active (yn, this);
2196 if ((prop = child->property (X_("gain"))) != 0) {
2199 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2200 _amp->gain_control()->set_value (val);
2204 /* Set up Panners in the IO */
2205 XMLNodeList io_nlist = child->children ();
2207 XMLNodeConstIterator io_niter;
2210 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2212 io_child = *io_niter;
2214 if (io_child->name() == X_("Panner")) {
2215 _main_outs->panner_shell()->set_state(*io_child, version);
2216 } else if (io_child->name() == X_("Automation")) {
2217 /* IO's automation is for the fader */
2218 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2224 XMLNodeList redirect_nodes;
2226 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2230 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2231 redirect_nodes.push_back(child);
2236 set_processor_state_2X (redirect_nodes, version);
2238 Stateful::save_extra_xml (node);
2240 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2243 if (child->name() == X_("Comment")) {
2245 /* XXX this is a terrible API design in libxml++ */
2247 XMLNode *cmt = *(child->children().begin());
2248 _comment = cmt->content();
2250 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2251 if (prop->value() == X_("solo")) {
2252 _solo_control->set_state (*child, version);
2253 } else if (prop->value() == X_("mute")) {
2254 _mute_control->set_state (*child, version);
2257 } else if (child->name() == X_("RemoteControl")) {
2258 if ((prop = child->property (X_("id"))) != 0) {
2260 sscanf (prop->value().c_str(), "%d", &x);
2261 set_remote_control_id (x);
2271 Route::get_processor_state ()
2273 XMLNode* root = new XMLNode (X_("redirects"));
2274 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2275 root->add_child_nocopy ((*i)->state (true));
2282 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2284 /* We don't bother removing existing processors not in nList, as this
2285 method will only be called when creating a Route from scratch, not
2286 for undo purposes. Just put processors in at the appropriate place
2290 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2291 add_processor_from_xml_2X (**i, version);
2296 Route::set_processor_state (const XMLNode& node)
2298 const XMLNodeList &nlist = node.children();
2299 XMLNodeConstIterator niter;
2300 ProcessorList new_order;
2301 bool must_configure = false;
2303 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2305 XMLProperty* prop = (*niter)->property ("type");
2307 if (prop->value() == "amp") {
2308 _amp->set_state (**niter, Stateful::current_state_version);
2309 new_order.push_back (_amp);
2310 } else if (prop->value() == "meter") {
2311 _meter->set_state (**niter, Stateful::current_state_version);
2312 new_order.push_back (_meter);
2313 } else if (prop->value() == "main-outs") {
2314 _main_outs->set_state (**niter, Stateful::current_state_version);
2315 } else if (prop->value() == "intreturn") {
2317 _intreturn.reset (new InternalReturn (_session));
2318 must_configure = true;
2320 _intreturn->set_state (**niter, Stateful::current_state_version);
2321 } else if (is_monitor() && prop->value() == "monitor") {
2322 if (!_monitor_control) {
2323 _monitor_control.reset (new MonitorProcessor (_session));
2324 must_configure = true;
2326 _monitor_control->set_state (**niter, Stateful::current_state_version);
2327 } else if (prop->value() == "capture") {
2328 _capturing_processor.reset (new CapturingProcessor (_session));
2330 ProcessorList::iterator o;
2332 for (o = _processors.begin(); o != _processors.end(); ++o) {
2333 XMLProperty* id_prop = (*niter)->property(X_("id"));
2334 if (id_prop && (*o)->id() == id_prop->value()) {
2335 (*o)->set_state (**niter, Stateful::current_state_version);
2336 new_order.push_back (*o);
2341 // If the processor (*niter) is not on the route then create it
2343 if (o == _processors.end()) {
2345 boost::shared_ptr<Processor> processor;
2347 if (prop->value() == "intsend") {
2349 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2351 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2352 prop->value() == "lv2" ||
2353 prop->value() == "vst" ||
2354 prop->value() == "lxvst" ||
2355 prop->value() == "audiounit") {
2357 processor.reset (new PluginInsert(_session));
2359 } else if (prop->value() == "port") {
2361 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2363 } else if (prop->value() == "send") {
2365 processor.reset (new Send (_session, _pannable, _mute_master));
2368 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2372 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2373 /* This processor could not be configured. Turn it into a UnknownProcessor */
2374 processor.reset (new UnknownProcessor (_session, **niter));
2377 /* we have to note the monitor send here, otherwise a new one will be created
2378 and the state of this one will be lost.
2380 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2381 if (isend && isend->role() == Delivery::Listen) {
2382 _monitor_send = isend;
2385 /* it doesn't matter if invisible processors are added here, as they
2386 will be sorted out by setup_invisible_processors () shortly.
2389 new_order.push_back (processor);
2390 must_configure = true;
2396 Glib::RWLock::WriterLock lm (_processor_lock);
2397 _processors = new_order;
2399 if (must_configure) {
2400 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2401 configure_processors_unlocked (0);
2404 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2406 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2408 boost::shared_ptr<PluginInsert> pi;
2410 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2411 if (pi->has_no_inputs ()) {
2412 _have_internal_generator = true;
2419 processors_changed (RouteProcessorChange ());
2420 set_processor_positions ();
2424 Route::curve_reallocate ()
2426 // _gain_automation_curve.finish_resize ();
2427 // _pan_automation_curve.finish_resize ();
2431 Route::silence (framecnt_t nframes)
2433 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2438 silence_unlocked (nframes);
2442 Route::silence_unlocked (framecnt_t nframes)
2444 /* Must be called with the processor lock held */
2448 _output->silence (nframes);
2450 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2451 boost::shared_ptr<PluginInsert> pi;
2453 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2454 // skip plugins, they don't need anything when we're not active
2458 (*i)->silence (nframes);
2461 if (nframes == _session.get_block_size()) {
2468 Route::add_internal_return ()
2471 _intreturn.reset (new InternalReturn (_session));
2472 add_processor (_intreturn, PreFader);
2477 Route::add_send_to_internal_return (InternalSend* send)
2479 Glib::RWLock::ReaderLock rm (_processor_lock);
2481 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2482 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2485 return d->add_send (send);
2491 Route::remove_send_from_internal_return (InternalSend* send)
2493 Glib::RWLock::ReaderLock rm (_processor_lock);
2495 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2496 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2499 return d->remove_send (send);
2504 /** Add a monitor send (if we don't already have one) but don't activate it */
2506 Route::listen_via_monitor ()
2508 /* master never sends to control outs */
2509 assert (!is_master ());
2511 /* make sure we have one */
2512 if (!_monitor_send) {
2513 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2514 _monitor_send->set_display_to_user (false);
2518 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2519 configure_processors (0);
2524 /** Add an internal send to a route.
2525 * @param route route to send to.
2526 * @param placement placement for the send.
2529 Route::listen_via (boost::shared_ptr<Route> route, Placement placement)
2531 assert (route != _session.monitor_out ());
2534 Glib::RWLock::ReaderLock rm (_processor_lock);
2536 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2538 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2540 if (d && d->target_route() == route) {
2541 /* already listening via the specified IO: do nothing */
2548 boost::shared_ptr<InternalSend> listener (new InternalSend (_session, _pannable, _mute_master, route, Delivery::Aux));
2549 add_processor (listener, placement);
2551 } catch (failed_constructor& err) {
2559 Route::drop_listen (boost::shared_ptr<Route> route)
2561 ProcessorStreams err;
2562 ProcessorList::iterator tmp;
2564 Glib::RWLock::ReaderLock rl(_processor_lock);
2568 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ) {
2570 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2572 if (d && d->target_route() == route) {
2574 remove_processor (*x, &err);
2577 /* list could have been demolished while we dropped the lock
2587 if (route == _session.monitor_out()) {
2588 _monitor_send.reset ();
2593 Route::set_comment (string cmt, void *src)
2596 comment_changed (src);
2597 _session.set_dirty ();
2601 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2603 FeedRecord fr (other, via_sends_only);
2605 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2607 if (!result.second) {
2609 /* already a record for "other" - make sure sends-only information is correct */
2610 if (!via_sends_only && result.first->sends_only) {
2611 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2612 frp->sends_only = false;
2616 return result.second;
2620 Route::clear_fed_by ()
2626 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2628 const FedBy& fed_by (other->fed_by());
2630 for (FedBy::iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2631 boost::shared_ptr<Route> sr = f->r.lock();
2633 if (sr && (sr.get() == this)) {
2635 if (via_sends_only) {
2636 *via_sends_only = f->sends_only;
2647 Route::direct_feeds (boost::shared_ptr<Route> other, bool* only_send)
2649 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2651 if (_output->connected_to (other->input())) {
2652 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2661 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2663 boost::shared_ptr<IOProcessor> iop;
2665 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2666 if (iop->feeds (other)) {
2667 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2673 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2676 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2681 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2685 /** Called from the (non-realtime) butler thread when the transport is stopped */
2687 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool did_locate, bool can_flush_processors)
2689 framepos_t now = _session.transport_frame();
2692 Glib::RWLock::ReaderLock lm (_processor_lock);
2695 automation_snapshot (now, true);
2698 Automatable::transport_stopped (now);
2700 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2702 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2706 (*i)->transport_stopped (now);
2710 _roll_delay = _initial_delay;
2713 /** Called with the process lock held if change contains ConfigurationChanged */
2715 Route::input_change_handler (IOChange change, void * /*src*/)
2717 if ((change.type & IOChange::ConfigurationChanged)) {
2718 configure_processors (0);
2719 _phase_invert.resize (_input->n_ports().n_audio ());
2720 io_changed (); /* EMIT SIGNAL */
2725 Route::pans_required () const
2727 if (n_outputs().n_audio() < 2) {
2731 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
2735 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
2737 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2742 if (n_outputs().n_total() == 0) {
2746 if (!_active || n_inputs() == ChanCount::ZERO) {
2747 silence_unlocked (nframes);
2750 if (session_state_changing) {
2751 if (_session.transport_speed() != 0.0f) {
2752 /* we're rolling but some state is changing (e.g. our diskstream contents)
2753 so we cannot use them. Be silent till this is over.
2755 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
2757 silence_unlocked (nframes);
2760 /* we're really not rolling, so we're either delivery silence or actually
2761 monitoring, both of which are safe to do while session_state_changing is true.
2765 _amp->apply_gain_automation (false);
2766 passthru (start_frame, end_frame, nframes, 0);
2772 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
2774 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
2779 automation_snapshot (_session.transport_frame(), false);
2781 if (n_outputs().n_total() == 0) {
2785 if (!_active || n_inputs().n_total() == 0) {
2786 silence_unlocked (nframes);
2790 framecnt_t unused = 0;
2792 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
2798 passthru (start_frame, end_frame, nframes, declick);
2804 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
2811 Route::toggle_monitor_input ()
2813 for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
2814 i->ensure_monitor_input( ! i->monitoring_input());
2819 Route::has_external_redirects () const
2821 // FIXME: what about sends? - they don't return a signal back to ardour?
2823 boost::shared_ptr<const PortInsert> pi;
2825 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2827 if ((pi = boost::dynamic_pointer_cast<const PortInsert>(*i)) != 0) {
2829 for (PortSet::const_iterator port = pi->output()->ports().begin(); port != pi->output()->ports().end(); ++port) {
2831 string port_name = port->name();
2832 string client_name = port_name.substr (0, port_name.find(':'));
2834 /* only say "yes" if the redirect is actually in use */
2836 if (client_name != "ardour" && pi->active()) {
2847 Route::flush_processors ()
2849 /* XXX shouldn't really try to take this lock, since
2850 this is called from the RT audio thread.
2853 Glib::RWLock::ReaderLock lm (_processor_lock);
2855 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2861 Route::set_meter_point (MeterPoint p, bool force)
2863 /* CAN BE CALLED FROM PROCESS CONTEXT */
2865 if (_meter_point == p && !force) {
2871 bool meter_was_visible_to_user = _meter->display_to_user ();
2874 Glib::RWLock::WriterLock lm (_processor_lock);
2876 if (_meter_point != MeterCustom) {
2878 _meter->set_display_to_user (false);
2880 setup_invisible_processors ();
2882 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
2886 if (loc == _processors.begin()) {
2887 m_in = _input->n_ports();
2889 ProcessorList::iterator before = loc;
2891 m_in = (*before)->output_streams ();
2894 _meter->reflect_inputs (m_in);
2896 /* we do not need to reconfigure the processors, because the meter
2897 (a) is always ready to handle processor_max_streams
2898 (b) is always an N-in/N-out processor, and thus moving
2899 it doesn't require any changes to the other processors.
2904 // just make it visible and let the user move it
2906 _meter->set_display_to_user (true);
2910 meter_change (); /* EMIT SIGNAL */
2912 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
2914 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
2918 Route::listen_position_changed ()
2921 Glib::RWLock::WriterLock lm (_processor_lock);
2922 ProcessorState pstate (this);
2925 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2927 if (configure_processors_unlocked (0)) {
2929 configure_processors_unlocked (0); // it worked before we tried to add it ...
2935 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2936 _session.set_dirty ();
2939 boost::shared_ptr<CapturingProcessor>
2940 Route::add_export_point()
2942 if (!_capturing_processor) {
2944 _capturing_processor.reset (new CapturingProcessor (_session));
2945 _capturing_processor->activate ();
2948 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2949 configure_processors (0);
2954 return _capturing_processor;
2958 Route::update_signal_latency ()
2960 framecnt_t l = _output->user_latency();
2962 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2963 if ((*i)->active ()) {
2964 l += (*i)->signal_latency ();
2968 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
2970 if (_signal_latency != l) {
2971 _signal_latency = l;
2972 signal_latency_changed (); /* EMIT SIGNAL */
2975 return _signal_latency;
2979 Route::set_user_latency (framecnt_t nframes)
2981 _output->set_user_latency (nframes);
2982 _session.update_latency_compensation ();
2986 Route::set_latency_compensation (framecnt_t longest_session_latency)
2988 framecnt_t old = _initial_delay;
2990 if (_signal_latency < longest_session_latency) {
2991 _initial_delay = longest_session_latency - _signal_latency;
2996 DEBUG_TRACE (DEBUG::Latency, string_compose (
2997 "%1: compensate for maximum latency of %2,"
2998 "given own latency of %3, using initial delay of %4\n",
2999 name(), longest_session_latency, _signal_latency, _initial_delay));
3001 if (_initial_delay != old) {
3002 initial_delay_changed (); /* EMIT SIGNAL */
3005 if (_session.transport_stopped()) {
3006 _roll_delay = _initial_delay;
3011 Route::automation_snapshot (framepos_t now, bool force)
3014 _pannable->automation_snapshot (now, force);
3017 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3018 (*i)->automation_snapshot (now, force);
3022 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3023 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3024 boost::shared_ptr<AutomationList>(), name)
3027 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3032 Route::SoloControllable::set_value (double val)
3034 bool bval = ((val >= 0.5f) ? true: false);
3036 boost::shared_ptr<RouteList> rl (new RouteList);
3038 boost::shared_ptr<Route> r = _route.lock ();
3045 if (Config->get_solo_control_is_listen_control()) {
3046 _session.set_listen (rl, bval);
3048 _session.set_solo (rl, bval);
3053 Route::SoloControllable::get_value () const
3055 boost::shared_ptr<Route> r = _route.lock ();
3060 if (Config->get_solo_control_is_listen_control()) {
3061 return r->listening_via_monitor() ? 1.0f : 0.0f;
3063 return r->self_soloed() ? 1.0f : 0.0f;
3067 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3068 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3069 boost::shared_ptr<AutomationList>(), name)
3072 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3077 Route::MuteControllable::set_value (double val)
3079 bool bval = ((val >= 0.5f) ? true: false);
3081 boost::shared_ptr<RouteList> rl (new RouteList);
3083 boost::shared_ptr<Route> r = _route.lock ();
3089 _session.set_mute (rl, bval);
3093 Route::MuteControllable::get_value () const
3095 boost::shared_ptr<Route> r = _route.lock ();
3100 return r->muted() ? 1.0f : 0.0f;
3104 Route::set_block_size (pframes_t nframes)
3106 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3107 (*i)->set_block_size (nframes);
3110 _session.ensure_buffers (n_process_buffers ());
3114 Route::protect_automation ()
3116 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3117 (*i)->protect_automation();
3121 Route::set_pending_declick (int declick)
3124 /* this call is not allowed to turn off a pending declick unless "force" is true */
3126 _pending_declick = declick;
3128 // cerr << _name << ": after setting to " << declick << " pending declick = " << _pending_declick << endl;
3130 _pending_declick = 0;
3135 /** Shift automation forwards from a particular place, thereby inserting time.
3136 * Adds undo commands for any shifts that are performed.
3138 * @param pos Position to start shifting from.
3139 * @param frames Amount to shift forwards by.
3143 Route::shift (framepos_t pos, framecnt_t frames)
3145 /* gain automation */
3147 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3149 XMLNode &before = gc->alist()->get_state ();
3150 gc->alist()->shift (pos, frames);
3151 XMLNode &after = gc->alist()->get_state ();
3152 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3155 /* pan automation */
3157 ControlSet::Controls& c (_pannable->controls());
3159 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3160 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3162 boost::shared_ptr<AutomationList> al = pc->alist();
3163 XMLNode& before = al->get_state ();
3164 al->shift (pos, frames);
3165 XMLNode& after = al->get_state ();
3166 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3171 /* redirect automation */
3173 Glib::RWLock::ReaderLock lm (_processor_lock);
3174 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3176 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3178 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3179 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3181 boost::shared_ptr<AutomationList> al = ac->alist();
3182 XMLNode &before = al->get_state ();
3183 al->shift (pos, frames);
3184 XMLNode &after = al->get_state ();
3185 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3194 Route::save_as_template (const string& path, const string& name)
3196 XMLNode& node (state (false));
3199 IO::set_name_in_state (*node.children().front(), name);
3201 tree.set_root (&node);
3202 return tree.write (path.c_str());
3207 Route::set_name (const string& str)
3213 name = Route::ensure_track_or_route_name (str, _session);
3214 SessionObject::set_name (name);
3216 ret = (_input->set_name(name) && _output->set_name(name));
3219 /* rename the main outs. Leave other IO processors
3220 * with whatever name they already have, because its
3221 * just fine as it is (it will not contain the route
3222 * name if its a port insert, port send or port return).
3226 if (_main_outs->set_name (name)) {
3227 /* XXX returning false here is stupid because
3228 we already changed the route name.
3238 boost::shared_ptr<Send>
3239 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3241 Glib::RWLock::ReaderLock lm (_processor_lock);
3243 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3244 boost::shared_ptr<InternalSend> send;
3246 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3247 if (send->target_route() == target) {
3253 return boost::shared_ptr<Send>();
3256 /** @param c Audio channel index.
3257 * @param yn true to invert phase, otherwise false.
3260 Route::set_phase_invert (uint32_t c, bool yn)
3262 if (_phase_invert[c] != yn) {
3263 _phase_invert[c] = yn;
3264 phase_invert_changed (); /* EMIT SIGNAL */
3265 _session.set_dirty ();
3270 Route::set_phase_invert (boost::dynamic_bitset<> p)
3272 if (_phase_invert != p) {
3274 phase_invert_changed (); /* EMIT SIGNAL */
3275 _session.set_dirty ();
3280 Route::phase_invert (uint32_t c) const
3282 return _phase_invert[c];
3285 boost::dynamic_bitset<>
3286 Route::phase_invert () const
3288 return _phase_invert;
3292 Route::set_denormal_protection (bool yn)
3294 if (_denormal_protection != yn) {
3295 _denormal_protection = yn;
3296 denormal_protection_changed (); /* EMIT SIGNAL */
3301 Route::denormal_protection () const
3303 return _denormal_protection;
3307 Route::set_active (bool yn, void* src)
3309 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3310 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3314 if (_active != yn) {
3316 _input->set_active (yn);
3317 _output->set_active (yn);
3318 active_changed (); // EMIT SIGNAL
3325 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3331 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3333 boost::shared_ptr<Send> s;
3334 boost::shared_ptr<Return> r;
3336 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3337 s->meter()->meter();
3338 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3339 r->meter()->meter ();
3344 boost::shared_ptr<Pannable>
3345 Route::pannable() const
3350 boost::shared_ptr<Panner>
3351 Route::panner() const
3354 return _main_outs->panner_shell()->panner();
3357 boost::shared_ptr<PannerShell>
3358 Route::panner_shell() const
3360 return _main_outs->panner_shell();
3363 boost::shared_ptr<AutomationControl>
3364 Route::gain_control() const
3366 return _amp->gain_control();
3369 boost::shared_ptr<AutomationControl>
3370 Route::get_control (const Evoral::Parameter& param)
3372 /* either we own the control or .... */
3374 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3378 /* maybe one of our processors does or ... */
3380 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
3381 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3382 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3390 /* nobody does so we'll make a new one */
3392 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3399 boost::shared_ptr<Processor>
3400 Route::nth_plugin (uint32_t n)
3402 Glib::RWLock::ReaderLock lm (_processor_lock);
3403 ProcessorList::iterator i;
3405 for (i = _processors.begin(); i != _processors.end(); ++i) {
3406 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3413 return boost::shared_ptr<Processor> ();
3416 boost::shared_ptr<Processor>
3417 Route::nth_send (uint32_t n)
3419 Glib::RWLock::ReaderLock lm (_processor_lock);
3420 ProcessorList::iterator i;
3422 for (i = _processors.begin(); i != _processors.end(); ++i) {
3423 if (boost::dynamic_pointer_cast<Send> (*i)) {
3430 return boost::shared_ptr<Processor> ();
3434 Route::has_io_processor_named (const string& name)
3436 Glib::RWLock::ReaderLock lm (_processor_lock);
3437 ProcessorList::iterator i;
3439 for (i = _processors.begin(); i != _processors.end(); ++i) {
3440 if (boost::dynamic_pointer_cast<Send> (*i) ||
3441 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3442 if ((*i)->name() == name) {
3451 MuteMaster::MutePoint
3452 Route::mute_points () const
3454 return _mute_master->mute_points ();
3458 Route::set_processor_positions ()
3460 Glib::RWLock::ReaderLock lm (_processor_lock);
3462 bool had_amp = false;
3463 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3464 (*i)->set_pre_fader (!had_amp);
3465 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3471 /** Called when there is a proposed change to the input port count */
3473 Route::input_port_count_changing (ChanCount to)
3475 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3477 /* The processors cannot be configured with the new input arrangement, so
3483 /* The change is ok */
3488 Route::unknown_processors () const
3492 Glib::RWLock::ReaderLock lm (_processor_lock);
3493 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3494 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3495 p.push_back ((*i)->name ());
3504 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3506 /* we assume that all our input ports feed all our output ports. its not
3507 universally true, but the alternative is way too corner-case to worry about.
3510 jack_latency_range_t all_connections;
3513 all_connections.min = 0;
3514 all_connections.max = 0;
3516 all_connections.min = ~((jack_nframes_t) 0);
3517 all_connections.max = 0;
3519 /* iterate over all "from" ports and determine the latency range for all of their
3520 connections to the "outside" (outside of this Route).
3523 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3525 jack_latency_range_t range;
3527 p->get_connected_latency_range (range, playback);
3529 all_connections.min = min (all_connections.min, range.min);
3530 all_connections.max = max (all_connections.max, range.max);
3534 /* set the "from" port latencies to the max/min range of all their connections */
3536 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3537 p->set_private_latency_range (all_connections, playback);
3540 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3542 all_connections.min += our_latency;
3543 all_connections.max += our_latency;
3545 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3546 p->set_private_latency_range (all_connections, playback);
3549 return all_connections.max;
3553 Route::set_private_port_latencies (bool playback) const
3555 framecnt_t own_latency = 0;
3557 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3558 OR LATENCY CALLBACK.
3560 This is called (early) from the latency callback. It computes the REAL
3561 latency associated with each port and stores the result as the "private"
3562 latency of the port. A later call to Route::set_public_port_latencies()
3563 sets all ports to the same value to reflect the fact that we do latency
3564 compensation and so all signals are delayed by the same amount as they
3565 flow through ardour.
3568 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3569 if ((*i)->active ()) {
3570 own_latency += (*i)->signal_latency ();
3575 /* playback: propagate latency from "outside the route" to outputs to inputs */
3576 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3578 /* capture: propagate latency from "outside the route" to inputs to outputs */
3579 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3584 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3586 /* this is called to set the JACK-visible port latencies, which take
3587 latency compensation into account.
3590 jack_latency_range_t range;
3596 const PortSet& ports (_input->ports());
3597 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3598 p->set_public_latency_range (range, playback);
3603 const PortSet& ports (_output->ports());
3604 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3605 p->set_public_latency_range (range, playback);
3610 /** Put the invisible processors in the right place in _processors.
3611 * Must be called with a writer lock on _processor_lock held.
3614 Route::setup_invisible_processors ()
3617 Glib::RWLock::WriterLock lm (_processor_lock, Glib::TRY_LOCK);
3618 assert (!lm.locked ());
3622 /* too early to be doing this stuff */
3626 /* we'll build this new list here and then use it */
3628 ProcessorList new_processors;
3630 /* find visible processors */
3632 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3633 if ((*i)->display_to_user ()) {
3634 new_processors.push_back (*i);
3640 ProcessorList::iterator amp = new_processors.begin ();
3641 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3645 assert (amp != _processors.end ());
3647 /* and the processor after the amp */
3649 ProcessorList::iterator after_amp = amp;
3655 switch (_meter_point) {
3657 assert (!_meter->display_to_user ());
3658 new_processors.push_front (_meter);
3661 assert (!_meter->display_to_user ());
3662 new_processors.insert (amp, _meter);
3664 case MeterPostFader:
3665 /* do nothing here */
3668 /* do nothing here */
3671 /* the meter is visible, so we don't touch it here */
3678 assert (_main_outs);
3679 assert (!_main_outs->display_to_user ());
3680 new_processors.push_back (_main_outs);
3682 /* iterator for the main outs */
3684 ProcessorList::iterator main = new_processors.end();
3687 /* OUTPUT METERING */
3689 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3690 assert (!_meter->display_to_user ());
3692 /* add the processor just before or just after the main outs */
3694 ProcessorList::iterator meter_point = main;
3696 if (_meter_point == MeterOutput) {
3699 new_processors.insert (meter_point, _meter);
3704 if (_monitor_send && !is_monitor ()) {
3705 assert (!_monitor_send->display_to_user ());
3706 if (Config->get_solo_control_is_listen_control()) {
3707 switch (Config->get_listen_position ()) {
3708 case PreFaderListen:
3709 switch (Config->get_pfl_position ()) {
3710 case PFLFromBeforeProcessors:
3711 new_processors.push_front (_monitor_send);
3713 case PFLFromAfterProcessors:
3714 new_processors.insert (amp, _monitor_send);
3717 _monitor_send->set_can_pan (false);
3719 case AfterFaderListen:
3720 switch (Config->get_afl_position ()) {
3721 case AFLFromBeforeProcessors:
3722 new_processors.insert (after_amp, _monitor_send);
3724 case AFLFromAfterProcessors:
3725 new_processors.insert (new_processors.end(), _monitor_send);
3728 _monitor_send->set_can_pan (true);
3732 new_processors.insert (new_processors.end(), _monitor_send);
3733 _monitor_send->set_can_pan (false);
3737 /* MONITOR CONTROL */
3739 if (_monitor_control && is_monitor ()) {
3740 assert (!_monitor_control->display_to_user ());
3741 new_processors.push_front (_monitor_control);
3744 /* INTERNAL RETURN */
3746 /* doing this here means that any monitor control will come just after
3751 assert (!_intreturn->display_to_user ());
3752 new_processors.push_front (_intreturn);
3755 /* EXPORT PROCESSOR */
3757 if (_capturing_processor) {
3758 assert (!_capturing_processor->display_to_user ());
3759 new_processors.push_front (_capturing_processor);
3762 _processors = new_processors;
3764 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
3765 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3766 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
3771 Route::should_monitor () const
3773 switch (Config->get_monitoring_model()) {
3774 case HardwareMonitoring:
3775 case ExternalMonitoring:
3776 return !record_enabled() || (_session.config.get_auto_input() && !_session.actively_recording());
3788 Glib::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3789 Glib::RWLock::ReaderLock lp (_processor_lock);
3793 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3794 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);