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     $Id$
  19 */
  20
  21 #ifndef __ardour_route_h__
  22 #define __ardour_route_h__
  23
  24 #include <cmath>
  25 #include <list>
  26 #include <set>
  27 #include <map>
  28 #include <string>
  29
  30 #include <boost/shared_ptr.hpp>
  31
  32 #include <pbd/fastlog.h>
  33 #include <glibmm/thread.h>
  34 #include <pbd/xml++.h>
  35 #include <pbd/undo.h>
  36 #include <pbd/stateful.h>
  37 #include <pbd/controllable.h>
  38 #include <pbd/destructible.h>
  39
  40 #include <ardour/ardour.h>
  41 #include <ardour/io.h>
  42 #include <ardour/session.h>
  43 #include <ardour/redirect.h>
  44 #include <ardour/types.h>
  45
  46 namespace ARDOUR {
  47
  48 class Insert;
  49 class Send;
  50 class RouteGroup;
  51
  52 enum mute_type {
  53     PRE_FADER =    0x1,
  54     POST_FADER =   0x2,
  55     CONTROL_OUTS = 0x4,
  56     MAIN_OUTS =    0x8
  57 };
  58
  59 class Route : public IO
  60 {
  61   protected:
  62
  63         typedef list<boost::shared_ptr<Redirect> > RedirectList;
  64   public:
  65
  66         enum Flag {
  67                 Hidden = 0x1,
  68                 MasterOut = 0x2,
  69                 ControlOut = 0x4
  70         };
  71
  72
  73         Route (Session&, std::string name, int input_min, int input_max, int output_min, int output_max,
  74                Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
  75
  76         Route (Session&, const XMLNode&);
  77         virtual ~Route();
  78
  79         std::string comment() { return _comment; }
  80         void set_comment (std::string str, void *src);
  81
  82         long order_key(std::string name) const;
  83         void set_order_key (std::string name, long n);
  84
  85         bool hidden() const { return _flags & Hidden; }
  86         bool master() const { return _flags & MasterOut; }
  87         bool control() const { return _flags & ControlOut; }
  88
  89         /* these are the core of the API of a Route. see the protected sections as well */
  90
  91
  92         virtual int  roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
  93                            nframes_t offset, int declick, bool can_record, bool rec_monitors_input);
  94
  95         virtual int  no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
  96                               nframes_t offset, bool state_changing, bool can_record, bool rec_monitors_input);
  97
  98         virtual int  silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
  99                                   nframes_t offset, bool can_record, bool rec_monitors_input);
 100         virtual void toggle_monitor_input ();
 101         virtual bool can_record() { return false; }
 102         virtual void set_record_enable (bool yn, void *src) {}
 103         virtual bool record_enabled() const { return false; }
 104         virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_redirects);
 105         virtual void set_pending_declick (int);
 106
 107         /* end of vfunc-based API */
 108
 109         /* override IO::set_gain() to provide group control */
 110
 111         void set_gain (gain_t val, void *src);
 112         void inc_gain (gain_t delta, void *src);
 113
 114         bool active() const { return _active; }
 115         void set_active (bool yn);
 116
 117         void set_solo (bool yn, void *src);
 118         bool soloed() const { return _soloed; }
 119
 120         void set_solo_safe (bool yn, void *src);
 121         bool solo_safe() const { return _solo_safe; }
 122
 123         void set_mute (bool yn, void *src);
 124         bool muted() const { return _muted; }
 125
 126         void set_mute_config (mute_type, bool, void *src);
 127         bool get_mute_config (mute_type);
 128
 129         void       set_edit_group (RouteGroup *, void *);
 130         void       drop_edit_group (void *);
 131         RouteGroup *edit_group () { return _edit_group; }
 132
 133         void       set_mix_group (RouteGroup *, void *);
 134         void       drop_mix_group (void *);
 135         RouteGroup *mix_group () { return _mix_group; }
 136
 137         virtual void  set_meter_point (MeterPoint, void *src);
 138         MeterPoint  meter_point() const { return _meter_point; }
 139
 140         /* Redirects */
 141
 142         void flush_redirects ();
 143
 144         template<class T> void foreach_redirect (T *obj, void (T::*func)(boost::shared_ptr<Redirect>)) {
 145                 Glib::RWLock::ReaderLock lm (redirect_lock);
 146                 for (RedirectList::iterator i = _redirects.begin(); i != _redirects.end(); ++i) {
 147                         (obj->*func) (*i);
 148                 }
 149         }
 150
 151         boost::shared_ptr<Redirect> nth_redirect (uint32_t n) {
 152                 Glib::RWLock::ReaderLock lm (redirect_lock);
 153                 RedirectList::iterator i;
 154                 for (i = _redirects.begin(); i != _redirects.end() && n; ++i, --n);
 155                 if (i == _redirects.end()) {
 156                         return boost::shared_ptr<Redirect> ();
 157                 } else {
 158                         return *i;
 159                 }
 160         }
 161
 162         ChanCount max_redirect_outs () const { return redirect_max_outs; }
 163
 164         // FIXME: remove/replace err_streams parameters with something appropriate
 165         // they are used by 'wierd_plugin_dialog'(sic) to display the number of input streams
 166         // at the insertion point if the insert fails
 167         int add_redirect (boost::shared_ptr<Redirect>, void *src, uint32_t* err_streams = 0);
 168         int add_redirects (const RedirectList&, void *src, uint32_t* err_streams = 0);
 169         int remove_redirect (boost::shared_ptr<Redirect>, void *src, uint32_t* err_streams = 0);
 170         int copy_redirects (const Route&, Placement, uint32_t* err_streams = 0);
 171         int sort_redirects (uint32_t* err_streams = 0);
 172
 173         void clear_redirects (void *src);
 174         void all_redirects_flip();
 175         void all_redirects_active (bool state);
 176
 177         virtual nframes_t update_total_latency();
 178         nframes_t signal_latency() const { return _own_latency; }
 179         virtual void set_latency_delay (nframes_t);
 180
 181         sigc::signal<void,void*> solo_changed;
 182         sigc::signal<void,void*> solo_safe_changed;
 183         sigc::signal<void,void*> comment_changed;
 184         sigc::signal<void,void*> mute_changed;
 185         sigc::signal<void,void*> pre_fader_changed;
 186         sigc::signal<void,void*> post_fader_changed;
 187         sigc::signal<void,void*> control_outs_changed;
 188         sigc::signal<void,void*> main_outs_changed;
 189         sigc::signal<void,void*> redirects_changed;
 190         sigc::signal<void,void*> record_enable_changed;
 191         sigc::signal<void,void*> edit_group_changed;
 192         sigc::signal<void,void*> mix_group_changed;
 193         sigc::signal<void>       active_changed;
 194         sigc::signal<void,void*> meter_change;
 195
 196         /* gui's call this for their own purposes. */
 197
 198         sigc::signal<void,std::string,void*> gui_changed;
 199
 200         /* stateful */
 201
 202         XMLNode& get_state();
 203         int set_state(const XMLNode& node);
 204         virtual XMLNode& get_template();
 205
 206         sigc::signal<void,void*> SelectedChanged;
 207
 208         /* undo */
 209
 210         UndoAction get_memento() const;
 211         void set_state (state_id_t);
 212
 213         int set_control_outs (const vector<std::string>& ports);
 214         IO* control_outs() { return _control_outs; }
 215
 216         bool feeds (boost::shared_ptr<Route>);
 217         set<boost::shared_ptr<Route> > fed_by;
 218
 219         struct ToggleControllable : public PBD::Controllable {
 220             enum ToggleType {
 221                     MuteControl = 0,
 222                     SoloControl
 223             };
 224
 225             ToggleControllable (std::string name, Route&, ToggleType);
 226             void set_value (float);
 227             float get_value (void) const;
 228
 229             Route& route;
 230             ToggleType type;
 231         };
 232
 233         PBD::Controllable& solo_control() {
 234                 return _solo_control;
 235         }
 236
 237         PBD::Controllable& mute_control() {
 238                 return _mute_control;
 239         }
 240
 241         void protect_automation ();
 242
 243         void set_remote_control_id (uint32_t id);
 244         uint32_t remote_control_id () const;
 245         sigc::signal<void> RemoteControlIDChanged;
 246
 247   protected:
 248         friend class Session;
 249
 250         void set_solo_mute (bool yn);
 251         void set_block_size (nframes_t nframes);
 252         bool has_external_redirects() const;
 253         void curve_reallocate ();
 254
 255   protected:
 256         unsigned char _flags;
 257
 258         /* tight cache-line access here is more important than sheer speed of
 259            access.
 260         */
 261
 262         bool                     _muted : 1;
 263         bool                     _soloed : 1;
 264         bool                     _solo_muted : 1;
 265         bool                     _solo_safe : 1;
 266         bool                     _recordable : 1;
 267         bool                     _active : 1;
 268         bool                     _mute_affects_pre_fader : 1;
 269         bool                     _mute_affects_post_fader : 1;
 270         bool                     _mute_affects_control_outs : 1;
 271         bool                     _mute_affects_main_outs : 1;
 272         bool                     _silent : 1;
 273         bool                     _declickable : 1;
 274         int                      _pending_declick;
 275
 276         MeterPoint               _meter_point;
 277
 278         gain_t                    solo_gain;
 279         gain_t                    mute_gain;
 280         gain_t                    desired_solo_gain;
 281         gain_t                    desired_mute_gain;
 282
 283         nframes_t            check_initial_delay (nframes_t, nframes_t&, nframes_t&);
 284
 285         nframes_t           _initial_delay;
 286         nframes_t           _roll_delay;
 287         nframes_t           _own_latency;
 288         RedirectList             _redirects;
 289         Glib::RWLock      redirect_lock;
 290         IO                      *_control_outs;
 291         Glib::Mutex      control_outs_lock;
 292         RouteGroup              *_edit_group;
 293         RouteGroup              *_mix_group;
 294         std::string              _comment;
 295         bool                     _have_internal_generator;
 296
 297         ToggleControllable _solo_control;
 298         ToggleControllable _mute_control;
 299
 300         void passthru (nframes_t start_frame, nframes_t end_frame,
 301                        nframes_t nframes, nframes_t offset, int declick, bool meter_inputs);
 302
 303         virtual void process_output_buffers (BufferSet& bufs,
 304                                      nframes_t start_frame, nframes_t end_frame,
 305                                      nframes_t nframes, nframes_t offset, bool with_redirects, int declick,
 306                                      bool meter);
 307
 308   protected:
 309
 310         virtual XMLNode& state(bool);
 311
 312         void passthru_silence (nframes_t start_frame, nframes_t end_frame,
 313                                nframes_t nframes, nframes_t offset, int declick,
 314                                bool meter);
 315
 316         void silence (nframes_t nframes, nframes_t offset);
 317
 318         sigc::connection input_signal_connection;
 319
 320         state_id_t _current_state_id;
 321         ChanCount redirect_max_outs;
 322         uint32_t _remote_control_id;
 323
 324         uint32_t pans_required() const;
 325         ChanCount n_process_buffers ();
 326
 327   private:
 328         void init ();
 329
 330         static uint32_t order_key_cnt;
 331         typedef std::map<std::string,long> OrderKeys;
 332         OrderKeys order_keys;
 333
 334         void input_change_handler (IOChange, void *src);
 335         void output_change_handler (IOChange, void *src);
 336
 337         bool legal_redirect (Redirect&);
 338         int reset_plugin_counts (uint32_t*); /* locked */
 339         int _reset_plugin_counts (uint32_t*); /* unlocked */
 340
 341         /* plugin count handling */
 342
 343         struct InsertCount {
 344             boost::shared_ptr<ARDOUR::Insert> insert;
 345             int32_t cnt;
 346             int32_t in;
 347             int32_t out;
 348
 349             InsertCount (boost::shared_ptr<ARDOUR::Insert> ins) : insert (ins), cnt (-1) {}
 350         };
 351
 352         int32_t apply_some_plugin_counts (std::list<InsertCount>& iclist);
 353         int32_t check_some_plugin_counts (std::list<InsertCount>& iclist, int32_t required_inputs, uint32_t* err_streams);
 354
 355         void set_deferred_state ();
 356         void add_redirect_from_xml (const XMLNode&);
 357         void redirect_active_proxy (Redirect*, void*);
 358 };
 359
 360 } // namespace ARDOUR
 361
 362 #endif /* __ardour_route_h__ */