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/internal_return.h"
50 #include "ardour/internal_send.h"
51 #include "ardour/meter.h"
52 #include "ardour/delayline.h"
53 #include "ardour/midi_buffer.h"
54 #include "ardour/midi_port.h"
55 #include "ardour/monitor_processor.h"
56 #include "ardour/pannable.h"
57 #include "ardour/panner.h"
58 #include "ardour/panner_shell.h"
59 #include "ardour/plugin_insert.h"
60 #include "ardour/port.h"
61 #include "ardour/port_insert.h"
62 #include "ardour/processor.h"
63 #include "ardour/profile.h"
64 #include "ardour/route.h"
65 #include "ardour/route_group.h"
66 #include "ardour/send.h"
67 #include "ardour/session.h"
68 #include "ardour/unknown_processor.h"
69 #include "ardour/utils.h"
74 using namespace ARDOUR;
77 PBD::Signal0<void> Route::SyncOrderKeys;
78 PBD::Signal0<void> Route::RemoteControlIDChange;
80 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
81 : SessionObject (sess, name)
83 , GraphNode (sess._process_graph)
86 , _signal_latency_at_amp_position (0)
87 , _signal_latency_at_trim_position (0)
90 , _pending_process_reorder (0)
91 , _pending_signals (0)
93 , _pending_declick (true)
94 , _meter_point (MeterPostFader)
95 , _pending_meter_point (MeterPostFader)
96 , _meter_type (MeterPeak)
98 , _soloed_by_others_upstream (0)
99 , _soloed_by_others_downstream (0)
100 , _solo_isolated (false)
101 , _solo_isolated_by_upstream (0)
102 , _denormal_protection (false)
105 , _declickable (false)
106 , _mute_master (new MuteMaster (sess, name))
107 , _have_internal_generator (false)
109 , _default_type (default_type)
111 , _has_order_key (false)
112 , _remote_control_id (0)
114 , _in_configure_processors (false)
115 , _initial_io_setup (false)
116 , _custom_meter_position_noted (false)
118 processor_max_streams.reset();
124 /* set default meter type */
126 _meter_type = Config->get_meter_type_master ();
128 else if (dynamic_cast<Track*>(this)) {
129 _meter_type = Config->get_meter_type_track ();
131 _meter_type = Config->get_meter_type_bus ();
134 /* add standard controls */
136 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
137 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
138 _phase_control.reset (new PhaseControllable (X_("phase"), shared_from_this ()));
140 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
141 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
142 _phase_control->set_flags (Controllable::Flag (_phase_control->flags() | Controllable::Toggle));
144 add_control (_solo_control);
145 add_control (_mute_control);
146 add_control (_phase_control);
150 if (!(_flags & Route::MonitorOut)) {
151 _pannable.reset (new Pannable (_session));
154 /* input and output objects */
156 _input.reset (new IO (_session, _name, IO::Input, _default_type));
157 _output.reset (new IO (_session, _name, IO::Output, _default_type));
159 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
160 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
162 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
163 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
165 #if 0 // not used - just yet
166 if (!is_master() && !is_monitor() && !is_auditioner()) {
167 _delayline.reset (new DelayLine (_session, _name));
168 add_processor (_delayline, PreFader);
172 /* add amp processor */
174 _amp.reset (new Amp (_session));
175 add_processor (_amp, PostFader);
177 // amp should exist before amp controls
178 _group_gain_control.reset (new GroupGainControllable (X_("groupgain"), shared_from_this ()));
179 _group_gain_control->set_flags (Controllable::Flag (_group_gain_control->flags() | Controllable::GainLike));
180 add_control (_group_gain_control);
183 _trim.reset (new Amp (_session, "trim"));
184 _trim->set_display_to_user (false);
186 if (dynamic_cast<AudioTrack*>(this)) {
187 /* we can't do this in the AudioTrack's constructor
188 * because _trim does not exit then
192 else if (!dynamic_cast<Track*>(this) && ! ( is_monitor() || is_auditioner() )) {
197 /* create standard processors: meter, main outs, monitor out;
198 they will be added to _processors by setup_invisible_processors ()
201 _meter.reset (new PeakMeter (_session, _name));
202 _meter->set_owner (this);
203 _meter->set_display_to_user (false);
206 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
207 _main_outs->activate ();
210 /* where we listen to tracks */
211 _intreturn.reset (new InternalReturn (_session));
212 _intreturn->activate ();
214 /* the thing that provides proper control over a control/monitor/listen bus
215 (such as per-channel cut, dim, solo, invert, etc).
217 _monitor_control.reset (new MonitorProcessor (_session));
218 _monitor_control->activate ();
221 if (is_master() || is_monitor() || is_auditioner()) {
222 _mute_master->set_solo_ignore (true);
225 /* now that we have _meter, its safe to connect to this */
228 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
229 configure_processors (0);
237 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
239 /* do this early so that we don't get incoming signals as we are going through destruction
244 /* don't use clear_processors here, as it depends on the session which may
245 be half-destroyed by now
248 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
249 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
250 (*i)->drop_references ();
253 _processors.clear ();
257 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
259 if (Config->get_remote_model() != UserOrdered) {
263 set_remote_control_id_internal (id, notify_class_listeners);
267 Route::set_remote_control_id_internal (uint32_t id, bool notify_class_listeners)
269 /* force IDs for master/monitor busses and prevent
270 any other route from accidentally getting these IDs
271 (i.e. legacy sessions)
274 if (is_master() && id != MasterBusRemoteControlID) {
275 id = MasterBusRemoteControlID;
278 if (is_monitor() && id != MonitorBusRemoteControlID) {
279 id = MonitorBusRemoteControlID;
286 /* don't allow it to collide */
288 if (!is_master () && !is_monitor() &&
289 (id == MasterBusRemoteControlID || id == MonitorBusRemoteControlID)) {
290 id += MonitorBusRemoteControlID;
293 if (id != remote_control_id()) {
294 _remote_control_id = id;
295 RemoteControlIDChanged ();
297 if (notify_class_listeners) {
298 RemoteControlIDChange ();
304 Route::remote_control_id() const
307 return MasterBusRemoteControlID;
311 return MonitorBusRemoteControlID;
314 return _remote_control_id;
318 Route::has_order_key () const
320 return _has_order_key;
324 Route::order_key () const
330 Route::set_remote_control_id_explicit (uint32_t rid)
332 if (is_master() || is_monitor() || is_auditioner()) {
333 /* hard-coded remote IDs, or no remote ID */
337 if (_remote_control_id != rid) {
338 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1: set edit-based RID to %2\n", name(), rid));
339 _remote_control_id = rid;
340 RemoteControlIDChanged (); /* EMIT SIGNAL (per-route) */
343 /* don't emit the class-level RID signal RemoteControlIDChange here,
344 leave that to the entity that changed the order key, so that we
345 don't get lots of emissions for no good reasons (e.g. when changing
346 all route order keys).
348 See Session::sync_remote_id_from_order_keys() for the (primary|only)
349 spot where that is emitted.
354 Route::set_order_key (uint32_t n)
356 _has_order_key = true;
358 if (_order_key == n) {
364 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 order key set to %2\n",
365 name(), order_key ()));
367 _session.set_dirty ();
371 Route::ensure_track_or_route_name(string name, Session &session)
373 string newname = name;
375 while (!session.io_name_is_legal (newname)) {
376 newname = bump_name_once (newname, ' ');
383 Route::inc_gain (gain_t fraction, void *src)
385 _amp->inc_gain (fraction, src);
389 Route::set_gain (gain_t val, void *src)
391 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
393 if (_route_group->is_relative()) {
395 gain_t usable_gain = _amp->gain();
396 if (usable_gain < 0.000001f) {
397 usable_gain = 0.000001f;
401 if (delta < 0.000001f) {
405 delta -= usable_gain;
410 gain_t factor = delta / usable_gain;
413 factor = _route_group->get_max_factor(factor);
414 if (factor == 0.0f) {
415 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
419 factor = _route_group->get_min_factor(factor);
420 if (factor == 0.0f) {
421 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
426 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
430 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
436 if (val == _amp->gain()) {
440 _amp->set_gain (val, src);
444 Route::inc_trim (gain_t fraction, void *src)
446 _trim->inc_gain (fraction, src);
450 Route::set_trim (gain_t val, void * /* src */)
452 // TODO route group, see set_gain()
453 _trim->set_gain (val, 0);
457 Route::maybe_declick (BufferSet&, framecnt_t, int)
459 /* this is the "bus" implementation and they never declick.
464 /** Process this route for one (sub) cycle (process thread)
466 * @param bufs Scratch buffers to use for the signal path
467 * @param start_frame Initial transport frame
468 * @param end_frame Final transport frame
469 * @param nframes Number of frames to output (to ports)
471 * Note that (end_frame - start_frame) may not be equal to nframes when the
472 * transport speed isn't 1.0 (eg varispeed).
475 Route::process_output_buffers (BufferSet& bufs,
476 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
477 int declick, bool gain_automation_ok)
479 /* Caller must hold process lock */
480 assert (!AudioEngine::instance()->process_lock().trylock());
482 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
484 // can this actually happen? functions calling process_output_buffers()
485 // already take a reader-lock.
486 bufs.silence (nframes, 0);
490 /* figure out if we're going to use gain automation */
491 if (gain_automation_ok) {
492 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
493 _amp->setup_gain_automation (
494 start_frame + _signal_latency_at_amp_position,
495 end_frame + _signal_latency_at_amp_position,
498 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
499 _trim->setup_gain_automation (
500 start_frame + _signal_latency_at_trim_position,
501 end_frame + _signal_latency_at_trim_position,
504 _amp->apply_gain_automation (false);
505 _trim->apply_gain_automation (false);
508 /* Tell main outs what to do about monitoring. We do this so that
509 on a transition between monitoring states we get a de-clicking gain
510 change in the _main_outs delivery, if config.get_use_monitor_fades()
513 We override this in the case where we have an internal generator.
515 bool silence = _have_internal_generator ? false : (monitoring_state () == MonitoringSilence);
517 _main_outs->no_outs_cuz_we_no_monitor (silence);
519 /* -------------------------------------------------------------------------------------------
520 GLOBAL DECLICK (for transport changes etc.)
521 ----------------------------------------------------------------------------------------- */
523 maybe_declick (bufs, nframes, declick);
524 _pending_declick = 0;
526 /* -------------------------------------------------------------------------------------------
527 DENORMAL CONTROL/PHASE INVERT
528 ----------------------------------------------------------------------------------------- */
530 if (_phase_invert.any ()) {
534 if (_denormal_protection || Config->get_denormal_protection()) {
536 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
537 Sample* const sp = i->data();
539 if (_phase_invert[chn]) {
540 for (pframes_t nx = 0; nx < nframes; ++nx) {
545 for (pframes_t nx = 0; nx < nframes; ++nx) {
553 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
554 Sample* const sp = i->data();
556 if (_phase_invert[chn]) {
557 for (pframes_t nx = 0; nx < nframes; ++nx) {
566 if (_denormal_protection || Config->get_denormal_protection()) {
568 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
569 Sample* const sp = i->data();
570 for (pframes_t nx = 0; nx < nframes; ++nx) {
578 /* -------------------------------------------------------------------------------------------
580 ----------------------------------------------------------------------------------------- */
582 /* set this to be true if the meter will already have been ::run() earlier */
583 bool const meter_already_run = metering_state() == MeteringInput;
585 framecnt_t latency = 0;
587 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
589 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
590 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
595 /* if it has any inputs, make sure they match */
596 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
597 if (bufs.count() != (*i)->input_streams()) {
599 DEBUG::Processors, string_compose (
600 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
601 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
608 /* should we NOT run plugins here if the route is inactive?
609 do we catch route != active somewhere higher?
612 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
613 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
616 (*i)->run (bufs, start_frame - latency, end_frame - latency, nframes, *i != _processors.back());
617 bufs.set_count ((*i)->output_streams());
619 if ((*i)->active ()) {
620 latency += (*i)->signal_latency ();
626 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
627 boost::shared_ptr<Processor> endpoint,
628 bool include_endpoint, bool for_export, bool for_freeze)
630 /* If no processing is required, there's no need to go any further. */
631 if (!endpoint && !include_endpoint) {
635 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
636 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
637 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
639 /* trim is always at the top, for bounce no latency compensation is needed */
640 _trim->set_gain_automation_buffer (_session.trim_automation_buffer ());
641 _trim->setup_gain_automation (start, start + nframes, nframes);
644 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
646 if (!include_endpoint && (*i) == endpoint) {
650 /* if we're not exporting, stop processing if we come across a routing processor. */
651 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
654 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
658 /* don't run any processors that does routing.
659 * oh, and don't bother with the peak meter either.
661 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
662 (*i)->run (buffers, start - latency, start - latency + nframes, nframes, true);
663 buffers.set_count ((*i)->output_streams());
664 latency += (*i)->signal_latency ();
667 if ((*i) == endpoint) {
674 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
675 bool include_endpoint, bool for_export, bool for_freeze) const
677 framecnt_t latency = 0;
678 if (!endpoint && !include_endpoint) {
682 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
683 if (!include_endpoint && (*i) == endpoint) {
686 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
689 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
692 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
693 latency += (*i)->signal_latency ();
695 if ((*i) == endpoint) {
703 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
704 bool include_endpoint, bool for_export, bool for_freeze) const
706 if (!endpoint && !include_endpoint) {
710 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
711 if (!include_endpoint && (*i) == endpoint) {
714 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
717 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
720 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
721 cc = (*i)->output_streams();
723 if ((*i) == endpoint) {
731 Route::n_process_buffers ()
733 return max (_input->n_ports(), processor_max_streams);
737 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
739 assert (is_monitor());
740 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
741 fill_buffers_with_input (bufs, _input, nframes);
742 passthru (bufs, start_frame, end_frame, nframes, declick);
746 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
750 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
752 /* control/monitor bus ignores input ports when something is
753 feeding the listen "stream". data will "arrive" into the
754 route from the intreturn processor element.
757 bufs.silence (nframes, 0);
760 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
761 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
765 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
767 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
769 bufs.set_count (_input->n_ports());
770 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
771 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
775 Route::set_listen (bool yn, void* src, bool group_override)
781 bool group_active = _route_group && _route_group->is_active() && _route_group->is_solo();
782 if (group_override && _route_group) {
783 group_active = !group_active;
786 if (_route_group && src != _route_group && group_active) {
787 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group, group_override));
792 if (yn != _monitor_send->active()) {
794 _monitor_send->activate ();
795 _mute_master->set_soloed_by_self (true);
797 _monitor_send->deactivate ();
798 _mute_master->set_soloed_by_self (false);
800 _mute_master->set_soloed_by_others (false);
802 listen_changed (src, group_override); /* EMIT SIGNAL */
808 Route::listening_via_monitor () const
811 return _monitor_send->active ();
818 Route::set_solo_safe (bool yn, void *src)
820 if (_solo_safe != yn) {
822 solo_safe_changed (src);
827 Route::solo_safe() const
833 Route::clear_all_solo_state ()
835 // ideally this function will never do anything, it only exists to forestall Murphy
836 bool emit_changed = false;
839 // these are really debug messages, but of possible interest.
841 PBD::info << string_compose (_("Cleared Explicit solo: %1\n"), name());
843 if (_soloed_by_others_upstream || _soloed_by_others_downstream) {
844 PBD::info << string_compose (_("Cleared Implicit solo: %1 up:%2 down:%3\n"),
845 name(), _soloed_by_others_upstream, _soloed_by_others_downstream);
849 if (!_self_solo && (_soloed_by_others_upstream || _soloed_by_others_downstream)) {
850 // if self-soled, set_solo() will do signal emission
854 _soloed_by_others_upstream = 0;
855 _soloed_by_others_downstream = 0;
858 PBD::Unwinder<bool> uw (_solo_safe, false);
859 set_solo (false, this);
863 set_mute_master_solo ();
864 solo_changed (false, this, false); /* EMIT SIGNAL */
869 Route::set_solo (bool yn, void *src, bool group_override)
872 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change due to solo-safe\n", name()));
876 if (is_master() || is_monitor() || is_auditioner()) {
877 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change (master, monitor or auditioner)\n", name()));
881 bool group_active = _route_group && _route_group->is_active() && _route_group->is_solo();
882 if (group_override && _route_group) {
883 group_active = !group_active;
885 if (_route_group && src != _route_group && group_active) {
886 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group, group_override));
890 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set solo => %2, src: %3 grp ? %4 currently self-soloed ? %5\n",
891 name(), yn, src, (src == _route_group), self_soloed()));
893 if (self_soloed() != yn) {
895 solo_changed (true, src, group_override); /* EMIT SIGNAL */
896 _solo_control->Changed (); /* EMIT SIGNAL */
899 assert (Config->get_solo_control_is_listen_control() || !_monitor_send || !_monitor_send->active());
901 /* XXX TRACKS DEVELOPERS: THIS LOGIC SUGGESTS THAT YOU ARE NOT AWARE OF
902 Config->get_solo_mute_overrride().
905 if (yn && Profile->get_trx()) {
906 set_mute (false, src);
911 Route::set_self_solo (bool yn)
913 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set SELF solo => %2\n", name(), yn));
915 set_mute_master_solo ();
919 Route::mod_solo_by_others_upstream (int32_t delta)
921 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-upstream by %2, current up = %3 down = %4\n",
922 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
924 uint32_t old_sbu = _soloed_by_others_upstream;
927 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
928 _soloed_by_others_upstream += delta;
930 _soloed_by_others_upstream = 0;
933 _soloed_by_others_upstream += delta;
936 DEBUG_TRACE (DEBUG::Solo, string_compose (
937 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
938 name(), delta, _soloed_by_others_upstream, old_sbu,
939 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
941 /* push the inverse solo change to everything that feeds us.
943 This is important for solo-within-group. When we solo 1 track out of N that
944 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
945 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
946 tracks that feed it. This will silence them if they were audible because
947 of a bus solo, but the newly soloed track will still be audible (because
950 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
954 if ((_self_solo || _soloed_by_others_downstream) &&
955 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
956 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
958 if (delta > 0 || !Config->get_exclusive_solo()) {
959 DEBUG_TRACE (DEBUG::Solo, string_compose("\t ... INVERT push from %1\n", _name));
960 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
964 boost::shared_ptr<Route> sr = i->r.lock();
966 sr->mod_solo_by_others_downstream (-delta);
972 set_mute_master_solo ();
973 solo_changed (false, this, false); /* EMIT SIGNAL */
977 Route::mod_solo_by_others_downstream (int32_t delta)
979 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-downstream by %2, current up = %3 down = %4\n",
980 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
983 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
984 _soloed_by_others_downstream += delta;
986 _soloed_by_others_downstream = 0;
989 _soloed_by_others_downstream += delta;
992 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
994 set_mute_master_solo ();
995 solo_changed (false, this, false); /* EMIT SIGNAL */
999 Route::set_mute_master_solo ()
1001 _mute_master->set_soloed_by_self (self_soloed());
1002 _mute_master->set_soloed_by_others (soloed_by_others_downstream() || soloed_by_others_upstream());
1006 Route::mod_solo_isolated_by_upstream (bool yn, void* src)
1008 bool old = solo_isolated ();
1009 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod_solo_isolated_by_upstream cur: %2 d: %3\n",
1010 name(), _solo_isolated_by_upstream, yn ? "+1" : "-1"));
1013 if (_solo_isolated_by_upstream >= 1) {
1014 _solo_isolated_by_upstream--;
1016 _solo_isolated_by_upstream = 0;
1019 _solo_isolated_by_upstream++;
1022 if (solo_isolated() != old) {
1023 /* solo isolated status changed */
1024 _mute_master->set_solo_ignore (solo_isolated());
1025 solo_isolated_changed (src); /* EMIT SIGNAL */
1030 Route::set_solo_isolated (bool yn, void *src)
1032 if (is_master() || is_monitor() || is_auditioner()) {
1036 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
1037 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
1041 bool changed = false;
1044 if (_solo_isolated == false) {
1045 _mute_master->set_solo_ignore (true);
1048 _solo_isolated = true;
1050 if (_solo_isolated == true) {
1051 _solo_isolated = false;
1052 _mute_master->set_solo_ignore (false);
1062 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
1064 boost::shared_ptr<RouteList> routes = _session.get_routes ();
1065 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
1067 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
1072 bool does_feed = feeds (*i, &sends_only);
1074 if (does_feed && !sends_only) {
1075 (*i)->mod_solo_isolated_by_upstream (yn, src);
1079 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
1081 solo_isolated_changed (src); /* EMIT SIGNAL */
1085 Route::solo_isolated () const
1087 return (_solo_isolated == true) || (_solo_isolated_by_upstream > 0);
1091 Route::set_mute_points (MuteMaster::MutePoint mp)
1093 _mute_master->set_mute_points (mp);
1094 mute_points_changed (); /* EMIT SIGNAL */
1096 if (_mute_master->muted_by_self()) {
1097 mute_changed (this); /* EMIT SIGNAL */
1098 _mute_control->Changed (); /* EMIT SIGNAL */
1103 Route::set_mute (bool yn, void *src)
1105 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
1106 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
1110 if (muted() != yn) {
1111 _mute_master->set_muted_by_self (yn);
1112 /* allow any derived classes to respond to the mute change
1113 before anybody else knows about it.
1116 /* tell everyone else */
1117 mute_changed (src); /* EMIT SIGNAL */
1118 _mute_control->Changed (); /* EMIT SIGNAL */
1123 Route::muted () const
1125 return _mute_master->muted_by_self();
1129 Route::muted_by_others () const
1131 // This method is only used by route_ui for display state.
1132 // The real thing is MuteMaster::muted_by_others_at()
1134 //master is never muted by others
1138 //now check to see if something is soloed (and I am not)
1139 //see also MuteMaster::mute_gain_at()
1140 return (_session.soloing() && !soloed() && !solo_isolated());
1145 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
1147 cerr << name << " {" << endl;
1148 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
1149 p != procs.end(); ++p) {
1150 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
1152 cerr << "}" << endl;
1156 /** Supposing that we want to insert a Processor at a given Placement, return
1157 * the processor to add the new one before (or 0 to add at the end).
1159 boost::shared_ptr<Processor>
1160 Route::before_processor_for_placement (Placement p)
1162 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1164 ProcessorList::iterator loc;
1166 if (p == PreFader) {
1167 /* generic pre-fader: insert immediately before the amp */
1168 loc = find (_processors.begin(), _processors.end(), _amp);
1170 /* generic post-fader: insert right before the main outs */
1171 loc = find (_processors.begin(), _processors.end(), _main_outs);
1174 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
1177 /** Supposing that we want to insert a Processor at a given index, return
1178 * the processor to add the new one before (or 0 to add at the end).
1180 boost::shared_ptr<Processor>
1181 Route::before_processor_for_index (int index)
1184 return boost::shared_ptr<Processor> ();
1187 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1189 ProcessorList::iterator i = _processors.begin ();
1191 while (i != _processors.end() && j < index) {
1192 if ((*i)->display_to_user()) {
1199 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
1202 /** Add a processor either pre- or post-fader
1203 * @return 0 on success, non-0 on failure.
1206 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
1208 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
1212 /** Add a processor to a route such that it ends up with a given index into the visible processors.
1213 * @param index Index to add the processor at, or -1 to add at the end of the list.
1214 * @return 0 on success, non-0 on failure.
1217 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
1219 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
1222 /** Add a processor to the route.
1223 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
1224 * @return 0 on success, non-0 on failure.
1227 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
1229 assert (processor != _meter);
1230 assert (processor != _main_outs);
1232 DEBUG_TRACE (DEBUG::Processors, string_compose (
1233 "%1 adding processor %2\n", name(), processor->name()));
1235 if (!AudioEngine::instance()->connected() || !processor) {
1240 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1241 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1242 ProcessorState pstate (this);
1244 boost::shared_ptr<PluginInsert> pi;
1245 boost::shared_ptr<PortInsert> porti;
1247 if (processor == _amp) {
1248 /* Ensure that only one amp is in the list at any time */
1249 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), processor);
1250 if (check != _processors.end()) {
1251 if (before == _amp) {
1252 /* Already in position; all is well */
1255 _processors.erase (check);
1260 assert (find (_processors.begin(), _processors.end(), processor) == _processors.end ());
1262 ProcessorList::iterator loc;
1264 /* inserting before a processor; find it */
1265 loc = find (_processors.begin(), _processors.end(), before);
1266 if (loc == _processors.end ()) {
1271 /* inserting at end */
1272 loc = _processors.end ();
1275 _processors.insert (loc, processor);
1276 processor->set_owner (this);
1278 // Set up processor list channels. This will set processor->[input|output]_streams(),
1279 // configure redirect ports properly, etc.
1282 if (configure_processors_unlocked (err)) {
1284 configure_processors_unlocked (0); // it worked before we tried to add it ...
1289 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1291 if (pi->has_no_inputs ()) {
1292 /* generator plugin */
1293 _have_internal_generator = true;
1298 if (activation_allowed && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user ())) {
1299 processor->activate ();
1302 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1304 _output->set_user_latency (0);
1307 reset_instrument_info ();
1308 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1309 set_processor_positions ();
1315 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1317 const XMLProperty *prop;
1320 boost::shared_ptr<Processor> processor;
1322 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1323 so that we can add the processor in the right place (pre/post-fader)
1326 XMLNodeList const & children = node.children ();
1327 XMLNodeList::const_iterator i = children.begin ();
1329 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1333 Placement placement = PreFader;
1335 if (i != children.end()) {
1336 if ((prop = (*i)->property (X_("placement"))) != 0) {
1337 placement = Placement (string_2_enum (prop->value(), placement));
1341 if (node.name() == "Insert") {
1343 if ((prop = node.property ("type")) != 0) {
1345 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1346 prop->value() == "lv2" ||
1347 prop->value() == "windows-vst" ||
1348 prop->value() == "lxvst" ||
1349 prop->value() == "audiounit") {
1351 if (_session.get_disable_all_loaded_plugins ()) {
1352 processor.reset (new UnknownProcessor (_session, node));
1354 processor.reset (new PluginInsert (_session));
1359 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1364 } else if (node.name() == "Send") {
1366 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
1367 processor.reset (new Send (_session, sendpan, _mute_master));
1371 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1375 if (processor->set_state (node, version)) {
1379 //A2 uses the "active" flag in the toplevel redirect node, not in the child plugin/IO
1380 if (i != children.end()) {
1381 if ((prop = (*i)->property (X_("active"))) != 0) {
1382 if ( string_is_affirmative (prop->value()) && (!_session.get_bypass_all_loaded_plugins () || !processor->display_to_user () ) )
1383 processor->activate();
1385 processor->deactivate();
1389 return (add_processor (processor, placement, 0, false) == 0);
1392 catch (failed_constructor &err) {
1393 warning << _("processor could not be created. Ignored.") << endmsg;
1399 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1401 /* NOTE: this is intended to be used ONLY when copying
1402 processors from another Route. Hence the subtle
1403 differences between this and ::add_processor()
1406 ProcessorList::iterator loc;
1409 loc = find(_processors.begin(), _processors.end(), before);
1411 /* nothing specified - at end */
1412 loc = _processors.end ();
1415 if (!_session.engine().connected()) {
1419 if (others.empty()) {
1424 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1425 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1426 ProcessorState pstate (this);
1428 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1434 boost::shared_ptr<PluginInsert> pi;
1436 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1440 _processors.insert (loc, *i);
1441 (*i)->set_owner (this);
1443 if ((*i)->active()) {
1447 /* Think: does this really need to be called for every processor in the loop? */
1449 if (configure_processors_unlocked (err)) {
1451 configure_processors_unlocked (0); // it worked before we tried to add it ...
1456 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1459 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1460 boost::shared_ptr<PluginInsert> pi;
1462 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1463 if (pi->has_no_inputs ()) {
1464 _have_internal_generator = true;
1470 _output->set_user_latency (0);
1473 reset_instrument_info ();
1474 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1475 set_processor_positions ();
1481 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1483 if (p == PreFader) {
1484 start = _processors.begin();
1485 end = find(_processors.begin(), _processors.end(), _amp);
1487 start = find(_processors.begin(), _processors.end(), _amp);
1489 end = _processors.end();
1493 /** Turn off all processors with a given placement
1494 * @param p Placement of processors to disable
1497 Route::disable_processors (Placement p)
1499 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1501 ProcessorList::iterator start, end;
1502 placement_range(p, start, end);
1504 for (ProcessorList::iterator i = start; i != end; ++i) {
1505 (*i)->deactivate ();
1508 _session.set_dirty ();
1511 /** Turn off all redirects
1514 Route::disable_processors ()
1516 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1518 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1519 (*i)->deactivate ();
1522 _session.set_dirty ();
1525 /** Turn off all redirects with a given placement
1526 * @param p Placement of redirects to disable
1529 Route::disable_plugins (Placement p)
1531 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1533 ProcessorList::iterator start, end;
1534 placement_range(p, start, end);
1536 for (ProcessorList::iterator i = start; i != end; ++i) {
1537 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1538 (*i)->deactivate ();
1542 _session.set_dirty ();
1545 /** Turn off all plugins
1548 Route::disable_plugins ()
1550 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1552 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1553 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1554 (*i)->deactivate ();
1558 _session.set_dirty ();
1563 Route::ab_plugins (bool forward)
1565 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1569 /* forward = turn off all active redirects, and mark them so that the next time
1570 we go the other way, we will revert them
1573 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1574 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1578 if ((*i)->active()) {
1579 (*i)->deactivate ();
1580 (*i)->set_next_ab_is_active (true);
1582 (*i)->set_next_ab_is_active (false);
1588 /* backward = if the redirect was marked to go active on the next ab, do so */
1590 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1592 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1596 if ((*i)->get_next_ab_is_active()) {
1599 (*i)->deactivate ();
1604 _session.set_dirty ();
1608 /** Remove processors with a given placement.
1609 * @param p Placement of processors to remove.
1612 Route::clear_processors (Placement p)
1614 if (!_session.engine().connected()) {
1618 bool already_deleting = _session.deletion_in_progress();
1619 if (!already_deleting) {
1620 _session.set_deletion_in_progress();
1624 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1625 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1626 ProcessorList new_list;
1627 ProcessorStreams err;
1628 bool seen_amp = false;
1630 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1636 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline || (*i) == _trim) {
1638 /* you can't remove these */
1640 new_list.push_back (*i);
1647 new_list.push_back (*i);
1650 (*i)->drop_references ();
1658 (*i)->drop_references ();
1661 new_list.push_back (*i);
1668 _processors = new_list;
1669 configure_processors_unlocked (&err); // this can't fail
1672 processor_max_streams.reset();
1673 _have_internal_generator = false;
1674 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1675 set_processor_positions ();
1677 reset_instrument_info ();
1679 if (!already_deleting) {
1680 _session.clear_deletion_in_progress();
1685 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1687 // TODO once the export point can be configured properly, do something smarter here
1688 if (processor == _capturing_processor) {
1689 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1690 if (need_process_lock) {
1694 _capturing_processor.reset();
1696 if (need_process_lock) {
1701 /* these can never be removed */
1703 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1707 if (!_session.engine().connected()) {
1711 processor_max_streams.reset();
1714 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1715 if (need_process_lock) {
1719 /* Caller must hold process lock */
1720 assert (!AudioEngine::instance()->process_lock().trylock());
1722 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1724 ProcessorState pstate (this);
1726 ProcessorList::iterator i;
1727 bool removed = false;
1729 for (i = _processors.begin(); i != _processors.end(); ) {
1730 if (*i == processor) {
1732 /* move along, see failure case for configure_processors()
1733 where we may need to reconfigure the processor.
1736 /* stop redirects that send signals to JACK ports
1737 from causing noise as a result of no longer being
1741 boost::shared_ptr<IOProcessor> iop;
1743 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1747 i = _processors.erase (i);
1755 _output->set_user_latency (0);
1763 if (configure_processors_unlocked (err)) {
1765 /* we know this will work, because it worked before :) */
1766 configure_processors_unlocked (0);
1770 _have_internal_generator = false;
1772 for (i = _processors.begin(); i != _processors.end(); ++i) {
1773 boost::shared_ptr<PluginInsert> pi;
1775 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1776 if (pi->has_no_inputs ()) {
1777 _have_internal_generator = true;
1782 if (need_process_lock) {
1787 reset_instrument_info ();
1788 processor->drop_references ();
1789 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1790 set_processor_positions ();
1796 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1798 ProcessorList deleted;
1800 if (!_session.engine().connected()) {
1804 processor_max_streams.reset();
1807 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1808 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1809 ProcessorState pstate (this);
1811 ProcessorList::iterator i;
1812 boost::shared_ptr<Processor> processor;
1814 for (i = _processors.begin(); i != _processors.end(); ) {
1818 /* these can never be removed */
1820 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline || processor == _trim) {
1825 /* see if its in the list of processors to delete */
1827 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1832 /* stop IOProcessors that send to JACK ports
1833 from causing noise as a result of no longer being
1837 boost::shared_ptr<IOProcessor> iop;
1839 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1843 deleted.push_back (processor);
1844 i = _processors.erase (i);
1847 if (deleted.empty()) {
1848 /* none of those in the requested list were found */
1852 _output->set_user_latency (0);
1854 if (configure_processors_unlocked (err)) {
1856 /* we know this will work, because it worked before :) */
1857 configure_processors_unlocked (0);
1862 _have_internal_generator = false;
1864 for (i = _processors.begin(); i != _processors.end(); ++i) {
1865 boost::shared_ptr<PluginInsert> pi;
1867 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1868 if (pi->has_no_inputs ()) {
1869 _have_internal_generator = true;
1876 /* now try to do what we need to so that those that were removed will be deleted */
1878 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1879 (*i)->drop_references ();
1882 reset_instrument_info ();
1883 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1884 set_processor_positions ();
1890 Route::reset_instrument_info ()
1892 boost::shared_ptr<Processor> instr = the_instrument();
1894 _instrument_info.set_internal_instrument (instr);
1898 /** Caller must hold process lock */
1900 Route::configure_processors (ProcessorStreams* err)
1902 #ifndef PLATFORM_WINDOWS
1903 assert (!AudioEngine::instance()->process_lock().trylock());
1906 if (!_in_configure_processors) {
1907 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1908 return configure_processors_unlocked (err);
1915 Route::input_streams () const
1917 return _input->n_ports ();
1920 list<pair<ChanCount, ChanCount> >
1921 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1923 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1925 return try_configure_processors_unlocked (in, err);
1928 list<pair<ChanCount, ChanCount> >
1929 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1931 // Check each processor in order to see if we can configure as requested
1933 list<pair<ChanCount, ChanCount> > configuration;
1936 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1937 DEBUG_TRACE (DEBUG::Processors, "{\n");
1939 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1941 if ((*p)->can_support_io_configuration(in, out)) {
1942 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1943 configuration.push_back(make_pair(in, out));
1950 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1951 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1952 DEBUG_TRACE (DEBUG::Processors, "}\n");
1953 return list<pair<ChanCount, ChanCount> > ();
1957 DEBUG_TRACE (DEBUG::Processors, "}\n");
1959 return configuration;
1962 /** Set the input/output configuration of each processor in the processors list.
1963 * Caller must hold process lock.
1964 * Return 0 on success, otherwise configuration is impossible.
1967 Route::configure_processors_unlocked (ProcessorStreams* err)
1969 #ifndef PLATFORM_WINDOWS
1970 assert (!AudioEngine::instance()->process_lock().trylock());
1973 if (_in_configure_processors) {
1977 /* put invisible processors where they should be */
1978 setup_invisible_processors ();
1980 _in_configure_processors = true;
1982 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1984 if (configuration.empty ()) {
1985 _in_configure_processors = false;
1990 bool seen_mains_out = false;
1991 processor_out_streams = _input->n_ports();
1992 processor_max_streams.reset();
1994 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1995 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1997 if (!(*p)->configure_io(c->first, c->second)) {
1998 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration failed\n", _name));
2000 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
2001 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
2003 boost::shared_ptr<PluginInsert> pi;
2004 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*p)) != 0) {
2005 /* plugins connected via Split Match may have more channels.
2006 * route/scratch buffers are needed for all of them*/
2007 processor_max_streams = ChanCount::max(processor_max_streams, pi->input_streams());
2008 processor_max_streams = ChanCount::max(processor_max_streams, pi->natural_input_streams());
2012 if (boost::dynamic_pointer_cast<Delivery> (*p)
2013 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
2014 /* main delivery will increase port count to match input.
2015 * the Delivery::Main is usually the last processor - followed only by
2018 seen_mains_out = true;
2020 if (!seen_mains_out) {
2021 processor_out_streams = out;
2027 _meter->set_max_channels (processor_max_streams);
2030 /* make sure we have sufficient scratch buffers to cope with the new processor
2033 _session.ensure_buffers (n_process_buffers ());
2035 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
2037 _in_configure_processors = false;
2041 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
2042 * @param state New active state for those processors.
2045 Route::all_visible_processors_active (bool state)
2047 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2049 if (_processors.empty()) {
2053 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2054 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
2061 (*i)->deactivate ();
2065 _session.set_dirty ();
2069 Route::processors_reorder_needs_configure (const ProcessorList& new_order)
2071 /* check if re-order requires re-configuration of any processors
2072 * -> compare channel configuration for all processors
2074 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2075 ChanCount c = input_streams ();
2077 for (ProcessorList::const_iterator j = new_order.begin(); j != new_order.end(); ++j) {
2079 if (c != (*j)->input_streams()) {
2082 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2085 if ((*i)->input_streams() != c) {
2088 c = (*i)->output_streams();
2100 __attribute__((annotate("realtime")))
2103 Route::apply_processor_order (const ProcessorList& new_order)
2105 /* need to hold processor_lock; either read or write lock
2106 * and the engine process_lock.
2107 * Due to r/w lock ambiguity we can only assert the latter
2109 assert (!AudioEngine::instance()->process_lock().trylock());
2112 /* "new_order" is an ordered list of processors to be positioned according to "placement".
2113 * NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
2114 * processors in the current actual processor list that are hidden. Any visible processors
2115 * in the current list but not in "new_order" will be assumed to be deleted.
2118 /* "as_it_will_be" and "_processors" are lists of shared pointers.
2119 * actual memory usage is small, but insert/erase is not actually rt-safe :(
2120 * (note though that ::processors_reorder_needs_configure() ensured that
2121 * this function will only ever be called from the rt-thread if no processor were removed)
2123 * either way, I can't proove it, but an x-run due to re-order here is less likley
2124 * than an x-run-less 'ardour-silent cycle' both of which effectively "click".
2127 ProcessorList as_it_will_be;
2128 ProcessorList::iterator oiter;
2129 ProcessorList::const_iterator niter;
2131 oiter = _processors.begin();
2132 niter = new_order.begin();
2134 while (niter != new_order.end()) {
2136 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
2137 then append it to the temp list.
2139 Otherwise, see if the next processor in the old list is in the new list. if not,
2140 its been deleted. If its there, append it to the temp list.
2143 if (oiter == _processors.end()) {
2145 /* no more elements in the old list, so just stick the rest of
2146 the new order onto the temp list.
2149 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
2150 while (niter != new_order.end()) {
2157 if (!(*oiter)->display_to_user()) {
2159 as_it_will_be.push_back (*oiter);
2163 /* visible processor: check that its in the new order */
2165 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
2166 /* deleted: do nothing, shared_ptr<> will clean up */
2168 /* ignore this one, and add the next item from the new order instead */
2169 as_it_will_be.push_back (*niter);
2174 /* now remove from old order - its taken care of no matter what */
2175 oiter = _processors.erase (oiter);
2179 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
2181 /* If the meter is in a custom position, find it and make a rough note of its position */
2182 maybe_note_meter_position ();
2186 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
2188 // it a change is already queued, wait for it
2189 // (unless engine is stopped. apply immediately and proceed
2190 while (g_atomic_int_get (&_pending_process_reorder)) {
2191 if (!AudioEngine::instance()->running()) {
2192 DEBUG_TRACE (DEBUG::Processors, "offline apply queued processor re-order.\n");
2193 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2195 apply_processor_order(_pending_processor_order);
2196 setup_invisible_processors ();
2198 g_atomic_int_set (&_pending_process_reorder, 0);
2200 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2201 set_processor_positions ();
2203 // TODO rather use a semaphore or something.
2204 // but since ::reorder_processors() is called
2205 // from the GUI thread, this is fine..
2210 if (processors_reorder_needs_configure (new_order) || !AudioEngine::instance()->running()) {
2212 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2213 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2214 ProcessorState pstate (this);
2216 apply_processor_order (new_order);
2218 if (configure_processors_unlocked (err)) {
2226 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2227 set_processor_positions ();
2230 DEBUG_TRACE (DEBUG::Processors, "Queue clickless processor re-order.\n");
2231 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2233 // _pending_processor_order is protected by _processor_lock
2234 _pending_processor_order = new_order;
2235 g_atomic_int_set (&_pending_process_reorder, 1);
2248 Route::get_template()
2250 return state(false);
2254 Route::state(bool full_state)
2256 XMLNode *node = new XMLNode("Route");
2257 ProcessorList::iterator i;
2260 id().print (buf, sizeof (buf));
2261 node->add_property("id", buf);
2262 node->add_property ("name", _name);
2263 node->add_property("default-type", _default_type.to_string());
2266 node->add_property("flags", enum_2_string (_flags));
2269 node->add_property("active", _active?"yes":"no");
2271 boost::to_string (_phase_invert, p);
2272 node->add_property("phase-invert", p);
2273 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2274 node->add_property("meter-point", enum_2_string (_meter_point));
2276 node->add_property("meter-type", enum_2_string (_meter_type));
2279 node->add_property("route-group", _route_group->name());
2282 snprintf (buf, sizeof (buf), "%d", _order_key);
2283 node->add_property ("order-key", buf);
2284 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
2285 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
2286 node->add_property ("soloed-by-upstream", buf);
2287 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
2288 node->add_property ("soloed-by-downstream", buf);
2289 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
2290 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
2292 node->add_child_nocopy (_input->state (full_state));
2293 node->add_child_nocopy (_output->state (full_state));
2294 node->add_child_nocopy (_solo_control->get_state ());
2295 node->add_child_nocopy (_mute_control->get_state ());
2296 node->add_child_nocopy (_mute_master->get_state ());
2299 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2302 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
2303 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
2304 remote_control_node->add_property (X_("id"), buf);
2305 node->add_child_nocopy (*remote_control_node);
2307 if (_comment.length()) {
2308 XMLNode *cmt = node->add_child ("Comment");
2309 cmt->add_content (_comment);
2313 node->add_child_nocopy (_pannable->state (full_state));
2316 for (i = _processors.begin(); i != _processors.end(); ++i) {
2318 /* template save: do not include internal sends functioning as
2319 aux sends because the chance of the target ID
2320 in the session where this template is used
2323 similarly, do not save listen sends which connect to
2324 the monitor section, because these will always be
2327 boost::shared_ptr<InternalSend> is;
2329 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2330 if (is->role() == Delivery::Listen) {
2335 node->add_child_nocopy((*i)->state (full_state));
2339 node->add_child_copy (*_extra_xml);
2342 if (_custom_meter_position_noted) {
2343 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2345 after->id().print (buf, sizeof (buf));
2346 node->add_property (X_("processor-after-last-custom-meter"), buf);
2354 Route::set_state (const XMLNode& node, int version)
2356 if (version < 3000) {
2357 return set_state_2X (node, version);
2361 XMLNodeConstIterator niter;
2363 const XMLProperty *prop;
2365 if (node.name() != "Route"){
2366 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2370 if ((prop = node.property (X_("name"))) != 0) {
2371 Route::set_name (prop->value());
2375 _initial_io_setup = true;
2377 if ((prop = node.property (X_("flags"))) != 0) {
2378 _flags = Flag (string_2_enum (prop->value(), _flags));
2383 if (is_master() || is_monitor() || is_auditioner()) {
2384 _mute_master->set_solo_ignore (true);
2388 /* monitor bus does not get a panner, but if (re)created
2389 via XML, it will already have one by the time we
2390 call ::set_state(). so ... remove it.
2395 /* add all processors (except amp, which is always present) */
2397 nlist = node.children();
2398 XMLNode processor_state (X_("processor_state"));
2400 Stateful::save_extra_xml (node);
2402 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2406 if (child->name() == IO::state_node_name) {
2407 if ((prop = child->property (X_("direction"))) == 0) {
2411 if (prop->value() == "Input") {
2412 _input->set_state (*child, version);
2413 } else if (prop->value() == "Output") {
2414 _output->set_state (*child, version);
2418 if (child->name() == X_("Processor")) {
2419 processor_state.add_child_copy (*child);
2422 if (child->name() == X_("Pannable")) {
2424 _pannable->set_state (*child, version);
2426 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2431 if ((prop = node.property (X_("meter-point"))) != 0) {
2432 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2433 set_meter_point (mp, true);
2435 _meter->set_display_to_user (_meter_point == MeterCustom);
2439 if ((prop = node.property (X_("meter-type"))) != 0) {
2440 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2443 _initial_io_setup = false;
2445 set_processor_state (processor_state);
2447 // this looks up the internal instrument in processors
2448 reset_instrument_info();
2450 if ((prop = node.property ("self-solo")) != 0) {
2451 set_self_solo (string_is_affirmative (prop->value()));
2454 if ((prop = node.property ("soloed-by-upstream")) != 0) {
2455 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
2456 mod_solo_by_others_upstream (atoi (prop->value()));
2459 if ((prop = node.property ("soloed-by-downstream")) != 0) {
2460 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
2461 mod_solo_by_others_downstream (atoi (prop->value()));
2464 if ((prop = node.property ("solo-isolated")) != 0) {
2465 set_solo_isolated (string_is_affirmative (prop->value()), this);
2468 if ((prop = node.property ("solo-safe")) != 0) {
2469 set_solo_safe (string_is_affirmative (prop->value()), this);
2472 if ((prop = node.property (X_("phase-invert"))) != 0) {
2473 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2476 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2477 set_denormal_protection (string_is_affirmative (prop->value()));
2480 if ((prop = node.property (X_("active"))) != 0) {
2481 bool yn = string_is_affirmative (prop->value());
2482 _active = !yn; // force switch
2483 set_active (yn, this);
2486 if ((prop = node.property (X_("order-key"))) != 0) { // New order key (no separate mixer/editor ordering)
2487 set_order_key (atoi(prop->value()));
2490 if ((prop = node.property (X_("order-keys"))) != 0) { // Deprecated order keys
2494 string::size_type colon, equal;
2495 string remaining = prop->value();
2497 while (remaining.length()) {
2499 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2500 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2503 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2504 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2507 string keyname = remaining.substr (0, equal);
2509 if ((keyname == "EditorSort") || (keyname == "editor")) {
2510 cerr << "Setting " << name() << " order key to " << n << " using saved Editor order." << endl;
2516 colon = remaining.find_first_of (':');
2518 if (colon != string::npos) {
2519 remaining = remaining.substr (colon+1);
2526 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2527 PBD::ID id (prop->value ());
2528 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2529 ProcessorList::const_iterator i = _processors.begin ();
2530 while (i != _processors.end() && (*i)->id() != id) {
2534 if (i != _processors.end ()) {
2535 _processor_after_last_custom_meter = *i;
2536 _custom_meter_position_noted = true;
2540 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2543 if (child->name() == X_("Comment")) {
2545 /* XXX this is a terrible API design in libxml++ */
2547 XMLNode *cmt = *(child->children().begin());
2548 _comment = cmt->content();
2550 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2551 if (prop->value() == "solo") {
2552 _solo_control->set_state (*child, version);
2553 } else if (prop->value() == "mute") {
2554 _mute_control->set_state (*child, version);
2557 } else if (child->name() == X_("RemoteControl")) {
2558 if ((prop = child->property (X_("id"))) != 0) {
2560 sscanf (prop->value().c_str(), "%d", &x);
2561 set_remote_control_id_internal (x);
2564 } else if (child->name() == X_("MuteMaster")) {
2565 _mute_master->set_state (*child, version);
2567 } else if (child->name() == Automatable::xml_node_name) {
2568 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2576 Route::set_state_2X (const XMLNode& node, int version)
2578 LocaleGuard lg (X_("C"));
2580 XMLNodeConstIterator niter;
2582 const XMLProperty *prop;
2584 /* 2X things which still remain to be handled:
2590 if (node.name() != "Route") {
2591 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2595 if ((prop = node.property (X_("flags"))) != 0) {
2596 string f = prop->value ();
2597 boost::replace_all (f, "ControlOut", "MonitorOut");
2598 _flags = Flag (string_2_enum (f, _flags));
2603 if (is_master() || is_monitor() || is_auditioner()) {
2604 _mute_master->set_solo_ignore (true);
2607 if ((prop = node.property (X_("phase-invert"))) != 0) {
2608 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2609 if (string_is_affirmative (prop->value ())) {
2612 set_phase_invert (p);
2615 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2616 set_denormal_protection (string_is_affirmative (prop->value()));
2619 if ((prop = node.property (X_("soloed"))) != 0) {
2620 bool yn = string_is_affirmative (prop->value());
2622 /* XXX force reset of solo status */
2624 set_solo (yn, this);
2627 if ((prop = node.property (X_("muted"))) != 0) {
2630 bool muted = string_is_affirmative (prop->value());
2636 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2638 if (string_is_affirmative (prop->value())){
2639 mute_point = mute_point + "PreFader";
2644 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2646 if (string_is_affirmative (prop->value())){
2649 mute_point = mute_point + ",";
2652 mute_point = mute_point + "PostFader";
2657 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2659 if (string_is_affirmative (prop->value())){
2662 mute_point = mute_point + ",";
2665 mute_point = mute_point + "Listen";
2670 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2672 if (string_is_affirmative (prop->value())){
2675 mute_point = mute_point + ",";
2678 mute_point = mute_point + "Main";
2682 _mute_master->set_mute_points (mute_point);
2683 _mute_master->set_muted_by_self (true);
2687 if ((prop = node.property (X_("meter-point"))) != 0) {
2688 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2691 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2692 don't mean the same thing.
2695 if ((prop = node.property (X_("order-keys"))) != 0) {
2699 string::size_type colon, equal;
2700 string remaining = prop->value();
2702 while (remaining.length()) {
2704 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2705 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2708 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2709 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2712 string keyname = remaining.substr (0, equal);
2714 if (keyname == "EditorSort" || keyname == "editor") {
2715 info << string_compose(_("Converting deprecated order key for %1 using Editor order %2"), name (), n) << endmsg;
2721 colon = remaining.find_first_of (':');
2723 if (colon != string::npos) {
2724 remaining = remaining.substr (colon+1);
2733 nlist = node.children ();
2734 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2738 if (child->name() == IO::state_node_name) {
2740 /* there is a note in IO::set_state_2X() about why we have to call
2744 _input->set_state_2X (*child, version, true);
2745 _output->set_state_2X (*child, version, false);
2747 if ((prop = child->property (X_("name"))) != 0) {
2748 Route::set_name (prop->value ());
2753 if ((prop = child->property (X_("active"))) != 0) {
2754 bool yn = string_is_affirmative (prop->value());
2755 _active = !yn; // force switch
2756 set_active (yn, this);
2759 if ((prop = child->property (X_("gain"))) != 0) {
2762 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2763 _amp->gain_control()->set_value (val);
2767 /* Set up Panners in the IO */
2768 XMLNodeList io_nlist = child->children ();
2770 XMLNodeConstIterator io_niter;
2773 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2775 io_child = *io_niter;
2777 if (io_child->name() == X_("Panner")) {
2778 _main_outs->panner_shell()->set_state(*io_child, version);
2779 } else if (io_child->name() == X_("Automation")) {
2780 /* IO's automation is for the fader */
2781 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2787 XMLNodeList redirect_nodes;
2789 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2793 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2794 redirect_nodes.push_back(child);
2799 set_processor_state_2X (redirect_nodes, version);
2801 Stateful::save_extra_xml (node);
2803 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2806 if (child->name() == X_("Comment")) {
2808 /* XXX this is a terrible API design in libxml++ */
2810 XMLNode *cmt = *(child->children().begin());
2811 _comment = cmt->content();
2813 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2814 if (prop->value() == X_("solo")) {
2815 _solo_control->set_state (*child, version);
2816 } else if (prop->value() == X_("mute")) {
2817 _mute_control->set_state (*child, version);
2820 } else if (child->name() == X_("RemoteControl")) {
2821 if ((prop = child->property (X_("id"))) != 0) {
2823 sscanf (prop->value().c_str(), "%d", &x);
2824 set_remote_control_id_internal (x);
2834 Route::get_processor_state ()
2836 XMLNode* root = new XMLNode (X_("redirects"));
2837 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2838 root->add_child_nocopy ((*i)->state (true));
2845 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2847 /* We don't bother removing existing processors not in nList, as this
2848 method will only be called when creating a Route from scratch, not
2849 for undo purposes. Just put processors in at the appropriate place
2853 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2854 add_processor_from_xml_2X (**i, version);
2859 Route::set_processor_state (const XMLNode& node)
2861 const XMLNodeList &nlist = node.children();
2862 XMLNodeConstIterator niter;
2863 ProcessorList new_order;
2864 bool must_configure = false;
2866 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2868 XMLProperty* prop = (*niter)->property ("type");
2870 if (prop->value() == "amp") {
2871 _amp->set_state (**niter, Stateful::current_state_version);
2872 new_order.push_back (_amp);
2873 } else if (prop->value() == "trim") {
2874 _trim->set_state (**niter, Stateful::current_state_version);
2875 new_order.push_back (_trim);
2876 } else if (prop->value() == "meter") {
2877 _meter->set_state (**niter, Stateful::current_state_version);
2878 new_order.push_back (_meter);
2879 } else if (prop->value() == "delay") {
2881 _delayline->set_state (**niter, Stateful::current_state_version);
2882 new_order.push_back (_delayline);
2884 } else if (prop->value() == "main-outs") {
2885 _main_outs->set_state (**niter, Stateful::current_state_version);
2886 } else if (prop->value() == "intreturn") {
2888 _intreturn.reset (new InternalReturn (_session));
2889 must_configure = true;
2891 _intreturn->set_state (**niter, Stateful::current_state_version);
2892 } else if (is_monitor() && prop->value() == "monitor") {
2893 if (!_monitor_control) {
2894 _monitor_control.reset (new MonitorProcessor (_session));
2895 must_configure = true;
2897 _monitor_control->set_state (**niter, Stateful::current_state_version);
2898 } else if (prop->value() == "capture") {
2899 /* CapturingProcessor should never be restored, it's always
2900 added explicitly when needed */
2902 ProcessorList::iterator o;
2904 for (o = _processors.begin(); o != _processors.end(); ++o) {
2905 XMLProperty* id_prop = (*niter)->property(X_("id"));
2906 if (id_prop && (*o)->id() == id_prop->value()) {
2907 (*o)->set_state (**niter, Stateful::current_state_version);
2908 new_order.push_back (*o);
2913 // If the processor (*niter) is not on the route then create it
2915 if (o == _processors.end()) {
2917 boost::shared_ptr<Processor> processor;
2919 if (prop->value() == "intsend") {
2921 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2923 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2924 prop->value() == "lv2" ||
2925 prop->value() == "windows-vst" ||
2926 prop->value() == "lxvst" ||
2927 prop->value() == "audiounit") {
2929 if (_session.get_disable_all_loaded_plugins ()) {
2930 processor.reset (new UnknownProcessor (_session, **niter));
2932 processor.reset (new PluginInsert (_session));
2934 } else if (prop->value() == "port") {
2936 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2938 } else if (prop->value() == "send") {
2940 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2943 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2947 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2948 /* This processor could not be configured. Turn it into a UnknownProcessor */
2949 processor.reset (new UnknownProcessor (_session, **niter));
2952 /* we have to note the monitor send here, otherwise a new one will be created
2953 and the state of this one will be lost.
2955 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2956 if (isend && isend->role() == Delivery::Listen) {
2957 _monitor_send = isend;
2960 /* it doesn't matter if invisible processors are added here, as they
2961 will be sorted out by setup_invisible_processors () shortly.
2964 new_order.push_back (processor);
2965 must_configure = true;
2971 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2972 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2973 _processors = new_order;
2975 if (must_configure) {
2976 configure_processors_unlocked (0);
2979 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2981 (*i)->set_owner (this);
2982 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2984 boost::shared_ptr<PluginInsert> pi;
2986 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2987 if (pi->has_no_inputs ()) {
2988 _have_internal_generator = true;
2995 reset_instrument_info ();
2996 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
2997 set_processor_positions ();
3001 Route::curve_reallocate ()
3003 // _gain_automation_curve.finish_resize ();
3004 // _pan_automation_curve.finish_resize ();
3008 Route::silence (framecnt_t nframes)
3010 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3015 silence_unlocked (nframes);
3019 Route::silence_unlocked (framecnt_t nframes)
3021 /* Must be called with the processor lock held */
3025 _output->silence (nframes);
3027 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3028 boost::shared_ptr<PluginInsert> pi;
3030 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
3031 // skip plugins, they don't need anything when we're not active
3035 (*i)->silence (nframes);
3038 if (nframes == _session.get_block_size()) {
3045 Route::add_internal_return ()
3048 _intreturn.reset (new InternalReturn (_session));
3049 add_processor (_intreturn, PreFader);
3054 Route::add_send_to_internal_return (InternalSend* send)
3056 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3058 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3059 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3062 return d->add_send (send);
3068 Route::remove_send_from_internal_return (InternalSend* send)
3070 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3072 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
3073 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
3076 return d->remove_send (send);
3082 Route::enable_monitor_send ()
3084 /* Caller must hold process lock */
3085 assert (!AudioEngine::instance()->process_lock().trylock());
3087 /* master never sends to monitor section via the normal mechanism */
3088 assert (!is_master ());
3089 assert (!is_monitor ());
3091 /* make sure we have one */
3092 if (!_monitor_send) {
3093 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
3094 _monitor_send->set_display_to_user (false);
3098 configure_processors (0);
3101 /** Add an aux send to a route.
3102 * @param route route to send to.
3103 * @param before Processor to insert before, or 0 to insert at the end.
3106 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
3108 assert (route != _session.monitor_out ());
3111 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3113 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3115 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
3117 if (d && d->target_route() == route) {
3118 /* already listening via the specified IO: do nothing */
3126 boost::shared_ptr<InternalSend> listener;
3129 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3130 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
3131 listener.reset (new InternalSend (_session, sendpan, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
3134 add_processor (listener, before);
3136 } catch (failed_constructor& err) {
3144 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
3146 ProcessorStreams err;
3147 ProcessorList::iterator tmp;
3150 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
3152 /* have to do this early because otherwise processor reconfig
3153 * will put _monitor_send back in the list
3156 if (route == _session.monitor_out()) {
3157 _monitor_send.reset ();
3161 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
3163 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
3165 if (d && d->target_route() == route) {
3167 if (remove_processor (*x, &err, false) > 0) {
3173 /* list could have been demolished while we dropped the lock
3176 if (_session.engine().connected()) {
3177 /* i/o processors cannot be removed if the engine is not running
3178 * so don't live-loop in case the engine is N/A or dies
3188 Route::set_comment (string cmt, void *src)
3191 comment_changed (src);
3192 _session.set_dirty ();
3196 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
3198 FeedRecord fr (other, via_sends_only);
3200 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
3202 if (!result.second) {
3204 /* already a record for "other" - make sure sends-only information is correct */
3205 if (!via_sends_only && result.first->sends_only) {
3206 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
3207 frp->sends_only = false;
3211 return result.second;
3215 Route::clear_fed_by ()
3221 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
3223 const FedBy& fed_by (other->fed_by());
3225 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
3226 boost::shared_ptr<Route> sr = f->r.lock();
3228 if (sr && (sr.get() == this)) {
3230 if (via_sends_only) {
3231 *via_sends_only = f->sends_only;
3242 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
3244 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
3246 if (_output->connected_to (other->input())) {
3247 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
3248 if (via_send_only) {
3249 *via_send_only = false;
3256 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
3258 boost::shared_ptr<IOProcessor> iop;
3260 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
3261 if (iop->feeds (other)) {
3262 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
3263 if (via_send_only) {
3264 *via_send_only = true;
3268 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3271 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3276 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3281 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3283 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3286 /** Called from the (non-realtime) butler thread when the transport is stopped */
3288 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3290 framepos_t now = _session.transport_frame();
3293 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3295 Automatable::transport_stopped (now);
3297 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3299 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3303 (*i)->transport_stopped (now);
3307 _roll_delay = _initial_delay;
3311 Route::input_change_handler (IOChange change, void * /*src*/)
3313 if ((change.type & IOChange::ConfigurationChanged)) {
3314 /* This is called with the process lock held if change
3315 contains ConfigurationChanged
3317 configure_processors (0);
3318 _phase_invert.resize (_input->n_ports().n_audio ());
3319 io_changed (); /* EMIT SIGNAL */
3322 if (_soloed_by_others_upstream || _solo_isolated_by_upstream) {
3325 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3326 if (_input->connected()) {
3327 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3328 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3332 bool does_feed = (*i)->direct_feeds_according_to_reality (shared_from_this(), &sends_only);
3333 if (does_feed && !sends_only) {
3334 if ((*i)->soloed()) {
3337 if ((*i)->solo_isolated()) {
3344 int delta = sbou - _soloed_by_others_upstream;
3345 int idelta = ibou - _solo_isolated_by_upstream;
3348 PBD::warning << string_compose (
3349 _("Invalid Solo-Isolate propagation: from:%1 new:%2 - old:%3 = delta:%4"),
3350 _name, ibou, _solo_isolated_by_upstream, idelta)
3355 if (_soloed_by_others_upstream) {
3356 // ignore new connections (they're not propagated)
3358 mod_solo_by_others_upstream (delta);
3362 if (_solo_isolated_by_upstream) {
3363 // solo-isolate currently only propagates downstream
3365 mod_solo_isolated_by_upstream (false, this);
3367 // TODO think: mod_solo_isolated_by_upstream() does not take delta arg,
3368 // but idelta can't be smaller than -1, can it?
3369 //_solo_isolated_by_upstream = ibou;
3372 // Session::route_solo_changed does not propagate indirect solo-changes
3373 // propagate downstream to tracks
3374 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3375 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3379 bool does_feed = feeds (*i, &sends_only);
3380 if (delta <= 0 && does_feed && !sends_only) {
3381 (*i)->mod_solo_by_others_upstream (delta);
3384 if (idelta < 0 && does_feed && !sends_only) {
3385 (*i)->mod_solo_isolated_by_upstream (false, this);
3392 Route::output_change_handler (IOChange change, void * /*src*/)
3394 if (_initial_io_setup) {
3398 if ((change.type & IOChange::ConfigurationChanged)) {
3399 /* This is called with the process lock held if change
3400 contains ConfigurationChanged
3402 configure_processors (0);
3405 _session.reset_monitor_section();
3408 io_changed (); /* EMIT SIGNAL */
3411 if (_soloed_by_others_downstream) {
3413 /* checking all all downstream routes for
3414 * explicit of implict solo is a rather drastic measure,
3415 * ideally the input_change_handler() of the other route
3416 * would propagate the change to us.
3418 boost::shared_ptr<RouteList> routes = _session.get_routes ();
3419 if (_output->connected()) {
3420 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3421 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3425 bool does_feed = direct_feeds_according_to_reality (*i, &sends_only);
3426 if (does_feed && !sends_only) {
3427 if ((*i)->soloed()) {
3434 int delta = sbod - _soloed_by_others_downstream;
3436 // do not allow new connections to change implicit solo (no propagation)
3437 mod_solo_by_others_downstream (delta);
3438 // Session::route_solo_changed() does not propagate indirect solo-changes
3439 // propagate upstream to tracks
3440 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
3441 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3445 bool does_feed = (*i)->feeds (shared_from_this(), &sends_only);
3446 if (delta != 0 && does_feed && !sends_only) {
3447 (*i)->mod_solo_by_others_downstream (delta);
3456 Route::pans_required () const
3458 if (n_outputs().n_audio() < 2) {
3462 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3466 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3468 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3474 if (n_outputs().n_total() == 0) {
3478 if (!_active || n_inputs() == ChanCount::ZERO) {
3479 silence_unlocked (nframes);
3483 if (session_state_changing) {
3484 if (_session.transport_speed() != 0.0f) {
3485 /* we're rolling but some state is changing (e.g. our diskstream contents)
3486 so we cannot use them. Be silent till this is over.
3488 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3490 silence_unlocked (nframes);
3493 /* we're really not rolling, so we're either delivery silence or actually
3494 monitoring, both of which are safe to do while session_state_changing is true.
3498 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3500 fill_buffers_with_input (bufs, _input, nframes);
3502 if (_meter_point == MeterInput) {
3503 _meter->run (bufs, start_frame, end_frame, nframes, true);
3506 _amp->apply_gain_automation (false);
3507 _trim->apply_gain_automation (false);
3508 passthru (bufs, start_frame, end_frame, nframes, 0);
3514 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3516 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3521 if (n_outputs().n_total() == 0) {
3525 if (!_active || n_inputs().n_total() == 0) {
3526 silence_unlocked (nframes);
3530 framepos_t unused = 0;
3532 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3538 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3540 fill_buffers_with_input (bufs, _input, nframes);
3542 if (_meter_point == MeterInput) {
3543 _meter->run (bufs, start_frame, end_frame, nframes, true);
3546 passthru (bufs, start_frame, end_frame, nframes, declick);
3552 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3559 Route::flush_processors ()
3561 /* XXX shouldn't really try to take this lock, since
3562 this is called from the RT audio thread.
3565 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3567 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3573 __attribute__((annotate("realtime")))
3576 Route::apply_processor_changes_rt ()
3578 int emissions = EmitNone;
3580 if (_pending_meter_point != _meter_point) {
3581 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3583 /* meters always have buffers for 'processor_max_streams'
3584 * they can be re-positioned without re-allocation */
3585 if (set_meter_point_unlocked()) {
3586 emissions |= EmitMeterChanged | EmitMeterVisibilityChange;;
3588 emissions |= EmitMeterChanged;
3593 bool changed = false;
3595 if (g_atomic_int_get (&_pending_process_reorder)) {
3596 Glib::Threads::RWLock::WriterLock pwl (_processor_lock, Glib::Threads::TRY_LOCK);
3598 apply_processor_order (_pending_processor_order);
3599 setup_invisible_processors ();
3601 g_atomic_int_set (&_pending_process_reorder, 0);
3602 emissions |= EmitRtProcessorChange;
3606 set_processor_positions ();
3608 if (emissions != 0) {
3609 g_atomic_int_set (&_pending_signals, emissions);
3616 Route::emit_pending_signals ()
3619 int sig = g_atomic_int_and (&_pending_signals, 0);
3620 if (sig & EmitMeterChanged) {
3621 _meter->emit_configuration_changed();
3622 meter_change (); /* EMIT SIGNAL */
3623 if (sig & EmitMeterVisibilityChange) {
3624 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3626 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3629 if (sig & EmitRtProcessorChange) {
3630 processors_changed (RouteProcessorChange (RouteProcessorChange::RealTimeChange)); /* EMIT SIGNAL */
3635 Route::set_meter_point (MeterPoint p, bool force)
3637 if (_pending_meter_point == p && !force) {
3641 if (force || !AudioEngine::instance()->running()) {
3642 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3643 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3644 _pending_meter_point = p;
3645 _meter->emit_configuration_changed();
3646 meter_change (); /* EMIT SIGNAL */
3647 if (set_meter_point_unlocked()) {
3648 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, true)); /* EMIT SIGNAL */
3650 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, false)); /* EMIT SIGNAL */
3653 _pending_meter_point = p;
3659 __attribute__((annotate("realtime")))
3662 Route::set_meter_point_unlocked ()
3665 /* Caller must hold process and processor write lock */
3666 assert (!AudioEngine::instance()->process_lock().trylock());
3667 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3668 assert (!lm.locked ());
3671 _meter_point = _pending_meter_point;
3673 bool meter_was_visible_to_user = _meter->display_to_user ();
3675 if (!_custom_meter_position_noted) {
3676 maybe_note_meter_position ();
3679 if (_meter_point != MeterCustom) {
3681 _meter->set_display_to_user (false);
3683 setup_invisible_processors ();
3686 _meter->set_display_to_user (true);
3688 /* If we have a previous position for the custom meter, try to put it there */
3689 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3691 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3692 if (i != _processors.end ()) {
3693 _processors.remove (_meter);
3694 _processors.insert (i, _meter);
3696 } else {// at end, right before the mains_out/panner
3697 _processors.remove (_meter);
3698 ProcessorList::iterator main = _processors.end();
3699 _processors.insert (--main, _meter);
3703 /* Set up the meter for its new position */
3705 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3709 if (loc == _processors.begin()) {
3710 m_in = _input->n_ports();
3712 ProcessorList::iterator before = loc;
3714 m_in = (*before)->output_streams ();
3717 _meter->reflect_inputs (m_in);
3719 /* we do not need to reconfigure the processors, because the meter
3720 (a) is always ready to handle processor_max_streams
3721 (b) is always an N-in/N-out processor, and thus moving
3722 it doesn't require any changes to the other processors.
3725 /* these should really be done after releasing the lock
3726 * but all those signals are subscribed to with gui_thread()
3729 return (_meter->display_to_user() != meter_was_visible_to_user);
3733 Route::listen_position_changed ()
3736 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3737 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3738 ProcessorState pstate (this);
3740 if (configure_processors_unlocked (0)) {
3741 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
3743 configure_processors_unlocked (0); // it worked before we tried to add it ...
3748 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3749 _session.set_dirty ();
3752 boost::shared_ptr<CapturingProcessor>
3753 Route::add_export_point()
3755 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3756 if (!_capturing_processor) {
3758 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3759 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3761 _capturing_processor.reset (new CapturingProcessor (_session));
3762 _capturing_processor->activate ();
3764 configure_processors_unlocked (0);
3768 return _capturing_processor;
3772 Route::update_signal_latency ()
3774 framecnt_t l = _output->user_latency();
3775 framecnt_t lamp = 0;
3776 bool before_amp = true;
3777 framecnt_t ltrim = 0;
3778 bool before_trim = true;
3780 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3781 if ((*i)->active ()) {
3782 l += (*i)->signal_latency ();
3787 if ((*i) == _trim) {
3798 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3800 // TODO: (lamp - _signal_latency) to sync to output (read-ahed), currently _roll_delay shifts this around
3801 _signal_latency_at_amp_position = lamp;
3802 _signal_latency_at_trim_position = ltrim;
3804 if (_signal_latency != l) {
3805 _signal_latency = l;
3806 signal_latency_changed (); /* EMIT SIGNAL */
3809 return _signal_latency;
3813 Route::set_user_latency (framecnt_t nframes)
3815 _output->set_user_latency (nframes);
3816 _session.update_latency_compensation ();
3820 Route::set_latency_compensation (framecnt_t longest_session_latency)
3822 framecnt_t old = _initial_delay;
3824 if (_signal_latency < longest_session_latency) {
3825 _initial_delay = longest_session_latency - _signal_latency;
3830 DEBUG_TRACE (DEBUG::Latency, string_compose (
3831 "%1: compensate for maximum latency of %2,"
3832 "given own latency of %3, using initial delay of %4\n",
3833 name(), longest_session_latency, _signal_latency, _initial_delay));
3835 if (_initial_delay != old) {
3836 initial_delay_changed (); /* EMIT SIGNAL */
3839 if (_session.transport_stopped()) {
3840 _roll_delay = _initial_delay;
3844 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3845 : AutomationControl (r->session(),
3846 Evoral::Parameter (SoloAutomation),
3847 ParameterDescriptor(Evoral::Parameter (SoloAutomation)),
3848 boost::shared_ptr<AutomationList>(), name)
3851 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3852 gl->set_interpolation(Evoral::ControlList::Discrete);
3857 Route::SoloControllable::set_value (double val)
3860 set_value_unchecked (val);
3865 Route::SoloControllable::set_value_unchecked (double val)
3867 const bool bval = ((val >= 0.5) ? true : false);
3869 boost::shared_ptr<RouteList> rl (new RouteList);
3871 boost::shared_ptr<Route> r = _route.lock ();
3878 if (Config->get_solo_control_is_listen_control()) {
3879 _session.set_listen (rl, bval);
3881 _session.set_solo (rl, bval);
3886 Route::SoloControllable::get_value () const
3888 boost::shared_ptr<Route> r = _route.lock ();
3893 if (Config->get_solo_control_is_listen_control()) {
3894 return r->listening_via_monitor() ? GAIN_COEFF_UNITY : GAIN_COEFF_ZERO;
3896 return r->self_soloed() ? GAIN_COEFF_UNITY : GAIN_COEFF_ZERO;
3900 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3901 : AutomationControl (r->session(),
3902 Evoral::Parameter (MuteAutomation),
3903 ParameterDescriptor (Evoral::Parameter (MuteAutomation)),
3904 boost::shared_ptr<AutomationList>(),
3908 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3909 gl->set_interpolation(Evoral::ControlList::Discrete);
3914 Route::MuteControllable::set_superficial_value(bool muted)
3916 /* Note we can not use AutomationControl::set_value here since it will emit
3917 Changed(), but the value will not be correct to the observer. */
3919 const bool to_list = _list && ((AutomationList*)_list.get ())->automation_write ();
3920 const double where = _session.audible_frame ();
3922 /* Note that we really need this:
3923 * if (as == Touch && _list->in_new_write_pass ()) {
3924 * alist->start_write_pass (_session.audible_frame ());
3926 * here in the case of the user calling from a GUI or whatever.
3927 * Without the ability to distinguish between user and
3928 * automation-initiated changes, we lose the "touch mute"
3929 * behaviour we have in AutomationController::toggled ().
3931 _list->set_in_write_pass (true, false, where);
3934 Control::set_double (muted, where, to_list);
3938 Route::MuteControllable::set_value (double val)
3941 set_value_unchecked (val);
3946 Route::MuteControllable::set_value_unchecked (double val)
3948 const bool bval = ((val >= 0.5) ? true : false);
3950 boost::shared_ptr<Route> r = _route.lock ();
3955 if (_list && ((AutomationList*)_list.get())->automation_playback()) {
3956 // Set superficial/automation value to drive controller (and possibly record)
3957 set_superficial_value (bval);
3958 // Playing back automation, set route mute directly
3959 r->set_mute (bval, this);
3961 // Set from user, queue mute event
3962 boost::shared_ptr<RouteList> rl (new RouteList);
3964 _session.set_mute (rl, bval, Session::rt_cleanup);
3969 Route::MuteControllable::get_value () const
3971 if (_list && ((AutomationList*)_list.get())->automation_playback()) {
3972 // Playing back automation, get the value from the list
3973 return AutomationControl::get_value();
3976 // Not playing back automation, get the actual route mute value
3977 boost::shared_ptr<Route> r = _route.lock ();
3978 return (r && r->muted()) ? GAIN_COEFF_UNITY : GAIN_COEFF_ZERO;
3981 Route::GroupGainControllable::GroupGainControllable (std::string name, boost::shared_ptr<Route> r)
3982 : AutomationControl (r->session(),
3983 Evoral::Parameter (GainAutomation),
3984 ParameterDescriptor (Evoral::Parameter (GainAutomation)),
3985 boost::shared_ptr<AutomationList>(),
3989 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(GainAutomation)));
3990 gl->set_interpolation(Evoral::ControlList::Discrete);
3995 Route::GroupGainControllable::set_value (double val)
3997 boost::shared_ptr<Route> r = _route.lock ();
3998 // I am not sure why I need the * .5 to make this work
3999 float normalized_position = r->gain_control()->interface_to_internal (val * 0.5);
4000 r->set_gain ((gain_t)normalized_position, this);
4004 Route::GroupGainControllable::get_value () const
4006 boost::shared_ptr<Route> r = _route.lock ();
4007 return 2.0 * r->gain_control()->internal_to_interface (r->gain_control()->get_value ());
4010 Route::PhaseControllable::PhaseControllable (std::string name, boost::shared_ptr<Route> r)
4011 : AutomationControl (r->session(),
4012 Evoral::Parameter (PhaseAutomation),
4013 ParameterDescriptor (Evoral::Parameter (PhaseAutomation)),
4014 boost::shared_ptr<AutomationList>(),
4018 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(PhaseAutomation)));
4019 gl->set_interpolation(Evoral::ControlList::Discrete);
4024 Route::PhaseControllable::set_value (double v)
4026 boost::shared_ptr<Route> r = _route.lock ();
4027 if (r->phase_invert().size()) {
4028 if (v == 0 || (v < 1 && v > 0.9) ) {
4029 r->set_phase_invert (_current_phase, false);
4031 r->set_phase_invert (_current_phase, true);
4037 Route::PhaseControllable::get_value () const
4039 boost::shared_ptr<Route> r = _route.lock ();
4040 return (double) r->phase_invert (_current_phase);
4044 Route::PhaseControllable::set_channel (uint32_t c)
4050 Route::PhaseControllable::channel () const
4052 return _current_phase;
4056 Route::set_block_size (pframes_t nframes)
4058 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4059 (*i)->set_block_size (nframes);
4062 _session.ensure_buffers (n_process_buffers ());
4066 Route::protect_automation ()
4068 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
4069 (*i)->protect_automation();
4072 /** @param declick 1 to set a pending declick fade-in,
4073 * -1 to set a pending declick fade-out
4076 Route::set_pending_declick (int declick)
4079 /* this call is not allowed to turn off a pending declick */
4081 _pending_declick = declick;
4084 _pending_declick = 0;
4088 /** Shift automation forwards from a particular place, thereby inserting time.
4089 * Adds undo commands for any shifts that are performed.
4091 * @param pos Position to start shifting from.
4092 * @param frames Amount to shift forwards by.
4096 Route::shift (framepos_t pos, framecnt_t frames)
4098 /* gain automation */
4100 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
4102 XMLNode &before = gc->alist()->get_state ();
4103 gc->alist()->shift (pos, frames);
4104 XMLNode &after = gc->alist()->get_state ();
4105 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
4108 /* gain automation */
4110 boost::shared_ptr<AutomationControl> gc = _trim->gain_control();
4112 XMLNode &before = gc->alist()->get_state ();
4113 gc->alist()->shift (pos, frames);
4114 XMLNode &after = gc->alist()->get_state ();
4115 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
4118 // TODO mute automation ??
4120 /* pan automation */
4122 ControlSet::Controls& c (_pannable->controls());
4124 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
4125 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
4127 boost::shared_ptr<AutomationList> al = pc->alist();
4128 XMLNode& before = al->get_state ();
4129 al->shift (pos, frames);
4130 XMLNode& after = al->get_state ();
4131 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4136 /* redirect automation */
4138 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4139 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
4141 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
4143 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
4144 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
4146 boost::shared_ptr<AutomationList> al = ac->alist();
4147 XMLNode &before = al->get_state ();
4148 al->shift (pos, frames);
4149 XMLNode &after = al->get_state ();
4150 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
4159 Route::save_as_template (const string& path, const string& name)
4161 XMLNode& node (state (false));
4164 IO::set_name_in_state (*node.children().front(), name);
4166 tree.set_root (&node);
4167 /* return zero on success, non-zero otherwise */
4168 return !tree.write (path.c_str());
4173 Route::set_name (const string& str)
4175 if (str == name()) {
4179 string name = Route::ensure_track_or_route_name (str, _session);
4180 SessionObject::set_name (name);
4182 bool ret = (_input->set_name(name) && _output->set_name(name));
4185 /* rename the main outs. Leave other IO processors
4186 * with whatever name they already have, because its
4187 * just fine as it is (it will not contain the route
4188 * name if its a port insert, port send or port return).
4192 if (_main_outs->set_name (name)) {
4193 /* XXX returning false here is stupid because
4194 we already changed the route name.
4204 /** Set the name of a route in an XML description.
4205 * @param node XML <Route> node to set the name in.
4206 * @param name New name.
4209 Route::set_name_in_state (XMLNode& node, string const & name, bool rename_playlist)
4211 node.add_property (X_("name"), name);
4213 XMLNodeList children = node.children();
4214 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
4216 if ((*i)->name() == X_("IO")) {
4218 IO::set_name_in_state (**i, name);
4220 } else if ((*i)->name() == X_("Processor")) {
4222 XMLProperty* role = (*i)->property (X_("role"));
4223 if (role && role->value() == X_("Main")) {
4224 (*i)->add_property (X_("name"), name);
4227 } else if ((*i)->name() == X_("Diskstream")) {
4229 if (rename_playlist) {
4230 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
4232 (*i)->add_property (X_("name"), name);
4238 boost::shared_ptr<Send>
4239 Route::internal_send_for (boost::shared_ptr<const Route> target) const
4241 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4243 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4244 boost::shared_ptr<InternalSend> send;
4246 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
4247 if (send->target_route() == target) {
4253 return boost::shared_ptr<Send>();
4256 /** @param c Audio channel index.
4257 * @param yn true to invert phase, otherwise false.
4260 Route::set_phase_invert (uint32_t c, bool yn)
4262 if (_phase_invert[c] != yn) {
4263 _phase_invert[c] = yn;
4264 phase_invert_changed (); /* EMIT SIGNAL */
4265 _session.set_dirty ();
4270 Route::set_phase_invert (boost::dynamic_bitset<> p)
4272 if (_phase_invert != p) {
4274 phase_invert_changed (); /* EMIT SIGNAL */
4275 _session.set_dirty ();
4280 Route::phase_invert (uint32_t c) const
4282 return _phase_invert[c];
4285 boost::dynamic_bitset<>
4286 Route::phase_invert () const
4288 return _phase_invert;
4292 Route::set_denormal_protection (bool yn)
4294 if (_denormal_protection != yn) {
4295 _denormal_protection = yn;
4296 denormal_protection_changed (); /* EMIT SIGNAL */
4301 Route::denormal_protection () const
4303 return _denormal_protection;
4307 Route::set_active (bool yn, void* src)
4309 if (_session.transport_rolling()) {
4313 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
4314 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
4318 if (_active != yn) {
4320 _input->set_active (yn);
4321 _output->set_active (yn);
4322 active_changed (); // EMIT SIGNAL
4323 _session.set_dirty ();
4327 boost::shared_ptr<Pannable>
4328 Route::pannable() const
4333 boost::shared_ptr<Panner>
4334 Route::panner() const
4337 return _main_outs->panner_shell()->panner();
4340 boost::shared_ptr<PannerShell>
4341 Route::panner_shell() const
4343 return _main_outs->panner_shell();
4346 boost::shared_ptr<AutomationControl>
4347 Route::gain_control() const
4349 return _amp->gain_control();
4352 boost::shared_ptr<AutomationControl>
4353 Route::trim_control() const
4355 return _trim->gain_control();
4358 boost::shared_ptr<AutomationControl>
4359 Route::get_control (const Evoral::Parameter& param)
4361 /* either we own the control or .... */
4363 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
4367 /* maybe one of our processors does or ... */
4369 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
4370 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4371 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
4379 /* nobody does so we'll make a new one */
4381 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
4388 boost::shared_ptr<Processor>
4389 Route::nth_plugin (uint32_t n)
4391 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4392 ProcessorList::iterator i;
4394 for (i = _processors.begin(); i != _processors.end(); ++i) {
4395 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
4402 return boost::shared_ptr<Processor> ();
4405 boost::shared_ptr<Processor>
4406 Route::nth_send (uint32_t n)
4408 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4409 ProcessorList::iterator i;
4411 for (i = _processors.begin(); i != _processors.end(); ++i) {
4412 if (boost::dynamic_pointer_cast<Send> (*i)) {
4419 return boost::shared_ptr<Processor> ();
4423 Route::has_io_processor_named (const string& name)
4425 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4426 ProcessorList::iterator i;
4428 for (i = _processors.begin(); i != _processors.end(); ++i) {
4429 if (boost::dynamic_pointer_cast<Send> (*i) ||
4430 boost::dynamic_pointer_cast<PortInsert> (*i)) {
4431 if ((*i)->name() == name) {
4440 MuteMaster::MutePoint
4441 Route::mute_points () const
4443 return _mute_master->mute_points ();
4447 Route::set_processor_positions ()
4449 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4451 bool had_amp = false;
4452 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4453 (*i)->set_pre_fader (!had_amp);
4460 /** Called when there is a proposed change to the input port count */
4462 Route::input_port_count_changing (ChanCount to)
4464 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
4466 /* The processors cannot be configured with the new input arrangement, so
4472 /* The change is ok */
4476 /** Called when there is a proposed change to the output port count */
4478 Route::output_port_count_changing (ChanCount to)
4480 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4481 if (processor_out_streams.get(*t) > to.get(*t)) {
4485 /* The change is ok */
4490 Route::unknown_processors () const
4494 if (_session.get_disable_all_loaded_plugins ()) {
4495 // Do not list "missing plugins" if they are explicitly disabled
4499 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4500 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4501 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
4502 p.push_back ((*i)->name ());
4511 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
4513 /* we assume that all our input ports feed all our output ports. its not
4514 universally true, but the alternative is way too corner-case to worry about.
4517 LatencyRange all_connections;
4520 all_connections.min = 0;
4521 all_connections.max = 0;
4523 all_connections.min = ~((pframes_t) 0);
4524 all_connections.max = 0;
4526 /* iterate over all "from" ports and determine the latency range for all of their
4527 connections to the "outside" (outside of this Route).
4530 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4534 p->get_connected_latency_range (range, playback);
4536 all_connections.min = min (all_connections.min, range.min);
4537 all_connections.max = max (all_connections.max, range.max);
4541 /* set the "from" port latencies to the max/min range of all their connections */
4543 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
4544 p->set_private_latency_range (all_connections, playback);
4547 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
4549 all_connections.min += our_latency;
4550 all_connections.max += our_latency;
4552 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4553 p->set_private_latency_range (all_connections, playback);
4556 return all_connections.max;
4560 Route::set_private_port_latencies (bool playback) const
4562 framecnt_t own_latency = 0;
4564 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4565 OR LATENCY CALLBACK.
4567 This is called (early) from the latency callback. It computes the REAL
4568 latency associated with each port and stores the result as the "private"
4569 latency of the port. A later call to Route::set_public_port_latencies()
4570 sets all ports to the same value to reflect the fact that we do latency
4571 compensation and so all signals are delayed by the same amount as they
4572 flow through ardour.
4575 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4576 if ((*i)->active ()) {
4577 own_latency += (*i)->signal_latency ();
4582 /* playback: propagate latency from "outside the route" to outputs to inputs */
4583 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4585 /* capture: propagate latency from "outside the route" to inputs to outputs */
4586 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4591 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4593 /* this is called to set the JACK-visible port latencies, which take
4594 latency compensation into account.
4603 const PortSet& ports (_input->ports());
4604 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4605 p->set_public_latency_range (range, playback);
4610 const PortSet& ports (_output->ports());
4611 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4612 p->set_public_latency_range (range, playback);
4617 /** Put the invisible processors in the right place in _processors.
4618 * Must be called with a writer lock on _processor_lock held.
4621 __attribute__((annotate("realtime")))
4624 Route::setup_invisible_processors ()
4627 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4628 assert (!lm.locked ());
4632 /* too early to be doing this stuff */
4636 /* we'll build this new list here and then use it
4638 * TODO put the ProcessorList is on the stack for RT-safety.
4641 ProcessorList new_processors;
4643 /* find visible processors */
4645 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4646 if ((*i)->display_to_user ()) {
4647 new_processors.push_back (*i);
4653 ProcessorList::iterator amp = new_processors.begin ();
4654 while (amp != new_processors.end() && *amp != _amp) {
4658 assert (amp != new_processors.end ());
4660 /* and the processor after the amp */
4662 ProcessorList::iterator after_amp = amp;
4668 switch (_meter_point) {
4670 assert (!_meter->display_to_user ());
4671 new_processors.push_front (_meter);
4674 assert (!_meter->display_to_user ());
4675 new_processors.insert (amp, _meter);
4677 case MeterPostFader:
4678 /* do nothing here */
4681 /* do nothing here */
4684 /* the meter is visible, so we don't touch it here */
4691 assert (_main_outs);
4692 assert (!_main_outs->display_to_user ());
4693 new_processors.push_back (_main_outs);
4695 /* iterator for the main outs */
4697 ProcessorList::iterator main = new_processors.end();
4700 /* OUTPUT METERING */
4702 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4703 assert (!_meter->display_to_user ());
4705 /* add the processor just before or just after the main outs */
4707 ProcessorList::iterator meter_point = main;
4709 if (_meter_point == MeterOutput) {
4712 new_processors.insert (meter_point, _meter);
4717 if (_monitor_send && !is_monitor ()) {
4718 assert (!_monitor_send->display_to_user ());
4719 switch (Config->get_listen_position ()) {
4720 case PreFaderListen:
4721 switch (Config->get_pfl_position ()) {
4722 case PFLFromBeforeProcessors:
4723 new_processors.push_front (_monitor_send);
4725 case PFLFromAfterProcessors:
4726 new_processors.insert (amp, _monitor_send);
4729 _monitor_send->set_can_pan (false);
4731 case AfterFaderListen:
4732 switch (Config->get_afl_position ()) {
4733 case AFLFromBeforeProcessors:
4734 new_processors.insert (after_amp, _monitor_send);
4736 case AFLFromAfterProcessors:
4737 new_processors.insert (new_processors.end(), _monitor_send);
4740 _monitor_send->set_can_pan (true);
4745 #if 0 // not used - just yet
4746 if (!is_master() && !is_monitor() && !is_auditioner()) {
4747 new_processors.push_front (_delayline);
4751 /* MONITOR CONTROL */
4753 if (_monitor_control && is_monitor ()) {
4754 assert (!_monitor_control->display_to_user ());
4755 new_processors.push_front (_monitor_control);
4758 /* INTERNAL RETURN */
4760 /* doing this here means that any monitor control will come just after
4765 assert (!_intreturn->display_to_user ());
4766 new_processors.push_front (_intreturn);
4769 if (_trim && _trim->active()) {
4770 assert (!_trim->display_to_user ());
4771 new_processors.push_front (_trim);
4773 /* EXPORT PROCESSOR */
4775 if (_capturing_processor) {
4776 assert (!_capturing_processor->display_to_user ());
4777 new_processors.push_front (_capturing_processor);
4780 _processors = new_processors;
4782 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4783 if (!(*i)->display_to_user () && !(*i)->active () && (*i) != _monitor_send) {
4788 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4789 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4790 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4797 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4798 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4802 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4803 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4810 /** If the meter point is `Custom', make a note of where the meter is.
4811 * This is so that if the meter point is subsequently set to something else,
4812 * and then back to custom, we can put the meter back where it was last time
4813 * custom was enabled.
4815 * Must be called with the _processor_lock held.
4818 Route::maybe_note_meter_position ()
4820 if (_meter_point != MeterCustom) {
4824 _custom_meter_position_noted = true;
4825 /* custom meter points range from after trim to before panner/main_outs
4826 * this is a limitation by the current processor UI
4828 bool seen_trim = false;
4829 _processor_after_last_custom_meter.reset();
4830 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4831 if ((*i) == _trim) {
4834 if ((*i) == _main_outs) {
4835 _processor_after_last_custom_meter = *i;
4838 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4840 _processor_after_last_custom_meter = _trim;
4842 ProcessorList::iterator j = i;
4844 assert(j != _processors.end ()); // main_outs should be before
4845 _processor_after_last_custom_meter = *j;
4850 assert(_processor_after_last_custom_meter.lock());
4853 boost::shared_ptr<Processor>
4854 Route::processor_by_id (PBD::ID id) const
4856 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4857 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4858 if ((*i)->id() == id) {
4863 return boost::shared_ptr<Processor> ();
4866 /** @return the monitoring state, or in other words what data we are pushing
4867 * into the route (data from the inputs, data from disk or silence)
4870 Route::monitoring_state () const
4872 return MonitoringInput;
4875 /** @return what we should be metering; either the data coming from the input
4876 * IO or the data that is flowing through the route.
4879 Route::metering_state () const
4881 return MeteringRoute;
4885 Route::has_external_redirects () const
4887 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4889 /* ignore inactive processors and obviously ignore the main
4890 * outs since everything has them and we don't care.
4893 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4901 boost::shared_ptr<Processor>
4902 Route::the_instrument () const
4904 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4905 return the_instrument_unlocked ();
4908 boost::shared_ptr<Processor>
4909 Route::the_instrument_unlocked () const
4911 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4912 if (boost::dynamic_pointer_cast<PluginInsert>(*i)) {
4913 if ((*i)->input_streams().n_midi() > 0 &&
4914 (*i)->output_streams().n_audio() > 0) {
4919 return boost::shared_ptr<Processor>();
4925 Route::non_realtime_locate (framepos_t pos)
4928 _pannable->transport_located (pos);
4931 if (_delayline.get()) {
4932 _delayline.get()->flush();
4936 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4937 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4939 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4940 (*i)->transport_located (pos);
4943 _roll_delay = _initial_delay;
4947 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4954 * We don't currently mix MIDI input together, so we don't need the
4955 * complex logic of the audio case.
4958 n_buffers = bufs.count().n_midi ();
4960 for (i = 0; i < n_buffers; ++i) {
4962 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4963 MidiBuffer& buf (bufs.get_midi (i));
4966 buf.copy (source_port->get_midi_buffer(nframes));
4968 buf.silence (nframes);
4974 n_buffers = bufs.count().n_audio();
4976 size_t n_ports = io->n_ports().n_audio();
4977 float scaling = 1.0f;
4979 if (n_ports > n_buffers) {
4980 scaling = ((float) n_buffers) / n_ports;
4983 for (i = 0; i < n_ports; ++i) {
4985 /* if there are more ports than buffers, map them onto buffers
4986 * in a round-robin fashion
4989 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4990 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4993 if (i < n_buffers) {
4995 /* first time through just copy a channel into
4999 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
5001 if (scaling != 1.0f) {
5002 buf.apply_gain (scaling, nframes);
5007 /* on subsequent times around, merge data from
5008 * the port with what is already there
5011 if (scaling != 1.0f) {
5012 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
5014 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
5019 /* silence any remaining buffers */
5021 for (; i < n_buffers; ++i) {
5022 AudioBuffer& buf (bufs.get_audio (i));
5023 buf.silence (nframes);
5026 /* establish the initial setup of the buffer set, reflecting what was
5027 copied into it. unless, of course, we are the auditioner, in which
5028 case nothing was fed into it from the inputs at all.
5031 if (!is_auditioner()) {
5032 bufs.set_count (io->n_ports());
5036 boost::shared_ptr<AutomationControl>
5037 Route::pan_azimuth_control() const
5040 boost::shared_ptr<ARDOUR::PluginInsert> plug = ch_post();
5042 const uint32_t port_channel_post_pan = 2; // gtk2_ardour/mixbus_ports.h
5043 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (plug->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_channel_post_pan)));
5045 if (!_pannable || !panner()) {
5046 return boost::shared_ptr<AutomationControl>();
5048 return _pannable->pan_azimuth_control;
5052 boost::shared_ptr<AutomationControl>
5053 Route::pan_elevation_control() const
5055 if (Profile->get_mixbus() || !_pannable || !panner()) {
5056 return boost::shared_ptr<AutomationControl>();
5059 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5061 if (c.find (PanElevationAutomation) != c.end()) {
5062 return _pannable->pan_elevation_control;
5064 return boost::shared_ptr<AutomationControl>();
5067 boost::shared_ptr<AutomationControl>
5068 Route::pan_width_control() const
5070 if (Profile->get_mixbus() || !_pannable || !panner()) {
5071 return boost::shared_ptr<AutomationControl>();
5074 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5076 if (c.find (PanWidthAutomation) != c.end()) {
5077 return _pannable->pan_width_control;
5079 return boost::shared_ptr<AutomationControl>();
5082 boost::shared_ptr<AutomationControl>
5083 Route::pan_frontback_control() const
5085 if (Profile->get_mixbus() || !_pannable || !panner()) {
5086 return boost::shared_ptr<AutomationControl>();
5089 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5091 if (c.find (PanFrontBackAutomation) != c.end()) {
5092 return _pannable->pan_frontback_control;
5094 return boost::shared_ptr<AutomationControl>();
5097 boost::shared_ptr<AutomationControl>
5098 Route::pan_lfe_control() const
5100 if (Profile->get_mixbus() || !_pannable || !panner()) {
5101 return boost::shared_ptr<AutomationControl>();
5104 set<Evoral::Parameter> c = panner()->what_can_be_automated ();
5106 if (c.find (PanLFEAutomation) != c.end()) {
5107 return _pannable->pan_lfe_control;
5109 return boost::shared_ptr<AutomationControl>();
5114 Route::eq_band_cnt () const
5116 if (Profile->get_mixbus()) {
5119 /* Ardour has no well-known EQ object */
5124 boost::shared_ptr<AutomationControl>
5125 Route::eq_gain_controllable (uint32_t band) const
5128 boost::shared_ptr<PluginInsert> eq = ch_eq();
5131 return boost::shared_ptr<AutomationControl>();
5134 uint32_t port_number;
5137 if (is_master() || mixbus()) {
5144 if (is_master() || mixbus()) {
5151 if (is_master() || mixbus()) {
5158 return boost::shared_ptr<AutomationControl>();
5161 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5163 return boost::shared_ptr<AutomationControl>();
5166 boost::shared_ptr<AutomationControl>
5167 Route::eq_freq_controllable (uint32_t band) const
5171 if (mixbus() || is_master()) {
5172 /* no frequency controls for mixbusses or master */
5173 return boost::shared_ptr<AutomationControl>();
5176 boost::shared_ptr<PluginInsert> eq = ch_eq();
5179 return boost::shared_ptr<AutomationControl>();
5182 uint32_t port_number;
5194 return boost::shared_ptr<AutomationControl>();
5197 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, port_number)));
5199 return boost::shared_ptr<AutomationControl>();
5203 boost::shared_ptr<AutomationControl>
5204 Route::eq_q_controllable (uint32_t band) const
5206 return boost::shared_ptr<AutomationControl>();
5209 boost::shared_ptr<AutomationControl>
5210 Route::eq_shape_controllable (uint32_t band) const
5212 return boost::shared_ptr<AutomationControl>();
5215 boost::shared_ptr<AutomationControl>
5216 Route::eq_enable_controllable () const
5219 boost::shared_ptr<PluginInsert> eq = ch_eq();
5222 return boost::shared_ptr<AutomationControl>();
5225 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5227 return boost::shared_ptr<AutomationControl>();
5231 boost::shared_ptr<AutomationControl>
5232 Route::eq_hpf_controllable () const
5235 boost::shared_ptr<PluginInsert> eq = ch_eq();
5238 return boost::shared_ptr<AutomationControl>();
5241 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (eq->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5243 return boost::shared_ptr<AutomationControl>();
5248 Route::eq_band_name (uint32_t band) const
5250 if (Profile->get_mixbus()) {
5266 boost::shared_ptr<AutomationControl>
5267 Route::comp_enable_controllable () const
5270 boost::shared_ptr<PluginInsert> comp = ch_comp();
5273 return boost::shared_ptr<AutomationControl>();
5276 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 1)));
5278 return boost::shared_ptr<AutomationControl>();
5281 boost::shared_ptr<AutomationControl>
5282 Route::comp_threshold_controllable () const
5285 boost::shared_ptr<PluginInsert> comp = ch_comp();
5288 return boost::shared_ptr<AutomationControl>();
5291 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 2)));
5294 return boost::shared_ptr<AutomationControl>();
5297 boost::shared_ptr<AutomationControl>
5298 Route::comp_speed_controllable () const
5301 boost::shared_ptr<PluginInsert> comp = ch_comp();
5304 return boost::shared_ptr<AutomationControl>();
5307 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 3)));
5309 return boost::shared_ptr<AutomationControl>();
5312 boost::shared_ptr<AutomationControl>
5313 Route::comp_mode_controllable () const
5316 boost::shared_ptr<PluginInsert> comp = ch_comp();
5319 return boost::shared_ptr<AutomationControl>();
5322 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 4)));
5324 return boost::shared_ptr<AutomationControl>();
5327 boost::shared_ptr<AutomationControl>
5328 Route::comp_makeup_controllable () const
5331 boost::shared_ptr<PluginInsert> comp = ch_comp();
5334 return boost::shared_ptr<AutomationControl>();
5337 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 5)));
5339 return boost::shared_ptr<AutomationControl>();
5342 boost::shared_ptr<AutomationControl>
5343 Route::comp_redux_controllable () const
5346 boost::shared_ptr<PluginInsert> comp = ch_comp();
5349 return boost::shared_ptr<AutomationControl>();
5352 return boost::dynamic_pointer_cast<ARDOUR::AutomationControl> (comp->control (Evoral::Parameter (ARDOUR::PluginAutomation, 0, 6)));
5354 return boost::shared_ptr<AutomationControl>();
5359 Route::comp_mode_name (uint32_t mode) const
5364 return _("Leveler");
5366 return _("Compressor");
5368 return _("Limiter");
5378 Route::comp_speed_name (uint32_t mode) const