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.
21 #ifndef __ardour_route_h__
22 #define __ardour_route_h__
32 #include <pbd/atomic.h>
33 #include <pbd/fastlog.h>
34 #include <pbd/lockmonitor.h>
35 #include <pbd/xml++.h>
37 #include <midi++/controllable.h>
39 #include <ardour/ardour.h>
40 #include <ardour/stateful.h>
41 #include <ardour/io.h>
42 #include <ardour/session.h>
43 #include <ardour/redirect.h>
58 class Route : public IO
62 typedef list<Redirect *> RedirectList;
72 Route (Session&, std::string name, int input_min, int input_max, int output_min, int output_max, Flag flags = Flag(0));
73 Route (Session&, const XMLNode&);
76 std::string comment() { return _comment; }
77 void set_comment (std::string str, void *src);
79 long order_key(std::string name) const;
80 void set_order_key (std::string name, long n);
82 bool hidden() const { return _flags & Hidden; }
83 bool master() const { return _flags & MasterOut; }
84 bool control() const { return _flags & ControlOut; }
86 /* these are the core of the API of a Route. see the protected sections as well */
89 virtual int roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame,
90 jack_nframes_t offset, int declick, bool can_record, bool rec_monitors_input);
92 virtual int no_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame,
93 jack_nframes_t offset, bool state_changing, bool can_record, bool rec_monitors_input);
95 virtual int silent_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame,
96 jack_nframes_t offset, bool can_record, bool rec_monitors_input);
97 virtual void toggle_monitor_input ();
98 virtual bool can_record() const { return false; }
99 virtual void set_record_enable (bool yn, void *src) {}
100 virtual bool record_enabled() const { return false; }
101 virtual void transport_stopped (bool abort, bool did_locate, bool flush_redirects);
102 virtual void set_pending_declick (int);
104 /* end of vfunc-based API */
106 /* override IO::set_gain() to provide group control */
108 void set_gain (gain_t val, void *src);
109 void inc_gain (gain_t delta, void *src);
111 bool active() const { return _active; }
112 void set_active (bool yn);
114 void set_solo (bool yn, void *src);
115 bool soloed() const { return _soloed; }
117 void set_solo_safe (bool yn, void *src);
118 bool solo_safe() const { return _solo_safe; }
120 void set_mute (bool yn, void *src);
121 bool muted() const { return _muted; }
123 void set_mute_config (mute_type, bool, void *src);
124 bool get_mute_config (mute_type);
126 void set_phase_invert (bool yn, void *src);
127 bool phase_invert() const { return _phase_invert; }
129 void set_edit_group (RouteGroup *, void *);
130 void drop_edit_group (void *);
131 RouteGroup *edit_group () { return _edit_group; }
133 void set_mix_group (RouteGroup *, void *);
134 void drop_mix_group (void *);
135 RouteGroup *mix_group () { return _mix_group; }
137 virtual void set_meter_point (MeterPoint, void *src);
138 MeterPoint meter_point() const { return _meter_point; }
142 void flush_redirects ();
144 template<class T> void foreach_redirect (T *obj, void (T::*func)(Redirect *)) {
145 RWLockMonitor lm (redirect_lock, false, __LINE__, __FILE__);
146 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
151 Redirect *nth_redirect (uint32_t n) {
152 RWLockMonitor lm (redirect_lock, false, __LINE__, __FILE__);
153 RedirectList::iterator i;
154 for (i = _redirects.begin(); i != _redirects.end() && n; ++i, --n);
155 if (i == _redirects.end()) {
162 uint32_t max_redirect_outs () const { return redirect_max_outs; }
164 int add_redirect (Redirect *, void *src, uint32_t* err_streams = 0);
165 int add_redirects (const RedirectList&, void *src, uint32_t* err_streams = 0);
166 int remove_redirect (Redirect *, void *src, uint32_t* err_streams = 0);
167 int copy_redirects (const Route&, Placement, uint32_t* err_streams = 0);
168 int sort_redirects (uint32_t* err_streams = 0);
170 void clear_redirects (void *src);
171 void all_redirects_flip();
172 void all_redirects_active (bool state);
174 virtual jack_nframes_t update_total_latency();
175 jack_nframes_t signal_latency() const { return _own_latency; }
176 virtual void set_latency_delay (jack_nframes_t);
178 sigc::signal<void,void*> solo_changed;
179 sigc::signal<void,void*> solo_safe_changed;
180 sigc::signal<void,void*> comment_changed;
181 sigc::signal<void,void*> mute_changed;
182 sigc::signal<void,void*> pre_fader_changed;
183 sigc::signal<void,void*> post_fader_changed;
184 sigc::signal<void,void*> control_outs_changed;
185 sigc::signal<void,void*> main_outs_changed;
186 sigc::signal<void,void*> redirects_changed;
187 sigc::signal<void,void*> record_enable_changed;
188 sigc::signal<void,void*> edit_group_changed;
189 sigc::signal<void,void*> mix_group_changed;
190 sigc::signal<void> active_changed;
191 sigc::signal<void,void*> meter_change;
193 sigc::signal<void> GoingAway;
195 /* gui's call this for their own purposes. */
197 sigc::signal<void,std::string,void*> gui_changed;
201 XMLNode& get_state();
202 int set_state(const XMLNode& node);
203 virtual XMLNode& get_template();
205 sigc::signal<void,void*> SelectedChanged;
209 UndoAction get_memento() const;
210 void set_state (state_id_t);
212 int set_control_outs (const vector<std::string>& ports);
213 IO* control_outs() { return _control_outs; }
215 bool feeds (Route *);
218 struct MIDIToggleControl : public MIDI::Controllable {
224 MIDIToggleControl (Route&, ToggleType, MIDI::Port *);
225 void set_value (float);
226 void send_feedback (bool);
227 MIDI::byte* write_feedback (MIDI::byte* buf, int32_t& bufsize, bool val, bool force = false);
235 MIDI::Controllable& midi_solo_control() {
236 return _midi_solo_control;
238 MIDI::Controllable& midi_mute_control() {
239 return _midi_mute_control;
242 virtual void reset_midi_control (MIDI::Port*, bool);
243 virtual void send_all_midi_feedback ();
244 virtual MIDI::byte* write_midi_feedback (MIDI::byte*, int32_t& bufsize);
246 void automation_snapshot (jack_nframes_t now);
248 void protect_automation ();
250 void set_remote_control_id (uint32_t id);
251 uint32_t remote_control_id () const;
252 sigc::signal<void> RemoteControlIDChanged;
255 friend class Session;
257 void set_solo_mute (bool yn);
258 void set_block_size (jack_nframes_t nframes);
259 bool has_external_redirects() const;
260 void curve_reallocate ();
263 unsigned char _flags;
265 /* tight cache-line access here is more important than sheer speed of
271 bool _solo_muted : 1;
273 bool _phase_invert : 1;
274 bool _recordable : 1;
276 bool _mute_affects_pre_fader : 1;
277 bool _mute_affects_post_fader : 1;
278 bool _mute_affects_control_outs : 1;
279 bool _mute_affects_main_outs : 1;
281 bool _declickable : 1;
282 int _pending_declick;
284 MeterPoint _meter_point;
288 gain_t desired_solo_gain;
289 gain_t desired_mute_gain;
291 jack_nframes_t check_initial_delay (jack_nframes_t, jack_nframes_t&, jack_nframes_t&);
293 jack_nframes_t _initial_delay;
294 jack_nframes_t _roll_delay;
295 jack_nframes_t _own_latency;
296 RedirectList _redirects;
297 PBD::NonBlockingRWLock redirect_lock;
299 PBD::NonBlockingLock control_outs_lock;
300 RouteGroup *_edit_group;
301 RouteGroup *_mix_group;
302 std::string _comment;
303 bool _have_internal_generator;
305 MIDIToggleControl _midi_solo_control;
306 MIDIToggleControl _midi_mute_control;
308 void passthru (jack_nframes_t start_frame, jack_nframes_t end_frame,
309 jack_nframes_t nframes, jack_nframes_t offset, int declick, bool meter_inputs);
311 void process_output_buffers (vector<Sample*>& bufs, uint32_t nbufs,
312 jack_nframes_t start_frame, jack_nframes_t end_frame,
313 jack_nframes_t nframes, jack_nframes_t offset, bool with_redirects, int declick,
317 /* for derived classes */
319 virtual XMLNode& state(bool);
321 void silence (jack_nframes_t nframes, jack_nframes_t offset);
322 sigc::connection input_signal_connection;
324 state_id_t _current_state_id;
325 uint32_t redirect_max_outs;
326 uint32_t _remote_control_id;
328 uint32_t pans_required() const;
329 uint32_t n_process_buffers ();
334 static uint32_t order_key_cnt;
335 typedef std::map<std::string,long> OrderKeys;
336 OrderKeys order_keys;
338 void input_change_handler (IOChange, void *src);
339 void output_change_handler (IOChange, void *src);
341 bool legal_redirect (Redirect&);
342 int reset_plugin_counts (uint32_t*); /* locked */
343 int _reset_plugin_counts (uint32_t*); /* unlocked */
345 /* plugin count handling */
348 ARDOUR::Insert& insert;
353 InsertCount (ARDOUR::Insert& ins) : insert (ins), cnt (-1) {}
356 int32_t apply_some_plugin_counts (std::list<InsertCount>& iclist);
357 int32_t check_some_plugin_counts (std::list<InsertCount>& iclist, int32_t required_inputs, uint32_t* err_streams);
359 void set_deferred_state ();
360 void add_redirect_from_xml (const XMLNode&);
361 void redirect_active_proxy (Redirect*, void*);
364 }; /* namespace ARDOUR*/
366 #endif /* __ardour_route_h__ */