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/midi_buffer.h"
51 #include "ardour/midi_port.h"
52 #include "ardour/monitor_processor.h"
53 #include "ardour/pannable.h"
54 #include "ardour/panner.h"
55 #include "ardour/panner_shell.h"
56 #include "ardour/plugin_insert.h"
57 #include "ardour/port.h"
58 #include "ardour/port_insert.h"
59 #include "ardour/processor.h"
60 #include "ardour/route.h"
61 #include "ardour/route_group.h"
62 #include "ardour/send.h"
63 #include "ardour/session.h"
64 #include "ardour/unknown_processor.h"
65 #include "ardour/utils.h"
70 using namespace ARDOUR;
73 PBD::Signal0<void> Route::SyncOrderKeys;
74 PBD::Signal0<void> Route::RemoteControlIDChange;
76 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
77 : SessionObject (sess, name)
79 , GraphNode (sess._process_graph)
85 , _pending_declick (true)
86 , _meter_point (MeterPostFader)
87 , _meter_type (MeterPeak)
89 , _soloed_by_others_upstream (0)
90 , _soloed_by_others_downstream (0)
92 , _denormal_protection (false)
95 , _declickable (false)
96 , _mute_master (new MuteMaster (sess, name))
97 , _have_internal_generator (false)
99 , _default_type (default_type)
101 , _has_order_key (false)
102 , _remote_control_id (0)
103 , _in_configure_processors (false)
104 , _initial_io_setup (false)
105 , _custom_meter_position_noted (false)
106 , _last_custom_meter_was_at_end (false)
109 _meter_type = MeterK20;
111 processor_max_streams.reset();
117 /* add standard controls */
119 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
120 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
122 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
123 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
125 add_control (_solo_control);
126 add_control (_mute_control);
130 if (!(_flags & Route::MonitorOut)) {
131 _pannable.reset (new Pannable (_session));
134 /* input and output objects */
136 _input.reset (new IO (_session, _name, IO::Input, _default_type));
137 _output.reset (new IO (_session, _name, IO::Output, _default_type));
139 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
140 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
142 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
143 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
145 /* add amp processor */
147 _amp.reset (new Amp (_session));
148 add_processor (_amp, PostFader);
150 /* create standard processors: meter, main outs, monitor out;
151 they will be added to _processors by setup_invisible_processors ()
154 _meter.reset (new PeakMeter (_session, _name));
155 _meter->set_owner (this);
156 _meter->set_display_to_user (false);
159 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
160 _main_outs->activate ();
163 /* where we listen to tracks */
164 _intreturn.reset (new InternalReturn (_session));
165 _intreturn->activate ();
167 /* the thing that provides proper control over a control/monitor/listen bus
168 (such as per-channel cut, dim, solo, invert, etc).
170 _monitor_control.reset (new MonitorProcessor (_session));
171 _monitor_control->activate ();
174 if (is_master() || is_monitor() || is_auditioner()) {
175 _mute_master->set_solo_ignore (true);
178 /* now that we have _meter, its safe to connect to this */
180 Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
183 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
184 configure_processors (0);
192 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
194 /* do this early so that we don't get incoming signals as we are going through destruction
199 /* don't use clear_processors here, as it depends on the session which may
200 be half-destroyed by now
203 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
204 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
205 (*i)->drop_references ();
208 _processors.clear ();
212 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
214 if (Config->get_remote_model() != UserOrdered) {
218 set_remote_control_id_internal (id, notify_class_listeners);
222 Route::set_remote_control_id_internal (uint32_t id, bool notify_class_listeners)
224 /* force IDs for master/monitor busses and prevent
225 any other route from accidentally getting these IDs
226 (i.e. legacy sessions)
229 if (is_master() && id != MasterBusRemoteControlID) {
230 id = MasterBusRemoteControlID;
233 if (is_monitor() && id != MonitorBusRemoteControlID) {
234 id = MonitorBusRemoteControlID;
241 /* don't allow it to collide */
243 if (!is_master () && !is_monitor() &&
244 (id == MasterBusRemoteControlID || id == MonitorBusRemoteControlID)) {
245 id += MonitorBusRemoteControlID;
248 if (id != remote_control_id()) {
249 _remote_control_id = id;
250 RemoteControlIDChanged ();
252 if (notify_class_listeners) {
253 RemoteControlIDChange ();
259 Route::remote_control_id() const
262 return MasterBusRemoteControlID;
266 return MonitorBusRemoteControlID;
269 return _remote_control_id;
273 Route::has_order_key () const
275 return _has_order_key;
279 Route::order_key () const
285 Route::set_remote_control_id_explicit (uint32_t rid)
287 if (is_master() || is_monitor() || is_auditioner()) {
288 /* hard-coded remote IDs, or no remote ID */
292 if (_remote_control_id != rid) {
293 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1: set edit-based RID to %2\n", name(), rid));
294 _remote_control_id = rid;
295 RemoteControlIDChanged (); /* EMIT SIGNAL (per-route) */
298 /* don't emit the class-level RID signal RemoteControlIDChange here,
299 leave that to the entity that changed the order key, so that we
300 don't get lots of emissions for no good reasons (e.g. when changing
301 all route order keys).
303 See Session::sync_remote_id_from_order_keys() for the (primary|only)
304 spot where that is emitted.
309 Route::set_order_key (uint32_t n)
311 _has_order_key = true;
313 if (_order_key == n) {
319 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 order key set to %2\n",
320 name(), order_key ()));
322 _session.set_dirty ();
326 Route::ensure_track_or_route_name(string name, Session &session)
328 string newname = name;
330 while (!session.io_name_is_legal (newname)) {
331 newname = bump_name_once (newname, '.');
339 Route::inc_gain (gain_t fraction, void *src)
341 _amp->inc_gain (fraction, src);
345 Route::set_gain (gain_t val, void *src)
347 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
349 if (_route_group->is_relative()) {
351 gain_t usable_gain = _amp->gain();
352 if (usable_gain < 0.000001f) {
353 usable_gain = 0.000001f;
357 if (delta < 0.000001f) {
361 delta -= usable_gain;
366 gain_t factor = delta / usable_gain;
369 factor = _route_group->get_max_factor(factor);
370 if (factor == 0.0f) {
371 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
375 factor = _route_group->get_min_factor(factor);
376 if (factor == 0.0f) {
377 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
382 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
386 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
392 if (val == _amp->gain()) {
396 _amp->set_gain (val, src);
400 Route::maybe_declick (BufferSet&, framecnt_t, int)
402 /* this is the "bus" implementation and they never declick.
407 /** Process this route for one (sub) cycle (process thread)
409 * @param bufs Scratch buffers to use for the signal path
410 * @param start_frame Initial transport frame
411 * @param end_frame Final transport frame
412 * @param nframes Number of frames to output (to ports)
414 * Note that (end_frame - start_frame) may not be equal to nframes when the
415 * transport speed isn't 1.0 (eg varispeed).
418 Route::process_output_buffers (BufferSet& bufs,
419 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
420 int declick, bool gain_automation_ok)
422 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
425 /* figure out if we're going to use gain automation */
426 if (gain_automation_ok) {
427 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
428 _amp->setup_gain_automation (start_frame, end_frame, nframes);
430 _amp->apply_gain_automation (false);
433 /* Tell main outs what to do about monitoring. We do this so that
434 on a transition between monitoring states we get a de-clicking gain
435 change in the _main_outs delivery.
438 _main_outs->no_outs_cuz_we_no_monitor (monitoring_state () == MonitoringSilence);
440 /* -------------------------------------------------------------------------------------------
441 GLOBAL DECLICK (for transport changes etc.)
442 ----------------------------------------------------------------------------------------- */
444 maybe_declick (bufs, nframes, declick);
445 _pending_declick = 0;
447 /* -------------------------------------------------------------------------------------------
448 DENORMAL CONTROL/PHASE INVERT
449 ----------------------------------------------------------------------------------------- */
451 if (_phase_invert.any ()) {
455 if (_denormal_protection || Config->get_denormal_protection()) {
457 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
458 Sample* const sp = i->data();
460 if (_phase_invert[chn]) {
461 for (pframes_t nx = 0; nx < nframes; ++nx) {
466 for (pframes_t nx = 0; nx < nframes; ++nx) {
474 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
475 Sample* const sp = i->data();
477 if (_phase_invert[chn]) {
478 for (pframes_t nx = 0; nx < nframes; ++nx) {
487 if (_denormal_protection || Config->get_denormal_protection()) {
489 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
490 Sample* const sp = i->data();
491 for (pframes_t nx = 0; nx < nframes; ++nx) {
499 /* -------------------------------------------------------------------------------------------
501 ----------------------------------------------------------------------------------------- */
503 /* set this to be true if the meter will already have been ::run() earlier */
504 bool const meter_already_run = metering_state() == MeteringInput;
506 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
508 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
509 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
514 /* if it has any inputs, make sure they match */
515 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
516 if (bufs.count() != (*i)->input_streams()) {
518 DEBUG::Processors, string_compose (
519 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
520 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
527 /* should we NOT run plugins here if the route is inactive?
528 do we catch route != active somewhere higher?
531 (*i)->run (bufs, start_frame, end_frame, nframes, *i != _processors.back());
532 bufs.set_count ((*i)->output_streams());
537 Route::n_process_buffers ()
539 return max (_input->n_ports(), processor_max_streams);
543 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
545 assert (is_monitor());
546 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
547 passthru (bufs, start_frame, end_frame, nframes, declick);
551 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
555 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
557 /* control/monitor bus ignores input ports when something is
558 feeding the listen "stream". data will "arrive" into the
559 route from the intreturn processor element.
562 bufs.silence (nframes, 0);
565 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
566 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
570 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
572 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
574 bufs.set_count (_input->n_ports());
575 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
576 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
580 Route::set_listen (bool yn, void* src)
586 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
587 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
592 if (yn != _monitor_send->active()) {
594 _monitor_send->activate ();
595 _mute_master->set_soloed (true);
597 _monitor_send->deactivate ();
598 _mute_master->set_soloed (false);
601 listen_changed (src); /* EMIT SIGNAL */
607 Route::listening_via_monitor () const
610 return _monitor_send->active ();
617 Route::set_solo_safe (bool yn, void *src)
619 if (_solo_safe != yn) {
621 solo_safe_changed (src);
626 Route::solo_safe() const
632 Route::set_solo (bool yn, void *src)
635 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change due to solo-safe\n", name()));
639 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
640 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
644 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set solo => %2, src: %3 grp ? %4 currently self-soloed ? %5\n",
645 name(), yn, src, (src == _route_group), self_soloed()));
647 if (self_soloed() != yn) {
649 set_mute_master_solo ();
650 solo_changed (true, src); /* EMIT SIGNAL */
651 _solo_control->Changed (); /* EMIT SIGNAL */
656 Route::set_self_solo (bool yn)
658 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set SELF solo => %2\n", name(), yn));
663 Route::mod_solo_by_others_upstream (int32_t delta)
666 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-upstream due to solo-safe\n", name()));
670 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-upstream by %2, current up = %3 down = %4\n",
671 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
673 uint32_t old_sbu = _soloed_by_others_upstream;
676 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
677 _soloed_by_others_upstream += delta;
679 _soloed_by_others_upstream = 0;
682 _soloed_by_others_upstream += delta;
685 DEBUG_TRACE (DEBUG::Solo, string_compose (
686 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
687 name(), delta, _soloed_by_others_upstream, old_sbu,
688 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
690 /* push the inverse solo change to everything that feeds us.
692 This is important for solo-within-group. When we solo 1 track out of N that
693 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
694 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
695 tracks that feed it. This will silence them if they were audible because
696 of a bus solo, but the newly soloed track will still be audible (because
699 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
703 if ((_self_solo || _soloed_by_others_downstream) &&
704 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
705 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
707 if (delta > 0 || !Config->get_exclusive_solo()) {
708 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
709 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
710 boost::shared_ptr<Route> sr = i->r.lock();
712 sr->mod_solo_by_others_downstream (-delta);
718 set_mute_master_solo ();
719 solo_changed (false, this);
723 Route::mod_solo_by_others_downstream (int32_t delta)
726 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-downstream due to solo safe\n", name()));
730 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-downstream by %2, current up = %3 down = %4\n",
731 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
734 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
735 _soloed_by_others_downstream += delta;
737 _soloed_by_others_downstream = 0;
740 _soloed_by_others_downstream += delta;
743 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
745 set_mute_master_solo ();
746 solo_changed (false, this);
750 Route::set_mute_master_solo ()
752 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
756 Route::set_solo_isolated (bool yn, void *src)
758 if (is_master() || is_monitor() || is_auditioner()) {
762 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
763 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
767 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
769 boost::shared_ptr<RouteList> routes = _session.get_routes ();
770 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
772 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
777 bool does_feed = direct_feeds_according_to_graph (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
779 if (does_feed && !sends_only) {
780 (*i)->set_solo_isolated (yn, (*i)->route_group());
784 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
786 bool changed = false;
789 if (_solo_isolated == 0) {
790 _mute_master->set_solo_ignore (true);
795 if (_solo_isolated > 0) {
797 if (_solo_isolated == 0) {
798 _mute_master->set_solo_ignore (false);
805 solo_isolated_changed (src);
810 Route::solo_isolated () const
812 return _solo_isolated > 0;
816 Route::set_mute_points (MuteMaster::MutePoint mp)
818 _mute_master->set_mute_points (mp);
819 mute_points_changed (); /* EMIT SIGNAL */
821 if (_mute_master->muted_by_self()) {
822 mute_changed (this); /* EMIT SIGNAL */
823 _mute_control->Changed (); /* EMIT SIGNAL */
828 Route::set_mute (bool yn, void *src)
830 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
831 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
836 _mute_master->set_muted_by_self (yn);
837 /* allow any derived classes to respond to the mute change
838 before anybody else knows about it.
841 /* tell everyone else */
842 mute_changed (src); /* EMIT SIGNAL */
843 _mute_control->Changed (); /* EMIT SIGNAL */
848 Route::muted () const
850 return _mute_master->muted_by_self();
855 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
857 cerr << name << " {" << endl;
858 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
859 p != procs.end(); ++p) {
860 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
866 /** Supposing that we want to insert a Processor at a given Placement, return
867 * the processor to add the new one before (or 0 to add at the end).
869 boost::shared_ptr<Processor>
870 Route::before_processor_for_placement (Placement p)
872 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
874 ProcessorList::iterator loc;
877 /* generic pre-fader: insert immediately before the amp */
878 loc = find (_processors.begin(), _processors.end(), _amp);
880 /* generic post-fader: insert right before the main outs */
881 loc = find (_processors.begin(), _processors.end(), _main_outs);
884 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
887 /** Supposing that we want to insert a Processor at a given index, return
888 * the processor to add the new one before (or 0 to add at the end).
890 boost::shared_ptr<Processor>
891 Route::before_processor_for_index (int index)
894 return boost::shared_ptr<Processor> ();
897 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
899 ProcessorList::iterator i = _processors.begin ();
901 while (i != _processors.end() && j < index) {
902 if ((*i)->display_to_user()) {
909 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
912 /** Add a processor either pre- or post-fader
913 * @return 0 on success, non-0 on failure.
916 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
918 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
922 /** Add a processor to a route such that it ends up with a given index into the visible processors.
923 * @param index Index to add the processor at, or -1 to add at the end of the list.
924 * @return 0 on success, non-0 on failure.
927 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
929 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
932 /** Add a processor to the route.
933 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
934 * @return 0 on success, non-0 on failure.
937 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
939 assert (processor != _meter);
940 assert (processor != _main_outs);
942 DEBUG_TRACE (DEBUG::Processors, string_compose (
943 "%1 adding processor %2\n", name(), processor->name()));
945 if (!AudioEngine::instance()->connected() || !processor) {
950 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
951 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
952 ProcessorState pstate (this);
954 boost::shared_ptr<PluginInsert> pi;
955 boost::shared_ptr<PortInsert> porti;
957 if (processor == _amp) {
958 /* Ensure that only one amp is in the list at any time */
959 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), processor);
960 if (check != _processors.end()) {
961 if (before == _amp) {
962 /* Already in position; all is well */
965 _processors.erase (check);
970 assert (find (_processors.begin(), _processors.end(), processor) == _processors.end ());
972 ProcessorList::iterator loc;
974 /* inserting before a processor; find it */
975 loc = find (_processors.begin(), _processors.end(), before);
976 if (loc == _processors.end ()) {
981 /* inserting at end */
982 loc = _processors.end ();
985 _processors.insert (loc, processor);
986 processor->set_owner (this);
988 // Set up processor list channels. This will set processor->[input|output]_streams(),
989 // configure redirect ports properly, etc.
992 if (configure_processors_unlocked (err)) {
994 configure_processors_unlocked (0); // it worked before we tried to add it ...
999 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1001 if (pi->has_no_inputs ()) {
1002 /* generator plugin */
1003 _have_internal_generator = true;
1008 if (activation_allowed && !_session.get_disable_all_loaded_plugins()) {
1009 processor->activate ();
1012 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1014 _output->set_user_latency (0);
1017 reset_instrument_info ();
1018 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1019 set_processor_positions ();
1025 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1027 const XMLProperty *prop;
1030 boost::shared_ptr<Processor> processor;
1032 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1033 so that we can add the processor in the right place (pre/post-fader)
1036 XMLNodeList const & children = node.children ();
1037 XMLNodeList::const_iterator i = children.begin ();
1039 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1043 Placement placement = PreFader;
1045 if (i != children.end()) {
1046 if ((prop = (*i)->property (X_("placement"))) != 0) {
1047 placement = Placement (string_2_enum (prop->value(), placement));
1051 if (node.name() == "Insert") {
1053 if ((prop = node.property ("type")) != 0) {
1055 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1056 prop->value() == "lv2" ||
1057 prop->value() == "windows-vst" ||
1058 prop->value() == "lxvst" ||
1059 prop->value() == "audiounit") {
1061 processor.reset (new PluginInsert (_session));
1065 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1070 } else if (node.name() == "Send") {
1072 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
1073 processor.reset (new Send (_session, sendpan, _mute_master));
1077 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1081 if (processor->set_state (node, version)) {
1085 return (add_processor (processor, placement) == 0);
1088 catch (failed_constructor &err) {
1089 warning << _("processor could not be created. Ignored.") << endmsg;
1095 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1097 /* NOTE: this is intended to be used ONLY when copying
1098 processors from another Route. Hence the subtle
1099 differences between this and ::add_processor()
1102 ProcessorList::iterator loc;
1105 loc = find(_processors.begin(), _processors.end(), before);
1107 /* nothing specified - at end */
1108 loc = _processors.end ();
1111 if (!_session.engine().connected()) {
1115 if (others.empty()) {
1120 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1121 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1122 ProcessorState pstate (this);
1124 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1130 boost::shared_ptr<PluginInsert> pi;
1132 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1136 _processors.insert (loc, *i);
1137 (*i)->set_owner (this);
1139 if ((*i)->active()) {
1143 /* Think: does this really need to be called for every processor in the loop? */
1145 if (configure_processors_unlocked (err)) {
1147 configure_processors_unlocked (0); // it worked before we tried to add it ...
1152 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1155 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1156 boost::shared_ptr<PluginInsert> pi;
1158 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1159 if (pi->has_no_inputs ()) {
1160 _have_internal_generator = true;
1166 _output->set_user_latency (0);
1169 reset_instrument_info ();
1170 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1171 set_processor_positions ();
1177 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1179 if (p == PreFader) {
1180 start = _processors.begin();
1181 end = find(_processors.begin(), _processors.end(), _amp);
1183 start = find(_processors.begin(), _processors.end(), _amp);
1185 end = _processors.end();
1189 /** Turn off all processors with a given placement
1190 * @param p Placement of processors to disable
1193 Route::disable_processors (Placement p)
1195 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1197 ProcessorList::iterator start, end;
1198 placement_range(p, start, end);
1200 for (ProcessorList::iterator i = start; i != end; ++i) {
1201 (*i)->deactivate ();
1204 _session.set_dirty ();
1207 /** Turn off all redirects
1210 Route::disable_processors ()
1212 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1214 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1215 (*i)->deactivate ();
1218 _session.set_dirty ();
1221 /** Turn off all redirects with a given placement
1222 * @param p Placement of redirects to disable
1225 Route::disable_plugins (Placement p)
1227 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1229 ProcessorList::iterator start, end;
1230 placement_range(p, start, end);
1232 for (ProcessorList::iterator i = start; i != end; ++i) {
1233 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1234 (*i)->deactivate ();
1238 _session.set_dirty ();
1241 /** Turn off all plugins
1244 Route::disable_plugins ()
1246 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1248 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1249 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1250 (*i)->deactivate ();
1254 _session.set_dirty ();
1259 Route::ab_plugins (bool forward)
1261 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1265 /* forward = turn off all active redirects, and mark them so that the next time
1266 we go the other way, we will revert them
1269 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1270 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1274 if ((*i)->active()) {
1275 (*i)->deactivate ();
1276 (*i)->set_next_ab_is_active (true);
1278 (*i)->set_next_ab_is_active (false);
1284 /* backward = if the redirect was marked to go active on the next ab, do so */
1286 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1288 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1292 if ((*i)->get_next_ab_is_active()) {
1295 (*i)->deactivate ();
1300 _session.set_dirty ();
1304 /** Remove processors with a given placement.
1305 * @param p Placement of processors to remove.
1308 Route::clear_processors (Placement p)
1310 if (!_session.engine().connected()) {
1314 bool already_deleting = _session.deletion_in_progress();
1315 if (!already_deleting) {
1316 _session.set_deletion_in_progress();
1320 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1321 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1322 ProcessorList new_list;
1323 ProcessorStreams err;
1324 bool seen_amp = false;
1326 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1332 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1334 /* you can't remove these */
1336 new_list.push_back (*i);
1343 new_list.push_back (*i);
1346 (*i)->drop_references ();
1354 (*i)->drop_references ();
1357 new_list.push_back (*i);
1364 _processors = new_list;
1365 configure_processors_unlocked (&err); // this can't fail
1368 processor_max_streams.reset();
1369 _have_internal_generator = false;
1370 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1371 set_processor_positions ();
1373 reset_instrument_info ();
1375 if (!already_deleting) {
1376 _session.clear_deletion_in_progress();
1381 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1383 // TODO once the export point can be configured properly, do something smarter here
1384 if (processor == _capturing_processor) {
1385 _capturing_processor.reset();
1388 /* these can never be removed */
1390 if (processor == _amp || processor == _meter || processor == _main_outs) {
1394 if (!_session.engine().connected()) {
1398 processor_max_streams.reset();
1401 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1402 if (need_process_lock) {
1405 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1406 ProcessorState pstate (this);
1408 ProcessorList::iterator i;
1409 bool removed = false;
1411 for (i = _processors.begin(); i != _processors.end(); ) {
1412 if (*i == processor) {
1414 /* move along, see failure case for configure_processors()
1415 where we may need to reconfigure the processor.
1418 /* stop redirects that send signals to JACK ports
1419 from causing noise as a result of no longer being
1423 boost::shared_ptr<IOProcessor> iop;
1425 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1429 i = _processors.erase (i);
1437 _output->set_user_latency (0);
1445 if (configure_processors_unlocked (err)) {
1447 /* we know this will work, because it worked before :) */
1448 configure_processors_unlocked (0);
1452 _have_internal_generator = false;
1454 for (i = _processors.begin(); i != _processors.end(); ++i) {
1455 boost::shared_ptr<PluginInsert> pi;
1457 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1458 if (pi->has_no_inputs ()) {
1459 _have_internal_generator = true;
1464 if (need_process_lock) {
1469 reset_instrument_info ();
1470 processor->drop_references ();
1471 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1472 set_processor_positions ();
1478 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1480 ProcessorList deleted;
1482 if (!_session.engine().connected()) {
1486 processor_max_streams.reset();
1489 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1490 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1491 ProcessorState pstate (this);
1493 ProcessorList::iterator i;
1494 boost::shared_ptr<Processor> processor;
1496 for (i = _processors.begin(); i != _processors.end(); ) {
1500 /* these can never be removed */
1502 if (processor == _amp || processor == _meter || processor == _main_outs) {
1507 /* see if its in the list of processors to delete */
1509 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1514 /* stop IOProcessors that send to JACK ports
1515 from causing noise as a result of no longer being
1519 boost::shared_ptr<IOProcessor> iop;
1521 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1525 deleted.push_back (processor);
1526 i = _processors.erase (i);
1529 if (deleted.empty()) {
1530 /* none of those in the requested list were found */
1534 _output->set_user_latency (0);
1536 if (configure_processors_unlocked (err)) {
1538 /* we know this will work, because it worked before :) */
1539 configure_processors_unlocked (0);
1544 _have_internal_generator = false;
1546 for (i = _processors.begin(); i != _processors.end(); ++i) {
1547 boost::shared_ptr<PluginInsert> pi;
1549 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1550 if (pi->has_no_inputs ()) {
1551 _have_internal_generator = true;
1558 /* now try to do what we need to so that those that were removed will be deleted */
1560 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1561 (*i)->drop_references ();
1564 reset_instrument_info ();
1565 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1566 set_processor_positions ();
1572 Route::set_custom_panner_uri (std::string const panner_uri)
1574 if (_in_configure_processors) {
1575 DEBUG_TRACE (DEBUG::Panning, string_compose (_("Route::set_custom_panner_uri '%1' -- called while in_configure_processors\n"), name()));
1579 if (!_main_outs->panner_shell()->set_user_selected_panner_uri(panner_uri)) {
1580 DEBUG_TRACE (DEBUG::Panning, string_compose (_("Route::set_custom_panner_uri '%1 '%2' -- no change needed\n"), name(), panner_uri));
1581 /* no change needed */
1585 DEBUG_TRACE (DEBUG::Panning, string_compose (_("Route::set_custom_panner_uri '%1 '%2' -- reconfigure I/O\n"), name(), panner_uri));
1587 /* reconfigure I/O -- re-initialize panner modules */
1589 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1590 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1592 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p) {
1593 boost::shared_ptr<Delivery> dl;
1594 boost::shared_ptr<Panner> panner;
1595 if ((dl = boost::dynamic_pointer_cast<Delivery> (*p)) == 0) {
1598 if (!dl->panner_shell()) {
1601 if (!(panner = dl->panner_shell()->panner())) {
1604 /* _main_outs has already been set before the loop.
1605 * Ignore the return status here. It need reconfiguration */
1606 if (dl->panner_shell() != _main_outs->panner_shell()) {
1607 if (!dl->panner_shell()->set_user_selected_panner_uri(panner_uri)) {
1612 ChanCount in = panner->in();
1613 ChanCount out = panner->out();
1614 dl->panner_shell()->configure_io(in, out);
1615 dl->panner_shell()->pannable()->set_panner(dl->panner_shell()->panner());
1619 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1620 _session.set_dirty ();
1624 Route::reset_instrument_info ()
1626 boost::shared_ptr<Processor> instr = the_instrument();
1628 _instrument_info.set_internal_instrument (instr);
1632 /** Caller must hold process lock */
1634 Route::configure_processors (ProcessorStreams* err)
1636 #ifndef PLATFORM_WINDOWS
1637 assert (!AudioEngine::instance()->process_lock().trylock());
1640 if (!_in_configure_processors) {
1641 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1642 return configure_processors_unlocked (err);
1649 Route::input_streams () const
1651 return _input->n_ports ();
1654 list<pair<ChanCount, ChanCount> >
1655 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1657 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1659 return try_configure_processors_unlocked (in, err);
1662 list<pair<ChanCount, ChanCount> >
1663 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1665 // Check each processor in order to see if we can configure as requested
1667 list<pair<ChanCount, ChanCount> > configuration;
1670 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1671 DEBUG_TRACE (DEBUG::Processors, "{\n");
1673 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1675 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1676 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1677 DEBUG_TRACE (DEBUG::Processors, "}\n");
1678 return list<pair<ChanCount, ChanCount> > ();
1681 if ((*p)->can_support_io_configuration(in, out)) {
1682 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1683 configuration.push_back(make_pair(in, out));
1690 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1691 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1692 DEBUG_TRACE (DEBUG::Processors, "}\n");
1693 return list<pair<ChanCount, ChanCount> > ();
1697 DEBUG_TRACE (DEBUG::Processors, "}\n");
1699 return configuration;
1702 /** Set the input/output configuration of each processor in the processors list.
1703 * Caller must hold process lock.
1704 * Return 0 on success, otherwise configuration is impossible.
1707 Route::configure_processors_unlocked (ProcessorStreams* err)
1709 #ifndef PLATFORM_WINDOWS
1710 assert (!AudioEngine::instance()->process_lock().trylock());
1713 if (_in_configure_processors) {
1717 /* put invisible processors where they should be */
1718 setup_invisible_processors ();
1720 _in_configure_processors = true;
1722 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1724 if (configuration.empty ()) {
1725 _in_configure_processors = false;
1730 bool seen_mains_out = false;
1731 processor_out_streams = _input->n_ports();
1732 processor_max_streams.reset();
1734 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1735 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1737 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1741 (*p)->configure_io(c->first, c->second);
1742 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1743 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1746 if (boost::dynamic_pointer_cast<Delivery> (*p)
1747 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1748 /* main delivery will increase port count to match input.
1749 * the Delivery::Main is usually the last processor - followed only by
1752 seen_mains_out = true;
1754 if (!seen_mains_out) {
1755 processor_out_streams = out;
1761 _meter->reset_max_channels (processor_max_streams);
1764 /* make sure we have sufficient scratch buffers to cope with the new processor
1767 _session.ensure_buffers (n_process_buffers ());
1769 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1771 _in_configure_processors = false;
1775 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1776 * @param state New active state for those processors.
1779 Route::all_visible_processors_active (bool state)
1781 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1783 if (_processors.empty()) {
1787 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1788 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1795 (*i)->deactivate ();
1799 _session.set_dirty ();
1803 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1805 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1806 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1807 processors in the current actual processor list that are hidden. Any visible processors
1808 in the current list but not in "new_order" will be assumed to be deleted.
1812 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1813 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1814 ProcessorState pstate (this);
1816 ProcessorList::iterator oiter;
1817 ProcessorList::const_iterator niter;
1818 ProcessorList as_it_will_be;
1820 oiter = _processors.begin();
1821 niter = new_order.begin();
1823 while (niter != new_order.end()) {
1825 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1826 then append it to the temp list.
1828 Otherwise, see if the next processor in the old list is in the new list. if not,
1829 its been deleted. If its there, append it to the temp list.
1832 if (oiter == _processors.end()) {
1834 /* no more elements in the old list, so just stick the rest of
1835 the new order onto the temp list.
1838 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1839 while (niter != new_order.end()) {
1846 if (!(*oiter)->display_to_user()) {
1848 as_it_will_be.push_back (*oiter);
1852 /* visible processor: check that its in the new order */
1854 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1855 /* deleted: do nothing, shared_ptr<> will clean up */
1857 /* ignore this one, and add the next item from the new order instead */
1858 as_it_will_be.push_back (*niter);
1863 /* now remove from old order - its taken care of no matter what */
1864 oiter = _processors.erase (oiter);
1869 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1871 /* If the meter is in a custom position, find it and make a rough note of its position */
1872 maybe_note_meter_position ();
1874 if (configure_processors_unlocked (err)) {
1880 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1881 set_processor_positions ();
1893 Route::get_template()
1895 return state(false);
1899 Route::state(bool full_state)
1901 XMLNode *node = new XMLNode("Route");
1902 ProcessorList::iterator i;
1905 id().print (buf, sizeof (buf));
1906 node->add_property("id", buf);
1907 node->add_property ("name", _name);
1908 node->add_property("default-type", _default_type.to_string());
1911 node->add_property("flags", enum_2_string (_flags));
1914 node->add_property("active", _active?"yes":"no");
1916 boost::to_string (_phase_invert, p);
1917 node->add_property("phase-invert", p);
1918 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1919 node->add_property("meter-point", enum_2_string (_meter_point));
1921 node->add_property("meter-type", enum_2_string (_meter_type));
1924 node->add_property("route-group", _route_group->name());
1927 snprintf (buf, sizeof (buf), "%d", _order_key);
1928 node->add_property ("order-key", buf);
1929 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1930 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1931 node->add_property ("soloed-by-upstream", buf);
1932 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1933 node->add_property ("soloed-by-downstream", buf);
1934 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1935 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1937 node->add_child_nocopy (_input->state (full_state));
1938 node->add_child_nocopy (_output->state (full_state));
1939 node->add_child_nocopy (_solo_control->get_state ());
1940 node->add_child_nocopy (_mute_control->get_state ());
1941 node->add_child_nocopy (_mute_master->get_state ());
1943 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1944 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1945 remote_control_node->add_property (X_("id"), buf);
1946 node->add_child_nocopy (*remote_control_node);
1948 if (_comment.length()) {
1949 XMLNode *cmt = node->add_child ("Comment");
1950 cmt->add_content (_comment);
1954 node->add_child_nocopy (_pannable->state (full_state));
1957 for (i = _processors.begin(); i != _processors.end(); ++i) {
1959 /* template save: do not include internal sends functioning as
1960 aux sends because the chance of the target ID
1961 in the session where this template is used
1964 similarly, do not save listen sends which connect to
1965 the monitor section, because these will always be
1968 boost::shared_ptr<InternalSend> is;
1970 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
1971 if (is->role() == Delivery::Listen) {
1976 node->add_child_nocopy((*i)->state (full_state));
1980 node->add_child_copy (*_extra_xml);
1983 if (_custom_meter_position_noted) {
1984 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
1986 after->id().print (buf, sizeof (buf));
1987 node->add_property (X_("processor-after-last-custom-meter"), buf);
1990 node->add_property (X_("last-custom-meter-was-at-end"), _last_custom_meter_was_at_end ? "yes" : "no");
1997 Route::set_state (const XMLNode& node, int version)
1999 if (version < 3000) {
2000 return set_state_2X (node, version);
2004 XMLNodeConstIterator niter;
2006 const XMLProperty *prop;
2008 if (node.name() != "Route"){
2009 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2013 if ((prop = node.property (X_("name"))) != 0) {
2014 Route::set_name (prop->value());
2018 _initial_io_setup = true;
2020 if ((prop = node.property (X_("flags"))) != 0) {
2021 _flags = Flag (string_2_enum (prop->value(), _flags));
2026 if (is_master() || is_monitor() || is_auditioner()) {
2027 _mute_master->set_solo_ignore (true);
2031 /* monitor bus does not get a panner, but if (re)created
2032 via XML, it will already have one by the time we
2033 call ::set_state(). so ... remove it.
2038 /* add all processors (except amp, which is always present) */
2040 nlist = node.children();
2041 XMLNode processor_state (X_("processor_state"));
2043 Stateful::save_extra_xml (node);
2045 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2049 if (child->name() == IO::state_node_name) {
2050 if ((prop = child->property (X_("direction"))) == 0) {
2054 if (prop->value() == "Input") {
2055 _input->set_state (*child, version);
2056 } else if (prop->value() == "Output") {
2057 _output->set_state (*child, version);
2061 if (child->name() == X_("Processor")) {
2062 processor_state.add_child_copy (*child);
2065 if (child->name() == X_("Pannable")) {
2067 _pannable->set_state (*child, version);
2069 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2074 if ((prop = node.property (X_("meter-point"))) != 0) {
2075 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2076 set_meter_point (mp, true);
2078 _meter->set_display_to_user (_meter_point == MeterCustom);
2082 if ((prop = node.property (X_("meter-type"))) != 0) {
2083 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2086 _initial_io_setup = false;
2088 set_processor_state (processor_state);
2090 // this looks up the internal instrument in processors
2091 reset_instrument_info();
2093 if ((prop = node.property ("self-solo")) != 0) {
2094 set_self_solo (string_is_affirmative (prop->value()));
2097 if ((prop = node.property ("soloed-by-upstream")) != 0) {
2098 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
2099 mod_solo_by_others_upstream (atoi (prop->value()));
2102 if ((prop = node.property ("soloed-by-downstream")) != 0) {
2103 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
2104 mod_solo_by_others_downstream (atoi (prop->value()));
2107 if ((prop = node.property ("solo-isolated")) != 0) {
2108 set_solo_isolated (string_is_affirmative (prop->value()), this);
2111 if ((prop = node.property ("solo-safe")) != 0) {
2112 set_solo_safe (string_is_affirmative (prop->value()), this);
2115 if ((prop = node.property (X_("phase-invert"))) != 0) {
2116 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2119 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2120 set_denormal_protection (string_is_affirmative (prop->value()));
2123 if ((prop = node.property (X_("active"))) != 0) {
2124 bool yn = string_is_affirmative (prop->value());
2125 _active = !yn; // force switch
2126 set_active (yn, this);
2129 if ((prop = node.property (X_("order-key"))) != 0) { // New order key (no separate mixer/editor ordering)
2130 set_order_key (atoi(prop->value()));
2133 if ((prop = node.property (X_("order-keys"))) != 0) { // Deprecated order keys
2137 string::size_type colon, equal;
2138 string remaining = prop->value();
2140 while (remaining.length()) {
2142 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2143 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2146 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2147 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2150 string keyname = remaining.substr (0, equal);
2152 if ((keyname == "EditorSort") || (keyname == "editor")) {
2153 cerr << "Setting " << name() << " order key to " << n << " using saved Editor order." << endl;
2159 colon = remaining.find_first_of (':');
2161 if (colon != string::npos) {
2162 remaining = remaining.substr (colon+1);
2169 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2170 PBD::ID id (prop->value ());
2171 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2172 ProcessorList::const_iterator i = _processors.begin ();
2173 while (i != _processors.end() && (*i)->id() != id) {
2177 if (i != _processors.end ()) {
2178 _processor_after_last_custom_meter = *i;
2179 _custom_meter_position_noted = true;
2183 if ((prop = node.property (X_("last-custom-meter-was-at-end"))) != 0) {
2184 _last_custom_meter_was_at_end = string_is_affirmative (prop->value ());
2187 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2190 if (child->name() == X_("Comment")) {
2192 /* XXX this is a terrible API design in libxml++ */
2194 XMLNode *cmt = *(child->children().begin());
2195 _comment = cmt->content();
2197 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2198 if (prop->value() == "solo") {
2199 _solo_control->set_state (*child, version);
2200 } else if (prop->value() == "mute") {
2201 _mute_control->set_state (*child, version);
2204 } else if (child->name() == X_("RemoteControl")) {
2205 if ((prop = child->property (X_("id"))) != 0) {
2207 sscanf (prop->value().c_str(), "%d", &x);
2208 set_remote_control_id_internal (x);
2211 } else if (child->name() == X_("MuteMaster")) {
2212 _mute_master->set_state (*child, version);
2220 Route::set_state_2X (const XMLNode& node, int version)
2223 XMLNodeConstIterator niter;
2225 const XMLProperty *prop;
2227 /* 2X things which still remain to be handled:
2233 if (node.name() != "Route") {
2234 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2238 if ((prop = node.property (X_("flags"))) != 0) {
2239 string f = prop->value ();
2240 boost::replace_all (f, "ControlOut", "MonitorOut");
2241 _flags = Flag (string_2_enum (f, _flags));
2246 if (is_master() || is_monitor() || is_auditioner()) {
2247 _mute_master->set_solo_ignore (true);
2250 if ((prop = node.property (X_("phase-invert"))) != 0) {
2251 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2252 if (string_is_affirmative (prop->value ())) {
2255 set_phase_invert (p);
2258 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2259 set_denormal_protection (string_is_affirmative (prop->value()));
2262 if ((prop = node.property (X_("soloed"))) != 0) {
2263 bool yn = string_is_affirmative (prop->value());
2265 /* XXX force reset of solo status */
2267 set_solo (yn, this);
2270 if ((prop = node.property (X_("muted"))) != 0) {
2273 bool muted = string_is_affirmative (prop->value());
2279 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2281 if (string_is_affirmative (prop->value())){
2282 mute_point = mute_point + "PreFader";
2287 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2289 if (string_is_affirmative (prop->value())){
2292 mute_point = mute_point + ",";
2295 mute_point = mute_point + "PostFader";
2300 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2302 if (string_is_affirmative (prop->value())){
2305 mute_point = mute_point + ",";
2308 mute_point = mute_point + "Listen";
2313 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2315 if (string_is_affirmative (prop->value())){
2318 mute_point = mute_point + ",";
2321 mute_point = mute_point + "Main";
2325 _mute_master->set_mute_points (mute_point);
2326 _mute_master->set_muted_by_self (true);
2330 if ((prop = node.property (X_("meter-point"))) != 0) {
2331 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2334 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2335 don't mean the same thing.
2338 if ((prop = node.property (X_("order-keys"))) != 0) {
2342 string::size_type colon, equal;
2343 string remaining = prop->value();
2345 while (remaining.length()) {
2347 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2348 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2351 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2352 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2355 string keyname = remaining.substr (0, equal);
2357 if (keyname == "EditorSort" || keyname == "editor") {
2358 info << string_compose(_("Converting deprecated order key for %1 using Editor order %2"), name (), n) << endmsg;
2364 colon = remaining.find_first_of (':');
2366 if (colon != string::npos) {
2367 remaining = remaining.substr (colon+1);
2376 nlist = node.children ();
2377 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2381 if (child->name() == IO::state_node_name) {
2383 /* there is a note in IO::set_state_2X() about why we have to call
2387 _input->set_state_2X (*child, version, true);
2388 _output->set_state_2X (*child, version, false);
2390 if ((prop = child->property (X_("name"))) != 0) {
2391 Route::set_name (prop->value ());
2396 if ((prop = child->property (X_("active"))) != 0) {
2397 bool yn = string_is_affirmative (prop->value());
2398 _active = !yn; // force switch
2399 set_active (yn, this);
2402 if ((prop = child->property (X_("gain"))) != 0) {
2405 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2406 _amp->gain_control()->set_value (val);
2410 /* Set up Panners in the IO */
2411 XMLNodeList io_nlist = child->children ();
2413 XMLNodeConstIterator io_niter;
2416 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2418 io_child = *io_niter;
2420 if (io_child->name() == X_("Panner")) {
2421 _main_outs->panner_shell()->set_state(*io_child, version);
2422 } else if (io_child->name() == X_("Automation")) {
2423 /* IO's automation is for the fader */
2424 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2430 XMLNodeList redirect_nodes;
2432 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2436 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2437 redirect_nodes.push_back(child);
2442 set_processor_state_2X (redirect_nodes, version);
2444 Stateful::save_extra_xml (node);
2446 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2449 if (child->name() == X_("Comment")) {
2451 /* XXX this is a terrible API design in libxml++ */
2453 XMLNode *cmt = *(child->children().begin());
2454 _comment = cmt->content();
2456 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2457 if (prop->value() == X_("solo")) {
2458 _solo_control->set_state (*child, version);
2459 } else if (prop->value() == X_("mute")) {
2460 _mute_control->set_state (*child, version);
2463 } else if (child->name() == X_("RemoteControl")) {
2464 if ((prop = child->property (X_("id"))) != 0) {
2466 sscanf (prop->value().c_str(), "%d", &x);
2467 set_remote_control_id_internal (x);
2477 Route::get_processor_state ()
2479 XMLNode* root = new XMLNode (X_("redirects"));
2480 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2481 root->add_child_nocopy ((*i)->state (true));
2488 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2490 /* We don't bother removing existing processors not in nList, as this
2491 method will only be called when creating a Route from scratch, not
2492 for undo purposes. Just put processors in at the appropriate place
2496 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2497 add_processor_from_xml_2X (**i, version);
2502 Route::set_processor_state (const XMLNode& node)
2504 const XMLNodeList &nlist = node.children();
2505 XMLNodeConstIterator niter;
2506 ProcessorList new_order;
2507 bool must_configure = false;
2509 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2511 XMLProperty* prop = (*niter)->property ("type");
2513 if (prop->value() == "amp") {
2514 _amp->set_state (**niter, Stateful::current_state_version);
2515 new_order.push_back (_amp);
2516 } else if (prop->value() == "meter") {
2517 _meter->set_state (**niter, Stateful::current_state_version);
2518 new_order.push_back (_meter);
2519 } else if (prop->value() == "main-outs") {
2520 _main_outs->set_state (**niter, Stateful::current_state_version);
2521 } else if (prop->value() == "intreturn") {
2523 _intreturn.reset (new InternalReturn (_session));
2524 must_configure = true;
2526 _intreturn->set_state (**niter, Stateful::current_state_version);
2527 } else if (is_monitor() && prop->value() == "monitor") {
2528 if (!_monitor_control) {
2529 _monitor_control.reset (new MonitorProcessor (_session));
2530 must_configure = true;
2532 _monitor_control->set_state (**niter, Stateful::current_state_version);
2533 } else if (prop->value() == "capture") {
2534 /* CapturingProcessor should never be restored, it's always
2535 added explicitly when needed */
2537 ProcessorList::iterator o;
2539 for (o = _processors.begin(); o != _processors.end(); ++o) {
2540 XMLProperty* id_prop = (*niter)->property(X_("id"));
2541 if (id_prop && (*o)->id() == id_prop->value()) {
2542 (*o)->set_state (**niter, Stateful::current_state_version);
2543 new_order.push_back (*o);
2548 // If the processor (*niter) is not on the route then create it
2550 if (o == _processors.end()) {
2552 boost::shared_ptr<Processor> processor;
2554 if (prop->value() == "intsend") {
2556 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2557 processor.reset (new InternalSend (_session, sendpan, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2559 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2560 prop->value() == "lv2" ||
2561 prop->value() == "windows-vst" ||
2562 prop->value() == "lxvst" ||
2563 prop->value() == "audiounit") {
2565 processor.reset (new PluginInsert(_session));
2567 } else if (prop->value() == "port") {
2569 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2571 } else if (prop->value() == "send") {
2573 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2574 processor.reset (new Send (_session, sendpan, _mute_master));
2577 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2581 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2582 /* This processor could not be configured. Turn it into a UnknownProcessor */
2583 processor.reset (new UnknownProcessor (_session, **niter));
2586 /* we have to note the monitor send here, otherwise a new one will be created
2587 and the state of this one will be lost.
2589 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2590 if (isend && isend->role() == Delivery::Listen) {
2591 _monitor_send = isend;
2594 /* it doesn't matter if invisible processors are added here, as they
2595 will be sorted out by setup_invisible_processors () shortly.
2598 new_order.push_back (processor);
2599 must_configure = true;
2605 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2606 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2607 _processors = new_order;
2609 if (must_configure) {
2610 configure_processors_unlocked (0);
2613 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2615 (*i)->set_owner (this);
2616 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2618 boost::shared_ptr<PluginInsert> pi;
2620 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2621 if (pi->has_no_inputs ()) {
2622 _have_internal_generator = true;
2629 reset_instrument_info ();
2630 processors_changed (RouteProcessorChange ());
2631 set_processor_positions ();
2635 Route::curve_reallocate ()
2637 // _gain_automation_curve.finish_resize ();
2638 // _pan_automation_curve.finish_resize ();
2642 Route::silence (framecnt_t nframes)
2644 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2649 silence_unlocked (nframes);
2653 Route::silence_unlocked (framecnt_t nframes)
2655 /* Must be called with the processor lock held */
2659 _output->silence (nframes);
2661 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2662 boost::shared_ptr<PluginInsert> pi;
2664 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2665 // skip plugins, they don't need anything when we're not active
2669 (*i)->silence (nframes);
2672 if (nframes == _session.get_block_size()) {
2679 Route::add_internal_return ()
2682 _intreturn.reset (new InternalReturn (_session));
2683 add_processor (_intreturn, PreFader);
2688 Route::add_send_to_internal_return (InternalSend* send)
2690 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2692 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2693 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2696 return d->add_send (send);
2702 Route::remove_send_from_internal_return (InternalSend* send)
2704 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2706 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2707 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2710 return d->remove_send (send);
2716 Route::enable_monitor_send ()
2718 /* Caller must hold process lock */
2719 assert (!AudioEngine::instance()->process_lock().trylock());
2721 /* master never sends to monitor section via the normal mechanism */
2722 assert (!is_master ());
2723 assert (!is_monitor ());
2725 /* make sure we have one */
2726 if (!_monitor_send) {
2727 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2728 _monitor_send->set_display_to_user (false);
2732 configure_processors (0);
2735 /** Add an aux send to a route.
2736 * @param route route to send to.
2737 * @param before Processor to insert before, or 0 to insert at the end.
2740 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2742 assert (route != _session.monitor_out ());
2745 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2747 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2749 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2751 if (d && d->target_route() == route) {
2752 /* already listening via the specified IO: do nothing */
2760 boost::shared_ptr<InternalSend> listener;
2763 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2764 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2765 listener.reset (new InternalSend (_session, sendpan, _mute_master, route, Delivery::Aux));
2768 add_processor (listener, before);
2770 } catch (failed_constructor& err) {
2778 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
2780 ProcessorStreams err;
2781 ProcessorList::iterator tmp;
2784 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
2786 /* have to do this early because otherwise processor reconfig
2787 * will put _monitor_send back in the list
2790 if (route == _session.monitor_out()) {
2791 _monitor_send.reset ();
2795 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2797 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2799 if (d && d->target_route() == route) {
2801 remove_processor (*x, &err, false);
2804 /* list could have been demolished while we dropped the lock
2815 Route::set_comment (string cmt, void *src)
2818 comment_changed (src);
2819 _session.set_dirty ();
2823 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2825 FeedRecord fr (other, via_sends_only);
2827 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2829 if (!result.second) {
2831 /* already a record for "other" - make sure sends-only information is correct */
2832 if (!via_sends_only && result.first->sends_only) {
2833 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2834 frp->sends_only = false;
2838 return result.second;
2842 Route::clear_fed_by ()
2848 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2850 const FedBy& fed_by (other->fed_by());
2852 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2853 boost::shared_ptr<Route> sr = f->r.lock();
2855 if (sr && (sr.get() == this)) {
2857 if (via_sends_only) {
2858 *via_sends_only = f->sends_only;
2869 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
2871 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2873 if (_output->connected_to (other->input())) {
2874 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2875 if (via_send_only) {
2876 *via_send_only = false;
2883 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2885 boost::shared_ptr<IOProcessor> iop;
2887 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2888 if (iop->feeds (other)) {
2889 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2890 if (via_send_only) {
2891 *via_send_only = true;
2895 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2898 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2903 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2908 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
2910 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
2913 /** Called from the (non-realtime) butler thread when the transport is stopped */
2915 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
2917 framepos_t now = _session.transport_frame();
2920 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2922 Automatable::transport_stopped (now);
2924 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2926 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2930 (*i)->transport_stopped (now);
2934 _roll_delay = _initial_delay;
2938 Route::input_change_handler (IOChange change, void * /*src*/)
2940 bool need_to_queue_solo_change = true;
2942 if ((change.type & IOChange::ConfigurationChanged)) {
2943 /* This is called with the process lock held if change
2944 contains ConfigurationChanged
2946 need_to_queue_solo_change = false;
2947 configure_processors (0);
2948 _phase_invert.resize (_input->n_ports().n_audio ());
2949 io_changed (); /* EMIT SIGNAL */
2952 if (!_input->connected() && _soloed_by_others_upstream) {
2953 if (need_to_queue_solo_change) {
2954 _session.cancel_solo_after_disconnect (shared_from_this(), true);
2956 cancel_solo_after_disconnect (true);
2962 Route::output_change_handler (IOChange change, void * /*src*/)
2964 bool need_to_queue_solo_change = true;
2965 if (_initial_io_setup) {
2969 if ((change.type & IOChange::ConfigurationChanged)) {
2970 /* This is called with the process lock held if change
2971 contains ConfigurationChanged
2973 need_to_queue_solo_change = false;
2974 configure_processors (0);
2975 io_changed (); /* EMIT SIGNAL */
2978 if (!_output->connected() && _soloed_by_others_downstream) {
2979 if (need_to_queue_solo_change) {
2980 _session.cancel_solo_after_disconnect (shared_from_this(), false);
2982 cancel_solo_after_disconnect (false);
2988 Route::cancel_solo_after_disconnect (bool upstream)
2991 _soloed_by_others_upstream = 0;
2993 _soloed_by_others_downstream = 0;
2995 set_mute_master_solo ();
2996 solo_changed (false, this);
3000 Route::pans_required () const
3002 if (n_outputs().n_audio() < 2) {
3006 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3010 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3012 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3018 if (n_outputs().n_total() == 0) {
3022 if (!_active || n_inputs() == ChanCount::ZERO) {
3023 silence_unlocked (nframes);
3027 if (session_state_changing) {
3028 if (_session.transport_speed() != 0.0f) {
3029 /* we're rolling but some state is changing (e.g. our diskstream contents)
3030 so we cannot use them. Be silent till this is over.
3032 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3034 silence_unlocked (nframes);
3037 /* we're really not rolling, so we're either delivery silence or actually
3038 monitoring, both of which are safe to do while session_state_changing is true.
3042 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3044 fill_buffers_with_input (bufs, _input, nframes);
3046 if (_meter_point == MeterInput) {
3047 _meter->run (bufs, start_frame, end_frame, nframes, true);
3050 _amp->apply_gain_automation (false);
3051 passthru (bufs, start_frame, end_frame, nframes, 0);
3057 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3059 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3064 if (n_outputs().n_total() == 0) {
3068 if (!_active || n_inputs().n_total() == 0) {
3069 silence_unlocked (nframes);
3073 framepos_t unused = 0;
3075 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3081 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3083 fill_buffers_with_input (bufs, _input, nframes);
3085 if (_meter_point == MeterInput) {
3086 _meter->run (bufs, start_frame, end_frame, nframes, true);
3089 passthru (bufs, start_frame, end_frame, nframes, declick);
3095 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3102 Route::flush_processors ()
3104 /* XXX shouldn't really try to take this lock, since
3105 this is called from the RT audio thread.
3108 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3110 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3116 Route::set_meter_point (MeterPoint p, bool force)
3118 if (_meter_point == p && !force) {
3122 bool meter_was_visible_to_user = _meter->display_to_user ();
3125 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3127 maybe_note_meter_position ();
3131 if (_meter_point != MeterCustom) {
3133 _meter->set_display_to_user (false);
3135 setup_invisible_processors ();
3139 _meter->set_display_to_user (true);
3141 /* If we have a previous position for the custom meter, try to put it there */
3142 if (_custom_meter_position_noted) {
3143 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3146 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3147 if (i != _processors.end ()) {
3148 _processors.remove (_meter);
3149 _processors.insert (i, _meter);
3151 } else if (_last_custom_meter_was_at_end) {
3152 _processors.remove (_meter);
3153 _processors.push_back (_meter);
3158 /* Set up the meter for its new position */
3160 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3164 if (loc == _processors.begin()) {
3165 m_in = _input->n_ports();
3167 ProcessorList::iterator before = loc;
3169 m_in = (*before)->output_streams ();
3172 _meter->reflect_inputs (m_in);
3174 /* we do not need to reconfigure the processors, because the meter
3175 (a) is always ready to handle processor_max_streams
3176 (b) is always an N-in/N-out processor, and thus moving
3177 it doesn't require any changes to the other processors.
3181 meter_change (); /* EMIT SIGNAL */
3183 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
3185 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
3189 Route::listen_position_changed ()
3192 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3193 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3194 ProcessorState pstate (this);
3196 if (configure_processors_unlocked (0)) {
3198 configure_processors_unlocked (0); // it worked before we tried to add it ...
3203 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3204 _session.set_dirty ();
3207 boost::shared_ptr<CapturingProcessor>
3208 Route::add_export_point()
3210 if (!_capturing_processor) {
3212 _capturing_processor.reset (new CapturingProcessor (_session));
3213 _capturing_processor->activate ();
3215 configure_processors (0);
3219 return _capturing_processor;
3223 Route::update_signal_latency ()
3225 framecnt_t l = _output->user_latency();
3227 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3228 if ((*i)->active ()) {
3229 l += (*i)->signal_latency ();
3233 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3235 if (_signal_latency != l) {
3236 _signal_latency = l;
3237 signal_latency_changed (); /* EMIT SIGNAL */
3240 return _signal_latency;
3244 Route::set_user_latency (framecnt_t nframes)
3246 _output->set_user_latency (nframes);
3247 _session.update_latency_compensation ();
3251 Route::set_latency_compensation (framecnt_t longest_session_latency)
3253 framecnt_t old = _initial_delay;
3255 if (_signal_latency < longest_session_latency) {
3256 _initial_delay = longest_session_latency - _signal_latency;
3261 DEBUG_TRACE (DEBUG::Latency, string_compose (
3262 "%1: compensate for maximum latency of %2,"
3263 "given own latency of %3, using initial delay of %4\n",
3264 name(), longest_session_latency, _signal_latency, _initial_delay));
3266 if (_initial_delay != old) {
3267 initial_delay_changed (); /* EMIT SIGNAL */
3270 if (_session.transport_stopped()) {
3271 _roll_delay = _initial_delay;
3275 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3276 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3277 boost::shared_ptr<AutomationList>(), name)
3280 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3285 Route::SoloControllable::set_value (double val)
3287 bool bval = ((val >= 0.5f) ? true: false);
3289 boost::shared_ptr<RouteList> rl (new RouteList);
3291 boost::shared_ptr<Route> r = _route.lock ();
3298 if (Config->get_solo_control_is_listen_control()) {
3299 _session.set_listen (rl, bval);
3301 _session.set_solo (rl, bval);
3306 Route::SoloControllable::get_value () const
3308 boost::shared_ptr<Route> r = _route.lock ();
3313 if (Config->get_solo_control_is_listen_control()) {
3314 return r->listening_via_monitor() ? 1.0f : 0.0f;
3316 return r->self_soloed() ? 1.0f : 0.0f;
3320 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3321 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3322 boost::shared_ptr<AutomationList>(), name)
3325 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3330 Route::MuteControllable::set_value (double val)
3332 bool bval = ((val >= 0.5f) ? true: false);
3334 boost::shared_ptr<RouteList> rl (new RouteList);
3336 boost::shared_ptr<Route> r = _route.lock ();
3342 _session.set_mute (rl, bval);
3346 Route::MuteControllable::get_value () const
3348 boost::shared_ptr<Route> r = _route.lock ();
3353 return r->muted() ? 1.0f : 0.0f;
3357 Route::set_block_size (pframes_t nframes)
3359 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3360 (*i)->set_block_size (nframes);
3363 _session.ensure_buffers (n_process_buffers ());
3367 Route::protect_automation ()
3369 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3370 (*i)->protect_automation();
3373 /** @param declick 1 to set a pending declick fade-in,
3374 * -1 to set a pending declick fade-out
3377 Route::set_pending_declick (int declick)
3380 /* this call is not allowed to turn off a pending declick */
3382 _pending_declick = declick;
3385 _pending_declick = 0;
3389 /** Shift automation forwards from a particular place, thereby inserting time.
3390 * Adds undo commands for any shifts that are performed.
3392 * @param pos Position to start shifting from.
3393 * @param frames Amount to shift forwards by.
3397 Route::shift (framepos_t pos, framecnt_t frames)
3399 /* gain automation */
3401 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3403 XMLNode &before = gc->alist()->get_state ();
3404 gc->alist()->shift (pos, frames);
3405 XMLNode &after = gc->alist()->get_state ();
3406 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3409 /* pan automation */
3411 ControlSet::Controls& c (_pannable->controls());
3413 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3414 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3416 boost::shared_ptr<AutomationList> al = pc->alist();
3417 XMLNode& before = al->get_state ();
3418 al->shift (pos, frames);
3419 XMLNode& after = al->get_state ();
3420 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3425 /* redirect automation */
3427 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3428 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3430 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3432 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3433 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3435 boost::shared_ptr<AutomationList> al = ac->alist();
3436 XMLNode &before = al->get_state ();
3437 al->shift (pos, frames);
3438 XMLNode &after = al->get_state ();
3439 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3448 Route::save_as_template (const string& path, const string& name)
3450 XMLNode& node (state (false));
3453 IO::set_name_in_state (*node.children().front(), name);
3455 tree.set_root (&node);
3456 return tree.write (path.c_str());
3461 Route::set_name (const string& str)
3467 name = Route::ensure_track_or_route_name (str, _session);
3468 SessionObject::set_name (name);
3470 ret = (_input->set_name(name) && _output->set_name(name));
3473 /* rename the main outs. Leave other IO processors
3474 * with whatever name they already have, because its
3475 * just fine as it is (it will not contain the route
3476 * name if its a port insert, port send or port return).
3480 if (_main_outs->set_name (name)) {
3481 /* XXX returning false here is stupid because
3482 we already changed the route name.
3492 /** Set the name of a route in an XML description.
3493 * @param node XML <Route> node to set the name in.
3494 * @param name New name.
3497 Route::set_name_in_state (XMLNode& node, string const & name)
3499 node.add_property (X_("name"), name);
3501 XMLNodeList children = node.children();
3502 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3504 if ((*i)->name() == X_("IO")) {
3506 IO::set_name_in_state (**i, name);
3508 } else if ((*i)->name() == X_("Processor")) {
3510 XMLProperty* role = (*i)->property (X_("role"));
3511 if (role && role->value() == X_("Main")) {
3512 (*i)->add_property (X_("name"), name);
3515 } else if ((*i)->name() == X_("Diskstream")) {
3517 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3518 (*i)->add_property (X_("name"), name);
3524 boost::shared_ptr<Send>
3525 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3527 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3529 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3530 boost::shared_ptr<InternalSend> send;
3532 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3533 if (send->target_route() == target) {
3539 return boost::shared_ptr<Send>();
3542 /** @param c Audio channel index.
3543 * @param yn true to invert phase, otherwise false.
3546 Route::set_phase_invert (uint32_t c, bool yn)
3548 if (_phase_invert[c] != yn) {
3549 _phase_invert[c] = yn;
3550 phase_invert_changed (); /* EMIT SIGNAL */
3551 _session.set_dirty ();
3556 Route::set_phase_invert (boost::dynamic_bitset<> p)
3558 if (_phase_invert != p) {
3560 phase_invert_changed (); /* EMIT SIGNAL */
3561 _session.set_dirty ();
3566 Route::phase_invert (uint32_t c) const
3568 return _phase_invert[c];
3571 boost::dynamic_bitset<>
3572 Route::phase_invert () const
3574 return _phase_invert;
3578 Route::set_denormal_protection (bool yn)
3580 if (_denormal_protection != yn) {
3581 _denormal_protection = yn;
3582 denormal_protection_changed (); /* EMIT SIGNAL */
3587 Route::denormal_protection () const
3589 return _denormal_protection;
3593 Route::set_active (bool yn, void* src)
3595 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3596 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3600 if (_active != yn) {
3602 _input->set_active (yn);
3603 _output->set_active (yn);
3604 active_changed (); // EMIT SIGNAL
3605 _session.set_dirty ();
3612 Glib::Threads::RWLock::ReaderLock rm (_processor_lock, Glib::Threads::TRY_LOCK);
3618 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3620 boost::shared_ptr<Send> s;
3621 boost::shared_ptr<Return> r;
3623 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3624 s->meter()->meter();
3625 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3626 r->meter()->meter ();
3631 boost::shared_ptr<Pannable>
3632 Route::pannable() const
3637 boost::shared_ptr<Panner>
3638 Route::panner() const
3641 return _main_outs->panner_shell()->panner();
3644 boost::shared_ptr<PannerShell>
3645 Route::panner_shell() const
3647 return _main_outs->panner_shell();
3650 boost::shared_ptr<AutomationControl>
3651 Route::gain_control() const
3653 return _amp->gain_control();
3656 boost::shared_ptr<AutomationControl>
3657 Route::get_control (const Evoral::Parameter& param)
3659 /* either we own the control or .... */
3661 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3665 /* maybe one of our processors does or ... */
3667 Glib::Threads::RWLock::ReaderLock rm (_processor_lock, Glib::Threads::TRY_LOCK);
3668 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3669 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3677 /* nobody does so we'll make a new one */
3679 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3686 boost::shared_ptr<Processor>
3687 Route::nth_plugin (uint32_t n)
3689 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3690 ProcessorList::iterator i;
3692 for (i = _processors.begin(); i != _processors.end(); ++i) {
3693 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3700 return boost::shared_ptr<Processor> ();
3703 boost::shared_ptr<Processor>
3704 Route::nth_send (uint32_t n)
3706 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3707 ProcessorList::iterator i;
3709 for (i = _processors.begin(); i != _processors.end(); ++i) {
3710 if (boost::dynamic_pointer_cast<Send> (*i)) {
3717 return boost::shared_ptr<Processor> ();
3721 Route::has_io_processor_named (const string& name)
3723 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3724 ProcessorList::iterator i;
3726 for (i = _processors.begin(); i != _processors.end(); ++i) {
3727 if (boost::dynamic_pointer_cast<Send> (*i) ||
3728 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3729 if ((*i)->name() == name) {
3738 MuteMaster::MutePoint
3739 Route::mute_points () const
3741 return _mute_master->mute_points ();
3745 Route::set_processor_positions ()
3747 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3749 bool had_amp = false;
3750 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3751 (*i)->set_pre_fader (!had_amp);
3752 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3758 /** Called when there is a proposed change to the input port count */
3760 Route::input_port_count_changing (ChanCount to)
3762 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3764 /* The processors cannot be configured with the new input arrangement, so
3770 /* The change is ok */
3774 /** Called when there is a proposed change to the output port count */
3776 Route::output_port_count_changing (ChanCount to)
3778 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
3779 if (processor_out_streams.get(*t) > to.get(*t)) {
3783 /* The change is ok */
3788 Route::unknown_processors () const
3792 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3793 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3794 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3795 p.push_back ((*i)->name ());
3804 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3806 /* we assume that all our input ports feed all our output ports. its not
3807 universally true, but the alternative is way too corner-case to worry about.
3810 LatencyRange all_connections;
3813 all_connections.min = 0;
3814 all_connections.max = 0;
3816 all_connections.min = ~((pframes_t) 0);
3817 all_connections.max = 0;
3819 /* iterate over all "from" ports and determine the latency range for all of their
3820 connections to the "outside" (outside of this Route).
3823 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3827 p->get_connected_latency_range (range, playback);
3829 all_connections.min = min (all_connections.min, range.min);
3830 all_connections.max = max (all_connections.max, range.max);
3834 /* set the "from" port latencies to the max/min range of all their connections */
3836 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3837 p->set_private_latency_range (all_connections, playback);
3840 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3842 all_connections.min += our_latency;
3843 all_connections.max += our_latency;
3845 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3846 p->set_private_latency_range (all_connections, playback);
3849 return all_connections.max;
3853 Route::set_private_port_latencies (bool playback) const
3855 framecnt_t own_latency = 0;
3857 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3858 OR LATENCY CALLBACK.
3860 This is called (early) from the latency callback. It computes the REAL
3861 latency associated with each port and stores the result as the "private"
3862 latency of the port. A later call to Route::set_public_port_latencies()
3863 sets all ports to the same value to reflect the fact that we do latency
3864 compensation and so all signals are delayed by the same amount as they
3865 flow through ardour.
3868 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3869 if ((*i)->active ()) {
3870 own_latency += (*i)->signal_latency ();
3875 /* playback: propagate latency from "outside the route" to outputs to inputs */
3876 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3878 /* capture: propagate latency from "outside the route" to inputs to outputs */
3879 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3884 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3886 /* this is called to set the JACK-visible port latencies, which take
3887 latency compensation into account.
3896 const PortSet& ports (_input->ports());
3897 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3898 p->set_public_latency_range (range, playback);
3903 const PortSet& ports (_output->ports());
3904 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3905 p->set_public_latency_range (range, playback);
3910 /** Put the invisible processors in the right place in _processors.
3911 * Must be called with a writer lock on _processor_lock held.
3914 Route::setup_invisible_processors ()
3917 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3918 assert (!lm.locked ());
3922 /* too early to be doing this stuff */
3926 /* we'll build this new list here and then use it */
3928 ProcessorList new_processors;
3930 /* find visible processors */
3932 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3933 if ((*i)->display_to_user ()) {
3934 new_processors.push_back (*i);
3940 ProcessorList::iterator amp = new_processors.begin ();
3941 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3945 assert (amp != _processors.end ());
3947 /* and the processor after the amp */
3949 ProcessorList::iterator after_amp = amp;
3955 switch (_meter_point) {
3957 assert (!_meter->display_to_user ());
3958 new_processors.push_front (_meter);
3961 assert (!_meter->display_to_user ());
3962 new_processors.insert (amp, _meter);
3964 case MeterPostFader:
3965 /* do nothing here */
3968 /* do nothing here */
3971 /* the meter is visible, so we don't touch it here */
3978 assert (_main_outs);
3979 assert (!_main_outs->display_to_user ());
3980 new_processors.push_back (_main_outs);
3982 /* iterator for the main outs */
3984 ProcessorList::iterator main = new_processors.end();
3987 /* OUTPUT METERING */
3989 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3990 assert (!_meter->display_to_user ());
3992 /* add the processor just before or just after the main outs */
3994 ProcessorList::iterator meter_point = main;
3996 if (_meter_point == MeterOutput) {
3999 new_processors.insert (meter_point, _meter);
4004 if (_monitor_send && !is_monitor ()) {
4005 assert (!_monitor_send->display_to_user ());
4006 if (Config->get_solo_control_is_listen_control()) {
4007 switch (Config->get_listen_position ()) {
4008 case PreFaderListen:
4009 switch (Config->get_pfl_position ()) {
4010 case PFLFromBeforeProcessors:
4011 new_processors.push_front (_monitor_send);
4013 case PFLFromAfterProcessors:
4014 new_processors.insert (amp, _monitor_send);
4017 _monitor_send->set_can_pan (false);
4019 case AfterFaderListen:
4020 switch (Config->get_afl_position ()) {
4021 case AFLFromBeforeProcessors:
4022 new_processors.insert (after_amp, _monitor_send);
4024 case AFLFromAfterProcessors:
4025 new_processors.insert (new_processors.end(), _monitor_send);
4028 _monitor_send->set_can_pan (true);
4032 new_processors.insert (new_processors.end(), _monitor_send);
4033 _monitor_send->set_can_pan (false);
4037 /* MONITOR CONTROL */
4039 if (_monitor_control && is_monitor ()) {
4040 assert (!_monitor_control->display_to_user ());
4041 new_processors.push_front (_monitor_control);
4044 /* INTERNAL RETURN */
4046 /* doing this here means that any monitor control will come just after
4051 assert (!_intreturn->display_to_user ());
4052 new_processors.push_front (_intreturn);
4055 /* EXPORT PROCESSOR */
4057 if (_capturing_processor) {
4058 assert (!_capturing_processor->display_to_user ());
4059 new_processors.push_front (_capturing_processor);
4062 _processors = new_processors;
4064 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4065 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4066 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4073 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4074 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4078 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4079 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4086 /** If the meter point is `Custom', make a note of where the meter is.
4087 * This is so that if the meter point is subsequently set to something else,
4088 * and then back to custom, we can put the meter back where it was last time
4089 * custom was enabled.
4091 * Must be called with the _processor_lock held.
4094 Route::maybe_note_meter_position ()
4096 if (_meter_point != MeterCustom) {
4100 _custom_meter_position_noted = true;
4101 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4102 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4103 ProcessorList::iterator j = i;
4105 if (j != _processors.end ()) {
4106 _processor_after_last_custom_meter = *j;
4107 _last_custom_meter_was_at_end = false;
4109 _last_custom_meter_was_at_end = true;
4115 boost::shared_ptr<Processor>
4116 Route::processor_by_id (PBD::ID id) const
4118 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4119 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4120 if ((*i)->id() == id) {
4125 return boost::shared_ptr<Processor> ();
4128 /** @return the monitoring state, or in other words what data we are pushing
4129 * into the route (data from the inputs, data from disk or silence)
4132 Route::monitoring_state () const
4134 return MonitoringInput;
4137 /** @return what we should be metering; either the data coming from the input
4138 * IO or the data that is flowing through the route.
4141 Route::metering_state () const
4143 return MeteringRoute;
4147 Route::has_external_redirects () const
4149 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4151 /* ignore inactive processors and obviously ignore the main
4152 * outs since everything has them and we don't care.
4155 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4163 boost::shared_ptr<Processor>
4164 Route::the_instrument () const
4166 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4167 return the_instrument_unlocked ();
4170 boost::shared_ptr<Processor>
4171 Route::the_instrument_unlocked () const
4173 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4174 if (boost::dynamic_pointer_cast<PluginInsert>(*i)) {
4175 if ((*i)->input_streams().n_midi() > 0 &&
4176 (*i)->output_streams().n_audio() > 0) {
4181 return boost::shared_ptr<Processor>();
4187 Route::non_realtime_locate (framepos_t pos)
4190 _pannable->transport_located (pos);
4194 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4195 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
4197 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4198 (*i)->transport_located (pos);
4204 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4211 * We don't currently mix MIDI input together, so we don't need the
4212 * complex logic of the audio case.
4215 n_buffers = bufs.count().n_midi ();
4217 for (i = 0; i < n_buffers; ++i) {
4219 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4220 MidiBuffer& buf (bufs.get_midi (i));
4223 buf.copy (source_port->get_midi_buffer(nframes));
4225 buf.silence (nframes);
4231 n_buffers = bufs.count().n_audio();
4233 size_t n_ports = io->n_ports().n_audio();
4234 float scaling = 1.0f;
4236 if (n_ports > n_buffers) {
4237 scaling = ((float) n_buffers) / n_ports;
4240 for (i = 0; i < n_ports; ++i) {
4242 /* if there are more ports than buffers, map them onto buffers
4243 * in a round-robin fashion
4246 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4247 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4250 if (i < n_buffers) {
4252 /* first time through just copy a channel into
4256 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4258 if (scaling != 1.0f) {
4259 buf.apply_gain (scaling, nframes);
4264 /* on subsequent times around, merge data from
4265 * the port with what is already there
4268 if (scaling != 1.0f) {
4269 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4271 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4276 /* silence any remaining buffers */
4278 for (; i < n_buffers; ++i) {
4279 AudioBuffer& buf (bufs.get_audio (i));
4280 buf.silence (nframes);
4283 /* establish the initial setup of the buffer set, reflecting what was
4284 copied into it. unless, of course, we are the auditioner, in which
4285 case nothing was fed into it from the inputs at all.
4288 if (!is_auditioner()) {
4289 bufs.set_count (io->n_ports());