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