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 <list>
  25 #include <set>
  26 #include <map>
  27 #include <string>
  28
  29 #include <boost/shared_ptr.hpp>
  30
  31 #include <pbd/fastlog.h>
  32 #include <glibmm/thread.h>
  33 #include <pbd/xml++.h>
  34 #include <pbd/undo.h>
  35 #include <pbd/stateful.h>
  36 #include <pbd/controllable.h>
  37 #include <pbd/destructible.h>
  38
  39 #include <ardour/ardour.h>
  40 #include <ardour/io.h>
  41 #include <ardour/session.h>
  42 #include <ardour/io_processor.h>
  43 #include <ardour/types.h>
  44
  45 namespace ARDOUR {
  46
  47 class Processor;
  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<Processor> > ProcessorList;
  63
  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         Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
  76         virtual ~Route();
  77
  78         static std::string ensure_track_or_route_name(std::string, Session &);
  79
  80         std::string comment() { return _comment; }
  81         void set_comment (std::string str, void *src);
  82
  83         long order_key (const char* name) const;
  84         void set_order_key (const char* name, long n);
  85
  86         bool is_hidden() const { return _flags & Hidden; }
  87         bool is_master() const { return _flags & MasterOut; }
  88         bool is_control() const { return _flags & ControlOut; }
  89
  90         /* these are the core of the API of a Route. see the protected sections as well */
  91
  92
  93         virtual int  roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
  94                            nframes_t offset, int declick, bool can_record, bool rec_monitors_input);
  95
  96         virtual int  no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
  97                               nframes_t offset, bool state_changing, bool can_record, bool rec_monitors_input);
  98
  99         virtual int  silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame,
 100                                   nframes_t offset, bool can_record, bool rec_monitors_input);
 101         virtual void toggle_monitor_input ();
 102         virtual bool can_record() { return false; }
 103         virtual void set_record_enable (bool yn, void *src) {}
 104         virtual bool record_enabled() const { return false; }
 105         virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
 106         virtual void set_pending_declick (int);
 107
 108         /* end of vfunc-based API */
 109
 110         void shift (nframes64_t, nframes64_t);
 111
 112         /* override IO::set_gain() to provide group control */
 113
 114         void set_gain (gain_t val, void *src);
 115         void inc_gain (gain_t delta, void *src);
 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         bool solo_muted() const { return desired_solo_gain == 0.0; }
 126
 127         void set_mute_config (mute_type, bool, void *src);
 128         bool get_mute_config (mute_type);
 129
 130         void       set_edit_group (RouteGroup *, void *);
 131         void       drop_edit_group (void *);
 132         RouteGroup *edit_group () { return _edit_group; }
 133
 134         void       set_mix_group (RouteGroup *, void *);
 135         void       drop_mix_group (void *);
 136         RouteGroup *mix_group () { return _mix_group; }
 137
 138         virtual void  set_meter_point (MeterPoint, void *src);
 139         MeterPoint  meter_point() const { return _meter_point; }
 140
 141         /* Processors */
 142
 143         void flush_processors ();
 144
 145         template<class T> void foreach_processor (T *obj, void (T::*func)(boost::shared_ptr<Processor>)) {
 146                 Glib::RWLock::ReaderLock lm (_processor_lock);
 147                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 148                         (obj->*func) (*i);
 149                 }
 150         }
 151
 152         boost::shared_ptr<Processor> nth_processor (uint32_t n) {
 153                 Glib::RWLock::ReaderLock lm (_processor_lock);
 154                 ProcessorList::iterator i;
 155                 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n);
 156                 if (i == _processors.end()) {
 157                         return boost::shared_ptr<IOProcessor> ();
 158                 } else {
 159                         return *i;
 160                 }
 161         }
 162
 163         ChanCount max_processor_outs () const { return processor_max_outs; }
 164         ChanCount pre_fader_streams() const;
 165
 166         /** A record of the stream configuration at some point in the processor list.
 167          * Used to return where and why an processor list configuration request failed.
 168          */
 169         struct ProcessorStreams {
 170                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 171
 172                 size_t    index; ///< Index of processor where configuration failed
 173                 ChanCount count; ///< Input requested of processor
 174         };
 175
 176         int add_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 177         int add_processors (const ProcessorList&, ProcessorStreams* err = 0);
 178         int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 179         int copy_processors (const Route&, Placement, ProcessorStreams* err = 0);
 180         int sort_processors (ProcessorStreams* err = 0);
 181         void disable_processors (Placement);
 182         void disable_processors ();
 183         void disable_plugins (Placement);
 184         void disable_plugins ();
 185         void ab_plugins (bool forward);
 186         void clear_processors (Placement);
 187         void all_processors_flip();
 188         void all_processors_active (Placement, bool state);
 189
 190         virtual nframes_t update_total_latency();
 191         void set_latency_delay (nframes_t);
 192         void set_user_latency (nframes_t);
 193         nframes_t initial_delay() const { return _initial_delay; }
 194
 195         sigc::signal<void,void*> solo_changed;
 196         sigc::signal<void,void*> solo_safe_changed;
 197         sigc::signal<void,void*> comment_changed;
 198         sigc::signal<void,void*> mute_changed;
 199         sigc::signal<void,void*> pre_fader_changed;
 200         sigc::signal<void,void*> post_fader_changed;
 201         sigc::signal<void,void*> control_outs_changed;
 202         sigc::signal<void,void*> main_outs_changed;
 203         sigc::signal<void>       processors_changed;
 204         sigc::signal<void,void*> record_enable_changed;
 205         sigc::signal<void,void*> edit_group_changed;
 206         sigc::signal<void,void*> mix_group_changed;
 207         sigc::signal<void,void*> meter_change;
 208         sigc::signal<void>       signal_latency_changed;
 209         sigc::signal<void>       initial_delay_changed;
 210
 211         /* gui's call this for their own purposes. */
 212
 213         sigc::signal<void,std::string,void*> gui_changed;
 214
 215         /* stateful */
 216
 217         XMLNode& get_state();
 218         int set_state(const XMLNode& node);
 219         virtual XMLNode& get_template();
 220
 221         XMLNode& get_processor_state ();
 222         int set_processor_state (const XMLNode&);
 223
 224         sigc::signal<void,void*> SelectedChanged;
 225
 226         int set_control_outs (const vector<std::string>& ports);
 227         IO* control_outs() { return _control_outs; }
 228
 229         bool feeds (boost::shared_ptr<Route>);
 230         set<boost::shared_ptr<Route> > fed_by;
 231
 232         struct ToggleControllable : public PBD::Controllable {
 233             enum ToggleType {
 234                     MuteControl = 0,
 235                     SoloControl
 236             };
 237
 238             ToggleControllable (std::string name, Route&, ToggleType);
 239             void set_value (float);
 240             float get_value (void) const;
 241
 242             Route& route;
 243             ToggleType type;
 244         };
 245
 246         boost::shared_ptr<PBD::Controllable> solo_control() {
 247                 return _solo_control;
 248         }
 249
 250         boost::shared_ptr<PBD::Controllable> mute_control() {
 251                 return _mute_control;
 252         }
 253
 254         void automation_snapshot (nframes_t now, bool force=false);
 255         void protect_automation ();
 256
 257         void set_remote_control_id (uint32_t id);
 258         uint32_t remote_control_id () const;
 259         sigc::signal<void> RemoteControlIDChanged;
 260
 261         void sync_order_keys (const char* base);
 262         static sigc::signal<void,const char*> SyncOrderKeys;
 263
 264   protected:
 265         friend class Session;
 266
 267         void catch_up_on_solo_mute_override ();
 268         void set_solo_mute (bool yn);
 269         void set_block_size (nframes_t nframes);
 270         bool has_external_redirects() const;
 271         void curve_reallocate ();
 272
 273   protected:
 274         Flag _flags;
 275
 276         /* tight cache-line access here is more important than sheer speed of
 277            access.
 278         */
 279
 280         bool                     _muted : 1;
 281         bool                     _soloed : 1;
 282         bool                     _solo_safe : 1;
 283         bool                     _recordable : 1;
 284         bool                     _mute_affects_pre_fader : 1;
 285         bool                     _mute_affects_post_fader : 1;
 286         bool                     _mute_affects_control_outs : 1;
 287         bool                     _mute_affects_main_outs : 1;
 288         bool                     _silent : 1;
 289         bool                     _declickable : 1;
 290         int                      _pending_declick;
 291
 292         MeterPoint               _meter_point;
 293
 294         gain_t                    solo_gain;
 295         gain_t                    mute_gain;
 296         gain_t                    desired_solo_gain;
 297         gain_t                    desired_mute_gain;
 298
 299
 300
 301         nframes_t           _initial_delay;
 302         nframes_t           _roll_delay;
 303         ProcessorList       _processors;
 304         Glib::RWLock        _processor_lock;
 305         IO                 *_control_outs;
 306         Glib::Mutex         _control_outs_lock;
 307         RouteGroup         *_edit_group;
 308         RouteGroup         *_mix_group;
 309         std::string         _comment;
 310         bool                _have_internal_generator;
 311
 312         boost::shared_ptr<ToggleControllable> _solo_control;
 313         boost::shared_ptr<ToggleControllable> _mute_control;
 314
 315         nframes_t check_initial_delay (nframes_t, nframes_t&, nframes_t&);
 316
 317         void passthru (nframes_t start_frame, nframes_t end_frame,
 318                        nframes_t nframes, nframes_t offset, int declick, bool meter_inputs);
 319
 320         virtual void process_output_buffers (BufferSet& bufs,
 321                                      nframes_t start_frame, nframes_t end_frame,
 322                                      nframes_t nframes, nframes_t offset, bool with_processors, int declick,
 323                                      bool meter);
 324
 325   protected:
 326
 327         virtual XMLNode& state(bool);
 328
 329         void passthru_silence (nframes_t start_frame, nframes_t end_frame,
 330                                nframes_t nframes, nframes_t offset, int declick,
 331                                bool meter);
 332
 333         void silence (nframes_t nframes, nframes_t offset);
 334
 335         sigc::connection input_signal_connection;
 336
 337         ChanCount processor_max_outs;
 338         uint32_t _remote_control_id;
 339
 340         uint32_t pans_required() const;
 341         ChanCount n_process_buffers ();
 342
 343         virtual int  _set_state (const XMLNode&, bool call_base);
 344         virtual void _set_processor_states (const XMLNodeList&);
 345
 346   private:
 347         void init ();
 348
 349         static uint32_t order_key_cnt;
 350
 351         struct ltstr
 352         {
 353             bool operator()(const char* s1, const char* s2) const
 354             {
 355                     return strcmp(s1, s2) < 0;
 356             }
 357         };
 358
 359         typedef std::map<const char*,long,ltstr> OrderKeys;
 360         OrderKeys order_keys;
 361
 362         void input_change_handler (IOChange, void *src);
 363         void output_change_handler (IOChange, void *src);
 364
 365         int reset_processor_counts (ProcessorStreams*); /* locked */
 366         int _reset_processor_counts (ProcessorStreams*); /* unlocked */
 367
 368         /* processor I/O channels and plugin count handling */
 369
 370         struct ProcessorCount {
 371             boost::shared_ptr<ARDOUR::Processor> processor;
 372             ChanCount in;
 373             ChanCount out;
 374
 375             ProcessorCount (boost::shared_ptr<ARDOUR::Processor> ins) : processor(ins) {}
 376         };
 377
 378         int32_t apply_some_processor_counts (std::list<ProcessorCount>& iclist);
 379         bool    check_some_processor_counts (std::list<ProcessorCount>& iclist, ChanCount required_inputs, ProcessorStreams* err_streams);
 380
 381         void set_deferred_state ();
 382         void add_processor_from_xml (const XMLNode&);
 383 };
 384
 385 } // namespace ARDOUR
 386
 387 #endif /* __ardour_route_h__ */