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/thread.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/io.h"
  45 #include "ardour/types.h"
  46 #include "ardour/mute_master.h"
  47 #include "ardour/route_group_member.h"
  48 #include "ardour/graphnode.h"
  49 #include "ardour/automatable.h"
  50 #include "ardour/unknown_processor.h"
  51
  52 namespace ARDOUR {
  53
  54 class Amp;
  55 class Delivery;
  56 class IOProcessor;
  57 class Panner;
  58 class PannerShell;
  59 class PortSet;
  60 class Processor;
  61 class RouteGroup;
  62 class Send;
  63 class InternalReturn;
  64 class MonitorProcessor;
  65 class Pannable;
  66 class CapturingProcessor;
  67 class InternalSend;
  68
  69 class Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
  70 {
  71   public:
  72
  73         typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
  74
  75         enum Flag {
  76                 Hidden = 0x1,
  77                 MasterOut = 0x2,
  78                 MonitorOut = 0x4
  79         };
  80
  81         Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
  82         virtual ~Route();
  83
  84         virtual int init ();
  85
  86         boost::shared_ptr<IO> input() const { return _input; }
  87         boost::shared_ptr<IO> output() const { return _output; }
  88
  89         ChanCount n_inputs() const { return _input->n_ports(); }
  90         ChanCount n_outputs() const { return _output->n_ports(); }
  91
  92         bool active() const { return _active; }
  93         void set_active (bool yn, void *);
  94
  95         static std::string ensure_track_or_route_name(std::string, Session &);
  96
  97         std::string comment() { return _comment; }
  98         void set_comment (std::string str, void *src);
  99
 100         bool set_name (const std::string& str);
 101
 102         int32_t order_key (std::string const &) const;
 103         void set_order_key (std::string const &, int32_t);
 104
 105         bool is_hidden() const { return _flags & Hidden; }
 106         bool is_master() const { return _flags & MasterOut; }
 107         bool is_monitor() const { return _flags & MonitorOut; }
 108
 109         /* these are the core of the API of a Route. see the protected sections as well */
 110
 111         virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 112                           int declick, bool can_record, bool rec_monitors_input, bool& need_butler);
 113
 114         virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 115                         bool state_changing, bool can_record, bool rec_monitors_input);
 116
 117         virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 118                                  bool can_record, bool rec_monitors_input, bool& need_butler);
 119
 120         virtual void toggle_monitor_input ();
 121         virtual bool can_record() { return false; }
 122
 123         virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
 124         virtual bool record_enabled() const { return false; }
 125         virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
 126         virtual void realtime_handle_transport_stopped () {}
 127         virtual void set_pending_declick (int);
 128
 129         /* end of vfunc-based API */
 130
 131         void shift (framepos_t, framepos_t);
 132
 133         void set_gain (gain_t val, void *src);
 134         void inc_gain (gain_t delta, void *src);
 135
 136         void set_mute_points (MuteMaster::MutePoint);
 137         MuteMaster::MutePoint mute_points () const;
 138
 139         bool muted () const;
 140         void set_mute (bool yn, void* src);
 141
 142         /* controls use set_solo() to modify this route's solo state
 143          */
 144
 145         void set_solo (bool yn, void *src);
 146         bool soloed () const { return self_soloed () || soloed_by_others (); }
 147
 148         bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
 149         bool soloed_by_others_upstream () const { return _soloed_by_others_upstream; }
 150         bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
 151         bool self_soloed () const { return _self_solo; }
 152
 153         void set_solo_isolated (bool yn, void *src);
 154         bool solo_isolated() const;
 155
 156         void set_solo_safe (bool yn, void *src);
 157         bool solo_safe() const;
 158
 159         void set_listen (bool yn, void* src);
 160         bool listening_via_monitor () const;
 161
 162         void set_phase_invert (uint32_t, bool yn);
 163         void set_phase_invert (boost::dynamic_bitset<>);
 164         bool phase_invert (uint32_t) const;
 165         boost::dynamic_bitset<> phase_invert () const;
 166
 167         void set_denormal_protection (bool yn);
 168         bool denormal_protection() const;
 169
 170         void         set_meter_point (MeterPoint, bool force = false);
 171         void         infer_meter_point () const;
 172         MeterPoint   meter_point() const { return _meter_point; }
 173         void         meter ();
 174
 175         /* Processors */
 176
 177         boost::shared_ptr<Amp> amp() const  { return _amp; }
 178         PeakMeter&       peak_meter()       { return *_meter.get(); }
 179         const PeakMeter& peak_meter() const { return *_meter.get(); }
 180         boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
 181
 182         void flush_processors ();
 183
 184         void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
 185                 Glib::RWLock::ReaderLock lm (_processor_lock);
 186                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 187                         if (boost::dynamic_pointer_cast<UnknownProcessor> (*i)) {
 188                                 break;
 189                         }
 190                         method (boost::weak_ptr<Processor> (*i));
 191                 }
 192         }
 193
 194         boost::shared_ptr<Processor> nth_processor (uint32_t n) {
 195                 Glib::RWLock::ReaderLock lm (_processor_lock);
 196                 ProcessorList::iterator i;
 197                 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
 198                 if (i == _processors.end()) {
 199                         return boost::shared_ptr<Processor> ();
 200                 } else {
 201                         return *i;
 202                 }
 203         }
 204
 205         boost::shared_ptr<Processor> nth_plugin (uint32_t n);
 206         boost::shared_ptr<Processor> nth_send (uint32_t n);
 207
 208         bool processor_is_prefader (boost::shared_ptr<Processor> p);
 209
 210         bool has_io_processor_named (const std::string&);
 211         ChanCount max_processor_streams () const { return processor_max_streams; }
 212
 213         std::list<std::string> unknown_processors () const;
 214
 215         /* special processors */
 216
 217         boost::shared_ptr<Delivery>         monitor_send() const { return _monitor_send; }
 218         boost::shared_ptr<Delivery>         main_outs() const { return _main_outs; }
 219         boost::shared_ptr<InternalReturn>   internal_return() const { return _intreturn; }
 220         boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
 221         boost::shared_ptr<Send>             internal_send_for (boost::shared_ptr<const Route> target) const;
 222         void add_internal_return ();
 223         void add_send_to_internal_return (InternalSend *);
 224         void remove_send_from_internal_return (InternalSend *);
 225         void listen_position_changed ();
 226         boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
 227
 228         /** A record of the stream configuration at some point in the processor list.
 229          * Used to return where and why an processor list configuration request failed.
 230          */
 231         struct ProcessorStreams {
 232                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 233
 234                 uint32_t  index; ///< Index of processor where configuration failed
 235                 ChanCount count; ///< Input requested of processor
 236         };
 237
 238         int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
 239         int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0, bool activation_allowed = true);
 240         int add_processors (const ProcessorList&, boost::shared_ptr<Processor> before, ProcessorStreams* err = 0);
 241         int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 242         int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
 243         int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
 244         void disable_processors (Placement);
 245         void disable_processors ();
 246         void disable_plugins (Placement);
 247         void disable_plugins ();
 248         void ab_plugins (bool forward);
 249         void clear_processors (Placement);
 250         void all_processors_flip();
 251         void all_processors_active (Placement, bool state);
 252
 253         void set_latency_ranges (bool playback) const;
 254         virtual framecnt_t update_total_latency();
 255         void set_latency_delay (framecnt_t);
 256         void set_user_latency (framecnt_t);
 257         framecnt_t initial_delay() const { return _initial_delay; }
 258
 259         PBD::Signal0<void>       active_changed;
 260         PBD::Signal0<void>       phase_invert_changed;
 261         PBD::Signal0<void>       denormal_protection_changed;
 262         PBD::Signal1<void,void*> listen_changed;
 263         PBD::Signal2<void,bool,void*> solo_changed;
 264         PBD::Signal1<void,void*> solo_safe_changed;
 265         PBD::Signal1<void,void*> solo_isolated_changed;
 266         PBD::Signal1<void,void*> comment_changed;
 267         PBD::Signal1<void,void*> mute_changed;
 268         PBD::Signal0<void>       mute_points_changed;
 269
 270         /** the processors have changed; the parameter indicates what changed */
 271         PBD::Signal1<void,RouteProcessorChange> processors_changed;
 272         PBD::Signal1<void,void*> record_enable_changed;
 273         /** the metering point has changed */
 274         PBD::Signal0<void>       meter_change;
 275         PBD::Signal0<void>       signal_latency_changed;
 276         PBD::Signal0<void>       initial_delay_changed;
 277         PBD::Signal0<void>       order_key_changed;
 278
 279         /** Emitted with the process lock held */
 280         PBD::Signal0<void>       io_changed;
 281
 282         /* gui's call this for their own purposes. */
 283
 284         PBD::Signal2<void,std::string,void*> gui_changed;
 285
 286         /* stateful */
 287
 288         XMLNode& get_state();
 289         int set_state (const XMLNode&, int version);
 290         virtual XMLNode& get_template();
 291
 292         XMLNode& get_processor_state ();
 293         virtual void set_processor_state (const XMLNode&);
 294
 295         int save_as_template (const std::string& path, const std::string& name);
 296
 297         PBD::Signal1<void,void*> SelectedChanged;
 298
 299         int listen_via_monitor ();
 300         int listen_via (boost::shared_ptr<Route>, Placement p);
 301         void drop_listen (boost::shared_ptr<Route>);
 302
 303        /**
 304         * return true if this route feeds the first argument via at least one
 305         * (arbitrarily long) signal pathway.
 306         */
 307         bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
 308
 309        /**
 310         * return true if this route feeds the first argument directly, via
 311         * either its main outs or a send.
 312         */
 313         bool direct_feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
 314
 315         struct FeedRecord {
 316             boost::weak_ptr<Route> r;
 317             bool sends_only;
 318
 319             FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
 320                     : r (rp)
 321                     , sends_only (sendsonly) {}
 322         };
 323
 324         struct FeedRecordCompare {
 325             bool operator() (const FeedRecord& a, const FeedRecord& b) const {
 326                     return a.r < b.r;
 327             }
 328         };
 329
 330         typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
 331
 332         const FedBy& fed_by() const { return _fed_by; }
 333         void clear_fed_by ();
 334         bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
 335         bool not_fed() const { return _fed_by.empty(); }
 336
 337         /* Controls (not all directly owned by the Route */
 338
 339         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 340
 341         class SoloControllable : public AutomationControl {
 342         public:
 343                 SoloControllable (std::string name, boost::shared_ptr<Route>);
 344                 void set_value (double);
 345                 double get_value () const;
 346
 347         private:
 348                 boost::weak_ptr<Route> _route;
 349         };
 350
 351         struct MuteControllable : public AutomationControl {
 352         public:
 353                 MuteControllable (std::string name, boost::shared_ptr<Route>);
 354                 void set_value (double);
 355                 double get_value () const;
 356
 357         private:
 358                 boost::weak_ptr<Route> _route;
 359         };
 360
 361         boost::shared_ptr<AutomationControl> solo_control() const {
 362                 return _solo_control;
 363         }
 364
 365         boost::shared_ptr<AutomationControl> mute_control() const {
 366                 return _mute_control;
 367         }
 368
 369         boost::shared_ptr<MuteMaster> mute_master() const {
 370                 return _mute_master;
 371         }
 372
 373         /* Route doesn't own these items, but sub-objects that it does own have them
 374            and to make UI code a bit simpler, we provide direct access to them
 375            here.
 376         */
 377
 378         boost::shared_ptr<Panner> panner() const;  /* may return null */
 379         boost::shared_ptr<PannerShell> panner_shell() const;
 380         boost::shared_ptr<AutomationControl> gain_control() const;
 381         boost::shared_ptr<Pannable> pannable() const;
 382
 383         void automation_snapshot (framepos_t now, bool force=false);
 384         void protect_automation ();
 385
 386         void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
 387         uint32_t remote_control_id () const;
 388
 389         /* for things concerned about *this* route's RID */
 390
 391         PBD::Signal0<void> RemoteControlIDChanged;
 392
 393         /* for things concerned about any route's RID changes */
 394
 395         static PBD::Signal0<void> RemoteControlIDChange;
 396
 397         void sync_order_keys (std::string const &);
 398         static PBD::Signal1<void,std::string const &> SyncOrderKeys;
 399
 400   protected:
 401         friend class Session;
 402
 403         void catch_up_on_solo_mute_override ();
 404         void mod_solo_by_others_upstream (int32_t);
 405         void mod_solo_by_others_downstream (int32_t);
 406         bool has_external_redirects() const;
 407         void curve_reallocate ();
 408         void just_meter_input (framepos_t start_frame, framepos_t end_frame, pframes_t nframes);
 409         virtual void set_block_size (pframes_t nframes);
 410
 411   protected:
 412         framecnt_t check_initial_delay (framecnt_t, framecnt_t&);
 413
 414         void passthru (framepos_t start_frame, framepos_t end_frame,
 415                         pframes_t nframes, int declick);
 416
 417         virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
 418                         framecnt_t /* nframes */) {}
 419
 420         virtual void process_output_buffers (BufferSet& bufs,
 421                                              framepos_t start_frame, framepos_t end_frame,
 422                                              pframes_t nframes, bool with_processors, int declick,
 423                                              bool gain_automation_ok);
 424
 425         boost::shared_ptr<IO> _input;
 426         boost::shared_ptr<IO> _output;
 427
 428         bool           _active;
 429         framecnt_t     _initial_delay;
 430         framecnt_t     _roll_delay;
 431
 432         ProcessorList  _processors;
 433         mutable Glib::RWLock   _processor_lock;
 434         boost::shared_ptr<Delivery> _main_outs;
 435         boost::shared_ptr<Delivery> _monitor_send;
 436         boost::shared_ptr<InternalReturn> _intreturn;
 437         boost::shared_ptr<MonitorProcessor> _monitor_control;
 438         boost::shared_ptr<Pannable> _pannable;
 439
 440         Flag           _flags;
 441         int            _pending_declick;
 442         MeterPoint     _meter_point;
 443         boost::dynamic_bitset<> _phase_invert;
 444         bool           _self_solo;
 445         uint32_t       _soloed_by_others_upstream;
 446         uint32_t       _soloed_by_others_downstream;
 447         uint32_t       _solo_isolated;
 448
 449         bool           _denormal_protection;
 450
 451         bool _recordable : 1;
 452         bool _silent : 1;
 453         bool _declickable : 1;
 454
 455         boost::shared_ptr<SoloControllable> _solo_control;
 456         boost::shared_ptr<MuteControllable> _mute_control;
 457         boost::shared_ptr<MuteMaster> _mute_master;
 458
 459         std::string    _comment;
 460         bool           _have_internal_generator;
 461         bool           _solo_safe;
 462         DataType       _default_type;
 463         FedBy          _fed_by;
 464
 465         virtual ChanCount input_streams () const;
 466
 467   protected:
 468         virtual XMLNode& state(bool);
 469
 470         int configure_processors (ProcessorStreams*);
 471
 472         void passthru_silence (framepos_t start_frame, framepos_t end_frame,
 473                                pframes_t nframes, int declick);
 474
 475         void silence (framecnt_t);
 476         void silence_unlocked (framecnt_t);
 477
 478         ChanCount processor_max_streams;
 479         uint32_t _remote_control_id;
 480
 481         uint32_t pans_required() const;
 482         ChanCount n_process_buffers ();
 483
 484         virtual bool should_monitor () const;
 485         virtual void maybe_declick (BufferSet&, framecnt_t, int);
 486
 487         virtual int  _set_state (const XMLNode&, int, bool call_base);
 488
 489         boost::shared_ptr<Amp>       _amp;
 490         boost::shared_ptr<PeakMeter> _meter;
 491
 492   private:
 493         int _set_state_2X (const XMLNode&, int);
 494         void set_processor_state_2X (XMLNodeList const &, int);
 495
 496         static uint32_t order_key_cnt;
 497
 498         typedef std::map<std::string, long> OrderKeys;
 499         OrderKeys order_keys;
 500
 501         void input_change_handler (IOChange, void *src);
 502         void output_change_handler (IOChange, void *src);
 503
 504         bool input_port_count_changing (ChanCount);
 505
 506         bool _in_configure_processors;
 507
 508         int configure_processors_unlocked (ProcessorStreams*);
 509         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
 510         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
 511
 512         bool add_processor_from_xml_2X (const XMLNode&, int);
 513
 514         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 515
 516         void set_self_solo (bool yn);
 517         void set_mute_master_solo ();
 518
 519         void set_processor_positions ();
 520         void update_port_latencies (const PortSet& ports, const PortSet& feeders, bool playback, framecnt_t) const;
 521
 522         void setup_invisible_processors ();
 523
 524         boost::shared_ptr<CapturingProcessor> _capturing_processor;
 525
 526         /** A handy class to keep processor state while we attempt a reconfiguration
 527          *  that may fail.
 528          */
 529         class ProcessorState {
 530         public:
 531                 ProcessorState (Route* r)
 532                         : _route (r)
 533                         , _processors (r->_processors)
 534                         , _processor_max_streams (r->processor_max_streams)
 535                 { }
 536
 537                 void restore () {
 538                         _route->_processors = _processors;
 539                         _route->processor_max_streams = _processor_max_streams;
 540                 }
 541
 542         private:
 543                 /* this should perhaps be a shared_ptr, but ProcessorStates will
 544                    not hang around long enough for it to matter.
 545                 */
 546                 Route* _route;
 547                 ProcessorList _processors;
 548                 ChanCount _processor_max_streams;
 549         };
 550
 551         friend class ProcessorState;
 552
 553         /* no copy construction */
 554         Route (Route const &);
 555 };
 556
 557 } // namespace ARDOUR
 558
 559 #endif /* __ardour_route_h__ */