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