fix merge conflict with master
[ardour.git] / libs / ardour / ardour / route.h
1 /*
2     Copyright (C) 2000-2002 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #ifndef __ardour_route_h__
21 #define __ardour_route_h__
22
23 #include <cmath>
24 #include <cstring>
25 #include <list>
26 #include <map>
27 #include <set>
28 #include <string>
29
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>
34
35 #include <glibmm/threads.h>
36 #include "pbd/fastlog.h"
37 #include "pbd/xml++.h"
38 #include "pbd/undo.h"
39 #include "pbd/stateful.h"
40 #include "pbd/controllable.h"
41 #include "pbd/destructible.h"
42
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"
53
54 namespace ARDOUR {
55
56 class Amp;
57 class Delivery;
58 class IOProcessor;
59 class Panner;
60 class PannerShell;
61 class PortSet;
62 class Processor;
63 class RouteGroup;
64 class Send;
65 class InternalReturn;
66 class MonitorProcessor;
67 class Pannable;
68 class CapturingProcessor;
69 class InternalSend;
70
71 class LIBARDOUR_API Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
72 {
73   public:
74
75         typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
76
77         enum Flag {
78                 Auditioner = 0x1,
79                 MasterOut = 0x2,
80                 MonitorOut = 0x4
81         };
82
83         Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
84         virtual ~Route();
85
86         virtual int init ();
87
88         boost::shared_ptr<IO> input() const { return _input; }
89         boost::shared_ptr<IO> output() const { return _output; }
90
91         ChanCount n_inputs() const { return _input->n_ports(); }
92         ChanCount n_outputs() const { return _output->n_ports(); }
93
94         bool active() const { return _active; }
95         void set_active (bool yn, void *);
96
97         static std::string ensure_track_or_route_name(std::string, Session &);
98
99         std::string comment() { return _comment; }
100         void set_comment (std::string str, void *src);
101
102         bool set_name (const std::string& str);
103         static void set_name_in_state (XMLNode &, const std::string &);
104
105         uint32_t order_key () const;
106         bool has_order_key () const;
107         void set_order_key (uint32_t);
108
109         bool is_auditioner() const { return _flags & Auditioner; }
110         bool is_master() const { return _flags & MasterOut; }
111         bool is_monitor() const { return _flags & MonitorOut; }
112
113         virtual MonitorState monitoring_state () const;
114         virtual MeterState metering_state () const;
115         
116         /* these are the core of the API of a Route. see the protected sections as well */
117
118         virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
119                           int declick, bool& need_butler);
120
121         virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
122                              bool state_changing);
123
124         virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
125                                  bool& need_butler);
126
127         virtual bool can_record() { return false; }
128
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);
136
137         /* end of vfunc-based API */
138
139         void shift (framepos_t, framecnt_t);
140
141         void set_gain (gain_t val, void *src);
142         void inc_gain (gain_t delta, void *src);
143
144         void set_mute_points (MuteMaster::MutePoint);
145         MuteMaster::MutePoint mute_points () const;
146
147         bool muted () const;
148         void set_mute (bool yn, void* src);
149         
150         /* controls use set_solo() to modify this route's solo state
151          */
152
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);
156
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; }
161
162         void set_solo_isolated (bool yn, void *src);
163         bool solo_isolated() const;
164
165         void set_solo_safe (bool yn, void *src);
166         bool solo_safe() const;
167
168         void set_listen (bool yn, void* src);
169         bool listening_via_monitor () const;
170         void enable_monitor_send ();
171
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;
176
177         void set_denormal_protection (bool yn);
178         bool denormal_protection() const;
179
180         void         set_meter_point (MeterPoint, bool force = false);
181         MeterPoint   meter_point() const { return _meter_point; }
182         void         meter ();
183
184         void         set_meter_type (MeterType t) { _meter_type = t; }
185         MeterType    meter_type() const { return _meter_type; }
186
187         /* Processors */
188
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; }
193
194         void flush_processors ();
195
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)) {
200                                 break;
201                         }
202                         method (boost::weak_ptr<Processor> (*i));
203                 }
204         }
205
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> ();
212                 } else {
213                         return *i;
214                 }
215         }
216
217         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
218
219         boost::shared_ptr<Processor> nth_plugin (uint32_t n);
220         boost::shared_ptr<Processor> nth_send (uint32_t n);
221
222         bool has_io_processor_named (const std::string&);
223         ChanCount max_processor_streams () const { return processor_max_streams; }
224
225         std::list<std::string> unknown_processors () const;
226
227         /* special processors */
228
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 */);
239
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.
242          */
243         struct ProcessorStreams {
244                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
245
246                 uint32_t  index; ///< Index of processor where configuration failed
247                 ChanCount count; ///< Input requested of processor
248         };
249
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);
266
267         framecnt_t set_private_port_latencies (bool playback) const;
268         void       set_public_port_latencies (framecnt_t, bool playback) const;
269
270         framecnt_t   update_signal_latency();
271         virtual void set_latency_compensation (framecnt_t);
272
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; }
276
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;
287
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;
295
296         /** Emitted with the process lock held */
297         PBD::Signal0<void>       io_changed;
298
299         /* gui's call this for their own purposes. */
300
301         PBD::Signal2<void,std::string,void*> gui_changed;
302
303         /* stateful */
304
305         XMLNode& get_state();
306         virtual int set_state (const XMLNode&, int version);
307         virtual XMLNode& get_template();
308
309         XMLNode& get_processor_state ();
310         virtual void set_processor_state (const XMLNode&);
311
312         int save_as_template (const std::string& path, const std::string& name);
313
314         PBD::Signal1<void,void*> SelectedChanged;
315
316         int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
317         void remove_aux_or_listen (boost::shared_ptr<Route>);
318
319         /**
320          * return true if this route feeds the first argument via at least one
321          * (arbitrarily long) signal pathway.
322          */
323         bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
324
325         /**
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.
329          */
330         bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
331
332         /**
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.
336          */
337         bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
338
339         struct FeedRecord {
340                 boost::weak_ptr<Route> r;
341                 bool sends_only;
342
343                 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
344                 : r (rp)
345                 , sends_only (sendsonly) {}
346         };
347
348         struct FeedRecordCompare {
349                 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
350                         return a.r < b.r;
351                 }
352         };
353
354         typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
355
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);
359
360         /* Controls (not all directly owned by the Route */
361
362         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
363
364         class SoloControllable : public AutomationControl {
365         public:
366                 SoloControllable (std::string name, boost::shared_ptr<Route>);
367                 void set_value (double);
368                 double get_value () const;
369
370         private:
371                 boost::weak_ptr<Route> _route;
372         };
373
374         struct MuteControllable : public AutomationControl {
375         public:
376                 MuteControllable (std::string name, boost::shared_ptr<Route>);
377                 void set_value (double);
378                 double get_value () const;
379
380         private:
381                 boost::weak_ptr<Route> _route;
382         };
383
384         boost::shared_ptr<AutomationControl> solo_control() const {
385                 return _solo_control;
386         }
387
388         boost::shared_ptr<AutomationControl> mute_control() const {
389                 return _mute_control;
390         }
391
392         boost::shared_ptr<MuteMaster> mute_master() const {
393                 return _mute_master;
394         }
395
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
398            here.
399         */
400
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;
405
406         /**
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.
412         */
413         boost::shared_ptr<Processor> the_instrument() const;
414         InstrumentInfo& instrument_info() { return _instrument_info; }
415
416         void protect_automation ();
417
418         enum { 
419                 /* These numbers are taken from MIDI Machine Control,
420                    which can only control up to 317 tracks without
421                    doing sysex segmentation.
422                 */
423                 MasterBusRemoteControlID = 318,
424                 MonitorBusRemoteControlID = 319,
425         };
426
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);
430
431         /* for things concerned about *this* route's RID */
432
433         PBD::Signal0<void> RemoteControlIDChanged;
434
435         /* for things concerned about *any* route's RID changes */
436
437         static PBD::Signal0<void> RemoteControlIDChange;
438         static PBD::Signal0<void> SyncOrderKeys;
439
440         bool has_external_redirects() const;
441
442         /* can only be executed by a route for which is_monitor() is true
443            (i.e. the monitor out)
444         */
445         void monitor_run (framepos_t start_frame, framepos_t end_frame,
446                           pframes_t nframes, int declick);
447
448   protected:
449         friend class Session;
450
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);
456
457   protected:
458         virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
459
460         void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
461
462         void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
463                         pframes_t nframes, int declick);
464
465         virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
466                                              framecnt_t /* nframes */) {}
467
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);
472
473         boost::shared_ptr<IO> _input;
474         boost::shared_ptr<IO> _output;
475
476         bool           _active;
477         framecnt_t     _signal_latency;
478         framecnt_t     _initial_delay;
479         framecnt_t     _roll_delay;
480
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;
488
489         Flag           _flags;
490         int            _pending_declick;
491         MeterPoint     _meter_point;
492         MeterType      _meter_type;
493         boost::dynamic_bitset<> _phase_invert;
494         bool           _self_solo;
495         uint32_t       _soloed_by_others_upstream;
496         uint32_t       _soloed_by_others_downstream;
497         uint32_t       _solo_isolated;
498
499         bool           _denormal_protection;
500
501         bool _recordable : 1;
502         bool _silent : 1;
503         bool _declickable : 1;
504
505         boost::shared_ptr<SoloControllable> _solo_control;
506         boost::shared_ptr<MuteControllable> _mute_control;
507         boost::shared_ptr<MuteMaster> _mute_master;
508
509         virtual void act_on_mute () {}
510
511         std::string    _comment;
512         bool           _have_internal_generator;
513         bool           _solo_safe;
514         DataType       _default_type;
515         FedBy          _fed_by;
516
517         InstrumentInfo _instrument_info;
518
519         virtual ChanCount input_streams () const;
520
521   protected:
522         virtual XMLNode& state(bool);
523
524         int configure_processors (ProcessorStreams*);
525
526         void passthru_silence (framepos_t start_frame, framepos_t end_frame,
527                                pframes_t nframes, int declick);
528
529         void silence (framecnt_t);
530         void silence_unlocked (framecnt_t);
531
532         ChanCount processor_max_streams;
533         ChanCount processor_out_streams;
534
535         uint32_t pans_required() const;
536         ChanCount n_process_buffers ();
537
538         virtual void maybe_declick (BufferSet&, framecnt_t, int);
539
540         boost::shared_ptr<Amp>       _amp;
541         boost::shared_ptr<PeakMeter> _meter;
542
543         boost::shared_ptr<Processor> the_instrument_unlocked() const;
544
545   private:
546         int set_state_2X (const XMLNode&, int);
547         void set_processor_state_2X (XMLNodeList const &, int);
548
549         uint32_t _order_key;
550         bool _has_order_key;
551         uint32_t _remote_control_id;
552
553         void input_change_handler (IOChange, void *src);
554         void output_change_handler (IOChange, void *src);
555
556         bool input_port_count_changing (ChanCount);
557         bool output_port_count_changing (ChanCount);
558
559         bool _in_configure_processors;
560         bool _initial_io_setup;
561
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 *);
565
566         bool add_processor_from_xml_2X (const XMLNode&, int);
567
568         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
569
570         void set_self_solo (bool yn);
571         void set_mute_master_solo ();
572
573         void set_processor_positions ();
574         framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
575
576         void setup_invisible_processors ();
577         void unpan ();
578
579         boost::shared_ptr<CapturingProcessor> _capturing_processor;
580
581         /** A handy class to keep processor state while we attempt a reconfiguration
582          *  that may fail.
583          */
584         class ProcessorState {
585         public:
586                 ProcessorState (Route* r)
587                         : _route (r)
588                         , _processors (r->_processors)
589                         , _processor_max_streams (r->processor_max_streams)
590                 { }
591
592                 void restore () {
593                         _route->_processors = _processors;
594                         _route->processor_max_streams = _processor_max_streams;
595                 }
596
597         private:
598                 /* this should perhaps be a shared_ptr, but ProcessorStates will
599                    not hang around long enough for it to matter.
600                 */
601                 Route* _route;
602                 ProcessorList _processors;
603                 ChanCount _processor_max_streams;
604         };
605
606         friend class ProcessorState;
607
608         /* no copy construction */
609         Route (Route const &);
610
611         void maybe_note_meter_position ();
612         
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,
616             or 0.
617         */
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;
621
622         void reset_instrument_info ();
623
624         void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
625 };
626
627 } // namespace ARDOUR
628
629 #endif /* __ardour_route_h__ */