2 Copyright (C) 2000-2002 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.
20 #ifndef __ardour_route_h__
21 #define __ardour_route_h__
30 #include <boost/shared_ptr.hpp>
31 #include <boost/weak_ptr.hpp>
32 #include <boost/dynamic_bitset.hpp>
33 #include <boost/enable_shared_from_this.hpp>
35 #include <glibmm/threads.h>
36 #include "pbd/fastlog.h"
37 #include "pbd/xml++.h"
39 #include "pbd/stateful.h"
40 #include "pbd/controllable.h"
41 #include "pbd/destructible.h"
43 #include "ardour/ardour.h"
44 #include "ardour/instrument_info.h"
45 #include "ardour/io.h"
46 #include "ardour/libardour_visibility.h"
47 #include "ardour/types.h"
48 #include "ardour/mute_master.h"
49 #include "ardour/route_group_member.h"
50 #include "ardour/graphnode.h"
51 #include "ardour/automatable.h"
52 #include "ardour/unknown_processor.h"
66 class MonitorProcessor;
68 class CapturingProcessor;
71 class LIBARDOUR_API Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
75 typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
83 Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
88 boost::shared_ptr<IO> input() const { return _input; }
89 boost::shared_ptr<IO> output() const { return _output; }
91 ChanCount n_inputs() const { return _input->n_ports(); }
92 ChanCount n_outputs() const { return _output->n_ports(); }
94 bool active() const { return _active; }
95 void set_active (bool yn, void *);
97 static std::string ensure_track_or_route_name(std::string, Session &);
99 std::string comment() { return _comment; }
100 void set_comment (std::string str, void *src);
102 bool set_name (const std::string& str);
103 static void set_name_in_state (XMLNode &, const std::string &);
105 uint32_t order_key () const;
106 bool has_order_key () const;
107 void set_order_key (uint32_t);
109 bool is_auditioner() const { return _flags & Auditioner; }
110 bool is_master() const { return _flags & MasterOut; }
111 bool is_monitor() const { return _flags & MonitorOut; }
113 virtual MonitorState monitoring_state () const;
114 virtual MeterState metering_state () const;
116 /* these are the core of the API of a Route. see the protected sections as well */
118 virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
119 int declick, bool& need_butler);
121 virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
122 bool state_changing);
124 virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
127 virtual bool can_record() { return false; }
129 virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
130 virtual bool record_enabled() const { return false; }
131 virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
132 virtual void realtime_handle_transport_stopped () {}
133 virtual void realtime_locate () {}
134 virtual void non_realtime_locate (framepos_t);
135 virtual void set_pending_declick (int);
137 /* end of vfunc-based API */
139 void shift (framepos_t, framecnt_t);
141 void set_gain (gain_t val, void *src);
142 void inc_gain (gain_t delta, void *src);
144 void set_mute_points (MuteMaster::MutePoint);
145 MuteMaster::MutePoint mute_points () const;
148 void set_mute (bool yn, void* src);
150 /* controls use set_solo() to modify this route's solo state
153 void set_solo (bool yn, void *src);
154 bool soloed () const { return self_soloed () || soloed_by_others (); }
155 void cancel_solo_after_disconnect (bool upstream);
157 bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
158 bool soloed_by_others_upstream () const { return _soloed_by_others_upstream; }
159 bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
160 bool self_soloed () const { return _self_solo; }
162 void set_solo_isolated (bool yn, void *src);
163 bool solo_isolated() const;
165 void set_solo_safe (bool yn, void *src);
166 bool solo_safe() const;
168 void set_listen (bool yn, void* src);
169 bool listening_via_monitor () const;
170 void enable_monitor_send ();
172 void set_phase_invert (uint32_t, bool yn);
173 void set_phase_invert (boost::dynamic_bitset<>);
174 bool phase_invert (uint32_t) const;
175 boost::dynamic_bitset<> phase_invert () const;
177 void set_denormal_protection (bool yn);
178 bool denormal_protection() const;
180 void set_meter_point (MeterPoint, bool force = false);
181 MeterPoint meter_point() const { return _meter_point; }
184 void set_meter_type (MeterType t) { _meter_type = t; }
185 MeterType meter_type() const { return _meter_type; }
189 boost::shared_ptr<Amp> amp() const { return _amp; }
190 PeakMeter& peak_meter() { return *_meter.get(); }
191 const PeakMeter& peak_meter() const { return *_meter.get(); }
192 boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
194 void flush_processors ();
196 void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
197 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
198 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
199 if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
202 method (boost::weak_ptr<Processor> (*i));
206 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
207 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
208 ProcessorList::iterator i;
209 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
210 if (i == _processors.end()) {
211 return boost::shared_ptr<Processor> ();
217 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
219 boost::shared_ptr<Processor> nth_plugin (uint32_t n);
220 boost::shared_ptr<Processor> nth_send (uint32_t n);
222 bool has_io_processor_named (const std::string&);
223 ChanCount max_processor_streams () const { return processor_max_streams; }
225 std::list<std::string> unknown_processors () const;
227 /* special processors */
229 boost::shared_ptr<InternalSend> monitor_send() const { return _monitor_send; }
230 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
231 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
232 boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
233 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
234 void add_internal_return ();
235 void add_send_to_internal_return (InternalSend *);
236 void remove_send_from_internal_return (InternalSend *);
237 void listen_position_changed ();
238 boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
240 /** A record of the stream configuration at some point in the processor list.
241 * Used to return where and why an processor list configuration request failed.
243 struct ProcessorStreams {
244 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
246 uint32_t index; ///< Index of processor where configuration failed
247 ChanCount count; ///< Input requested of processor
250 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
251 int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
252 int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
253 int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
254 boost::shared_ptr<Processor> before_processor_for_placement (Placement);
255 boost::shared_ptr<Processor> before_processor_for_index (int);
256 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool need_process_lock = true);
257 int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
258 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
259 void disable_processors (Placement);
260 void disable_processors ();
261 void disable_plugins (Placement);
262 void disable_plugins ();
263 void ab_plugins (bool forward);
264 void clear_processors (Placement);
265 void all_visible_processors_active (bool);
267 framecnt_t set_private_port_latencies (bool playback) const;
268 void set_public_port_latencies (framecnt_t, bool playback) const;
270 framecnt_t update_signal_latency();
271 virtual void set_latency_compensation (framecnt_t);
273 void set_user_latency (framecnt_t);
274 framecnt_t initial_delay() const { return _initial_delay; }
275 framecnt_t signal_latency() const { return _signal_latency; }
277 PBD::Signal0<void> active_changed;
278 PBD::Signal0<void> phase_invert_changed;
279 PBD::Signal0<void> denormal_protection_changed;
280 PBD::Signal1<void,void*> listen_changed;
281 PBD::Signal2<void,bool,void*> solo_changed;
282 PBD::Signal1<void,void*> solo_safe_changed;
283 PBD::Signal1<void,void*> solo_isolated_changed;
284 PBD::Signal1<void,void*> comment_changed;
285 PBD::Signal1<void,void*> mute_changed;
286 PBD::Signal0<void> mute_points_changed;
288 /** the processors have changed; the parameter indicates what changed */
289 PBD::Signal1<void,RouteProcessorChange> processors_changed;
290 PBD::Signal1<void,void*> record_enable_changed;
291 /** the metering point has changed */
292 PBD::Signal0<void> meter_change;
293 PBD::Signal0<void> signal_latency_changed;
294 PBD::Signal0<void> initial_delay_changed;
296 /** Emitted with the process lock held */
297 PBD::Signal0<void> io_changed;
299 /* gui's call this for their own purposes. */
301 PBD::Signal2<void,std::string,void*> gui_changed;
305 XMLNode& get_state();
306 virtual int set_state (const XMLNode&, int version);
307 virtual XMLNode& get_template();
309 XMLNode& get_processor_state ();
310 virtual void set_processor_state (const XMLNode&);
312 int save_as_template (const std::string& path, const std::string& name);
314 PBD::Signal1<void,void*> SelectedChanged;
316 int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
317 void remove_aux_or_listen (boost::shared_ptr<Route>);
320 * return true if this route feeds the first argument via at least one
321 * (arbitrarily long) signal pathway.
323 bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
326 * return true if this route feeds the first argument directly, via
327 * either its main outs or a send. This is checked by the actual
328 * connections, rather than by what the graph is currently doing.
330 bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
333 * return true if this route feeds the first argument directly, via
334 * either its main outs or a send, according to the graph that
335 * is currently being processed.
337 bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
340 boost::weak_ptr<Route> r;
343 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
345 , sends_only (sendsonly) {}
348 struct FeedRecordCompare {
349 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
354 typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
356 const FedBy& fed_by() const { return _fed_by; }
357 void clear_fed_by ();
358 bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
360 /* Controls (not all directly owned by the Route */
362 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
364 class SoloControllable : public AutomationControl {
366 SoloControllable (std::string name, boost::shared_ptr<Route>);
367 void set_value (double);
368 double get_value () const;
371 boost::weak_ptr<Route> _route;
374 struct MuteControllable : public AutomationControl {
376 MuteControllable (std::string name, boost::shared_ptr<Route>);
377 void set_value (double);
378 double get_value () const;
381 boost::weak_ptr<Route> _route;
384 boost::shared_ptr<AutomationControl> solo_control() const {
385 return _solo_control;
388 boost::shared_ptr<AutomationControl> mute_control() const {
389 return _mute_control;
392 boost::shared_ptr<MuteMaster> mute_master() const {
396 /* Route doesn't own these items, but sub-objects that it does own have them
397 and to make UI code a bit simpler, we provide direct access to them
401 boost::shared_ptr<Panner> panner() const; /* may return null */
402 boost::shared_ptr<PannerShell> panner_shell() const;
403 boost::shared_ptr<AutomationControl> gain_control() const;
404 boost::shared_ptr<Pannable> pannable() const;
407 Return the first processor that accepts has at least one MIDI input
408 and at least one audio output. In the vast majority of cases, this
409 will be "the instrument". This does not preclude other MIDI->audio
410 processors later in the processing chain, but that would be a
411 special case not covered by this utility function.
413 boost::shared_ptr<Processor> the_instrument() const;
414 InstrumentInfo& instrument_info() { return _instrument_info; }
416 void protect_automation ();
419 /* These numbers are taken from MIDI Machine Control,
420 which can only control up to 317 tracks without
421 doing sysex segmentation.
423 MasterBusRemoteControlID = 318,
424 MonitorBusRemoteControlID = 319,
427 void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
428 uint32_t remote_control_id () const;
429 void set_remote_control_id_explicit (uint32_t order_key);
431 /* for things concerned about *this* route's RID */
433 PBD::Signal0<void> RemoteControlIDChanged;
435 /* for things concerned about *any* route's RID changes */
437 static PBD::Signal0<void> RemoteControlIDChange;
438 static PBD::Signal0<void> SyncOrderKeys;
440 bool has_external_redirects() const;
442 /* can only be executed by a route for which is_monitor() is true
443 (i.e. the monitor out)
445 void monitor_run (framepos_t start_frame, framepos_t end_frame,
446 pframes_t nframes, int declick);
449 friend class Session;
451 void catch_up_on_solo_mute_override ();
452 void mod_solo_by_others_upstream (int32_t);
453 void mod_solo_by_others_downstream (int32_t);
454 void curve_reallocate ();
455 virtual void set_block_size (pframes_t nframes);
458 virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
460 void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
462 void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
463 pframes_t nframes, int declick);
465 virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
466 framecnt_t /* nframes */) {}
468 virtual void process_output_buffers (BufferSet& bufs,
469 framepos_t start_frame, framepos_t end_frame,
470 pframes_t nframes, int declick,
471 bool gain_automation_ok);
473 boost::shared_ptr<IO> _input;
474 boost::shared_ptr<IO> _output;
477 framecnt_t _signal_latency;
478 framecnt_t _initial_delay;
479 framecnt_t _roll_delay;
481 ProcessorList _processors;
482 mutable Glib::Threads::RWLock _processor_lock;
483 boost::shared_ptr<Delivery> _main_outs;
484 boost::shared_ptr<InternalSend> _monitor_send;
485 boost::shared_ptr<InternalReturn> _intreturn;
486 boost::shared_ptr<MonitorProcessor> _monitor_control;
487 boost::shared_ptr<Pannable> _pannable;
490 int _pending_declick;
491 MeterPoint _meter_point;
492 MeterType _meter_type;
493 boost::dynamic_bitset<> _phase_invert;
495 uint32_t _soloed_by_others_upstream;
496 uint32_t _soloed_by_others_downstream;
497 uint32_t _solo_isolated;
499 bool _denormal_protection;
501 bool _recordable : 1;
503 bool _declickable : 1;
505 boost::shared_ptr<SoloControllable> _solo_control;
506 boost::shared_ptr<MuteControllable> _mute_control;
507 boost::shared_ptr<MuteMaster> _mute_master;
509 virtual void act_on_mute () {}
511 std::string _comment;
512 bool _have_internal_generator;
514 DataType _default_type;
517 InstrumentInfo _instrument_info;
519 virtual ChanCount input_streams () const;
522 virtual XMLNode& state(bool);
524 int configure_processors (ProcessorStreams*);
526 void passthru_silence (framepos_t start_frame, framepos_t end_frame,
527 pframes_t nframes, int declick);
529 void silence (framecnt_t);
530 void silence_unlocked (framecnt_t);
532 ChanCount processor_max_streams;
533 ChanCount processor_out_streams;
535 uint32_t pans_required() const;
536 ChanCount n_process_buffers ();
538 virtual void maybe_declick (BufferSet&, framecnt_t, int);
540 boost::shared_ptr<Amp> _amp;
541 boost::shared_ptr<PeakMeter> _meter;
543 boost::shared_ptr<Processor> the_instrument_unlocked() const;
546 int set_state_2X (const XMLNode&, int);
547 void set_processor_state_2X (XMLNodeList const &, int);
551 uint32_t _remote_control_id;
553 void input_change_handler (IOChange, void *src);
554 void output_change_handler (IOChange, void *src);
556 bool input_port_count_changing (ChanCount);
557 bool output_port_count_changing (ChanCount);
559 bool _in_configure_processors;
560 bool _initial_io_setup;
562 int configure_processors_unlocked (ProcessorStreams*);
563 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
564 std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
566 bool add_processor_from_xml_2X (const XMLNode&, int);
568 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
570 void set_self_solo (bool yn);
571 void set_mute_master_solo ();
573 void set_processor_positions ();
574 framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
576 void setup_invisible_processors ();
579 boost::shared_ptr<CapturingProcessor> _capturing_processor;
581 /** A handy class to keep processor state while we attempt a reconfiguration
584 class ProcessorState {
586 ProcessorState (Route* r)
588 , _processors (r->_processors)
589 , _processor_max_streams (r->processor_max_streams)
593 _route->_processors = _processors;
594 _route->processor_max_streams = _processor_max_streams;
598 /* this should perhaps be a shared_ptr, but ProcessorStates will
599 not hang around long enough for it to matter.
602 ProcessorList _processors;
603 ChanCount _processor_max_streams;
606 friend class ProcessorState;
608 /* no copy construction */
609 Route (Route const &);
611 void maybe_note_meter_position ();
613 /** true if we've made a note of a custom meter position in these variables */
614 bool _custom_meter_position_noted;
615 /** the processor that came after the meter when it was last set to a custom position,
618 boost::weak_ptr<Processor> _processor_after_last_custom_meter;
619 /** true if the last custom meter position was at the end of the processor list */
620 bool _last_custom_meter_was_at_end;
622 void reset_instrument_info ();
624 void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
627 } // namespace ARDOUR
629 #endif /* __ardour_route_h__ */