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