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