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_shell.h"
55 #include "ardour/plugin_insert.h"
56 #include "ardour/port.h"
57 #include "ardour/port_insert.h"
58 #include "ardour/processor.h"
59 #include "ardour/route.h"
60 #include "ardour/route_group.h"
61 #include "ardour/send.h"
62 #include "ardour/session.h"
63 #include "ardour/unknown_processor.h"
64 #include "ardour/utils.h"
69 using namespace ARDOUR;
72 PBD::Signal1<void,RouteSortOrderKey> Route::SyncOrderKeys;
73 PBD::Signal0<void> Route::RemoteControlIDChange;
75 Route::Route (Session& sess, string name, Flag flg, DataType default_type)
76 : SessionObject (sess, name)
78 , GraphNode (sess._process_graph)
84 , _pending_declick (true)
85 , _meter_point (MeterPostFader)
86 , _meter_type (MeterPeak)
88 , _soloed_by_others_upstream (0)
89 , _soloed_by_others_downstream (0)
91 , _denormal_protection (false)
94 , _declickable (false)
95 , _mute_master (new MuteMaster (sess, name))
96 , _have_internal_generator (false)
98 , _default_type (default_type)
99 , _remote_control_id (0)
100 , _in_configure_processors (false)
101 , _initial_io_setup (false)
102 , _custom_meter_position_noted (false)
103 , _last_custom_meter_was_at_end (false)
106 _meter_type = MeterK20;
108 processor_max_streams.reset();
114 /* add standard controls */
116 _solo_control.reset (new SoloControllable (X_("solo"), shared_from_this ()));
117 _mute_control.reset (new MuteControllable (X_("mute"), shared_from_this ()));
119 _solo_control->set_flags (Controllable::Flag (_solo_control->flags() | Controllable::Toggle));
120 _mute_control->set_flags (Controllable::Flag (_mute_control->flags() | Controllable::Toggle));
122 add_control (_solo_control);
123 add_control (_mute_control);
127 if (!(_flags & Route::MonitorOut)) {
128 _pannable.reset (new Pannable (_session));
131 /* input and output objects */
133 _input.reset (new IO (_session, _name, IO::Input, _default_type));
134 _output.reset (new IO (_session, _name, IO::Output, _default_type));
136 _input->changed.connect_same_thread (*this, boost::bind (&Route::input_change_handler, this, _1, _2));
137 _input->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::input_port_count_changing, this, _1));
139 _output->changed.connect_same_thread (*this, boost::bind (&Route::output_change_handler, this, _1, _2));
140 _output->PortCountChanging.connect_same_thread (*this, boost::bind (&Route::output_port_count_changing, this, _1));
142 /* add amp processor */
144 _amp.reset (new Amp (_session));
145 add_processor (_amp, PostFader);
147 /* create standard processors: meter, main outs, monitor out;
148 they will be added to _processors by setup_invisible_processors ()
151 _meter.reset (new PeakMeter (_session, _name));
152 _meter->set_display_to_user (false);
155 _main_outs.reset (new Delivery (_session, _output, _pannable, _mute_master, _name, Delivery::Main));
156 _main_outs->activate ();
159 /* where we listen to tracks */
160 _intreturn.reset (new InternalReturn (_session));
161 _intreturn->activate ();
163 /* the thing that provides proper control over a control/monitor/listen bus
164 (such as per-channel cut, dim, solo, invert, etc).
166 _monitor_control.reset (new MonitorProcessor (_session));
167 _monitor_control->activate ();
170 if (is_master() || is_monitor() || is_auditioner()) {
171 _mute_master->set_solo_ignore (true);
174 /* now that we have _meter, its safe to connect to this */
176 Metering::Meter.connect_same_thread (*this, (boost::bind (&Route::meter, this)));
179 /* run a configure so that the invisible processors get set up */
180 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
181 configure_processors (0);
189 DEBUG_TRACE (DEBUG::Destruction, string_compose ("route %1 destructor\n", _name));
191 /* do this early so that we don't get incoming signals as we are going through destruction
196 /* don't use clear_processors here, as it depends on the session which may
197 be half-destroyed by now
200 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
201 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
202 (*i)->drop_references ();
205 _processors.clear ();
209 Route::set_remote_control_id (uint32_t id, bool notify_class_listeners)
211 if (Config->get_remote_model() != UserOrdered) {
215 set_remote_control_id_internal (id, notify_class_listeners);
219 Route::set_remote_control_id_internal (uint32_t id, bool notify_class_listeners)
221 /* force IDs for master/monitor busses and prevent
222 any other route from accidentally getting these IDs
223 (i.e. legacy sessions)
226 if (is_master() && id != MasterBusRemoteControlID) {
227 id = MasterBusRemoteControlID;
230 if (is_monitor() && id != MonitorBusRemoteControlID) {
231 id = MonitorBusRemoteControlID;
238 /* don't allow it to collide */
240 if (!is_master () && !is_monitor() &&
241 (id == MasterBusRemoteControlID || id == MonitorBusRemoteControlID)) {
242 id += MonitorBusRemoteControlID;
245 if (id != remote_control_id()) {
246 _remote_control_id = id;
247 RemoteControlIDChanged ();
249 if (notify_class_listeners) {
250 RemoteControlIDChange ();
256 Route::remote_control_id() const
259 return MasterBusRemoteControlID;
263 return MonitorBusRemoteControlID;
266 return _remote_control_id;
270 Route::has_order_key (RouteSortOrderKey key) const
272 return (order_keys.find (key) != order_keys.end());
276 Route::order_key (RouteSortOrderKey key) const
278 OrderKeys::const_iterator i = order_keys.find (key);
280 if (i == order_keys.end()) {
288 Route::sync_order_keys (RouteSortOrderKey base)
290 /* this is called after changes to 1 or more route order keys have been
291 * made, and we want to sync up.
294 OrderKeys::iterator i = order_keys.find (base);
296 if (i == order_keys.end()) {
300 for (OrderKeys::iterator k = order_keys.begin(); k != order_keys.end(); ++k) {
302 if (k->first != base) {
303 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 set key for %2 to %3 from %4\n",
305 enum_2_string (k->first),
307 enum_2_string (base)));
309 k->second = i->second;
315 Route::set_remote_control_id_from_order_key (RouteSortOrderKey /*key*/, uint32_t rid)
317 if (is_master() || is_monitor() || is_auditioner()) {
318 /* hard-coded remote IDs, or no remote ID */
322 if (_remote_control_id != rid) {
323 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1: set edit-based RID to %2\n", name(), rid));
324 _remote_control_id = rid;
325 RemoteControlIDChanged (); /* EMIT SIGNAL (per-route) */
328 /* don't emit the class-level RID signal RemoteControlIDChange here,
329 leave that to the entity that changed the order key, so that we
330 don't get lots of emissions for no good reasons (e.g. when changing
331 all route order keys).
333 See Session::sync_remote_id_from_order_keys() for the (primary|only)
334 spot where that is emitted.
339 Route::set_order_key (RouteSortOrderKey key, uint32_t n)
341 OrderKeys::iterator i = order_keys.find (key);
343 if (i != order_keys.end() && i->second == n) {
349 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 order key %2 set to %3\n",
350 name(), enum_2_string (key), order_key (key)));
352 _session.set_dirty ();
356 Route::ensure_track_or_route_name(string name, Session &session)
358 string newname = name;
360 while (!session.io_name_is_legal (newname)) {
361 newname = bump_name_once (newname, '.');
369 Route::inc_gain (gain_t fraction, void *src)
371 _amp->inc_gain (fraction, src);
375 Route::set_gain (gain_t val, void *src)
377 if (src != 0 && _route_group && src != _route_group && _route_group->is_active() && _route_group->is_gain()) {
379 if (_route_group->is_relative()) {
381 gain_t usable_gain = _amp->gain();
382 if (usable_gain < 0.000001f) {
383 usable_gain = 0.000001f;
387 if (delta < 0.000001f) {
391 delta -= usable_gain;
396 gain_t factor = delta / usable_gain;
399 factor = _route_group->get_max_factor(factor);
400 if (factor == 0.0f) {
401 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
405 factor = _route_group->get_min_factor(factor);
406 if (factor == 0.0f) {
407 _amp->gain_control()->Changed(); /* EMIT SIGNAL */
412 _route_group->foreach_route (boost::bind (&Route::inc_gain, _1, factor, _route_group));
416 _route_group->foreach_route (boost::bind (&Route::set_gain, _1, val, _route_group));
422 if (val == _amp->gain()) {
426 _amp->set_gain (val, src);
430 Route::maybe_declick (BufferSet&, framecnt_t, int)
432 /* this is the "bus" implementation and they never declick.
437 /** Process this route for one (sub) cycle (process thread)
439 * @param bufs Scratch buffers to use for the signal path
440 * @param start_frame Initial transport frame
441 * @param end_frame Final transport frame
442 * @param nframes Number of frames to output (to ports)
444 * Note that (end_frame - start_frame) may not be equal to nframes when the
445 * transport speed isn't 1.0 (eg varispeed).
448 Route::process_output_buffers (BufferSet& bufs,
449 framepos_t start_frame, framepos_t end_frame, pframes_t nframes,
450 int declick, bool gain_automation_ok)
452 bufs.set_is_silent (false);
454 /* figure out if we're going to use gain automation */
455 if (gain_automation_ok) {
456 _amp->set_gain_automation_buffer (_session.gain_automation_buffer ());
457 _amp->setup_gain_automation (start_frame, end_frame, nframes);
459 _amp->apply_gain_automation (false);
462 /* Tell main outs what to do about monitoring. We do this so that
463 on a transition between monitoring states we get a de-clicking gain
464 change in the _main_outs delivery.
467 _main_outs->no_outs_cuz_we_no_monitor (monitoring_state () == MonitoringSilence);
469 /* -------------------------------------------------------------------------------------------
470 GLOBAL DECLICK (for transport changes etc.)
471 ----------------------------------------------------------------------------------------- */
473 maybe_declick (bufs, nframes, declick);
474 _pending_declick = 0;
476 /* -------------------------------------------------------------------------------------------
477 DENORMAL CONTROL/PHASE INVERT
478 ----------------------------------------------------------------------------------------- */
480 if (_phase_invert.any ()) {
484 if (_denormal_protection || Config->get_denormal_protection()) {
486 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
487 Sample* const sp = i->data();
489 if (_phase_invert[chn]) {
490 for (pframes_t nx = 0; nx < nframes; ++nx) {
495 for (pframes_t nx = 0; nx < nframes; ++nx) {
503 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
504 Sample* const sp = i->data();
506 if (_phase_invert[chn]) {
507 for (pframes_t nx = 0; nx < nframes; ++nx) {
516 if (_denormal_protection || Config->get_denormal_protection()) {
518 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
519 Sample* const sp = i->data();
520 for (pframes_t nx = 0; nx < nframes; ++nx) {
528 /* -------------------------------------------------------------------------------------------
530 ----------------------------------------------------------------------------------------- */
532 /* set this to be true if the meter will already have been ::run() earlier */
533 bool const meter_already_run = metering_state() == MeteringInput;
535 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
537 if (meter_already_run && boost::dynamic_pointer_cast<PeakMeter> (*i)) {
538 /* don't ::run() the meter, otherwise it will have its previous peak corrupted */
543 /* if it has any inputs, make sure they match */
544 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i) == 0 && (*i)->input_streams() != ChanCount::ZERO) {
545 if (bufs.count() != (*i)->input_streams()) {
547 DEBUG::Processors, string_compose (
548 "input port mismatch %1 bufs = %2 input for %3 = %4\n",
549 _name, bufs.count(), (*i)->name(), (*i)->input_streams()
556 /* should we NOT run plugins here if the route is inactive?
557 do we catch route != active somewhere higher?
560 (*i)->run (bufs, start_frame, end_frame, nframes, *i != _processors.back());
561 bufs.set_count ((*i)->output_streams());
566 Route::n_process_buffers ()
568 return max (_input->n_ports(), processor_max_streams);
572 Route::monitor_run (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
574 assert (is_monitor());
575 BufferSet& bufs (_session.get_route_buffers (n_process_buffers()));
576 passthru (bufs, start_frame, end_frame, nframes, declick);
580 Route::passthru (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
584 if (is_monitor() && _session.listening() && !_session.is_auditioning()) {
586 /* control/monitor bus ignores input ports when something is
587 feeding the listen "stream". data will "arrive" into the
588 route from the intreturn processor element.
591 bufs.silence (nframes, 0);
594 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
595 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, true);
599 Route::passthru_silence (framepos_t start_frame, framepos_t end_frame, pframes_t nframes, int declick)
601 BufferSet& bufs (_session.get_route_buffers (n_process_buffers(), true));
603 bufs.set_count (_input->n_ports());
604 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
605 process_output_buffers (bufs, start_frame, end_frame, nframes, declick, false);
609 Route::set_listen (bool yn, void* src)
615 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
616 _route_group->foreach_route (boost::bind (&Route::set_listen, _1, yn, _route_group));
621 if (yn != _monitor_send->active()) {
623 _monitor_send->activate ();
624 _mute_master->set_soloed (true);
626 _monitor_send->deactivate ();
627 _mute_master->set_soloed (false);
630 listen_changed (src); /* EMIT SIGNAL */
636 Route::listening_via_monitor () const
639 return _monitor_send->active ();
646 Route::set_solo_safe (bool yn, void *src)
648 if (_solo_safe != yn) {
650 solo_safe_changed (src);
655 Route::solo_safe() const
661 Route::set_solo (bool yn, void *src)
664 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo change due to solo-safe\n", name()));
668 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
669 _route_group->foreach_route (boost::bind (&Route::set_solo, _1, yn, _route_group));
673 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set solo => %2, src: %3 grp ? %4 currently self-soloed ? %5\n",
674 name(), yn, src, (src == _route_group), self_soloed()));
676 if (self_soloed() != yn) {
678 set_mute_master_solo ();
679 solo_changed (true, src); /* EMIT SIGNAL */
680 _solo_control->Changed (); /* EMIT SIGNAL */
685 Route::set_self_solo (bool yn)
687 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: set SELF solo => %2\n", name(), yn));
692 Route::mod_solo_by_others_upstream (int32_t delta)
695 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-upstream due to solo-safe\n", name()));
699 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-upstream by %2, current up = %3 down = %4\n",
700 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
702 uint32_t old_sbu = _soloed_by_others_upstream;
705 if (_soloed_by_others_upstream >= (uint32_t) abs (delta)) {
706 _soloed_by_others_upstream += delta;
708 _soloed_by_others_upstream = 0;
711 _soloed_by_others_upstream += delta;
714 DEBUG_TRACE (DEBUG::Solo, string_compose (
715 "%1 SbU delta %2 = %3 old = %4 sbd %5 ss %6 exclusive %7\n",
716 name(), delta, _soloed_by_others_upstream, old_sbu,
717 _soloed_by_others_downstream, _self_solo, Config->get_exclusive_solo()));
719 /* push the inverse solo change to everything that feeds us.
721 This is important for solo-within-group. When we solo 1 track out of N that
722 feed a bus, that track will cause mod_solo_by_upstream (+1) to be called
723 on the bus. The bus then needs to call mod_solo_by_downstream (-1) on all
724 tracks that feed it. This will silence them if they were audible because
725 of a bus solo, but the newly soloed track will still be audible (because
728 but .. do this only when we are being told to solo-by-upstream (i.e delta = +1),
732 if ((_self_solo || _soloed_by_others_downstream) &&
733 ((old_sbu == 0 && _soloed_by_others_upstream > 0) ||
734 (old_sbu > 0 && _soloed_by_others_upstream == 0))) {
736 if (delta > 0 || !Config->get_exclusive_solo()) {
737 DEBUG_TRACE (DEBUG::Solo, "\t ... INVERT push\n");
738 for (FedBy::iterator i = _fed_by.begin(); i != _fed_by.end(); ++i) {
739 boost::shared_ptr<Route> sr = i->r.lock();
741 sr->mod_solo_by_others_downstream (-delta);
747 set_mute_master_solo ();
748 solo_changed (false, this);
752 Route::mod_solo_by_others_downstream (int32_t delta)
755 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 ignore solo-by-downstream due to solo safe\n", name()));
759 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod solo-by-downstream by %2, current up = %3 down = %4\n",
760 name(), delta, _soloed_by_others_upstream, _soloed_by_others_downstream));
763 if (_soloed_by_others_downstream >= (uint32_t) abs (delta)) {
764 _soloed_by_others_downstream += delta;
766 _soloed_by_others_downstream = 0;
769 _soloed_by_others_downstream += delta;
772 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 SbD delta %2 = %3\n", name(), delta, _soloed_by_others_downstream));
774 set_mute_master_solo ();
775 solo_changed (false, this);
779 Route::set_mute_master_solo ()
781 _mute_master->set_soloed (self_soloed() || soloed_by_others_downstream() || soloed_by_others_upstream());
785 Route::set_solo_isolated (bool yn, void *src)
787 if (is_master() || is_monitor() || is_auditioner()) {
791 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_solo()) {
792 _route_group->foreach_route (boost::bind (&Route::set_solo_isolated, _1, yn, _route_group));
796 /* forward propagate solo-isolate status to everything fed by this route, but not those via sends only */
798 boost::shared_ptr<RouteList> routes = _session.get_routes ();
799 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
801 if ((*i).get() == this || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
806 bool does_feed = direct_feeds_according_to_graph (*i, &sends_only); // we will recurse anyway, so don't use ::feeds()
808 if (does_feed && !sends_only) {
809 (*i)->set_solo_isolated (yn, (*i)->route_group());
813 /* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
815 bool changed = false;
818 if (_solo_isolated == 0) {
819 _mute_master->set_solo_ignore (true);
824 if (_solo_isolated > 0) {
826 if (_solo_isolated == 0) {
827 _mute_master->set_solo_ignore (false);
834 solo_isolated_changed (src);
839 Route::solo_isolated () const
841 return _solo_isolated > 0;
845 Route::set_mute_points (MuteMaster::MutePoint mp)
847 _mute_master->set_mute_points (mp);
848 mute_points_changed (); /* EMIT SIGNAL */
850 if (_mute_master->muted_by_self()) {
851 mute_changed (this); /* EMIT SIGNAL */
852 _mute_control->Changed (); /* EMIT SIGNAL */
857 Route::set_mute (bool yn, void *src)
859 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_mute()) {
860 _route_group->foreach_route (boost::bind (&Route::set_mute, _1, yn, _route_group));
865 _mute_master->set_muted_by_self (yn);
866 /* allow any derived classes to respond to the mute change
867 before anybody else knows about it.
870 /* tell everyone else */
871 mute_changed (src); /* EMIT SIGNAL */
872 _mute_control->Changed (); /* EMIT SIGNAL */
877 Route::muted () const
879 return _mute_master->muted_by_self();
884 dump_processors(const string& name, const list<boost::shared_ptr<Processor> >& procs)
886 cerr << name << " {" << endl;
887 for (list<boost::shared_ptr<Processor> >::const_iterator p = procs.begin();
888 p != procs.end(); ++p) {
889 cerr << "\t" << (*p)->name() << " ID = " << (*p)->id() << " @ " << (*p) << endl;
895 /** Supposing that we want to insert a Processor at a given Placement, return
896 * the processor to add the new one before (or 0 to add at the end).
898 boost::shared_ptr<Processor>
899 Route::before_processor_for_placement (Placement p)
901 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
903 ProcessorList::iterator loc;
906 /* generic pre-fader: insert immediately before the amp */
907 loc = find (_processors.begin(), _processors.end(), _amp);
909 /* generic post-fader: insert right before the main outs */
910 loc = find (_processors.begin(), _processors.end(), _main_outs);
913 return loc != _processors.end() ? *loc : boost::shared_ptr<Processor> ();
916 /** Supposing that we want to insert a Processor at a given index, return
917 * the processor to add the new one before (or 0 to add at the end).
919 boost::shared_ptr<Processor>
920 Route::before_processor_for_index (int index)
923 return boost::shared_ptr<Processor> ();
926 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
928 ProcessorList::iterator i = _processors.begin ();
930 while (i != _processors.end() && j < index) {
931 if ((*i)->display_to_user()) {
938 return (i != _processors.end() ? *i : boost::shared_ptr<Processor> ());
941 /** Add a processor either pre- or post-fader
942 * @return 0 on success, non-0 on failure.
945 Route::add_processor (boost::shared_ptr<Processor> processor, Placement placement, ProcessorStreams* err, bool activation_allowed)
947 return add_processor (processor, before_processor_for_placement (placement), err, activation_allowed);
951 /** Add a processor to a route such that it ends up with a given index into the visible processors.
952 * @param index Index to add the processor at, or -1 to add at the end of the list.
953 * @return 0 on success, non-0 on failure.
956 Route::add_processor_by_index (boost::shared_ptr<Processor> processor, int index, ProcessorStreams* err, bool activation_allowed)
958 return add_processor (processor, before_processor_for_index (index), err, activation_allowed);
961 /** Add a processor to the route.
962 * @param before An existing processor in the list, or 0; the new processor will be inserted immediately before it (or at the end).
963 * @return 0 on success, non-0 on failure.
966 Route::add_processor (boost::shared_ptr<Processor> processor, boost::shared_ptr<Processor> before, ProcessorStreams* err, bool activation_allowed)
968 assert (processor != _meter);
969 assert (processor != _main_outs);
971 DEBUG_TRACE (DEBUG::Processors, string_compose (
972 "%1 adding processor %2\n", name(), processor->name()));
974 if (!AudioEngine::instance()->connected() || !processor) {
979 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
980 ProcessorState pstate (this);
982 boost::shared_ptr<PluginInsert> pi;
983 boost::shared_ptr<PortInsert> porti;
985 if (processor == _amp) {
986 /* Ensure that only one amp is in the list at any time */
987 ProcessorList::iterator check = find (_processors.begin(), _processors.end(), processor);
988 if (check != _processors.end()) {
989 if (before == _amp) {
990 /* Already in position; all is well */
993 _processors.erase (check);
998 assert (find (_processors.begin(), _processors.end(), processor) == _processors.end ());
1000 ProcessorList::iterator loc;
1002 /* inserting before a processor; find it */
1003 loc = find (_processors.begin(), _processors.end(), before);
1004 if (loc == _processors.end ()) {
1009 /* inserting at end */
1010 loc = _processors.end ();
1013 _processors.insert (loc, processor);
1015 // Set up processor list channels. This will set processor->[input|output]_streams(),
1016 // configure redirect ports properly, etc.
1019 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1021 if (configure_processors_unlocked (err)) {
1023 configure_processors_unlocked (0); // it worked before we tried to add it ...
1028 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(processor)) != 0) {
1030 if (pi->has_no_inputs ()) {
1031 /* generator plugin */
1032 _have_internal_generator = true;
1037 if (activation_allowed && !_session.get_disable_all_loaded_plugins()) {
1038 processor->activate ();
1041 processor->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1043 _output->set_user_latency (0);
1046 reset_instrument_info ();
1047 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1048 set_processor_positions ();
1054 Route::add_processor_from_xml_2X (const XMLNode& node, int version)
1056 const XMLProperty *prop;
1059 boost::shared_ptr<Processor> processor;
1061 /* bit of a hack: get the `placement' property from the <Redirect> tag here
1062 so that we can add the processor in the right place (pre/post-fader)
1065 XMLNodeList const & children = node.children ();
1066 XMLNodeList::const_iterator i = children.begin ();
1068 while (i != children.end() && (*i)->name() != X_("Redirect")) {
1072 Placement placement = PreFader;
1074 if (i != children.end()) {
1075 if ((prop = (*i)->property (X_("placement"))) != 0) {
1076 placement = Placement (string_2_enum (prop->value(), placement));
1080 if (node.name() == "Insert") {
1082 if ((prop = node.property ("type")) != 0) {
1084 if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
1085 prop->value() == "lv2" ||
1086 prop->value() == "windows-vst" ||
1087 prop->value() == "lxvst" ||
1088 prop->value() == "audiounit") {
1090 processor.reset (new PluginInsert (_session));
1094 processor.reset (new PortInsert (_session, _pannable, _mute_master));
1099 } else if (node.name() == "Send") {
1101 processor.reset (new Send (_session, _pannable, _mute_master));
1105 error << string_compose(_("unknown Processor type \"%1\"; ignored"), node.name()) << endmsg;
1109 if (processor->set_state (node, version)) {
1113 return (add_processor (processor, placement) == 0);
1116 catch (failed_constructor &err) {
1117 warning << _("processor could not be created. Ignored.") << endmsg;
1123 Route::add_processors (const ProcessorList& others, boost::shared_ptr<Processor> before, ProcessorStreams* err)
1125 /* NOTE: this is intended to be used ONLY when copying
1126 processors from another Route. Hence the subtle
1127 differences between this and ::add_processor()
1130 ProcessorList::iterator loc;
1133 loc = find(_processors.begin(), _processors.end(), before);
1135 /* nothing specified - at end */
1136 loc = _processors.end ();
1139 if (!_session.engine().connected()) {
1143 if (others.empty()) {
1148 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1149 ProcessorState pstate (this);
1151 for (ProcessorList::const_iterator i = others.begin(); i != others.end(); ++i) {
1157 boost::shared_ptr<PluginInsert> pi;
1159 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1163 _processors.insert (loc, *i);
1165 if ((*i)->active()) {
1170 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1171 if (configure_processors_unlocked (err)) {
1173 configure_processors_unlocked (0); // it worked before we tried to add it ...
1178 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
1181 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
1182 boost::shared_ptr<PluginInsert> pi;
1184 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1185 if (pi->has_no_inputs ()) {
1186 _have_internal_generator = true;
1192 _output->set_user_latency (0);
1195 reset_instrument_info ();
1196 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1197 set_processor_positions ();
1203 Route::placement_range(Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end)
1205 if (p == PreFader) {
1206 start = _processors.begin();
1207 end = find(_processors.begin(), _processors.end(), _amp);
1209 start = find(_processors.begin(), _processors.end(), _amp);
1211 end = _processors.end();
1215 /** Turn off all processors with a given placement
1216 * @param p Placement of processors to disable
1219 Route::disable_processors (Placement p)
1221 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1223 ProcessorList::iterator start, end;
1224 placement_range(p, start, end);
1226 for (ProcessorList::iterator i = start; i != end; ++i) {
1227 (*i)->deactivate ();
1230 _session.set_dirty ();
1233 /** Turn off all redirects
1236 Route::disable_processors ()
1238 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1240 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1241 (*i)->deactivate ();
1244 _session.set_dirty ();
1247 /** Turn off all redirects with a given placement
1248 * @param p Placement of redirects to disable
1251 Route::disable_plugins (Placement p)
1253 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1255 ProcessorList::iterator start, end;
1256 placement_range(p, start, end);
1258 for (ProcessorList::iterator i = start; i != end; ++i) {
1259 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1260 (*i)->deactivate ();
1264 _session.set_dirty ();
1267 /** Turn off all plugins
1270 Route::disable_plugins ()
1272 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1274 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1275 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1276 (*i)->deactivate ();
1280 _session.set_dirty ();
1285 Route::ab_plugins (bool forward)
1287 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1291 /* forward = turn off all active redirects, and mark them so that the next time
1292 we go the other way, we will revert them
1295 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1296 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1300 if ((*i)->active()) {
1301 (*i)->deactivate ();
1302 (*i)->set_next_ab_is_active (true);
1304 (*i)->set_next_ab_is_active (false);
1310 /* backward = if the redirect was marked to go active on the next ab, do so */
1312 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1314 if (!boost::dynamic_pointer_cast<PluginInsert> (*i)) {
1318 if ((*i)->get_next_ab_is_active()) {
1321 (*i)->deactivate ();
1326 _session.set_dirty ();
1330 /** Remove processors with a given placement.
1331 * @param p Placement of processors to remove.
1334 Route::clear_processors (Placement p)
1336 if (!_session.engine().connected()) {
1340 bool already_deleting = _session.deletion_in_progress();
1341 if (!already_deleting) {
1342 _session.set_deletion_in_progress();
1346 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1347 ProcessorList new_list;
1348 ProcessorStreams err;
1349 bool seen_amp = false;
1351 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1357 if ((*i) == _amp || (*i) == _meter || (*i) == _main_outs) {
1359 /* you can't remove these */
1361 new_list.push_back (*i);
1368 new_list.push_back (*i);
1371 (*i)->drop_references ();
1379 (*i)->drop_references ();
1382 new_list.push_back (*i);
1389 _processors = new_list;
1392 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1393 configure_processors_unlocked (&err); // this can't fail
1397 processor_max_streams.reset();
1398 _have_internal_generator = false;
1399 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1400 set_processor_positions ();
1402 reset_instrument_info ();
1404 if (!already_deleting) {
1405 _session.clear_deletion_in_progress();
1410 Route::remove_processor (boost::shared_ptr<Processor> processor, ProcessorStreams* err, bool need_process_lock)
1412 // TODO once the export point can be configured properly, do something smarter here
1413 if (processor == _capturing_processor) {
1414 _capturing_processor.reset();
1417 /* these can never be removed */
1419 if (processor == _amp || processor == _meter || processor == _main_outs) {
1423 if (!_session.engine().connected()) {
1427 processor_max_streams.reset();
1430 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1431 ProcessorState pstate (this);
1433 ProcessorList::iterator i;
1434 bool removed = false;
1436 for (i = _processors.begin(); i != _processors.end(); ) {
1437 if (*i == processor) {
1439 /* move along, see failure case for configure_processors()
1440 where we may need to reconfigure the processor.
1443 /* stop redirects that send signals to JACK ports
1444 from causing noise as a result of no longer being
1448 boost::shared_ptr<IOProcessor> iop;
1450 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (*i)) != 0) {
1454 i = _processors.erase (i);
1462 _output->set_user_latency (0);
1470 if (need_process_lock) {
1471 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1473 if (configure_processors_unlocked (err)) {
1475 /* we know this will work, because it worked before :) */
1476 configure_processors_unlocked (0);
1480 if (configure_processors_unlocked (err)) {
1482 /* we know this will work, because it worked before :) */
1483 configure_processors_unlocked (0);
1488 _have_internal_generator = false;
1490 for (i = _processors.begin(); i != _processors.end(); ++i) {
1491 boost::shared_ptr<PluginInsert> pi;
1493 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1494 if (pi->has_no_inputs ()) {
1495 _have_internal_generator = true;
1502 reset_instrument_info ();
1503 processor->drop_references ();
1504 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1505 set_processor_positions ();
1511 Route::remove_processors (const ProcessorList& to_be_deleted, ProcessorStreams* err)
1513 ProcessorList deleted;
1515 if (!_session.engine().connected()) {
1519 processor_max_streams.reset();
1522 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1523 ProcessorState pstate (this);
1525 ProcessorList::iterator i;
1526 boost::shared_ptr<Processor> processor;
1528 for (i = _processors.begin(); i != _processors.end(); ) {
1532 /* these can never be removed */
1534 if (processor == _amp || processor == _meter || processor == _main_outs) {
1539 /* see if its in the list of processors to delete */
1541 if (find (to_be_deleted.begin(), to_be_deleted.end(), processor) == to_be_deleted.end()) {
1546 /* stop IOProcessors that send to JACK ports
1547 from causing noise as a result of no longer being
1551 boost::shared_ptr<IOProcessor> iop;
1553 if ((iop = boost::dynamic_pointer_cast<IOProcessor> (processor)) != 0) {
1557 deleted.push_back (processor);
1558 i = _processors.erase (i);
1561 if (deleted.empty()) {
1562 /* none of those in the requested list were found */
1566 _output->set_user_latency (0);
1569 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1571 if (configure_processors_unlocked (err)) {
1573 /* we know this will work, because it worked before :) */
1574 configure_processors_unlocked (0);
1579 _have_internal_generator = false;
1581 for (i = _processors.begin(); i != _processors.end(); ++i) {
1582 boost::shared_ptr<PluginInsert> pi;
1584 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
1585 if (pi->has_no_inputs ()) {
1586 _have_internal_generator = true;
1593 /* now try to do what we need to so that those that were removed will be deleted */
1595 for (ProcessorList::iterator i = deleted.begin(); i != deleted.end(); ++i) {
1596 (*i)->drop_references ();
1599 reset_instrument_info ();
1600 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1601 set_processor_positions ();
1607 Route::reset_instrument_info ()
1609 boost::shared_ptr<Processor> instr = the_instrument();
1611 _instrument_info.set_internal_instrument (instr);
1615 /** Caller must hold process lock */
1617 Route::configure_processors (ProcessorStreams* err)
1619 assert (!AudioEngine::instance()->process_lock().trylock());
1621 if (!_in_configure_processors) {
1622 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1623 return configure_processors_unlocked (err);
1630 Route::input_streams () const
1632 return _input->n_ports ();
1635 list<pair<ChanCount, ChanCount> >
1636 Route::try_configure_processors (ChanCount in, ProcessorStreams* err)
1638 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1640 return try_configure_processors_unlocked (in, err);
1643 list<pair<ChanCount, ChanCount> >
1644 Route::try_configure_processors_unlocked (ChanCount in, ProcessorStreams* err)
1646 // Check each processor in order to see if we can configure as requested
1648 list<pair<ChanCount, ChanCount> > configuration;
1651 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configure processors\n", _name));
1652 DEBUG_TRACE (DEBUG::Processors, "{\n");
1654 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++index) {
1656 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1657 DEBUG_TRACE (DEBUG::Processors, "--- CONFIGURE ABORTED due to unknown processor.\n");
1658 DEBUG_TRACE (DEBUG::Processors, "}\n");
1659 return list<pair<ChanCount, ChanCount> > ();
1662 if ((*p)->can_support_io_configuration(in, out)) {
1663 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1 ID=%2 in=%3 out=%4\n",(*p)->name(), (*p)->id(), in, out));
1664 configuration.push_back(make_pair(in, out));
1671 DEBUG_TRACE (DEBUG::Processors, "---- CONFIGURATION FAILED.\n");
1672 DEBUG_TRACE (DEBUG::Processors, string_compose ("---- %1 cannot support in=%2 out=%3\n", (*p)->name(), in, out));
1673 DEBUG_TRACE (DEBUG::Processors, "}\n");
1674 return list<pair<ChanCount, ChanCount> > ();
1678 DEBUG_TRACE (DEBUG::Processors, "}\n");
1680 return configuration;
1683 /** Set the input/output configuration of each processor in the processors list.
1684 * Caller must hold process lock.
1685 * Return 0 on success, otherwise configuration is impossible.
1688 Route::configure_processors_unlocked (ProcessorStreams* err)
1690 assert (!AudioEngine::instance()->process_lock().trylock());
1692 if (_in_configure_processors) {
1696 /* put invisible processors where they should be */
1697 setup_invisible_processors ();
1699 _in_configure_processors = true;
1701 list<pair<ChanCount, ChanCount> > configuration = try_configure_processors_unlocked (input_streams (), err);
1703 if (configuration.empty ()) {
1704 _in_configure_processors = false;
1709 bool seen_mains_out = false;
1710 processor_out_streams = _input->n_ports();
1711 processor_max_streams.reset();
1713 list< pair<ChanCount,ChanCount> >::iterator c = configuration.begin();
1714 for (ProcessorList::iterator p = _processors.begin(); p != _processors.end(); ++p, ++c) {
1716 if (boost::dynamic_pointer_cast<UnknownProcessor> (*p)) {
1720 (*p)->configure_io(c->first, c->second);
1721 processor_max_streams = ChanCount::max(processor_max_streams, c->first);
1722 processor_max_streams = ChanCount::max(processor_max_streams, c->second);
1725 if (boost::dynamic_pointer_cast<Delivery> (*p)
1726 && boost::dynamic_pointer_cast<Delivery> (*p)->role() == Delivery::Main) {
1727 /* main delivery will increase port count to match input.
1728 * the Delivery::Main is usually the last processor - followed only by
1731 seen_mains_out = true;
1733 if (!seen_mains_out) {
1734 processor_out_streams = out;
1740 _meter->reset_max_channels (processor_max_streams);
1743 /* make sure we have sufficient scratch buffers to cope with the new processor
1746 _session.ensure_buffers (n_process_buffers ());
1748 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: configuration complete\n", _name));
1750 _in_configure_processors = false;
1754 /** Set all visible processors to a given active state (except Fader, whose state is not changed)
1755 * @param state New active state for those processors.
1758 Route::all_visible_processors_active (bool state)
1760 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
1762 if (_processors.empty()) {
1766 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
1767 if (!(*i)->display_to_user() || boost::dynamic_pointer_cast<Amp> (*i)) {
1774 (*i)->deactivate ();
1778 _session.set_dirty ();
1782 Route::reorder_processors (const ProcessorList& new_order, ProcessorStreams* err)
1784 /* "new_order" is an ordered list of processors to be positioned according to "placement".
1785 NOTE: all processors in "new_order" MUST be marked as display_to_user(). There maybe additional
1786 processors in the current actual processor list that are hidden. Any visible processors
1787 in the current list but not in "new_order" will be assumed to be deleted.
1791 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
1792 ProcessorState pstate (this);
1794 ProcessorList::iterator oiter;
1795 ProcessorList::const_iterator niter;
1796 ProcessorList as_it_will_be;
1798 oiter = _processors.begin();
1799 niter = new_order.begin();
1801 while (niter != new_order.end()) {
1803 /* if the next processor in the old list is invisible (i.e. should not be in the new order)
1804 then append it to the temp list.
1806 Otherwise, see if the next processor in the old list is in the new list. if not,
1807 its been deleted. If its there, append it to the temp list.
1810 if (oiter == _processors.end()) {
1812 /* no more elements in the old list, so just stick the rest of
1813 the new order onto the temp list.
1816 as_it_will_be.insert (as_it_will_be.end(), niter, new_order.end());
1817 while (niter != new_order.end()) {
1824 if (!(*oiter)->display_to_user()) {
1826 as_it_will_be.push_back (*oiter);
1830 /* visible processor: check that its in the new order */
1832 if (find (new_order.begin(), new_order.end(), (*oiter)) == new_order.end()) {
1833 /* deleted: do nothing, shared_ptr<> will clean up */
1835 /* ignore this one, and add the next item from the new order instead */
1836 as_it_will_be.push_back (*niter);
1841 /* now remove from old order - its taken care of no matter what */
1842 oiter = _processors.erase (oiter);
1847 _processors.insert (oiter, as_it_will_be.begin(), as_it_will_be.end());
1849 /* If the meter is in a custom position, find it and make a rough note of its position */
1850 maybe_note_meter_position ();
1853 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1855 if (configure_processors_unlocked (err)) {
1862 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
1863 set_processor_positions ();
1875 Route::get_template()
1877 return state(false);
1881 Route::state(bool full_state)
1883 XMLNode *node = new XMLNode("Route");
1884 ProcessorList::iterator i;
1887 id().print (buf, sizeof (buf));
1888 node->add_property("id", buf);
1889 node->add_property ("name", _name);
1890 node->add_property("default-type", _default_type.to_string());
1893 node->add_property("flags", enum_2_string (_flags));
1896 node->add_property("active", _active?"yes":"no");
1898 boost::to_string (_phase_invert, p);
1899 node->add_property("phase-invert", p);
1900 node->add_property("denormal-protection", _denormal_protection?"yes":"no");
1901 node->add_property("meter-point", enum_2_string (_meter_point));
1903 node->add_property("meter-type", enum_2_string (_meter_type));
1906 node->add_property("route-group", _route_group->name());
1909 string order_string;
1910 OrderKeys::iterator x = order_keys.begin();
1912 while (x != order_keys.end()) {
1913 order_string += enum_2_string ((*x).first);
1914 order_string += '=';
1915 snprintf (buf, sizeof(buf), "%" PRId32, (*x).second);
1916 order_string += buf;
1920 if (x == order_keys.end()) {
1924 order_string += ':';
1926 node->add_property ("order-keys", order_string);
1927 node->add_property ("self-solo", (_self_solo ? "yes" : "no"));
1928 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_upstream);
1929 node->add_property ("soloed-by-upstream", buf);
1930 snprintf (buf, sizeof (buf), "%d", _soloed_by_others_downstream);
1931 node->add_property ("soloed-by-downstream", buf);
1932 node->add_property ("solo-isolated", solo_isolated() ? "yes" : "no");
1933 node->add_property ("solo-safe", _solo_safe ? "yes" : "no");
1935 node->add_child_nocopy (_input->state (full_state));
1936 node->add_child_nocopy (_output->state (full_state));
1937 node->add_child_nocopy (_solo_control->get_state ());
1938 node->add_child_nocopy (_mute_control->get_state ());
1939 node->add_child_nocopy (_mute_master->get_state ());
1941 XMLNode* remote_control_node = new XMLNode (X_("RemoteControl"));
1942 snprintf (buf, sizeof (buf), "%d", _remote_control_id);
1943 remote_control_node->add_property (X_("id"), buf);
1944 node->add_child_nocopy (*remote_control_node);
1946 if (_comment.length()) {
1947 XMLNode *cmt = node->add_child ("Comment");
1948 cmt->add_content (_comment);
1952 node->add_child_nocopy (_pannable->state (full_state));
1955 for (i = _processors.begin(); i != _processors.end(); ++i) {
1957 /* template save: do not include internal sends functioning as
1958 aux sends because the chance of the target ID
1959 in the session where this template is used
1962 similarly, do not save listen sends which connect to
1963 the monitor section, because these will always be
1966 boost::shared_ptr<InternalSend> is;
1968 if ((is = boost::dynamic_pointer_cast<InternalSend> (*i)) != 0) {
1969 if (is->role() == Delivery::Listen) {
1974 node->add_child_nocopy((*i)->state (full_state));
1978 node->add_child_copy (*_extra_xml);
1981 if (_custom_meter_position_noted) {
1982 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
1984 after->id().print (buf, sizeof (buf));
1985 node->add_property (X_("processor-after-last-custom-meter"), buf);
1988 node->add_property (X_("last-custom-meter-was-at-end"), _last_custom_meter_was_at_end ? "yes" : "no");
1995 Route::set_state (const XMLNode& node, int version)
1997 if (version < 3000) {
1998 return set_state_2X (node, version);
2002 XMLNodeConstIterator niter;
2004 const XMLProperty *prop;
2006 if (node.name() != "Route"){
2007 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2011 if ((prop = node.property (X_("name"))) != 0) {
2012 Route::set_name (prop->value());
2016 _initial_io_setup = true;
2018 if ((prop = node.property (X_("flags"))) != 0) {
2019 _flags = Flag (string_2_enum (prop->value(), _flags));
2024 if (is_master() || is_monitor() || is_auditioner()) {
2025 _mute_master->set_solo_ignore (true);
2029 /* monitor bus does not get a panner, but if (re)created
2030 via XML, it will already have one by the time we
2031 call ::set_state(). so ... remove it.
2036 /* add all processors (except amp, which is always present) */
2038 nlist = node.children();
2039 XMLNode processor_state (X_("processor_state"));
2041 Stateful::save_extra_xml (node);
2043 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2047 if (child->name() == IO::state_node_name) {
2048 if ((prop = child->property (X_("direction"))) == 0) {
2052 if (prop->value() == "Input") {
2053 _input->set_state (*child, version);
2054 } else if (prop->value() == "Output") {
2055 _output->set_state (*child, version);
2059 if (child->name() == X_("Processor")) {
2060 processor_state.add_child_copy (*child);
2063 if (child->name() == X_("Pannable")) {
2065 _pannable->set_state (*child, version);
2067 warning << string_compose (_("Pannable state found for route (%1) without a panner!"), name()) << endmsg;
2072 if ((prop = node.property (X_("meter-point"))) != 0) {
2073 MeterPoint mp = MeterPoint (string_2_enum (prop->value (), _meter_point));
2074 set_meter_point (mp, true);
2076 _meter->set_display_to_user (_meter_point == MeterCustom);
2080 if ((prop = node.property (X_("meter-type"))) != 0) {
2081 _meter_type = MeterType (string_2_enum (prop->value (), _meter_type));
2084 _initial_io_setup = false;
2086 set_processor_state (processor_state);
2088 // this looks up the internal instrument in processors
2089 reset_instrument_info();
2091 if ((prop = node.property ("self-solo")) != 0) {
2092 set_self_solo (string_is_affirmative (prop->value()));
2095 if ((prop = node.property ("soloed-by-upstream")) != 0) {
2096 _soloed_by_others_upstream = 0; // needed for mod_.... () to work
2097 mod_solo_by_others_upstream (atoi (prop->value()));
2100 if ((prop = node.property ("soloed-by-downstream")) != 0) {
2101 _soloed_by_others_downstream = 0; // needed for mod_.... () to work
2102 mod_solo_by_others_downstream (atoi (prop->value()));
2105 if ((prop = node.property ("solo-isolated")) != 0) {
2106 set_solo_isolated (string_is_affirmative (prop->value()), this);
2109 if ((prop = node.property ("solo-safe")) != 0) {
2110 set_solo_safe (string_is_affirmative (prop->value()), this);
2113 if ((prop = node.property (X_("phase-invert"))) != 0) {
2114 set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
2117 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2118 set_denormal_protection (string_is_affirmative (prop->value()));
2121 if ((prop = node.property (X_("active"))) != 0) {
2122 bool yn = string_is_affirmative (prop->value());
2123 _active = !yn; // force switch
2124 set_active (yn, this);
2127 if ((prop = node.property (X_("order-keys"))) != 0) {
2131 string::size_type colon, equal;
2132 string remaining = prop->value();
2134 while (remaining.length()) {
2136 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2137 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2140 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2141 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2144 string keyname = remaining.substr (0, equal);
2145 RouteSortOrderKey sk;
2147 if (keyname == "signal") {
2149 } else if (keyname == "editor") {
2152 sk = (RouteSortOrderKey) string_2_enum (remaining.substr (0, equal), sk);
2155 set_order_key (sk, n);
2159 colon = remaining.find_first_of (':');
2161 if (colon != string::npos) {
2162 remaining = remaining.substr (colon+1);
2169 if ((prop = node.property (X_("processor-after-last-custom-meter"))) != 0) {
2170 PBD::ID id (prop->value ());
2171 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2172 ProcessorList::const_iterator i = _processors.begin ();
2173 while (i != _processors.end() && (*i)->id() != id) {
2177 if (i != _processors.end ()) {
2178 _processor_after_last_custom_meter = *i;
2179 _custom_meter_position_noted = true;
2183 if ((prop = node.property (X_("last-custom-meter-was-at-end"))) != 0) {
2184 _last_custom_meter_was_at_end = string_is_affirmative (prop->value ());
2187 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2190 if (child->name() == X_("Comment")) {
2192 /* XXX this is a terrible API design in libxml++ */
2194 XMLNode *cmt = *(child->children().begin());
2195 _comment = cmt->content();
2197 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2198 if (prop->value() == "solo") {
2199 _solo_control->set_state (*child, version);
2200 } else if (prop->value() == "mute") {
2201 _mute_control->set_state (*child, version);
2204 } else if (child->name() == X_("RemoteControl")) {
2205 if ((prop = child->property (X_("id"))) != 0) {
2207 sscanf (prop->value().c_str(), "%d", &x);
2208 set_remote_control_id_internal (x);
2211 } else if (child->name() == X_("MuteMaster")) {
2212 _mute_master->set_state (*child, version);
2220 Route::set_state_2X (const XMLNode& node, int version)
2223 XMLNodeConstIterator niter;
2225 const XMLProperty *prop;
2227 /* 2X things which still remain to be handled:
2233 if (node.name() != "Route") {
2234 error << string_compose(_("Bad node sent to Route::set_state() [%1]"), node.name()) << endmsg;
2238 if ((prop = node.property (X_("flags"))) != 0) {
2239 string f = prop->value ();
2240 boost::replace_all (f, "ControlOut", "MonitorOut");
2241 _flags = Flag (string_2_enum (f, _flags));
2246 if (is_master() || is_monitor() || is_auditioner()) {
2247 _mute_master->set_solo_ignore (true);
2250 if ((prop = node.property (X_("phase-invert"))) != 0) {
2251 boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
2252 if (string_is_affirmative (prop->value ())) {
2255 set_phase_invert (p);
2258 if ((prop = node.property (X_("denormal-protection"))) != 0) {
2259 set_denormal_protection (string_is_affirmative (prop->value()));
2262 if ((prop = node.property (X_("soloed"))) != 0) {
2263 bool yn = string_is_affirmative (prop->value());
2265 /* XXX force reset of solo status */
2267 set_solo (yn, this);
2270 if ((prop = node.property (X_("muted"))) != 0) {
2273 bool muted = string_is_affirmative (prop->value());
2279 if ((prop = node.property (X_("mute-affects-pre-fader"))) != 0) {
2281 if (string_is_affirmative (prop->value())){
2282 mute_point = mute_point + "PreFader";
2287 if ((prop = node.property (X_("mute-affects-post-fader"))) != 0) {
2289 if (string_is_affirmative (prop->value())){
2292 mute_point = mute_point + ",";
2295 mute_point = mute_point + "PostFader";
2300 if ((prop = node.property (X_("mute-affects-control-outs"))) != 0) {
2302 if (string_is_affirmative (prop->value())){
2305 mute_point = mute_point + ",";
2308 mute_point = mute_point + "Listen";
2313 if ((prop = node.property (X_("mute-affects-main-outs"))) != 0) {
2315 if (string_is_affirmative (prop->value())){
2318 mute_point = mute_point + ",";
2321 mute_point = mute_point + "Main";
2325 _mute_master->set_mute_points (mute_point);
2326 _mute_master->set_muted_by_self (true);
2330 if ((prop = node.property (X_("meter-point"))) != 0) {
2331 _meter_point = MeterPoint (string_2_enum (prop->value (), _meter_point));
2334 /* do not carry over edit/mix groups from 2.X because (a) its hard (b) they
2335 don't mean the same thing.
2338 if ((prop = node.property (X_("order-keys"))) != 0) {
2342 string::size_type colon, equal;
2343 string remaining = prop->value();
2345 while (remaining.length()) {
2347 if ((equal = remaining.find_first_of ('=')) == string::npos || equal == remaining.length()) {
2348 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2351 if (sscanf (remaining.substr (equal+1).c_str(), "%d", &n) != 1) {
2352 error << string_compose (_("badly formed order key string in state file! [%1] ... ignored."), remaining)
2355 string keyname = remaining.substr (0, equal);
2356 RouteSortOrderKey sk;
2358 if (keyname == "signal") {
2360 } else if (keyname == "editor") {
2363 sk = (RouteSortOrderKey) string_2_enum (remaining.substr (0, equal), sk);
2366 set_order_key (sk, n);
2370 colon = remaining.find_first_of (':');
2372 if (colon != string::npos) {
2373 remaining = remaining.substr (colon+1);
2382 nlist = node.children ();
2383 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2387 if (child->name() == IO::state_node_name) {
2389 /* there is a note in IO::set_state_2X() about why we have to call
2393 _input->set_state_2X (*child, version, true);
2394 _output->set_state_2X (*child, version, false);
2396 if ((prop = child->property (X_("name"))) != 0) {
2397 Route::set_name (prop->value ());
2402 if ((prop = child->property (X_("active"))) != 0) {
2403 bool yn = string_is_affirmative (prop->value());
2404 _active = !yn; // force switch
2405 set_active (yn, this);
2408 if ((prop = child->property (X_("gain"))) != 0) {
2411 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
2412 _amp->gain_control()->set_value (val);
2416 /* Set up Panners in the IO */
2417 XMLNodeList io_nlist = child->children ();
2419 XMLNodeConstIterator io_niter;
2422 for (io_niter = io_nlist.begin(); io_niter != io_nlist.end(); ++io_niter) {
2424 io_child = *io_niter;
2426 if (io_child->name() == X_("Panner")) {
2427 _main_outs->panner_shell()->set_state(*io_child, version);
2428 } else if (io_child->name() == X_("Automation")) {
2429 /* IO's automation is for the fader */
2430 _amp->set_automation_xml_state (*io_child, Evoral::Parameter (GainAutomation));
2436 XMLNodeList redirect_nodes;
2438 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2442 if (child->name() == X_("Send") || child->name() == X_("Insert")) {
2443 redirect_nodes.push_back(child);
2448 set_processor_state_2X (redirect_nodes, version);
2450 Stateful::save_extra_xml (node);
2452 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
2455 if (child->name() == X_("Comment")) {
2457 /* XXX this is a terrible API design in libxml++ */
2459 XMLNode *cmt = *(child->children().begin());
2460 _comment = cmt->content();
2462 } else if (child->name() == Controllable::xml_node_name && (prop = child->property("name")) != 0) {
2463 if (prop->value() == X_("solo")) {
2464 _solo_control->set_state (*child, version);
2465 } else if (prop->value() == X_("mute")) {
2466 _mute_control->set_state (*child, version);
2469 } else if (child->name() == X_("RemoteControl")) {
2470 if ((prop = child->property (X_("id"))) != 0) {
2472 sscanf (prop->value().c_str(), "%d", &x);
2473 set_remote_control_id_internal (x);
2483 Route::get_processor_state ()
2485 XMLNode* root = new XMLNode (X_("redirects"));
2486 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2487 root->add_child_nocopy ((*i)->state (true));
2494 Route::set_processor_state_2X (XMLNodeList const & nList, int version)
2496 /* We don't bother removing existing processors not in nList, as this
2497 method will only be called when creating a Route from scratch, not
2498 for undo purposes. Just put processors in at the appropriate place
2502 for (XMLNodeConstIterator i = nList.begin(); i != nList.end(); ++i) {
2503 add_processor_from_xml_2X (**i, version);
2508 Route::set_processor_state (const XMLNode& node)
2510 const XMLNodeList &nlist = node.children();
2511 XMLNodeConstIterator niter;
2512 ProcessorList new_order;
2513 bool must_configure = false;
2515 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2517 XMLProperty* prop = (*niter)->property ("type");
2519 if (prop->value() == "amp") {
2520 _amp->set_state (**niter, Stateful::current_state_version);
2521 new_order.push_back (_amp);
2522 } else if (prop->value() == "meter") {
2523 _meter->set_state (**niter, Stateful::current_state_version);
2524 new_order.push_back (_meter);
2525 } else if (prop->value() == "main-outs") {
2526 _main_outs->set_state (**niter, Stateful::current_state_version);
2527 } else if (prop->value() == "intreturn") {
2529 _intreturn.reset (new InternalReturn (_session));
2530 must_configure = true;
2532 _intreturn->set_state (**niter, Stateful::current_state_version);
2533 } else if (is_monitor() && prop->value() == "monitor") {
2534 if (!_monitor_control) {
2535 _monitor_control.reset (new MonitorProcessor (_session));
2536 must_configure = true;
2538 _monitor_control->set_state (**niter, Stateful::current_state_version);
2539 } else if (prop->value() == "capture") {
2540 /* CapturingProcessor should never be restored, it's always
2541 added explicitly when needed */
2543 ProcessorList::iterator o;
2545 for (o = _processors.begin(); o != _processors.end(); ++o) {
2546 XMLProperty* id_prop = (*niter)->property(X_("id"));
2547 if (id_prop && (*o)->id() == id_prop->value()) {
2548 (*o)->set_state (**niter, Stateful::current_state_version);
2549 new_order.push_back (*o);
2554 // If the processor (*niter) is not on the route then create it
2556 if (o == _processors.end()) {
2558 boost::shared_ptr<Processor> processor;
2560 if (prop->value() == "intsend") {
2562 processor.reset (new InternalSend (_session, _pannable, _mute_master, boost::shared_ptr<Route>(), Delivery::Role (0)));
2564 } else if (prop->value() == "ladspa" || prop->value() == "Ladspa" ||
2565 prop->value() == "lv2" ||
2566 prop->value() == "windows-vst" ||
2567 prop->value() == "lxvst" ||
2568 prop->value() == "audiounit") {
2570 processor.reset (new PluginInsert(_session));
2572 } else if (prop->value() == "port") {
2574 processor.reset (new PortInsert (_session, _pannable, _mute_master));
2576 } else if (prop->value() == "send") {
2578 processor.reset (new Send (_session, _pannable, _mute_master));
2581 error << string_compose(_("unknown Processor type \"%1\"; ignored"), prop->value()) << endmsg;
2585 if (processor->set_state (**niter, Stateful::current_state_version) != 0) {
2586 /* This processor could not be configured. Turn it into a UnknownProcessor */
2587 processor.reset (new UnknownProcessor (_session, **niter));
2590 /* we have to note the monitor send here, otherwise a new one will be created
2591 and the state of this one will be lost.
2593 boost::shared_ptr<InternalSend> isend = boost::dynamic_pointer_cast<InternalSend> (processor);
2594 if (isend && isend->role() == Delivery::Listen) {
2595 _monitor_send = isend;
2598 /* it doesn't matter if invisible processors are added here, as they
2599 will be sorted out by setup_invisible_processors () shortly.
2602 new_order.push_back (processor);
2603 must_configure = true;
2609 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
2610 _processors = new_order;
2612 if (must_configure) {
2613 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2614 configure_processors_unlocked (0);
2617 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
2619 (*i)->ActiveChanged.connect_same_thread (*this, boost::bind (&Session::update_latency_compensation, &_session, false));
2621 boost::shared_ptr<PluginInsert> pi;
2623 if ((pi = boost::dynamic_pointer_cast<PluginInsert>(*i)) != 0) {
2624 if (pi->has_no_inputs ()) {
2625 _have_internal_generator = true;
2632 reset_instrument_info ();
2633 processors_changed (RouteProcessorChange ());
2634 set_processor_positions ();
2638 Route::curve_reallocate ()
2640 // _gain_automation_curve.finish_resize ();
2641 // _pan_automation_curve.finish_resize ();
2645 Route::silence (framecnt_t nframes)
2647 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
2652 silence_unlocked (nframes);
2656 Route::silence_unlocked (framecnt_t nframes)
2658 /* Must be called with the processor lock held */
2662 _output->silence (nframes);
2664 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2665 boost::shared_ptr<PluginInsert> pi;
2667 if (!_active && (pi = boost::dynamic_pointer_cast<PluginInsert> (*i)) != 0) {
2668 // skip plugins, they don't need anything when we're not active
2672 (*i)->silence (nframes);
2675 if (nframes == _session.get_block_size()) {
2682 Route::add_internal_return ()
2685 _intreturn.reset (new InternalReturn (_session));
2686 add_processor (_intreturn, PreFader);
2691 Route::add_send_to_internal_return (InternalSend* send)
2693 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2695 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2696 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2699 return d->add_send (send);
2705 Route::remove_send_from_internal_return (InternalSend* send)
2707 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2709 for (ProcessorList::const_iterator x = _processors.begin(); x != _processors.end(); ++x) {
2710 boost::shared_ptr<InternalReturn> d = boost::dynamic_pointer_cast<InternalReturn>(*x);
2713 return d->remove_send (send);
2719 Route::enable_monitor_send ()
2721 /* Caller must hold process lock */
2722 assert (!AudioEngine::instance()->process_lock().trylock());
2724 /* master never sends to monitor section via the normal mechanism */
2725 assert (!is_master ());
2727 /* make sure we have one */
2728 if (!_monitor_send) {
2729 _monitor_send.reset (new InternalSend (_session, _pannable, _mute_master, _session.monitor_out(), Delivery::Listen));
2730 _monitor_send->set_display_to_user (false);
2734 configure_processors (0);
2737 /** Add an aux send to a route.
2738 * @param route route to send to.
2739 * @param before Processor to insert before, or 0 to insert at the end.
2742 Route::add_aux_send (boost::shared_ptr<Route> route, boost::shared_ptr<Processor> before)
2744 assert (route != _session.monitor_out ());
2747 Glib::Threads::RWLock::ReaderLock rm (_processor_lock);
2749 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2751 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend> (*x);
2753 if (d && d->target_route() == route) {
2754 /* already listening via the specified IO: do nothing */
2762 boost::shared_ptr<InternalSend> listener;
2765 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2766 listener.reset (new InternalSend (_session, _pannable, _mute_master, route, Delivery::Aux));
2769 add_processor (listener, before);
2771 } catch (failed_constructor& err) {
2779 Route::remove_aux_or_listen (boost::shared_ptr<Route> route)
2781 ProcessorStreams err;
2782 ProcessorList::iterator tmp;
2785 Glib::Threads::RWLock::ReaderLock rl(_processor_lock);
2787 /* have to do this early because otherwise processor reconfig
2788 * will put _monitor_send back in the list
2791 if (route == _session.monitor_out()) {
2792 _monitor_send.reset ();
2796 for (ProcessorList::iterator x = _processors.begin(); x != _processors.end(); ++x) {
2798 boost::shared_ptr<InternalSend> d = boost::dynamic_pointer_cast<InternalSend>(*x);
2800 if (d && d->target_route() == route) {
2802 remove_processor (*x, &err, false);
2805 /* list could have been demolished while we dropped the lock
2816 Route::set_comment (string cmt, void *src)
2819 comment_changed (src);
2820 _session.set_dirty ();
2824 Route::add_fed_by (boost::shared_ptr<Route> other, bool via_sends_only)
2826 FeedRecord fr (other, via_sends_only);
2828 pair<FedBy::iterator,bool> result = _fed_by.insert (fr);
2830 if (!result.second) {
2832 /* already a record for "other" - make sure sends-only information is correct */
2833 if (!via_sends_only && result.first->sends_only) {
2834 FeedRecord* frp = const_cast<FeedRecord*>(&(*result.first));
2835 frp->sends_only = false;
2839 return result.second;
2843 Route::clear_fed_by ()
2849 Route::feeds (boost::shared_ptr<Route> other, bool* via_sends_only)
2851 const FedBy& fed_by (other->fed_by());
2853 for (FedBy::iterator f = fed_by.begin(); f != fed_by.end(); ++f) {
2854 boost::shared_ptr<Route> sr = f->r.lock();
2856 if (sr && (sr.get() == this)) {
2858 if (via_sends_only) {
2859 *via_sends_only = f->sends_only;
2870 Route::direct_feeds_according_to_reality (boost::shared_ptr<Route> other, bool* via_send_only)
2872 DEBUG_TRACE (DEBUG::Graph, string_compose ("Feeds? %1\n", _name));
2874 if (_output->connected_to (other->input())) {
2875 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdirect FEEDS %2\n", other->name()));
2876 if (via_send_only) {
2877 *via_send_only = false;
2884 for (ProcessorList::iterator r = _processors.begin(); r != _processors.end(); ++r) {
2886 boost::shared_ptr<IOProcessor> iop;
2888 if ((iop = boost::dynamic_pointer_cast<IOProcessor>(*r)) != 0) {
2889 if (iop->feeds (other)) {
2890 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does feed %2\n", iop->name(), other->name()));
2891 if (via_send_only) {
2892 *via_send_only = true;
2896 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tIOP %1 does NOT feed %2\n", iop->name(), other->name()));
2899 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tPROC %1 is not an IOP\n", (*r)->name()));
2904 DEBUG_TRACE (DEBUG::Graph, string_compose ("\tdoes NOT feed %1\n", other->name()));
2909 Route::direct_feeds_according_to_graph (boost::shared_ptr<Route> other, bool* via_send_only)
2911 return _session._current_route_graph.has (shared_from_this (), other, via_send_only);
2914 /** Called from the (non-realtime) butler thread when the transport is stopped */
2916 Route::nonrealtime_handle_transport_stopped (bool /*abort_ignored*/, bool /*did_locate*/, bool can_flush_processors)
2918 framepos_t now = _session.transport_frame();
2921 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
2923 Automatable::transport_stopped (now);
2925 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
2927 if (!_have_internal_generator && (Config->get_plugins_stop_with_transport() && can_flush_processors)) {
2931 (*i)->transport_stopped (now);
2935 _roll_delay = _initial_delay;
2939 Route::input_change_handler (IOChange change, void * /*src*/)
2941 bool need_to_queue_solo_change = true;
2943 if ((change.type & IOChange::ConfigurationChanged)) {
2944 /* This is called with the process lock held if change
2945 contains ConfigurationChanged
2947 need_to_queue_solo_change = false;
2948 configure_processors (0);
2949 _phase_invert.resize (_input->n_ports().n_audio ());
2950 io_changed (); /* EMIT SIGNAL */
2953 if (!_input->connected() && _soloed_by_others_upstream) {
2954 if (need_to_queue_solo_change) {
2955 _session.cancel_solo_after_disconnect (shared_from_this(), true);
2957 cancel_solo_after_disconnect (true);
2963 Route::output_change_handler (IOChange change, void * /*src*/)
2965 bool need_to_queue_solo_change = true;
2966 if (_initial_io_setup) {
2970 if ((change.type & IOChange::ConfigurationChanged)) {
2971 /* This is called with the process lock held if change
2972 contains ConfigurationChanged
2974 need_to_queue_solo_change = false;
2975 configure_processors (0);
2976 io_changed (); /* EMIT SIGNAL */
2979 if (!_output->connected() && _soloed_by_others_downstream) {
2980 if (need_to_queue_solo_change) {
2981 _session.cancel_solo_after_disconnect (shared_from_this(), false);
2983 cancel_solo_after_disconnect (false);
2989 Route::cancel_solo_after_disconnect (bool upstream)
2992 _soloed_by_others_upstream = 0;
2994 _soloed_by_others_downstream = 0;
2996 set_mute_master_solo ();
2997 solo_changed (false, this);
3001 Route::pans_required () const
3003 if (n_outputs().n_audio() < 2) {
3007 return max (n_inputs ().n_audio(), processor_max_streams.n_audio());
3011 Route::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
3013 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3019 if (n_outputs().n_total() == 0) {
3023 if (!_active || n_inputs() == ChanCount::ZERO) {
3024 silence_unlocked (nframes);
3028 if (session_state_changing) {
3029 if (_session.transport_speed() != 0.0f) {
3030 /* we're rolling but some state is changing (e.g. our diskstream contents)
3031 so we cannot use them. Be silent till this is over.
3033 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
3035 silence_unlocked (nframes);
3038 /* we're really not rolling, so we're either delivery silence or actually
3039 monitoring, both of which are safe to do while session_state_changing is true.
3043 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3045 fill_buffers_with_input (bufs, _input, nframes);
3047 if (_meter_point == MeterInput) {
3048 _meter->run (bufs, start_frame, end_frame, nframes, true);
3051 _amp->apply_gain_automation (false);
3052 passthru (bufs, start_frame, end_frame, nframes, 0);
3058 Route::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick, bool& /* need_butler */)
3060 Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3065 if (n_outputs().n_total() == 0) {
3069 if (!_active || n_inputs().n_total() == 0) {
3070 silence_unlocked (nframes);
3074 framepos_t unused = 0;
3076 if ((nframes = check_initial_delay (nframes, unused)) == 0) {
3082 BufferSet& bufs = _session.get_route_buffers (n_process_buffers());
3084 fill_buffers_with_input (bufs, _input, nframes);
3086 if (_meter_point == MeterInput) {
3087 _meter->run (bufs, start_frame, end_frame, nframes, true);
3090 passthru (bufs, start_frame, end_frame, nframes, declick);
3096 Route::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& /* need_butler */)
3103 Route::flush_processors ()
3105 /* XXX shouldn't really try to take this lock, since
3106 this is called from the RT audio thread.
3109 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3111 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3117 Route::set_meter_point (MeterPoint p, bool force)
3119 if (_meter_point == p && !force) {
3123 bool meter_was_visible_to_user = _meter->display_to_user ();
3126 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3128 maybe_note_meter_position ();
3132 if (_meter_point != MeterCustom) {
3134 _meter->set_display_to_user (false);
3136 setup_invisible_processors ();
3140 _meter->set_display_to_user (true);
3142 /* If we have a previous position for the custom meter, try to put it there */
3143 if (_custom_meter_position_noted) {
3144 boost::shared_ptr<Processor> after = _processor_after_last_custom_meter.lock ();
3147 ProcessorList::iterator i = find (_processors.begin(), _processors.end(), after);
3148 if (i != _processors.end ()) {
3149 _processors.remove (_meter);
3150 _processors.insert (i, _meter);
3152 } else if (_last_custom_meter_was_at_end) {
3153 _processors.remove (_meter);
3154 _processors.push_back (_meter);
3159 /* Set up the meter for its new position */
3161 ProcessorList::iterator loc = find (_processors.begin(), _processors.end(), _meter);
3165 if (loc == _processors.begin()) {
3166 m_in = _input->n_ports();
3168 ProcessorList::iterator before = loc;
3170 m_in = (*before)->output_streams ();
3173 _meter->reflect_inputs (m_in);
3175 /* we do not need to reconfigure the processors, because the meter
3176 (a) is always ready to handle processor_max_streams
3177 (b) is always an N-in/N-out processor, and thus moving
3178 it doesn't require any changes to the other processors.
3182 meter_change (); /* EMIT SIGNAL */
3184 bool const meter_visibly_changed = (_meter->display_to_user() != meter_was_visible_to_user);
3186 processors_changed (RouteProcessorChange (RouteProcessorChange::MeterPointChange, meter_visibly_changed)); /* EMIT SIGNAL */
3190 Route::listen_position_changed ()
3193 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
3194 ProcessorState pstate (this);
3197 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3199 if (configure_processors_unlocked (0)) {
3201 configure_processors_unlocked (0); // it worked before we tried to add it ...
3207 processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
3208 _session.set_dirty ();
3211 boost::shared_ptr<CapturingProcessor>
3212 Route::add_export_point()
3214 if (!_capturing_processor) {
3216 _capturing_processor.reset (new CapturingProcessor (_session));
3217 _capturing_processor->activate ();
3220 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3221 configure_processors (0);
3226 return _capturing_processor;
3230 Route::update_signal_latency ()
3232 framecnt_t l = _output->user_latency();
3234 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3235 if ((*i)->active ()) {
3236 l += (*i)->signal_latency ();
3240 DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: internal signal latency = %2\n", _name, l));
3242 if (_signal_latency != l) {
3243 _signal_latency = l;
3244 signal_latency_changed (); /* EMIT SIGNAL */
3247 return _signal_latency;
3251 Route::set_user_latency (framecnt_t nframes)
3253 _output->set_user_latency (nframes);
3254 _session.update_latency_compensation ();
3258 Route::set_latency_compensation (framecnt_t longest_session_latency)
3260 framecnt_t old = _initial_delay;
3262 if (_signal_latency < longest_session_latency) {
3263 _initial_delay = longest_session_latency - _signal_latency;
3268 DEBUG_TRACE (DEBUG::Latency, string_compose (
3269 "%1: compensate for maximum latency of %2,"
3270 "given own latency of %3, using initial delay of %4\n",
3271 name(), longest_session_latency, _signal_latency, _initial_delay));
3273 if (_initial_delay != old) {
3274 initial_delay_changed (); /* EMIT SIGNAL */
3277 if (_session.transport_stopped()) {
3278 _roll_delay = _initial_delay;
3282 Route::SoloControllable::SoloControllable (std::string name, boost::shared_ptr<Route> r)
3283 : AutomationControl (r->session(), Evoral::Parameter (SoloAutomation),
3284 boost::shared_ptr<AutomationList>(), name)
3287 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(SoloAutomation)));
3292 Route::SoloControllable::set_value (double val)
3294 bool bval = ((val >= 0.5f) ? true: false);
3296 boost::shared_ptr<RouteList> rl (new RouteList);
3298 boost::shared_ptr<Route> r = _route.lock ();
3305 if (Config->get_solo_control_is_listen_control()) {
3306 _session.set_listen (rl, bval);
3308 _session.set_solo (rl, bval);
3313 Route::SoloControllable::get_value () const
3315 boost::shared_ptr<Route> r = _route.lock ();
3320 if (Config->get_solo_control_is_listen_control()) {
3321 return r->listening_via_monitor() ? 1.0f : 0.0f;
3323 return r->self_soloed() ? 1.0f : 0.0f;
3327 Route::MuteControllable::MuteControllable (std::string name, boost::shared_ptr<Route> r)
3328 : AutomationControl (r->session(), Evoral::Parameter (MuteAutomation),
3329 boost::shared_ptr<AutomationList>(), name)
3332 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(MuteAutomation)));
3337 Route::MuteControllable::set_value (double val)
3339 bool bval = ((val >= 0.5f) ? true: false);
3341 boost::shared_ptr<RouteList> rl (new RouteList);
3343 boost::shared_ptr<Route> r = _route.lock ();
3349 _session.set_mute (rl, bval);
3353 Route::MuteControllable::get_value () const
3355 boost::shared_ptr<Route> r = _route.lock ();
3360 return r->muted() ? 1.0f : 0.0f;
3364 Route::set_block_size (pframes_t nframes)
3366 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3367 (*i)->set_block_size (nframes);
3370 _session.ensure_buffers (n_process_buffers ());
3374 Route::protect_automation ()
3376 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i)
3377 (*i)->protect_automation();
3380 /** @param declick 1 to set a pending declick fade-in,
3381 * -1 to set a pending declick fade-out
3384 Route::set_pending_declick (int declick)
3387 /* this call is not allowed to turn off a pending declick */
3389 _pending_declick = declick;
3392 _pending_declick = 0;
3396 /** Shift automation forwards from a particular place, thereby inserting time.
3397 * Adds undo commands for any shifts that are performed.
3399 * @param pos Position to start shifting from.
3400 * @param frames Amount to shift forwards by.
3404 Route::shift (framepos_t pos, framecnt_t frames)
3406 /* gain automation */
3408 boost::shared_ptr<AutomationControl> gc = _amp->gain_control();
3410 XMLNode &before = gc->alist()->get_state ();
3411 gc->alist()->shift (pos, frames);
3412 XMLNode &after = gc->alist()->get_state ();
3413 _session.add_command (new MementoCommand<AutomationList> (*gc->alist().get(), &before, &after));
3416 /* pan automation */
3418 ControlSet::Controls& c (_pannable->controls());
3420 for (ControlSet::Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
3421 boost::shared_ptr<AutomationControl> pc = boost::dynamic_pointer_cast<AutomationControl> (ci->second);
3423 boost::shared_ptr<AutomationList> al = pc->alist();
3424 XMLNode& before = al->get_state ();
3425 al->shift (pos, frames);
3426 XMLNode& after = al->get_state ();
3427 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3432 /* redirect automation */
3434 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3435 for (ProcessorList::iterator i = _processors.begin (); i != _processors.end (); ++i) {
3437 set<Evoral::Parameter> parameters = (*i)->what_can_be_automated();
3439 for (set<Evoral::Parameter>::const_iterator p = parameters.begin (); p != parameters.end (); ++p) {
3440 boost::shared_ptr<AutomationControl> ac = (*i)->automation_control (*p);
3442 boost::shared_ptr<AutomationList> al = ac->alist();
3443 XMLNode &before = al->get_state ();
3444 al->shift (pos, frames);
3445 XMLNode &after = al->get_state ();
3446 _session.add_command (new MementoCommand<AutomationList> (*al.get(), &before, &after));
3455 Route::save_as_template (const string& path, const string& name)
3457 XMLNode& node (state (false));
3460 IO::set_name_in_state (*node.children().front(), name);
3462 tree.set_root (&node);
3463 return tree.write (path.c_str());
3468 Route::set_name (const string& str)
3474 name = Route::ensure_track_or_route_name (str, _session);
3475 SessionObject::set_name (name);
3477 ret = (_input->set_name(name) && _output->set_name(name));
3480 /* rename the main outs. Leave other IO processors
3481 * with whatever name they already have, because its
3482 * just fine as it is (it will not contain the route
3483 * name if its a port insert, port send or port return).
3487 if (_main_outs->set_name (name)) {
3488 /* XXX returning false here is stupid because
3489 we already changed the route name.
3499 /** Set the name of a route in an XML description.
3500 * @param node XML <Route> node to set the name in.
3501 * @param name New name.
3504 Route::set_name_in_state (XMLNode& node, string const & name)
3506 node.add_property (X_("name"), name);
3508 XMLNodeList children = node.children();
3509 for (XMLNodeIterator i = children.begin(); i != children.end(); ++i) {
3511 if ((*i)->name() == X_("IO")) {
3513 IO::set_name_in_state (**i, name);
3515 } else if ((*i)->name() == X_("Processor")) {
3517 XMLProperty* role = (*i)->property (X_("role"));
3518 if (role && role->value() == X_("Main")) {
3519 (*i)->add_property (X_("name"), name);
3522 } else if ((*i)->name() == X_("Diskstream")) {
3524 (*i)->add_property (X_("playlist"), string_compose ("%1.1", name).c_str());
3525 (*i)->add_property (X_("name"), name);
3531 boost::shared_ptr<Send>
3532 Route::internal_send_for (boost::shared_ptr<const Route> target) const
3534 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3536 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3537 boost::shared_ptr<InternalSend> send;
3539 if ((send = boost::dynamic_pointer_cast<InternalSend>(*i)) != 0) {
3540 if (send->target_route() == target) {
3546 return boost::shared_ptr<Send>();
3549 /** @param c Audio channel index.
3550 * @param yn true to invert phase, otherwise false.
3553 Route::set_phase_invert (uint32_t c, bool yn)
3555 if (_phase_invert[c] != yn) {
3556 _phase_invert[c] = yn;
3557 phase_invert_changed (); /* EMIT SIGNAL */
3558 _session.set_dirty ();
3563 Route::set_phase_invert (boost::dynamic_bitset<> p)
3565 if (_phase_invert != p) {
3567 phase_invert_changed (); /* EMIT SIGNAL */
3568 _session.set_dirty ();
3573 Route::phase_invert (uint32_t c) const
3575 return _phase_invert[c];
3578 boost::dynamic_bitset<>
3579 Route::phase_invert () const
3581 return _phase_invert;
3585 Route::set_denormal_protection (bool yn)
3587 if (_denormal_protection != yn) {
3588 _denormal_protection = yn;
3589 denormal_protection_changed (); /* EMIT SIGNAL */
3594 Route::denormal_protection () const
3596 return _denormal_protection;
3600 Route::set_active (bool yn, void* src)
3602 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_route_active()) {
3603 _route_group->foreach_route (boost::bind (&Route::set_active, _1, yn, _route_group));
3607 if (_active != yn) {
3609 _input->set_active (yn);
3610 _output->set_active (yn);
3611 active_changed (); // EMIT SIGNAL
3612 _session.set_dirty ();
3619 Glib::Threads::RWLock::ReaderLock rm (_processor_lock, Glib::Threads::TRY_LOCK);
3625 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3627 boost::shared_ptr<Send> s;
3628 boost::shared_ptr<Return> r;
3630 if ((s = boost::dynamic_pointer_cast<Send> (*i)) != 0) {
3631 s->meter()->meter();
3632 } else if ((r = boost::dynamic_pointer_cast<Return> (*i)) != 0) {
3633 r->meter()->meter ();
3638 boost::shared_ptr<Pannable>
3639 Route::pannable() const
3644 boost::shared_ptr<Panner>
3645 Route::panner() const
3648 return _main_outs->panner_shell()->panner();
3651 boost::shared_ptr<PannerShell>
3652 Route::panner_shell() const
3654 return _main_outs->panner_shell();
3657 boost::shared_ptr<AutomationControl>
3658 Route::gain_control() const
3660 return _amp->gain_control();
3663 boost::shared_ptr<AutomationControl>
3664 Route::get_control (const Evoral::Parameter& param)
3666 /* either we own the control or .... */
3668 boost::shared_ptr<AutomationControl> c = boost::dynamic_pointer_cast<AutomationControl>(control (param));
3672 /* maybe one of our processors does or ... */
3674 Glib::Threads::RWLock::ReaderLock rm (_processor_lock, Glib::Threads::TRY_LOCK);
3675 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3676 if ((c = boost::dynamic_pointer_cast<AutomationControl>((*i)->control (param))) != 0) {
3684 /* nobody does so we'll make a new one */
3686 c = boost::dynamic_pointer_cast<AutomationControl>(control_factory(param));
3693 boost::shared_ptr<Processor>
3694 Route::nth_plugin (uint32_t n)
3696 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3697 ProcessorList::iterator i;
3699 for (i = _processors.begin(); i != _processors.end(); ++i) {
3700 if (boost::dynamic_pointer_cast<PluginInsert> (*i)) {
3707 return boost::shared_ptr<Processor> ();
3710 boost::shared_ptr<Processor>
3711 Route::nth_send (uint32_t n)
3713 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3714 ProcessorList::iterator i;
3716 for (i = _processors.begin(); i != _processors.end(); ++i) {
3717 if (boost::dynamic_pointer_cast<Send> (*i)) {
3724 return boost::shared_ptr<Processor> ();
3728 Route::has_io_processor_named (const string& name)
3730 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3731 ProcessorList::iterator i;
3733 for (i = _processors.begin(); i != _processors.end(); ++i) {
3734 if (boost::dynamic_pointer_cast<Send> (*i) ||
3735 boost::dynamic_pointer_cast<PortInsert> (*i)) {
3736 if ((*i)->name() == name) {
3745 MuteMaster::MutePoint
3746 Route::mute_points () const
3748 return _mute_master->mute_points ();
3752 Route::set_processor_positions ()
3754 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3756 bool had_amp = false;
3757 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3758 (*i)->set_pre_fader (!had_amp);
3759 if (boost::dynamic_pointer_cast<Amp> (*i)) {
3765 /** Called when there is a proposed change to the input port count */
3767 Route::input_port_count_changing (ChanCount to)
3769 list<pair<ChanCount, ChanCount> > c = try_configure_processors (to, 0);
3771 /* The processors cannot be configured with the new input arrangement, so
3777 /* The change is ok */
3781 /** Called when there is a proposed change to the output port count */
3783 Route::output_port_count_changing (ChanCount to)
3785 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
3786 if (processor_out_streams.get(*t) > to.get(*t)) {
3790 /* The change is ok */
3795 Route::unknown_processors () const
3799 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
3800 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3801 if (boost::dynamic_pointer_cast<UnknownProcessor const> (*i)) {
3802 p.push_back ((*i)->name ());
3811 Route::update_port_latencies (PortSet& from, PortSet& to, bool playback, framecnt_t our_latency) const
3813 /* we assume that all our input ports feed all our output ports. its not
3814 universally true, but the alternative is way too corner-case to worry about.
3817 LatencyRange all_connections;
3820 all_connections.min = 0;
3821 all_connections.max = 0;
3823 all_connections.min = ~((pframes_t) 0);
3824 all_connections.max = 0;
3826 /* iterate over all "from" ports and determine the latency range for all of their
3827 connections to the "outside" (outside of this Route).
3830 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3834 p->get_connected_latency_range (range, playback);
3836 all_connections.min = min (all_connections.min, range.min);
3837 all_connections.max = max (all_connections.max, range.max);
3841 /* set the "from" port latencies to the max/min range of all their connections */
3843 for (PortSet::iterator p = from.begin(); p != from.end(); ++p) {
3844 p->set_private_latency_range (all_connections, playback);
3847 /* set the ports "in the direction of the flow" to the same value as above plus our own signal latency */
3849 all_connections.min += our_latency;
3850 all_connections.max += our_latency;
3852 for (PortSet::iterator p = to.begin(); p != to.end(); ++p) {
3853 p->set_private_latency_range (all_connections, playback);
3856 return all_connections.max;
3860 Route::set_private_port_latencies (bool playback) const
3862 framecnt_t own_latency = 0;
3864 /* Processor list not protected by lock: MUST BE CALLED FROM PROCESS THREAD
3865 OR LATENCY CALLBACK.
3867 This is called (early) from the latency callback. It computes the REAL
3868 latency associated with each port and stores the result as the "private"
3869 latency of the port. A later call to Route::set_public_port_latencies()
3870 sets all ports to the same value to reflect the fact that we do latency
3871 compensation and so all signals are delayed by the same amount as they
3872 flow through ardour.
3875 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
3876 if ((*i)->active ()) {
3877 own_latency += (*i)->signal_latency ();
3882 /* playback: propagate latency from "outside the route" to outputs to inputs */
3883 return update_port_latencies (_output->ports (), _input->ports (), true, own_latency);
3885 /* capture: propagate latency from "outside the route" to inputs to outputs */
3886 return update_port_latencies (_input->ports (), _output->ports (), false, own_latency);
3891 Route::set_public_port_latencies (framecnt_t value, bool playback) const
3893 /* this is called to set the JACK-visible port latencies, which take
3894 latency compensation into account.
3903 const PortSet& ports (_input->ports());
3904 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3905 p->set_public_latency_range (range, playback);
3910 const PortSet& ports (_output->ports());
3911 for (PortSet::const_iterator p = ports.begin(); p != ports.end(); ++p) {
3912 p->set_public_latency_range (range, playback);
3917 /** Put the invisible processors in the right place in _processors.
3918 * Must be called with a writer lock on _processor_lock held.
3921 Route::setup_invisible_processors ()
3924 Glib::Threads::RWLock::WriterLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
3925 assert (!lm.locked ());
3929 /* too early to be doing this stuff */
3933 /* we'll build this new list here and then use it */
3935 ProcessorList new_processors;
3937 /* find visible processors */
3939 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
3940 if ((*i)->display_to_user ()) {
3941 new_processors.push_back (*i);
3947 ProcessorList::iterator amp = new_processors.begin ();
3948 while (amp != new_processors.end() && boost::dynamic_pointer_cast<Amp> (*amp) == 0) {
3952 assert (amp != _processors.end ());
3954 /* and the processor after the amp */
3956 ProcessorList::iterator after_amp = amp;
3962 switch (_meter_point) {
3964 assert (!_meter->display_to_user ());
3965 new_processors.push_front (_meter);
3968 assert (!_meter->display_to_user ());
3969 new_processors.insert (amp, _meter);
3971 case MeterPostFader:
3972 /* do nothing here */
3975 /* do nothing here */
3978 /* the meter is visible, so we don't touch it here */
3985 assert (_main_outs);
3986 assert (!_main_outs->display_to_user ());
3987 new_processors.push_back (_main_outs);
3989 /* iterator for the main outs */
3991 ProcessorList::iterator main = new_processors.end();
3994 /* OUTPUT METERING */
3996 if (_meter && (_meter_point == MeterOutput || _meter_point == MeterPostFader)) {
3997 assert (!_meter->display_to_user ());
3999 /* add the processor just before or just after the main outs */
4001 ProcessorList::iterator meter_point = main;
4003 if (_meter_point == MeterOutput) {
4006 new_processors.insert (meter_point, _meter);
4011 if (_monitor_send && !is_monitor ()) {
4012 assert (!_monitor_send->display_to_user ());
4013 if (Config->get_solo_control_is_listen_control()) {
4014 switch (Config->get_listen_position ()) {
4015 case PreFaderListen:
4016 switch (Config->get_pfl_position ()) {
4017 case PFLFromBeforeProcessors:
4018 new_processors.push_front (_monitor_send);
4020 case PFLFromAfterProcessors:
4021 new_processors.insert (amp, _monitor_send);
4024 _monitor_send->set_can_pan (false);
4026 case AfterFaderListen:
4027 switch (Config->get_afl_position ()) {
4028 case AFLFromBeforeProcessors:
4029 new_processors.insert (after_amp, _monitor_send);
4031 case AFLFromAfterProcessors:
4032 new_processors.insert (new_processors.end(), _monitor_send);
4035 _monitor_send->set_can_pan (true);
4039 new_processors.insert (new_processors.end(), _monitor_send);
4040 _monitor_send->set_can_pan (false);
4044 /* MONITOR CONTROL */
4046 if (_monitor_control && is_monitor ()) {
4047 assert (!_monitor_control->display_to_user ());
4048 new_processors.push_front (_monitor_control);
4051 /* INTERNAL RETURN */
4053 /* doing this here means that any monitor control will come just after
4058 assert (!_intreturn->display_to_user ());
4059 new_processors.push_front (_intreturn);
4062 /* EXPORT PROCESSOR */
4064 if (_capturing_processor) {
4065 assert (!_capturing_processor->display_to_user ());
4066 new_processors.push_front (_capturing_processor);
4069 _processors = new_processors;
4071 DEBUG_TRACE (DEBUG::Processors, string_compose ("%1: setup_invisible_processors\n", _name));
4072 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4073 DEBUG_TRACE (DEBUG::Processors, string_compose ("\t%1\n", (*i)->name ()));
4080 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
4081 Glib::Threads::RWLock::ReaderLock lp (_processor_lock);
4085 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4086 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery>(*i);
4093 /** If the meter point is `Custom', make a note of where the meter is.
4094 * This is so that if the meter point is subsequently set to something else,
4095 * and then back to custom, we can put the meter back where it was last time
4096 * custom was enabled.
4098 * Must be called with the _processor_lock held.
4101 Route::maybe_note_meter_position ()
4103 if (_meter_point != MeterCustom) {
4107 _custom_meter_position_noted = true;
4108 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4109 if (boost::dynamic_pointer_cast<PeakMeter> (*i)) {
4110 ProcessorList::iterator j = i;
4112 if (j != _processors.end ()) {
4113 _processor_after_last_custom_meter = *j;
4114 _last_custom_meter_was_at_end = false;
4116 _last_custom_meter_was_at_end = true;
4122 boost::shared_ptr<Processor>
4123 Route::processor_by_id (PBD::ID id) const
4125 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
4126 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4127 if ((*i)->id() == id) {
4132 return boost::shared_ptr<Processor> ();
4135 /** @return the monitoring state, or in other words what data we are pushing
4136 * into the route (data from the inputs, data from disk or silence)
4139 Route::monitoring_state () const
4141 return MonitoringInput;
4144 /** @return what we should be metering; either the data coming from the input
4145 * IO or the data that is flowing through the route.
4148 Route::metering_state () const
4150 return MeteringRoute;
4154 Route::has_external_redirects () const
4156 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4158 /* ignore inactive processors and obviously ignore the main
4159 * outs since everything has them and we don't care.
4162 if ((*i)->active() && (*i) != _main_outs && (*i)->does_routing()) {
4170 boost::shared_ptr<Processor>
4171 Route::the_instrument () const
4173 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
4174 return the_instrument_unlocked ();
4177 boost::shared_ptr<Processor>
4178 Route::the_instrument_unlocked () const
4180 for (ProcessorList::const_iterator i = _processors.begin(); i != _processors.end(); ++i) {
4181 if (boost::dynamic_pointer_cast<PluginInsert>(*i)) {
4182 if ((*i)->input_streams().n_midi() > 0 &&
4183 (*i)->output_streams().n_audio() > 0) {
4188 return boost::shared_ptr<Processor>();
4194 Route::non_realtime_locate (framepos_t pos)
4197 _pannable->transport_located (pos);
4201 Glib::Threads::RWLock::WriterLock lm (_processor_lock);
4203 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
4204 (*i)->transport_located (pos);
4210 Route::fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes)
4217 * We don't currently mix MIDI input together, so we don't need the
4218 * complex logic of the audio case.
4221 n_buffers = bufs.count().n_midi ();
4223 for (i = 0; i < n_buffers; ++i) {
4225 boost::shared_ptr<MidiPort> source_port = io->midi (i);
4226 MidiBuffer& buf (bufs.get_midi (i));
4229 buf.copy (source_port->get_midi_buffer(nframes));
4231 buf.silence (nframes);
4237 n_buffers = bufs.count().n_audio();
4239 size_t n_ports = io->n_ports().n_audio();
4240 float scaling = 1.0f;
4242 if (n_ports > n_buffers) {
4243 scaling = ((float) n_buffers) / n_ports;
4246 for (i = 0; i < n_ports; ++i) {
4248 /* if there are more ports than buffers, map them onto buffers
4249 * in a round-robin fashion
4252 boost::shared_ptr<AudioPort> source_port = io->audio (i);
4253 AudioBuffer& buf (bufs.get_audio (i%n_buffers));
4256 if (i < n_buffers) {
4258 /* first time through just copy a channel into
4262 buf.read_from (source_port->get_audio_buffer (nframes), nframes);
4264 if (scaling != 1.0f) {
4265 buf.apply_gain (scaling, nframes);
4270 /* on subsequent times around, merge data from
4271 * the port with what is already there
4274 if (scaling != 1.0f) {
4275 buf.accumulate_with_gain_from (source_port->get_audio_buffer (nframes), nframes, 0, scaling);
4277 buf.accumulate_from (source_port->get_audio_buffer (nframes), nframes);
4282 /* silence any remaining buffers */
4284 for (; i < n_buffers; ++i) {
4285 AudioBuffer& buf (bufs.get_audio (i));
4286 buf.silence (nframes);
4289 /* establish the initial setup of the buffer set, reflecting what was
4290 copied into it. unless, of course, we are the auditioner, in which
4291 case nothing was fed into it from the inputs at all.
4294 if (!is_auditioner()) {
4295 bufs.set_count (io->n_ports());