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 #ifndef __ardour_route_h__
  20 #define __ardour_route_h__
  21
  22 #include <cmath>
  23 #include <cstring>
  24 #include <list>
  25 #include <map>
  26 #include <set>
  27 #include <string>
  28
  29 #include <boost/shared_ptr.hpp>
  30 #include <boost/weak_ptr.hpp>
  31
  32 #include <glibmm/threads.h>
  33 #include "pbd/fastlog.h"
  34 #include "pbd/xml++.h"
  35 #include "pbd/undo.h"
  36 #include "pbd/stateful.h"
  37 #include "pbd/controllable.h"
  38 #include "pbd/destructible.h"
  39
  40 #include "ardour/ardour.h"
  41 #include "ardour/gain_control.h"
  42 #include "ardour/instrument_info.h"
  43 #include "ardour/io.h"
  44 #include "ardour/io_vector.h"
  45 #include "ardour/libardour_visibility.h"
  46 #include "ardour/types.h"
  47 #include "ardour/monitorable.h"
  48 #include "ardour/muteable.h"
  49 #include "ardour/mute_master.h"
  50 #include "ardour/mute_control.h"
  51 #include "ardour/route_group_member.h"
  52 #include "ardour/stripable.h"
  53 #include "ardour/graphnode.h"
  54 #include "ardour/automatable.h"
  55 #include "ardour/unknown_processor.h"
  56 #include "ardour/soloable.h"
  57 #include "ardour/solo_control.h"
  58 #include "ardour/solo_safe_control.h"
  59 #include "ardour/slavable.h"
  60
  61 class RoutePinWindowProxy;
  62 class PatchChangeGridDialog;
  63
  64 namespace ARDOUR {
  65
  66 class Amp;
  67 class DelayLine;
  68 class Delivery;
  69 class DiskReader;
  70 class DiskWriter;
  71 class IOProcessor;
  72 class Panner;
  73 class PannerShell;
  74 class PortSet;
  75 class Processor;
  76 class PluginInsert;
  77 class RouteGroup;
  78 class Send;
  79 class InternalReturn;
  80 class MonitorControl;
  81 class MonitorProcessor;
  82 class Pannable;
  83 class CapturingProcessor;
  84 class InternalSend;
  85 class VCA;
  86 class SoloIsolateControl;
  87 class PhaseControl;
  88 class MonitorControl;
  89
  90 class LIBARDOUR_API Route : public Stripable,
  91                             public GraphNode,
  92                             public Soloable,
  93                             public Muteable,
  94                             public Monitorable,
  95                             public RouteGroupMember
  96 {
  97 public:
  98
  99         typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
 100
 101         Route (Session&, std::string name, PresentationInfo::Flag flags = PresentationInfo::Flag(0), DataType default_type = DataType::AUDIO);
 102         virtual ~Route();
 103
 104         virtual int init ();
 105
 106         DataType data_type () const {
 107                 /* XXX ultimately nice to do away with this concept, but it is
 108                    quite useful for coders and for users too.
 109                 */
 110                 return _default_type;
 111         }
 112
 113         boost::shared_ptr<IO> input() const { return _input; }
 114         boost::shared_ptr<IO> output() const { return _output; }
 115         IOVector all_inputs () const;
 116         IOVector all_outputs () const;
 117
 118         ChanCount n_inputs() const { return _input->n_ports(); }
 119         ChanCount n_outputs() const { return _output->n_ports(); }
 120
 121         bool active() const { return _active; }
 122         void set_active (bool yn, void *);
 123
 124         static std::string ensure_track_or_route_name(std::string, Session &);
 125
 126         std::string comment() { return _comment; }
 127         void set_comment (std::string str, void *src);
 128
 129         bool set_name (const std::string& str);
 130         static void set_name_in_state (XMLNode &, const std::string &, bool rename_playlist = true);
 131
 132         boost::shared_ptr<MonitorControl> monitoring_control() const { return _monitoring_control; }
 133
 134         MonitorState monitoring_state () const;
 135         virtual MeterState metering_state () const;
 136
 137         /* these are the core of the API of a Route. see the protected sections as well */
 138
 139         virtual void filter_input (BufferSet &) {}
 140
 141         virtual int roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample,
 142                           int declick, bool& need_butler);
 143
 144         virtual int no_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample,
 145                              bool state_changing);
 146
 147         virtual int silent_roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample,
 148                                  bool& need_butler);
 149
 150         virtual bool can_record() { return false; }
 151
 152         virtual void non_realtime_transport_stop (samplepos_t now, bool flush);
 153         virtual void realtime_handle_transport_stopped () {}
 154         virtual void realtime_locate () {}
 155         virtual void non_realtime_locate (samplepos_t);
 156         virtual void set_pending_declick (int);
 157
 158         /* end of vfunc-based API */
 159
 160         void shift (samplepos_t, samplecnt_t);
 161
 162         void set_trim (gain_t val, PBD::Controllable::GroupControlDisposition);
 163
 164         /* controls use set_solo() to modify this route's solo state
 165          */
 166
 167         void clear_all_solo_state ();
 168
 169         bool soloed_by_others () const { return _solo_control->soloed_by_others(); }
 170         bool soloed_by_others_upstream () const { return _solo_control->soloed_by_others_upstream(); }
 171         bool soloed_by_others_downstream () const { return _solo_control->soloed_by_others_downstream(); }
 172         bool self_soloed () const { return _solo_control->self_soloed(); }
 173         bool soloed () const { return self_soloed () || soloed_by_others (); }
 174
 175         void push_solo_upstream (int32_t delta);
 176         void push_solo_isolate_upstream (int32_t delta);
 177         bool can_solo () const {
 178                 return !(is_master() || is_monitor() || is_auditioner());
 179         }
 180         bool is_safe () const {
 181                 return _solo_safe_control->get_value();
 182         }
 183         void enable_monitor_send ();
 184
 185         void set_denormal_protection (bool yn);
 186         bool denormal_protection() const;
 187
 188         void         set_meter_point (MeterPoint, bool force = false);
 189         bool         apply_processor_changes_rt ();
 190         void         emit_pending_signals ();
 191         MeterPoint   meter_point() const { return _pending_meter_point; }
 192
 193         void         set_meter_type (MeterType t) { _meter_type = t; }
 194         MeterType    meter_type() const { return _meter_type; }
 195
 196         void set_disk_io_point (DiskIOPoint);
 197         DiskIOPoint disk_io_point() const { return _disk_io_point; }
 198
 199         /* Processors */
 200
 201         boost::shared_ptr<Amp> amp() const  { return _amp; }
 202         boost::shared_ptr<Amp> trim() const { return _trim; }
 203         boost::shared_ptr<PeakMeter>       peak_meter()       { return _meter; }
 204         boost::shared_ptr<const PeakMeter> peak_meter() const { return _meter; }
 205         boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
 206         boost::shared_ptr<DelayLine> delay_line() const  { return _delayline; }
 207
 208         void flush_processors ();
 209
 210         void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
 211                 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 212                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 213                         method (boost::weak_ptr<Processor> (*i));
 214                 }
 215         }
 216
 217         boost::shared_ptr<Processor> nth_processor (uint32_t n) {
 218                 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 219                 ProcessorList::iterator i;
 220                 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
 221                 if (i == _processors.end()) {
 222                         return boost::shared_ptr<Processor> ();
 223                 } else {
 224                         return *i;
 225                 }
 226         }
 227
 228         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
 229
 230         boost::shared_ptr<Processor> nth_plugin (uint32_t n) const;
 231         boost::shared_ptr<Processor> nth_send (uint32_t n) const;
 232
 233         bool has_io_processor_named (const std::string&);
 234         ChanCount max_processor_streams () const { return processor_max_streams; }
 235
 236         std::list<std::string> unknown_processors () const;
 237
 238         RoutePinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
 239         void set_pingmgr_proxy (RoutePinWindowProxy* wp) { _pinmgr_proxy = wp ; }
 240
 241         PatchChangeGridDialog* patch_selector_dialog () const { return _patch_selector_dialog; }
 242         void set_patch_selector_dialog  (PatchChangeGridDialog* d) { _patch_selector_dialog = d; }
 243
 244         boost::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const;
 245
 246         /* special processors */
 247
 248         boost::shared_ptr<InternalSend>     monitor_send() const { return _monitor_send; }
 249         /** the signal processorat at end of the processing chain which produces output */
 250         boost::shared_ptr<Delivery>         main_outs() const { return _main_outs; }
 251         boost::shared_ptr<InternalReturn>   internal_return() const { return _intreturn; }
 252         boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
 253         boost::shared_ptr<Send>             internal_send_for (boost::shared_ptr<const Route> target) const;
 254         void add_internal_return ();
 255         void add_send_to_internal_return (InternalSend *);
 256         void remove_send_from_internal_return (InternalSend *);
 257         void listen_position_changed ();
 258         boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
 259
 260         /** A record of the stream configuration at some point in the processor list.
 261          * Used to return where and why an processor list configuration request failed.
 262          */
 263         struct ProcessorStreams {
 264                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 265
 266                 uint32_t  index; ///< Index of processor where configuration failed
 267                 ChanCount count; ///< Input requested of processor
 268         };
 269
 270         int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
 271         int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
 272         int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
 273         int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 274         boost::shared_ptr<Processor> before_processor_for_placement (Placement);
 275         boost::shared_ptr<Processor> before_processor_for_index (int);
 276         bool processors_reorder_needs_configure (const ProcessorList& new_order);
 277         /** remove plugin/processor
 278          *
 279          * @param proc processor to remove
 280          * @param err error report (index where removal vailed, channel-count why it failed) may be nil
 281          * @param need_process_lock if locking is required (set to true, unless called from RT context with lock)
 282          * @returns 0 on success
 283          */
 284         int remove_processor (boost::shared_ptr<Processor> proc, ProcessorStreams* err = 0, bool need_process_lock = true);
 285         /** replace plugin/processor with another
 286          *
 287          * @param old processor to remove
 288          * @param sub processor to substitute the old one with
 289          * @param err error report (index where removal vailed, channel-count why it failed) may be nil
 290          * @returns 0 on success
 291          */
 292         int replace_processor (boost::shared_ptr<Processor> old, boost::shared_ptr<Processor> sub, ProcessorStreams* err = 0);
 293         int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
 294         int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
 295         void disable_processors (Placement);
 296         void disable_processors ();
 297         void disable_plugins (Placement);
 298         void disable_plugins ();
 299         void ab_plugins (bool forward);
 300         void clear_processors (Placement);
 301         void all_visible_processors_active (bool);
 302         void move_instrument_down (bool postfader = false);
 303
 304         bool strict_io () const { return _strict_io; }
 305         bool set_strict_io (bool);
 306         /** reset plugin-insert configuration to default, disable customizations.
 307          *
 308          * This is equivalent to calling
 309          * @code
 310          * customize_plugin_insert (proc, 0, unused)
 311          * @endcode
 312          *
 313          * @param proc Processor to reset
 314          * @returns true if successful
 315          */
 316         bool reset_plugin_insert (boost::shared_ptr<Processor> proc);
 317         /** enable custom plugin-insert configuration
 318          * @param proc Processor to customize
 319          * @param count number of plugin instances to use (if zero, reset to default)
 320          * @param outs output port customization
 321          * @param sinks input pins for variable-I/O plugins
 322          * @returns true if successful
 323          */
 324         bool customize_plugin_insert (boost::shared_ptr<Processor> proc, uint32_t count, ChanCount outs, ChanCount sinks);
 325         bool add_remove_sidechain (boost::shared_ptr<Processor> proc, bool);
 326         bool plugin_preset_output (boost::shared_ptr<Processor> proc, ChanCount outs);
 327
 328         /* enable sidechain input for a given processor
 329          *
 330          * The sidechain itself is an IO port object with variable number of channels and configured independently.
 331          * Adding/removing the port itself however requires reconfiguring the route and is hence
 332          * not a plugin operation itself.
 333          *
 334          * @param proc the processor to add sidechain inputs to
 335          * @returns true on success
 336          */
 337         bool add_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, true); }
 338         /* remove sidechain input from given processor
 339          * @param proc the processor to remove the sidechain input from
 340          * @returns true on success
 341          */
 342         bool remove_sidechain (boost::shared_ptr<Processor> proc) { return add_remove_sidechain (proc, false); }
 343
 344         samplecnt_t set_private_port_latencies (bool playback) const;
 345         void       set_public_port_latencies (samplecnt_t, bool playback) const;
 346
 347         samplecnt_t   update_signal_latency (bool set_initial_delay = false);
 348         virtual void set_latency_compensation (samplecnt_t);
 349
 350         void set_user_latency (samplecnt_t);
 351         samplecnt_t initial_delay() const  { return _initial_delay; }
 352         samplecnt_t signal_latency() const { return _signal_latency; }
 353
 354         PBD::Signal0<void>       active_changed;
 355         PBD::Signal0<void>       denormal_protection_changed;
 356         PBD::Signal0<void>       comment_changed;
 357
 358         /** track numbers - assigned by session
 359          * nubers > 0 indicate tracks (audio+midi)
 360          * nubers < 0 indicate busses
 361          * zero is reserved for unnumbered special busses.
 362          * */
 363         PBD::Signal0<void> track_number_changed;
 364         int64_t track_number() const { return _track_number; }
 365
 366         void set_track_number(int64_t tn) {
 367                 if (tn == _track_number) { return; }
 368                 _track_number = tn;
 369                 track_number_changed();
 370                 PropertyChanged (ARDOUR::Properties::name);
 371         }
 372
 373         enum PluginSetupOptions {
 374                 None = 0x0,
 375                 CanReplace = 0x1,
 376                 MultiOut = 0x2,
 377         };
 378
 379         static PBD::Signal3<int,boost::shared_ptr<Route>, boost::shared_ptr<PluginInsert>, PluginSetupOptions > PluginSetup;
 380
 381         /** the processors have changed; the parameter indicates what changed */
 382         PBD::Signal1<void,RouteProcessorChange> processors_changed;
 383         PBD::Signal0<void> fan_out; // used to signal the GUI to fan-out (track-creation)
 384         PBD::Signal1<void,void*> record_enable_changed;
 385         PBD::Signal0<void> processor_latency_changed;
 386         /** the metering point has changed */
 387         PBD::Signal0<void>       meter_change;
 388         PBD::Signal0<void>       signal_latency_changed;
 389         PBD::Signal0<void>       initial_delay_changed;
 390
 391         /** Emitted with the process lock held */
 392         PBD::Signal0<void>       io_changed;
 393
 394         /* stateful */
 395
 396         XMLNode& get_state();
 397         virtual int set_state (const XMLNode&, int version);
 398         virtual XMLNode& get_template();
 399
 400         XMLNode& get_processor_state ();
 401         void set_processor_state (const XMLNode&);
 402         virtual bool set_processor_state (XMLNode const & node, XMLProperty const* prop, ProcessorList& new_order, bool& must_configure);
 403
 404         boost::weak_ptr<Route> weakroute ();
 405
 406         int save_as_template (const std::string& path, const std::string& name, const std::string& description );
 407
 408         PBD::Signal1<void,void*> SelectedChanged;
 409
 410         int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
 411         void remove_aux_or_listen (boost::shared_ptr<Route>);
 412
 413         /**
 414          * return true if this route feeds the first argument via at least one
 415          * (arbitrarily long) signal pathway.
 416          */
 417         bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
 418
 419         /**
 420          * return true if this route feeds the first argument directly, via
 421          * either its main outs or a send.  This is checked by the actual
 422          * connections, rather than by what the graph is currently doing.
 423          */
 424         bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
 425
 426         /**
 427          * return true if this route feeds the first argument directly, via
 428          * either its main outs or a send, according to the graph that
 429          * is currently being processed.
 430          */
 431         bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
 432
 433         bool feeds_according_to_graph (boost::shared_ptr<Route>);
 434
 435         struct FeedRecord {
 436                 boost::weak_ptr<Route> r;
 437                 bool sends_only;
 438
 439                 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
 440                 : r (rp)
 441                 , sends_only (sendsonly) {}
 442         };
 443
 444         struct FeedRecordCompare {
 445                 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
 446                         return a.r < b.r;
 447                 }
 448         };
 449
 450         typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
 451
 452         const FedBy& fed_by() const { return _fed_by; }
 453         void clear_fed_by ();
 454         bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
 455
 456         /* Controls (not all directly owned by the Route) */
 457
 458         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 459
 460         boost::shared_ptr<SoloControl> solo_control() const {
 461                 return _solo_control;
 462         }
 463
 464         boost::shared_ptr<MuteControl> mute_control() const {
 465                 return _mute_control;
 466         }
 467
 468         bool can_be_muted_by_others () const { return can_solo(); }
 469         bool muted () const { return _mute_control->muted(); }
 470         bool muted_by_masters () const { return _mute_control->muted_by_masters(); }
 471         bool muted_by_self () const { return _mute_control->muted_by_self(); }
 472         bool muted_by_others_soloing () const;
 473
 474         boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const {
 475                 return _solo_isolate_control;
 476         }
 477
 478         boost::shared_ptr<SoloSafeControl> solo_safe_control() const {
 479                 return _solo_safe_control;
 480         }
 481
 482         /* Route doesn't own these items, but sub-objects that it does own have them
 483            and to make UI code a bit simpler, we provide direct access to them
 484            here.
 485         */
 486
 487         boost::shared_ptr<Panner> panner() const;  /* may return null */
 488         boost::shared_ptr<PannerShell> panner_shell() const;
 489         boost::shared_ptr<Pannable> pannable() const;
 490
 491         boost::shared_ptr<GainControl> gain_control() const;
 492         boost::shared_ptr<GainControl> trim_control() const;
 493         boost::shared_ptr<PhaseControl> phase_control() const;
 494
 495         /**
 496            Return the first processor that accepts has at least one MIDI input
 497            and at least one audio output. In the vast majority of cases, this
 498            will be "the instrument". This does not preclude other MIDI->audio
 499            processors later in the processing chain, but that would be a
 500            special case not covered by this utility function.
 501         */
 502         boost::shared_ptr<Processor> the_instrument() const;
 503         InstrumentInfo& instrument_info() { return _instrument_info; }
 504
 505         /* "well-known" controls for panning. Any or all of these may return
 506          * null.
 507          */
 508
 509         boost::shared_ptr<AutomationControl> pan_azimuth_control() const;
 510         boost::shared_ptr<AutomationControl> pan_elevation_control() const;
 511         boost::shared_ptr<AutomationControl> pan_width_control() const;
 512         boost::shared_ptr<AutomationControl> pan_frontback_control() const;
 513         boost::shared_ptr<AutomationControl> pan_lfe_control() const;
 514
 515         /* "well-known" controls for an EQ in this route. Any or all may
 516          * be null. eq_band_cnt() must return 0 if there is no EQ present.
 517          * Passing an @param band value >= eq_band_cnt() will guarantee the
 518          * return of a null ptr (or an empty string for eq_band_name()).
 519          */
 520         uint32_t eq_band_cnt () const;
 521         std::string eq_band_name (uint32_t) const;
 522         boost::shared_ptr<AutomationControl> eq_enable_controllable () const;
 523         boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const;
 524         boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const;
 525         boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const;
 526         boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const;
 527
 528         //additional HP/LP filters
 529         boost::shared_ptr<AutomationControl> filter_freq_controllable (bool hpf) const;
 530         boost::shared_ptr<AutomationControl> filter_slope_controllable (bool) const;
 531         boost::shared_ptr<AutomationControl> filter_enable_controllable (bool) const;
 532
 533
 534         /* "well-known" controls for a compressor in this route. Any or all may
 535          * be null.
 536          */
 537         boost::shared_ptr<AutomationControl> comp_enable_controllable () const;
 538         boost::shared_ptr<AutomationControl> comp_threshold_controllable () const;
 539         boost::shared_ptr<AutomationControl> comp_speed_controllable () const;
 540         boost::shared_ptr<AutomationControl> comp_mode_controllable () const;
 541         boost::shared_ptr<AutomationControl> comp_makeup_controllable () const;
 542         boost::shared_ptr<ReadOnlyControl>   comp_redux_controllable () const;
 543
 544         /* @param mode must be supplied by the comp_mode_controllable(). All other values
 545          * result in undefined behaviour
 546          */
 547         std::string comp_mode_name (uint32_t mode) const;
 548         /* @param mode - as for comp mode name. This returns the name for the
 549          * parameter/control accessed via comp_speed_controllable(), which can
 550          * be mode dependent.
 551          */
 552         std::string comp_speed_name (uint32_t mode) const;
 553
 554         /* "well-known" controls for sends to well-known busses in this route. Any or all may
 555          * be null.
 556          *
 557          * In Mixbus, these are the sends that connect to the mixbusses.
 558          * In Ardour, these are user-created sends that connect to user-created
 559          * Aux busses.
 560          */
 561         boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const;
 562         boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const;
 563         /* for the same value of @param n, this returns the name of the send
 564          * associated with the pair of controllables returned by the above two methods.
 565          */
 566         std::string send_name (uint32_t n) const;
 567
 568         /* well known control that enables/disables sending to the master bus.
 569          *
 570          * In Ardour, this returns null.
 571          * In Mixbus, it will return a suitable control, or null depending on
 572          * the route.
 573          */
 574         boost::shared_ptr<AutomationControl> master_send_enable_controllable () const;
 575
 576         void protect_automation ();
 577
 578         bool has_external_redirects() const;
 579
 580         /* can only be executed by a route for which is_monitor() is true
 581          *       (i.e. the monitor out)
 582          */
 583         void monitor_run (samplepos_t start_sample, samplepos_t end_sample,
 584                         pframes_t nframes, int declick);
 585
 586         bool slaved_to (boost::shared_ptr<VCA>) const;
 587         bool slaved () const;
 588
 589         virtual void use_captured_sources (SourceList& srcs, CaptureInfos const &) {}
 590
 591   protected:
 592         friend class Session;
 593
 594         void catch_up_on_solo_mute_override ();
 595         void set_listen (bool);
 596
 597         void curve_reallocate ();
 598         virtual void set_block_size (pframes_t nframes);
 599
 600         virtual samplecnt_t check_initial_delay (samplecnt_t nframes, samplepos_t&) { return nframes; }
 601
 602         void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
 603
 604         void passthru (BufferSet&, samplepos_t start_sample, samplepos_t end_sample, pframes_t nframes, int declick, bool gain_automation_ok);
 605
 606         virtual void write_out_of_band_data (BufferSet& /* bufs */, samplepos_t /* start_sample */, samplepos_t /* end_sample */,
 607                                              samplecnt_t /* nframes */) {}
 608
 609         virtual void process_output_buffers (BufferSet& bufs,
 610                                              samplepos_t start_sample, samplepos_t end_sample,
 611                                              pframes_t nframes, int declick,
 612                                              bool gain_automation_ok);
 613
 614         void flush_processor_buffers_locked (samplecnt_t nframes);
 615
 616         virtual void bounce_process (BufferSet& bufs,
 617                                      samplepos_t start_sample, samplecnt_t nframes,
 618                                                                                                                          boost::shared_ptr<Processor> endpoint, bool include_endpoint,
 619                                      bool for_export, bool for_freeze);
 620
 621         samplecnt_t   bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 622         ChanCount    bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 623
 624         boost::shared_ptr<IO> _input;
 625         boost::shared_ptr<IO> _output;
 626
 627         bool           _active;
 628         samplecnt_t     _signal_latency;
 629         samplecnt_t     _initial_delay;
 630
 631         ProcessorList  _processors;
 632         mutable Glib::Threads::RWLock   _processor_lock;
 633         boost::shared_ptr<Delivery> _main_outs;
 634         boost::shared_ptr<InternalSend> _monitor_send;
 635         boost::shared_ptr<InternalReturn> _intreturn;
 636         boost::shared_ptr<MonitorProcessor> _monitor_control;
 637         boost::shared_ptr<Pannable> _pannable;
 638         boost::shared_ptr<DiskReader> _disk_reader;
 639         boost::shared_ptr<DiskWriter> _disk_writer;
 640         boost::shared_ptr<MonitorControl> _monitoring_control;
 641
 642         DiskIOPoint    _disk_io_point;
 643
 644         enum {
 645                 EmitNone = 0x00,
 646                 EmitMeterChanged = 0x01,
 647                 EmitMeterVisibilityChange = 0x02,
 648                 EmitRtProcessorChange = 0x04
 649         };
 650
 651         ProcessorList  _pending_processor_order;
 652         gint           _pending_process_reorder; // atomic
 653         gint           _pending_signals; // atomic
 654
 655         int            _pending_declick;
 656         MeterPoint     _meter_point;
 657         MeterPoint     _pending_meter_point;
 658         MeterType      _meter_type;
 659
 660         bool           _denormal_protection;
 661
 662         bool _recordable : 1;
 663         bool _silent : 1;
 664         bool _declickable : 1;
 665
 666         boost::shared_ptr<SoloControl> _solo_control;
 667         boost::shared_ptr<MuteControl> _mute_control;
 668         boost::shared_ptr<PhaseControl> _phase_control;
 669         boost::shared_ptr<SoloIsolateControl> _solo_isolate_control;
 670         boost::shared_ptr<SoloSafeControl> _solo_safe_control;
 671
 672         std::string    _comment;
 673         bool           _have_internal_generator;
 674         DataType       _default_type;
 675         FedBy          _fed_by;
 676
 677         InstrumentInfo _instrument_info;
 678
 679         virtual ChanCount input_streams () const;
 680
 681         virtual XMLNode& state(bool);
 682
 683         int configure_processors (ProcessorStreams*);
 684
 685         void passthru_silence (samplepos_t start_sample, samplepos_t end_sample,
 686                                pframes_t nframes, int declick);
 687
 688         void silence (samplecnt_t);
 689         void silence_unlocked (samplecnt_t);
 690
 691         ChanCount processor_max_streams;
 692         ChanCount processor_out_streams;
 693
 694         uint32_t pans_required() const;
 695         ChanCount n_process_buffers ();
 696
 697         virtual void maybe_declick (BufferSet&, samplecnt_t, int);
 698
 699         boost::shared_ptr<GainControl> _gain_control;
 700         boost::shared_ptr<Amp>       _amp;
 701         boost::shared_ptr<GainControl> _trim_control;
 702         boost::shared_ptr<Amp>       _trim;
 703         boost::shared_ptr<PeakMeter> _meter;
 704         boost::shared_ptr<DelayLine> _delayline;
 705
 706         boost::shared_ptr<Processor> the_instrument_unlocked() const;
 707
 708         SlavableControlList slavables () const;
 709
 710 private:
 711         int64_t _track_number;
 712
 713         int set_state_2X (const XMLNode&, int);
 714         void set_processor_state_2X (XMLNodeList const &, int);
 715
 716         void input_change_handler (IOChange, void *src);
 717         void output_change_handler (IOChange, void *src);
 718         void sidechain_change_handler (IOChange, void *src);
 719
 720         void processor_selfdestruct (boost::weak_ptr<Processor>);
 721         std::vector<boost::weak_ptr<Processor> > selfdestruct_sequence;
 722         Glib::Threads::Mutex  selfdestruct_lock;
 723
 724         bool input_port_count_changing (ChanCount);
 725         bool output_port_count_changing (ChanCount);
 726
 727         bool _in_configure_processors;
 728         bool _initial_io_setup;
 729         bool _in_sidechain_setup;
 730
 731         int configure_processors_unlocked (ProcessorStreams*, Glib::Threads::RWLock::WriterLock*);
 732         bool set_meter_point_unlocked ();
 733         void apply_processor_order (const ProcessorList& new_order);
 734
 735         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
 736         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
 737
 738         bool add_processor_from_xml_2X (const XMLNode&, int);
 739
 740         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 741
 742         void set_self_solo (bool yn);
 743
 744         void set_processor_positions ();
 745         samplecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, samplecnt_t) const;
 746
 747         void setup_invisible_processors ();
 748
 749         void unpan ();
 750
 751         void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
 752
 753         boost::shared_ptr<CapturingProcessor> _capturing_processor;
 754
 755         /** A handy class to keep processor state while we attempt a reconfiguration
 756          *  that may fail.
 757          */
 758         class ProcessorState {
 759         public:
 760                 ProcessorState (Route* r)
 761                         : _route (r)
 762                         , _processors (r->_processors)
 763                         , _processor_max_streams (r->processor_max_streams)
 764                 { }
 765
 766                 void restore () {
 767                         _route->_processors = _processors;
 768                         _route->processor_max_streams = _processor_max_streams;
 769                 }
 770
 771         private:
 772                 /* this should perhaps be a shared_ptr, but ProcessorStates will
 773                    not hang around long enough for it to matter.
 774                 */
 775                 Route* _route;
 776                 ProcessorList _processors;
 777                 ChanCount _processor_max_streams;
 778         };
 779
 780         friend class ProcessorState;
 781
 782         bool _strict_io;
 783
 784         /* no copy construction */
 785         Route (Route const &);
 786
 787         void maybe_note_meter_position ();
 788
 789         /** true if we've made a note of a custom meter position in these variables */
 790         bool _custom_meter_position_noted;
 791         /** the processor that came after the meter when it was last set to a custom position,
 792             or 0.
 793         */
 794         boost::weak_ptr<Processor> _processor_after_last_custom_meter;
 795         RoutePinWindowProxy *_pinmgr_proxy;
 796         PatchChangeGridDialog* _patch_selector_dialog;
 797
 798         void reset_instrument_info ();
 799
 800         void solo_control_changed (bool self, PBD::Controllable::GroupControlDisposition);
 801 };
 802
 803 } // namespace ARDOUR
 804
 805 #endif /* __ardour_route_h__ */