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>
33 #include <glibmm/thread.h>
34 #include "pbd/fastlog.h"
35 #include "pbd/xml++.h"
37 #include "pbd/stateful.h"
38 #include "pbd/controllable.h"
39 #include "pbd/destructible.h"
41 #include "ardour/ardour.h"
42 #include "ardour/io.h"
43 #include "ardour/types.h"
44 #include "ardour/mute_master.h"
45 #include "ardour/route_group_member.h"
58 class Route : public SessionObject, public AutomatableControls, public RouteGroupMember
62 typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
70 Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
71 Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
74 boost::shared_ptr<IO> input() const { return _input; }
75 boost::shared_ptr<IO> output() const { return _output; }
77 ChanCount n_inputs() const { return _input->n_ports(); }
78 ChanCount n_outputs() const { return _output->n_ports(); }
80 bool active() const { return _active; }
81 void set_active (bool yn);
84 static std::string ensure_track_or_route_name(std::string, Session &);
86 std::string comment() { return _comment; }
87 void set_comment (std::string str, void *src);
89 bool set_name (const std::string& str);
91 long order_key (std::string const &) const;
92 void set_order_key (std::string const &, long);
94 bool is_hidden() const { return _flags & Hidden; }
95 bool is_master() const { return _flags & MasterOut; }
96 bool is_control() const { return _flags & ControlOut; }
98 /* these are the core of the API of a Route. see the protected sections as well */
100 virtual int roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
101 int declick, bool can_record, bool rec_monitors_input);
103 virtual int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
104 bool state_changing, bool can_record, bool rec_monitors_input);
106 virtual int silent_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
107 bool can_record, bool rec_monitors_input);
109 virtual void toggle_monitor_input ();
110 virtual bool can_record() { return false; }
112 virtual void set_record_enable (bool /*yn*/, void * /*src*/) {}
113 virtual bool record_enabled() const { return false; }
114 virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
115 virtual void set_pending_declick (int);
117 /* end of vfunc-based API */
119 void shift (nframes64_t, nframes64_t);
121 void set_gain (gain_t val, void *src);
122 void inc_gain (gain_t delta, void *src);
124 void set_mute_points (MuteMaster::MutePoint);
125 MuteMaster::MutePoint mute_points() const { return _mute_points; }
126 void set_mute (bool yn, void* src);
129 /* controls use set_solo() to modify this route's solo state
132 void set_solo (bool yn, void *src);
133 bool soloed () const { return self_soloed () || soloed_by_others (); }
135 bool soloed_by_others () const { return !_solo_isolated && _soloed_by_others; }
136 bool self_soloed () const { return _self_solo; }
138 void set_solo_isolated (bool yn, void *src);
139 bool solo_isolated() const;
141 void set_solo_safe (bool yn, void *src);
142 bool solo_safe() const;
144 void set_listen (bool yn, void* src);
145 bool listening () const;
147 void set_phase_invert (bool yn);
148 bool phase_invert() const;
150 void set_denormal_protection (bool yn);
151 bool denormal_protection() const;
153 void set_meter_point (MeterPoint, void *src);
154 MeterPoint meter_point() const { return _meter_point; }
159 boost::shared_ptr<Amp> amp() const { return _amp; }
160 PeakMeter& peak_meter() { return *_meter.get(); }
161 const PeakMeter& peak_meter() const { return *_meter.get(); }
162 boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
164 void flush_processors ();
166 void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
167 Glib::RWLock::ReaderLock lm (_processor_lock);
168 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
169 method (boost::weak_ptr<Processor> (*i));
173 boost::shared_ptr<Processor> nth_processor (uint32_t n) {
174 Glib::RWLock::ReaderLock lm (_processor_lock);
175 ProcessorList::iterator i;
176 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
177 if (i == _processors.end()) {
178 return boost::shared_ptr<Processor> ();
184 boost::shared_ptr<Processor> nth_plugin (uint32_t n);
185 boost::shared_ptr<Processor> nth_send (uint32_t n);
187 bool processor_is_prefader (boost::shared_ptr<Processor> p);
189 ChanCount max_processor_streams () const { return processor_max_streams; }
191 /* special processors */
193 boost::shared_ptr<Delivery> control_outs() const { return _control_outs; }
194 boost::shared_ptr<Delivery> main_outs() const { return _main_outs; }
195 boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
196 boost::shared_ptr<Send> internal_send_for (boost::shared_ptr<const Route> target) const;
197 void add_internal_return ();
198 BufferSet* get_return_buffer () const;
199 void release_return_buffer () const;
200 void put_control_outs_at (Placement);
202 /** A record of the stream configuration at some point in the processor list.
203 * Used to return where and why an processor list configuration request failed.
205 struct ProcessorStreams {
206 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
208 uint32_t index; ///< Index of processor where configuration failed
209 ChanCount count; ///< Input requested of processor
212 int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
213 int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0);
214 int add_processors (const ProcessorList&, boost::shared_ptr<Processor> before, ProcessorStreams* err = 0);
215 int add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
216 int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
217 int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
218 int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
219 void disable_processors (Placement);
220 void disable_processors ();
221 void disable_plugins (Placement);
222 void disable_plugins ();
223 void ab_plugins (bool forward);
224 void clear_processors (Placement);
225 void all_processors_flip();
226 void all_processors_active (Placement, bool state);
228 virtual nframes_t update_total_latency();
229 void set_latency_delay (nframes_t);
230 void set_user_latency (nframes_t);
231 nframes_t initial_delay() const { return _initial_delay; }
233 PBD::Signal0<void> active_changed;
234 PBD::Signal0<void> phase_invert_changed;
235 PBD::Signal0<void> denormal_protection_changed;
236 PBD::Signal1<void,void*> listen_changed;
237 PBD::Signal1<void,void*> solo_changed;
238 PBD::Signal1<void,void*> solo_safe_changed;
239 PBD::Signal1<void,void*> solo_isolated_changed;
240 PBD::Signal1<void,void*> comment_changed;
241 PBD::Signal1<void,void*> mute_changed;
242 PBD::Signal0<void> mute_points_changed;
244 /** the processors have changed; the parameter indicates what changed */
245 PBD::Signal1<void,RouteProcessorChange> processors_changed;
246 PBD::Signal1<void,void*> record_enable_changed;
247 /** the metering point has changed */
248 PBD::Signal1<void,void*> meter_change;
249 PBD::Signal0<void> signal_latency_changed;
250 PBD::Signal0<void> initial_delay_changed;
252 /* gui's call this for their own purposes. */
254 PBD::Signal2<void,std::string,void*> gui_changed;
258 XMLNode& get_state();
259 int set_state (const XMLNode&, int version);
260 virtual XMLNode& get_template();
262 XMLNode& get_processor_state ();
263 virtual void set_processor_state (const XMLNode&);
265 int save_as_template (const std::string& path, const std::string& name);
267 PBD::Signal1<void,void*> SelectedChanged;
269 int listen_via (boost::shared_ptr<Route>, Placement p, bool active, bool aux);
270 void drop_listen (boost::shared_ptr<Route>);
272 bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
273 std::set<boost::weak_ptr<Route> > fed_by;
275 /* Controls (not all directly owned by the Route */
277 boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
279 struct SoloControllable : public AutomationControl {
280 SoloControllable (std::string name, Route&);
281 void set_value (float);
282 float get_value (void) const;
287 boost::shared_ptr<AutomationControl> solo_control() const {
288 return _solo_control;
291 boost::shared_ptr<AutomationControl> mute_control() const {
295 boost::shared_ptr<MuteMaster> mute_master() const {
299 /* Route doesn't own these items, but sub-objects that it does own have them
300 and to make UI code a bit simpler, we provide direct access to them
304 boost::shared_ptr<Panner> panner() const;
305 boost::shared_ptr<AutomationControl> gain_control() const;
307 void automation_snapshot (nframes_t now, bool force=false);
308 void protect_automation ();
310 void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
311 uint32_t remote_control_id () const;
313 /* for things concerned about *this* route's RID */
315 PBD::Signal0<void> RemoteControlIDChanged;
317 /* for things concerned about any route's RID changes */
319 static PBD::Signal0<void> RemoteControlIDChange;
321 void sync_order_keys (std::string const &);
322 static PBD::Signal1<void,std::string const &> SyncOrderKeys;
325 friend class Session;
327 void catch_up_on_solo_mute_override ();
328 void mod_solo_by_others (int32_t);
329 void set_block_size (nframes_t nframes);
330 bool has_external_redirects() const;
331 void curve_reallocate ();
332 void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
335 nframes_t check_initial_delay (nframes_t, nframes_t&);
337 void passthru (sframes_t start_frame, sframes_t end_frame,
338 nframes_t nframes, int declick);
340 virtual void write_out_of_band_data (BufferSet& /* bufs */, sframes_t /* start_frame */, sframes_t /* end_frame */,
341 nframes_t /* nframes */) {}
343 virtual void process_output_buffers (BufferSet& bufs,
344 sframes_t start_frame, sframes_t end_frame,
345 nframes_t nframes, bool with_processors, int declick);
347 boost::shared_ptr<IO> _input;
348 boost::shared_ptr<IO> _output;
351 nframes_t _initial_delay;
352 nframes_t _roll_delay;
354 ProcessorList _processors;
355 mutable Glib::RWLock _processor_lock;
356 boost::shared_ptr<Delivery> _main_outs;
357 boost::shared_ptr<Delivery> _control_outs;
358 boost::shared_ptr<InternalReturn> _intreturn;
361 int _pending_declick;
362 MeterPoint _meter_point;
363 uint32_t _phase_invert;
365 uint32_t _soloed_by_others;
366 uint32_t _solo_isolated;
368 bool _denormal_protection;
370 bool _recordable : 1;
372 bool _declickable : 1;
374 boost::shared_ptr<SoloControllable> _solo_control;
375 boost::shared_ptr<MuteMaster> _mute_master;
376 MuteMaster::MutePoint _mute_points;
378 std::string _comment;
379 bool _have_internal_generator;
381 DataType _default_type;
385 virtual XMLNode& state(bool);
387 void passthru_silence (sframes_t start_frame, sframes_t end_frame,
388 nframes_t nframes, int declick);
390 void silence (nframes_t nframes);
392 ChanCount processor_max_streams;
393 uint32_t _remote_control_id;
395 uint32_t pans_required() const;
396 ChanCount n_process_buffers ();
398 virtual int _set_state (const XMLNode&, int, bool call_base);
400 boost::shared_ptr<Amp> _amp;
401 boost::shared_ptr<PeakMeter> _meter;
405 int _set_state_2X (const XMLNode&, int);
406 void set_processor_state_2X (XMLNodeList const &, int);
408 static uint32_t order_key_cnt;
410 typedef std::map<std::string, long> OrderKeys;
411 OrderKeys order_keys;
413 void input_change_handler (IOChange, void *src);
414 void output_change_handler (IOChange, void *src);
416 bool _in_configure_processors;
418 int configure_processors (ProcessorStreams*);
419 int configure_processors_unlocked (ProcessorStreams*);
421 bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);
422 bool add_processor_from_xml_2X (const XMLNode&, int, ProcessorList::iterator iter);
424 void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
426 void set_self_solo (bool yn);
427 void set_delivery_solo ();
430 } // namespace ARDOUR
432 #endif /* __ardour_route_h__ */