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