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