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                 ControlOut = 0x4
  69         };
  70
  71         Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
  72         Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
  73         virtual ~Route();
  74
  75         boost::shared_ptr<IO> input() const { return _input; }
  76         boost::shared_ptr<IO> output() const { return _output; }
  77
  78         ChanCount n_inputs() const { return _input->n_ports(); }
  79         ChanCount n_outputs() const { return _output->n_ports(); }
  80
  81         bool active() const { return _active; }
  82         void set_active (bool yn);
  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         boost::shared_ptr<Processor> nth_plugin (uint32_t n);
 185         boost::shared_ptr<Processor> nth_send (uint32_t n);
 186
 187         bool processor_is_prefader (boost::shared_ptr<Processor> p);
 188
 189         ChanCount max_processor_streams () const { return processor_max_streams; }
 190
 191         /* special processors */
 192
 193         boost::shared_ptr<Delivery>         control_outs() const { return _control_outs; }
 194         boost::shared_ptr<Delivery>         main_outs() const { return _main_outs; }
 195         boost::shared_ptr<InternalReturn>   internal_return() const { return _intreturn; }
 196         boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
 197         boost::shared_ptr<Send>             internal_send_for (boost::shared_ptr<const Route> target) const;
 198         void add_internal_return ();
 199         BufferSet* get_return_buffer () const;
 200         void release_return_buffer () const;
 201         void put_control_outs_at (Placement);
 202
 203         /** A record of the stream configuration at some point in the processor list.
 204          * Used to return where and why an processor list configuration request failed.
 205          */
 206         struct ProcessorStreams {
 207                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 208
 209                 uint32_t  index; ///< Index of processor where configuration failed
 210                 ChanCount count; ///< Input requested of processor
 211         };
 212
 213         int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
 214         int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0, bool activation_allowed = true);
 215         int add_processors (const ProcessorList&, boost::shared_ptr<Processor> before, ProcessorStreams* err = 0);
 216         int add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
 217         int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 218         int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
 219         int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
 220         void disable_processors (Placement);
 221         void disable_processors ();
 222         void disable_plugins (Placement);
 223         void disable_plugins ();
 224         void ab_plugins (bool forward);
 225         void clear_processors (Placement);
 226         void all_processors_flip();
 227         void all_processors_active (Placement, bool state);
 228
 229         virtual nframes_t update_total_latency();
 230         void set_latency_delay (nframes_t);
 231         void set_user_latency (nframes_t);
 232         nframes_t initial_delay() const { return _initial_delay; }
 233
 234         PBD::Signal0<void>       active_changed;
 235         PBD::Signal0<void>       phase_invert_changed;
 236         PBD::Signal0<void>       denormal_protection_changed;
 237         PBD::Signal1<void,void*> listen_changed;
 238         PBD::Signal1<void,void*> solo_changed;
 239         PBD::Signal1<void,void*> solo_safe_changed;
 240         PBD::Signal1<void,void*> solo_isolated_changed;
 241         PBD::Signal1<void,void*> comment_changed;
 242         PBD::Signal1<void,void*> mute_changed;
 243         PBD::Signal0<void>       mute_points_changed;
 244
 245         /** the processors have changed; the parameter indicates what changed */
 246         PBD::Signal1<void,RouteProcessorChange> processors_changed;
 247         PBD::Signal1<void,void*> record_enable_changed;
 248         /** the metering point has changed */
 249         PBD::Signal1<void,void*> meter_change;
 250         PBD::Signal0<void>       signal_latency_changed;
 251         PBD::Signal0<void>       initial_delay_changed;
 252
 253         /* gui's call this for their own purposes. */
 254
 255         PBD::Signal2<void,std::string,void*> gui_changed;
 256
 257         /* stateful */
 258
 259         XMLNode& get_state();
 260         int set_state (const XMLNode&, int version);
 261         virtual XMLNode& get_template();
 262
 263         XMLNode& get_processor_state ();
 264         virtual void set_processor_state (const XMLNode&);
 265
 266         int save_as_template (const std::string& path, const std::string& name);
 267
 268         PBD::Signal1<void,void*> SelectedChanged;
 269
 270         int listen_via (boost::shared_ptr<Route>, Placement p, bool active, bool aux);
 271         void drop_listen (boost::shared_ptr<Route>);
 272
 273         bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
 274         std::set<boost::weak_ptr<Route> > fed_by;
 275
 276         /* Controls (not all directly owned by the Route */
 277
 278         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 279
 280         struct SoloControllable : public AutomationControl {
 281                 SoloControllable (std::string name, Route&);
 282                 void set_value (float);
 283                 float get_value (void) const;
 284
 285                 Route& route;
 286         };
 287
 288         struct MuteControllable : public AutomationControl {
 289                 MuteControllable (std::string name, Route&);
 290                 void set_value (float);
 291                 float get_value (void) const;
 292
 293                 Route& route;
 294         };
 295
 296         boost::shared_ptr<AutomationControl> solo_control() const {
 297                 return _solo_control;
 298         }
 299
 300         boost::shared_ptr<AutomationControl> mute_control() const {
 301                 return _mute_control;
 302         }
 303
 304         boost::shared_ptr<MuteMaster> mute_master() const {
 305                 return _mute_master;
 306         }
 307
 308         /* Route doesn't own these items, but sub-objects that it does own have them
 309            and to make UI code a bit simpler, we provide direct access to them
 310            here.
 311         */
 312
 313         boost::shared_ptr<Panner> panner() const;
 314         boost::shared_ptr<AutomationControl> gain_control() const;
 315
 316         void automation_snapshot (nframes_t now, bool force=false);
 317         void protect_automation ();
 318
 319         void set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
 320         uint32_t remote_control_id () const;
 321
 322         /* for things concerned about *this* route's RID */
 323
 324         PBD::Signal0<void> RemoteControlIDChanged;
 325
 326         /* for things concerned about any route's RID changes */
 327
 328         static PBD::Signal0<void> RemoteControlIDChange;
 329
 330         void sync_order_keys (std::string const &);
 331         static PBD::Signal1<void,std::string const &> SyncOrderKeys;
 332
 333   protected:
 334         friend class Session;
 335
 336         void catch_up_on_solo_mute_override ();
 337         void mod_solo_by_others (int32_t);
 338         void set_block_size (nframes_t nframes);
 339         bool has_external_redirects() const;
 340         void curve_reallocate ();
 341         void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
 342
 343   protected:
 344         nframes_t check_initial_delay (nframes_t, nframes_t&);
 345
 346         void passthru (sframes_t start_frame, sframes_t end_frame,
 347                         nframes_t nframes, int declick);
 348
 349         virtual void write_out_of_band_data (BufferSet& /* bufs */, sframes_t /* start_frame */, sframes_t /* end_frame */,
 350                         nframes_t /* nframes */) {}
 351
 352         virtual void process_output_buffers (BufferSet& bufs,
 353                         sframes_t start_frame, sframes_t end_frame,
 354                         nframes_t nframes, bool with_processors, int declick);
 355
 356         boost::shared_ptr<IO> _input;
 357         boost::shared_ptr<IO> _output;
 358
 359         bool           _active;
 360         nframes_t      _initial_delay;
 361         nframes_t      _roll_delay;
 362
 363         ProcessorList  _processors;
 364         mutable Glib::RWLock   _processor_lock;
 365         boost::shared_ptr<Delivery> _main_outs;
 366         boost::shared_ptr<Delivery> _control_outs;
 367         boost::shared_ptr<InternalReturn> _intreturn;
 368         boost::shared_ptr<MonitorProcessor> _monitor_control;
 369
 370         Flag           _flags;
 371         int            _pending_declick;
 372         MeterPoint     _meter_point;
 373         uint32_t       _phase_invert;
 374         bool           _self_solo;
 375         uint32_t       _soloed_by_others;
 376         uint32_t       _solo_isolated;
 377
 378         bool           _denormal_protection;
 379
 380         bool _recordable : 1;
 381         bool _silent : 1;
 382         bool _declickable : 1;
 383
 384         boost::shared_ptr<SoloControllable> _solo_control;
 385         boost::shared_ptr<MuteControllable> _mute_control;
 386         boost::shared_ptr<MuteMaster> _mute_master;
 387         MuteMaster::MutePoint _mute_points;
 388
 389         std::string    _comment;
 390         bool           _have_internal_generator;
 391         bool           _solo_safe;
 392         DataType       _default_type;
 393
 394   protected:
 395
 396         virtual XMLNode& state(bool);
 397
 398         void passthru_silence (sframes_t start_frame, sframes_t end_frame,
 399                                nframes_t nframes, int declick);
 400
 401         void silence (nframes_t nframes);
 402
 403         ChanCount processor_max_streams;
 404         uint32_t _remote_control_id;
 405
 406         uint32_t pans_required() const;
 407         ChanCount n_process_buffers ();
 408
 409         virtual int  _set_state (const XMLNode&, int, bool call_base);
 410
 411         boost::shared_ptr<Amp>       _amp;
 412         boost::shared_ptr<PeakMeter> _meter;
 413
 414   private:
 415         void init ();
 416         int _set_state_2X (const XMLNode&, int);
 417         void set_processor_state_2X (XMLNodeList const &, int);
 418
 419         static uint32_t order_key_cnt;
 420
 421         typedef std::map<std::string, long> OrderKeys;
 422         OrderKeys order_keys;
 423
 424         void input_change_handler (IOChange, void *src);
 425         void output_change_handler (IOChange, void *src);
 426
 427         bool _in_configure_processors;
 428
 429         int configure_processors (ProcessorStreams*);
 430         int configure_processors_unlocked (ProcessorStreams*);
 431
 432         bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);
 433         bool add_processor_from_xml_2X (const XMLNode&, int, ProcessorList::iterator iter);
 434
 435         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 436
 437         void set_self_solo (bool yn);
 438         void set_delivery_solo ();
 439 };
 440
 441 } // namespace ARDOUR
 442
 443 #endif /* __ardour_route_h__ */