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         /** the metering point has changed */
 364         PBD::Signal0<void>       meter_change;
 365         PBD::Signal0<void>       signal_latency_changed;
 366         PBD::Signal0<void>       initial_delay_changed;
 367
 368         /** Emitted with the process lock held */
 369         PBD::Signal0<void>       io_changed;
 370
 371         /* stateful */
 372
 373         XMLNode& get_state();
 374         virtual int set_state (const XMLNode&, int version);
 375         virtual XMLNode& get_template();
 376
 377         XMLNode& get_processor_state ();
 378         virtual void set_processor_state (const XMLNode&);
 379
 380         int save_as_template (const std::string& path, const std::string& name);
 381
 382         PBD::Signal1<void,void*> SelectedChanged;
 383
 384         int add_aux_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>);
 385         void remove_aux_or_listen (boost::shared_ptr<Route>);
 386
 387         /**
 388          * return true if this route feeds the first argument via at least one
 389          * (arbitrarily long) signal pathway.
 390          */
 391         bool feeds (boost::shared_ptr<Route>, bool* via_send_only = 0);
 392
 393         /**
 394          * return true if this route feeds the first argument directly, via
 395          * either its main outs or a send.  This is checked by the actual
 396          * connections, rather than by what the graph is currently doing.
 397          */
 398         bool direct_feeds_according_to_reality (boost::shared_ptr<Route>, bool* via_send_only = 0);
 399
 400         /**
 401          * return true if this route feeds the first argument directly, via
 402          * either its main outs or a send, according to the graph that
 403          * is currently being processed.
 404          */
 405         bool direct_feeds_according_to_graph (boost::shared_ptr<Route>, bool* via_send_only = 0);
 406
 407         bool feeds_according_to_graph (boost::shared_ptr<Route>);
 408
 409         struct FeedRecord {
 410                 boost::weak_ptr<Route> r;
 411                 bool sends_only;
 412
 413                 FeedRecord (boost::shared_ptr<Route> rp, bool sendsonly)
 414                 : r (rp)
 415                 , sends_only (sendsonly) {}
 416         };
 417
 418         struct FeedRecordCompare {
 419                 bool operator() (const FeedRecord& a, const FeedRecord& b) const {
 420                         return a.r < b.r;
 421                 }
 422         };
 423
 424         typedef std::set<FeedRecord,FeedRecordCompare> FedBy;
 425
 426         const FedBy& fed_by() const { return _fed_by; }
 427         void clear_fed_by ();
 428         bool add_fed_by (boost::shared_ptr<Route>, bool sends_only);
 429
 430         /* Controls (not all directly owned by the Route) */
 431
 432         boost::shared_ptr<AutomationControl> get_control (const Evoral::Parameter& param);
 433
 434         boost::shared_ptr<SoloControl> solo_control() const {
 435                 return _solo_control;
 436         }
 437
 438         boost::shared_ptr<MuteControl> mute_control() const {
 439                 return _mute_control;
 440         }
 441
 442         bool can_be_muted_by_others () const { return !is_master(); }
 443         bool muted () const { return _mute_control->muted(); }
 444         bool muted_by_masters () const { return _mute_control->muted_by_masters(); }
 445         bool muted_by_self () const { return _mute_control->muted_by_self(); }
 446         bool muted_by_others_soloing () const;
 447
 448         boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const {
 449                 return _solo_isolate_control;
 450         }
 451
 452         boost::shared_ptr<SoloSafeControl> solo_safe_control() const {
 453                 return _solo_safe_control;
 454         }
 455
 456         boost::shared_ptr<MonitorControl> monitoring_control() const {
 457                 /* tracks override this to provide actual monitoring control;
 458                    busses have no possible choices except input monitoring.
 459                 */
 460                 return boost::shared_ptr<MonitorControl> ();
 461         }
 462
 463         /* Route doesn't own these items, but sub-objects that it does own have them
 464            and to make UI code a bit simpler, we provide direct access to them
 465            here.
 466         */
 467
 468         boost::shared_ptr<Panner> panner() const;  /* may return null */
 469         boost::shared_ptr<PannerShell> panner_shell() const;
 470         boost::shared_ptr<Pannable> pannable() const;
 471
 472         boost::shared_ptr<GainControl> gain_control() const;
 473         boost::shared_ptr<GainControl> trim_control() const;
 474         boost::shared_ptr<PhaseControl> phase_control() const;
 475
 476         /**
 477            Return the first processor that accepts has at least one MIDI input
 478            and at least one audio output. In the vast majority of cases, this
 479            will be "the instrument". This does not preclude other MIDI->audio
 480            processors later in the processing chain, but that would be a
 481            special case not covered by this utility function.
 482         */
 483         boost::shared_ptr<Processor> the_instrument() const;
 484         InstrumentInfo& instrument_info() { return _instrument_info; }
 485
 486         /* "well-known" controls for panning. Any or all of these may return
 487          * null.
 488          */
 489
 490         boost::shared_ptr<AutomationControl> pan_azimuth_control() const;
 491         boost::shared_ptr<AutomationControl> pan_elevation_control() const;
 492         boost::shared_ptr<AutomationControl> pan_width_control() const;
 493         boost::shared_ptr<AutomationControl> pan_frontback_control() const;
 494         boost::shared_ptr<AutomationControl> pan_lfe_control() const;
 495
 496         /* "well-known" controls for an EQ in this route. Any or all may
 497          * be null. eq_band_cnt() must return 0 if there is no EQ present.
 498          * Passing an @param band value >= eq_band_cnt() will guarantee the
 499          * return of a null ptr (or an empty string for eq_band_name()).
 500          */
 501         uint32_t eq_band_cnt () const;
 502         std::string eq_band_name (uint32_t) const;
 503         boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const;
 504         boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const;
 505         boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const;
 506         boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const;
 507         boost::shared_ptr<AutomationControl> eq_enable_controllable () const;
 508         boost::shared_ptr<AutomationControl> eq_hpf_controllable () const;
 509
 510         /* "well-known" controls for a compressor in this route. Any or all may
 511          * be null.
 512          */
 513         boost::shared_ptr<AutomationControl> comp_enable_controllable () const;
 514         boost::shared_ptr<AutomationControl> comp_threshold_controllable () const;
 515         boost::shared_ptr<AutomationControl> comp_speed_controllable () const;
 516         boost::shared_ptr<AutomationControl> comp_mode_controllable () const;
 517         boost::shared_ptr<AutomationControl> comp_makeup_controllable () const;
 518         boost::shared_ptr<AutomationControl> comp_redux_controllable () const;
 519
 520         /* @param mode must be supplied by the comp_mode_controllable(). All other values
 521          * result in undefined behaviour
 522          */
 523         std::string comp_mode_name (uint32_t mode) const;
 524         /* @param mode - as for comp mode name. This returns the name for the
 525          * parameter/control accessed via comp_speed_controllable(), which can
 526          * be mode dependent.
 527          */
 528         std::string comp_speed_name (uint32_t mode) const;
 529
 530         /* "well-known" controls for sends to well-known busses in this route. Any or all may
 531          * be null.
 532          *
 533          * In Mixbus, these are the sends that connect to the mixbusses.
 534          * In Ardour, these are user-created sends that connect to user-created
 535          * Aux busses.
 536          */
 537         boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const;
 538         boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const;
 539         /* for the same value of @param n, this returns the name of the send
 540          * associated with the pair of controllables returned by the above two methods.
 541          */
 542         std::string send_name (uint32_t n) const;
 543
 544         /* well known control that enables/disables sending to the master bus.
 545          *
 546          * In Ardour, this returns null.
 547          * In Mixbus, it will return a suitable control, or null depending on
 548          * the route.
 549          */
 550         boost::shared_ptr<AutomationControl> master_send_enable_controllable () const;
 551
 552         void protect_automation ();
 553
 554         bool has_external_redirects() const;
 555
 556         /* can only be executed by a route for which is_monitor() is true
 557          *       (i.e. the monitor out)
 558          */
 559         void monitor_run (framepos_t start_frame, framepos_t end_frame,
 560                         pframes_t nframes, int declick);
 561
 562         bool slaved_to (boost::shared_ptr<VCA>) const;
 563         bool slaved () const;
 564
 565   protected:
 566         friend class Session;
 567
 568         void catch_up_on_solo_mute_override ();
 569         void set_listen (bool);
 570
 571         void curve_reallocate ();
 572         virtual void set_block_size (pframes_t nframes);
 573
 574   protected:
 575         virtual framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&) { return nframes; }
 576
 577         void fill_buffers_with_input (BufferSet& bufs, boost::shared_ptr<IO> io, pframes_t nframes);
 578
 579         void passthru (BufferSet&, framepos_t start_frame, framepos_t end_frame,
 580                         pframes_t nframes, int declick);
 581
 582         virtual void write_out_of_band_data (BufferSet& /* bufs */, framepos_t /* start_frame */, framepos_t /* end_frame */,
 583                                              framecnt_t /* nframes */) {}
 584
 585         virtual void process_output_buffers (BufferSet& bufs,
 586                                              framepos_t start_frame, framepos_t end_frame,
 587                                              pframes_t nframes, int declick,
 588                                              bool gain_automation_ok);
 589
 590         virtual void bounce_process (BufferSet& bufs,
 591                                      framepos_t start_frame, framecnt_t nframes,
 592                                                                                                                          boost::shared_ptr<Processor> endpoint, bool include_endpoint,
 593                                      bool for_export, bool for_freeze);
 594
 595         framecnt_t   bounce_get_latency (boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 596         ChanCount    bounce_get_output_streams (ChanCount &cc, boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze) const;
 597
 598         boost::shared_ptr<IO> _input;
 599         boost::shared_ptr<IO> _output;
 600
 601         bool           _active;
 602         framecnt_t     _signal_latency;
 603         framecnt_t     _signal_latency_at_amp_position;
 604         framecnt_t     _signal_latency_at_trim_position;
 605         framecnt_t     _initial_delay;
 606         framecnt_t     _roll_delay;
 607
 608         ProcessorList  _processors;
 609         mutable Glib::Threads::RWLock   _processor_lock;
 610         boost::shared_ptr<Delivery> _main_outs;
 611         boost::shared_ptr<InternalSend> _monitor_send;
 612         boost::shared_ptr<InternalReturn> _intreturn;
 613         boost::shared_ptr<MonitorProcessor> _monitor_control;
 614         boost::shared_ptr<Pannable> _pannable;
 615
 616         enum {
 617                 EmitNone = 0x00,
 618                 EmitMeterChanged = 0x01,
 619                 EmitMeterVisibilityChange = 0x02,
 620                 EmitRtProcessorChange = 0x04
 621         };
 622
 623         ProcessorList  _pending_processor_order;
 624         gint           _pending_process_reorder; // atomic
 625         gint           _pending_signals; // atomic
 626
 627         int            _pending_declick;
 628         MeterPoint     _meter_point;
 629         MeterPoint     _pending_meter_point;
 630         MeterType      _meter_type;
 631
 632         bool           _denormal_protection;
 633
 634         bool _recordable : 1;
 635         bool _silent : 1;
 636         bool _declickable : 1;
 637
 638         boost::shared_ptr<SoloControl> _solo_control;
 639         boost::shared_ptr<MuteControl> _mute_control;
 640         boost::shared_ptr<PhaseControl> _phase_control;
 641         boost::shared_ptr<SoloIsolateControl> _solo_isolate_control;
 642         boost::shared_ptr<SoloSafeControl> _solo_safe_control;
 643
 644         std::string    _comment;
 645         bool           _have_internal_generator;
 646         DataType       _default_type;
 647         FedBy          _fed_by;
 648
 649         InstrumentInfo _instrument_info;
 650
 651         virtual ChanCount input_streams () const;
 652
 653 protected:
 654         virtual XMLNode& state(bool);
 655
 656         int configure_processors (ProcessorStreams*);
 657
 658         void passthru_silence (framepos_t start_frame, framepos_t end_frame,
 659                                pframes_t nframes, int declick);
 660
 661         void silence (framecnt_t);
 662         void silence_unlocked (framecnt_t);
 663
 664         ChanCount processor_max_streams;
 665         ChanCount processor_out_streams;
 666
 667         uint32_t pans_required() const;
 668         ChanCount n_process_buffers ();
 669
 670         virtual void maybe_declick (BufferSet&, framecnt_t, int);
 671
 672         boost::shared_ptr<GainControl> _gain_control;
 673         boost::shared_ptr<Amp>       _amp;
 674         boost::shared_ptr<GainControl> _trim_control;
 675         boost::shared_ptr<Amp>       _trim;
 676         boost::shared_ptr<PeakMeter> _meter;
 677         boost::shared_ptr<DelayLine> _delayline;
 678
 679         boost::shared_ptr<Processor> the_instrument_unlocked() const;
 680
 681   private:
 682         int64_t _track_number;
 683
 684         int set_state_2X (const XMLNode&, int);
 685         void set_processor_state_2X (XMLNodeList const &, int);
 686
 687         void input_change_handler (IOChange, void *src);
 688         void output_change_handler (IOChange, void *src);
 689         void sidechain_change_handler (IOChange, void *src);
 690
 691         void processor_selfdestruct (boost::weak_ptr<Processor>);
 692         std::vector<boost::weak_ptr<Processor> > selfdestruct_sequence;
 693         Glib::Threads::Mutex  selfdestruct_lock;
 694
 695         bool input_port_count_changing (ChanCount);
 696         bool output_port_count_changing (ChanCount);
 697
 698         bool _in_configure_processors;
 699         bool _initial_io_setup;
 700         bool _in_sidechain_setup;
 701
 702         int configure_processors_unlocked (ProcessorStreams*, Glib::Threads::RWLock::WriterLock*);
 703         bool set_meter_point_unlocked ();
 704         void apply_processor_order (const ProcessorList& new_order);
 705
 706         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors (ChanCount, ProcessorStreams *);
 707         std::list<std::pair<ChanCount, ChanCount> > try_configure_processors_unlocked (ChanCount, ProcessorStreams *);
 708
 709         bool add_processor_from_xml_2X (const XMLNode&, int);
 710
 711         void placement_range (Placement p, ProcessorList::iterator& start, ProcessorList::iterator& end);
 712
 713         void set_self_solo (bool yn);
 714
 715         void set_processor_positions ();
 716         framecnt_t update_port_latencies (PortSet& ports, PortSet& feeders, bool playback, framecnt_t) const;
 717
 718         void setup_invisible_processors ();
 719         void unpan ();
 720
 721         void set_plugin_state_dir (boost::weak_ptr<Processor>, const std::string&);
 722
 723         boost::shared_ptr<CapturingProcessor> _capturing_processor;
 724
 725         /** A handy class to keep processor state while we attempt a reconfiguration
 726          *  that may fail.
 727          */
 728         class ProcessorState {
 729         public:
 730                 ProcessorState (Route* r)
 731                         : _route (r)
 732                         , _processors (r->_processors)
 733                         , _processor_max_streams (r->processor_max_streams)
 734                 { }
 735
 736                 void restore () {
 737                         _route->_processors = _processors;
 738                         _route->processor_max_streams = _processor_max_streams;
 739                 }
 740
 741         private:
 742                 /* this should perhaps be a shared_ptr, but ProcessorStates will
 743                    not hang around long enough for it to matter.
 744                 */
 745                 Route* _route;
 746                 ProcessorList _processors;
 747                 ChanCount _processor_max_streams;
 748         };
 749
 750         friend class ProcessorState;
 751
 752         bool _strict_io;
 753
 754         /* no copy construction */
 755         Route (Route const &);
 756
 757         void maybe_note_meter_position ();
 758
 759         /** true if we've made a note of a custom meter position in these variables */
 760         bool _custom_meter_position_noted;
 761         /** the processor that came after the meter when it was last set to a custom position,
 762             or 0.
 763         */
 764         boost::weak_ptr<Processor> _processor_after_last_custom_meter;
 765         RoutePinWindowProxy *_pinmgr_proxy;
 766
 767         void reset_instrument_info ();
 768
 769         void solo_control_changed (bool self, PBD::Controllable::GroupControlDisposition);
 770 };
 771
 772 } // namespace ARDOUR
 773
 774 #endif /* __ardour_route_h__ */