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