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         void set_solo (bool yn, void *src);
 128         bool soloed() const;
 129
 130         void set_solo_isolated (bool yn, void *src);
 131         bool solo_isolated() const;
 132
 133         void set_phase_invert (bool yn);
 134         bool phase_invert() const;
 135
 136         void set_denormal_protection (bool yn);
 137         bool denormal_protection() const;
 138
 139         void       set_edit_group (RouteGroup *, void *);
 140         void       drop_edit_group (void *);
 141         RouteGroup *edit_group () const { return _edit_group; }
 142
 143         void       set_mix_group (RouteGroup *, void *);
 144         void       drop_mix_group (void *);
 145         RouteGroup *mix_group () const { return _mix_group; }
 146
 147         virtual void set_meter_point (MeterPoint, void *src);
 148         MeterPoint   meter_point() const { return _meter_point; }
 149         void         meter ();
 150
 151         /* Processors */
 152
 153         boost::shared_ptr<Amp> amp() const  { return _amp; }
 154         PeakMeter&       peak_meter()       { return *_meter.get(); }
 155         const PeakMeter& peak_meter() const { return *_meter.get(); }
 156         boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
 157
 158         void flush_processors ();
 159
 160         void foreach_processor (sigc::slot<void, boost::weak_ptr<Processor> > method) {
 161                 Glib::RWLock::ReaderLock lm (_processor_lock);
 162                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 163                         method (boost::weak_ptr<Processor> (*i));
 164                 }
 165         }
 166
 167         void foreach_processor (Placement p, sigc::slot<void, boost::weak_ptr<Processor> > method) {
 168                 Glib::RWLock::ReaderLock lm (_processor_lock);
 169                 ProcessorList::iterator start, end;
 170                 placement_range(p, start, end);
 171                 for (ProcessorList::iterator i = start; i != end; ++i) {
 172                         method (boost::weak_ptr<Processor> (*i));
 173                 }
 174         }
 175
 176         boost::shared_ptr<Processor> nth_processor (uint32_t n) {
 177                 Glib::RWLock::ReaderLock lm (_processor_lock);
 178                 ProcessorList::iterator i;
 179                 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
 180                 if (i == _processors.end()) {
 181                         return boost::shared_ptr<Processor> ();
 182                 } else {
 183                         return *i;
 184                 }
 185         }
 186
 187         ChanCount max_processor_streams () const { return processor_max_streams; }
 188
 189         /* special processors */
 190
 191         boost::shared_ptr<Delivery>       control_outs() const { return _control_outs; }
 192         boost::shared_ptr<Delivery>       main_outs() const { return _main_outs; }
 193         boost::shared_ptr<InternalReturn> internal_return() const { return _intreturn; }
 194         boost::shared_ptr<Send>           internal_send_for (boost::shared_ptr<const Route> target) const;
 195         BufferSet* get_return_buffer () const;
 196         void release_return_buffer () const;
 197
 198         /** A record of the stream configuration at some point in the processor list.
 199          * Used to return where and why an processor list configuration request failed.
 200          */
 201         struct ProcessorStreams {
 202                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 203
 204                 uint32_t  index; ///< Index of processor where configuration failed
 205                 ChanCount count; ///< Input requested of processor
 206         };
 207
 208         int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0);
 209         int add_processor (boost::shared_ptr<Processor>, ProcessorList::iterator iter, ProcessorStreams* err = 0);
 210         int add_processors (const ProcessorList&, Placement placement, ProcessorStreams* err = 0);
 211         int add_processors (const ProcessorList&, ProcessorList::iterator iter, ProcessorStreams* err = 0);
 212         int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 213         int reorder_processors (const ProcessorList& new_order, Placement placement, ProcessorStreams* err = 0);
 214         void disable_processors (Placement);
 215         void disable_processors ();
 216         void disable_plugins (Placement);
 217         void disable_plugins ();
 218         void ab_plugins (bool forward);
 219         void clear_processors (Placement);
 220         void all_processors_flip();
 221         void all_processors_active (Placement, bool state);
 222
 223         virtual nframes_t update_total_latency();
 224         void set_latency_delay (nframes_t);
 225         void set_user_latency (nframes_t);
 226         nframes_t initial_delay() const { return _initial_delay; }
 227
 228         sigc::signal<void>       active_changed;
 229         sigc::signal<void>       phase_invert_changed;
 230         sigc::signal<void>       denormal_protection_changed;
 231         sigc::signal<void,void*> solo_changed;
 232         sigc::signal<void,void*> solo_safe_changed;
 233         sigc::signal<void,void*> solo_isolated_changed;
 234         sigc::signal<void,void*> comment_changed;
 235         sigc::signal<void,void*> mute_changed;
 236         sigc::signal<void,void*> pre_fader_changed;
 237         sigc::signal<void,void*> post_fader_changed;
 238         sigc::signal<void,void*> control_outs_changed;
 239         sigc::signal<void,void*> main_outs_changed;
 240         sigc::signal<void>       processors_changed;
 241         sigc::signal<void,void*> record_enable_changed;
 242         sigc::signal<void,void*> edit_group_changed;
 243         sigc::signal<void,void*> mix_group_changed;
 244         sigc::signal<void,void*> meter_change;
 245         sigc::signal<void>       signal_latency_changed;
 246         sigc::signal<void>       initial_delay_changed;
 247
 248         /* gui's call this for their own purposes. */
 249
 250         sigc::signal<void,std::string,void*> gui_changed;
 251
 252         /* stateful */
 253
 254         XMLNode& get_state();
 255         int set_state(const XMLNode& node);
 256         virtual XMLNode& get_template();
 257
 258         XMLNode& get_processor_state ();
 259         virtual void set_processor_state (const XMLNode&);
 260
 261         int save_as_template (const std::string& path, const std::string& name);
 262
 263         sigc::signal<void,void*> SelectedChanged;
 264
 265         int listen_via (boost::shared_ptr<Route>, const std::string& name);
 266         void drop_listen (boost::shared_ptr<Route>);
 267
 268         bool feeds (boost::shared_ptr<Route>);
 269         std::set<boost::shared_ptr<Route> > fed_by;
 270
 271         /* Controls (not all directly owned by the Route */
 272
 273         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 274
 275         struct SoloControllable : public AutomationControl {
 276                 SoloControllable (std::string name, Route&);
 277                 void set_value (float);
 278                 float get_value (void) const;
 279
 280                 Route& route;
 281         };
 282
 283         boost::shared_ptr<AutomationControl> solo_control() const {
 284                 return _solo_control;
 285         }
 286
 287         boost::shared_ptr<AutomationControl> mute_control() const {
 288                 return _mute_master;
 289         }
 290
 291         boost::shared_ptr<MuteMaster> mute_master() const {
 292                 return _mute_master;
 293         }
 294
 295         /* Route doesn't own these items, but sub-objects that it does own have them
 296            and to make UI code a bit simpler, we provide direct access to them
 297            here.
 298         */
 299
 300         boost::shared_ptr<Panner> panner() const;
 301         boost::shared_ptr<AutomationControl> gain_control() const;
 302
 303         void automation_snapshot (nframes_t now, bool force=false);
 304         void protect_automation ();
 305
 306         void set_remote_control_id (uint32_t id);
 307         uint32_t remote_control_id () const;
 308         sigc::signal<void> RemoteControlIDChanged;
 309
 310         void sync_order_keys (const char* base);
 311         static sigc::signal<void,const char*> SyncOrderKeys;
 312
 313   protected:
 314         friend class Session;
 315
 316         void catch_up_on_solo_mute_override ();
 317         void mod_solo_level (int32_t);
 318         void set_block_size (nframes_t nframes);
 319         bool has_external_redirects() const;
 320         void curve_reallocate ();
 321         void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
 322
 323   protected:
 324         nframes_t check_initial_delay (nframes_t, nframes_t&);
 325
 326         void passthru (sframes_t start_frame, sframes_t end_frame,
 327                        nframes_t nframes, int declick);
 328
 329         virtual void process_output_buffers (BufferSet& bufs,
 330                                              sframes_t start_frame, sframes_t end_frame,
 331                                              nframes_t nframes, bool with_processors, int declick);
 332
 333         boost::shared_ptr<IO> _input;
 334         boost::shared_ptr<IO> _output;
 335
 336         bool           _active;
 337         nframes_t      _initial_delay;
 338         nframes_t      _roll_delay;
 339
 340         ProcessorList  _processors;
 341         mutable Glib::RWLock   _processor_lock;
 342         boost::shared_ptr<Delivery> _main_outs;
 343         boost::shared_ptr<Delivery> _control_outs; // XXX to be removed/generalized by listen points
 344         boost::shared_ptr<InternalReturn> _intreturn;
 345
 346         Flag           _flags;
 347         int            _pending_declick;
 348         MeterPoint     _meter_point;
 349         uint32_t       _phase_invert;
 350         bool           _denormal_protection;
 351
 352         bool _recordable : 1;
 353         bool _silent : 1;
 354         bool _declickable : 1;
 355
 356         boost::shared_ptr<SoloControllable> _solo_control;
 357         boost::shared_ptr<MuteMaster> _mute_master;
 358
 359         RouteGroup*    _edit_group;
 360         RouteGroup*    _mix_group;
 361         std::string    _comment;
 362         bool           _have_internal_generator;
 363         bool           _solo_safe;
 364         DataType       _default_type;
 365
 366   protected:
 367
 368         virtual XMLNode& state(bool);
 369
 370         void passthru_silence (sframes_t start_frame, sframes_t end_frame,
 371                                nframes_t nframes, int declick);
 372
 373         void silence (nframes_t nframes);
 374
 375         sigc::connection input_signal_connection;
 376
 377         ChanCount processor_max_streams;
 378         uint32_t _remote_control_id;
 379
 380         uint32_t pans_required() const;
 381         ChanCount n_process_buffers ();
 382
 383         virtual int  _set_state (const XMLNode&, bool call_base);
 384
 385         boost::shared_ptr<Amp>       _amp;
 386         boost::shared_ptr<PeakMeter> _meter;
 387         sigc::connection _meter_connection;
 388
 389   private:
 390         void init ();
 391
 392         static uint32_t order_key_cnt;
 393
 394         struct ltstr {
 395             bool operator()(const char* s1, const char* s2) const {
 396                     return strcmp(s1, s2) < 0;
 397             }
 398         };
 399
 400         typedef std::map<const char*,long,ltstr> OrderKeys;
 401         OrderKeys order_keys;
 402
 403         void input_change_handler (IOChange, void *src);
 404         void output_change_handler (IOChange, void *src);
 405
 406         bool _in_configure_processors;
 407
 408         int configure_processors (ProcessorStreams*);
 409         int configure_processors_unlocked (ProcessorStreams*);
 410
 411         bool add_processor_from_xml (const XMLNode&, Placement);
 412         bool add_processor_from_xml (const XMLNode&, ProcessorList::iterator iter);
 413
 414         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 415 };
 416
 417 } // namespace ARDOUR
 418
 419 #endif /* __ardour_route_h__ */