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