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