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 fill_buffers_with_input (bufs, _input, nframes);
548 passthru (bufs, start_frame, end_frame, nframes, declick);
552 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
556 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
558 /* control/monitor bus ignores input ports when something is
559 feeding the listen "stream". data will "arrive" into the
560 route from the intreturn processor element.
563 bufs.silence (nframes, 0);
566 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
567 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
571 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
573 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
575 bufs.set_count (_input->n_ports());
576 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
577 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
581 Route::set_listen (bool yn, void* src)
587 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
588 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
593 if (yn != _monitor_send->active()) {
595 _monitor_send->activate ();
596 _mute_master->set_soloed (true);
598 _monitor_send->deactivate ();
599 _mute_master->set_soloed (false);
602 listen_changed (src); /* EMIT SIGNAL */
608 Route::listening_via_monitor () const
611 return _monitor_send->active ();
618 Route::set_solo_safe (bool yn, void *src)
620 if (_solo_safe != yn) {
622 solo_safe_changed (src);
627 Route::solo_safe() const
633 Route::set_solo (bool yn, void *src)
636 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change due to solo-safe\n", name()));
640 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
641 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
645 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set solo => %2, src: %3 grp ? %4 currently self-soloed ? %5\n",
646 name(), yn, src, (src == _route_group), self_soloed()));
648 if (self_soloed() != yn) {
650 set_mute_master_solo ();
651 solo_changed (true, src); /* EMIT SIGNAL */
652 _solo_control->Changed (); /* EMIT SIGNAL */
657 Route::set_self_solo (bool yn)
659 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set SELF solo => %2\n", name(), yn));
664 Route::mod_solo_by_others_upstream (int32_t delta)
667 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-upstream due to solo-safe\n", name()));
671 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-upstream by %2, current up = %3 down = %4\n",
672 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
674 uint32_t old_sbu = _soloed_by_others_upstream;
677 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
678 _soloed_by_others_upstream += delta;
680 _soloed_by_others_upstream = 0;
683 _soloed_by_others_upstream += delta;
686 DEBUG_TRACE (DEBUG::Solo, string_compose (
687 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
688 name(), delta, _soloed_by_others_upstream, old_sbu,
689 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
691 /* push the inverse solo change to everything that feeds us.
693 This is important for solo-within-group. When we solo 1 track out of N that
694 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
695 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
696 tracks that feed it. This will silence them if they were audible because
697 of a bus solo, but the newly soloed track will still be audible (because
700 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
704 if ((_self_solo || _soloed_by_others_downstream) &&
705 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
706 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
708 if (delta > 0 || !Config->get_exclusive_solo()) {
709 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
710 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
711 boost::shared_ptr<Route> sr = i->r.lock();
713 sr->mod_solo_by_others_downstream (-delta);
719 set_mute_master_solo ();
720 solo_changed (false, this);
724 Route::mod_solo_by_others_downstream (int32_t delta)
727 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-downstream due to solo safe\n", name()));
731 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-downstream by %2, current up = %3 down = %4\n",
732 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
735 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
736 _soloed_by_others_downstream += delta;
738 _soloed_by_others_downstream = 0;
741 _soloed_by_others_downstream += delta;
744 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
746 set_mute_master_solo ();
747 solo_changed (false, this);
751 Route::set_mute_master_solo ()
753 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
757 Route::set_solo_isolated (bool yn, void *src)
759 if (is_master() || is_monitor() || is_auditioner()) {
763 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
764 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
768 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
770 boost::shared_ptr<RouteList> routes = _session.get_routes ();
771 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
773 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
778 bool does_feed = direct_feeds_according_to_graph (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
780 if (does_feed && !sends_only) {
781 (*i)->set_solo_isolated (yn, (*i)->route_group());
785 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
787 bool changed = false;
790 if (_solo_isolated == 0) {
791 _mute_master->set_solo_ignore (true);
796 if (_solo_isolated > 0) {
798 if (_solo_isolated == 0) {
799 _mute_master->set_solo_ignore (false);
806 solo_isolated_changed (src);
811 Route::solo_isolated () const
813 return _solo_isolated > 0;
817 Route::set_mute_points (MuteMaster::MutePoint mp)
819 _mute_master->set_mute_points (mp);
820 mute_points_changed (); /* EMIT SIGNAL */
822 if (_mute_master->muted_by_self()) {
823 mute_changed (this); /* EMIT SIGNAL */
824 _mute_control->Changed (); /* EMIT SIGNAL */
829 Route::set_mute (bool yn, void *src)
831 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
832 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
837 _mute_master->set_muted_by_self (yn);
838 /* allow any derived classes to respond to the mute change
839 before anybody else knows about it.
842 /* tell everyone else */
843 mute_changed (src); /* EMIT SIGNAL */
844 _mute_control->Changed (); /* EMIT SIGNAL */
849 Route::muted () const
851 return _mute_master->muted_by_self();
856 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
858 cerr << name << " {" << endl;
859 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
860 p != procs.end(); ++p) {
861 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
867 /** Supposing that we want to insert a Processor at a given Placement, return
868 * the processor to add the new one before (or 0 to add at the end).
870 boost::shared_ptr<Processor>
871 Route::before_processor_for_placement (Placement p)
873 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
875 ProcessorList::iterator loc;
878 /* generic pre-fader: insert immediately before the amp */
879 loc = find (_processors.begin(), _processors.end(), _amp);
881 /* generic post-fader: insert right before the main outs */
882 loc = find (_processors.begin(), _processors.end(), _main_outs);
885 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
888 /** Supposing that we want to insert a Processor at a given index, return
889 * the processor to add the new one before (or 0 to add at the end).
891 boost::shared_ptr<Processor>
892 Route::before_processor_for_index (int index)
895 return boost::shared_ptr<Processor> ();
898 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
900 ProcessorList::iterator i = _processors.begin ();
902 while (i != _processors.end() && j < index) {
903 if ((*i)->display_to_user()) {
910 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
913 /** Add a processor either pre- or post-fader
914 * @return 0 on success, non-0 on failure.
917 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
919 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
923 /** Add a processor to a route such that it ends up with a given index into the visible processors.
924 * @param index Index to add the processor at, or -1 to add at the end of the list.
925 * @return 0 on success, non-0 on failure.
928 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
930 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
933 /** Add a processor to the route.
934 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
935 * @return 0 on success, non-0 on failure.
938 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
940 assert (processor != _meter);
941 assert (processor != _main_outs);
943 DEBUG_TRACE (DEBUG::Processors, string_compose (
944 "%1 adding processor %2\n", name(), processor->name()));
946 if (!AudioEngine::instance()->connected() || !processor) {
951 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
952 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
953 ProcessorState pstate (this);
955 boost::shared_ptr<PluginInsert> pi;
956 boost::shared_ptr<PortInsert> porti;
958 if (processor == _amp) {
959 /* Ensure that only one amp is in the list at any time */
960 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), processor);
961 if (check != _processors.end()) {
962 if (before == _amp) {
963 /* Already in position; all is well */
966 _processors.erase (check);
971 assert (find (_processors.begin(), _processors.end(), processor) == _processors.end ());
973 ProcessorList::iterator loc;
975 /* inserting before a processor; find it */
976 loc = find (_processors.begin(), _processors.end(), before);
977 if (loc == _processors.end ()) {
982 /* inserting at end */
983 loc = _processors.end ();
986 _processors.insert (loc, processor);
987 processor->set_owner (this);
989 // Set up processor list channels. This will set processor->[input|output]_streams(),
990 // configure redirect ports properly, etc.
993 if (configure_processors_unlocked (err)) {
995 configure_processors_unlocked (0); // it worked before we tried to add it ...
1000 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1002 if (pi->has_no_inputs ()) {
1003 /* generator plugin */
1004 _have_internal_generator = true;
1009 if (activation_allowed && !_session.get_disable_all_loaded_plugins()) {
1010 processor->activate ();
1013 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1015 _output->set_user_latency (0);
1018 reset_instrument_info ();
1019 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1020 set_processor_positions ();
1026 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1028 const XMLProperty *prop;
1031 boost::shared_ptr<Processor> processor;
1033 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1034 so that we can add the processor in the right place (pre/post-fader)
1037 XMLNodeList const & children = node.children ();
1038 XMLNodeList::const_iterator i = children.begin ();
1040 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1044 Placement placement = PreFader;
1046 if (i != children.end()) {
1047 if ((prop = (*i)->property (X_("placement"))) != 0) {
1048 placement = Placement (string_2_enum (prop->value(), placement));
1052 if (node.name() == "Insert") {
1054 if ((prop = node.property ("type")) != 0) {
1056 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1057 prop->value() == "lv2" ||
1058 prop->value() == "windows-vst" ||
1059 prop->value() == "lxvst" ||
1060 prop->value() == "audiounit") {
1062 processor.reset (new PluginInsert (_session));
1066 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1071 } else if (node.name() == "Send") {
1073 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
1074 processor.reset (new Send (_session, sendpan, _mute_master));
1078 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1082 if (processor->set_state (node, version)) {
1086 return (add_processor (processor, placement) == 0);
1089 catch (failed_constructor &err) {
1090 warning << _("processor could not be created. Ignored.") << endmsg;
1096 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1098 /* NOTE: this is intended to be used ONLY when copying
1099 processors from another Route. Hence the subtle
1100 differences between this and ::add_processor()
1103 ProcessorList::iterator loc;
1106 loc = find(_processors.begin(), _processors.end(), before);
1108 /* nothing specified - at end */
1109 loc = _processors.end ();
1112 if (!_session.engine().connected()) {
1116 if (others.empty()) {
1121 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1122 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1123 ProcessorState pstate (this);
1125 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1131 boost::shared_ptr<PluginInsert> pi;
1133 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1137 _processors.insert (loc, *i);
1138 (*i)->set_owner (this);
1140 if ((*i)->active()) {
1144 /* Think: does this really need to be called for every processor in the loop? */
1146 if (configure_processors_unlocked (err)) {
1148 configure_processors_unlocked (0); // it worked before we tried to add it ...
1153 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1156 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1157 boost::shared_ptr<PluginInsert> pi;
1159 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1160 if (pi->has_no_inputs ()) {
1161 _have_internal_generator = true;
1167 _output->set_user_latency (0);
1170 reset_instrument_info ();
1171 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1172 set_processor_positions ();
1178 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1180 if (p == PreFader) {
1181 start = _processors.begin();
1182 end = find(_processors.begin(), _processors.end(), _amp);
1184 start = find(_processors.begin(), _processors.end(), _amp);
1186 end = _processors.end();
1190 /** Turn off all processors with a given placement
1191 * @param p Placement of processors to disable
1194 Route::disable_processors (Placement p)
1196 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1198 ProcessorList::iterator start, end;
1199 placement_range(p, start, end);
1201 for (ProcessorList::iterator i = start; i != end; ++i) {
1202 (*i)->deactivate ();
1205 _session.set_dirty ();
1208 /** Turn off all redirects
1211 Route::disable_processors ()
1213 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1215 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1216 (*i)->deactivate ();
1219 _session.set_dirty ();
1222 /** Turn off all redirects with a given placement
1223 * @param p Placement of redirects to disable
1226 Route::disable_plugins (Placement p)
1228 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1230 ProcessorList::iterator start, end;
1231 placement_range(p, start, end);
1233 for (ProcessorList::iterator i = start; i != end; ++i) {
1234 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1235 (*i)->deactivate ();
1239 _session.set_dirty ();
1242 /** Turn off all plugins
1245 Route::disable_plugins ()
1247 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1249 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1250 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1251 (*i)->deactivate ();
1255 _session.set_dirty ();
1260 Route::ab_plugins (bool forward)
1262 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1266 /* forward = turn off all active redirects, and mark them so that the next time
1267 we go the other way, we will revert them
1270 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1271 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1275 if ((*i)->active()) {
1276 (*i)->deactivate ();
1277 (*i)->set_next_ab_is_active (true);
1279 (*i)->set_next_ab_is_active (false);
1285 /* backward = if the redirect was marked to go active on the next ab, do so */
1287 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1289 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1293 if ((*i)->get_next_ab_is_active()) {
1296 (*i)->deactivate ();
1301 _session.set_dirty ();
1305 /** Remove processors with a given placement.
1306 * @param p Placement of processors to remove.
1309 Route::clear_processors (Placement p)
1311 if (!_session.engine().connected()) {
1315 bool already_deleting = _session.deletion_in_progress();
1316 if (!already_deleting) {
1317 _session.set_deletion_in_progress();
1321 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1322 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1323 ProcessorList new_list;
1324 ProcessorStreams err;
1325 bool seen_amp = false;
1327 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1333 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1335 /* you can't remove these */
1337 new_list.push_back (*i);
1344 new_list.push_back (*i);
1347 (*i)->drop_references ();
1355 (*i)->drop_references ();
1358 new_list.push_back (*i);
1365 _processors = new_list;
1366 configure_processors_unlocked (&err); // this can't fail
1369 processor_max_streams.reset();
1370 _have_internal_generator = false;
1371 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1372 set_processor_positions ();
1374 reset_instrument_info ();
1376 if (!already_deleting) {
1377 _session.clear_deletion_in_progress();
1382 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1384 // TODO once the export point can be configured properly, do something smarter here
1385 if (processor == _capturing_processor) {
1386 _capturing_processor.reset();
1389 /* these can never be removed */
1391 if (processor == _amp || processor == _meter || processor == _main_outs) {
1395 if (!_session.engine().connected()) {
1399 processor_max_streams.reset();
1402 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
1403 if (need_process_lock) {
1406 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1407 ProcessorState pstate (this);
1409 ProcessorList::iterator i;
1410 bool removed = false;
1412 for (i = _processors.begin(); i != _processors.end(); ) {
1413 if (*i == processor) {
1415 /* move along, see failure case for configure_processors()
1416 where we may need to reconfigure the processor.
1419 /* stop redirects that send signals to JACK ports
1420 from causing noise as a result of no longer being
1424 boost::shared_ptr<IOProcessor> iop;
1426 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1430 i = _processors.erase (i);
1438 _output->set_user_latency (0);
1446 if (configure_processors_unlocked (err)) {
1448 /* we know this will work, because it worked before :) */
1449 configure_processors_unlocked (0);
1453 _have_internal_generator = false;
1455 for (i = _processors.begin(); i != _processors.end(); ++i) {
1456 boost::shared_ptr<PluginInsert> pi;
1458 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1459 if (pi->has_no_inputs ()) {
1460 _have_internal_generator = true;
1465 if (need_process_lock) {
1470 reset_instrument_info ();
1471 processor->drop_references ();
1472 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1473 set_processor_positions ();
1479 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1481 ProcessorList deleted;
1483 if (!_session.engine().connected()) {
1487 processor_max_streams.reset();
1490 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1491 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1492 ProcessorState pstate (this);
1494 ProcessorList::iterator i;
1495 boost::shared_ptr<Processor> processor;
1497 for (i = _processors.begin(); i != _processors.end(); ) {
1501 /* these can never be removed */
1503 if (processor == _amp || processor == _meter || processor == _main_outs) {
1508 /* see if its in the list of processors to delete */
1510 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1515 /* stop IOProcessors that send to JACK ports
1516 from causing noise as a result of no longer being
1520 boost::shared_ptr<IOProcessor> iop;
1522 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1526 deleted.push_back (processor);
1527 i = _processors.erase (i);
1530 if (deleted.empty()) {
1531 /* none of those in the requested list were found */
1535 _output->set_user_latency (0);
1537 if (configure_processors_unlocked (err)) {
1539 /* we know this will work, because it worked before :) */
1540 configure_processors_unlocked (0);
1545 _have_internal_generator = false;
1547 for (i = _processors.begin(); i != _processors.end(); ++i) {
1548 boost::shared_ptr<PluginInsert> pi;
1550 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1551 if (pi->has_no_inputs ()) {
1552 _have_internal_generator = true;
1559 /* now try to do what we need to so that those that were removed will be deleted */
1561 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1562 (*i)->drop_references ();
1565 reset_instrument_info ();
1566 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1567 set_processor_positions ();
1573 Route::reset_instrument_info ()
1575 boost::shared_ptr<Processor> instr = the_instrument();
1577 _instrument_info.set_internal_instrument (instr);
1581 /** Caller must hold process lock */
1583 Route::configure_processors (ProcessorStreams* err)
1585 #ifndef PLATFORM_WINDOWS
1586 assert (!AudioEngine::instance()->process_lock().trylock());
1589 if (!_in_configure_processors) {
1590 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1591 return configure_processors_unlocked (err);
1598 Route::input_streams () const
1600 return _input->n_ports ();
1603 list<pair<ChanCount, ChanCount> >
1604 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1606 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1608 return try_configure_processors_unlocked (in, err);
1611 list<pair<ChanCount, ChanCount> >
1612 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1614 // Check each processor in order to see if we can configure as requested
1616 list<pair<ChanCount, ChanCount> > configuration;
1619 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1620 DEBUG_TRACE (DEBUG::Processors, "{\n");
1622 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1624 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1625 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1626 DEBUG_TRACE (DEBUG::Processors, "}\n");
1627 return list<pair<ChanCount, ChanCount> > ();
1630 if ((*p)->can_support_io_configuration(in, out)) {
1631 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1632 configuration.push_back(make_pair(in, out));
1639 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1640 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1641 DEBUG_TRACE (DEBUG::Processors, "}\n");
1642 return list<pair<ChanCount, ChanCount> > ();
1646 DEBUG_TRACE (DEBUG::Processors, "}\n");
1648 return configuration;
1651 /** Set the input/output configuration of each processor in the processors list.
1652 * Caller must hold process lock.
1653 * Return 0 on success, otherwise configuration is impossible.
1656 Route::configure_processors_unlocked (ProcessorStreams* err)
1658 #ifndef PLATFORM_WINDOWS
1659 assert (!AudioEngine::instance()->process_lock().trylock());
1662 if (_in_configure_processors) {
1666 /* put invisible processors where they should be */
1667 setup_invisible_processors ();
1669 _in_configure_processors = true;
1671 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1673 if (configuration.empty ()) {
1674 _in_configure_processors = false;
1679 bool seen_mains_out = false;
1680 processor_out_streams = _input->n_ports();
1681 processor_max_streams.reset();
1683 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1684 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1686 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1690 (*p)->configure_io(c->first, c->second);
1691 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1692 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1695 if (boost::dynamic_pointer_cast<Delivery> (*p)
1696 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1697 /* main delivery will increase port count to match input.
1698 * the Delivery::Main is usually the last processor - followed only by
1701 seen_mains_out = true;
1703 if (!seen_mains_out) {
1704 processor_out_streams = out;
1710 _meter->reset_max_channels (processor_max_streams);
1713 /* make sure we have sufficient scratch buffers to cope with the new processor
1716 _session.ensure_buffers (n_process_buffers ());
1718 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1720 _in_configure_processors = false;
1724 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1725 * @param state New active state for those processors.
1728 Route::all_visible_processors_active (bool state)
1730 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1732 if (_processors.empty()) {
1736 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1737 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1744 (*i)->deactivate ();
1748 _session.set_dirty ();
1752 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1754 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1755 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1756 processors in the current actual processor list that are hidden. Any visible processors
1757 in the current list but not in "new_order" will be assumed to be deleted.
1761 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1762 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1763 ProcessorState pstate (this);
1765 ProcessorList::iterator oiter;
1766 ProcessorList::const_iterator niter;
1767 ProcessorList as_it_will_be;
1769 oiter = _processors.begin();
1770 niter = new_order.begin();
1772 while (niter != new_order.end()) {
1774 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1775 then append it to the temp list.
1777 Otherwise, see if the next processor in the old list is in the new list. if not,
1778 its been deleted. If its there, append it to the temp list.
1781 if (oiter == _processors.end()) {
1783 /* no more elements in the old list, so just stick the rest of
1784 the new order onto the temp list.
1787 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1788 while (niter != new_order.end()) {
1795 if (!(*oiter)->display_to_user()) {
1797 as_it_will_be.push_back (*oiter);
1801 /* visible processor: check that its in the new order */
1803 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1804 /* deleted: do nothing, shared_ptr<> will clean up */
1806 /* ignore this one, and add the next item from the new order instead */
1807 as_it_will_be.push_back (*niter);
1812 /* now remove from old order - its taken care of no matter what */
1813 oiter = _processors.erase (oiter);
1818 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1820 /* If the meter is in a custom position, find it and make a rough note of its position */
1821 maybe_note_meter_position ();
1823 if (configure_processors_unlocked (err)) {
1829 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1830 set_processor_positions ();
1842 Route::get_template()
1844 return state(false);
1848 Route::state(bool full_state)
1850 XMLNode *node = new XMLNode("Route");
1851 ProcessorList::iterator i;
1854 id().print (buf, sizeof (buf));
1855 node->add_property("id", buf);
1856 node->add_property ("name", _name);
1857 node->add_property("default-type", _default_type.to_string());
1860 node->add_property("flags", enum_2_string (_flags));
1863 node->add_property("active", _active?"yes":"no");
1865 boost::to_string (_phase_invert, p);
1866 node->add_property("phase-invert", p);
1867 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1868 node->add_property("meter-point", enum_2_string (_meter_point));
1870 node->add_property("meter-type", enum_2_string (_meter_type));
1873 node->add_property("route-group", _route_group->name());
1876 snprintf (buf, sizeof (buf), "%d", _order_key);
1877 node->add_property ("order-key", buf);
1878 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1879 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1880 node->add_property ("soloed-by-upstream", buf);
1881 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1882 node->add_property ("soloed-by-downstream", buf);
1883 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1884 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1886 node->add_child_nocopy (_input->state (full_state));
1887 node->add_child_nocopy (_output->state (full_state));
1888 node->add_child_nocopy (_solo_control->get_state ());
1889 node->add_child_nocopy (_mute_control->get_state ());
1890 node->add_child_nocopy (_mute_master->get_state ());
1892 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1893 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1894 remote_control_node->add_property (X_("id"), buf);
1895 node->add_child_nocopy (*remote_control_node);
1897 if (_comment.length()) {
1898 XMLNode *cmt = node->add_child ("Comment");
1899 cmt->add_content (_comment);
1903 node->add_child_nocopy (_pannable->state (full_state));
1906 for (i = _processors.begin(); i != _processors.end(); ++i) {
1908 /* template save: do not include internal sends functioning as
1909 aux sends because the chance of the target ID
1910 in the session where this template is used
1913 similarly, do not save listen sends which connect to
1914 the monitor section, because these will always be
1917 boost::shared_ptr<InternalSend> is;
1919 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
1920 if (is->role() == Delivery::Listen) {
1925 node->add_child_nocopy((*i)->state (full_state));
1929 node->add_child_copy (*_extra_xml);
1932 if (_custom_meter_position_noted) {
1933 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
1935 after->id().print (buf, sizeof (buf));
1936 node->add_property (X_("processor-after-last-custom-meter"), buf);
1939 node->add_property (X_("last-custom-meter-was-at-end"), _last_custom_meter_was_at_end ? "yes" : "no");
1946 Route::set_state (const XMLNode& node, int version)
1948 if (version < 3000) {
1949 return set_state_2X (node, version);
1953 XMLNodeConstIterator niter;
1955 const XMLProperty *prop;
1957 if (node.name() != "Route"){
1958 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
1962 if ((prop = node.property (X_("name"))) != 0) {
1963 Route::set_name (prop->value());
1967 _initial_io_setup = true;
1969 if ((prop = node.property (X_("flags"))) != 0) {
1970 _flags = Flag (string_2_enum (prop->value(), _flags));
1975 if (is_master() || is_monitor() || is_auditioner()) {
1976 _mute_master->set_solo_ignore (true);
1980 /* monitor bus does not get a panner, but if (re)created
1981 via XML, it will already have one by the time we
1982 call ::set_state(). so ... remove it.
1987 /* add all processors (except amp, which is always present) */
1989 nlist = node.children();
1990 XMLNode processor_state (X_("processor_state"));
1992 Stateful::save_extra_xml (node);
1994 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
1998 if (child->name() == IO::state_node_name) {
1999 if ((prop = child->property (X_("direction"))) == 0) {
2003 if (prop->value() == "Input") {
2004 _input->set_state (*child, version);
2005 } else if (prop->value() == "Output") {
2006 _output->set_state (*child, version);
2010 if (child->name() == X_("Processor")) {
2011 processor_state.add_child_copy (*child);
2014 if (child->name() == X_("Pannable")) {
2016 _pannable->set_state (*child, version);
2018 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2023 if ((prop = node.property (X_("meter-point"))) != 0) {
2024 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2025 set_meter_point (mp, true);
2027 _meter->set_display_to_user (_meter_point == MeterCustom);
2031 if ((prop = node.property (X_("meter-type"))) != 0) {
2032 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2035 _initial_io_setup = false;
2037 set_processor_state (processor_state);
2039 // this looks up the internal instrument in processors
2040 reset_instrument_info();
2042 if ((prop = node.property ("self-solo")) != 0) {
2043 set_self_solo (string_is_affirmative (prop->value()));
2046 if ((prop = node.property ("soloed-by-upstream")) != 0) {
2047 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
2048 mod_solo_by_others_upstream (atoi (prop->value()));
2051 if ((prop = node.property ("soloed-by-downstream")) != 0) {
2052 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
2053 mod_solo_by_others_downstream (atoi (prop->value()));
2056 if ((prop = node.property ("solo-isolated")) != 0) {
2057 set_solo_isolated (string_is_affirmative (prop->value()), this);
2060 if ((prop = node.property ("solo-safe")) != 0) {
2061 set_solo_safe (string_is_affirmative (prop->value()), this);
2064 if ((prop = node.property (X_("phase-invert"))) != 0) {
2065 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2068 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2069 set_denormal_protection (string_is_affirmative (prop->value()));
2072 if ((prop = node.property (X_("active"))) != 0) {
2073 bool yn = string_is_affirmative (prop->value());
2074 _active = !yn; // force switch
2075 set_active (yn, this);
2078 if ((prop = node.property (X_("order-key"))) != 0) { // New order key (no separate mixer/editor ordering)
2079 set_order_key (atoi(prop->value()));
2082 if ((prop = node.property (X_("order-keys"))) != 0) { // Deprecated order keys
2086 string::size_type colon, equal;
2087 string remaining = prop->value();
2089 while (remaining.length()) {
2091 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2092 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2095 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2096 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2099 string keyname = remaining.substr (0, equal);
2101 if ((keyname == "EditorSort") || (keyname == "editor")) {
2102 cerr << "Setting " << name() << " order key to " << n << " using saved Editor order." << endl;
2108 colon = remaining.find_first_of (':');
2110 if (colon != string::npos) {
2111 remaining = remaining.substr (colon+1);
2118 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2119 PBD::ID id (prop->value ());
2120 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2121 ProcessorList::const_iterator i = _processors.begin ();
2122 while (i != _processors.end() && (*i)->id() != id) {
2126 if (i != _processors.end ()) {
2127 _processor_after_last_custom_meter = *i;
2128 _custom_meter_position_noted = true;
2132 if ((prop = node.property (X_("last-custom-meter-was-at-end"))) != 0) {
2133 _last_custom_meter_was_at_end = string_is_affirmative (prop->value ());
2136 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2139 if (child->name() == X_("Comment")) {
2141 /* XXX this is a terrible API design in libxml++ */
2143 XMLNode *cmt = *(child->children().begin());
2144 _comment = cmt->content();
2146 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2147 if (prop->value() == "solo") {
2148 _solo_control->set_state (*child, version);
2149 } else if (prop->value() == "mute") {
2150 _mute_control->set_state (*child, version);
2153 } else if (child->name() == X_("RemoteControl")) {
2154 if ((prop = child->property (X_("id"))) != 0) {
2156 sscanf (prop->value().c_str(), "%d", &x);
2157 set_remote_control_id_internal (x);
2160 } else if (child->name() == X_("MuteMaster")) {
2161 _mute_master->set_state (*child, version);
2169 Route::set_state_2X (const XMLNode& node, int version)
2172 XMLNodeConstIterator niter;
2174 const XMLProperty *prop;
2176 /* 2X things which still remain to be handled:
2182 if (node.name() != "Route") {
2183 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2187 if ((prop = node.property (X_("flags"))) != 0) {
2188 string f = prop->value ();
2189 boost::replace_all (f, "ControlOut", "MonitorOut");
2190 _flags = Flag (string_2_enum (f, _flags));
2195 if (is_master() || is_monitor() || is_auditioner()) {
2196 _mute_master->set_solo_ignore (true);
2199 if ((prop = node.property (X_("phase-invert"))) != 0) {
2200 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2201 if (string_is_affirmative (prop->value ())) {
2204 set_phase_invert (p);
2207 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2208 set_denormal_protection (string_is_affirmative (prop->value()));
2211 if ((prop = node.property (X_("soloed"))) != 0) {
2212 bool yn = string_is_affirmative (prop->value());
2214 /* XXX force reset of solo status */
2216 set_solo (yn, this);
2219 if ((prop = node.property (X_("muted"))) != 0) {
2222 bool muted = string_is_affirmative (prop->value());
2228 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2230 if (string_is_affirmative (prop->value())){
2231 mute_point = mute_point + "PreFader";
2236 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2238 if (string_is_affirmative (prop->value())){
2241 mute_point = mute_point + ",";
2244 mute_point = mute_point + "PostFader";
2249 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2251 if (string_is_affirmative (prop->value())){
2254 mute_point = mute_point + ",";
2257 mute_point = mute_point + "Listen";
2262 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2264 if (string_is_affirmative (prop->value())){
2267 mute_point = mute_point + ",";
2270 mute_point = mute_point + "Main";
2274 _mute_master->set_mute_points (mute_point);
2275 _mute_master->set_muted_by_self (true);
2279 if ((prop = node.property (X_("meter-point"))) != 0) {
2280 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2283 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2284 don't mean the same thing.
2287 if ((prop = node.property (X_("order-keys"))) != 0) {
2291 string::size_type colon, equal;
2292 string remaining = prop->value();
2294 while (remaining.length()) {
2296 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2297 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2300 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2301 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2304 string keyname = remaining.substr (0, equal);
2306 if (keyname == "EditorSort" || keyname == "editor") {
2307 info << string_compose(_("Converting deprecated order key for %1 using Editor order %2"), name (), n) << endmsg;
2313 colon = remaining.find_first_of (':');
2315 if (colon != string::npos) {
2316 remaining = remaining.substr (colon+1);
2325 nlist = node.children ();
2326 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2330 if (child->name() == IO::state_node_name) {
2332 /* there is a note in IO::set_state_2X() about why we have to call
2336 _input->set_state_2X (*child, version, true);
2337 _output->set_state_2X (*child, version, false);
2339 if ((prop = child->property (X_("name"))) != 0) {
2340 Route::set_name (prop->value ());
2345 if ((prop = child->property (X_("active"))) != 0) {
2346 bool yn = string_is_affirmative (prop->value());
2347 _active = !yn; // force switch
2348 set_active (yn, this);
2351 if ((prop = child->property (X_("gain"))) != 0) {
2354 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2355 _amp->gain_control()->set_value (val);
2359 /* Set up Panners in the IO */
2360 XMLNodeList io_nlist = child->children ();
2362 XMLNodeConstIterator io_niter;
2365 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2367 io_child = *io_niter;
2369 if (io_child->name() == X_("Panner")) {
2370 _main_outs->panner_shell()->set_state(*io_child, version);
2371 } else if (io_child->name() == X_("Automation")) {
2372 /* IO's automation is for the fader */
2373 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2379 XMLNodeList redirect_nodes;
2381 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2385 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2386 redirect_nodes.push_back(child);
2391 set_processor_state_2X (redirect_nodes, version);
2393 Stateful::save_extra_xml (node);
2395 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2398 if (child->name() == X_("Comment")) {
2400 /* XXX this is a terrible API design in libxml++ */
2402 XMLNode *cmt = *(child->children().begin());
2403 _comment = cmt->content();
2405 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2406 if (prop->value() == X_("solo")) {
2407 _solo_control->set_state (*child, version);
2408 } else if (prop->value() == X_("mute")) {
2409 _mute_control->set_state (*child, version);
2412 } else if (child->name() == X_("RemoteControl")) {
2413 if ((prop = child->property (X_("id"))) != 0) {
2415 sscanf (prop->value().c_str(), "%d", &x);
2416 set_remote_control_id_internal (x);
2426 Route::get_processor_state ()
2428 XMLNode* root = new XMLNode (X_("redirects"));
2429 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2430 root->add_child_nocopy ((*i)->state (true));
2437 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2439 /* We don't bother removing existing processors not in nList, as this
2440 method will only be called when creating a Route from scratch, not
2441 for undo purposes. Just put processors in at the appropriate place
2445 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2446 add_processor_from_xml_2X (**i, version);
2451 Route::set_processor_state (const XMLNode& node)
2453 const XMLNodeList &nlist = node.children();
2454 XMLNodeConstIterator niter;
2455 ProcessorList new_order;
2456 bool must_configure = false;
2458 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2460 XMLProperty* prop = (*niter)->property ("type");
2462 if (prop->value() == "amp") {
2463 _amp->set_state (**niter, Stateful::current_state_version);
2464 new_order.push_back (_amp);
2465 } else if (prop->value() == "meter") {
2466 _meter->set_state (**niter, Stateful::current_state_version);
2467 new_order.push_back (_meter);
2468 } else if (prop->value() == "main-outs") {
2469 _main_outs->set_state (**niter, Stateful::current_state_version);
2470 } else if (prop->value() == "intreturn") {
2472 _intreturn.reset (new InternalReturn (_session));
2473 must_configure = true;
2475 _intreturn->set_state (**niter, Stateful::current_state_version);
2476 } else if (is_monitor() && prop->value() == "monitor") {
2477 if (!_monitor_control) {
2478 _monitor_control.reset (new MonitorProcessor (_session));
2479 must_configure = true;
2481 _monitor_control->set_state (**niter, Stateful::current_state_version);
2482 } else if (prop->value() == "capture") {
2483 /* CapturingProcessor should never be restored, it's always
2484 added explicitly when needed */
2486 ProcessorList::iterator o;
2488 for (o = _processors.begin(); o != _processors.end(); ++o) {
2489 XMLProperty* id_prop = (*niter)->property(X_("id"));
2490 if (id_prop && (*o)->id() == id_prop->value()) {
2491 (*o)->set_state (**niter, Stateful::current_state_version);
2492 new_order.push_back (*o);
2497 // If the processor (*niter) is not on the route then create it
2499 if (o == _processors.end()) {
2501 boost::shared_ptr<Processor> processor;
2503 if (prop->value() == "intsend") {
2505 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Aux, true));
2507 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2508 prop->value() == "lv2" ||
2509 prop->value() == "windows-vst" ||
2510 prop->value() == "lxvst" ||
2511 prop->value() == "audiounit") {
2513 processor.reset (new PluginInsert(_session));
2515 } else if (prop->value() == "port") {
2517 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2519 } else if (prop->value() == "send") {
2521 processor.reset (new Send (_session, _pannable, _mute_master, Delivery::Send, true));
2524 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2528 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2529 /* This processor could not be configured. Turn it into a UnknownProcessor */
2530 processor.reset (new UnknownProcessor (_session, **niter));
2533 /* we have to note the monitor send here, otherwise a new one will be created
2534 and the state of this one will be lost.
2536 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2537 if (isend && isend->role() == Delivery::Listen) {
2538 _monitor_send = isend;
2541 /* it doesn't matter if invisible processors are added here, as they
2542 will be sorted out by setup_invisible_processors () shortly.
2545 new_order.push_back (processor);
2546 must_configure = true;
2552 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
2553 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2554 _processors = new_order;
2556 if (must_configure) {
2557 configure_processors_unlocked (0);
2560 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2562 (*i)->set_owner (this);
2563 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2565 boost::shared_ptr<PluginInsert> pi;
2567 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2568 if (pi->has_no_inputs ()) {
2569 _have_internal_generator = true;
2576 reset_instrument_info ();
2577 processors_changed (RouteProcessorChange ());
2578 set_processor_positions ();
2582 Route::curve_reallocate ()
2584 // _gain_automation_curve.finish_resize ();
2585 // _pan_automation_curve.finish_resize ();
2589 Route::silence (framecnt_t nframes)
2591 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2596 silence_unlocked (nframes);
2600 Route::silence_unlocked (framecnt_t nframes)
2602 /* Must be called with the processor lock held */
2606 _output->silence (nframes);
2608 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2609 boost::shared_ptr<PluginInsert> pi;
2611 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2612 // skip plugins, they don't need anything when we're not active
2616 (*i)->silence (nframes);
2619 if (nframes == _session.get_block_size()) {
2626 Route::add_internal_return ()
2629 _intreturn.reset (new InternalReturn (_session));
2630 add_processor (_intreturn, PreFader);
2635 Route::add_send_to_internal_return (InternalSend* send)
2637 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2639 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2640 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2643 return d->add_send (send);
2649 Route::remove_send_from_internal_return (InternalSend* send)
2651 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2653 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2654 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2657 return d->remove_send (send);
2663 Route::enable_monitor_send ()
2665 /* Caller must hold process lock */
2666 assert (!AudioEngine::instance()->process_lock().trylock());
2668 /* master never sends to monitor section via the normal mechanism */
2669 assert (!is_master ());
2670 assert (!is_monitor ());
2672 /* make sure we have one */
2673 if (!_monitor_send) {
2674 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2675 _monitor_send->set_display_to_user (false);
2679 configure_processors (0);
2682 /** Add an aux send to a route.
2683 * @param route route to send to.
2684 * @param before Processor to insert before, or 0 to insert at the end.
2687 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2689 assert (route != _session.monitor_out ());
2692 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2694 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2696 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2698 if (d && d->target_route() == route) {
2699 /* already listening via the specified IO: do nothing */
2707 boost::shared_ptr<InternalSend> listener;
2710 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2711 boost::shared_ptr<Pannable> sendpan (new Pannable (_session));
2712 listener.reset (new InternalSend (_session, sendpan, _mute_master, route, Delivery::Aux));
2715 add_processor (listener, before);
2717 } catch (failed_constructor& err) {
2725 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
2727 ProcessorStreams err;
2728 ProcessorList::iterator tmp;
2731 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
2733 /* have to do this early because otherwise processor reconfig
2734 * will put _monitor_send back in the list
2737 if (route == _session.monitor_out()) {
2738 _monitor_send.reset ();
2742 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2744 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2746 if (d && d->target_route() == route) {
2748 remove_processor (*x, &err, false);
2751 /* list could have been demolished while we dropped the lock
2762 Route::set_comment (string cmt, void *src)
2765 comment_changed (src);
2766 _session.set_dirty ();
2770 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2772 FeedRecord fr (other, via_sends_only);
2774 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2776 if (!result.second) {
2778 /* already a record for "other" - make sure sends-only information is correct */
2779 if (!via_sends_only && result.first->sends_only) {
2780 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2781 frp->sends_only = false;
2785 return result.second;
2789 Route::clear_fed_by ()
2795 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2797 const FedBy& fed_by (other->fed_by());
2799 for (FedBy::const_iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2800 boost::shared_ptr<Route> sr = f->r.lock();
2802 if (sr && (sr.get() == this)) {
2804 if (via_sends_only) {
2805 *via_sends_only = f->sends_only;
2816 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
2818 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2820 if (_output->connected_to (other->input())) {
2821 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2822 if (via_send_only) {
2823 *via_send_only = false;
2830 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2832 boost::shared_ptr<IOProcessor> iop;
2834 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2835 if (iop->feeds (other)) {
2836 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2837 if (via_send_only) {
2838 *via_send_only = true;
2842 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2845 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2850 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2855 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
2857 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
2860 /** Called from the (non-realtime) butler thread when the transport is stopped */
2862 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
2864 framepos_t now = _session.transport_frame();
2867 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2869 Automatable::transport_stopped (now);
2871 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2873 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2877 (*i)->transport_stopped (now);
2881 _roll_delay = _initial_delay;
2885 Route::input_change_handler (IOChange change, void * /*src*/)
2887 bool need_to_queue_solo_change = true;
2889 if ((change.type & IOChange::ConfigurationChanged)) {
2890 /* This is called with the process lock held if change
2891 contains ConfigurationChanged
2893 need_to_queue_solo_change = false;
2894 configure_processors (0);
2895 _phase_invert.resize (_input->n_ports().n_audio ());
2896 io_changed (); /* EMIT SIGNAL */
2899 if (!_input->connected() && _soloed_by_others_upstream) {
2900 if (need_to_queue_solo_change) {
2901 _session.cancel_solo_after_disconnect (shared_from_this(), true);
2903 cancel_solo_after_disconnect (true);
2909 Route::output_change_handler (IOChange change, void * /*src*/)
2911 bool need_to_queue_solo_change = true;
2912 if (_initial_io_setup) {
2916 if ((change.type & IOChange::ConfigurationChanged)) {
2917 /* This is called with the process lock held if change
2918 contains ConfigurationChanged
2920 need_to_queue_solo_change = false;
2921 configure_processors (0);
2922 io_changed (); /* EMIT SIGNAL */
2925 if (!_output->connected() && _soloed_by_others_downstream) {
2926 if (need_to_queue_solo_change) {
2927 _session.cancel_solo_after_disconnect (shared_from_this(), false);
2929 cancel_solo_after_disconnect (false);
2935 Route::cancel_solo_after_disconnect (bool upstream)
2938 _soloed_by_others_upstream = 0;
2940 _soloed_by_others_downstream = 0;
2942 set_mute_master_solo ();
2943 solo_changed (false, this);
2947 Route::pans_required () const
2949 if (n_outputs().n_audio() < 2) {
2953 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
2957 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
2959 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2965 if (n_outputs().n_total() == 0) {
2969 if (!_active || n_inputs() == ChanCount::ZERO) {
2970 silence_unlocked (nframes);
2974 if (session_state_changing) {
2975 if (_session.transport_speed() != 0.0f) {
2976 /* we're rolling but some state is changing (e.g. our diskstream contents)
2977 so we cannot use them. Be silent till this is over.
2979 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
2981 silence_unlocked (nframes);
2984 /* we're really not rolling, so we're either delivery silence or actually
2985 monitoring, both of which are safe to do while session_state_changing is true.
2989 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
2991 fill_buffers_with_input (bufs, _input, nframes);
2993 if (_meter_point == MeterInput) {
2994 _meter->run (bufs, start_frame, end_frame, nframes, true);
2997 _amp->apply_gain_automation (false);
2998 passthru (bufs, start_frame, end_frame, nframes, 0);
3004 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3006 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3011 if (n_outputs().n_total() == 0) {
3015 if (!_active || n_inputs().n_total() == 0) {
3016 silence_unlocked (nframes);
3020 framepos_t unused = 0;
3022 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3028 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3030 fill_buffers_with_input (bufs, _input, nframes);
3032 if (_meter_point == MeterInput) {
3033 _meter->run (bufs, start_frame, end_frame, nframes, true);
3036 passthru (bufs, start_frame, end_frame, nframes, declick);
3042 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3049 Route::flush_processors ()
3051 /* XXX shouldn't really try to take this lock, since
3052 this is called from the RT audio thread.
3055 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3057 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3063 Route::set_meter_point (MeterPoint p, bool force)
3065 if (_meter_point == p && !force) {
3069 bool meter_was_visible_to_user = _meter->display_to_user ();
3072 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3074 maybe_note_meter_position ();
3078 if (_meter_point != MeterCustom) {
3080 _meter->set_display_to_user (false);
3082 setup_invisible_processors ();
3086 _meter->set_display_to_user (true);
3088 /* If we have a previous position for the custom meter, try to put it there */
3089 if (_custom_meter_position_noted) {
3090 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3093 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3094 if (i != _processors.end ()) {
3095 _processors.remove (_meter);
3096 _processors.insert (i, _meter);
3098 } else if (_last_custom_meter_was_at_end) {
3099 _processors.remove (_meter);
3100 _processors.push_back (_meter);
3105 /* Set up the meter for its new position */
3107 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3111 if (loc == _processors.begin()) {
3112 m_in = _input->n_ports();
3114 ProcessorList::iterator before = loc;
3116 m_in = (*before)->output_streams ();
3119 _meter->reflect_inputs (m_in);
3121 /* we do not need to reconfigure the processors, because the meter
3122 (a) is always ready to handle processor_max_streams
3123 (b) is always an N-in/N-out processor, and thus moving
3124 it doesn't require any changes to the other processors.
3128 meter_change (); /* EMIT SIGNAL */
3130 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
3132 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
3136 Route::listen_position_changed ()
3139 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
3140 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3141 ProcessorState pstate (this);
3143 if (configure_processors_unlocked (0)) {
3145 configure_processors_unlocked (0); // it worked before we tried to add it ...
3150 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3151 _session.set_dirty ();
3154 boost::shared_ptr<CapturingProcessor>
3155 Route::add_export_point()
3157 if (!_capturing_processor) {
3159 _capturing_processor.reset (new CapturingProcessor (_session));
3160 _capturing_processor->activate ();
3162 configure_processors (0);
3166 return _capturing_processor;
3170 Route::update_signal_latency ()
3172 framecnt_t l = _output->user_latency();
3174 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3175 if ((*i)->active ()) {
3176 l += (*i)->signal_latency ();
3180 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3182 if (_signal_latency != l) {
3183 _signal_latency = l;
3184 signal_latency_changed (); /* EMIT SIGNAL */
3187 return _signal_latency;
3191 Route::set_user_latency (framecnt_t nframes)
3193 _output->set_user_latency (nframes);
3194 _session.update_latency_compensation ();
3198 Route::set_latency_compensation (framecnt_t longest_session_latency)
3200 framecnt_t old = _initial_delay;
3202 if (_signal_latency < longest_session_latency) {
3203 _initial_delay = longest_session_latency - _signal_latency;
3208 DEBUG_TRACE (DEBUG::Latency, string_compose (
3209 "%1: compensate for maximum latency of %2,"
3210 "given own latency of %3, using initial delay of %4\n",
3211 name(), longest_session_latency, _signal_latency, _initial_delay));
3213 if (_initial_delay != old) {
3214 initial_delay_changed (); /* EMIT SIGNAL */
3217 if (_session.transport_stopped()) {
3218 _roll_delay = _initial_delay;
3222 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3223 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3224 boost::shared_ptr<AutomationList>(), name)
3227 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3232 Route::SoloControllable::set_value (double val)
3234 bool bval = ((val >= 0.5f) ? true: false);
3236 boost::shared_ptr<RouteList> rl (new RouteList);
3238 boost::shared_ptr<Route> r = _route.lock ();
3245 if (Config->get_solo_control_is_listen_control()) {
3246 _session.set_listen (rl, bval);
3248 _session.set_solo (rl, bval);
3253 Route::SoloControllable::get_value () const
3255 boost::shared_ptr<Route> r = _route.lock ();
3260 if (Config->get_solo_control_is_listen_control()) {
3261 return r->listening_via_monitor() ? 1.0f : 0.0f;
3263 return r->self_soloed() ? 1.0f : 0.0f;
3267 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3268 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3269 boost::shared_ptr<AutomationList>(), name)
3272 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3277 Route::MuteControllable::set_value (double val)
3279 bool bval = ((val >= 0.5f) ? true: false);
3281 boost::shared_ptr<RouteList> rl (new RouteList);
3283 boost::shared_ptr<Route> r = _route.lock ();
3289 _session.set_mute (rl, bval);
3293 Route::MuteControllable::get_value () const
3295 boost::shared_ptr<Route> r = _route.lock ();
3300 return r->muted() ? 1.0f : 0.0f;
3304 Route::set_block_size (pframes_t nframes)
3306 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3307 (*i)->set_block_size (nframes);
3310 _session.ensure_buffers (n_process_buffers ());
3314 Route::protect_automation ()
3316 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3317 (*i)->protect_automation();
3320 /** @param declick 1 to set a pending declick fade-in,
3321 * -1 to set a pending declick fade-out
3324 Route::set_pending_declick (int declick)
3327 /* this call is not allowed to turn off a pending declick */
3329 _pending_declick = declick;
3332 _pending_declick = 0;
3336 /** Shift automation forwards from a particular place, thereby inserting time.
3337 * Adds undo commands for any shifts that are performed.
3339 * @param pos Position to start shifting from.
3340 * @param frames Amount to shift forwards by.
3344 Route::shift (framepos_t pos, framecnt_t frames)
3346 /* gain automation */
3348 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3350 XMLNode &before = gc->alist()->get_state ();
3351 gc->alist()->shift (pos, frames);
3352 XMLNode &after = gc->alist()->get_state ();
3353 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3356 /* pan automation */
3358 ControlSet::Controls& c (_pannable->controls());
3360 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3361 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3363 boost::shared_ptr<AutomationList> al = pc->alist();
3364 XMLNode& before = al->get_state ();
3365 al->shift (pos, frames);
3366 XMLNode& after = al->get_state ();
3367 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3372 /* redirect automation */
3374 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3375 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3377 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3379 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3380 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3382 boost::shared_ptr<AutomationList> al = ac->alist();
3383 XMLNode &before = al->get_state ();
3384 al->shift (pos, frames);
3385 XMLNode &after = al->get_state ();
3386 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3395 Route::save_as_template (const string& path, const string& name)
3397 XMLNode& node (state (false));
3400 IO::set_name_in_state (*node.children().front(), name);
3402 tree.set_root (&node);
3403 return tree.write (path.c_str());
3408 Route::set_name (const string& str)
3414 name = Route::ensure_track_or_route_name (str, _session);
3415 SessionObject::set_name (name);
3417 ret = (_input->set_name(name) && _output->set_name(name));
3420 /* rename the main outs. Leave other IO processors
3421 * with whatever name they already have, because its
3422 * just fine as it is (it will not contain the route
3423 * name if its a port insert, port send or port return).
3427 if (_main_outs->set_name (name)) {
3428 /* XXX returning false here is stupid because
3429 we already changed the route name.
3439 /** Set the name of a route in an XML description.
3440 * @param node XML <Route> node to set the name in.
3441 * @param name New name.
3444 Route::set_name_in_state (XMLNode& node, string const & name)
3446 node.add_property (X_("name"), name);
3448 XMLNodeList children = node.children();
3449 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3451 if ((*i)->name() == X_("IO")) {
3453 IO::set_name_in_state (**i, name);
3455 } else if ((*i)->name() == X_("Processor")) {
3457 XMLProperty* role = (*i)->property (X_("role"));
3458 if (role && role->value() == X_("Main")) {
3459 (*i)->add_property (X_("name"), name);
3462 } else if ((*i)->name() == X_("Diskstream")) {
3464 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3465 (*i)->add_property (X_("name"), name);
3471 boost::shared_ptr<Send>
3472 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3474 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3476 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3477 boost::shared_ptr<InternalSend> send;
3479 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3480 if (send->target_route() == target) {
3486 return boost::shared_ptr<Send>();
3489 /** @param c Audio channel index.
3490 * @param yn true to invert phase, otherwise false.
3493 Route::set_phase_invert (uint32_t c, bool yn)
3495 if (_phase_invert[c] != yn) {
3496 _phase_invert[c] = yn;
3497 phase_invert_changed (); /* EMIT SIGNAL */
3498 _session.set_dirty ();
3503 Route::set_phase_invert (boost::dynamic_bitset<> p)
3505 if (_phase_invert != p) {
3507 phase_invert_changed (); /* EMIT SIGNAL */
3508 _session.set_dirty ();
3513 Route::phase_invert (uint32_t c) const
3515 return _phase_invert[c];
3518 boost::dynamic_bitset<>
3519 Route::phase_invert () const
3521 return _phase_invert;
3525 Route::set_denormal_protection (bool yn)
3527 if (_denormal_protection != yn) {
3528 _denormal_protection = yn;
3529 denormal_protection_changed (); /* EMIT SIGNAL */
3534 Route::denormal_protection () const
3536 return _denormal_protection;
3540 Route::set_active (bool yn, void* src)
3542 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3543 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3547 if (_active != yn) {
3549 _input->set_active (yn);
3550 _output->set_active (yn);
3551 active_changed (); // EMIT SIGNAL
3552 _session.set_dirty ();
3559 Glib::Threads::RWLock::ReaderLock rm (_processor_lock, Glib::Threads::TRY_LOCK);
3565 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3567 boost::shared_ptr<Send> s;
3568 boost::shared_ptr<Return> r;
3570 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3571 s->meter()->meter();
3572 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3573 r->meter()->meter ();
3578 boost::shared_ptr<Pannable>
3579 Route::pannable() const
3584 boost::shared_ptr<Panner>
3585 Route::panner() const
3588 return _main_outs->panner_shell()->panner();
3591 boost::shared_ptr<PannerShell>
3592 Route::panner_shell() const
3594 return _main_outs->panner_shell();
3597 boost::shared_ptr<AutomationControl>
3598 Route::gain_control() const
3600 return _amp->gain_control();
3603 boost::shared_ptr<AutomationControl>
3604 Route::get_control (const Evoral::Parameter& param)
3606 /* either we own the control or .... */
3608 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3612 /* maybe one of our processors does or ... */
3614 Glib::Threads::RWLock::ReaderLock rm (_processor_lock, Glib::Threads::TRY_LOCK);
3615 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3616 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3624 /* nobody does so we'll make a new one */
3626 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3633 boost::shared_ptr<Processor>
3634 Route::nth_plugin (uint32_t n)
3636 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3637 ProcessorList::iterator i;
3639 for (i = _processors.begin(); i != _processors.end(); ++i) {
3640 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3647 return boost::shared_ptr<Processor> ();
3650 boost::shared_ptr<Processor>
3651 Route::nth_send (uint32_t n)
3653 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3654 ProcessorList::iterator i;
3656 for (i = _processors.begin(); i != _processors.end(); ++i) {
3657 if (boost::dynamic_pointer_cast<Send> (*i)) {
3664 return boost::shared_ptr<Processor> ();
3668 Route::has_io_processor_named (const string& name)
3670 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3671 ProcessorList::iterator i;
3673 for (i = _processors.begin(); i != _processors.end(); ++i) {
3674 if (boost::dynamic_pointer_cast<Send> (*i) ||
3675 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3676 if ((*i)->name() == name) {
3685 MuteMaster::MutePoint
3686 Route::mute_points () const
3688 return _mute_master->mute_points ();
3692 Route::set_processor_positions ()
3694 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3696 bool had_amp = false;
3697 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3698 (*i)->set_pre_fader (!had_amp);
3699 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3705 /** Called when there is a proposed change to the input port count */
3707 Route::input_port_count_changing (ChanCount to)
3709 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3711 /* The processors cannot be configured with the new input arrangement, so
3717 /* The change is ok */
3721 /** Called when there is a proposed change to the output port count */
3723 Route::output_port_count_changing (ChanCount to)
3725 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
3726 if (processor_out_streams.get(*t) > to.get(*t)) {
3730 /* The change is ok */
3735 Route::unknown_processors () const
3739 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3740 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3741 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3742 p.push_back ((*i)->name ());
3751 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3753 /* we assume that all our input ports feed all our output ports. its not
3754 universally true, but the alternative is way too corner-case to worry about.
3757 LatencyRange all_connections;
3760 all_connections.min = 0;
3761 all_connections.max = 0;
3763 all_connections.min = ~((pframes_t) 0);
3764 all_connections.max = 0;
3766 /* iterate over all "from" ports and determine the latency range for all of their
3767 connections to the "outside" (outside of this Route).
3770 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3774 p->get_connected_latency_range (range, playback);
3776 all_connections.min = min (all_connections.min, range.min);
3777 all_connections.max = max (all_connections.max, range.max);
3781 /* set the "from" port latencies to the max/min range of all their connections */
3783 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3784 p->set_private_latency_range (all_connections, playback);
3787 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3789 all_connections.min += our_latency;
3790 all_connections.max += our_latency;
3792 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3793 p->set_private_latency_range (all_connections, playback);
3796 return all_connections.max;
3800 Route::set_private_port_latencies (bool playback) const
3802 framecnt_t own_latency = 0;
3804 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3805 OR LATENCY CALLBACK.
3807 This is called (early) from the latency callback. It computes the REAL
3808 latency associated with each port and stores the result as the "private"
3809 latency of the port. A later call to Route::set_public_port_latencies()
3810 sets all ports to the same value to reflect the fact that we do latency
3811 compensation and so all signals are delayed by the same amount as they
3812 flow through ardour.
3815 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3816 if ((*i)->active ()) {
3817 own_latency += (*i)->signal_latency ();
3822 /* playback: propagate latency from "outside the route" to outputs to inputs */
3823 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3825 /* capture: propagate latency from "outside the route" to inputs to outputs */
3826 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3831 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3833 /* this is called to set the JACK-visible port latencies, which take
3834 latency compensation into account.
3843 const PortSet& ports (_input->ports());
3844 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3845 p->set_public_latency_range (range, playback);
3850 const PortSet& ports (_output->ports());
3851 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3852 p->set_public_latency_range (range, playback);
3857 /** Put the invisible processors in the right place in _processors.
3858 * Must be called with a writer lock on _processor_lock held.
3861 Route::setup_invisible_processors ()
3864 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3865 assert (!lm.locked ());
3869 /* too early to be doing this stuff */
3873 /* we'll build this new list here and then use it */
3875 ProcessorList new_processors;
3877 /* find visible processors */
3879 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3880 if ((*i)->display_to_user ()) {
3881 new_processors.push_back (*i);
3887 ProcessorList::iterator amp = new_processors.begin ();
3888 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3892 assert (amp != _processors.end ());
3894 /* and the processor after the amp */
3896 ProcessorList::iterator after_amp = amp;
3902 switch (_meter_point) {
3904 assert (!_meter->display_to_user ());
3905 new_processors.push_front (_meter);
3908 assert (!_meter->display_to_user ());
3909 new_processors.insert (amp, _meter);
3911 case MeterPostFader:
3912 /* do nothing here */
3915 /* do nothing here */
3918 /* the meter is visible, so we don't touch it here */
3925 assert (_main_outs);
3926 assert (!_main_outs->display_to_user ());
3927 new_processors.push_back (_main_outs);
3929 /* iterator for the main outs */
3931 ProcessorList::iterator main = new_processors.end();
3934 /* OUTPUT METERING */
3936 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3937 assert (!_meter->display_to_user ());
3939 /* add the processor just before or just after the main outs */
3941 ProcessorList::iterator meter_point = main;
3943 if (_meter_point == MeterOutput) {
3946 new_processors.insert (meter_point, _meter);
3951 if (_monitor_send && !is_monitor ()) {
3952 assert (!_monitor_send->display_to_user ());
3953 if (Config->get_solo_control_is_listen_control()) {
3954 switch (Config->get_listen_position ()) {
3955 case PreFaderListen:
3956 switch (Config->get_pfl_position ()) {
3957 case PFLFromBeforeProcessors:
3958 new_processors.push_front (_monitor_send);
3960 case PFLFromAfterProcessors:
3961 new_processors.insert (amp, _monitor_send);
3964 _monitor_send->set_can_pan (false);
3966 case AfterFaderListen:
3967 switch (Config->get_afl_position ()) {
3968 case AFLFromBeforeProcessors:
3969 new_processors.insert (after_amp, _monitor_send);
3971 case AFLFromAfterProcessors:
3972 new_processors.insert (new_processors.end(), _monitor_send);
3975 _monitor_send->set_can_pan (true);
3979 new_processors.insert (new_processors.end(), _monitor_send);
3980 _monitor_send->set_can_pan (false);
3984 /* MONITOR CONTROL */
3986 if (_monitor_control && is_monitor ()) {
3987 assert (!_monitor_control->display_to_user ());
3988 new_processors.push_front (_monitor_control);
3991 /* INTERNAL RETURN */
3993 /* doing this here means that any monitor control will come just after
3998 assert (!_intreturn->display_to_user ());
3999 new_processors.push_front (_intreturn);
4002 /* EXPORT PROCESSOR */
4004 if (_capturing_processor) {
4005 assert (!_capturing_processor->display_to_user ());
4006 new_processors.push_front (_capturing_processor);
4009 _processors = new_processors;
4011 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4012 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4013 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4020 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4021 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4025 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4026 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4033 /** If the meter point is `Custom', make a note of where the meter is.
4034 * This is so that if the meter point is subsequently set to something else,
4035 * and then back to custom, we can put the meter back where it was last time
4036 * custom was enabled.
4038 * Must be called with the _processor_lock held.
4041 Route::maybe_note_meter_position ()
4043 if (_meter_point != MeterCustom) {
4047 _custom_meter_position_noted = true;
4048 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4049 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4050 ProcessorList::iterator j = i;
4052 if (j != _processors.end ()) {
4053 _processor_after_last_custom_meter = *j;
4054 _last_custom_meter_was_at_end = false;
4056 _last_custom_meter_was_at_end = true;
4062 boost::shared_ptr<Processor>
4063 Route::processor_by_id (PBD::ID id) const
4065 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4066 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4067 if ((*i)->id() == id) {
4072 return boost::shared_ptr<Processor> ();
4075 /** @return the monitoring state, or in other words what data we are pushing
4076 * into the route (data from the inputs, data from disk or silence)
4079 Route::monitoring_state () const
4081 return MonitoringInput;
4084 /** @return what we should be metering; either the data coming from the input
4085 * IO or the data that is flowing through the route.
4088 Route::metering_state () const
4090 return MeteringRoute;
4094 Route::has_external_redirects () const
4096 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4098 /* ignore inactive processors and obviously ignore the main
4099 * outs since everything has them and we don't care.
4102 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4110 boost::shared_ptr<Processor>
4111 Route::the_instrument () const
4113 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4114 return the_instrument_unlocked ();
4117 boost::shared_ptr<Processor>
4118 Route::the_instrument_unlocked () const
4120 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4121 if (boost::dynamic_pointer_cast<PluginInsert>(*i)) {
4122 if ((*i)->input_streams().n_midi() > 0 &&
4123 (*i)->output_streams().n_audio() > 0) {
4128 return boost::shared_ptr<Processor>();
4134 Route::non_realtime_locate (framepos_t pos)
4137 _pannable->transport_located (pos);
4141 //Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
4142 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
4144 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4145 (*i)->transport_located (pos);
4151 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4158 * We don't currently mix MIDI input together, so we don't need the
4159 * complex logic of the audio case.
4162 n_buffers = bufs.count().n_midi ();
4164 for (i = 0; i < n_buffers; ++i) {
4166 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4167 MidiBuffer& buf (bufs.get_midi (i));
4170 buf.copy (source_port->get_midi_buffer(nframes));
4172 buf.silence (nframes);
4178 n_buffers = bufs.count().n_audio();
4180 size_t n_ports = io->n_ports().n_audio();
4181 float scaling = 1.0f;
4183 if (n_ports > n_buffers) {
4184 scaling = ((float) n_buffers) / n_ports;
4187 for (i = 0; i < n_ports; ++i) {
4189 /* if there are more ports than buffers, map them onto buffers
4190 * in a round-robin fashion
4193 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4194 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4197 if (i < n_buffers) {
4199 /* first time through just copy a channel into
4203 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4205 if (scaling != 1.0f) {
4206 buf.apply_gain (scaling, nframes);
4211 /* on subsequent times around, merge data from
4212 * the port with what is already there
4215 if (scaling != 1.0f) {
4216 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4218 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4223 /* silence any remaining buffers */
4225 for (; i < n_buffers; ++i) {
4226 AudioBuffer& buf (bufs.get_audio (i));
4227 buf.silence (nframes);
4230 /* establish the initial setup of the buffer set, reflecting what was
4231 copied into it. unless, of course, we are the auditioner, in which
4232 case nothing was fed into it from the inputs at all.
4235 if (!is_auditioner()) {
4236 bufs.set_count (io->n_ports());