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