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