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 <cstring>
  25 #include <list>
  26 #include <map>
  27 #include <set>
  28 #include <string>
  29
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/weak_ptr.hpp>
  32
  33 #include <glibmm/thread.h>
  34 #include "pbd/fastlog.h"
  35 #include "pbd/xml++.h"
  36 #include "pbd/undo.h"
  37 #include "pbd/stateful.h"
  38 #include "pbd/controllable.h"
  39 #include "pbd/destructible.h"
  40
  41 #include "ardour/ardour.h"
  42 #include "ardour/io.h"
  43 #include "ardour/types.h"
  44 #include "ardour/mute_master.h"
  45
  46 namespace ARDOUR {
  47
  48 class Amp;
  49 class Delivery;
  50 class IOProcessor;
  51 class Panner;
  52 class Processor;
  53 class RouteGroup;
  54 class Send;
  55 class InternalReturn;
  56
  57 class Route : public SessionObject, public AutomatableControls
  58 {
  59   public:
  60
  61         typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
  62
  63         enum Flag {
  64                 Hidden = 0x1,
  65                 MasterOut = 0x2,
  66                 ControlOut = 0x4
  67         };
  68
  69         Route (Session&, std::string name, Flag flags = Flag(0),
  70                DataType default_type = DataType::AUDIO);
  71         Route (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
  72         virtual ~Route();
  73
  74         boost::shared_ptr<IO> input() const { return _input; }
  75         boost::shared_ptr<IO> output() const { return _output; }
  76
  77         ChanCount n_inputs() const { return _input->n_ports(); }
  78         ChanCount n_outputs() const { return _output->n_ports(); }
  79
  80         bool active() const { return _active; }
  81         void set_active (bool yn);
  82
  83
  84         static std::string ensure_track_or_route_name(std::string, Session &);
  85
  86         std::string comment() { return _comment; }
  87         void set_comment (std::string str, void *src);
  88
  89         bool set_name (const std::string& str);
  90
  91         long order_key (const char* name) const;
  92         void set_order_key (const char* name, long n);
  93
  94         bool is_hidden() const { return _flags & Hidden; }
  95         bool is_master() const { return _flags & MasterOut; }
  96         bool is_control() const { return _flags & ControlOut; }
  97
  98         /* these are the core of the API of a Route. see the protected sections as well */
  99
 100         virtual int roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
 101                           int declick, bool can_record, bool rec_monitors_input);
 102
 103         virtual int no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
 104                              bool state_changing, bool can_record, bool rec_monitors_input);
 105
 106         virtual int silent_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
 107                                  bool can_record, bool rec_monitors_input);
 108
 109         virtual void toggle_monitor_input ();
 110         virtual bool can_record() { return false; }
 111
 112         virtual void set_record_enable (bool yn, void *src) {}
 113         virtual bool record_enabled() const { return false; }
 114         virtual void handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
 115         virtual void set_pending_declick (int);
 116
 117         /* end of vfunc-based API */
 118
 119         void shift (nframes64_t, nframes64_t);
 120
 121         void set_gain (gain_t val, void *src);
 122         void inc_gain (gain_t delta, void *src);
 123
 124         void set_mute (bool yn, void* src);
 125         bool muted () const;
 126
 127
 128         /* controls use set_solo() to modify this route's solo state
 129          */
 130
 131         void set_solo (bool yn, void *src);
 132         bool soloed () const { return (bool) _solo_level; }
 133
 134         void set_solo_isolated (bool yn, void *src);
 135         bool solo_isolated() const;
 136
 137         void set_listen (bool yn, void* src);
 138         bool listening () const;
 139
 140         void set_phase_invert (bool yn);
 141         bool phase_invert() const;
 142
 143         void set_denormal_protection (bool yn);
 144         bool denormal_protection() const;
 145
 146         void       set_route_group (RouteGroup *, void *);
 147         void       drop_route_group (void *);
 148         RouteGroup *route_group () const { return _route_group; }
 149
 150         virtual void set_meter_point (MeterPoint, void *src);
 151         MeterPoint   meter_point() const { return _meter_point; }
 152         void         meter ();
 153
 154         /* Processors */
 155
 156         boost::shared_ptr<Amp> amp() const  { return _amp; }
 157         PeakMeter&       peak_meter()       { return *_meter.get(); }
 158         const PeakMeter& peak_meter() const { return *_meter.get(); }
 159         boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
 160
 161         void flush_processors ();
 162
 163         void foreach_processor (sigc::slot<void, boost::weak_ptr<Processor> > method) {
 164                 Glib::RWLock::ReaderLock lm (_processor_lock);
 165                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 166                         method (boost::weak_ptr<Processor> (*i));
 167                 }
 168         }
 169
 170         void foreach_processor (Placement p, sigc::slot<void, boost::weak_ptr<Processor> > method) {
 171                 Glib::RWLock::ReaderLock lm (_processor_lock);
 172                 ProcessorList::iterator start, end;
 173                 placement_range(p, start, end);
 174                 for (ProcessorList::iterator i = start; i != end; ++i) {
 175                         method (boost::weak_ptr<Processor> (*i));
 176                 }
 177         }
 178
 179         boost::shared_ptr<Processor> nth_processor (uint32_t n) {
 180                 Glib::RWLock::ReaderLock lm (_processor_lock);
 181                 ProcessorList::iterator i;
 182                 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
 183                 if (i == _processors.end()) {
 184                         return boost::shared_ptr<Processor> ();
 185                 } else {
 186                         return *i;
 187                 }
 188         }
 189
 190         ChanCount max_processor_streams () const { return processor_max_streams; }
 191
 192         /* special processors */
 193
 194         boost::shared_ptr<Delivery>       control_outs() const { return _control_outs; }
 195         boost::shared_ptr<Delivery>       main_outs() const { return _main_outs; }
 196         boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
 197         boost::shared_ptr<Send>           internal_send_for (boost::shared_ptr<const Route> target) const;
 198         void add_internal_return ();
 199         BufferSet* get_return_buffer () const;
 200         void release_return_buffer () const;
 201         void put_control_outs_at (Placement);
 202
 203         /** A record of the stream configuration at some point in the processor list.
 204          * Used to return where and why an processor list configuration request failed.
 205          */
 206         struct ProcessorStreams {
 207                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 208
 209                 uint32_t  index; ///< Index of processor where configuration failed
 210                 ChanCount count; ///< Input requested of processor
 211         };
 212
 213         int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
 214         int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0);
 215         int add_processors (const ProcessorList&, Placement placement, ProcessorStreams* err = 0);
 216         int add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
 217         int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 218         int reorder_processors (const ProcessorList& new_order, Placement placement, ProcessorStreams* err = 0);
 219         void disable_processors (Placement);
 220         void disable_processors ();
 221         void disable_plugins (Placement);
 222         void disable_plugins ();
 223         void ab_plugins (bool forward);
 224         void clear_processors (Placement);
 225         void all_processors_flip();
 226         void all_processors_active (Placement, bool state);
 227
 228         virtual nframes_t update_total_latency();
 229         void set_latency_delay (nframes_t);
 230         void set_user_latency (nframes_t);
 231         nframes_t initial_delay() const { return _initial_delay; }
 232
 233         sigc::signal<void>       active_changed;
 234         sigc::signal<void>       phase_invert_changed;
 235         sigc::signal<void>       denormal_protection_changed;
 236         sigc::signal<void,void*> listen_changed;
 237         sigc::signal<void,void*> solo_changed;
 238         sigc::signal<void,void*> solo_safe_changed;
 239         sigc::signal<void,void*> solo_isolated_changed;
 240         sigc::signal<void,void*> comment_changed;
 241         sigc::signal<void,void*> mute_changed;
 242         sigc::signal<void,void*> pre_fader_changed;
 243         sigc::signal<void,void*> post_fader_changed;
 244         sigc::signal<void,void*> control_outs_changed;
 245         sigc::signal<void,void*> main_outs_changed;
 246         sigc::signal<void>       processors_changed;
 247         sigc::signal<void,void*> record_enable_changed;
 248         sigc::signal<void,void*> route_group_changed;
 249         sigc::signal<void,void*> meter_change;
 250         sigc::signal<void>       signal_latency_changed;
 251         sigc::signal<void>       initial_delay_changed;
 252
 253         /* gui's call this for their own purposes. */
 254
 255         sigc::signal<void,std::string,void*> gui_changed;
 256
 257         /* stateful */
 258
 259         XMLNode& get_state();
 260         int set_state(const XMLNode& node);
 261         virtual XMLNode& get_template();
 262
 263         XMLNode& get_processor_state ();
 264         virtual void set_processor_state (const XMLNode&);
 265
 266         int save_as_template (const std::string& path, const std::string& name);
 267
 268         sigc::signal<void,void*> SelectedChanged;
 269
 270         int listen_via (boost::shared_ptr<Route>, bool);
 271         void drop_listen (boost::shared_ptr<Route>);
 272
 273         bool feeds (boost::shared_ptr<Route>);
 274         std::set<boost::shared_ptr<Route> > fed_by;
 275
 276         /* Controls (not all directly owned by the Route */
 277
 278         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 279
 280         struct SoloControllable : public AutomationControl {
 281                 SoloControllable (std::string name, Route&);
 282                 void set_value (float);
 283                 float get_value (void) const;
 284
 285                 Route& route;
 286         };
 287
 288         boost::shared_ptr<AutomationControl> solo_control() const {
 289                 return _solo_control;
 290         }
 291
 292         boost::shared_ptr<AutomationControl> mute_control() const {
 293                 return _mute_master;
 294         }
 295
 296         boost::shared_ptr<MuteMaster> mute_master() const {
 297                 return _mute_master;
 298         }
 299
 300         /* Route doesn't own these items, but sub-objects that it does own have them
 301            and to make UI code a bit simpler, we provide direct access to them
 302            here.
 303         */
 304
 305         boost::shared_ptr<Panner> panner() const;
 306         boost::shared_ptr<AutomationControl> gain_control() const;
 307
 308         void automation_snapshot (nframes_t now, bool force=false);
 309         void protect_automation ();
 310
 311         void set_remote_control_id (uint32_t id);
 312         uint32_t remote_control_id () const;
 313         sigc::signal<void> RemoteControlIDChanged;
 314
 315         void sync_order_keys (const char* base);
 316         static sigc::signal<void,const char*> SyncOrderKeys;
 317
 318   protected:
 319         friend class Session;
 320
 321         void catch_up_on_solo_mute_override ();
 322         void mod_solo_level (int32_t);
 323         uint32_t solo_level () const { return _solo_level; }
 324         void set_block_size (nframes_t nframes);
 325         bool has_external_redirects() const;
 326         void curve_reallocate ();
 327         void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
 328
 329   protected:
 330         nframes_t check_initial_delay (nframes_t, nframes_t&);
 331
 332         void passthru (sframes_t start_frame, sframes_t end_frame,
 333                        nframes_t nframes, int declick);
 334
 335         virtual void process_output_buffers (BufferSet& bufs,
 336                                              sframes_t start_frame, sframes_t end_frame,
 337                                              nframes_t nframes, bool with_processors, int declick);
 338
 339         boost::shared_ptr<IO> _input;
 340         boost::shared_ptr<IO> _output;
 341
 342         bool           _active;
 343         nframes_t      _initial_delay;
 344         nframes_t      _roll_delay;
 345
 346         ProcessorList  _processors;
 347         mutable Glib::RWLock   _processor_lock;
 348         boost::shared_ptr<Delivery> _main_outs;
 349         boost::shared_ptr<Delivery> _control_outs;
 350         boost::shared_ptr<InternalReturn> _intreturn;
 351
 352         Flag           _flags;
 353         int            _pending_declick;
 354         MeterPoint     _meter_point;
 355         uint32_t       _phase_invert;
 356         uint32_t       _solo_level;
 357         bool           _solo_isolated;
 358
 359         bool           _denormal_protection;
 360
 361         bool _recordable : 1;
 362         bool _silent : 1;
 363         bool _declickable : 1;
 364
 365         boost::shared_ptr<SoloControllable> _solo_control;
 366         boost::shared_ptr<MuteMaster> _mute_master;
 367
 368         RouteGroup*    _route_group;
 369         std::string    _comment;
 370         bool           _have_internal_generator;
 371         bool           _solo_safe;
 372         DataType       _default_type;
 373
 374   protected:
 375
 376         virtual XMLNode& state(bool);
 377
 378         void passthru_silence (sframes_t start_frame, sframes_t end_frame,
 379                                nframes_t nframes, int declick);
 380
 381         void silence (nframes_t nframes);
 382
 383         sigc::connection input_signal_connection;
 384
 385         ChanCount processor_max_streams;
 386         uint32_t _remote_control_id;
 387
 388         uint32_t pans_required() const;
 389         ChanCount n_process_buffers ();
 390
 391         virtual int  _set_state (const XMLNode&, bool call_base);
 392
 393         boost::shared_ptr<Amp>       _amp;
 394         boost::shared_ptr<PeakMeter> _meter;
 395         sigc::connection _meter_connection;
 396
 397   private:
 398         void init ();
 399
 400         static uint32_t order_key_cnt;
 401
 402         struct ltstr {
 403             bool operator()(const char* s1, const char* s2) const {
 404                     return strcmp(s1, s2) < 0;
 405             }
 406         };
 407
 408         typedef std::map<const char*,long,ltstr> OrderKeys;
 409         OrderKeys order_keys;
 410
 411         void input_change_handler (IOChange, void *src);
 412         void output_change_handler (IOChange, void *src);
 413
 414         bool _in_configure_processors;
 415
 416         int configure_processors (ProcessorStreams*);
 417         int configure_processors_unlocked (ProcessorStreams*);
 418
 419         bool add_processor_from_xml (const XMLNode&, Placement);
 420         bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);
 421
 422         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 423 };
 424
 425 } // namespace ARDOUR
 426
 427 #endif /* __ardour_route_h__ */