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 <boost/algorithm/string.hpp>
31 #include "pbd/xml++.h"
32 #include "pbd/enumwriter.h"
33 #include "pbd/memento_command.h"
34 #include "pbd/stacktrace.h"
35 #include "pbd/convert.h"
36 #include "pbd/boost_debug.h"
37 #include "pbd/unwind.h"
39 #include "ardour/amp.h"
40 #include "ardour/audio_buffer.h"
41 #include "ardour/audio_track.h"
42 #include "ardour/audio_port.h"
43 #include "ardour/audioengine.h"
44 #include "ardour/buffer.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/capturing_processor.h"
47 #include "ardour/debug.h"
48 #include "ardour/delivery.h"
49 #include "ardour/gain_control.h"
50 #include "ardour/internal_return.h"
51 #include "ardour/internal_send.h"
52 #include "ardour/meter.h"
53 #include "ardour/delayline.h"
54 #include "ardour/midi_buffer.h"
55 #include "ardour/midi_port.h"
56 #include "ardour/monitor_processor.h"
57 #include "ardour/pannable.h"
58 #include "ardour/panner.h"
59 #include "ardour/panner_shell.h"
60 #include "ardour/parameter_descriptor.h"
61 #include "ardour/plugin_insert.h"
62 #include "ardour/port.h"
63 #include "ardour/port_insert.h"
64 #include "ardour/processor.h"
65 #include "ardour/profile.h"
66 #include "ardour/route.h"
67 #include "ardour/route_group.h"
68 #include "ardour/send.h"
69 #include "ardour/session.h"
70 #include "ardour/unknown_processor.h"
71 #include "ardour/utils.h"
76 using namespace ARDOUR;
79 PBD::Signal0<void> Route::SyncOrderKeys;
80 PBD::Signal0<void> Route::RemoteControlIDChange;
82 /** Base class for all routable/mixable objects (tracks and busses) */
83 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
84 : SessionObject (sess, name)
86 , GraphNode (sess._process_graph)
89 , _signal_latency_at_amp_position (0)
90 , _signal_latency_at_trim_position (0)
93 , _pending_process_reorder (0)
94 , _pending_signals (0)
96 , _pending_declick (true)
97 , _meter_point (MeterPostFader)
98 , _pending_meter_point (MeterPostFader)
99 , _meter_type (MeterPeak)
101 , _soloed_by_others_upstream (0)
102 , _soloed_by_others_downstream (0)
103 , _solo_isolated (false)
104 , _solo_isolated_by_upstream (0)
105 , _denormal_protection (false)
108 , _declickable (false)
109 , _mute_master (new MuteMaster (sess, name))
110 , _have_internal_generator (false)
112 , _default_type (default_type)
114 , _has_order_key (false)
115 , _remote_control_id (0)
117 , _in_configure_processors (false)
118 , _initial_io_setup (false)
119 , _in_sidechain_setup (false)
121 , _custom_meter_position_noted (false)
123 processor_max_streams.reset();
129 /* set default meter type */
131 _meter_type = Config->get_meter_type_master ();
133 else if (dynamic_cast<Track*>(this)) {
134 _meter_type = Config->get_meter_type_track ();
136 _meter_type = Config->get_meter_type_bus ();
139 /* add standard controls */
141 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
142 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
143 _phase_control.reset (new PhaseControllable (X_("phase"), shared_from_this ()));
145 _solo_isolate_control.reset (new SoloIsolateControllable (X_("solo-iso"), shared_from_this ()));
146 _solo_safe_control.reset (new SoloSafeControllable (X_("solo-safe"), shared_from_this ()));
148 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
149 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
150 _phase_control->set_flags (Controllable::Flag (_phase_control->flags() | Controllable::Toggle));
152 add_control (_solo_control);
153 add_control (_mute_control);
154 add_control (_phase_control);
158 if (!(_flags & Route::MonitorOut)) {
159 _pannable.reset (new Pannable (_session));
162 /* input and output objects */
164 _input.reset (new IO (_session, _name, IO::Input, _default_type));
165 _output.reset (new IO (_session, _name, IO::Output, _default_type));
167 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
168 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
170 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
171 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
173 #if 0 // not used - just yet
174 if (!is_master() && !is_monitor() && !is_auditioner()) {
175 _delayline.reset (new DelayLine (_session, _name));
176 add_processor (_delayline, PreFader);
180 /* add amp processor */
182 _gain_control = boost::shared_ptr<GainControllable> (new GainControllable (_session, GainAutomation, shared_from_this ()));
183 add_control (_gain_control);
185 _amp.reset (new Amp (_session, X_("Fader"), _gain_control, true));
186 add_processor (_amp, PostFader);
189 _amp->set_display_name (_("Monitor"));
194 _trim_control = boost::shared_ptr<GainControllable> (new GainControllable (_session, TrimAutomation, shared_from_this ()));
195 add_control (_trim_control);
197 _trim.reset (new Amp (_session, X_("Trim"), _trim_control, false));
198 _trim->set_display_to_user (false);
200 if (dynamic_cast<AudioTrack*>(this)) {
201 /* we can't do this in the AudioTrack's constructor
202 * because _trim does not exit then
206 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
211 /* create standard processors: meter, main outs, monitor out;
212 they will be added to _processors by setup_invisible_processors ()
215 _meter.reset (new PeakMeter (_session, _name));
216 _meter->set_owner (this);
217 _meter->set_display_to_user (false);
220 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
221 _main_outs->activate ();
224 /* where we listen to tracks */
225 _intreturn.reset (new InternalReturn (_session));
226 _intreturn->activate ();
228 /* the thing that provides proper control over a control/monitor/listen bus
229 (such as per-channel cut, dim, solo, invert, etc).
231 _monitor_control.reset (new MonitorProcessor (_session));
232 _monitor_control->activate ();
235 if (is_master() || is_monitor() || is_auditioner()) {
236 _mute_master->set_solo_ignore (true);
239 /* now that we have _meter, its safe to connect to this */
242 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
243 configure_processors (0);
251 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
253 /* do this early so that we don't get incoming signals as we are going through destruction
258 /* don't use clear_processors here, as it depends on the session which may
259 be half-destroyed by now
262 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
263 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
264 (*i)->drop_references ();
267 _processors.clear ();
271 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
273 if (Config->get_remote_model() != UserOrdered) {
277 set_remote_control_id_internal (id, notify_class_listeners);
281 Route::set_remote_control_id_internal (uint32_t id, bool notify_class_listeners)
283 /* force IDs for master/monitor busses and prevent
284 any other route from accidentally getting these IDs
285 (i.e. legacy sessions)
288 if (is_master() && id != MasterBusRemoteControlID) {
289 id = MasterBusRemoteControlID;
292 if (is_monitor() && id != MonitorBusRemoteControlID) {
293 id = MonitorBusRemoteControlID;
300 /* don't allow it to collide */
302 if (!is_master () && !is_monitor() &&
303 (id == MasterBusRemoteControlID || id == MonitorBusRemoteControlID)) {
304 id += MonitorBusRemoteControlID;
307 if (id != remote_control_id()) {
308 _remote_control_id = id;
309 RemoteControlIDChanged ();
311 if (notify_class_listeners) {
312 RemoteControlIDChange ();
318 Route::remote_control_id() const
321 return MasterBusRemoteControlID;
325 return MonitorBusRemoteControlID;
328 return _remote_control_id;
332 Route::has_order_key () const
334 return _has_order_key;
338 Route::order_key () const
344 Route::set_remote_control_id_explicit (uint32_t rid)
346 if (is_master() || is_monitor() || is_auditioner()) {
347 /* hard-coded remote IDs, or no remote ID */
351 if (_remote_control_id != rid) {
352 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1: set edit-based RID to %2\n", name(), rid));
353 _remote_control_id = rid;
354 RemoteControlIDChanged (); /* EMIT SIGNAL (per-route) */
357 /* don't emit the class-level RID signal RemoteControlIDChange here,
358 leave that to the entity that changed the order key, so that we
359 don't get lots of emissions for no good reasons (e.g. when changing
360 all route order keys).
362 See Session::sync_remote_id_from_order_keys() for the (primary|only)
363 spot where that is emitted.
368 Route::set_order_key (uint32_t n)
370 _has_order_key = true;
372 if (_order_key == n) {
378 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 order key set to %2\n",
379 name(), order_key ()));
381 _session.set_dirty ();
385 Route::ensure_track_or_route_name(string name, Session &session)
387 string newname = name;
389 while (!session.io_name_is_legal (newname)) {
390 newname = bump_name_once (newname, ' ');
397 Route::inc_gain (gain_t factor)
399 /* To be used ONLY when doing group-relative gain adjustment, from
403 float desired_gain = _gain_control->user_double();
405 if (fabsf (desired_gain) < GAIN_COEFF_SMALL) {
406 // really?! what's the idea here?
407 _gain_control->route_set_value (0.000001f + (0.000001f * factor));
409 _gain_control->route_set_value (desired_gain + (desired_gain * factor));
414 Route::set_gain (gain_t val, Controllable::GroupControlDisposition group_override)
416 if (use_group (group_override, &RouteGroup::is_gain)) {
418 if (_route_group->is_relative()) {
420 gain_t usable_gain = _gain_control->get_value();
421 if (usable_gain < 0.000001f) {
422 usable_gain = 0.000001f;
426 if (delta < 0.000001f) {
430 delta -= usable_gain;
435 gain_t factor = delta / usable_gain;
438 factor = _route_group->get_max_factor(factor);
439 if (factor == 0.0f) {
440 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
444 factor = _route_group->get_min_factor(factor);
445 if (factor == 0.0f) {
446 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
451 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor));
455 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, Controllable::NoGroup));
461 if (val == _gain_control->get_value()) {
465 _gain_control->route_set_value (val);
469 Route::set_trim (gain_t val, Controllable::GroupControlDisposition /* group override */)
471 // TODO route group, see set_gain()
472 _trim_control->route_set_value (val);
476 Route::maybe_declick (BufferSet&, framecnt_t, int)
478 /* this is the "bus" implementation and they never declick.
483 /** Process this route for one (sub) cycle (process thread)
485 * @param bufs Scratch buffers to use for the signal path
486 * @param start_frame Initial transport frame
487 * @param end_frame Final transport frame
488 * @param nframes Number of frames to output (to ports)
490 * Note that (end_frame - start_frame) may not be equal to nframes when the
491 * transport speed isn't 1.0 (eg varispeed).
494 Route::process_output_buffers (BufferSet& bufs,
495 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
496 int declick, bool gain_automation_ok)
498 /* Caller must hold process lock */
499 assert (!AudioEngine::instance()->process_lock().trylock());
501 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
503 // can this actually happen? functions calling process_output_buffers()
504 // already take a reader-lock.
505 bufs.silence (nframes, 0);
509 /* figure out if we're going to use gain automation */
510 if (gain_automation_ok) {
511 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
512 _amp->setup_gain_automation (
513 start_frame + _signal_latency_at_amp_position,
514 end_frame + _signal_latency_at_amp_position,
517 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
518 _trim->setup_gain_automation (
519 start_frame + _signal_latency_at_trim_position,
520 end_frame + _signal_latency_at_trim_position,
523 _amp->apply_gain_automation (false);
524 _trim->apply_gain_automation (false);
527 /* Tell main outs what to do about monitoring. We do this so that
528 on a transition between monitoring states we get a de-clicking gain
529 change in the _main_outs delivery, if config.get_use_monitor_fades()
532 We override this in the case where we have an internal generator.
534 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
536 _main_outs->no_outs_cuz_we_no_monitor (silence);
538 /* -------------------------------------------------------------------------------------------
539 GLOBAL DECLICK (for transport changes etc.)
540 ----------------------------------------------------------------------------------------- */
542 maybe_declick (bufs, nframes, declick);
543 _pending_declick = 0;
545 /* -------------------------------------------------------------------------------------------
546 DENORMAL CONTROL/PHASE INVERT
547 ----------------------------------------------------------------------------------------- */
549 if (_phase_invert.any ()) {
553 if (_denormal_protection || Config->get_denormal_protection()) {
555 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
556 Sample* const sp = i->data();
558 if (_phase_invert[chn]) {
559 for (pframes_t nx = 0; nx < nframes; ++nx) {
564 for (pframes_t nx = 0; nx < nframes; ++nx) {
572 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
573 Sample* const sp = i->data();
575 if (_phase_invert[chn]) {
576 for (pframes_t nx = 0; nx < nframes; ++nx) {
585 if (_denormal_protection || Config->get_denormal_protection()) {
587 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
588 Sample* const sp = i->data();
589 for (pframes_t nx = 0; nx < nframes; ++nx) {
597 /* -------------------------------------------------------------------------------------------
599 ----------------------------------------------------------------------------------------- */
601 /* set this to be true if the meter will already have been ::run() earlier */
602 bool const meter_already_run = metering_state() == MeteringInput;
604 framecnt_t latency = 0;
606 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
608 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
609 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
614 /* if it has any inputs, make sure they match */
615 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
616 if (bufs.count() != (*i)->input_streams()) {
618 DEBUG::Processors, string_compose (
619 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
620 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
627 /* should we NOT run plugins here if the route is inactive?
628 do we catch route != active somewhere higher?
631 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
632 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
635 (*i)->run (bufs, start_frame - latency, end_frame - latency, nframes, *i != _processors.back());
636 bufs.set_count ((*i)->output_streams());
638 if ((*i)->active ()) {
639 latency += (*i)->signal_latency ();
645 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
646 boost::shared_ptr<Processor> endpoint,
647 bool include_endpoint, bool for_export, bool for_freeze)
649 /* If no processing is required, there's no need to go any further. */
650 if (!endpoint && !include_endpoint) {
654 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
655 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
656 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
658 /* trim is always at the top, for bounce no latency compensation is needed */
659 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
660 _trim->setup_gain_automation (start, start + nframes, nframes);
663 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
665 if (!include_endpoint && (*i) == endpoint) {
669 /* if we're *not* exporting, stop processing if we come across a routing processor. */
670 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
673 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
677 /* special case the panner (export outputs)
678 * Ideally we'd only run the panner, not the delivery itself...
679 * but panners need separate input/output buffers and some context
680 * (panshell, panner type, etc). AFAICT there is no ill side effect
681 * of re-using the main delivery when freewheeling/exporting a region.
683 if ((*i) == _main_outs) {
684 assert ((*i)->does_routing());
685 (*i)->run (buffers, start - latency, start - latency + nframes, nframes, true);
686 buffers.set_count ((*i)->output_streams());
689 /* don't run any processors that do routing.
690 * Also don't bother with metering.
692 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
693 (*i)->run (buffers, start - latency, start - latency + nframes, nframes, true);
694 buffers.set_count ((*i)->output_streams());
695 latency += (*i)->signal_latency ();
698 if ((*i) == endpoint) {
705 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
706 bool include_endpoint, bool for_export, bool for_freeze) const
708 framecnt_t latency = 0;
709 if (!endpoint && !include_endpoint) {
713 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
714 if (!include_endpoint && (*i) == endpoint) {
717 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
720 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
723 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
724 latency += (*i)->signal_latency ();
726 if ((*i) == endpoint) {
734 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
735 bool include_endpoint, bool for_export, bool for_freeze) const
737 if (!endpoint && !include_endpoint) {
741 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
742 if (!include_endpoint && (*i) == endpoint) {
745 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
748 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
751 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
752 cc = (*i)->output_streams();
754 if ((*i) == endpoint) {
762 Route::n_process_buffers ()
764 return max (_input->n_ports(), processor_max_streams);
768 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
770 assert (is_monitor());
771 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
772 fill_buffers_with_input (bufs, _input, nframes);
773 passthru (bufs, start_frame, end_frame, nframes, declick);
777 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
781 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
783 /* control/monitor bus ignores input ports when something is
784 feeding the listen "stream". data will "arrive" into the
785 route from the intreturn processor element.
788 bufs.silence (nframes, 0);
791 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
792 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
796 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
798 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
800 bufs.set_count (_input->n_ports());
801 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
802 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
806 Route::set_listen (bool yn, Controllable::GroupControlDisposition group_override)
812 if (use_group (group_override, &RouteGroup::is_solo)) {
813 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, Controllable::ForGroup));
818 if (yn != _monitor_send->active()) {
820 _monitor_send->activate ();
821 _mute_master->set_soloed_by_self (true);
823 _monitor_send->deactivate ();
824 _mute_master->set_soloed_by_self (false);
826 _mute_master->set_soloed_by_others (false);
828 listen_changed (group_override); /* EMIT SIGNAL */
834 Route::listening_via_monitor () const
837 return _monitor_send->active ();
844 Route::set_solo_safe (bool yn, Controllable::GroupControlDisposition /* group_override */)
846 if (_solo_safe != yn) {
848 solo_safe_changed (); /* EMIT SIGNAL */
849 _solo_safe_control->Changed(); /* EMIT SIGNAL */
854 Route::solo_safe() const
860 Route::clear_all_solo_state ()
862 // ideally this function will never do anything, it only exists to forestall Murphy
863 bool emit_changed = false;
866 // these are really debug messages, but of possible interest.
868 PBD::info << string_compose (_("Cleared Explicit solo: %1\n"), name());
870 if (_soloed_by_others_upstream || _soloed_by_others_downstream) {
871 PBD::info << string_compose (_("Cleared Implicit solo: %1 up:%2 down:%3\n"),
872 name(), _soloed_by_others_upstream, _soloed_by_others_downstream);
876 if (!_self_solo && (_soloed_by_others_upstream || _soloed_by_others_downstream)) {
877 // if self-soled, set_solo() will do signal emission
881 _soloed_by_others_upstream = 0;
882 _soloed_by_others_downstream = 0;
885 PBD::Unwinder<bool> uw (_solo_safe, false);
886 set_solo (false, Controllable::NoGroup);
890 set_mute_master_solo ();
891 solo_changed (false, Controllable::UseGroup); /* EMIT SIGNAL */
896 Route::set_solo (bool yn, Controllable::GroupControlDisposition group_override)
898 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set solo => %2, grp ? %3 currently self-soloed ? %4\n",
899 name(), yn, enum_2_string(group_override), self_soloed()));
902 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change due to solo-safe\n", name()));
906 if (is_master() || is_monitor() || is_auditioner()) {
907 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change (master, monitor or auditioner)\n", name()));
911 if (use_group (group_override, &RouteGroup::is_solo)) {
912 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, Controllable::ForGroup));
916 if (self_soloed() != yn) {
918 solo_changed (true, group_override); /* EMIT SIGNAL */
919 _solo_control->Changed (); /* EMIT SIGNAL */
922 assert (Config->get_solo_control_is_listen_control() || !_monitor_send || !_monitor_send->active());
924 /* XXX TRACKS DEVELOPERS: THIS LOGIC SUGGESTS THAT YOU ARE NOT AWARE OF
925 Config->get_solo_mute_overrride().
928 if (yn && Profile->get_trx()) {
929 set_mute (false, Controllable::UseGroup);
934 Route::set_self_solo (bool yn)
936 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set SELF solo => %2\n", name(), yn));
938 set_mute_master_solo ();
942 Route::mod_solo_by_others_upstream (int32_t delta)
944 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-upstream by %2, current up = %3 down = %4\n",
945 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
947 uint32_t old_sbu = _soloed_by_others_upstream;
950 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
951 _soloed_by_others_upstream += delta;
953 _soloed_by_others_upstream = 0;
956 _soloed_by_others_upstream += delta;
959 DEBUG_TRACE (DEBUG::Solo, string_compose (
960 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
961 name(), delta, _soloed_by_others_upstream, old_sbu,
962 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
964 /* push the inverse solo change to everything that feeds us.
966 This is important for solo-within-group. When we solo 1 track out of N that
967 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
968 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
969 tracks that feed it. This will silence them if they were audible because
970 of a bus solo, but the newly soloed track will still be audible (because
973 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
977 if ((_self_solo || _soloed_by_others_downstream) &&
978 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
979 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
981 if (delta > 0 || !Config->get_exclusive_solo()) {
982 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
983 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
987 boost::shared_ptr<Route> sr = i->r.lock();
989 sr->mod_solo_by_others_downstream (-delta);
995 set_mute_master_solo ();
996 solo_changed (false, Controllable::UseGroup); /* EMIT SIGNAL */
1000 Route::mod_solo_by_others_downstream (int32_t delta)
1002 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-downstream by %2, current up = %3 down = %4\n",
1003 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
1006 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
1007 _soloed_by_others_downstream += delta;
1009 _soloed_by_others_downstream = 0;
1012 _soloed_by_others_downstream += delta;
1015 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
1017 set_mute_master_solo ();
1018 solo_changed (false, Controllable::UseGroup); /* EMIT SIGNAL */
1022 Route::set_mute_master_solo ()
1024 _mute_master->set_soloed_by_self (self_soloed());
1025 _mute_master->set_soloed_by_others (soloed_by_others_downstream() || soloed_by_others_upstream());
1029 Route::mod_solo_isolated_by_upstream (bool yn)
1031 bool old = solo_isolated ();
1032 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod_solo_isolated_by_upstream cur: %2 d: %3\n",
1033 name(), _solo_isolated_by_upstream, yn ? "+1" : "-1"));
1036 if (_solo_isolated_by_upstream >= 1) {
1037 _solo_isolated_by_upstream--;
1039 _solo_isolated_by_upstream = 0;
1042 _solo_isolated_by_upstream++;
1045 if (solo_isolated() != old) {
1046 /* solo isolated status changed */
1047 _mute_master->set_solo_ignore (solo_isolated());
1048 solo_isolated_changed (); /* EMIT SIGNAL */
1053 Route::set_solo_isolated (bool yn, Controllable::GroupControlDisposition group_override)
1055 if (is_master() || is_monitor() || is_auditioner()) {
1059 if (use_group (group_override, &RouteGroup::is_solo)) {
1060 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, Controllable::ForGroup));
1064 bool changed = false;
1067 if (_solo_isolated == false) {
1068 _mute_master->set_solo_ignore (true);
1071 _solo_isolated = true;
1073 if (_solo_isolated == true) {
1074 _solo_isolated = false;
1075 _mute_master->set_solo_ignore (false);
1085 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
1087 boost::shared_ptr<RouteList> routes = _session.get_routes ();
1088 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
1090 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
1095 bool does_feed = feeds (*i, &sends_only);
1097 if (does_feed && !sends_only) {
1098 (*i)->mod_solo_isolated_by_upstream (yn);
1102 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
1104 solo_isolated_changed (); /* EMIT SIGNAL */
1105 _solo_isolate_control->Changed(); /* EMIT SIGNAL */
1109 Route::solo_isolated () const
1111 return (_solo_isolated == true) || (_solo_isolated_by_upstream > 0);
1115 Route::set_mute_points (MuteMaster::MutePoint mp)
1117 _mute_master->set_mute_points (mp);
1118 mute_points_changed (); /* EMIT SIGNAL */
1120 if (_mute_master->muted_by_self()) {
1121 mute_changed (); /* EMIT SIGNAL */
1122 _mute_control->Changed (); /* EMIT SIGNAL */
1127 Route::set_mute (bool yn, Controllable::GroupControlDisposition group_override)
1129 if (use_group (group_override, &RouteGroup::is_mute)) {
1130 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, Controllable::ForGroup));
1134 if (muted() != yn) {
1135 _mute_master->set_muted_by_self (yn);
1136 /* allow any derived classes to respond to the mute change
1137 before anybody else knows about it.
1140 /* tell everyone else */
1141 mute_changed (); /* EMIT SIGNAL */
1142 _mute_control->Changed (); /* EMIT SIGNAL */
1147 Route::muted () const
1149 return _mute_master->muted_by_self();
1153 Route::muted_by_others () const
1155 // This method is only used by route_ui for display state.
1156 // The real thing is MuteMaster::muted_by_others_at()
1158 //master is never muted by others
1162 //now check to see if something is soloed (and I am not)
1163 //see also MuteMaster::mute_gain_at()
1164 return (_session.soloing() && !soloed() && !solo_isolated());
1169 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
1171 cerr << name << " {" << endl;
1172 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
1173 p != procs.end(); ++p) {
1174 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
1176 cerr << "}" << endl;
1180 /** Supposing that we want to insert a Processor at a given Placement, return
1181 * the processor to add the new one before (or 0 to add at the end).
1183 boost::shared_ptr<Processor>
1184 Route::before_processor_for_placement (Placement p)
1186 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1188 ProcessorList::iterator loc;
1190 if (p == PreFader) {
1191 /* generic pre-fader: insert immediately before the amp */
1192 loc = find (_processors.begin(), _processors.end(), _amp);
1194 /* generic post-fader: insert right before the main outs */
1195 loc = find (_processors.begin(), _processors.end(), _main_outs);
1198 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
1201 /** Supposing that we want to insert a Processor at a given index, return
1202 * the processor to add the new one before (or 0 to add at the end).
1204 boost::shared_ptr<Processor>
1205 Route::before_processor_for_index (int index)
1208 return boost::shared_ptr<Processor> ();
1211 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1213 ProcessorList::iterator i = _processors.begin ();
1215 while (i != _processors.end() && j < index) {
1216 if ((*i)->display_to_user()) {
1223 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
1226 /** Add a processor either pre- or post-fader
1227 * @return 0 on success, non-0 on failure.
1230 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
1232 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
1236 /** Add a processor to a route such that it ends up with a given index into the visible processors.
1237 * @param index Index to add the processor at, or -1 to add at the end of the list.
1238 * @return 0 on success, non-0 on failure.
1241 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
1243 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
1246 /** Add a processor to the route.
1247 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
1248 * @return 0 on success, non-0 on failure.
1251 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
1253 assert (processor != _meter);
1254 assert (processor != _main_outs);
1256 DEBUG_TRACE (DEBUG::Processors, string_compose (
1257 "%1 adding processor %2\n", name(), processor->name()));
1259 if (!AudioEngine::instance()->connected() || !processor) {
1264 boost::shared_ptr<PluginInsert> pi;
1265 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1266 pi->set_strict_io (true);
1271 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1272 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1273 ProcessorState pstate (this);
1275 boost::shared_ptr<PluginInsert> pi;
1276 boost::shared_ptr<PortInsert> porti;
1278 if (processor == _amp) {
1279 /* Ensure that only one amp is in the list at any time */
1280 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), processor);
1281 if (check != _processors.end()) {
1282 if (before == _amp) {
1283 /* Already in position; all is well */
1286 _processors.erase (check);
1291 assert (find (_processors.begin(), _processors.end(), processor) == _processors.end ());
1293 ProcessorList::iterator loc;
1295 /* inserting before a processor; find it */
1296 loc = find (_processors.begin(), _processors.end(), before);
1297 if (loc == _processors.end ()) {
1302 /* inserting at end */
1303 loc = _processors.end ();
1306 _processors.insert (loc, processor);
1307 processor->set_owner (this);
1309 // Set up processor list channels. This will set processor->[input|output]_streams(),
1310 // configure redirect ports properly, etc.
1313 if (configure_processors_unlocked (err, &lm)) {
1315 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1320 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1322 if (pi->has_no_inputs ()) {
1323 /* generator plugin */
1324 _have_internal_generator = true;
1329 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
1330 processor->activate ();
1333 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1335 _output->set_user_latency (0);
1338 reset_instrument_info ();
1339 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1340 set_processor_positions ();
1342 boost::shared_ptr<Send> send;
1343 if ((send = boost::dynamic_pointer_cast<Send> (processor))) {
1344 send->SelfDestruct.connect_same_thread (*this,
1345 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
1352 Route::processor_selfdestruct (boost::weak_ptr<Processor> wp)
1354 /* We cannot destruct the processor here (usually RT-thread
1355 * with various locks held - in case of sends also io_locks).
1356 * Queue for deletion in low-priority thread.
1358 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
1359 selfdestruct_sequence.push_back (wp);
1363 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1365 XMLProperty const * prop;
1368 boost::shared_ptr<Processor> processor;
1370 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1371 so that we can add the processor in the right place (pre/post-fader)
1374 XMLNodeList const & children = node.children ();
1375 XMLNodeList::const_iterator i = children.begin ();
1377 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1381 Placement placement = PreFader;
1383 if (i != children.end()) {
1384 if ((prop = (*i)->property (X_("placement"))) != 0) {
1385 placement = Placement (string_2_enum (prop->value(), placement));
1389 if (node.name() == "Insert") {
1391 if ((prop = node.property ("type")) != 0) {
1393 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1394 prop->value() == "lv2" ||
1395 prop->value() == "windows-vst" ||
1396 prop->value() == "lxvst" ||
1397 prop->value() == "audiounit") {
1399 if (_session.get_disable_all_loaded_plugins ()) {
1400 processor.reset (new UnknownProcessor (_session, node));
1402 processor.reset (new PluginInsert (_session));
1403 processor->set_owner (this);
1408 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1413 } else if (node.name() == "Send") {
1415 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
1416 processor.reset (new Send (_session, sendpan, _mute_master));
1420 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1424 if (processor->set_state (node, version)) {
1428 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
1429 if (i != children.end()) {
1430 if ((prop = (*i)->property (X_("active"))) != 0) {
1431 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
1432 processor->activate();
1434 processor->deactivate();
1438 return (add_processor (processor, placement, 0, false) == 0);
1441 catch (failed_constructor &err) {
1442 warning << _("processor could not be created. Ignored.") << endmsg;
1448 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1450 /* NOTE: this is intended to be used ONLY when copying
1451 processors from another Route. Hence the subtle
1452 differences between this and ::add_processor()
1455 ProcessorList::iterator loc;
1458 loc = find(_processors.begin(), _processors.end(), before);
1460 /* nothing specified - at end */
1461 loc = _processors.end ();
1464 if (!_session.engine().connected()) {
1468 if (others.empty()) {
1473 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1474 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1475 ProcessorState pstate (this);
1477 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1483 boost::shared_ptr<PluginInsert> pi;
1485 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1486 pi->set_strict_io (_strict_io);
1489 _processors.insert (loc, *i);
1490 (*i)->set_owner (this);
1492 if ((*i)->active()) {
1496 /* Think: does this really need to be called for every processor in the loop? */
1498 if (configure_processors_unlocked (err, &lm)) {
1500 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
1505 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1508 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1509 boost::shared_ptr<PluginInsert> pi;
1511 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1512 if (pi->has_no_inputs ()) {
1513 _have_internal_generator = true;
1519 _output->set_user_latency (0);
1522 reset_instrument_info ();
1523 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1524 set_processor_positions ();
1530 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1532 if (p == PreFader) {
1533 start = _processors.begin();
1534 end = find(_processors.begin(), _processors.end(), _amp);
1536 start = find(_processors.begin(), _processors.end(), _amp);
1538 end = _processors.end();
1542 /** Turn off all processors with a given placement
1543 * @param p Placement of processors to disable
1546 Route::disable_processors (Placement p)
1548 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1550 ProcessorList::iterator start, end;
1551 placement_range(p, start, end);
1553 for (ProcessorList::iterator i = start; i != end; ++i) {
1554 (*i)->deactivate ();
1557 _session.set_dirty ();
1560 /** Turn off all redirects
1563 Route::disable_processors ()
1565 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1567 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1568 (*i)->deactivate ();
1571 _session.set_dirty ();
1574 /** Turn off all redirects with a given placement
1575 * @param p Placement of redirects to disable
1578 Route::disable_plugins (Placement p)
1580 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1582 ProcessorList::iterator start, end;
1583 placement_range(p, start, end);
1585 for (ProcessorList::iterator i = start; i != end; ++i) {
1586 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1587 (*i)->deactivate ();
1591 _session.set_dirty ();
1594 /** Turn off all plugins
1597 Route::disable_plugins ()
1599 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1601 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1602 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1603 (*i)->deactivate ();
1607 _session.set_dirty ();
1612 Route::ab_plugins (bool forward)
1614 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1618 /* forward = turn off all active redirects, and mark them so that the next time
1619 we go the other way, we will revert them
1622 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1623 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1627 if ((*i)->active()) {
1628 (*i)->deactivate ();
1629 (*i)->set_next_ab_is_active (true);
1631 (*i)->set_next_ab_is_active (false);
1637 /* backward = if the redirect was marked to go active on the next ab, do so */
1639 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1641 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1645 if ((*i)->get_next_ab_is_active()) {
1648 (*i)->deactivate ();
1653 _session.set_dirty ();
1657 /** Remove processors with a given placement.
1658 * @param p Placement of processors to remove.
1661 Route::clear_processors (Placement p)
1663 if (!_session.engine().connected()) {
1667 bool already_deleting = _session.deletion_in_progress();
1668 if (!already_deleting) {
1669 _session.set_deletion_in_progress();
1673 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1674 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1675 ProcessorList new_list;
1676 ProcessorStreams err;
1677 bool seen_amp = false;
1679 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1685 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1687 /* you can't remove these */
1689 new_list.push_back (*i);
1696 new_list.push_back (*i);
1699 (*i)->drop_references ();
1707 (*i)->drop_references ();
1710 new_list.push_back (*i);
1717 _processors = new_list;
1718 configure_processors_unlocked (&err, &lm); // this can't fail
1721 processor_max_streams.reset();
1722 _have_internal_generator = false;
1723 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1724 set_processor_positions ();
1726 reset_instrument_info ();
1728 if (!already_deleting) {
1729 _session.clear_deletion_in_progress();
1734 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1736 // TODO once the export point can be configured properly, do something smarter here
1737 if (processor == _capturing_processor) {
1738 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1739 if (need_process_lock) {
1743 _capturing_processor.reset();
1745 if (need_process_lock) {
1750 /* these can never be removed */
1752 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1756 if (!_session.engine().connected()) {
1760 processor_max_streams.reset();
1763 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1764 if (need_process_lock) {
1768 /* Caller must hold process lock */
1769 assert (!AudioEngine::instance()->process_lock().trylock());
1771 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1773 ProcessorState pstate (this);
1775 ProcessorList::iterator i;
1776 bool removed = false;
1778 for (i = _processors.begin(); i != _processors.end(); ) {
1779 if (*i == processor) {
1781 /* move along, see failure case for configure_processors()
1782 where we may need to reconfigure the processor.
1785 /* stop redirects that send signals to JACK ports
1786 from causing noise as a result of no longer being
1790 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
1791 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
1795 iop = pi->sidechain();
1802 i = _processors.erase (i);
1810 _output->set_user_latency (0);
1818 if (configure_processors_unlocked (err, &lm)) {
1820 /* we know this will work, because it worked before :) */
1821 configure_processors_unlocked (0, &lm);
1825 _have_internal_generator = false;
1827 for (i = _processors.begin(); i != _processors.end(); ++i) {
1828 boost::shared_ptr<PluginInsert> pi;
1830 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1831 if (pi->has_no_inputs ()) {
1832 _have_internal_generator = true;
1837 if (need_process_lock) {
1842 reset_instrument_info ();
1843 processor->drop_references ();
1844 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1845 set_processor_positions ();
1851 Route::replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err)
1853 /* these can never be removed */
1854 if (old == _amp || old == _meter || old == _main_outs || old == _delayline || old == _trim) {
1857 /* and can't be used as substitute, either */
1858 if (sub == _amp || sub == _meter || sub == _main_outs || sub == _delayline || sub == _trim) {
1862 /* I/Os are out, too */
1863 if (boost::dynamic_pointer_cast<IOProcessor> (old) || boost::dynamic_pointer_cast<IOProcessor> (sub)) {
1867 /* this function cannot be used to swap/reorder processors */
1868 if (find (_processors.begin(), _processors.end(), sub) != _processors.end ()) {
1872 if (!AudioEngine::instance()->connected() || !old || !sub) {
1876 /* ensure that sub is not owned by another route */
1877 if (sub->owner ()) {
1882 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1883 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1884 ProcessorState pstate (this);
1886 assert (find (_processors.begin(), _processors.end(), sub) == _processors.end ());
1888 ProcessorList::iterator i;
1889 bool replaced = false;
1890 bool enable = old->active ();
1892 for (i = _processors.begin(); i != _processors.end(); ) {
1894 i = _processors.erase (i);
1895 _processors.insert (i, sub);
1896 sub->set_owner (this);
1909 boost::shared_ptr<PluginInsert> pi;
1910 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(sub)) != 0) {
1911 pi->set_strict_io (true);
1915 if (configure_processors_unlocked (err, &lm)) {
1917 configure_processors_unlocked (0, &lm);
1921 _have_internal_generator = false;
1923 for (i = _processors.begin(); i != _processors.end(); ++i) {
1924 boost::shared_ptr<PluginInsert> pi;
1925 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1926 if (pi->has_no_inputs ()) {
1927 _have_internal_generator = true;
1937 sub->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1938 _output->set_user_latency (0);
1941 reset_instrument_info ();
1942 old->drop_references ();
1943 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1944 set_processor_positions ();
1949 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1951 ProcessorList deleted;
1953 if (!_session.engine().connected()) {
1957 processor_max_streams.reset();
1960 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1961 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1962 ProcessorState pstate (this);
1964 ProcessorList::iterator i;
1965 boost::shared_ptr<Processor> processor;
1967 for (i = _processors.begin(); i != _processors.end(); ) {
1971 /* these can never be removed */
1973 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1978 /* see if its in the list of processors to delete */
1980 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1985 /* stop IOProcessors that send to JACK ports
1986 from causing noise as a result of no longer being
1990 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(processor);
1991 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
1994 iop = pi->sidechain();
2001 deleted.push_back (processor);
2002 i = _processors.erase (i);
2005 if (deleted.empty()) {
2006 /* none of those in the requested list were found */
2010 _output->set_user_latency (0);
2012 if (configure_processors_unlocked (err, &lm)) {
2014 /* we know this will work, because it worked before :) */
2015 configure_processors_unlocked (0, &lm);
2020 _have_internal_generator = false;
2022 for (i = _processors.begin(); i != _processors.end(); ++i) {
2023 boost::shared_ptr<PluginInsert> pi;
2025 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2026 if (pi->has_no_inputs ()) {
2027 _have_internal_generator = true;
2034 /* now try to do what we need to so that those that were removed will be deleted */
2036 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
2037 (*i)->drop_references ();
2040 reset_instrument_info ();
2041 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2042 set_processor_positions ();
2048 Route::reset_instrument_info ()
2050 boost::shared_ptr<Processor> instr = the_instrument();
2052 _instrument_info.set_internal_instrument (instr);
2056 /** Caller must hold process lock */
2058 Route::configure_processors (ProcessorStreams* err)
2060 #ifndef PLATFORM_WINDOWS
2061 assert (!AudioEngine::instance()->process_lock().trylock());
2064 if (!_in_configure_processors) {
2065 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2066 return configure_processors_unlocked (err, &lm);
2073 Route::input_streams () const
2075 return _input->n_ports ();
2078 list<pair<ChanCount, ChanCount> >
2079 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
2081 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2083 return try_configure_processors_unlocked (in, err);
2086 list<pair<ChanCount, ChanCount> >
2087 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
2089 // Check each processor in order to see if we can configure as requested
2091 list<pair<ChanCount, ChanCount> > configuration;
2094 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
2095 DEBUG_TRACE (DEBUG::Processors, "{\n");
2097 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
2099 if ((*p)->can_support_io_configuration(in, out)) {
2101 if (boost::dynamic_pointer_cast<Delivery> (*p)
2102 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main
2103 && !(is_monitor() || is_auditioner())
2104 && ( _strict_io || Profile->get_mixbus ())) {
2105 /* with strict I/O the panner + output are forced to
2106 * follow the last processor's output.
2108 * Delivery::can_support_io_configuration() will only add ports,
2109 * but not remove excess ports.
2111 * This works because the delivery only requires
2112 * as many outputs as there are inputs.
2113 * Delivery::configure_io() will do the actual removal
2114 * by calling _output->ensure_io()
2116 if (!is_master() && _session.master_out ()) {
2117 /* ..but at least as many as there are master-inputs */
2118 // XXX this may need special-casing for mixbus (master-outputs)
2119 // and should maybe be a preference anyway ?!
2120 out = ChanCount::max (in, _session.master_out ()->n_inputs ());
2126 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
2127 configuration.push_back(make_pair(in, out));
2130 // restriction for Monitor Section Processors
2131 if (in.n_audio() != out.n_audio() || out.n_midi() > 0) {
2132 /* do not allow to add/remove channels (for now)
2133 * The Monitor follows the master-bus and has no panner (unpan)
2134 * but do allow processors with midi-in to be added (e.g VSTs with control that
2135 * will remain unconnected)
2137 DEBUG_TRACE (DEBUG::Processors, "Monitor: Channel configuration not allowed.\n");
2138 return list<pair<ChanCount, ChanCount> > ();
2140 if (boost::dynamic_pointer_cast<InternalSend> (*p)) {
2141 // internal sends make no sense, only feedback
2142 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
2143 return list<pair<ChanCount, ChanCount> > ();
2145 if (boost::dynamic_pointer_cast<PortInsert> (*p)) {
2146 /* External Sends can be problematic. one can add/remove ports
2147 * there signal leaves the DAW to external monitors anyway, so there's
2148 * no real use for allowing them here anyway.
2150 DEBUG_TRACE (DEBUG::Processors, "Monitor: No External Sends allowed.\n");
2151 return list<pair<ChanCount, ChanCount> > ();
2153 if (boost::dynamic_pointer_cast<Send> (*p)) {
2155 DEBUG_TRACE (DEBUG::Processors, "Monitor: No Sends allowed.\n");
2156 return list<pair<ChanCount, ChanCount> > ();
2165 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
2166 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
2167 DEBUG_TRACE (DEBUG::Processors, "}\n");
2168 return list<pair<ChanCount, ChanCount> > ();
2172 DEBUG_TRACE (DEBUG::Processors, "}\n");
2174 return configuration;
2177 /** Set the input/output configuration of each processor in the processors list.
2178 * Caller must hold process lock.
2179 * Return 0 on success, otherwise configuration is impossible.
2182 Route::configure_processors_unlocked (ProcessorStreams* err, Glib::Threads::RWLock::WriterLock* lm)
2184 #ifndef PLATFORM_WINDOWS
2185 assert (!AudioEngine::instance()->process_lock().trylock());
2188 if (_in_configure_processors) {
2192 /* put invisible processors where they should be */
2193 setup_invisible_processors ();
2195 _in_configure_processors = true;
2197 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
2199 if (configuration.empty ()) {
2200 _in_configure_processors = false;
2205 bool seen_mains_out = false;
2206 processor_out_streams = _input->n_ports();
2207 processor_max_streams.reset();
2209 /* processor configure_io() may result in adding ports
2210 * e.g. Delivery::configure_io -> ARDOUR::IO::ensure_io ()
2212 * with jack2 adding ports results in a graph-order callback,
2213 * which calls Session::resort_routes() and eventually
2214 * Route::direct_feeds_according_to_reality()
2215 * which takes a ReaderLock (_processor_lock).
2217 * so we can't hold a WriterLock here until jack2 threading
2220 * NB. we still hold the process lock
2222 * (ardour's own engines do call graph-order from the
2223 * process-thread and hence do not have this issue; besides
2224 * merely adding ports won't trigger a graph-order, only
2225 * making connections does)
2229 // TODO check for a potential ReaderLock after ReaderLock ??
2230 Glib::Threads::RWLock::ReaderLock lr (_processor_lock);
2232 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
2233 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
2235 if (!(*p)->configure_io(c->first, c->second)) {
2236 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
2237 _in_configure_processors = false;
2242 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
2243 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
2245 boost::shared_ptr<IOProcessor> iop;
2246 boost::shared_ptr<PluginInsert> pi;
2247 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2248 /* plugins connected via Split or Hide Match may have more channels.
2249 * route/scratch buffers are needed for all of them
2250 * The configuration may only be a subset (both input and output)
2252 processor_max_streams = ChanCount::max(processor_max_streams, pi->required_buffers());
2254 else if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*p)) != 0) {
2255 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_input_streams());
2256 processor_max_streams = ChanCount::max(processor_max_streams, iop->natural_output_streams());
2260 if (boost::dynamic_pointer_cast<Delivery> (*p)
2261 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
2262 /* main delivery will increase port count to match input.
2263 * the Delivery::Main is usually the last processor - followed only by
2266 seen_mains_out = true;
2268 if (!seen_mains_out) {
2269 processor_out_streams = out;
2278 _meter->set_max_channels (processor_max_streams);
2281 /* make sure we have sufficient scratch buffers to cope with the new processor
2284 _session.ensure_buffers (n_process_buffers ());
2286 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
2288 _in_configure_processors = false;
2292 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
2293 * @param state New active state for those processors.
2296 Route::all_visible_processors_active (bool state)
2298 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2300 if (_processors.empty()) {
2304 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2305 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
2312 (*i)->deactivate ();
2316 _session.set_dirty ();
2320 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
2322 /* check if re-order requires re-configuration of any processors
2323 * -> compare channel configuration for all processors
2325 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2326 ChanCount c = input_streams ();
2328 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
2330 if (c != (*j)->input_streams()) {
2333 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2336 if ((*i)->input_streams() != c) {
2339 c = (*i)->output_streams();
2351 __attribute__((annotate("realtime")))
2354 Route::apply_processor_order (const ProcessorList& new_order)
2356 /* need to hold processor_lock; either read or write lock
2357 * and the engine process_lock.
2358 * Due to r/w lock ambiguity we can only assert the latter
2360 assert (!AudioEngine::instance()->process_lock().trylock());
2363 /* "new_order" is an ordered list of processors to be positioned according to "placement".
2364 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
2365 * processors in the current actual processor list that are hidden. Any visible processors
2366 * in the current list but not in "new_order" will be assumed to be deleted.
2369 /* "as_it_will_be" and "_processors" are lists of shared pointers.
2370 * actual memory usage is small, but insert/erase is not actually rt-safe :(
2371 * (note though that ::processors_reorder_needs_configure() ensured that
2372 * this function will only ever be called from the rt-thread if no processor were removed)
2374 * either way, I can't proove it, but an x-run due to re-order here is less likley
2375 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
2378 ProcessorList as_it_will_be;
2379 ProcessorList::iterator oiter;
2380 ProcessorList::const_iterator niter;
2382 oiter = _processors.begin();
2383 niter = new_order.begin();
2385 while (niter != new_order.end()) {
2387 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
2388 then append it to the temp list.
2390 Otherwise, see if the next processor in the old list is in the new list. if not,
2391 its been deleted. If its there, append it to the temp list.
2394 if (oiter == _processors.end()) {
2396 /* no more elements in the old list, so just stick the rest of
2397 the new order onto the temp list.
2400 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
2401 while (niter != new_order.end()) {
2408 if (!(*oiter)->display_to_user()) {
2410 as_it_will_be.push_back (*oiter);
2414 /* visible processor: check that its in the new order */
2416 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
2417 /* deleted: do nothing, shared_ptr<> will clean up */
2419 /* ignore this one, and add the next item from the new order instead */
2420 as_it_will_be.push_back (*niter);
2425 /* now remove from old order - its taken care of no matter what */
2426 oiter = _processors.erase (oiter);
2430 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
2432 /* If the meter is in a custom position, find it and make a rough note of its position */
2433 maybe_note_meter_position ();
2437 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
2439 // it a change is already queued, wait for it
2440 // (unless engine is stopped. apply immediately and proceed
2441 while (g_atomic_int_get (&_pending_process_reorder)) {
2442 if (!AudioEngine::instance()->running()) {
2443 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
2444 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2446 apply_processor_order(_pending_processor_order);
2447 setup_invisible_processors ();
2449 g_atomic_int_set (&_pending_process_reorder, 0);
2451 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2452 set_processor_positions ();
2454 // TODO rather use a semaphore or something.
2455 // but since ::reorder_processors() is called
2456 // from the GUI thread, this is fine..
2461 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
2463 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2464 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2465 ProcessorState pstate (this);
2467 apply_processor_order (new_order);
2469 if (configure_processors_unlocked (err, &lm)) {
2477 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2478 set_processor_positions ();
2481 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2482 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2484 // _pending_processor_order is protected by _processor_lock
2485 _pending_processor_order = new_order;
2486 g_atomic_int_set (&_pending_process_reorder, 1);
2493 Route::add_remove_sidechain (boost::shared_ptr<Processor> proc, bool add)
2495 boost::shared_ptr<PluginInsert> pi;
2496 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2500 if (pi->has_sidechain () == add) {
2501 return true; // ?? call failed, but result is as expected.
2505 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2506 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2507 if (i == _processors.end ()) {
2513 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ()); // take before Writerlock to avoid deadlock
2514 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2515 PBD::Unwinder<bool> uw (_in_sidechain_setup, true);
2517 lx.release (); // IO::add_port() and ~IO takes process lock - XXX check if this is safe
2519 if (!pi->add_sidechain ()) {
2523 if (!pi->del_sidechain ()) {
2529 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2534 pi->del_sidechain ();
2536 pi->add_sidechain ();
2537 // TODO restore side-chain's state.
2542 configure_processors_unlocked (0, &lm);
2545 if (pi->has_sidechain ()) {
2546 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
2549 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2550 _session.set_dirty ();
2555 Route::plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs)
2557 boost::shared_ptr<PluginInsert> pi;
2558 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2563 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2564 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2565 if (i == _processors.end ()) {
2571 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2572 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2574 const ChanCount& old (pi->preset_out ());
2575 if (!pi->set_preset_out (outs)) {
2576 return true; // no change, OK
2579 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2582 pi->set_preset_out (old);
2585 configure_processors_unlocked (0, &lm);
2588 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2589 _session.set_dirty ();
2594 Route::reset_plugin_insert (boost::shared_ptr<Processor> proc)
2597 return customize_plugin_insert (proc, 0, unused, unused);
2601 Route::customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks)
2603 boost::shared_ptr<PluginInsert> pi;
2604 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(proc)) == 0) {
2609 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2610 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), proc);
2611 if (i == _processors.end ()) {
2617 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2618 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2620 bool old_cust = pi->custom_cfg ();
2621 uint32_t old_cnt = pi->get_count ();
2622 ChanCount old_chan = pi->output_streams ();
2623 ChanCount old_sinks = pi->natural_input_streams ();
2626 pi->set_custom_cfg (false);
2628 pi->set_custom_cfg (true);
2629 pi->set_count (count);
2630 pi->set_outputs (outs);
2631 pi->set_sinks (sinks);
2634 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2638 pi->set_count (old_cnt);
2639 pi->set_sinks (old_sinks);
2640 pi->set_outputs (old_chan);
2641 pi->set_custom_cfg (old_cust);
2645 configure_processors_unlocked (0, &lm);
2648 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2649 _session.set_dirty ();
2654 Route::set_strict_io (const bool enable)
2656 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2658 if (_strict_io != enable) {
2659 _strict_io = enable;
2660 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2661 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2662 boost::shared_ptr<PluginInsert> pi;
2663 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2664 pi->set_strict_io (_strict_io);
2668 list<pair<ChanCount, ChanCount> > c = try_configure_processors_unlocked (n_inputs (), 0);
2672 _strict_io = !enable; // restore old value
2673 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
2674 boost::shared_ptr<PluginInsert> pi;
2675 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2676 pi->set_strict_io (_strict_io);
2683 configure_processors (0);
2686 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2687 _session.set_dirty ();
2699 Route::get_template()
2701 return state(false);
2705 Route::state(bool full_state)
2707 if (!_session._template_state_dir.empty()) {
2708 assert (!full_state); // only for templates
2709 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), _session._template_state_dir));
2712 XMLNode *node = new XMLNode("Route");
2713 ProcessorList::iterator i;
2716 id().print (buf, sizeof (buf));
2717 node->add_property("id", buf);
2718 node->add_property ("name", _name);
2719 node->add_property("default-type", _default_type.to_string());
2720 node->add_property ("strict-io", _strict_io);
2723 node->add_property("flags", enum_2_string (_flags));
2726 node->add_property("active", _active?"yes":"no");
2728 boost::to_string (_phase_invert, p);
2729 node->add_property("phase-invert", p);
2730 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2731 node->add_property("meter-point", enum_2_string (_meter_point));
2733 node->add_property("meter-type", enum_2_string (_meter_type));
2736 node->add_property("route-group", _route_group->name());
2739 snprintf (buf, sizeof (buf), "%d", _order_key);
2740 node->add_property ("order-key", buf);
2741 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
2742 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
2743 node->add_property ("soloed-by-upstream", buf);
2744 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
2745 node->add_property ("soloed-by-downstream", buf);
2746 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
2747 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
2749 node->add_child_nocopy (_input->state (full_state));
2750 node->add_child_nocopy (_output->state (full_state));
2751 node->add_child_nocopy (_solo_control->get_state ());
2752 node->add_child_nocopy (_mute_control->get_state ());
2753 node->add_child_nocopy (_mute_master->get_state ());
2756 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2759 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
2760 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
2761 remote_control_node->add_property (X_("id"), buf);
2762 node->add_child_nocopy (*remote_control_node);
2764 if (_comment.length()) {
2765 XMLNode *cmt = node->add_child ("Comment");
2766 cmt->add_content (_comment);
2770 node->add_child_nocopy (_pannable->state (full_state));
2773 for (i = _processors.begin(); i != _processors.end(); ++i) {
2775 /* template save: do not include internal sends functioning as
2776 aux sends because the chance of the target ID
2777 in the session where this template is used
2780 similarly, do not save listen sends which connect to
2781 the monitor section, because these will always be
2784 boost::shared_ptr<InternalSend> is;
2786 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2787 if (is->role() == Delivery::Listen) {
2792 node->add_child_nocopy((*i)->state (full_state));
2796 node->add_child_copy (*_extra_xml);
2799 if (_custom_meter_position_noted) {
2800 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2802 after->id().print (buf, sizeof (buf));
2803 node->add_property (X_("processor-after-last-custom-meter"), buf);
2807 if (!_session._template_state_dir.empty()) {
2808 foreach_processor (sigc::bind (sigc::mem_fun (*this, &Route::set_plugin_state_dir), ""));
2815 Route::set_state (const XMLNode& node, int version)
2817 if (version < 3000) {
2818 return set_state_2X (node, version);
2822 XMLNodeConstIterator niter;
2824 XMLProperty const * prop;
2826 if (node.name() != "Route"){
2827 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2831 if ((prop = node.property (X_("name"))) != 0) {
2832 Route::set_name (prop->value());
2836 _initial_io_setup = true;
2838 if ((prop = node.property (X_("flags"))) != 0) {
2839 _flags = Flag (string_2_enum (prop->value(), _flags));
2844 if ((prop = node.property (X_("strict-io"))) != 0) {
2845 _strict_io = string_is_affirmative (prop->value());
2848 if (is_master() || is_monitor() || is_auditioner()) {
2849 _mute_master->set_solo_ignore (true);
2853 /* monitor bus does not get a panner, but if (re)created
2854 via XML, it will already have one by the time we
2855 call ::set_state(). so ... remove it.
2860 /* add all processors (except amp, which is always present) */
2862 nlist = node.children();
2863 XMLNode processor_state (X_("processor_state"));
2865 Stateful::save_extra_xml (node);
2867 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2871 if (child->name() == IO::state_node_name) {
2872 if ((prop = child->property (X_("direction"))) == 0) {
2876 if (prop->value() == "Input") {
2877 _input->set_state (*child, version);
2878 } else if (prop->value() == "Output") {
2879 _output->set_state (*child, version);
2883 if (child->name() == X_("Processor")) {
2884 processor_state.add_child_copy (*child);
2887 if (child->name() == X_("Pannable")) {
2889 _pannable->set_state (*child, version);
2891 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2896 if ((prop = node.property (X_("meter-point"))) != 0) {
2897 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2898 set_meter_point (mp, true);
2900 _meter->set_display_to_user (_meter_point == MeterCustom);
2904 if ((prop = node.property (X_("meter-type"))) != 0) {
2905 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2908 _initial_io_setup = false;
2910 set_processor_state (processor_state);
2912 // this looks up the internal instrument in processors
2913 reset_instrument_info();
2915 if ((prop = node.property ("self-solo")) != 0) {
2916 set_self_solo (string_is_affirmative (prop->value()));
2919 if ((prop = node.property ("soloed-by-upstream")) != 0) {
2920 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
2921 mod_solo_by_others_upstream (atoi (prop->value()));
2924 if ((prop = node.property ("soloed-by-downstream")) != 0) {
2925 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
2926 mod_solo_by_others_downstream (atoi (prop->value()));
2929 if ((prop = node.property ("solo-isolated")) != 0) {
2930 set_solo_isolated (string_is_affirmative (prop->value()), Controllable::NoGroup);
2933 if ((prop = node.property ("solo-safe")) != 0) {
2934 set_solo_safe (string_is_affirmative (prop->value()), Controllable::NoGroup);
2937 if ((prop = node.property (X_("phase-invert"))) != 0) {
2938 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2941 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2942 set_denormal_protection (string_is_affirmative (prop->value()));
2945 if ((prop = node.property (X_("active"))) != 0) {
2946 bool yn = string_is_affirmative (prop->value());
2947 set_active (yn, this);
2950 if ((prop = node.property (X_("order-key"))) != 0) { // New order key (no separate mixer/editor ordering)
2951 set_order_key (atoi(prop->value()));
2954 if ((prop = node.property (X_("order-keys"))) != 0) { // Deprecated order keys
2958 string::size_type colon, equal;
2959 string remaining = prop->value();
2961 while (remaining.length()) {
2963 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2964 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2967 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2968 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2971 string keyname = remaining.substr (0, equal);
2973 if ((keyname == "EditorSort") || (keyname == "editor")) {
2974 cerr << "Setting " << name() << " order key to " << n << " using saved Editor order." << endl;
2980 colon = remaining.find_first_of (':');
2982 if (colon != string::npos) {
2983 remaining = remaining.substr (colon+1);
2990 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2991 PBD::ID id (prop->value ());
2992 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2993 ProcessorList::const_iterator i = _processors.begin ();
2994 while (i != _processors.end() && (*i)->id() != id) {
2998 if (i != _processors.end ()) {
2999 _processor_after_last_custom_meter = *i;
3000 _custom_meter_position_noted = true;
3004 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
3007 if (child->name() == X_("Comment")) {
3009 /* XXX this is a terrible API design in libxml++ */
3011 XMLNode *cmt = *(child->children().begin());
3012 _comment = cmt->content();
3014 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
3015 if (prop->value() == "solo") {
3016 _solo_control->set_state (*child, version);
3017 } else if (prop->value() == "mute") {
3018 _mute_control->set_state (*child, version);
3021 } else if (child->name() == X_("RemoteControl")) {
3022 if ((prop = child->property (X_("id"))) != 0) {
3024 sscanf (prop->value().c_str(), "%d", &x);
3025 set_remote_control_id_internal (x);
3028 } else if (child->name() == X_("MuteMaster")) {
3029 _mute_master->set_state (*child, version);
3031 } else if (child->name() == Automatable::xml_node_name) {
3032 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
3040 Route::set_state_2X (const XMLNode& node, int version)
3044 XMLNodeConstIterator niter;
3046 XMLProperty const * prop;
3048 /* 2X things which still remain to be handled:
3054 if (node.name() != "Route") {
3055 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
3059 if ((prop = node.property (X_("flags"))) != 0) {
3060 string f = prop->value ();
3061 boost::replace_all (f, "ControlOut", "MonitorOut");
3062 _flags = Flag (string_2_enum (f, _flags));
3067 if (is_master() || is_monitor() || is_auditioner()) {
3068 _mute_master->set_solo_ignore (true);
3071 if ((prop = node.property (X_("phase-invert"))) != 0) {
3072 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
3073 if (string_is_affirmative (prop->value ())) {
3076 set_phase_invert (p);
3079 if ((prop = node.property (X_("denormal-protection"))) != 0) {
3080 set_denormal_protection (string_is_affirmative (prop->value()));
3083 if ((prop = node.property (X_("soloed"))) != 0) {
3084 bool yn = string_is_affirmative (prop->value());
3086 /* XXX force reset of solo status */
3091 if ((prop = node.property (X_("muted"))) != 0) {
3094 bool muted = string_is_affirmative (prop->value());
3100 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
3102 if (string_is_affirmative (prop->value())){
3103 mute_point = mute_point + "PreFader";
3108 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
3110 if (string_is_affirmative (prop->value())){
3113 mute_point = mute_point + ",";
3116 mute_point = mute_point + "PostFader";
3121 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
3123 if (string_is_affirmative (prop->value())){
3126 mute_point = mute_point + ",";
3129 mute_point = mute_point + "Listen";
3134 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
3136 if (string_is_affirmative (prop->value())){
3139 mute_point = mute_point + ",";
3142 mute_point = mute_point + "Main";
3146 _mute_master->set_mute_points (mute_point);
3147 _mute_master->set_muted_by_self (true);
3151 if ((prop = node.property (X_("meter-point"))) != 0) {
3152 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
3155 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
3156 don't mean the same thing.
3159 if ((prop = node.property (X_("order-keys"))) != 0) {
3163 string::size_type colon, equal;
3164 string remaining = prop->value();
3166 while (remaining.length()) {
3168 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
3169 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
3172 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
3173 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
3176 string keyname = remaining.substr (0, equal);
3178 if (keyname == "EditorSort" || keyname == "editor") {
3179 info << string_compose(_("Converting deprecated order key for %1 using Editor order %2"), name (), n) << endmsg;
3185 colon = remaining.find_first_of (':');
3187 if (colon != string::npos) {
3188 remaining = remaining.substr (colon+1);
3197 nlist = node.children ();
3198 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3202 if (child->name() == IO::state_node_name) {
3204 /* there is a note in IO::set_state_2X() about why we have to call
3208 _input->set_state_2X (*child, version, true);
3209 _output->set_state_2X (*child, version, false);
3211 if ((prop = child->property (X_("name"))) != 0) {
3212 Route::set_name (prop->value ());
3217 if ((prop = child->property (X_("active"))) != 0) {
3218 bool yn = string_is_affirmative (prop->value());
3219 _active = !yn; // force switch
3220 set_active (yn, this);
3223 if ((prop = child->property (X_("gain"))) != 0) {
3226 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
3227 _amp->gain_control()->set_value (val, Controllable::NoGroup);
3231 /* Set up Panners in the IO */
3232 XMLNodeList io_nlist = child->children ();
3234 XMLNodeConstIterator io_niter;
3237 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
3239 io_child = *io_niter;
3241 if (io_child->name() == X_("Panner")) {
3242 _main_outs->panner_shell()->set_state(*io_child, version);
3243 } else if (io_child->name() == X_("Automation")) {
3244 /* IO's automation is for the fader */
3245 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
3251 XMLNodeList redirect_nodes;
3253 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
3257 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
3258 redirect_nodes.push_back(child);
3263 set_processor_state_2X (redirect_nodes, version);
3265 Stateful::save_extra_xml (node);
3267 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
3270 if (child->name() == X_("Comment")) {
3272 /* XXX this is a terrible API design in libxml++ */
3274 XMLNode *cmt = *(child->children().begin());
3275 _comment = cmt->content();
3277 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
3278 if (prop->value() == X_("solo")) {
3279 _solo_control->set_state (*child, version);
3280 } else if (prop->value() == X_("mute")) {
3281 _mute_control->set_state (*child, version);
3284 } else if (child->name() == X_("RemoteControl")) {
3285 if ((prop = child->property (X_("id"))) != 0) {
3287 sscanf (prop->value().c_str(), "%d", &x);
3288 set_remote_control_id_internal (x);
3298 Route::get_processor_state ()
3300 XMLNode* root = new XMLNode (X_("redirects"));
3301 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3302 root->add_child_nocopy ((*i)->state (true));
3309 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
3311 /* We don't bother removing existing processors not in nList, as this
3312 method will only be called when creating a Route from scratch, not
3313 for undo purposes. Just put processors in at the appropriate place
3317 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
3318 add_processor_from_xml_2X (**i, version);
3323 Route::set_processor_state (const XMLNode& node)
3325 const XMLNodeList &nlist = node.children();
3326 XMLNodeConstIterator niter;
3327 ProcessorList new_order;
3328 bool must_configure = false;
3330 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3332 XMLProperty const * prop = (*niter)->property ("type");
3334 if (prop->value() == "amp") {
3335 _amp->set_state (**niter, Stateful::current_state_version);
3336 new_order.push_back (_amp);
3337 } else if (prop->value() == "trim") {
3338 _trim->set_state (**niter, Stateful::current_state_version);
3339 new_order.push_back (_trim);
3340 } else if (prop->value() == "meter") {
3341 _meter->set_state (**niter, Stateful::current_state_version);
3342 new_order.push_back (_meter);
3343 } else if (prop->value() == "delay") {
3345 _delayline->set_state (**niter, Stateful::current_state_version);
3346 new_order.push_back (_delayline);
3348 } else if (prop->value() == "main-outs") {
3349 _main_outs->set_state (**niter, Stateful::current_state_version);
3350 } else if (prop->value() == "intreturn") {
3352 _intreturn.reset (new InternalReturn (_session));
3353 must_configure = true;
3355 _intreturn->set_state (**niter, Stateful::current_state_version);
3356 } else if (is_monitor() && prop->value() == "monitor") {
3357 if (!_monitor_control) {
3358 _monitor_control.reset (new MonitorProcessor (_session));
3359 must_configure = true;
3361 _monitor_control->set_state (**niter, Stateful::current_state_version);
3362 } else if (prop->value() == "capture") {
3363 /* CapturingProcessor should never be restored, it's always
3364 added explicitly when needed */
3366 ProcessorList::iterator o;
3368 for (o = _processors.begin(); o != _processors.end(); ++o) {
3369 XMLProperty const * id_prop = (*niter)->property(X_("id"));
3370 if (id_prop && (*o)->id() == id_prop->value()) {
3371 (*o)->set_state (**niter, Stateful::current_state_version);
3372 new_order.push_back (*o);
3377 // If the processor (*niter) is not on the route then create it
3379 if (o == _processors.end()) {
3381 boost::shared_ptr<Processor> processor;
3383 if (prop->value() == "intsend") {
3385 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
3387 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
3388 prop->value() == "lv2" ||
3389 prop->value() == "windows-vst" ||
3390 prop->value() == "lxvst" ||
3391 prop->value() == "luaproc" ||
3392 prop->value() == "audiounit") {
3394 if (_session.get_disable_all_loaded_plugins ()) {
3395 processor.reset (new UnknownProcessor (_session, **niter));
3397 processor.reset (new PluginInsert (_session));
3398 processor->set_owner (this);
3400 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(processor);
3401 pi->set_strict_io (true);
3405 } else if (prop->value() == "port") {
3407 processor.reset (new PortInsert (_session, _pannable, _mute_master));
3409 } else if (prop->value() == "send") {
3411 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
3412 boost::shared_ptr<Send> send = boost::dynamic_pointer_cast<Send> (processor);
3413 send->SelfDestruct.connect_same_thread (*this,
3414 boost::bind (&Route::processor_selfdestruct, this, boost::weak_ptr<Processor> (processor)));
3417 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
3421 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
3422 /* This processor could not be configured. Turn it into a UnknownProcessor */
3423 processor.reset (new UnknownProcessor (_session, **niter));
3426 /* subscribe to Sidechain IO changes */
3427 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
3428 if (pi && pi->has_sidechain ()) {
3429 pi->sidechain_input ()->changed.connect_same_thread (*this, boost::bind (&Route::sidechain_change_handler, this, _1, _2));
3432 /* we have to note the monitor send here, otherwise a new one will be created
3433 and the state of this one will be lost.
3435 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
3436 if (isend && isend->role() == Delivery::Listen) {
3437 _monitor_send = isend;
3440 /* it doesn't matter if invisible processors are added here, as they
3441 will be sorted out by setup_invisible_processors () shortly.
3444 new_order.push_back (processor);
3445 must_configure = true;
3451 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3452 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3453 _processors = new_order;
3455 if (must_configure) {
3456 configure_processors_unlocked (0, &lm);
3459 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3461 (*i)->set_owner (this);
3462 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
3464 boost::shared_ptr<PluginInsert> pi;
3466 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
3467 if (pi->has_no_inputs ()) {
3468 _have_internal_generator = true;
3475 reset_instrument_info ();
3476 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3477 set_processor_positions ();
3481 Route::curve_reallocate ()
3483 // _gain_automation_curve.finish_resize ();
3484 // _pan_automation_curve.finish_resize ();
3488 Route::silence (framecnt_t nframes)
3490 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3495 silence_unlocked (nframes);
3499 Route::silence_unlocked (framecnt_t nframes)
3501 /* Must be called with the processor lock held */
3505 _output->silence (nframes);
3507 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3508 boost::shared_ptr<PluginInsert> pi;
3510 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
3511 // skip plugins, they don't need anything when we're not active
3515 (*i)->silence (nframes);
3518 if (nframes == _session.get_block_size()) {
3525 Route::add_internal_return ()
3528 _intreturn.reset (new InternalReturn (_session));
3529 add_processor (_intreturn, PreFader);
3534 Route::add_send_to_internal_return (InternalSend* send)
3536 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3538 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3539 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3542 return d->add_send (send);
3548 Route::remove_send_from_internal_return (InternalSend* send)
3550 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3552 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3553 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3556 return d->remove_send (send);
3562 Route::enable_monitor_send ()
3564 /* Caller must hold process lock */
3565 assert (!AudioEngine::instance()->process_lock().trylock());
3567 /* master never sends to monitor section via the normal mechanism */
3568 assert (!is_master ());
3569 assert (!is_monitor ());
3571 /* make sure we have one */
3572 if (!_monitor_send) {
3573 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
3574 _monitor_send->set_display_to_user (false);
3578 configure_processors (0);
3581 /** Add an aux send to a route.
3582 * @param route route to send to.
3583 * @param before Processor to insert before, or 0 to insert at the end.
3586 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
3588 assert (route != _session.monitor_out ());
3591 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3593 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3595 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
3597 if (d && d->target_route() == route) {
3598 /* already listening via the specified IO: do nothing */
3606 boost::shared_ptr<InternalSend> listener;
3609 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3610 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
3611 listener.reset (new InternalSend (_session, sendpan, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
3614 add_processor (listener, before);
3616 } catch (failed_constructor& err) {
3624 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3626 ProcessorStreams err;
3627 ProcessorList::iterator tmp;
3630 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3632 /* have to do this early because otherwise processor reconfig
3633 * will put _monitor_send back in the list
3636 if (route == _session.monitor_out()) {
3637 _monitor_send.reset ();
3641 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3643 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3645 if (d && d->target_route() == route) {
3647 if (remove_processor (*x, &err, false) > 0) {
3653 /* list could have been demolished while we dropped the lock
3656 if (_session.engine().connected()) {
3657 /* i/o processors cannot be removed if the engine is not running
3658 * so don't live-loop in case the engine is N/A or dies
3668 Route::set_comment (string cmt, void *src)
3672 _session.set_dirty ();
3676 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3678 FeedRecord fr (other, via_sends_only);
3680 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3682 if (!result.second) {
3684 /* already a record for "other" - make sure sends-only information is correct */
3685 if (!via_sends_only && result.first->sends_only) {
3686 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3687 frp->sends_only = false;
3691 return result.second;
3695 Route::clear_fed_by ()
3701 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3703 const FedBy& fed_by (other->fed_by());
3705 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3706 boost::shared_ptr<Route> sr = f->r.lock();
3708 if (sr && (sr.get() == this)) {
3710 if (via_sends_only) {
3711 *via_sends_only = f->sends_only;
3722 Route::all_inputs () const
3724 /* TODO, if this works as expected,
3725 * cache the IOVector and maintain it via
3726 * input_change_handler(), sidechain_change_handler() etc
3729 ios.push_back (_input);
3731 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3732 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3734 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3735 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3738 iop = pi->sidechain();
3741 if (iop != 0 && iop->input()) {
3742 ios.push_back (iop->input());
3749 Route::all_outputs () const
3752 // _output is included via Delivery
3753 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3754 for (ProcessorList::const_iterator r = _processors.begin(); r != _processors.end(); ++r) {
3755 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3756 if (iop != 0 && iop->output()) {
3757 ios.push_back (iop->output());
3764 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3766 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3767 if (other->all_inputs().fed_by (_output)) {
3768 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3769 if (via_send_only) {
3770 *via_send_only = false;
3776 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3778 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3780 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor>(*r);
3781 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*r);
3784 iop = pi->sidechain();
3788 boost::shared_ptr<const IO> iop_out = iop->output();
3789 if ((iop_out && other->all_inputs().fed_by (iop_out)) || iop->feeds (other)) {
3790 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3791 if (via_send_only) {
3792 *via_send_only = true;
3796 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3799 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3804 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3809 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3811 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3815 Route::feeds_according_to_graph (boost::shared_ptr<Route> other)
3817 return _session._current_route_graph.feeds (shared_from_this (), other);
3820 /** Called from the (non-realtime) butler thread when the transport is stopped */
3822 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3824 framepos_t now = _session.transport_frame();
3827 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3829 Automatable::transport_stopped (now);
3831 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3833 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3837 (*i)->transport_stopped (now);
3841 _roll_delay = _initial_delay;
3845 Route::input_change_handler (IOChange change, void * /*src*/)
3847 if ((change.type & IOChange::ConfigurationChanged)) {
3848 /* This is called with the process lock held if change
3849 contains ConfigurationChanged
3851 configure_processors (0);
3852 _phase_invert.resize (_input->n_ports().n_audio ());
3853 io_changed (); /* EMIT SIGNAL */
3856 if (_soloed_by_others_upstream || _solo_isolated_by_upstream) {
3859 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3860 if (_input->connected()) {
3861 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3862 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3866 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3867 if (does_feed && !sends_only) {
3868 if ((*i)->soloed()) {
3871 if ((*i)->solo_isolated()) {
3878 int delta = sbou - _soloed_by_others_upstream;
3879 int idelta = ibou - _solo_isolated_by_upstream;
3882 PBD::warning << string_compose (
3883 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3884 _name, ibou, _solo_isolated_by_upstream, idelta)
3889 if (_soloed_by_others_upstream) {
3890 // ignore new connections (they're not propagated)
3892 mod_solo_by_others_upstream (delta);
3896 if (_solo_isolated_by_upstream) {
3897 // solo-isolate currently only propagates downstream
3899 mod_solo_isolated_by_upstream (false);
3901 // TODO think: mod_solo_isolated_by_upstream() does not take delta arg,
3902 // but idelta can't be smaller than -1, can it?
3903 //_solo_isolated_by_upstream = ibou;
3906 // Session::route_solo_changed does not propagate indirect solo-changes
3907 // propagate downstream to tracks
3908 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3909 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3913 bool does_feed = feeds (*i, &sends_only);
3914 if (delta <= 0 && does_feed && !sends_only) {
3915 (*i)->mod_solo_by_others_upstream (delta);
3918 if (idelta < 0 && does_feed && !sends_only) {
3919 (*i)->mod_solo_isolated_by_upstream (false);
3926 Route::output_change_handler (IOChange change, void * /*src*/)
3928 if (_initial_io_setup) {
3932 if ((change.type & IOChange::ConfigurationChanged)) {
3933 /* This is called with the process lock held if change
3934 contains ConfigurationChanged
3936 configure_processors (0);
3939 _session.reset_monitor_section();
3942 io_changed (); /* EMIT SIGNAL */
3945 if (_soloed_by_others_downstream) {
3947 /* checking all all downstream routes for
3948 * explicit of implict solo is a rather drastic measure,
3949 * ideally the input_change_handler() of the other route
3950 * would propagate the change to us.
3952 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3953 if (_output->connected()) {
3954 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3955 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3959 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3960 if (does_feed && !sends_only) {
3961 if ((*i)->soloed()) {
3968 int delta = sbod - _soloed_by_others_downstream;
3970 // do not allow new connections to change implicit solo (no propagation)
3971 mod_solo_by_others_downstream (delta);
3972 // Session::route_solo_changed() does not propagate indirect solo-changes
3973 // propagate upstream to tracks
3974 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3975 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3979 bool does_feed = (*i)->feeds (shared_from_this(), &sends_only);
3980 if (delta != 0 && does_feed && !sends_only) {
3981 (*i)->mod_solo_by_others_downstream (delta);
3990 Route::sidechain_change_handler (IOChange change, void* src)
3992 if (_initial_io_setup || _in_sidechain_setup) {
3996 input_change_handler (change, src);
4000 Route::pans_required () const
4002 if (n_outputs().n_audio() < 2) {
4006 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
4010 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
4012 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4018 if (n_outputs().n_total() == 0) {
4022 if (!_active || n_inputs() == ChanCount::ZERO) {
4023 silence_unlocked (nframes);
4027 if (session_state_changing) {
4028 if (_session.transport_speed() != 0.0f) {
4029 /* we're rolling but some state is changing (e.g. our diskstream contents)
4030 so we cannot use them. Be silent till this is over.
4032 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
4034 silence_unlocked (nframes);
4037 /* we're really not rolling, so we're either delivery silence or actually
4038 monitoring, both of which are safe to do while session_state_changing is true.
4042 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
4044 fill_buffers_with_input (bufs, _input, nframes);
4046 if (_meter_point == MeterInput) {
4047 _meter->run (bufs, start_frame, end_frame, nframes, true);
4050 _amp->apply_gain_automation (false);
4051 _trim->apply_gain_automation (false);
4052 passthru (bufs, start_frame, end_frame, nframes, 0);
4058 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
4060 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4065 if (n_outputs().n_total() == 0) {
4069 if (!_active || n_inputs().n_total() == 0) {
4070 silence_unlocked (nframes);
4074 framepos_t unused = 0;
4076 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
4082 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
4084 fill_buffers_with_input (bufs, _input, nframes);
4086 if (_meter_point == MeterInput) {
4087 _meter->run (bufs, start_frame, end_frame, nframes, true);
4090 passthru (bufs, start_frame, end_frame, nframes, declick);
4096 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
4103 Route::flush_processors ()
4105 /* XXX shouldn't really try to take this lock, since
4106 this is called from the RT audio thread.
4109 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4111 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4117 __attribute__((annotate("realtime")))
4120 Route::apply_processor_changes_rt ()
4122 int emissions = EmitNone;
4124 if (_pending_meter_point != _meter_point) {
4125 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
4127 /* meters always have buffers for 'processor_max_streams'
4128 * they can be re-positioned without re-allocation */
4129 if (set_meter_point_unlocked()) {
4130 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
4132 emissions |= EmitMeterChanged;
4137 bool changed = false;
4139 if (g_atomic_int_get (&_pending_process_reorder)) {
4140 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
4142 apply_processor_order (_pending_processor_order);
4143 setup_invisible_processors ();
4145 g_atomic_int_set (&_pending_process_reorder, 0);
4146 emissions |= EmitRtProcessorChange;
4150 set_processor_positions ();
4152 if (emissions != 0) {
4153 g_atomic_int_set (&_pending_signals, emissions);
4156 return (!selfdestruct_sequence.empty ());
4160 Route::emit_pending_signals ()
4162 int sig = g_atomic_int_and (&_pending_signals, 0);
4163 if (sig & EmitMeterChanged) {
4164 _meter->emit_configuration_changed();
4165 meter_change (); /* EMIT SIGNAL */
4166 if (sig & EmitMeterVisibilityChange) {
4167 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
4169 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
4172 if (sig & EmitRtProcessorChange) {
4173 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
4176 /* this would be a job for the butler.
4177 * Conceptually we should not take processe/processor locks here.
4178 * OTOH its more efficient (less overhead for summoning the butler and
4179 * telling her what do do) and signal emission is called
4180 * directly after the process callback, which decreases the chance
4181 * of x-runs when taking the locks.
4183 while (!selfdestruct_sequence.empty ()) {
4184 Glib::Threads::Mutex::Lock lx (selfdestruct_lock);
4185 if (selfdestruct_sequence.empty ()) { break; } // re-check with lock
4186 boost::shared_ptr<Processor> proc = selfdestruct_sequence.back ().lock ();
4187 selfdestruct_sequence.pop_back ();
4190 remove_processor (proc);
4196 Route::set_meter_point (MeterPoint p, bool force)
4198 if (_pending_meter_point == p && !force) {
4202 if (force || !AudioEngine::instance()->running()) {
4203 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4204 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
4205 _pending_meter_point = p;
4206 _meter->emit_configuration_changed();
4207 meter_change (); /* EMIT SIGNAL */
4208 if (set_meter_point_unlocked()) {
4209 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
4211 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
4214 _pending_meter_point = p;
4220 __attribute__((annotate("realtime")))
4223 Route::set_meter_point_unlocked ()
4226 /* Caller must hold process and processor write lock */
4227 assert (!AudioEngine::instance()->process_lock().trylock());
4228 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4229 assert (!lm.locked ());
4232 _meter_point = _pending_meter_point;
4234 bool meter_was_visible_to_user = _meter->display_to_user ();
4236 if (!_custom_meter_position_noted) {
4237 maybe_note_meter_position ();
4240 if (_meter_point != MeterCustom) {
4242 _meter->set_display_to_user (false);
4244 setup_invisible_processors ();
4247 _meter->set_display_to_user (true);
4249 /* If we have a previous position for the custom meter, try to put it there */
4250 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
4252 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
4253 if (i != _processors.end ()) {
4254 _processors.remove (_meter);
4255 _processors.insert (i, _meter);
4257 } else {// at end, right before the mains_out/panner
4258 _processors.remove (_meter);
4259 ProcessorList::iterator main = _processors.end();
4260 _processors.insert (--main, _meter);
4264 /* Set up the meter for its new position */
4266 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
4270 if (loc == _processors.begin()) {
4271 m_in = _input->n_ports();
4273 ProcessorList::iterator before = loc;
4275 m_in = (*before)->output_streams ();
4278 _meter->reflect_inputs (m_in);
4280 /* we do not need to reconfigure the processors, because the meter
4281 (a) is always ready to handle processor_max_streams
4282 (b) is always an N-in/N-out processor, and thus moving
4283 it doesn't require any changes to the other processors.
4286 /* these should really be done after releasing the lock
4287 * but all those signals are subscribed to with gui_thread()
4290 return (_meter->display_to_user() != meter_was_visible_to_user);
4294 Route::listen_position_changed ()
4297 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4298 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
4299 ProcessorState pstate (this);
4301 if (configure_processors_unlocked (0, &lm)) {
4302 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
4304 configure_processors_unlocked (0, &lm); // it worked before we tried to add it ...
4309 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
4310 _session.set_dirty ();
4313 boost::shared_ptr<CapturingProcessor>
4314 Route::add_export_point()
4316 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4317 if (!_capturing_processor) {
4319 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4320 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
4322 _capturing_processor.reset (new CapturingProcessor (_session));
4323 _capturing_processor->activate ();
4325 configure_processors_unlocked (0, &lw);
4329 return _capturing_processor;
4333 Route::update_signal_latency ()
4335 framecnt_t l = _output->user_latency();
4336 framecnt_t lamp = 0;
4337 bool before_amp = true;
4338 framecnt_t ltrim = 0;
4339 bool before_trim = true;
4341 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4342 if ((*i)->active ()) {
4343 l += (*i)->signal_latency ();
4348 if ((*i) == _trim) {
4359 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
4361 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
4362 _signal_latency_at_amp_position = lamp;
4363 _signal_latency_at_trim_position = ltrim;
4365 if (_signal_latency != l) {
4366 _signal_latency = l;
4367 signal_latency_changed (); /* EMIT SIGNAL */
4370 return _signal_latency;
4374 Route::set_user_latency (framecnt_t nframes)
4376 _output->set_user_latency (nframes);
4377 _session.update_latency_compensation ();
4381 Route::set_latency_compensation (framecnt_t longest_session_latency)
4383 framecnt_t old = _initial_delay;
4385 if (_signal_latency < longest_session_latency) {
4386 _initial_delay = longest_session_latency - _signal_latency;
4391 DEBUG_TRACE (DEBUG::Latency, string_compose (
4392 "%1: compensate for maximum latency of %2,"
4393 "given own latency of %3, using initial delay of %4\n",
4394 name(), longest_session_latency, _signal_latency, _initial_delay));
4396 if (_initial_delay != old) {
4397 initial_delay_changed (); /* EMIT SIGNAL */
4400 if (_session.transport_stopped()) {
4401 _roll_delay = _initial_delay;
4406 Route::set_block_size (pframes_t nframes)
4408 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4409 (*i)->set_block_size (nframes);
4412 _session.ensure_buffers (n_process_buffers ());
4416 Route::protect_automation ()
4418 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
4419 (*i)->protect_automation();
4422 /** @param declick 1 to set a pending declick fade-in,
4423 * -1 to set a pending declick fade-out
4426 Route::set_pending_declick (int declick)
4429 /* this call is not allowed to turn off a pending declick */
4431 _pending_declick = declick;
4434 _pending_declick = 0;
4438 /** Shift automation forwards from a particular place, thereby inserting time.
4439 * Adds undo commands for any shifts that are performed.
4441 * @param pos Position to start shifting from.
4442 * @param frames Amount to shift forwards by.
4446 Route::shift (framepos_t pos, framecnt_t frames)
4448 /* gain automation */
4450 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
4452 XMLNode &before = gc->alist()->get_state ();
4453 gc->alist()->shift (pos, frames);
4454 XMLNode &after = gc->alist()->get_state ();
4455 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
4458 /* gain automation */
4460 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
4462 XMLNode &before = gc->alist()->get_state ();
4463 gc->alist()->shift (pos, frames);
4464 XMLNode &after = gc->alist()->get_state ();
4465 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
4468 // TODO mute automation ??
4470 /* pan automation */
4472 ControlSet::Controls& c (_pannable->controls());
4474 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
4475 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
4477 boost::shared_ptr<AutomationList> al = pc->alist();
4478 XMLNode& before = al->get_state ();
4479 al->shift (pos, frames);
4480 XMLNode& after = al->get_state ();
4481 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4486 /* redirect automation */
4488 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4489 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
4491 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
4493 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
4494 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
4496 boost::shared_ptr<AutomationList> al = ac->alist();
4497 XMLNode &before = al->get_state ();
4498 al->shift (pos, frames);
4499 XMLNode &after = al->get_state ();
4500 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4508 Route::set_plugin_state_dir (boost::weak_ptr<Processor> p, const std::string& d)
4510 boost::shared_ptr<Processor> processor (p.lock ());
4511 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (processor);
4515 pi->set_state_dir (d);
4519 Route::save_as_template (const string& path, const string& name)
4521 std::string state_dir = path.substr (0, path.find_last_of ('.')); // strip template_suffix
4522 PBD::Unwinder<std::string> uw (_session._template_state_dir, state_dir);
4524 XMLNode& node (state (false));
4528 IO::set_name_in_state (*node.children().front(), name);
4530 tree.set_root (&node);
4532 /* return zero on success, non-zero otherwise */
4533 return !tree.write (path.c_str());
4538 Route::set_name (const string& str)
4540 if (str == name()) {
4544 string name = Route::ensure_track_or_route_name (str, _session);
4545 SessionObject::set_name (name);
4547 bool ret = (_input->set_name(name) && _output->set_name(name));
4550 /* rename the main outs. Leave other IO processors
4551 * with whatever name they already have, because its
4552 * just fine as it is (it will not contain the route
4553 * name if its a port insert, port send or port return).
4557 if (_main_outs->set_name (name)) {
4558 /* XXX returning false here is stupid because
4559 we already changed the route name.
4569 /** Set the name of a route in an XML description.
4570 * @param node XML <Route> node to set the name in.
4571 * @param name New name.
4574 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
4576 node.add_property (X_("name"), name);
4578 XMLNodeList children = node.children();
4579 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
4581 if ((*i)->name() == X_("IO")) {
4583 IO::set_name_in_state (**i, name);
4585 } else if ((*i)->name() == X_("Processor")) {
4587 XMLProperty const * role = (*i)->property (X_("role"));
4588 if (role && role->value() == X_("Main")) {
4589 (*i)->add_property (X_("name"), name);
4592 } else if ((*i)->name() == X_("Diskstream")) {
4594 if (rename_playlist) {
4595 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
4597 (*i)->add_property (X_("name"), name);
4603 boost::shared_ptr<Send>
4604 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4606 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4608 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4609 boost::shared_ptr<InternalSend> send;
4611 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4612 if (send->target_route() == target) {
4618 return boost::shared_ptr<Send>();
4621 /** @param c Audio channel index.
4622 * @param yn true to invert phase, otherwise false.
4625 Route::set_phase_invert (uint32_t c, bool yn)
4627 if (_phase_invert[c] != yn) {
4628 _phase_invert[c] = yn;
4629 phase_invert_changed (); /* EMIT SIGNAL */
4630 _phase_control->Changed(); /* EMIT SIGNAL */
4631 _session.set_dirty ();
4636 Route::set_phase_invert (boost::dynamic_bitset<> p)
4638 if (_phase_invert != p) {
4640 phase_invert_changed (); /* EMIT SIGNAL */
4641 _session.set_dirty ();
4646 Route::phase_invert (uint32_t c) const
4648 return _phase_invert[c];
4651 boost::dynamic_bitset<>
4652 Route::phase_invert () const
4654 return _phase_invert;
4658 Route::set_denormal_protection (bool yn)
4660 if (_denormal_protection != yn) {
4661 _denormal_protection = yn;
4662 denormal_protection_changed (); /* EMIT SIGNAL */
4667 Route::denormal_protection () const
4669 return _denormal_protection;
4673 Route::set_active (bool yn, void* src)
4675 if (_session.transport_rolling()) {
4679 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4680 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4684 if (_active != yn) {
4686 _input->set_active (yn);
4687 _output->set_active (yn);
4688 active_changed (); // EMIT SIGNAL
4689 _session.set_dirty ();
4693 boost::shared_ptr<Pannable>
4694 Route::pannable() const
4699 boost::shared_ptr<Panner>
4700 Route::panner() const
4703 return _main_outs->panner_shell()->panner();
4706 boost::shared_ptr<PannerShell>
4707 Route::panner_shell() const
4709 return _main_outs->panner_shell();
4712 boost::shared_ptr<GainControl>
4713 Route::gain_control() const
4715 return _gain_control;
4718 boost::shared_ptr<GainControl>
4719 Route::trim_control() const
4721 return _trim_control;
4724 boost::shared_ptr<Route::PhaseControllable>
4725 Route::phase_control() const
4727 if (phase_invert().size()) {
4728 return _phase_control;
4730 return boost::shared_ptr<PhaseControllable>();
4734 boost::shared_ptr<AutomationControl>
4735 Route::get_control (const Evoral::Parameter& param)
4737 /* either we own the control or .... */
4739 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4743 /* maybe one of our processors does or ... */
4745 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4746 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4747 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4755 /* nobody does so we'll make a new one */
4757 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4764 boost::shared_ptr<Processor>
4765 Route::nth_plugin (uint32_t n) const
4767 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4768 ProcessorList::const_iterator i;
4770 for (i = _processors.begin(); i != _processors.end(); ++i) {
4771 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4778 return boost::shared_ptr<Processor> ();
4781 boost::shared_ptr<Processor>
4782 Route::nth_send (uint32_t n) const
4784 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4785 ProcessorList::const_iterator i;
4787 for (i = _processors.begin(); i != _processors.end(); ++i) {
4788 if (boost::dynamic_pointer_cast<Send> (*i)) {
4790 if ((*i)->name().find (_("Monitor")) == 0) {
4791 /* send to monitor section is not considered
4792 to be an accessible send.
4803 return boost::shared_ptr<Processor> ();
4807 Route::has_io_processor_named (const string& name)
4809 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4810 ProcessorList::iterator i;
4812 for (i = _processors.begin(); i != _processors.end(); ++i) {
4813 if (boost::dynamic_pointer_cast<Send> (*i) ||
4814 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4815 if ((*i)->name() == name) {
4824 MuteMaster::MutePoint
4825 Route::mute_points () const
4827 return _mute_master->mute_points ();
4831 Route::set_processor_positions ()
4833 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4835 bool had_amp = false;
4836 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4837 (*i)->set_pre_fader (!had_amp);
4844 /** Called when there is a proposed change to the input port count */
4846 Route::input_port_count_changing (ChanCount to)
4848 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4850 /* The processors cannot be configured with the new input arrangement, so
4856 /* The change is ok */
4860 /** Called when there is a proposed change to the output port count */
4862 Route::output_port_count_changing (ChanCount to)
4864 if (_strict_io && !_in_configure_processors) {
4867 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4868 if (processor_out_streams.get(*t) > to.get(*t)) {
4872 /* The change is ok */
4877 Route::unknown_processors () const
4881 if (_session.get_disable_all_loaded_plugins ()) {
4882 // Do not list "missing plugins" if they are explicitly disabled
4886 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4887 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4888 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4889 p.push_back ((*i)->name ());
4898 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4900 /* we assume that all our input ports feed all our output ports. its not
4901 universally true, but the alternative is way too corner-case to worry about.
4904 LatencyRange all_connections;
4907 all_connections.min = 0;
4908 all_connections.max = 0;
4910 all_connections.min = ~((pframes_t) 0);
4911 all_connections.max = 0;
4913 /* iterate over all "from" ports and determine the latency range for all of their
4914 connections to the "outside" (outside of this Route).
4917 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4921 p->get_connected_latency_range (range, playback);
4923 all_connections.min = min (all_connections.min, range.min);
4924 all_connections.max = max (all_connections.max, range.max);
4928 /* set the "from" port latencies to the max/min range of all their connections */
4930 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4931 p->set_private_latency_range (all_connections, playback);
4934 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4936 all_connections.min += our_latency;
4937 all_connections.max += our_latency;
4939 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4940 p->set_private_latency_range (all_connections, playback);
4943 return all_connections.max;
4947 Route::set_private_port_latencies (bool playback) const
4949 framecnt_t own_latency = 0;
4951 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4952 OR LATENCY CALLBACK.
4954 This is called (early) from the latency callback. It computes the REAL
4955 latency associated with each port and stores the result as the "private"
4956 latency of the port. A later call to Route::set_public_port_latencies()
4957 sets all ports to the same value to reflect the fact that we do latency
4958 compensation and so all signals are delayed by the same amount as they
4959 flow through ardour.
4962 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4963 if ((*i)->active ()) {
4964 own_latency += (*i)->signal_latency ();
4969 /* playback: propagate latency from "outside the route" to outputs to inputs */
4970 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4972 /* capture: propagate latency from "outside the route" to inputs to outputs */
4973 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4978 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4980 /* this is called to set the JACK-visible port latencies, which take
4981 latency compensation into account.
4990 const PortSet& ports (_input->ports());
4991 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4992 p->set_public_latency_range (range, playback);
4997 const PortSet& ports (_output->ports());
4998 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4999 p->set_public_latency_range (range, playback);
5004 /** Put the invisible processors in the right place in _processors.
5005 * Must be called with a writer lock on _processor_lock held.
5008 __attribute__((annotate("realtime")))
5011 Route::setup_invisible_processors ()
5014 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
5015 assert (!lm.locked ());
5019 /* too early to be doing this stuff */
5023 /* we'll build this new list here and then use it
5025 * TODO put the ProcessorList is on the stack for RT-safety.
5028 ProcessorList new_processors;
5030 /* find visible processors */
5032 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5033 if ((*i)->display_to_user ()) {
5034 new_processors.push_back (*i);
5040 ProcessorList::iterator amp = new_processors.begin ();
5041 while (amp != new_processors.end() && *amp != _amp) {
5045 assert (amp != new_processors.end ());
5047 /* and the processor after the amp */
5049 ProcessorList::iterator after_amp = amp;
5055 switch (_meter_point) {
5057 assert (!_meter->display_to_user ());
5058 new_processors.push_front (_meter);
5061 assert (!_meter->display_to_user ());
5062 new_processors.insert (amp, _meter);
5064 case MeterPostFader:
5065 /* do nothing here */
5068 /* do nothing here */
5071 /* the meter is visible, so we don't touch it here */
5078 assert (_main_outs);
5079 assert (!_main_outs->display_to_user ());
5080 new_processors.push_back (_main_outs);
5082 /* iterator for the main outs */
5084 ProcessorList::iterator main = new_processors.end();
5087 /* OUTPUT METERING */
5089 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
5090 assert (!_meter->display_to_user ());
5092 /* add the processor just before or just after the main outs */
5094 ProcessorList::iterator meter_point = main;
5096 if (_meter_point == MeterOutput) {
5099 new_processors.insert (meter_point, _meter);
5104 if (_monitor_send && !is_monitor ()) {
5105 assert (!_monitor_send->display_to_user ());
5106 switch (Config->get_listen_position ()) {
5107 case PreFaderListen:
5108 switch (Config->get_pfl_position ()) {
5109 case PFLFromBeforeProcessors:
5110 new_processors.push_front (_monitor_send);
5112 case PFLFromAfterProcessors:
5113 new_processors.insert (amp, _monitor_send);
5116 _monitor_send->set_can_pan (false);
5118 case AfterFaderListen:
5119 switch (Config->get_afl_position ()) {
5120 case AFLFromBeforeProcessors:
5121 new_processors.insert (after_amp, _monitor_send);
5123 case AFLFromAfterProcessors:
5124 new_processors.insert (new_processors.end(), _monitor_send);
5127 _monitor_send->set_can_pan (true);
5132 #if 0 // not used - just yet
5133 if (!is_master() && !is_monitor() && !is_auditioner()) {
5134 new_processors.push_front (_delayline);
5138 /* MONITOR CONTROL */
5140 if (_monitor_control && is_monitor ()) {
5141 assert (!_monitor_control->display_to_user ());
5142 new_processors.insert (amp, _monitor_control);
5145 /* INTERNAL RETURN */
5147 /* doing this here means that any monitor control will come just after
5152 assert (!_intreturn->display_to_user ());
5153 new_processors.push_front (_intreturn);
5156 if (_trim && _trim->active()) {
5157 assert (!_trim->display_to_user ());
5158 new_processors.push_front (_trim);
5160 /* EXPORT PROCESSOR */
5162 if (_capturing_processor) {
5163 assert (!_capturing_processor->display_to_user ());
5164 new_processors.push_front (_capturing_processor);
5167 _processors = new_processors;
5169 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5170 if (!(*i)->display_to_user () && !(*i)->active () && (*i) != _monitor_send) {
5175 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
5176 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5177 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
5184 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
5185 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
5189 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5190 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
5197 /** If the meter point is `Custom', make a note of where the meter is.
5198 * This is so that if the meter point is subsequently set to something else,
5199 * and then back to custom, we can put the meter back where it was last time
5200 * custom was enabled.
5202 * Must be called with the _processor_lock held.
5205 Route::maybe_note_meter_position ()
5207 if (_meter_point != MeterCustom) {
5211 _custom_meter_position_noted = true;
5212 /* custom meter points range from after trim to before panner/main_outs
5213 * this is a limitation by the current processor UI
5215 bool seen_trim = false;
5216 _processor_after_last_custom_meter.reset();
5217 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5218 if ((*i) == _trim) {
5221 if ((*i) == _main_outs) {
5222 _processor_after_last_custom_meter = *i;
5225 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
5227 _processor_after_last_custom_meter = _trim;
5229 ProcessorList::iterator j = i;
5231 assert(j != _processors.end ()); // main_outs should be before
5232 _processor_after_last_custom_meter = *j;
5237 assert(_processor_after_last_custom_meter.lock());
5240 boost::shared_ptr<Processor>
5241 Route::processor_by_id (PBD::ID id) const
5243 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
5244 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
5245 if ((*i)->id() == id) {
5250 return boost::shared_ptr<Processor> ();
5253 /** @return the monitoring state, or in other words what data we are pushing
5254 * into the route (data from the inputs, data from disk or silence)
5257 Route::monitoring_state () const
5259 return MonitoringInput;
5262 /** @return what we should be metering; either the data coming from the input
5263 * IO or the data that is flowing through the route.
5266 Route::metering_state () const
5268 return MeteringRoute;
5272 Route::has_external_redirects () const
5274 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
5276 /* ignore inactive processors and obviously ignore the main
5277 * outs since everything has them and we don't care.
5280 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
5288 boost::shared_ptr<Processor>
5289 Route::the_instrument () const
5291 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
5292 return the_instrument_unlocked ();
5295 boost::shared_ptr<Processor>
5296 Route::the_instrument_unlocked () const
5298 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
5299 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert>(*i);
5300 if (pi && pi->plugin ()->get_info ()->is_instrument ()) {
5304 return boost::shared_ptr<Processor>();
5310 Route::non_realtime_locate (framepos_t pos)
5313 _pannable->transport_located (pos);
5316 if (_delayline.get()) {
5317 _delayline.get()->flush();
5321 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
5322 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
5324 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
5325 (*i)->transport_located (pos);
5328 _roll_delay = _initial_delay;
5332 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
5339 * We don't currently mix MIDI input together, so we don't need the
5340 * complex logic of the audio case.
5343 n_buffers = bufs.count().n_midi ();
5345 for (i = 0; i < n_buffers; ++i) {
5347 boost::shared_ptr<MidiPort> source_port = io->midi (i);
5348 MidiBuffer& buf (bufs.get_midi (i));
5351 buf.copy (source_port->get_midi_buffer(nframes));
5353 buf.silence (nframes);
5359 n_buffers = bufs.count().n_audio();
5361 size_t n_ports = io->n_ports().n_audio();
5362 float scaling = 1.0f;
5364 if (n_ports > n_buffers) {
5365 scaling = ((float) n_buffers) / n_ports;
5368 for (i = 0; i < n_ports; ++i) {
5370 /* if there are more ports than buffers, map them onto buffers
5371 * in a round-robin fashion
5374 boost::shared_ptr<AudioPort> source_port = io->audio (i);
5375 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
5378 if (i < n_buffers) {
5380 /* first time through just copy a channel into
5384 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
5386 if (scaling != 1.0f) {
5387 buf.apply_gain (scaling, nframes);
5392 /* on subsequent times around, merge data from
5393 * the port with what is already there
5396 if (scaling != 1.0f) {
5397 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
5399 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
5404 /* silence any remaining buffers */
5406 for (; i < n_buffers; ++i) {
5407 AudioBuffer& buf (bufs.get_audio (i));
5408 buf.silence (nframes);
5411 /* establish the initial setup of the buffer set, reflecting what was
5412 copied into it. unless, of course, we are the auditioner, in which
5413 case nothing was fed into it from the inputs at all.
5416 if (!is_auditioner()) {
5417 bufs.set_count (io->n_ports());
5421 boost::shared_ptr<AutomationControl>
5422 Route::pan_azimuth_control() const
5425 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5427 return boost::shared_ptr<AutomationControl>();
5429 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
5430 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
5432 if (!_pannable || !panner()) {
5433 return boost::shared_ptr<AutomationControl>();
5435 return _pannable->pan_azimuth_control;
5439 boost::shared_ptr<AutomationControl>
5440 Route::pan_elevation_control() const
5442 if (Profile->get_mixbus() || !_pannable || !panner()) {
5443 return boost::shared_ptr<AutomationControl>();
5446 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5448 if (c.find (PanElevationAutomation) != c.end()) {
5449 return _pannable->pan_elevation_control;
5451 return boost::shared_ptr<AutomationControl>();
5454 boost::shared_ptr<AutomationControl>
5455 Route::pan_width_control() const
5457 if (Profile->get_mixbus() || !_pannable || !panner()) {
5458 return boost::shared_ptr<AutomationControl>();
5461 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5463 if (c.find (PanWidthAutomation) != c.end()) {
5464 return _pannable->pan_width_control;
5466 return boost::shared_ptr<AutomationControl>();
5469 boost::shared_ptr<AutomationControl>
5470 Route::pan_frontback_control() const
5472 if (Profile->get_mixbus() || !_pannable || !panner()) {
5473 return boost::shared_ptr<AutomationControl>();
5476 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5478 if (c.find (PanFrontBackAutomation) != c.end()) {
5479 return _pannable->pan_frontback_control;
5481 return boost::shared_ptr<AutomationControl>();
5484 boost::shared_ptr<AutomationControl>
5485 Route::pan_lfe_control() const
5487 if (Profile->get_mixbus() || !_pannable || !panner()) {
5488 return boost::shared_ptr<AutomationControl>();
5491 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5493 if (c.find (PanLFEAutomation) != c.end()) {
5494 return _pannable->pan_lfe_control;
5496 return boost::shared_ptr<AutomationControl>();
5501 Route::eq_band_cnt () const
5503 if (Profile->get_mixbus()) {
5506 /* Ardour has no well-known EQ object */
5511 boost::shared_ptr<AutomationControl>
5512 Route::eq_gain_controllable (uint32_t band) const
5515 boost::shared_ptr<PluginInsert> eq = ch_eq();
5518 return boost::shared_ptr<AutomationControl>();
5521 uint32_t port_number;
5524 if (is_master() || mixbus()) {
5531 if (is_master() || mixbus()) {
5538 if (is_master() || mixbus()) {
5545 return boost::shared_ptr<AutomationControl>();
5548 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5550 return boost::shared_ptr<AutomationControl>();
5553 boost::shared_ptr<AutomationControl>
5554 Route::eq_freq_controllable (uint32_t band) const
5558 if (mixbus() || is_master()) {
5559 /* no frequency controls for mixbusses or master */
5560 return boost::shared_ptr<AutomationControl>();
5563 boost::shared_ptr<PluginInsert> eq = ch_eq();
5566 return boost::shared_ptr<AutomationControl>();
5569 uint32_t port_number;
5581 return boost::shared_ptr<AutomationControl>();
5584 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5586 return boost::shared_ptr<AutomationControl>();
5590 boost::shared_ptr<AutomationControl>
5591 Route::eq_q_controllable (uint32_t band) const
5593 return boost::shared_ptr<AutomationControl>();
5596 boost::shared_ptr<AutomationControl>
5597 Route::eq_shape_controllable (uint32_t band) const
5599 return boost::shared_ptr<AutomationControl>();
5602 boost::shared_ptr<AutomationControl>
5603 Route::eq_enable_controllable () const
5606 boost::shared_ptr<PluginInsert> eq = ch_eq();
5609 return boost::shared_ptr<AutomationControl>();
5612 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5614 return boost::shared_ptr<AutomationControl>();
5618 boost::shared_ptr<AutomationControl>
5619 Route::eq_hpf_controllable () const
5622 boost::shared_ptr<PluginInsert> eq = ch_eq();
5625 return boost::shared_ptr<AutomationControl>();
5628 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5630 return boost::shared_ptr<AutomationControl>();
5635 Route::eq_band_name (uint32_t band) const
5637 if (Profile->get_mixbus()) {
5653 boost::shared_ptr<AutomationControl>
5654 Route::comp_enable_controllable () const
5657 boost::shared_ptr<PluginInsert> comp = ch_comp();
5660 return boost::shared_ptr<AutomationControl>();
5663 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5665 return boost::shared_ptr<AutomationControl>();
5668 boost::shared_ptr<AutomationControl>
5669 Route::comp_threshold_controllable () const
5672 boost::shared_ptr<PluginInsert> comp = ch_comp();
5675 return boost::shared_ptr<AutomationControl>();
5678 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5681 return boost::shared_ptr<AutomationControl>();
5684 boost::shared_ptr<AutomationControl>
5685 Route::comp_speed_controllable () const
5688 boost::shared_ptr<PluginInsert> comp = ch_comp();
5691 return boost::shared_ptr<AutomationControl>();
5694 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5696 return boost::shared_ptr<AutomationControl>();
5699 boost::shared_ptr<AutomationControl>
5700 Route::comp_mode_controllable () const
5703 boost::shared_ptr<PluginInsert> comp = ch_comp();
5706 return boost::shared_ptr<AutomationControl>();
5709 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5711 return boost::shared_ptr<AutomationControl>();
5714 boost::shared_ptr<AutomationControl>
5715 Route::comp_makeup_controllable () const
5718 boost::shared_ptr<PluginInsert> comp = ch_comp();
5721 return boost::shared_ptr<AutomationControl>();
5724 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5726 return boost::shared_ptr<AutomationControl>();
5729 boost::shared_ptr<AutomationControl>
5730 Route::comp_redux_controllable () const
5733 boost::shared_ptr<PluginInsert> comp = ch_comp();
5736 return boost::shared_ptr<AutomationControl>();
5739 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5741 return boost::shared_ptr<AutomationControl>();
5746 Route::comp_mode_name (uint32_t mode) const
5751 return _("Leveler");
5753 return _("Compressor");
5755 return _("Limiter");
5757 return mixbus() ? _("Sidechain") : _("Limiter");
5767 Route::comp_speed_name (uint32_t mode) const
5785 boost::shared_ptr<AutomationControl>
5786 Route::send_level_controllable (uint32_t n) const
5789 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5791 return boost::shared_ptr<AutomationControl>();
5796 return boost::shared_ptr<AutomationControl>();
5799 const uint32_t port_id = port_channel_post_aux1_level + (2*n); // gtk2_ardour/mixbus_ports.h
5800 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5802 boost::shared_ptr<Send> s = boost::dynamic_pointer_cast<Send>(nth_send (n));
5804 return boost::shared_ptr<AutomationControl>();
5806 return s->gain_control ();
5810 boost::shared_ptr<AutomationControl>
5811 Route::send_enable_controllable (uint32_t n) const
5814 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5816 return boost::shared_ptr<AutomationControl>();
5821 return boost::shared_ptr<AutomationControl>();
5824 const uint32_t port_id = port_channel_post_aux1_asgn + (2*n); // gtk2_ardour/mixbus_ports.h
5825 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_id)));
5827 /* although Ardour sends have enable/disable as part of the Processor
5828 API, it is not exposed as a controllable.
5830 XXX: we should fix this.
5832 return boost::shared_ptr<AutomationControl>();
5837 Route::send_name (uint32_t n) const
5843 boost::shared_ptr<Route> r = _session.get_mixbus (n);
5847 boost::shared_ptr<Processor> p = nth_send (n);
5856 boost::shared_ptr<AutomationControl>
5857 Route::master_send_enable_controllable () const
5860 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5862 return boost::shared_ptr<AutomationControl>();
5864 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_mstr_assign)));
5866 return boost::shared_ptr<AutomationControl>();