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"
38 #include "ardour/amp.h"
39 #include "ardour/audio_buffer.h"
40 #include "ardour/audio_port.h"
41 #include "ardour/audioengine.h"
42 #include "ardour/buffer.h"
43 #include "ardour/buffer_set.h"
44 #include "ardour/capturing_processor.h"
45 #include "ardour/debug.h"
46 #include "ardour/delivery.h"
47 #include "ardour/internal_return.h"
48 #include "ardour/internal_send.h"
49 #include "ardour/meter.h"
50 #include "ardour/delayline.h"
51 #include "ardour/midi_buffer.h"
52 #include "ardour/midi_port.h"
53 #include "ardour/monitor_processor.h"
54 #include "ardour/pannable.h"
55 #include "ardour/panner.h"
56 #include "ardour/panner_shell.h"
57 #include "ardour/plugin_insert.h"
58 #include "ardour/port.h"
59 #include "ardour/port_insert.h"
60 #include "ardour/processor.h"
61 #include "ardour/route.h"
62 #include "ardour/route_group.h"
63 #include "ardour/send.h"
64 #include "ardour/session.h"
65 #include "ardour/unknown_processor.h"
66 #include "ardour/utils.h"
71 using namespace ARDOUR;
74 PBD::Signal0<void> Route::SyncOrderKeys;
75 PBD::Signal0<void> Route::RemoteControlIDChange;
77 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
78 : SessionObject (sess, name)
80 , GraphNode (sess._process_graph)
83 , _signal_latency_at_amp_position (0)
87 , _pending_declick (true)
88 , _meter_point (MeterPostFader)
89 , _meter_type (MeterPeak)
91 , _soloed_by_others_upstream (0)
92 , _soloed_by_others_downstream (0)
94 , _denormal_protection (false)
97 , _declickable (false)
98 , _mute_master (new MuteMaster (sess, name))
99 , _have_internal_generator (false)
101 , _default_type (default_type)
103 , _has_order_key (false)
104 , _remote_control_id (0)
106 , _in_configure_processors (false)
107 , _initial_io_setup (false)
108 , _custom_meter_position_noted (false)
109 , _last_custom_meter_was_at_end (false)
112 _meter_type = MeterK20;
114 processor_max_streams.reset();
120 /* add standard controls */
122 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
123 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
125 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
126 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
128 add_control (_solo_control);
129 add_control (_mute_control);
133 if (!(_flags & Route::MonitorOut)) {
134 _pannable.reset (new Pannable (_session));
137 /* input and output objects */
139 _input.reset (new IO (_session, _name, IO::Input, _default_type));
140 _output.reset (new IO (_session, _name, IO::Output, _default_type));
142 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
143 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
145 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
146 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
148 #if 0 // not used - just yet
149 if (!is_master() && !is_monitor() && !is_auditioner()) {
150 _delayline.reset (new DelayLine (_session, _name));
151 add_processor (_delayline, PreFader);
155 /* add amp processor */
157 _amp.reset (new Amp (_session));
158 add_processor (_amp, PostFader);
160 /* create standard processors: meter, main outs, monitor out;
161 they will be added to _processors by setup_invisible_processors ()
164 _meter.reset (new PeakMeter (_session, _name));
165 _meter->set_owner (this);
166 _meter->set_display_to_user (false);
169 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
170 _main_outs->activate ();
173 /* where we listen to tracks */
174 _intreturn.reset (new InternalReturn (_session));
175 _intreturn->activate ();
177 /* the thing that provides proper control over a control/monitor/listen bus
178 (such as per-channel cut, dim, solo, invert, etc).
180 _monitor_control.reset (new MonitorProcessor (_session));
181 _monitor_control->activate ();
184 if (is_master() || is_monitor() || is_auditioner()) {
185 _mute_master->set_solo_ignore (true);
188 /* now that we have _meter, its safe to connect to this */
190 Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
193 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
194 configure_processors (0);
202 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
204 /* do this early so that we don't get incoming signals as we are going through destruction
209 /* don't use clear_processors here, as it depends on the session which may
210 be half-destroyed by now
213 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
214 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
215 (*i)->drop_references ();
218 _processors.clear ();
222 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
224 if (Config->get_remote_model() != UserOrdered) {
228 set_remote_control_id_internal (id, notify_class_listeners);
232 Route::set_remote_control_id_internal (uint32_t id, bool notify_class_listeners)
234 /* force IDs for master/monitor busses and prevent
235 any other route from accidentally getting these IDs
236 (i.e. legacy sessions)
239 if (is_master() && id != MasterBusRemoteControlID) {
240 id = MasterBusRemoteControlID;
243 if (is_monitor() && id != MonitorBusRemoteControlID) {
244 id = MonitorBusRemoteControlID;
251 /* don't allow it to collide */
253 if (!is_master () && !is_monitor() &&
254 (id == MasterBusRemoteControlID || id == MonitorBusRemoteControlID)) {
255 id += MonitorBusRemoteControlID;
258 if (id != remote_control_id()) {
259 _remote_control_id = id;
260 RemoteControlIDChanged ();
262 if (notify_class_listeners) {
263 RemoteControlIDChange ();
269 Route::remote_control_id() const
272 return MasterBusRemoteControlID;
276 return MonitorBusRemoteControlID;
279 return _remote_control_id;
283 Route::has_order_key () const
285 return _has_order_key;
289 Route::order_key () const
295 Route::set_remote_control_id_explicit (uint32_t rid)
297 if (is_master() || is_monitor() || is_auditioner()) {
298 /* hard-coded remote IDs, or no remote ID */
302 if (_remote_control_id != rid) {
303 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1: set edit-based RID to %2\n", name(), rid));
304 _remote_control_id = rid;
305 RemoteControlIDChanged (); /* EMIT SIGNAL (per-route) */
308 /* don't emit the class-level RID signal RemoteControlIDChange here,
309 leave that to the entity that changed the order key, so that we
310 don't get lots of emissions for no good reasons (e.g. when changing
311 all route order keys).
313 See Session::sync_remote_id_from_order_keys() for the (primary|only)
314 spot where that is emitted.
319 Route::set_order_key (uint32_t n)
321 _has_order_key = true;
323 if (_order_key == n) {
329 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 order key set to %2\n",
330 name(), order_key ()));
332 _session.set_dirty ();
336 Route::ensure_track_or_route_name(string name, Session &session)
338 string newname = name;
340 while (!session.io_name_is_legal (newname)) {
341 newname = bump_name_once (newname, '.');
349 Route::inc_gain (gain_t fraction, void *src)
351 _amp->inc_gain (fraction, src);
355 Route::set_gain (gain_t val, void *src)
357 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
359 if (_route_group->is_relative()) {
361 gain_t usable_gain = _amp->gain();
362 if (usable_gain < 0.000001f) {
363 usable_gain = 0.000001f;
367 if (delta < 0.000001f) {
371 delta -= usable_gain;
376 gain_t factor = delta / usable_gain;
379 factor = _route_group->get_max_factor(factor);
380 if (factor == 0.0f) {
381 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
385 factor = _route_group->get_min_factor(factor);
386 if (factor == 0.0f) {
387 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
392 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
396 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
402 if (val == _amp->gain()) {
406 _amp->set_gain (val, src);
410 Route::maybe_declick (BufferSet&, framecnt_t, int)
412 /* this is the "bus" implementation and they never declick.
417 /** Process this route for one (sub) cycle (process thread)
419 * @param bufs Scratch buffers to use for the signal path
420 * @param start_frame Initial transport frame
421 * @param end_frame Final transport frame
422 * @param nframes Number of frames to output (to ports)
424 * Note that (end_frame - start_frame) may not be equal to nframes when the
425 * transport speed isn't 1.0 (eg varispeed).
428 Route::process_output_buffers (BufferSet& bufs,
429 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
430 int declick, bool gain_automation_ok)
432 /* Caller must hold process lock */
433 assert (!AudioEngine::instance()->process_lock().trylock());
435 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
437 bufs.silence (nframes, 0);
441 /* figure out if we're going to use gain automation */
442 if (gain_automation_ok) {
443 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
444 _amp->setup_gain_automation (
445 start_frame + _signal_latency_at_amp_position,
446 end_frame + _signal_latency_at_amp_position,
449 _amp->apply_gain_automation (false);
452 /* Tell main outs what to do about monitoring. We do this so that
453 on a transition between monitoring states we get a de-clicking gain
454 change in the _main_outs delivery.
456 bool silence = monitoring_state () == MonitoringSilence;
458 //but we override this in the case where we have an internal generator
459 if ( _have_internal_generator )
462 _main_outs->no_outs_cuz_we_no_monitor (silence);
464 /* -------------------------------------------------------------------------------------------
465 GLOBAL DECLICK (for transport changes etc.)
466 ----------------------------------------------------------------------------------------- */
468 maybe_declick (bufs, nframes, declick);
469 _pending_declick = 0;
471 /* -------------------------------------------------------------------------------------------
472 DENORMAL CONTROL/PHASE INVERT
473 ----------------------------------------------------------------------------------------- */
475 if (_phase_invert.any ()) {
479 if (_denormal_protection || Config->get_denormal_protection()) {
481 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
482 Sample* const sp = i->data();
484 if (_phase_invert[chn]) {
485 for (pframes_t nx = 0; nx < nframes; ++nx) {
490 for (pframes_t nx = 0; nx < nframes; ++nx) {
498 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
499 Sample* const sp = i->data();
501 if (_phase_invert[chn]) {
502 for (pframes_t nx = 0; nx < nframes; ++nx) {
511 if (_denormal_protection || Config->get_denormal_protection()) {
513 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
514 Sample* const sp = i->data();
515 for (pframes_t nx = 0; nx < nframes; ++nx) {
523 /* -------------------------------------------------------------------------------------------
525 ----------------------------------------------------------------------------------------- */
527 /* set this to be true if the meter will already have been ::run() earlier */
528 bool const meter_already_run = metering_state() == MeteringInput;
530 framecnt_t latency = 0;
532 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
534 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
535 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
540 /* if it has any inputs, make sure they match */
541 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
542 if (bufs.count() != (*i)->input_streams()) {
544 DEBUG::Processors, string_compose (
545 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
546 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
553 /* should we NOT run plugins here if the route is inactive?
554 do we catch route != active somewhere higher?
557 if (boost::dynamic_pointer_cast<Send>(*i) != 0) {
558 boost::dynamic_pointer_cast<Send>(*i)->set_delay_in(_signal_latency - latency);
561 (*i)->run (bufs, start_frame - latency, end_frame - latency, nframes, *i != _processors.back());
562 bufs.set_count ((*i)->output_streams());
564 if ((*i)->active ()) {
565 latency += (*i)->signal_latency ();
571 Route::bounce_process (BufferSet& buffers, framepos_t start, framecnt_t nframes,
572 boost::shared_ptr<Processor> endpoint,
573 bool include_endpoint, bool for_export, bool for_freeze)
575 /* If no processing is required, there's no need to go any further. */
576 if (!endpoint && !include_endpoint) {
580 framecnt_t latency = bounce_get_latency(_amp, false, for_export, for_freeze);
581 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
582 _amp->setup_gain_automation (start - latency, start - latency + nframes, nframes);
585 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
587 if (!include_endpoint && (*i) == endpoint) {
591 /* if we're not exporting, stop processing if we come across a routing processor. */
592 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
595 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
599 /* don't run any processors that does routing.
600 * oh, and don't bother with the peak meter either.
602 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
603 (*i)->run (buffers, start - latency, start - latency + nframes, nframes, true);
604 buffers.set_count ((*i)->output_streams());
605 latency += (*i)->signal_latency ();
608 if ((*i) == endpoint) {
615 Route::bounce_get_latency (boost::shared_ptr<Processor> endpoint,
616 bool include_endpoint, bool for_export, bool for_freeze) const
618 framecnt_t latency = 0;
619 if (!endpoint && !include_endpoint) {
623 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
624 if (!include_endpoint && (*i) == endpoint) {
627 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
630 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
633 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
634 latency += (*i)->signal_latency ();
636 if ((*i) == endpoint) {
644 Route::bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint,
645 bool include_endpoint, bool for_export, bool for_freeze) const
647 if (!endpoint && !include_endpoint) {
651 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
652 if (!include_endpoint && (*i) == endpoint) {
655 if (!for_export && boost::dynamic_pointer_cast<PortInsert>(*i)) {
658 if (!for_export && for_freeze && (*i)->does_routing() && (*i)->active()) {
661 if (!(*i)->does_routing() && !boost::dynamic_pointer_cast<PeakMeter>(*i)) {
662 cc = (*i)->output_streams();
664 if ((*i) == endpoint) {
672 Route::n_process_buffers ()
674 return max (_input->n_ports(), processor_max_streams);
678 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
680 assert (is_monitor());
681 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
682 fill_buffers_with_input (bufs, _input, nframes);
683 passthru (bufs, start_frame, end_frame, nframes, declick);
687 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
691 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
693 /* control/monitor bus ignores input ports when something is
694 feeding the listen "stream". data will "arrive" into the
695 route from the intreturn processor element.
698 bufs.silence (nframes, 0);
701 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
702 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
706 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
708 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
710 bufs.set_count (_input->n_ports());
711 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
712 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
716 Route::set_listen (bool yn, void* src)
722 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
723 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
728 if (yn != _monitor_send->active()) {
730 _monitor_send->activate ();
731 _mute_master->set_soloed (true);
733 _monitor_send->deactivate ();
734 _mute_master->set_soloed (false);
737 listen_changed (src); /* EMIT SIGNAL */
743 Route::listening_via_monitor () const
746 return _monitor_send->active ();
753 Route::set_solo_safe (bool yn, void *src)
755 if (_solo_safe != yn) {
757 solo_safe_changed (src);
762 Route::solo_safe() const
768 Route::set_solo (bool yn, void *src)
771 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change due to solo-safe\n", name()));
775 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
776 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
780 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set solo => %2, src: %3 grp ? %4 currently self-soloed ? %5\n",
781 name(), yn, src, (src == _route_group), self_soloed()));
783 if (self_soloed() != yn) {
785 set_mute_master_solo ();
786 solo_changed (true, src); /* EMIT SIGNAL */
787 _solo_control->Changed (); /* EMIT SIGNAL */
792 Route::set_self_solo (bool yn)
794 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set SELF solo => %2\n", name(), yn));
799 Route::mod_solo_by_others_upstream (int32_t delta)
802 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-upstream due to solo-safe\n", name()));
806 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-upstream by %2, current up = %3 down = %4\n",
807 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
809 uint32_t old_sbu = _soloed_by_others_upstream;
812 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
813 _soloed_by_others_upstream += delta;
815 _soloed_by_others_upstream = 0;
818 _soloed_by_others_upstream += delta;
821 DEBUG_TRACE (DEBUG::Solo, string_compose (
822 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
823 name(), delta, _soloed_by_others_upstream, old_sbu,
824 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
826 /* push the inverse solo change to everything that feeds us.
828 This is important for solo-within-group. When we solo 1 track out of N that
829 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
830 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
831 tracks that feed it. This will silence them if they were audible because
832 of a bus solo, but the newly soloed track will still be audible (because
835 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
839 if ((_self_solo || _soloed_by_others_downstream) &&
840 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
841 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
843 if (delta > 0 || !Config->get_exclusive_solo()) {
844 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
845 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
846 boost::shared_ptr<Route> sr = i->r.lock();
848 sr->mod_solo_by_others_downstream (-delta);
854 set_mute_master_solo ();
855 solo_changed (false, this);
859 Route::mod_solo_by_others_downstream (int32_t delta)
862 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-downstream due to solo safe\n", name()));
866 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-downstream by %2, current up = %3 down = %4\n",
867 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
870 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
871 _soloed_by_others_downstream += delta;
873 _soloed_by_others_downstream = 0;
876 _soloed_by_others_downstream += delta;
879 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
881 set_mute_master_solo ();
882 solo_changed (false, this);
886 Route::set_mute_master_solo ()
888 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
892 Route::set_solo_isolated (bool yn, void *src)
894 if (is_master() || is_monitor() || is_auditioner()) {
898 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
899 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
903 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
905 boost::shared_ptr<RouteList> routes = _session.get_routes ();
906 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
908 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
913 bool does_feed = direct_feeds_according_to_graph (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
915 if (does_feed && !sends_only) {
916 (*i)->set_solo_isolated (yn, (*i)->route_group());
920 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
922 bool changed = false;
925 if (_solo_isolated == 0) {
926 _mute_master->set_solo_ignore (true);
931 if (_solo_isolated > 0) {
933 if (_solo_isolated == 0) {
934 _mute_master->set_solo_ignore (false);
941 solo_isolated_changed (src);
946 Route::solo_isolated () const
948 return _solo_isolated > 0;
952 Route::set_mute_points (MuteMaster::MutePoint mp)
954 _mute_master->set_mute_points (mp);
955 mute_points_changed (); /* EMIT SIGNAL */
957 if (_mute_master->muted_by_self()) {
958 mute_changed (this); /* EMIT SIGNAL */
959 _mute_control->Changed (); /* EMIT SIGNAL */
964 Route::set_mute (bool yn, void *src)
966 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
967 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
972 _mute_master->set_muted_by_self (yn);
973 /* allow any derived classes to respond to the mute change
974 before anybody else knows about it.
977 /* tell everyone else */
978 mute_changed (src); /* EMIT SIGNAL */
979 _mute_control->Changed (); /* EMIT SIGNAL */
984 Route::muted () const
986 return _mute_master->muted_by_self();
991 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
993 cerr << name << " {" << endl;
994 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
995 p != procs.end(); ++p) {
996 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
1002 /** Supposing that we want to insert a Processor at a given Placement, return
1003 * the processor to add the new one before (or 0 to add at the end).
1005 boost::shared_ptr<Processor>
1006 Route::before_processor_for_placement (Placement p)
1008 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1010 ProcessorList::iterator loc;
1012 if (p == PreFader) {
1013 /* generic pre-fader: insert immediately before the amp */
1014 loc = find (_processors.begin(), _processors.end(), _amp);
1016 /* generic post-fader: insert right before the main outs */
1017 loc = find (_processors.begin(), _processors.end(), _main_outs);
1020 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
1023 /** Supposing that we want to insert a Processor at a given index, return
1024 * the processor to add the new one before (or 0 to add at the end).
1026 boost::shared_ptr<Processor>
1027 Route::before_processor_for_index (int index)
1030 return boost::shared_ptr<Processor> ();
1033 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1035 ProcessorList::iterator i = _processors.begin ();
1037 while (i != _processors.end() && j < index) {
1038 if ((*i)->display_to_user()) {
1045 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
1048 /** Add a processor either pre- or post-fader
1049 * @return 0 on success, non-0 on failure.
1052 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
1054 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
1058 /** Add a processor to a route such that it ends up with a given index into the visible processors.
1059 * @param index Index to add the processor at, or -1 to add at the end of the list.
1060 * @return 0 on success, non-0 on failure.
1063 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
1065 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
1068 /** Add a processor to the route.
1069 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
1070 * @return 0 on success, non-0 on failure.
1073 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
1075 assert (processor != _meter);
1076 assert (processor != _main_outs);
1078 DEBUG_TRACE (DEBUG::Processors, string_compose (
1079 "%1 adding processor %2\n", name(), processor->name()));
1081 if (!AudioEngine::instance()->connected() || !processor) {
1086 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1087 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1088 ProcessorState pstate (this);
1090 boost::shared_ptr<PluginInsert> pi;
1091 boost::shared_ptr<PortInsert> porti;
1093 if (processor == _amp) {
1094 /* Ensure that only one amp is in the list at any time */
1095 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), processor);
1096 if (check != _processors.end()) {
1097 if (before == _amp) {
1098 /* Already in position; all is well */
1101 _processors.erase (check);
1106 assert (find (_processors.begin(), _processors.end(), processor) == _processors.end ());
1108 ProcessorList::iterator loc;
1110 /* inserting before a processor; find it */
1111 loc = find (_processors.begin(), _processors.end(), before);
1112 if (loc == _processors.end ()) {
1117 /* inserting at end */
1118 loc = _processors.end ();
1121 _processors.insert (loc, processor);
1122 processor->set_owner (this);
1124 // Set up processor list channels. This will set processor->[input|output]_streams(),
1125 // configure redirect ports properly, etc.
1128 if (configure_processors_unlocked (err)) {
1130 configure_processors_unlocked (0); // it worked before we tried to add it ...
1135 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1137 if (pi->has_no_inputs ()) {
1138 /* generator plugin */
1139 _have_internal_generator = true;
1144 if (activation_allowed && !_session.get_disable_all_loaded_plugins()) {
1145 processor->activate ();
1148 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1150 _output->set_user_latency (0);
1153 reset_instrument_info ();
1154 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1155 set_processor_positions ();
1161 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1163 const XMLProperty *prop;
1166 boost::shared_ptr<Processor> processor;
1168 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1169 so that we can add the processor in the right place (pre/post-fader)
1172 XMLNodeList const & children = node.children ();
1173 XMLNodeList::const_iterator i = children.begin ();
1175 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1179 Placement placement = PreFader;
1181 if (i != children.end()) {
1182 if ((prop = (*i)->property (X_("placement"))) != 0) {
1183 placement = Placement (string_2_enum (prop->value(), placement));
1187 if (node.name() == "Insert") {
1189 if ((prop = node.property ("type")) != 0) {
1191 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1192 prop->value() == "lv2" ||
1193 prop->value() == "windows-vst" ||
1194 prop->value() == "lxvst" ||
1195 prop->value() == "audiounit") {
1197 processor.reset (new PluginInsert (_session));
1201 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1206 } else if (node.name() == "Send") {
1208 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
1209 processor.reset (new Send (_session, sendpan, _mute_master));
1213 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1217 if (processor->set_state (node, version)) {
1221 return (add_processor (processor, placement) == 0);
1224 catch (failed_constructor &err) {
1225 warning << _("processor could not be created. Ignored.") << endmsg;
1231 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1233 /* NOTE: this is intended to be used ONLY when copying
1234 processors from another Route. Hence the subtle
1235 differences between this and ::add_processor()
1238 ProcessorList::iterator loc;
1241 loc = find(_processors.begin(), _processors.end(), before);
1243 /* nothing specified - at end */
1244 loc = _processors.end ();
1247 if (!_session.engine().connected()) {
1251 if (others.empty()) {
1256 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1257 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1258 ProcessorState pstate (this);
1260 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1266 boost::shared_ptr<PluginInsert> pi;
1268 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1272 _processors.insert (loc, *i);
1273 (*i)->set_owner (this);
1275 if ((*i)->active()) {
1279 /* Think: does this really need to be called for every processor in the loop? */
1281 if (configure_processors_unlocked (err)) {
1283 configure_processors_unlocked (0); // it worked before we tried to add it ...
1288 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1291 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1292 boost::shared_ptr<PluginInsert> pi;
1294 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1295 if (pi->has_no_inputs ()) {
1296 _have_internal_generator = true;
1302 _output->set_user_latency (0);
1305 reset_instrument_info ();
1306 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1307 set_processor_positions ();
1313 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1315 if (p == PreFader) {
1316 start = _processors.begin();
1317 end = find(_processors.begin(), _processors.end(), _amp);
1319 start = find(_processors.begin(), _processors.end(), _amp);
1321 end = _processors.end();
1325 /** Turn off all processors with a given placement
1326 * @param p Placement of processors to disable
1329 Route::disable_processors (Placement p)
1331 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1333 ProcessorList::iterator start, end;
1334 placement_range(p, start, end);
1336 for (ProcessorList::iterator i = start; i != end; ++i) {
1337 (*i)->deactivate ();
1340 _session.set_dirty ();
1343 /** Turn off all redirects
1346 Route::disable_processors ()
1348 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1350 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1351 (*i)->deactivate ();
1354 _session.set_dirty ();
1357 /** Turn off all redirects with a given placement
1358 * @param p Placement of redirects to disable
1361 Route::disable_plugins (Placement p)
1363 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1365 ProcessorList::iterator start, end;
1366 placement_range(p, start, end);
1368 for (ProcessorList::iterator i = start; i != end; ++i) {
1369 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1370 (*i)->deactivate ();
1374 _session.set_dirty ();
1377 /** Turn off all plugins
1380 Route::disable_plugins ()
1382 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1384 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1385 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1386 (*i)->deactivate ();
1390 _session.set_dirty ();
1395 Route::ab_plugins (bool forward)
1397 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1401 /* forward = turn off all active redirects, and mark them so that the next time
1402 we go the other way, we will revert them
1405 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1406 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1410 if ((*i)->active()) {
1411 (*i)->deactivate ();
1412 (*i)->set_next_ab_is_active (true);
1414 (*i)->set_next_ab_is_active (false);
1420 /* backward = if the redirect was marked to go active on the next ab, do so */
1422 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1424 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1428 if ((*i)->get_next_ab_is_active()) {
1431 (*i)->deactivate ();
1436 _session.set_dirty ();
1440 /** Remove processors with a given placement.
1441 * @param p Placement of processors to remove.
1444 Route::clear_processors (Placement p)
1446 if (!_session.engine().connected()) {
1450 bool already_deleting = _session.deletion_in_progress();
1451 if (!already_deleting) {
1452 _session.set_deletion_in_progress();
1456 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1457 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1458 ProcessorList new_list;
1459 ProcessorStreams err;
1460 bool seen_amp = false;
1462 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1468 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs || (*i) == _delayline) {
1470 /* you can't remove these */
1472 new_list.push_back (*i);
1479 new_list.push_back (*i);
1482 (*i)->drop_references ();
1490 (*i)->drop_references ();
1493 new_list.push_back (*i);
1500 _processors = new_list;
1501 configure_processors_unlocked (&err); // this can't fail
1504 processor_max_streams.reset();
1505 _have_internal_generator = false;
1506 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1507 set_processor_positions ();
1509 reset_instrument_info ();
1511 if (!already_deleting) {
1512 _session.clear_deletion_in_progress();
1517 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1519 // TODO once the export point can be configured properly, do something smarter here
1520 if (processor == _capturing_processor) {
1521 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1522 if (need_process_lock) {
1526 _capturing_processor.reset();
1528 if (need_process_lock) {
1533 /* these can never be removed */
1535 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline) {
1539 if (!_session.engine().connected()) {
1543 processor_max_streams.reset();
1546 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1547 if (need_process_lock) {
1551 /* Caller must hold process lock */
1552 assert (!AudioEngine::instance()->process_lock().trylock());
1554 Glib::Threads::RWLock::WriterLock lm (_processor_lock); // XXX deadlock after export
1556 ProcessorState pstate (this);
1558 ProcessorList::iterator i;
1559 bool removed = false;
1561 for (i = _processors.begin(); i != _processors.end(); ) {
1562 if (*i == processor) {
1564 /* move along, see failure case for configure_processors()
1565 where we may need to reconfigure the processor.
1568 /* stop redirects that send signals to JACK ports
1569 from causing noise as a result of no longer being
1573 boost::shared_ptr<IOProcessor> iop;
1575 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1579 i = _processors.erase (i);
1587 _output->set_user_latency (0);
1595 if (configure_processors_unlocked (err)) {
1597 /* we know this will work, because it worked before :) */
1598 configure_processors_unlocked (0);
1602 _have_internal_generator = false;
1604 for (i = _processors.begin(); i != _processors.end(); ++i) {
1605 boost::shared_ptr<PluginInsert> pi;
1607 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1608 if (pi->has_no_inputs ()) {
1609 _have_internal_generator = true;
1614 if (need_process_lock) {
1619 reset_instrument_info ();
1620 processor->drop_references ();
1621 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1622 set_processor_positions ();
1628 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1630 ProcessorList deleted;
1632 if (!_session.engine().connected()) {
1636 processor_max_streams.reset();
1639 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1640 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1641 ProcessorState pstate (this);
1643 ProcessorList::iterator i;
1644 boost::shared_ptr<Processor> processor;
1646 for (i = _processors.begin(); i != _processors.end(); ) {
1650 /* these can never be removed */
1652 if (processor == _amp || processor == _meter || processor == _main_outs || processor == _delayline) {
1657 /* see if its in the list of processors to delete */
1659 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1664 /* stop IOProcessors that send to JACK ports
1665 from causing noise as a result of no longer being
1669 boost::shared_ptr<IOProcessor> iop;
1671 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1675 deleted.push_back (processor);
1676 i = _processors.erase (i);
1679 if (deleted.empty()) {
1680 /* none of those in the requested list were found */
1684 _output->set_user_latency (0);
1686 if (configure_processors_unlocked (err)) {
1688 /* we know this will work, because it worked before :) */
1689 configure_processors_unlocked (0);
1694 _have_internal_generator = false;
1696 for (i = _processors.begin(); i != _processors.end(); ++i) {
1697 boost::shared_ptr<PluginInsert> pi;
1699 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1700 if (pi->has_no_inputs ()) {
1701 _have_internal_generator = true;
1708 /* now try to do what we need to so that those that were removed will be deleted */
1710 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1711 (*i)->drop_references ();
1714 reset_instrument_info ();
1715 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1716 set_processor_positions ();
1722 Route::reset_instrument_info ()
1724 boost::shared_ptr<Processor> instr = the_instrument();
1726 _instrument_info.set_internal_instrument (instr);
1730 /** Caller must hold process lock */
1732 Route::configure_processors (ProcessorStreams* err)
1734 #ifndef PLATFORM_WINDOWS
1735 assert (!AudioEngine::instance()->process_lock().trylock());
1738 if (!_in_configure_processors) {
1739 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1740 return configure_processors_unlocked (err);
1747 Route::input_streams () const
1749 return _input->n_ports ();
1752 list<pair<ChanCount, ChanCount> >
1753 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1755 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1757 return try_configure_processors_unlocked (in, err);
1760 list<pair<ChanCount, ChanCount> >
1761 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1763 // Check each processor in order to see if we can configure as requested
1765 list<pair<ChanCount, ChanCount> > configuration;
1768 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1769 DEBUG_TRACE (DEBUG::Processors, "{\n");
1771 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1773 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1774 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1775 DEBUG_TRACE (DEBUG::Processors, "}\n");
1776 return list<pair<ChanCount, ChanCount> > ();
1779 if ((*p)->can_support_io_configuration(in, out)) {
1780 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1781 configuration.push_back(make_pair(in, out));
1788 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1789 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1790 DEBUG_TRACE (DEBUG::Processors, "}\n");
1791 return list<pair<ChanCount, ChanCount> > ();
1795 DEBUG_TRACE (DEBUG::Processors, "}\n");
1797 return configuration;
1800 /** Set the input/output configuration of each processor in the processors list.
1801 * Caller must hold process lock.
1802 * Return 0 on success, otherwise configuration is impossible.
1805 Route::configure_processors_unlocked (ProcessorStreams* err)
1807 #ifndef PLATFORM_WINDOWS
1808 assert (!AudioEngine::instance()->process_lock().trylock());
1811 if (_in_configure_processors) {
1815 /* put invisible processors where they should be */
1816 setup_invisible_processors ();
1818 _in_configure_processors = true;
1820 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1822 if (configuration.empty ()) {
1823 _in_configure_processors = false;
1828 bool seen_mains_out = false;
1829 processor_out_streams = _input->n_ports();
1830 processor_max_streams.reset();
1832 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1833 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1835 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1839 (*p)->configure_io(c->first, c->second);
1840 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1841 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1844 if (boost::dynamic_pointer_cast<Delivery> (*p)
1845 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1846 /* main delivery will increase port count to match input.
1847 * the Delivery::Main is usually the last processor - followed only by
1850 seen_mains_out = true;
1852 if (!seen_mains_out) {
1853 processor_out_streams = out;
1859 _meter->reset_max_channels (processor_max_streams);
1862 /* make sure we have sufficient scratch buffers to cope with the new processor
1865 _session.ensure_buffers (n_process_buffers ());
1867 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1869 _in_configure_processors = false;
1873 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1874 * @param state New active state for those processors.
1877 Route::all_visible_processors_active (bool state)
1879 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1881 if (_processors.empty()) {
1885 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1886 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1893 (*i)->deactivate ();
1897 _session.set_dirty ();
1901 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1903 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1904 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1905 processors in the current actual processor list that are hidden. Any visible processors
1906 in the current list but not in "new_order" will be assumed to be deleted.
1910 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1911 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1912 ProcessorState pstate (this);
1914 ProcessorList::iterator oiter;
1915 ProcessorList::const_iterator niter;
1916 ProcessorList as_it_will_be;
1918 oiter = _processors.begin();
1919 niter = new_order.begin();
1921 while (niter != new_order.end()) {
1923 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1924 then append it to the temp list.
1926 Otherwise, see if the next processor in the old list is in the new list. if not,
1927 its been deleted. If its there, append it to the temp list.
1930 if (oiter == _processors.end()) {
1932 /* no more elements in the old list, so just stick the rest of
1933 the new order onto the temp list.
1936 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1937 while (niter != new_order.end()) {
1944 if (!(*oiter)->display_to_user()) {
1946 as_it_will_be.push_back (*oiter);
1950 /* visible processor: check that its in the new order */
1952 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1953 /* deleted: do nothing, shared_ptr<> will clean up */
1955 /* ignore this one, and add the next item from the new order instead */
1956 as_it_will_be.push_back (*niter);
1961 /* now remove from old order - its taken care of no matter what */
1962 oiter = _processors.erase (oiter);
1967 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1969 /* If the meter is in a custom position, find it and make a rough note of its position */
1970 maybe_note_meter_position ();
1972 if (configure_processors_unlocked (err)) {
1978 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1979 set_processor_positions ();
1991 Route::get_template()
1993 return state(false);
1997 Route::state(bool full_state)
1999 XMLNode *node = new XMLNode("Route");
2000 ProcessorList::iterator i;
2003 id().print (buf, sizeof (buf));
2004 node->add_property("id", buf);
2005 node->add_property ("name", _name);
2006 node->add_property("default-type", _default_type.to_string());
2009 node->add_property("flags", enum_2_string (_flags));
2012 node->add_property("active", _active?"yes":"no");
2014 boost::to_string (_phase_invert, p);
2015 node->add_property("phase-invert", p);
2016 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
2017 node->add_property("meter-point", enum_2_string (_meter_point));
2019 node->add_property("meter-type", enum_2_string (_meter_type));
2022 node->add_property("route-group", _route_group->name());
2025 snprintf (buf, sizeof (buf), "%d", _order_key);
2026 node->add_property ("order-key", buf);
2027 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
2028 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
2029 node->add_property ("soloed-by-upstream", buf);
2030 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
2031 node->add_property ("soloed-by-downstream", buf);
2032 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
2033 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
2035 node->add_child_nocopy (_input->state (full_state));
2036 node->add_child_nocopy (_output->state (full_state));
2037 node->add_child_nocopy (_solo_control->get_state ());
2038 node->add_child_nocopy (_mute_control->get_state ());
2039 node->add_child_nocopy (_mute_master->get_state ());
2042 node->add_child_nocopy (Automatable::get_automation_xml_state ());
2045 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
2046 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
2047 remote_control_node->add_property (X_("id"), buf);
2048 node->add_child_nocopy (*remote_control_node);
2050 if (_comment.length()) {
2051 XMLNode *cmt = node->add_child ("Comment");
2052 cmt->add_content (_comment);
2056 node->add_child_nocopy (_pannable->state (full_state));
2059 for (i = _processors.begin(); i != _processors.end(); ++i) {
2061 /* template save: do not include internal sends functioning as
2062 aux sends because the chance of the target ID
2063 in the session where this template is used
2066 similarly, do not save listen sends which connect to
2067 the monitor section, because these will always be
2070 boost::shared_ptr<InternalSend> is;
2072 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
2073 if (is->role() == Delivery::Listen) {
2078 node->add_child_nocopy((*i)->state (full_state));
2082 node->add_child_copy (*_extra_xml);
2085 if (_custom_meter_position_noted) {
2086 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
2088 after->id().print (buf, sizeof (buf));
2089 node->add_property (X_("processor-after-last-custom-meter"), buf);
2092 node->add_property (X_("last-custom-meter-was-at-end"), _last_custom_meter_was_at_end ? "yes" : "no");
2099 Route::set_state (const XMLNode& node, int version)
2101 if (version < 3000) {
2102 return set_state_2X (node, version);
2106 XMLNodeConstIterator niter;
2108 const XMLProperty *prop;
2110 if (node.name() != "Route"){
2111 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2115 if ((prop = node.property (X_("name"))) != 0) {
2116 Route::set_name (prop->value());
2120 _initial_io_setup = true;
2122 if ((prop = node.property (X_("flags"))) != 0) {
2123 _flags = Flag (string_2_enum (prop->value(), _flags));
2128 if (is_master() || is_monitor() || is_auditioner()) {
2129 _mute_master->set_solo_ignore (true);
2133 /* monitor bus does not get a panner, but if (re)created
2134 via XML, it will already have one by the time we
2135 call ::set_state(). so ... remove it.
2140 /* add all processors (except amp, which is always present) */
2142 nlist = node.children();
2143 XMLNode processor_state (X_("processor_state"));
2145 Stateful::save_extra_xml (node);
2147 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2151 if (child->name() == IO::state_node_name) {
2152 if ((prop = child->property (X_("direction"))) == 0) {
2156 if (prop->value() == "Input") {
2157 _input->set_state (*child, version);
2158 } else if (prop->value() == "Output") {
2159 _output->set_state (*child, version);
2163 if (child->name() == X_("Processor")) {
2164 processor_state.add_child_copy (*child);
2167 if (child->name() == X_("Pannable")) {
2169 _pannable->set_state (*child, version);
2171 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2176 if ((prop = node.property (X_("meter-point"))) != 0) {
2177 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2178 set_meter_point (mp, true);
2180 _meter->set_display_to_user (_meter_point == MeterCustom);
2184 if ((prop = node.property (X_("meter-type"))) != 0) {
2185 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2188 _initial_io_setup = false;
2190 set_processor_state (processor_state);
2192 // this looks up the internal instrument in processors
2193 reset_instrument_info();
2195 if ((prop = node.property ("self-solo")) != 0) {
2196 set_self_solo (string_is_affirmative (prop->value()));
2199 if ((prop = node.property ("soloed-by-upstream")) != 0) {
2200 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
2201 mod_solo_by_others_upstream (atoi (prop->value()));
2204 if ((prop = node.property ("soloed-by-downstream")) != 0) {
2205 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
2206 mod_solo_by_others_downstream (atoi (prop->value()));
2209 if ((prop = node.property ("solo-isolated")) != 0) {
2210 set_solo_isolated (string_is_affirmative (prop->value()), this);
2213 if ((prop = node.property ("solo-safe")) != 0) {
2214 set_solo_safe (string_is_affirmative (prop->value()), this);
2217 if ((prop = node.property (X_("phase-invert"))) != 0) {
2218 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2221 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2222 set_denormal_protection (string_is_affirmative (prop->value()));
2225 if ((prop = node.property (X_("active"))) != 0) {
2226 bool yn = string_is_affirmative (prop->value());
2227 _active = !yn; // force switch
2228 set_active (yn, this);
2231 if ((prop = node.property (X_("order-key"))) != 0) { // New order key (no separate mixer/editor ordering)
2232 set_order_key (atoi(prop->value()));
2235 if ((prop = node.property (X_("order-keys"))) != 0) { // Deprecated order keys
2239 string::size_type colon, equal;
2240 string remaining = prop->value();
2242 while (remaining.length()) {
2244 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2245 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2248 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2249 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2252 string keyname = remaining.substr (0, equal);
2254 if ((keyname == "EditorSort") || (keyname == "editor")) {
2255 cerr << "Setting " << name() << " order key to " << n << " using saved Editor order." << endl;
2261 colon = remaining.find_first_of (':');
2263 if (colon != string::npos) {
2264 remaining = remaining.substr (colon+1);
2271 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2272 PBD::ID id (prop->value ());
2273 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2274 ProcessorList::const_iterator i = _processors.begin ();
2275 while (i != _processors.end() && (*i)->id() != id) {
2279 if (i != _processors.end ()) {
2280 _processor_after_last_custom_meter = *i;
2281 _custom_meter_position_noted = true;
2285 if ((prop = node.property (X_("last-custom-meter-was-at-end"))) != 0) {
2286 _last_custom_meter_was_at_end = string_is_affirmative (prop->value ());
2289 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2292 if (child->name() == X_("Comment")) {
2294 /* XXX this is a terrible API design in libxml++ */
2296 XMLNode *cmt = *(child->children().begin());
2297 _comment = cmt->content();
2299 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2300 if (prop->value() == "solo") {
2301 _solo_control->set_state (*child, version);
2302 } else if (prop->value() == "mute") {
2303 _mute_control->set_state (*child, version);
2306 } else if (child->name() == X_("RemoteControl")) {
2307 if ((prop = child->property (X_("id"))) != 0) {
2309 sscanf (prop->value().c_str(), "%d", &x);
2310 set_remote_control_id_internal (x);
2313 } else if (child->name() == X_("MuteMaster")) {
2314 _mute_master->set_state (*child, version);
2316 } else if (child->name() == Automatable::xml_node_name) {
2317 set_automation_xml_state (*child, Evoral::Parameter(NullAutomation));
2325 Route::set_state_2X (const XMLNode& node, int version)
2328 XMLNodeConstIterator niter;
2330 const XMLProperty *prop;
2332 /* 2X things which still remain to be handled:
2338 if (node.name() != "Route") {
2339 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2343 if ((prop = node.property (X_("flags"))) != 0) {
2344 string f = prop->value ();
2345 boost::replace_all (f, "ControlOut", "MonitorOut");
2346 _flags = Flag (string_2_enum (f, _flags));
2351 if (is_master() || is_monitor() || is_auditioner()) {
2352 _mute_master->set_solo_ignore (true);
2355 if ((prop = node.property (X_("phase-invert"))) != 0) {
2356 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2357 if (string_is_affirmative (prop->value ())) {
2360 set_phase_invert (p);
2363 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2364 set_denormal_protection (string_is_affirmative (prop->value()));
2367 if ((prop = node.property (X_("soloed"))) != 0) {
2368 bool yn = string_is_affirmative (prop->value());
2370 /* XXX force reset of solo status */
2372 set_solo (yn, this);
2375 if ((prop = node.property (X_("muted"))) != 0) {
2378 bool muted = string_is_affirmative (prop->value());
2384 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2386 if (string_is_affirmative (prop->value())){
2387 mute_point = mute_point + "PreFader";
2392 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2394 if (string_is_affirmative (prop->value())){
2397 mute_point = mute_point + ",";
2400 mute_point = mute_point + "PostFader";
2405 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2407 if (string_is_affirmative (prop->value())){
2410 mute_point = mute_point + ",";
2413 mute_point = mute_point + "Listen";
2418 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2420 if (string_is_affirmative (prop->value())){
2423 mute_point = mute_point + ",";
2426 mute_point = mute_point + "Main";
2430 _mute_master->set_mute_points (mute_point);
2431 _mute_master->set_muted_by_self (true);
2435 if ((prop = node.property (X_("meter-point"))) != 0) {
2436 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2439 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2440 don't mean the same thing.
2443 if ((prop = node.property (X_("order-keys"))) != 0) {
2447 string::size_type colon, equal;
2448 string remaining = prop->value();
2450 while (remaining.length()) {
2452 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2453 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2456 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2457 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2460 string keyname = remaining.substr (0, equal);
2462 if (keyname == "EditorSort" || keyname == "editor") {
2463 info << string_compose(_("Converting deprecated order key for %1 using Editor order %2"), name (), n) << endmsg;
2469 colon = remaining.find_first_of (':');
2471 if (colon != string::npos) {
2472 remaining = remaining.substr (colon+1);
2481 nlist = node.children ();
2482 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2486 if (child->name() == IO::state_node_name) {
2488 /* there is a note in IO::set_state_2X() about why we have to call
2492 _input->set_state_2X (*child, version, true);
2493 _output->set_state_2X (*child, version, false);
2495 if ((prop = child->property (X_("name"))) != 0) {
2496 Route::set_name (prop->value ());
2501 if ((prop = child->property (X_("active"))) != 0) {
2502 bool yn = string_is_affirmative (prop->value());
2503 _active = !yn; // force switch
2504 set_active (yn, this);
2507 if ((prop = child->property (X_("gain"))) != 0) {
2510 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2511 _amp->gain_control()->set_value (val);
2515 /* Set up Panners in the IO */
2516 XMLNodeList io_nlist = child->children ();
2518 XMLNodeConstIterator io_niter;
2521 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2523 io_child = *io_niter;
2525 if (io_child->name() == X_("Panner")) {
2526 _main_outs->panner_shell()->set_state(*io_child, version);
2527 } else if (io_child->name() == X_("Automation")) {
2528 /* IO's automation is for the fader */
2529 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2535 XMLNodeList redirect_nodes;
2537 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2541 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2542 redirect_nodes.push_back(child);
2547 set_processor_state_2X (redirect_nodes, version);
2549 Stateful::save_extra_xml (node);
2551 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2554 if (child->name() == X_("Comment")) {
2556 /* XXX this is a terrible API design in libxml++ */
2558 XMLNode *cmt = *(child->children().begin());
2559 _comment = cmt->content();
2561 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2562 if (prop->value() == X_("solo")) {
2563 _solo_control->set_state (*child, version);
2564 } else if (prop->value() == X_("mute")) {
2565 _mute_control->set_state (*child, version);
2568 } else if (child->name() == X_("RemoteControl")) {
2569 if ((prop = child->property (X_("id"))) != 0) {
2571 sscanf (prop->value().c_str(), "%d", &x);
2572 set_remote_control_id_internal (x);
2582 Route::get_processor_state ()
2584 XMLNode* root = new XMLNode (X_("redirects"));
2585 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2586 root->add_child_nocopy ((*i)->state (true));
2593 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2595 /* We don't bother removing existing processors not in nList, as this
2596 method will only be called when creating a Route from scratch, not
2597 for undo purposes. Just put processors in at the appropriate place
2601 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2602 add_processor_from_xml_2X (**i, version);
2607 Route::set_processor_state (const XMLNode& node)
2609 const XMLNodeList &nlist = node.children();
2610 XMLNodeConstIterator niter;
2611 ProcessorList new_order;
2612 bool must_configure = false;
2614 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2616 XMLProperty* prop = (*niter)->property ("type");
2618 if (prop->value() == "amp") {
2619 _amp->set_state (**niter, Stateful::current_state_version);
2620 new_order.push_back (_amp);
2621 } else if (prop->value() == "meter") {
2622 _meter->set_state (**niter, Stateful::current_state_version);
2623 new_order.push_back (_meter);
2624 } else if (prop->value() == "delay") {
2626 _delayline->set_state (**niter, Stateful::current_state_version);
2627 new_order.push_back (_delayline);
2629 } else if (prop->value() == "main-outs") {
2630 _main_outs->set_state (**niter, Stateful::current_state_version);
2631 } else if (prop->value() == "intreturn") {
2633 _intreturn.reset (new InternalReturn (_session));
2634 must_configure = true;
2636 _intreturn->set_state (**niter, Stateful::current_state_version);
2637 } else if (is_monitor() && prop->value() == "monitor") {
2638 if (!_monitor_control) {
2639 _monitor_control.reset (new MonitorProcessor (_session));
2640 must_configure = true;
2642 _monitor_control->set_state (**niter, Stateful::current_state_version);
2643 } else if (prop->value() == "capture") {
2644 /* CapturingProcessor should never be restored, it's always
2645 added explicitly when needed */
2647 ProcessorList::iterator o;
2649 for (o = _processors.begin(); o != _processors.end(); ++o) {
2650 XMLProperty* id_prop = (*niter)->property(X_("id"));
2651 if (id_prop && (*o)->id() == id_prop->value()) {
2652 (*o)->set_state (**niter, Stateful::current_state_version);
2653 new_order.push_back (*o);
2658 // If the processor (*niter) is not on the route then create it
2660 if (o == _processors.end()) {
2662 boost::shared_ptr<Processor> processor;
2664 if (prop->value() == "intsend") {
2666 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), boost::shared_ptr<Route>(), Delivery::Aux, true));
2668 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2669 prop->value() == "lv2" ||
2670 prop->value() == "windows-vst" ||
2671 prop->value() == "lxvst" ||
2672 prop->value() == "audiounit") {
2674 processor.reset (new PluginInsert(_session));
2676 } else if (prop->value() == "port") {
2678 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2680 } else if (prop->value() == "send") {
2682 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2685 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2689 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2690 /* This processor could not be configured. Turn it into a UnknownProcessor */
2691 processor.reset (new UnknownProcessor (_session, **niter));
2694 /* we have to note the monitor send here, otherwise a new one will be created
2695 and the state of this one will be lost.
2697 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2698 if (isend && isend->role() == Delivery::Listen) {
2699 _monitor_send = isend;
2702 /* it doesn't matter if invisible processors are added here, as they
2703 will be sorted out by setup_invisible_processors () shortly.
2706 new_order.push_back (processor);
2707 must_configure = true;
2713 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2714 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2715 _processors = new_order;
2717 if (must_configure) {
2718 configure_processors_unlocked (0);
2721 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2723 (*i)->set_owner (this);
2724 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2726 boost::shared_ptr<PluginInsert> pi;
2728 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2729 if (pi->has_no_inputs ()) {
2730 _have_internal_generator = true;
2737 reset_instrument_info ();
2738 processors_changed (RouteProcessorChange ());
2739 set_processor_positions ();
2743 Route::curve_reallocate ()
2745 // _gain_automation_curve.finish_resize ();
2746 // _pan_automation_curve.finish_resize ();
2750 Route::silence (framecnt_t nframes)
2752 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2757 silence_unlocked (nframes);
2761 Route::silence_unlocked (framecnt_t nframes)
2763 /* Must be called with the processor lock held */
2767 _output->silence (nframes);
2769 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2770 boost::shared_ptr<PluginInsert> pi;
2772 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2773 // skip plugins, they don't need anything when we're not active
2777 (*i)->silence (nframes);
2780 if (nframes == _session.get_block_size()) {
2787 Route::add_internal_return ()
2790 _intreturn.reset (new InternalReturn (_session));
2791 add_processor (_intreturn, PreFader);
2796 Route::add_send_to_internal_return (InternalSend* send)
2798 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2800 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2801 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2804 return d->add_send (send);
2810 Route::remove_send_from_internal_return (InternalSend* send)
2812 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2814 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2815 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2818 return d->remove_send (send);
2824 Route::enable_monitor_send ()
2826 /* Caller must hold process lock */
2827 assert (!AudioEngine::instance()->process_lock().trylock());
2829 /* master never sends to monitor section via the normal mechanism */
2830 assert (!is_master ());
2831 assert (!is_monitor ());
2833 /* make sure we have one */
2834 if (!_monitor_send) {
2835 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), _session.monitor_out(), Delivery::Listen));
2836 _monitor_send->set_display_to_user (false);
2840 configure_processors (0);
2843 /** Add an aux send to a route.
2844 * @param route route to send to.
2845 * @param before Processor to insert before, or 0 to insert at the end.
2848 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2850 assert (route != _session.monitor_out ());
2853 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2855 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2857 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2859 if (d && d->target_route() == route) {
2860 /* already listening via the specified IO: do nothing */
2868 boost::shared_ptr<InternalSend> listener;
2871 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2872 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2873 listener.reset (new InternalSend (_session, sendpan, _mute_master, boost::dynamic_pointer_cast<ARDOUR::Route>(shared_from_this()), route, Delivery::Aux));
2876 add_processor (listener, before);
2878 } catch (failed_constructor& err) {
2886 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
2888 ProcessorStreams err;
2889 ProcessorList::iterator tmp;
2892 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
2894 /* have to do this early because otherwise processor reconfig
2895 * will put _monitor_send back in the list
2898 if (route == _session.monitor_out()) {
2899 _monitor_send.reset ();
2903 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2905 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2907 if (d && d->target_route() == route) {
2909 remove_processor (*x, &err, false);
2912 /* list could have been demolished while we dropped the lock
2923 Route::set_comment (string cmt, void *src)
2926 comment_changed (src);
2927 _session.set_dirty ();
2931 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2933 FeedRecord fr (other, via_sends_only);
2935 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2937 if (!result.second) {
2939 /* already a record for "other" - make sure sends-only information is correct */
2940 if (!via_sends_only && result.first->sends_only) {
2941 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2942 frp->sends_only = false;
2946 return result.second;
2950 Route::clear_fed_by ()
2956 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2958 const FedBy& fed_by (other->fed_by());
2960 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2961 boost::shared_ptr<Route> sr = f->r.lock();
2963 if (sr && (sr.get() == this)) {
2965 if (via_sends_only) {
2966 *via_sends_only = f->sends_only;
2977 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
2979 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2981 if (_output->connected_to (other->input())) {
2982 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2983 if (via_send_only) {
2984 *via_send_only = false;
2991 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2993 boost::shared_ptr<IOProcessor> iop;
2995 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2996 if (iop->feeds (other)) {
2997 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2998 if (via_send_only) {
2999 *via_send_only = true;
3003 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
3006 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
3011 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
3016 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
3018 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
3021 /** Called from the (non-realtime) butler thread when the transport is stopped */
3023 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
3025 framepos_t now = _session.transport_frame();
3028 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3030 Automatable::transport_stopped (now);
3032 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3034 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
3038 (*i)->transport_stopped (now);
3042 _roll_delay = _initial_delay;
3046 Route::input_change_handler (IOChange change, void * /*src*/)
3048 bool need_to_queue_solo_change = true;
3050 if ((change.type & IOChange::ConfigurationChanged)) {
3051 /* This is called with the process lock held if change
3052 contains ConfigurationChanged
3054 need_to_queue_solo_change = false;
3055 configure_processors (0);
3056 _phase_invert.resize (_input->n_ports().n_audio ());
3057 io_changed (); /* EMIT SIGNAL */
3060 if (!_input->connected() && _soloed_by_others_upstream) {
3061 if (need_to_queue_solo_change) {
3062 _session.cancel_solo_after_disconnect (shared_from_this(), true);
3064 cancel_solo_after_disconnect (true);
3070 Route::output_change_handler (IOChange change, void * /*src*/)
3072 bool need_to_queue_solo_change = true;
3073 if (_initial_io_setup) {
3077 if ((change.type & IOChange::ConfigurationChanged)) {
3078 /* This is called with the process lock held if change
3079 contains ConfigurationChanged
3081 need_to_queue_solo_change = false;
3082 configure_processors (0);
3083 io_changed (); /* EMIT SIGNAL */
3086 if (!_output->connected() && _soloed_by_others_downstream) {
3087 if (need_to_queue_solo_change) {
3088 _session.cancel_solo_after_disconnect (shared_from_this(), false);
3090 cancel_solo_after_disconnect (false);
3096 Route::cancel_solo_after_disconnect (bool upstream)
3099 _soloed_by_others_upstream = 0;
3101 _soloed_by_others_downstream = 0;
3103 set_mute_master_solo ();
3104 solo_changed (false, this);
3108 Route::pans_required () const
3110 if (n_outputs().n_audio() < 2) {
3114 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3118 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3120 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3126 if (n_outputs().n_total() == 0) {
3130 if (!_active || n_inputs() == ChanCount::ZERO) {
3131 silence_unlocked (nframes);
3135 if (session_state_changing) {
3136 if (_session.transport_speed() != 0.0f) {
3137 /* we're rolling but some state is changing (e.g. our diskstream contents)
3138 so we cannot use them. Be silent till this is over.
3140 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3142 silence_unlocked (nframes);
3145 /* we're really not rolling, so we're either delivery silence or actually
3146 monitoring, both of which are safe to do while session_state_changing is true.
3150 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3152 fill_buffers_with_input (bufs, _input, nframes);
3154 if (_meter_point == MeterInput) {
3155 _meter->run (bufs, start_frame, end_frame, nframes, true);
3158 _amp->apply_gain_automation (false);
3159 passthru (bufs, start_frame, end_frame, nframes, 0);
3165 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3167 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3172 if (n_outputs().n_total() == 0) {
3176 if (!_active || n_inputs().n_total() == 0) {
3177 silence_unlocked (nframes);
3181 framepos_t unused = 0;
3183 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3189 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3191 fill_buffers_with_input (bufs, _input, nframes);
3193 if (_meter_point == MeterInput) {
3194 _meter->run (bufs, start_frame, end_frame, nframes, true);
3197 passthru (bufs, start_frame, end_frame, nframes, declick);
3203 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3210 Route::flush_processors ()
3212 /* XXX shouldn't really try to take this lock, since
3213 this is called from the RT audio thread.
3216 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3218 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3224 Route::set_meter_point (MeterPoint p, bool force)
3226 if (_meter_point == p && !force) {
3230 bool meter_was_visible_to_user = _meter->display_to_user ();
3233 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3234 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3236 maybe_note_meter_position ();
3240 if (_meter_point != MeterCustom) {
3242 _meter->set_display_to_user (false);
3244 setup_invisible_processors ();
3248 _meter->set_display_to_user (true);
3250 /* If we have a previous position for the custom meter, try to put it there */
3251 if (_custom_meter_position_noted) {
3252 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3255 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3256 if (i != _processors.end ()) {
3257 _processors.remove (_meter);
3258 _processors.insert (i, _meter);
3260 } else if (_last_custom_meter_was_at_end) {
3261 _processors.remove (_meter);
3262 _processors.push_back (_meter);
3267 /* Set up the meter for its new position */
3269 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3273 if (loc == _processors.begin()) {
3274 m_in = _input->n_ports();
3276 ProcessorList::iterator before = loc;
3278 m_in = (*before)->output_streams ();
3281 _meter->reflect_inputs (m_in);
3283 /* we do not need to reconfigure the processors, because the meter
3284 (a) is always ready to handle processor_max_streams
3285 (b) is always an N-in/N-out processor, and thus moving
3286 it doesn't require any changes to the other processors.
3290 meter_change (); /* EMIT SIGNAL */
3292 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
3294 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
3298 Route::listen_position_changed ()
3301 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3302 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3303 ProcessorState pstate (this);
3305 if (configure_processors_unlocked (0)) {
3307 configure_processors_unlocked (0); // it worked before we tried to add it ...
3312 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3313 _session.set_dirty ();
3316 boost::shared_ptr<CapturingProcessor>
3317 Route::add_export_point()
3319 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3320 if (!_capturing_processor) {
3322 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3323 Glib::Threads::RWLock::WriterLock lw (_processor_lock);
3325 _capturing_processor.reset (new CapturingProcessor (_session));
3326 _capturing_processor->activate ();
3328 configure_processors_unlocked (0);
3332 return _capturing_processor;
3336 Route::update_signal_latency ()
3338 framecnt_t l = _output->user_latency();
3339 framecnt_t lamp = 0;
3340 bool before_amp = true;
3342 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3343 if ((*i)->active ()) {
3344 l += (*i)->signal_latency ();
3354 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3356 _signal_latency_at_amp_position = lamp;
3357 if (_signal_latency != l) {
3358 _signal_latency = l;
3359 signal_latency_changed (); /* EMIT SIGNAL */
3362 return _signal_latency;
3366 Route::set_user_latency (framecnt_t nframes)
3368 _output->set_user_latency (nframes);
3369 _session.update_latency_compensation ();
3373 Route::set_latency_compensation (framecnt_t longest_session_latency)
3375 framecnt_t old = _initial_delay;
3377 if (_signal_latency < longest_session_latency) {
3378 _initial_delay = longest_session_latency - _signal_latency;
3383 DEBUG_TRACE (DEBUG::Latency, string_compose (
3384 "%1: compensate for maximum latency of %2,"
3385 "given own latency of %3, using initial delay of %4\n",
3386 name(), longest_session_latency, _signal_latency, _initial_delay));
3388 if (_initial_delay != old) {
3389 initial_delay_changed (); /* EMIT SIGNAL */
3392 if (_session.transport_stopped()) {
3393 _roll_delay = _initial_delay;
3397 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3398 : AutomationControl (r->session(),
3399 Evoral::Parameter (SoloAutomation),
3400 ParameterDescriptor(Evoral::Parameter (SoloAutomation)),
3401 boost::shared_ptr<AutomationList>(), name)
3404 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3405 gl->set_interpolation(Evoral::ControlList::Discrete);
3410 Route::SoloControllable::set_value (double val)
3412 const bool bval = ((val >= 0.5) ? true : false);
3414 boost::shared_ptr<RouteList> rl (new RouteList);
3416 boost::shared_ptr<Route> r = _route.lock ();
3423 if (Config->get_solo_control_is_listen_control()) {
3424 _session.set_listen (rl, bval);
3426 _session.set_solo (rl, bval);
3431 Route::SoloControllable::get_value () const
3433 boost::shared_ptr<Route> r = _route.lock ();
3438 if (Config->get_solo_control_is_listen_control()) {
3439 return r->listening_via_monitor() ? 1.0f : 0.0f;
3441 return r->self_soloed() ? 1.0f : 0.0f;
3445 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3446 : AutomationControl (r->session(),
3447 Evoral::Parameter (MuteAutomation),
3448 ParameterDescriptor (Evoral::Parameter (MuteAutomation)),
3449 boost::shared_ptr<AutomationList>(),
3453 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3454 gl->set_interpolation(Evoral::ControlList::Discrete);
3459 Route::MuteControllable::set_superficial_value(bool muted)
3461 /* Note we can not use AutomationControl::set_value here since it will emit
3462 Changed(), but the value will not be correct to the observer. */
3464 bool to_list = _list && ((AutomationList*)_list.get())->automation_write();
3466 Control::set_double (muted, _session.transport_frame(), to_list);
3470 Route::MuteControllable::set_value (double val)
3472 const bool bval = ((val >= 0.5) ? true : false);
3474 boost::shared_ptr<Route> r = _route.lock ();
3479 if (_list && ((AutomationList*)_list.get())->automation_playback()) {
3480 // Playing back automation, set route mute directly
3481 r->set_mute (bval, this);
3483 // Set from user, queue mute event
3484 boost::shared_ptr<RouteList> rl (new RouteList);
3486 _session.set_mute (rl, bval, Session::rt_cleanup);
3489 // Set superficial/automation value to drive controller (and possibly record)
3490 set_superficial_value(bval);
3494 Route::MuteControllable::get_value () const
3496 if (_list && ((AutomationList*)_list.get())->automation_playback()) {
3497 // Playing back automation, get the value from the list
3498 return AutomationControl::get_value();
3501 // Not playing back automation, get the actual route mute value
3502 boost::shared_ptr<Route> r = _route.lock ();
3503 return (r && r->muted()) ? 1.0 : 0.0;
3507 Route::set_block_size (pframes_t nframes)
3509 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3510 (*i)->set_block_size (nframes);
3513 _session.ensure_buffers (n_process_buffers ());
3517 Route::protect_automation ()
3519 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3520 (*i)->protect_automation();
3523 /** @param declick 1 to set a pending declick fade-in,
3524 * -1 to set a pending declick fade-out
3527 Route::set_pending_declick (int declick)
3530 /* this call is not allowed to turn off a pending declick */
3532 _pending_declick = declick;
3535 _pending_declick = 0;
3539 /** Shift automation forwards from a particular place, thereby inserting time.
3540 * Adds undo commands for any shifts that are performed.
3542 * @param pos Position to start shifting from.
3543 * @param frames Amount to shift forwards by.
3547 Route::shift (framepos_t pos, framecnt_t frames)
3549 /* gain automation */
3551 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3553 XMLNode &before = gc->alist()->get_state ();
3554 gc->alist()->shift (pos, frames);
3555 XMLNode &after = gc->alist()->get_state ();
3556 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3559 /* pan automation */
3561 ControlSet::Controls& c (_pannable->controls());
3563 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3564 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3566 boost::shared_ptr<AutomationList> al = pc->alist();
3567 XMLNode& before = al->get_state ();
3568 al->shift (pos, frames);
3569 XMLNode& after = al->get_state ();
3570 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3575 /* redirect automation */
3577 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3578 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3580 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3582 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3583 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3585 boost::shared_ptr<AutomationList> al = ac->alist();
3586 XMLNode &before = al->get_state ();
3587 al->shift (pos, frames);
3588 XMLNode &after = al->get_state ();
3589 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3598 Route::save_as_template (const string& path, const string& name)
3600 XMLNode& node (state (false));
3603 IO::set_name_in_state (*node.children().front(), name);
3605 tree.set_root (&node);
3606 return tree.write (path.c_str());
3611 Route::set_name (const string& str)
3613 if (str == name()) {
3617 string name = Route::ensure_track_or_route_name (str, _session);
3618 SessionObject::set_name (name);
3620 bool ret = (_input->set_name(name) && _output->set_name(name));
3623 /* rename the main outs. Leave other IO processors
3624 * with whatever name they already have, because its
3625 * just fine as it is (it will not contain the route
3626 * name if its a port insert, port send or port return).
3630 if (_main_outs->set_name (name)) {
3631 /* XXX returning false here is stupid because
3632 we already changed the route name.
3642 /** Set the name of a route in an XML description.
3643 * @param node XML <Route> node to set the name in.
3644 * @param name New name.
3647 Route::set_name_in_state (XMLNode& node, string const & name)
3649 node.add_property (X_("name"), name);
3651 XMLNodeList children = node.children();
3652 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3654 if ((*i)->name() == X_("IO")) {
3656 IO::set_name_in_state (**i, name);
3658 } else if ((*i)->name() == X_("Processor")) {
3660 XMLProperty* role = (*i)->property (X_("role"));
3661 if (role && role->value() == X_("Main")) {
3662 (*i)->add_property (X_("name"), name);
3665 } else if ((*i)->name() == X_("Diskstream")) {
3667 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3668 (*i)->add_property (X_("name"), name);
3674 boost::shared_ptr<Send>
3675 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3677 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3679 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3680 boost::shared_ptr<InternalSend> send;
3682 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3683 if (send->target_route() == target) {
3689 return boost::shared_ptr<Send>();
3692 /** @param c Audio channel index.
3693 * @param yn true to invert phase, otherwise false.
3696 Route::set_phase_invert (uint32_t c, bool yn)
3698 if (_phase_invert[c] != yn) {
3699 _phase_invert[c] = yn;
3700 phase_invert_changed (); /* EMIT SIGNAL */
3701 _session.set_dirty ();
3706 Route::set_phase_invert (boost::dynamic_bitset<> p)
3708 if (_phase_invert != p) {
3710 phase_invert_changed (); /* EMIT SIGNAL */
3711 _session.set_dirty ();
3716 Route::phase_invert (uint32_t c) const
3718 return _phase_invert[c];
3721 boost::dynamic_bitset<>
3722 Route::phase_invert () const
3724 return _phase_invert;
3728 Route::set_denormal_protection (bool yn)
3730 if (_denormal_protection != yn) {
3731 _denormal_protection = yn;
3732 denormal_protection_changed (); /* EMIT SIGNAL */
3737 Route::denormal_protection () const
3739 return _denormal_protection;
3743 Route::set_active (bool yn, void* src)
3745 if (_session.transport_rolling()) {
3749 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3750 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3754 if (_active != yn) {
3756 _input->set_active (yn);
3757 _output->set_active (yn);
3758 active_changed (); // EMIT SIGNAL
3759 _session.set_dirty ();
3766 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3772 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3774 boost::shared_ptr<Send> s;
3775 boost::shared_ptr<Return> r;
3777 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3778 s->meter()->meter();
3779 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3780 r->meter()->meter ();
3785 boost::shared_ptr<Pannable>
3786 Route::pannable() const
3791 boost::shared_ptr<Panner>
3792 Route::panner() const
3795 return _main_outs->panner_shell()->panner();
3798 boost::shared_ptr<PannerShell>
3799 Route::panner_shell() const
3801 return _main_outs->panner_shell();
3804 boost::shared_ptr<AutomationControl>
3805 Route::gain_control() const
3807 return _amp->gain_control();
3810 boost::shared_ptr<AutomationControl>
3811 Route::get_control (const Evoral::Parameter& param)
3813 /* either we own the control or .... */
3815 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3819 /* maybe one of our processors does or ... */
3821 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
3822 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3823 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3831 /* nobody does so we'll make a new one */
3833 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3840 boost::shared_ptr<Processor>
3841 Route::nth_plugin (uint32_t n)
3843 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3844 ProcessorList::iterator i;
3846 for (i = _processors.begin(); i != _processors.end(); ++i) {
3847 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3854 return boost::shared_ptr<Processor> ();
3857 boost::shared_ptr<Processor>
3858 Route::nth_send (uint32_t n)
3860 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3861 ProcessorList::iterator i;
3863 for (i = _processors.begin(); i != _processors.end(); ++i) {
3864 if (boost::dynamic_pointer_cast<Send> (*i)) {
3871 return boost::shared_ptr<Processor> ();
3875 Route::has_io_processor_named (const string& name)
3877 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3878 ProcessorList::iterator i;
3880 for (i = _processors.begin(); i != _processors.end(); ++i) {
3881 if (boost::dynamic_pointer_cast<Send> (*i) ||
3882 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3883 if ((*i)->name() == name) {
3892 MuteMaster::MutePoint
3893 Route::mute_points () const
3895 return _mute_master->mute_points ();
3899 Route::set_processor_positions ()
3901 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3903 bool had_amp = false;
3904 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3905 (*i)->set_pre_fader (!had_amp);
3906 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3912 /** Called when there is a proposed change to the input port count */
3914 Route::input_port_count_changing (ChanCount to)
3916 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3918 /* The processors cannot be configured with the new input arrangement, so
3924 /* The change is ok */
3928 /** Called when there is a proposed change to the output port count */
3930 Route::output_port_count_changing (ChanCount to)
3932 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
3933 if (processor_out_streams.get(*t) > to.get(*t)) {
3937 /* The change is ok */
3942 Route::unknown_processors () const
3946 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3947 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3948 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3949 p.push_back ((*i)->name ());
3958 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3960 /* we assume that all our input ports feed all our output ports. its not
3961 universally true, but the alternative is way too corner-case to worry about.
3964 LatencyRange all_connections;
3967 all_connections.min = 0;
3968 all_connections.max = 0;
3970 all_connections.min = ~((pframes_t) 0);
3971 all_connections.max = 0;
3973 /* iterate over all "from" ports and determine the latency range for all of their
3974 connections to the "outside" (outside of this Route).
3977 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3981 p->get_connected_latency_range (range, playback);
3983 all_connections.min = min (all_connections.min, range.min);
3984 all_connections.max = max (all_connections.max, range.max);
3988 /* set the "from" port latencies to the max/min range of all their connections */
3990 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3991 p->set_private_latency_range (all_connections, playback);
3994 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3996 all_connections.min += our_latency;
3997 all_connections.max += our_latency;
3999 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
4000 p->set_private_latency_range (all_connections, playback);
4003 return all_connections.max;
4007 Route::set_private_port_latencies (bool playback) const
4009 framecnt_t own_latency = 0;
4011 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
4012 OR LATENCY CALLBACK.
4014 This is called (early) from the latency callback. It computes the REAL
4015 latency associated with each port and stores the result as the "private"
4016 latency of the port. A later call to Route::set_public_port_latencies()
4017 sets all ports to the same value to reflect the fact that we do latency
4018 compensation and so all signals are delayed by the same amount as they
4019 flow through ardour.
4022 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4023 if ((*i)->active ()) {
4024 own_latency += (*i)->signal_latency ();
4029 /* playback: propagate latency from "outside the route" to outputs to inputs */
4030 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
4032 /* capture: propagate latency from "outside the route" to inputs to outputs */
4033 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
4038 Route::set_public_port_latencies (framecnt_t value, bool playback) const
4040 /* this is called to set the JACK-visible port latencies, which take
4041 latency compensation into account.
4050 const PortSet& ports (_input->ports());
4051 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4052 p->set_public_latency_range (range, playback);
4057 const PortSet& ports (_output->ports());
4058 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
4059 p->set_public_latency_range (range, playback);
4064 /** Put the invisible processors in the right place in _processors.
4065 * Must be called with a writer lock on _processor_lock held.
4068 Route::setup_invisible_processors ()
4071 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
4072 assert (!lm.locked ());
4076 /* too early to be doing this stuff */
4080 /* we'll build this new list here and then use it */
4082 ProcessorList new_processors;
4084 /* find visible processors */
4086 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4087 if ((*i)->display_to_user ()) {
4088 new_processors.push_back (*i);
4094 ProcessorList::iterator amp = new_processors.begin ();
4095 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
4099 assert (amp != new_processors.end ());
4101 /* and the processor after the amp */
4103 ProcessorList::iterator after_amp = amp;
4109 switch (_meter_point) {
4111 assert (!_meter->display_to_user ());
4112 new_processors.push_front (_meter);
4115 assert (!_meter->display_to_user ());
4116 new_processors.insert (amp, _meter);
4118 case MeterPostFader:
4119 /* do nothing here */
4122 /* do nothing here */
4125 /* the meter is visible, so we don't touch it here */
4132 assert (_main_outs);
4133 assert (!_main_outs->display_to_user ());
4134 new_processors.push_back (_main_outs);
4136 /* iterator for the main outs */
4138 ProcessorList::iterator main = new_processors.end();
4141 /* OUTPUT METERING */
4143 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
4144 assert (!_meter->display_to_user ());
4146 /* add the processor just before or just after the main outs */
4148 ProcessorList::iterator meter_point = main;
4150 if (_meter_point == MeterOutput) {
4153 new_processors.insert (meter_point, _meter);
4158 if (_monitor_send && !is_monitor ()) {
4159 assert (!_monitor_send->display_to_user ());
4160 if (Config->get_solo_control_is_listen_control()) {
4161 switch (Config->get_listen_position ()) {
4162 case PreFaderListen:
4163 switch (Config->get_pfl_position ()) {
4164 case PFLFromBeforeProcessors:
4165 new_processors.push_front (_monitor_send);
4167 case PFLFromAfterProcessors:
4168 new_processors.insert (amp, _monitor_send);
4171 _monitor_send->set_can_pan (false);
4173 case AfterFaderListen:
4174 switch (Config->get_afl_position ()) {
4175 case AFLFromBeforeProcessors:
4176 new_processors.insert (after_amp, _monitor_send);
4178 case AFLFromAfterProcessors:
4179 new_processors.insert (new_processors.end(), _monitor_send);
4182 _monitor_send->set_can_pan (true);
4186 new_processors.insert (new_processors.end(), _monitor_send);
4187 _monitor_send->set_can_pan (false);
4191 #if 0 // not used - just yet
4192 if (!is_master() && !is_monitor() && !is_auditioner()) {
4193 new_processors.push_front (_delayline);
4197 /* MONITOR CONTROL */
4199 if (_monitor_control && is_monitor ()) {
4200 assert (!_monitor_control->display_to_user ());
4201 new_processors.push_front (_monitor_control);
4204 /* INTERNAL RETURN */
4206 /* doing this here means that any monitor control will come just after
4211 assert (!_intreturn->display_to_user ());
4212 new_processors.push_front (_intreturn);
4215 /* EXPORT PROCESSOR */
4217 if (_capturing_processor) {
4218 assert (!_capturing_processor->display_to_user ());
4219 new_processors.push_front (_capturing_processor);
4222 _processors = new_processors;
4224 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4225 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4226 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4233 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4234 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4238 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4239 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4246 /** If the meter point is `Custom', make a note of where the meter is.
4247 * This is so that if the meter point is subsequently set to something else,
4248 * and then back to custom, we can put the meter back where it was last time
4249 * custom was enabled.
4251 * Must be called with the _processor_lock held.
4254 Route::maybe_note_meter_position ()
4256 if (_meter_point != MeterCustom) {
4260 _custom_meter_position_noted = true;
4261 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4262 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4263 ProcessorList::iterator j = i;
4265 if (j != _processors.end ()) {
4266 _processor_after_last_custom_meter = *j;
4267 _last_custom_meter_was_at_end = false;
4269 _last_custom_meter_was_at_end = true;
4275 boost::shared_ptr<Processor>
4276 Route::processor_by_id (PBD::ID id) const
4278 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4279 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4280 if ((*i)->id() == id) {
4285 return boost::shared_ptr<Processor> ();
4288 /** @return the monitoring state, or in other words what data we are pushing
4289 * into the route (data from the inputs, data from disk or silence)
4292 Route::monitoring_state () const
4294 return MonitoringInput;
4297 /** @return what we should be metering; either the data coming from the input
4298 * IO or the data that is flowing through the route.
4301 Route::metering_state () const
4303 return MeteringRoute;
4307 Route::has_external_redirects () const
4309 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4311 /* ignore inactive processors and obviously ignore the main
4312 * outs since everything has them and we don't care.
4315 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4323 boost::shared_ptr<Processor>
4324 Route::the_instrument () const
4326 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4327 return the_instrument_unlocked ();
4330 boost::shared_ptr<Processor>
4331 Route::the_instrument_unlocked () const
4333 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4334 if (boost::dynamic_pointer_cast<PluginInsert>(*i)) {
4335 if ((*i)->input_streams().n_midi() > 0 &&
4336 (*i)->output_streams().n_audio() > 0) {
4341 return boost::shared_ptr<Processor>();
4347 Route::non_realtime_locate (framepos_t pos)
4350 _pannable->transport_located (pos);
4353 if (_delayline.get()) {
4354 _delayline.get()->flush();
4358 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4359 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4361 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4362 (*i)->transport_located (pos);
4368 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4375 * We don't currently mix MIDI input together, so we don't need the
4376 * complex logic of the audio case.
4379 n_buffers = bufs.count().n_midi ();
4381 for (i = 0; i < n_buffers; ++i) {
4383 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4384 MidiBuffer& buf (bufs.get_midi (i));
4387 buf.copy (source_port->get_midi_buffer(nframes));
4389 buf.silence (nframes);
4395 n_buffers = bufs.count().n_audio();
4397 size_t n_ports = io->n_ports().n_audio();
4398 float scaling = 1.0f;
4400 if (n_ports > n_buffers) {
4401 scaling = ((float) n_buffers) / n_ports;
4404 for (i = 0; i < n_ports; ++i) {
4406 /* if there are more ports than buffers, map them onto buffers
4407 * in a round-robin fashion
4410 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4411 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4414 if (i < n_buffers) {
4416 /* first time through just copy a channel into
4420 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4422 if (scaling != 1.0f) {
4423 buf.apply_gain (scaling, nframes);
4428 /* on subsequent times around, merge data from
4429 * the port with what is already there
4432 if (scaling != 1.0f) {
4433 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4435 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4440 /* silence any remaining buffers */
4442 for (; i < n_buffers; ++i) {
4443 AudioBuffer& buf (bufs.get_audio (i));
4444 buf.silence (nframes);
4447 /* establish the initial setup of the buffer set, reflecting what was
4448 copied into it. unless, of course, we are the auditioner, in which
4449 case nothing was fed into it from the inputs at all.
4452 if (!is_auditioner()) {
4453 bufs.set_count (io->n_ports());