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