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