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 #include <boost/dynamic_bitset.hpp>
  33 #include <boost/enable_shared_from_this.hpp>
  34
  35 #include <glibmm/threads.h>
  36 #include "pbd/fastlog.h"
  37 #include "pbd/xml++.h"
  38 #include "pbd/undo.h"
  39 #include "pbd/stateful.h"
  40 #include "pbd/controllable.h"
  41 #include "pbd/destructible.h"
  42
  43 #include "ardour/ardour.h"
  44 #include "ardour/instrument_info.h"
  45 #include "ardour/io.h"
  46 #include "ardour/libardour_visibility.h"
  47 #include "ardour/types.h"
  48 #include "ardour/mute_master.h"
  49 #include "ardour/route_group_member.h"
  50 #include "ardour/graphnode.h"
  51 #include "ardour/automatable.h"
  52 #include "ardour/unknown_processor.h"
  53
  54 namespace ARDOUR {
  55
  56 class Amp;
  57 class DelayLine;
  58 class Delivery;
  59 class IOProcessor;
  60 class Panner;
  61 class PannerShell;
  62 class PortSet;
  63 class Processor;
  64 class RouteGroup;
  65 class Send;
  66 class InternalReturn;
  67 class MonitorProcessor;
  68 class Pannable;
  69 class CapturingProcessor;
  70 class InternalSend;
  71
  72 class LIBARDOUR_API Route : public SessionObject, public Automatable, public RouteGroupMember, public GraphNode, public boost::enable_shared_from_this<Route>
  73 {
  74   public:
  75
  76         typedef std::list<boost::shared_ptr<Processor> > ProcessorList;
  77
  78         enum Flag {
  79                 Auditioner = 0x1,
  80                 MasterOut = 0x2,
  81                 MonitorOut = 0x4
  82         };
  83
  84         Route (Session&, std::string name, Flag flags = Flag(0), DataType default_type = DataType::AUDIO);
  85         virtual ~Route();
  86
  87         virtual int init ();
  88
  89         boost::shared_ptr<IO> input() const { return _input; }
  90         boost::shared_ptr<IO> output() const { return _output; }
  91
  92         ChanCount n_inputs() const { return _input->n_ports(); }
  93         ChanCount n_outputs() const { return _output->n_ports(); }
  94
  95         bool active() const { return _active; }
  96         void set_active (bool yn, void *);
  97
  98         static std::string ensure_track_or_route_name(std::string, Session &);
  99
 100         std::string comment() { return _comment; }
 101         void set_comment (std::string str, void *src);
 102
 103         bool set_name (const std::string& str);
 104         static void set_name_in_state (XMLNode &, const std::string &);
 105
 106         uint32_t order_key () const;
 107         bool has_order_key () const;
 108         void set_order_key (uint32_t);
 109
 110         bool is_auditioner() const { return _flags & Auditioner; }
 111         bool is_master() const { return _flags & MasterOut; }
 112         bool is_monitor() const { return _flags & MonitorOut; }
 113
 114         virtual MonitorState monitoring_state () const;
 115         virtual MeterState metering_state () const;
 116
 117         /* these are the core of the API of a Route. see the protected sections as well */
 118
 119         virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 120                           int declick, bool& need_butler);
 121
 122         virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 123                              bool state_changing);
 124
 125         virtual int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 126                                  bool& need_butler);
 127
 128         virtual bool can_record() { return false; }
 129
 130         virtual void set_record_enabled (bool /*yn*/, void * /*src*/) {}
 131         virtual bool record_enabled() const { return false; }
 132         virtual void set_record_safe (bool yn, void *src) {}
 133         virtual bool record_safe () const {return false; }
 134         virtual void nonrealtime_handle_transport_stopped (bool abort, bool did_locate, bool flush_processors);
 135         virtual void realtime_handle_transport_stopped () {}
 136         virtual void realtime_locate () {}
 137         virtual void non_realtime_locate (framepos_t);
 138         virtual void set_pending_declick (int);
 139
 140         /* end of vfunc-based API */
 141
 142         void shift (framepos_t, framecnt_t);
 143
 144         void set_gain (gain_t val, void *src);
 145         void inc_gain (gain_t delta, void *src);
 146
 147         void set_trim (gain_t val, void *src);
 148         void inc_trim (gain_t delta, void *src);
 149
 150         void set_mute_points (MuteMaster::MutePoint);
 151         MuteMaster::MutePoint mute_points () const;
 152
 153         bool muted () const;
 154         void set_mute (bool yn, void* src);
 155
 156         bool muted_by_others() const;
 157
 158         /* controls use set_solo() to modify this route's solo state
 159          */
 160
 161         void set_solo (bool yn, void *src, bool group_override = false);
 162         bool soloed () const { return self_soloed () || soloed_by_others (); }
 163         void clear_all_solo_state ();
 164
 165         bool soloed_by_others () const { return _soloed_by_others_upstream||_soloed_by_others_downstream; }
 166         bool soloed_by_others_upstream () const { return _soloed_by_others_upstream; }
 167         bool soloed_by_others_downstream () const { return _soloed_by_others_downstream; }
 168         bool self_soloed () const { return _self_solo; }
 169
 170         void set_solo_isolated (bool yn, void *src);
 171         bool solo_isolated() const;
 172
 173         void set_solo_safe (bool yn, void *src);
 174         bool solo_safe() const;
 175
 176         void set_listen (bool yn, void* src, bool group_override = false);
 177         bool listening_via_monitor () const;
 178         void enable_monitor_send ();
 179
 180         void set_phase_invert (uint32_t, bool yn);
 181         void set_phase_invert (boost::dynamic_bitset<>);
 182         bool phase_invert (uint32_t) const;
 183         boost::dynamic_bitset<> phase_invert () const;
 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         /* Processors */
 197
 198         boost::shared_ptr<Amp> amp() const  { return _amp; }
 199         boost::shared_ptr<Amp> trim() const { return _trim; }
 200         PeakMeter&       peak_meter()       { return *_meter.get(); }
 201         const PeakMeter& peak_meter() const { return *_meter.get(); }
 202         boost::shared_ptr<PeakMeter> shared_peak_meter() const { return _meter; }
 203         boost::shared_ptr<DelayLine> delay_line() const  { return _delayline; }
 204
 205         void flush_processors ();
 206
 207         void foreach_processor (boost::function<void(boost::weak_ptr<Processor>)> method) {
 208                 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 209                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
 210                         method (boost::weak_ptr<Processor> (*i));
 211                 }
 212         }
 213
 214         boost::shared_ptr<Processor> nth_processor (uint32_t n) {
 215                 Glib::Threads::RWLock::ReaderLock lm (_processor_lock);
 216                 ProcessorList::iterator i;
 217                 for (i = _processors.begin(); i != _processors.end() && n; ++i, --n) {}
 218                 if (i == _processors.end()) {
 219                         return boost::shared_ptr<Processor> ();
 220                 } else {
 221                         return *i;
 222                 }
 223         }
 224
 225         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
 226
 227         boost::shared_ptr<Processor> nth_plugin (uint32_t n);
 228         boost::shared_ptr<Processor> nth_send (uint32_t n);
 229
 230         bool has_io_processor_named (const std::string&);
 231         ChanCount max_processor_streams () const { return processor_max_streams; }
 232
 233         std::list<std::string> unknown_processors () const;
 234
 235         /* special processors */
 236
 237         boost::shared_ptr<InternalSend>     monitor_send() const { return _monitor_send; }
 238         boost::shared_ptr<Delivery>         main_outs() const { return _main_outs; }
 239         boost::shared_ptr<InternalReturn>   internal_return() const { return _intreturn; }
 240         boost::shared_ptr<MonitorProcessor> monitor_control() const { return _monitor_control; }
 241         boost::shared_ptr<Send>             internal_send_for (boost::shared_ptr<const Route> target) const;
 242         void add_internal_return ();
 243         void add_send_to_internal_return (InternalSend *);
 244         void remove_send_from_internal_return (InternalSend *);
 245         void listen_position_changed ();
 246         boost::shared_ptr<CapturingProcessor> add_export_point(/* Add some argument for placement later */);
 247
 248         /** A record of the stream configuration at some point in the processor list.
 249          * Used to return where and why an processor list configuration request failed.
 250          */
 251         struct ProcessorStreams {
 252                 ProcessorStreams(size_t i=0, ChanCount c=ChanCount()) : index(i), count(c) {}
 253
 254                 uint32_t  index; ///< Index of processor where configuration failed
 255                 ChanCount count; ///< Input requested of processor
 256         };
 257
 258         int add_processor (boost::shared_ptr<Processor>, Placement placement, ProcessorStreams* err = 0, bool activation_allowed = true);
 259         int add_processor_by_index (boost::shared_ptr<Processor>, int, ProcessorStreams* err = 0, bool activation_allowed = true);
 260         int add_processor (boost::shared_ptr<Processor>, boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool activation_allowed = true);
 261         int add_processors (const ProcessorList&, boost::shared_ptr<Processor>, ProcessorStreams* err = 0);
 262         boost::shared_ptr<Processor> before_processor_for_placement (Placement);
 263         boost::shared_ptr<Processor> before_processor_for_index (int);
 264         bool processors_reorder_needs_configure (const ProcessorList& new_order);
 265         int remove_processor (boost::shared_ptr<Processor>, ProcessorStreams* err = 0, bool need_process_lock = true);
 266         int remove_processors (const ProcessorList&, ProcessorStreams* err = 0);
 267         int reorder_processors (const ProcessorList& new_order, ProcessorStreams* err = 0);
 268         void disable_processors (Placement);
 269         void disable_processors ();
 270         void disable_plugins (Placement);
 271         void disable_plugins ();
 272         void ab_plugins (bool forward);
 273         void clear_processors (Placement);
 274         void all_visible_processors_active (bool);
 275
 276         framecnt_t set_private_port_latencies (bool playback) const;
 277         void       set_public_port_latencies (framecnt_t, bool playback) const;
 278
 279         framecnt_t   update_signal_latency();
 280         virtual void set_latency_compensation (framecnt_t);
 281
 282         void set_user_latency (framecnt_t);
 283         framecnt_t initial_delay() const { return _initial_delay; }
 284         framecnt_t signal_latency() const { return _signal_latency; }
 285
 286         PBD::Signal0<void>       active_changed;
 287         PBD::Signal0<void>       phase_invert_changed;
 288         PBD::Signal0<void>       denormal_protection_changed;
 289         PBD::Signal2<void,void*,bool> listen_changed;
 290         PBD::Signal3<void,bool,void*,bool> solo_changed;
 291         PBD::Signal1<void,void*> solo_safe_changed;
 292         PBD::Signal1<void,void*> solo_isolated_changed;
 293         PBD::Signal1<void,void*> comment_changed;
 294         PBD::Signal1<void,void*> mute_changed;
 295         PBD::Signal0<void>       mute_points_changed;
 296
 297         /** track numbers - assigned by session
 298          * nubers > 0 indicate tracks (audio+midi)
 299          * nubers < 0 indicate busses
 300          * zero is reserved for unnumbered special busses.
 301          * */
 302         PBD::Signal0<void> track_number_changed;
 303         int64_t track_number() const { return _track_number; }
 304
 305         void set_track_number(int64_t tn) {
 306                 if (tn == _track_number) { return; }
 307                 _track_number = tn;
 308                 track_number_changed();
 309                 PropertyChanged (ARDOUR::Properties::name);
 310         }
 311
 312         /** the processors have changed; the parameter indicates what changed */
 313         PBD::Signal1<void,RouteProcessorChange> processors_changed;
 314         PBD::Signal1<void,void*> record_enable_changed;
 315         /** the metering point has changed */
 316         PBD::Signal0<void>       meter_change;
 317         PBD::Signal0<void>       signal_latency_changed;
 318         PBD::Signal0<void>       initial_delay_changed;
 319
 320         /** Emitted with the process lock held */
 321         PBD::Signal0<void>       io_changed;
 322
 323         /* gui's call this for their own purposes. */
 324
 325         PBD::Signal2<void,std::string,void*> gui_changed;
 326
 327         /* stateful */
 328
 329         XMLNode& get_state();
 330         virtual int set_state (const XMLNode&, int version);
 331         virtual XMLNode& get_template();
 332
 333         XMLNode& get_processor_state ();
 334         virtual void set_processor_state (const XMLNode&);
 335
 336         int save_as_template (const std::string& path, const std::string& name);
 337
 338         PBD::Signal1<void,void*> SelectedChanged;
 339
 340         int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
 341         void remove_aux_or_listen (boost::shared_ptr<Route>);
 342
 343         /**
 344          * return true if this route feeds the first argument via at least one
 345          * (arbitrarily long) signal pathway.
 346          */
 347         bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
 348
 349         /**
 350          * return true if this route feeds the first argument directly, via
 351          * either its main outs or a send.  This is checked by the actual
 352          * connections, rather than by what the graph is currently doing.
 353          */
 354         bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
 355
 356         /**
 357          * return true if this route feeds the first argument directly, via
 358          * either its main outs or a send, according to the graph that
 359          * is currently being processed.
 360          */
 361         bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
 362
 363         struct FeedRecord {
 364                 boost::weak_ptr<Route> r;
 365                 bool sends_only;
 366
 367                 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
 368                 : r (rp)
 369                 , sends_only (sendsonly) {}
 370         };
 371
 372         struct FeedRecordCompare {
 373                 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
 374                         return a.r < b.r;
 375                 }
 376         };
 377
 378         typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
 379
 380         const FedBy& fed_by() const { return _fed_by; }
 381         void clear_fed_by ();
 382         bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
 383
 384         /* Controls (not all directly owned by the Route */
 385
 386         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 387
 388         class SoloControllable : public AutomationControl {
 389         public:
 390                 SoloControllable (std::string name, boost::shared_ptr<Route>);
 391                 void set_value (double);
 392                 void set_value_unchecked (double);
 393                 double get_value () const;
 394
 395         private:
 396                 boost::weak_ptr<Route> _route;
 397         };
 398
 399         struct MuteControllable : public AutomationControl {
 400         public:
 401                 MuteControllable (std::string name, boost::shared_ptr<Route>);
 402                 void set_value (double);
 403                 void set_value_unchecked (double);
 404                 double get_value () const;
 405
 406                 /* Pretend to change value, but do not affect actual route mute. */
 407                 void set_superficial_value(bool muted);
 408
 409         private:
 410                 boost::weak_ptr<Route> _route;
 411         };
 412
 413         class PhaseControllable : public AutomationControl {
 414         public:
 415                 PhaseControllable (std::string name, boost::shared_ptr<Route>);
 416                 void set_value (double);
 417                 void set_channel (int);
 418                 double get_value () const;
 419                 int channel() const;
 420
 421         private:
 422                 boost::weak_ptr<Route> _route;
 423                 int _current_phase;
 424         };
 425
 426
 427         boost::shared_ptr<SoloControllable> solo_control() const {
 428                 return _solo_control;
 429         }
 430
 431         boost::shared_ptr<MuteControllable> mute_control() const {
 432                 return _mute_control;
 433         }
 434
 435         boost::shared_ptr<MuteMaster> mute_master() const {
 436                 return _mute_master;
 437         }
 438
 439         boost::shared_ptr<PhaseControllable> phase_control() const {
 440                 return _phase_control;
 441         }
 442
 443         /* Route doesn't own these items, but sub-objects that it does own have them
 444            and to make UI code a bit simpler, we provide direct access to them
 445            here.
 446         */
 447
 448         boost::shared_ptr<Panner> panner() const;  /* may return null */
 449         boost::shared_ptr<PannerShell> panner_shell() const;
 450         boost::shared_ptr<AutomationControl> gain_control() const;
 451         boost::shared_ptr<Pannable> pannable() const;
 452         boost::shared_ptr<AutomationControl> trim_control() const;
 453
 454         /**
 455            Return the first processor that accepts has at least one MIDI input
 456            and at least one audio output. In the vast majority of cases, this
 457            will be "the instrument". This does not preclude other MIDI->audio
 458            processors later in the processing chain, but that would be a
 459            special case not covered by this utility function.
 460         */
 461         boost::shared_ptr<Processor> the_instrument() const;
 462         InstrumentInfo& instrument_info() { return _instrument_info; }
 463
 464         void protect_automation ();
 465
 466         enum {
 467                 /* These numbers are taken from MIDI Machine Control,
 468                    which can only control up to 317 tracks without
 469                    doing sysex segmentation.
 470                 */
 471                 MasterBusRemoteControlID = 318,
 472                 MonitorBusRemoteControlID = 319,
 473         };
 474
 475         void     set_remote_control_id (uint32_t id, bool notify_class_listeners = true);
 476         uint32_t remote_control_id () const;
 477         void     set_remote_control_id_explicit (uint32_t order_key);
 478
 479         /* for things concerned about *this* route's RID */
 480
 481         PBD::Signal0<void> RemoteControlIDChanged;
 482
 483         /* for things concerned about *any* route's RID changes */
 484
 485         static PBD::Signal0<void> RemoteControlIDChange;
 486         static PBD::Signal0<void> SyncOrderKeys;
 487
 488         bool has_external_redirects() const;
 489
 490         /* can only be executed by a route for which is_monitor() is true
 491            (i.e. the monitor out)
 492         */
 493         void monitor_run (framepos_t start_frame, framepos_t end_frame,
 494                           pframes_t nframes, int declick);
 495
 496   protected:
 497         friend class Session;
 498
 499         void catch_up_on_solo_mute_override ();
 500         void mod_solo_by_others_upstream (int32_t);
 501         void mod_solo_by_others_downstream (int32_t);
 502         void curve_reallocate ();
 503         virtual void set_block_size (pframes_t nframes);
 504
 505   protected:
 506         virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
 507
 508         void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
 509
 510         void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
 511                         pframes_t nframes, int declick);
 512
 513         virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
 514                                              framecnt_t /* nframes */) {}
 515
 516         virtual void process_output_buffers (BufferSet& bufs,
 517                                              framepos_t start_frame, framepos_t end_frame,
 518                                              pframes_t nframes, int declick,
 519                                              bool gain_automation_ok);
 520
 521         virtual void bounce_process (BufferSet& bufs,
 522                                      framepos_t start_frame, framecnt_t nframes,
 523                                                                                                                          boost::shared_ptr<Processor> endpoint, bool include_endpoint,
 524                                      bool for_export, bool for_freeze);
 525
 526         framecnt_t   bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 527         ChanCount    bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 528
 529         boost::shared_ptr<IO> _input;
 530         boost::shared_ptr<IO> _output;
 531
 532         bool           _active;
 533         framecnt_t     _signal_latency;
 534         framecnt_t     _signal_latency_at_amp_position;
 535         framecnt_t     _signal_latency_at_trim_position;
 536         framecnt_t     _initial_delay;
 537         framecnt_t     _roll_delay;
 538
 539         ProcessorList  _processors;
 540         mutable Glib::Threads::RWLock   _processor_lock;
 541         boost::shared_ptr<Delivery> _main_outs;
 542         boost::shared_ptr<InternalSend> _monitor_send;
 543         boost::shared_ptr<InternalReturn> _intreturn;
 544         boost::shared_ptr<MonitorProcessor> _monitor_control;
 545         boost::shared_ptr<Pannable> _pannable;
 546
 547         enum {
 548                 EmitNone = 0x00,
 549                 EmitMeterChanged = 0x01,
 550                 EmitMeterVisibilityChange = 0x02,
 551                 EmitRtProcessorChange = 0x04
 552         };
 553
 554         ProcessorList  _pending_processor_order;
 555         gint           _pending_process_reorder; // atomic
 556         gint           _pending_signals; // atomic
 557
 558         Flag           _flags;
 559         int            _pending_declick;
 560         MeterPoint     _meter_point;
 561         MeterPoint     _pending_meter_point;
 562         MeterType      _meter_type;
 563         boost::dynamic_bitset<> _phase_invert;
 564         bool           _self_solo;
 565         uint32_t       _soloed_by_others_upstream;
 566         uint32_t       _soloed_by_others_downstream;
 567         bool           _solo_isolated;
 568         uint32_t       _solo_isolated_by_upstream;
 569
 570         void mod_solo_isolated_by_upstream (bool, void*);
 571
 572         bool           _denormal_protection;
 573
 574         bool _recordable : 1;
 575         bool _silent : 1;
 576         bool _declickable : 1;
 577
 578         boost::shared_ptr<SoloControllable> _solo_control;
 579         boost::shared_ptr<MuteControllable> _mute_control;
 580         boost::shared_ptr<MuteMaster> _mute_master;
 581         boost::shared_ptr<PhaseControllable> _phase_control;
 582
 583         virtual void act_on_mute () {}
 584
 585         std::string    _comment;
 586         bool           _have_internal_generator;
 587         bool           _solo_safe;
 588         DataType       _default_type;
 589         FedBy          _fed_by;
 590
 591         InstrumentInfo _instrument_info;
 592
 593         virtual ChanCount input_streams () const;
 594
 595   protected:
 596         virtual XMLNode& state(bool);
 597
 598         int configure_processors (ProcessorStreams*);
 599
 600         void passthru_silence (framepos_t start_frame, framepos_t end_frame,
 601                                pframes_t nframes, int declick);
 602
 603         void silence (framecnt_t);
 604         void silence_unlocked (framecnt_t);
 605
 606         ChanCount processor_max_streams;
 607         ChanCount processor_out_streams;
 608
 609         uint32_t pans_required() const;
 610         ChanCount n_process_buffers ();
 611
 612         virtual void maybe_declick (BufferSet&, framecnt_t, int);
 613
 614         boost::shared_ptr<Amp>       _amp;
 615         boost::shared_ptr<Amp>       _trim;
 616         boost::shared_ptr<PeakMeter> _meter;
 617         boost::shared_ptr<DelayLine> _delayline;
 618
 619         boost::shared_ptr<Processor> the_instrument_unlocked() const;
 620
 621   private:
 622         int set_state_2X (const XMLNode&, int);
 623         void set_processor_state_2X (XMLNodeList const &, int);
 624
 625         uint32_t _order_key;
 626         bool _has_order_key;
 627         uint32_t _remote_control_id;
 628
 629         int64_t _track_number;
 630
 631         void input_change_handler (IOChange, void *src);
 632         void output_change_handler (IOChange, void *src);
 633
 634         bool input_port_count_changing (ChanCount);
 635         bool output_port_count_changing (ChanCount);
 636
 637         bool _in_configure_processors;
 638         bool _initial_io_setup;
 639
 640         int configure_processors_unlocked (ProcessorStreams*);
 641         bool set_meter_point_unlocked ();
 642         void apply_processor_order (const ProcessorList& new_order);
 643
 644         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
 645         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
 646
 647         bool add_processor_from_xml_2X (const XMLNode&, int);
 648
 649         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 650
 651         void set_self_solo (bool yn);
 652         void set_mute_master_solo ();
 653
 654         void set_processor_positions ();
 655         framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
 656
 657         void setup_invisible_processors ();
 658         void unpan ();
 659
 660         boost::shared_ptr<CapturingProcessor> _capturing_processor;
 661
 662         /** A handy class to keep processor state while we attempt a reconfiguration
 663          *  that may fail.
 664          */
 665         class ProcessorState {
 666         public:
 667                 ProcessorState (Route* r)
 668                         : _route (r)
 669                         , _processors (r->_processors)
 670                         , _processor_max_streams (r->processor_max_streams)
 671                 { }
 672
 673                 void restore () {
 674                         _route->_processors = _processors;
 675                         _route->processor_max_streams = _processor_max_streams;
 676                 }
 677
 678         private:
 679                 /* this should perhaps be a shared_ptr, but ProcessorStates will
 680                    not hang around long enough for it to matter.
 681                 */
 682                 Route* _route;
 683                 ProcessorList _processors;
 684                 ChanCount _processor_max_streams;
 685         };
 686
 687         friend class ProcessorState;
 688
 689         /* no copy construction */
 690         Route (Route const &);
 691
 692         void maybe_note_meter_position ();
 693
 694         /** true if we've made a note of a custom meter position in these variables */
 695         bool _custom_meter_position_noted;
 696         /** the processor that came after the meter when it was last set to a custom position,
 697             or 0.
 698         */
 699         boost::weak_ptr<Processor> _processor_after_last_custom_meter;
 700
 701         void reset_instrument_info ();
 702
 703         void set_remote_control_id_internal (uint32_t id, bool notify_class_listeners = true);
 704 };
 705
 706 } // namespace ARDOUR
 707
 708 #endif /* __ardour_route_h__ */