libs/ardour/ardour/session.h

   1 /*
   2     Copyright (C) 2000 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_session_h__
  21 #define __ardour_session_h__
  22
  23 #include "libardour-config.h"
  24
  25 #include <list>
  26 #include <map>
  27 #include <set>
  28 #include <string>
  29 #include <vector>
  30 #include <stdint.h>
  31
  32 #include <boost/dynamic_bitset.hpp>
  33 #include <boost/scoped_ptr.hpp>
  34 #include <boost/weak_ptr.hpp>
  35 #include <boost/utility.hpp>
  36
  37 #include <glibmm/thread.h>
  38
  39 #include "pbd/error.h"
  40 #include "pbd/event_loop.h"
  41 #include "pbd/rcu.h"
  42 #include "pbd/statefuldestructible.h"
  43 #include "pbd/signals.h"
  44 #include "pbd/undo.h"
  45
  46 #include "evoral/types.hpp"
  47
  48 #include "midi++/types.h"
  49
  50 #include "timecode/time.h"
  51
  52 #include "ardour/ardour.h"
  53 #include "ardour/chan_count.h"
  54 #include "ardour/delivery.h"
  55 #include "ardour/interthread_info.h"
  56 #include "ardour/rc_configuration.h"
  57 #include "ardour/session_configuration.h"
  58 #include "ardour/session_event.h"
  59 #include "ardour/location.h"
  60 #include "ardour/interpolation.h"
  61 #include "ardour/route_graph.h"
  62
  63 #ifdef HAVE_JACK_SESSION
  64 #include <jack/session.h>
  65 #endif
  66
  67 class XMLTree;
  68 class XMLNode;
  69 struct _AEffect;
  70 typedef struct _AEffect AEffect;
  71
  72 namespace MIDI {
  73         class Port;
  74         class MachineControl;
  75         class Parser;
  76 }
  77
  78 namespace PBD {
  79         class Controllable;
  80         class ControllableDescriptor;
  81 }
  82
  83 namespace Evoral {
  84         class Curve;
  85 }
  86
  87 namespace ARDOUR {
  88
  89 class Amp;
  90 class AudioEngine;
  91 class AudioFileSource;
  92 class AudioRegion;
  93 class AudioSource;
  94 class AudioTrack;
  95 class Auditioner;
  96 class AutomationList;
  97 class AuxInput;
  98 class BufferSet;
  99 class Bundle;
 100 class Butler;
 101 class Click;
 102 class Diskstream;
 103 class ExportHandler;
 104 class ExportStatus;
 105 class Graph;
 106 class IO;
 107 class IOProcessor;
 108 class ImportStatus;
 109 class MidiClockTicker;
 110 class MidiControlUI;
 111 class MidiRegion;
 112 class MidiSource;
 113 class MidiTrack;
 114 class NamedSelection;
 115 class Playlist;
 116 class PluginInsert;
 117 class PluginInfo;
 118 class Port;
 119 class PortInsert;
 120 class ProcessThread;
 121 class Processor;
 122 class Region;
 123 class Return;
 124 class Route;
 125 class RouteGroup;
 126 class SMFSource;
 127 class Send;
 128 class SessionDirectory;
 129 class SessionMetadata;
 130 class SessionPlaylists;
 131 class Slave;
 132 class Source;
 133 class Speakers;
 134 class TempoMap;
 135 class Track;
 136 class WindowsVSTPlugin;
 137
 138 extern void setup_enum_writer ();
 139
 140 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
 141 {
 142   public:
 143         enum RecordState {
 144                 Disabled = 0,
 145                 Enabled = 1,
 146                 Recording = 2
 147         };
 148
 149         /* a new session might have non-empty mix_template, an existing session should always have an empty one.
 150            the bus profile can be null if no master out bus is required.
 151         */
 152
 153         Session (AudioEngine&,
 154                  const std::string& fullpath,
 155                  const std::string& snapshot_name,
 156                  BusProfile* bus_profile = 0,
 157                  std::string mix_template = "");
 158
 159         virtual ~Session ();
 160
 161         std::string path() const { return _path; }
 162         std::string name() const { return _name; }
 163         std::string snap_name() const { return _current_snapshot_name; }
 164         std::string raid_path () const;
 165         bool path_is_within_session (const std::string&);
 166
 167         void set_snap_name ();
 168
 169         bool writable() const { return _writable; }
 170         void set_dirty ();
 171         void set_clean ();
 172         bool dirty() const { return _state_of_the_state & Dirty; }
 173         void set_deletion_in_progress ();
 174         void clear_deletion_in_progress ();
 175         bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
 176         PBD::Signal0<void> DirtyChanged;
 177
 178         const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
 179
 180         static PBD::Signal0<void> AutoBindingOn;
 181         static PBD::Signal0<void> AutoBindingOff;
 182
 183         static PBD::Signal1<void,std::string> Dialog;
 184
 185         int ensure_subdirs ();
 186
 187         std::string automation_dir () const;  ///< Automation data
 188         std::string analysis_dir () const;    ///< Analysis data
 189         std::string plugins_dir () const;     ///< Plugin state
 190         std::string externals_dir () const;   ///< Links to external files
 191
 192         std::string peak_path (std::string) const;
 193
 194         std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
 195
 196         std::string peak_path_from_audio_path (std::string) const;
 197         std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
 198         std::string new_midi_source_name (const std::string&);
 199         std::string new_source_path_from_name (DataType type, const std::string&);
 200         RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
 201
 202         void process (pframes_t nframes);
 203
 204         BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
 205         BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
 206         BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
 207
 208         bool have_rec_enabled_track () const;
 209
 210         bool have_captured() const { return _have_captured; }
 211
 212         void refill_all_track_buffers ();
 213         Butler* butler() { return _butler; }
 214         void butler_transport_work ();
 215
 216         void refresh_disk_space ();
 217
 218         int load_diskstreams_2X (XMLNode const &, int);
 219
 220         int load_routes (const XMLNode&, int);
 221         boost::shared_ptr<RouteList> get_routes() const {
 222                 return routes.reader ();
 223         }
 224
 225         boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
 226
 227         boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
 228
 229         uint32_t nroutes() const { return routes.reader()->size(); }
 230         uint32_t ntracks () const;
 231         uint32_t nbusses () const;
 232
 233         boost::shared_ptr<BundleList> bundles () {
 234                 return _bundles.reader ();
 235         }
 236
 237         struct RoutePublicOrderSorter {
 238                 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
 239         };
 240
 241         void sync_order_keys (std::string const &);
 242
 243         template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
 244         template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
 245         template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
 246
 247         static char session_name_is_legal (const std::string&);
 248         bool io_name_is_legal (const std::string&);
 249         boost::shared_ptr<Route> route_by_name (std::string);
 250         boost::shared_ptr<Route> route_by_id (PBD::ID);
 251         boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
 252         boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
 253         void routes_using_input_from (const std::string& str, RouteList& rl);
 254
 255         bool route_name_unique (std::string) const;
 256         bool route_name_internal (std::string) const;
 257
 258         bool get_record_enabled() const {
 259                 return (record_status () >= Enabled);
 260         }
 261
 262         RecordState record_status() const {
 263                 return (RecordState) g_atomic_int_get (&_record_status);
 264         }
 265
 266         bool actively_recording () const {
 267                 return record_status() == Recording;
 268         }
 269
 270         bool record_enabling_legal () const;
 271         void maybe_enable_record ();
 272         void disable_record (bool rt_context, bool force = false);
 273         void step_back_from_record ();
 274
 275         void maybe_write_autosave ();
 276
 277         /* Emitted when all i/o connections are complete */
 278
 279         PBD::Signal0<void> IOConnectionsComplete;
 280
 281         /* Record status signals */
 282
 283         PBD::Signal0<void> RecordStateChanged;
 284
 285         /* Transport mechanism signals */
 286
 287         /** Emitted on the following changes in transport state:
 288          *  - stop (from the butler thread)
 289          *  - change in whether or not we are looping (from the process thread)
 290          *  - change in the play range (from the process thread)
 291          *  - start (from the process thread)
 292          *  - engine halted
 293         */
 294         PBD::Signal0<void> TransportStateChange;
 295
 296         PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
 297         PBD::Signal1<void,framepos_t> Xrun;
 298         PBD::Signal0<void> TransportLooped;
 299
 300         /** emitted when a locate has occurred */
 301         PBD::Signal0<void> Located;
 302
 303         PBD::Signal1<void,RouteList&> RouteAdded;
 304         /** Emitted when a property of one of our route groups changes.
 305          *  The parameter is the RouteGroup that has changed.
 306          */
 307         PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
 308         /** Emitted when a route is added to one of our route groups.
 309          *  First parameter is the RouteGroup, second is the route.
 310          */
 311         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
 312         /** Emitted when a route is removed from one of our route groups.
 313          *  First parameter is the RouteGroup, second is the route.
 314          */
 315         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
 316
 317         /* Step Editing status changed */
 318         PBD::Signal1<void,bool> StepEditStatusChange;
 319
 320         void queue_event (SessionEvent*);
 321
 322         void request_roll_at_and_return (framepos_t start, framepos_t return_to);
 323         void request_bounded_roll (framepos_t start, framepos_t end);
 324         void request_stop (bool abort = false, bool clear_state = false);
 325         void request_locate (framepos_t frame, bool with_roll = false);
 326
 327         void request_play_loop (bool yn, bool leave_rolling = false);
 328         bool get_play_loop () const { return play_loop; }
 329
 330         framepos_t last_transport_start () const { return _last_roll_location; }
 331         void goto_end ();
 332         void goto_start ();
 333         void use_rf_shuttle_speed ();
 334         void allow_auto_play (bool yn);
 335         void request_transport_speed (double speed);
 336         void request_transport_speed_nonzero (double);
 337         void request_overwrite_buffer (Track *);
 338         void adjust_playback_buffering();
 339         void adjust_capture_buffering();
 340         void request_track_speed (Track *, double speed);
 341         void request_input_change_handling ();
 342
 343         bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
 344         bool transport_locked () const;
 345
 346         int wipe ();
 347
 348         framepos_t current_end_frame () const;
 349         framepos_t current_start_frame () const;
 350         /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
 351         framecnt_t frame_rate () const { return _current_frame_rate; }
 352         /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
 353         framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
 354         framecnt_t frames_per_hour () const { return _frames_per_hour; }
 355
 356         double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
 357         framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
 358
 359         MIDI::byte get_mtc_timecode_bits() const {
 360                 return mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
 361         }
 362
 363         float timecode_frames_per_second() const;
 364         bool timecode_drop_frames() const;
 365
 366         /* Locations */
 367
 368         Locations *locations() { return _locations; }
 369
 370         PBD::Signal1<void,Location*>    auto_loop_location_changed;
 371         PBD::Signal1<void,Location*>    auto_punch_location_changed;
 372         PBD::Signal0<void>              locations_modified;
 373
 374         void set_auto_punch_location (Location *);
 375         void set_auto_loop_location (Location *);
 376         int location_name(std::string& result, std::string base = std::string(""));
 377
 378         pframes_t get_block_size()        const { return current_block_size; }
 379         framecnt_t worst_output_latency () const { return _worst_output_latency; }
 380         framecnt_t worst_input_latency ()  const { return _worst_input_latency; }
 381         framecnt_t worst_track_latency ()  const { return _worst_track_latency; }
 382         framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
 383
 384 #ifdef HAVE_JACK_SESSION
 385         void jack_session_event (jack_session_event_t* event);
 386 #endif
 387         int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
 388         int restore_state (std::string snapshot_name);
 389         int save_template (std::string template_name);
 390         int save_history (std::string snapshot_name = "");
 391         int restore_history (std::string snapshot_name);
 392         void remove_state (std::string snapshot_name);
 393         void rename_state (std::string old_name, std::string new_name);
 394         void remove_pending_capture_state ();
 395         int rename (const std::string&);
 396
 397         PBD::Signal1<void,std::string> StateSaved;
 398         PBD::Signal0<void> StateReady;
 399
 400         std::vector<std::string*>* possible_states() const;
 401         static std::vector<std::string*>* possible_states (std::string path);
 402
 403         XMLNode& get_state();
 404         int      set_state(const XMLNode& node, int version); // not idempotent
 405         XMLNode& get_template();
 406
 407         /// The instant xml file is written to the session directory
 408         void add_instant_xml (XMLNode&, bool write_to_config = true);
 409         XMLNode* instant_xml (const std::string& str);
 410
 411         enum StateOfTheState {
 412                 Clean = 0x0,
 413                 Dirty = 0x1,
 414                 CannotSave = 0x2,
 415                 Deletion = 0x4,
 416                 InitialConnecting = 0x8,
 417                 Loading = 0x10,
 418                 InCleanup = 0x20
 419         };
 420
 421         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 422
 423         void add_route_group (RouteGroup *);
 424         void remove_route_group (RouteGroup&);
 425         void reorder_route_groups (std::list<RouteGroup*>);
 426
 427         RouteGroup* route_group_by_name (std::string);
 428         RouteGroup& all_route_group() const;
 429
 430         PBD::Signal1<void,RouteGroup*> route_group_added;
 431         PBD::Signal0<void>             route_group_removed;
 432         PBD::Signal0<void>             route_groups_reordered;
 433
 434         void foreach_route_group (boost::function<void(RouteGroup*)> f) {
 435                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 436                         f (*i);
 437                 }
 438         }
 439
 440         std::list<RouteGroup*> const & route_groups () const {
 441                 return _route_groups;
 442         }
 443
 444         /* fundamental operations. duh. */
 445
 446         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 447                 int input_channels,
 448                 int output_channels,
 449                 TrackMode mode = Normal,
 450                 RouteGroup* route_group = 0,
 451                 uint32_t how_many = 1,
 452                 std::string name_template = ""
 453                 );
 454
 455         RouteList new_audio_route (
 456                 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
 457                 );
 458
 459         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 460                 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
 461                 TrackMode mode = Normal,
 462                 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
 463                 );
 464
 465         void   remove_route (boost::shared_ptr<Route>);
 466         void   resort_routes ();
 467         void   resort_routes_using (boost::shared_ptr<RouteList>);
 468
 469         void   set_remote_control_ids();
 470
 471         AudioEngine & engine() { return _engine; }
 472         AudioEngine const & engine () const { return _engine; }
 473
 474         /* Time */
 475
 476         framepos_t transport_frame () const {return _transport_frame; }
 477         framepos_t audible_frame () const;
 478         framepos_t requested_return_frame() const { return _requested_return_frame; }
 479
 480         enum PullupFormat {
 481                 pullup_Plus4Plus1,
 482                 pullup_Plus4,
 483                 pullup_Plus4Minus1,
 484                 pullup_Plus1,
 485                 pullup_None,
 486                 pullup_Minus1,
 487                 pullup_Minus4Plus1,
 488                 pullup_Minus4,
 489                 pullup_Minus4Minus1
 490         };
 491
 492         void sync_time_vars();
 493
 494         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 495         void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
 496         void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
 497         void timecode_time (Timecode::Time &);
 498         void timecode_time (framepos_t when, Timecode::Time&);
 499         void timecode_time_subframes (framepos_t when, Timecode::Time&);
 500
 501         void timecode_duration (framecnt_t, Timecode::Time&) const;
 502         void timecode_duration_string (char *, framecnt_t) const;
 503
 504         framecnt_t convert_to_frames (AnyTime const & position);
 505         framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
 506
 507         static PBD::Signal1<void, framepos_t> StartTimeChanged;
 508         static PBD::Signal1<void, framepos_t> EndTimeChanged;
 509
 510         std::vector<SyncSource> get_available_sync_options() const;
 511         void   request_sync_source (Slave*);
 512         bool   synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
 513
 514         double transport_speed() const { return _transport_speed; }
 515         bool   transport_stopped() const { return _transport_speed == 0.0f; }
 516         bool   transport_rolling() const { return _transport_speed != 0.0f; }
 517
 518         void set_silent (bool yn);
 519         bool silent () { return _silent; }
 520
 521         TempoMap& tempo_map() { return *_tempo_map; }
 522
 523         /* region info  */
 524
 525         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
 526
 527         std::string path_from_region_name (DataType type, std::string name, std::string identifier);
 528
 529         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 530         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 531         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 532
 533         /* source management */
 534
 535         void import_audiofiles (ImportStatus&);
 536         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 537         std::string build_tmp_convert_name (std::string file);
 538
 539         boost::shared_ptr<ExportHandler> get_export_handler ();
 540         boost::shared_ptr<ExportStatus> get_export_status ();
 541
 542         int start_audio_export (framepos_t position, bool realtime);
 543
 544         PBD::Signal1<int, framecnt_t> ProcessExport;
 545         static PBD::Signal2<void,std::string, std::string> Exported;
 546
 547         void add_source (boost::shared_ptr<Source>);
 548         void remove_source (boost::weak_ptr<Source>);
 549
 550         void  cleanup_regions();
 551         int  cleanup_sources (CleanupReport&);
 552         int  cleanup_trash_sources (CleanupReport&);
 553
 554         int destroy_sources (std::list<boost::shared_ptr<Source> >);
 555
 556         int remove_last_capture ();
 557
 558         /** handlers should return -1 for "stop cleanup",
 559             0 for "yes, delete this playlist",
 560             1 for "no, don't delete this playlist".
 561         */
 562         static PBD::Signal1<int,boost::shared_ptr<Playlist> >  AskAboutPlaylistDeletion;
 563
 564         /** handlers should return 0 for "ignore the rate mismatch",
 565             !0 for "do not use this session"
 566         */
 567         static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
 568
 569         /** handlers should return !0 for use pending state, 0 for ignore it.
 570         */
 571         static PBD::Signal0<int> AskAboutPendingState;
 572
 573         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
 574                 size_t, std::string const &, uint32_t, bool destructive);
 575
 576         boost::shared_ptr<MidiSource> create_midi_source_for_session (
 577                 Track*, std::string const &);
 578
 579         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 580         boost::shared_ptr<Source> source_by_path_and_channel (const std::string&, uint16_t);
 581         uint32_t count_sources_by_origin (const std::string&);
 582
 583         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 584
 585         /* named selections */
 586
 587         boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
 588         void add_named_selection (boost::shared_ptr<NamedSelection>);
 589         void remove_named_selection (boost::shared_ptr<NamedSelection>);
 590
 591         template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
 592         PBD::Signal0<void> NamedSelectionAdded;
 593         PBD::Signal0<void> NamedSelectionRemoved;
 594
 595         /* Curves and AutomationLists (TODO when they go away) */
 596         void add_automation_list(AutomationList*);
 597
 598         /* auditioning */
 599
 600         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 601         void audition_playlist ();
 602         void audition_region (boost::shared_ptr<Region>);
 603         void cancel_audition ();
 604         bool is_auditioning () const;
 605
 606         PBD::Signal1<void,bool> AuditionActive;
 607
 608         /* flattening stuff */
 609
 610         boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
 611                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 612                                                    boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export);
 613         int freeze_all (InterThreadInfo&);
 614
 615         /* session-wide solo/mute/rec-enable */
 616
 617         bool soloing() const { return _non_soloed_outs_muted; }
 618         bool listening() const { return _listen_cnt > 0; }
 619         bool solo_isolated() const { return _solo_isolated_cnt > 0; }
 620
 621         static const SessionEvent::RTeventCallback rt_cleanup;
 622
 623         void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 624         void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
 625         void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
 626         void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 627         void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 628         void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 629         void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 630         void set_exclusive_input_active (boost::shared_ptr<Route> rt, bool others_on);
 631         void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 632
 633         PBD::Signal1<void,bool> SoloActive;
 634         PBD::Signal0<void> SoloChanged;
 635         PBD::Signal0<void> IsolatedChanged;
 636
 637         /* monitor/master out */
 638
 639         void add_monitor_section ();
 640         void remove_monitor_section ();
 641
 642         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 643         boost::shared_ptr<Route> master_out() const { return _master_out; }
 644
 645         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 646         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 647         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 648         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 649         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 650         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 651         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 652
 653         static void set_disable_all_loaded_plugins (bool yn) {
 654                 _disable_all_loaded_plugins = yn;
 655         }
 656         static bool get_disable_all_loaded_plugins() {
 657                 return _disable_all_loaded_plugins;
 658         }
 659
 660         uint32_t next_send_id();
 661         uint32_t next_aux_send_id();
 662         uint32_t next_return_id();
 663         uint32_t next_insert_id();
 664         void mark_send_id (uint32_t);
 665         void mark_aux_send_id (uint32_t);
 666         void mark_return_id (uint32_t);
 667         void mark_insert_id (uint32_t);
 668         void unmark_send_id (uint32_t);
 669         void unmark_aux_send_id (uint32_t);
 670         void unmark_return_id (uint32_t);
 671         void unmark_insert_id (uint32_t);
 672
 673         /* s/w "RAID" management */
 674
 675         framecnt_t available_capture_duration();
 676
 677         /* I/O bundles */
 678
 679         void add_bundle (boost::shared_ptr<Bundle>);
 680         void remove_bundle (boost::shared_ptr<Bundle>);
 681         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 682
 683         PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
 684         PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
 685
 686         void midi_panic ();
 687
 688         /* History (for editors, mixers, UIs etc.) */
 689
 690         /** Undo some transactions.
 691          * @param n Number of transactions to undo.
 692          */
 693         void undo (uint32_t n) {
 694                 _history.undo (n);
 695         }
 696
 697         void redo (uint32_t n) {
 698                 _history.redo (n);
 699         }
 700
 701         UndoHistory& history() { return _history; }
 702
 703         uint32_t undo_depth() const { return _history.undo_depth(); }
 704         uint32_t redo_depth() const { return _history.redo_depth(); }
 705         std::string next_undo() const { return _history.next_undo(); }
 706         std::string next_redo() const { return _history.next_redo(); }
 707
 708         void begin_reversible_command (const std::string& cmd_name);
 709         void begin_reversible_command (GQuark);
 710         void commit_reversible_command (Command* cmd = 0);
 711
 712         void add_command (Command *const cmd) {
 713                 assert (_current_trans);
 714                 _current_trans->add_command (cmd);
 715         }
 716
 717         /** @return The list of operations that are currently in progress */
 718         std::list<GQuark> const & current_operations () {
 719                 return _current_trans_quarks;
 720         }
 721
 722         void add_commands (std::vector<Command*> const & cmds);
 723
 724         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 725
 726         // these commands are implemented in libs/ardour/session_command.cc
 727         Command* memento_command_factory(XMLNode* n);
 728         Command* stateful_diff_command_factory (XMLNode *);
 729         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
 730
 731         /* clicking */
 732
 733         boost::shared_ptr<IO> click_io() { return _click_io; }
 734         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
 735
 736         /* disk, buffer loads */
 737
 738         uint32_t playback_load ();
 739         uint32_t capture_load ();
 740
 741         /* ranges */
 742
 743         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
 744         bool get_play_range () const { return _play_range; }
 745
 746         /* buffers for gain and pan */
 747
 748         gain_t* gain_automation_buffer () const;
 749         pan_t** pan_automation_buffer () const;
 750
 751         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
 752
 753         /* VST support */
 754
 755         static intptr_t vst_callback (
 756                 AEffect* effect,
 757                 int32_t opcode,
 758                 int32_t index,
 759                 intptr_t value,
 760                 void* ptr,
 761                 float opt
 762                 );
 763
 764         static PBD::Signal0<void> SendFeedback;
 765
 766         /* Speakers */
 767
 768         boost::shared_ptr<Speakers> get_speakers ();
 769
 770         /* Controllables */
 771
 772         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
 773         boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
 774
 775         void add_controllable (boost::shared_ptr<PBD::Controllable>);
 776         void remove_controllable (PBD::Controllable*);
 777
 778         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
 779
 780         SessionMetadata & metadata () { return *_metadata; }
 781
 782         SessionConfiguration config;
 783
 784         bool exporting () const {
 785                 return _exporting;
 786         }
 787
 788         /* this is a private enum, but setup_enum_writer() needs it,
 789            and i can't find a way to give that function
 790            friend access. sigh.
 791         */
 792
 793         enum PostTransportWork {
 794                 PostTransportStop               = 0x1,
 795                 PostTransportDuration           = 0x2,
 796                 PostTransportLocate             = 0x4,
 797                 PostTransportRoll               = 0x8,
 798                 PostTransportAbort              = 0x10,
 799                 PostTransportOverWrite          = 0x20,
 800                 PostTransportSpeed              = 0x40,
 801                 PostTransportAudition           = 0x80,
 802                 PostTransportReverse            = 0x100,
 803                 PostTransportInputChange        = 0x200,
 804                 PostTransportCurveRealloc       = 0x400,
 805                 PostTransportClearSubstate      = 0x800,
 806                 PostTransportAdjustPlaybackBuffering  = 0x1000,
 807                 PostTransportAdjustCaptureBuffering   = 0x2000
 808         };
 809
 810         enum SlaveState {
 811                 Stopped,
 812                 Waiting,
 813                 Running
 814         };
 815
 816         SlaveState slave_state() const { return _slave_state; }
 817
 818         boost::shared_ptr<SessionPlaylists> playlists;
 819
 820         void send_mmc_locate (framepos_t);
 821         int send_full_time_code (framepos_t);
 822
 823         PBD::Signal0<void> RouteOrderKeyChanged;
 824
 825         bool step_editing() const { return (_step_editors > 0); }
 826
 827         void request_suspend_timecode_transmission ();
 828         void request_resume_timecode_transmission ();
 829         bool timecode_transmission_suspended () const;
 830
 831         std::string source_search_path(DataType) const;
 832         void ensure_search_path_includes (const std::string& path, DataType type);
 833
 834         std::list<std::string> unknown_processors () const;
 835
 836         /** Emitted when a feedback cycle has been detected within Ardour's signal
 837             processing path.  Until it is fixed (by the user) some (unspecified)
 838             routes will not be run.
 839         */
 840         static PBD::Signal0<void> FeedbackDetected;
 841
 842         /** Emitted when a graph sort has successfully completed, which means
 843             that it has no feedback cycles.
 844         */
 845         static PBD::Signal0<void> SuccessfulGraphSort;
 846
 847         /* handlers can return an integer value:
 848            0: config.set_audio_search_path() or config.set_midi_search_path() was used
 849            to modify the search path and we should try to find it again.
 850            1: quit entire session load
 851            2: as 0, but don't ask about other missing files
 852            3: don't ask about other missing files, and just mark this one missing
 853            -1: just mark this one missing
 854            any other value: as -1
 855         */
 856         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
 857
 858         /** Emitted when the session wants Ardour to quit */
 859         static PBD::Signal0<void> Quit;
 860
 861   protected:
 862         friend class AudioEngine;
 863         void set_block_size (pframes_t nframes);
 864         void set_frame_rate (framecnt_t nframes);
 865
 866   protected:
 867         friend class Route;
 868         void schedule_curve_reallocation ();
 869         void update_latency_compensation (bool force = false);
 870
 871   private:
 872         int  create (const std::string& mix_template, BusProfile*);
 873         void destroy ();
 874
 875         enum SubState {
 876                 PendingDeclickIn   = 0x1,
 877                 PendingDeclickOut  = 0x2,
 878                 StopPendingCapture = 0x4,
 879                 PendingLocate      = 0x20,
 880         };
 881
 882         /* stuff used in process() should be close together to
 883            maximise cache hits
 884         */
 885
 886         typedef void (Session::*process_function_type)(pframes_t);
 887
 888         AudioEngine&            _engine;
 889         mutable gint             processing_prohibited;
 890         process_function_type    process_function;
 891         process_function_type    last_process_function;
 892         bool                     waiting_for_sync_offset;
 893         framecnt_t              _base_frame_rate;
 894         framecnt_t              _current_frame_rate;  //this includes video pullup offset
 895         framecnt_t              _nominal_frame_rate;  //ignores audioengine setting, "native" SR
 896         int                      transport_sub_state;
 897         mutable gint            _record_status;
 898         framepos_t              _transport_frame;
 899         Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
 900         Slave*                  _slave;
 901         bool                    _silent;
 902
 903         void maybe_update_session_range (framepos_t, framepos_t);
 904
 905         // varispeed playback
 906         double                  _transport_speed;
 907         double                  _last_transport_speed;
 908         double                  _target_transport_speed;
 909         CubicInterpolation       interpolation;
 910
 911         bool                     auto_play_legal;
 912         framepos_t              _last_slave_transport_frame;
 913         framecnt_t               maximum_output_latency;
 914         framepos_t              _requested_return_frame;
 915         pframes_t                current_block_size;
 916         framecnt_t              _worst_output_latency;
 917         framecnt_t              _worst_input_latency;
 918         framecnt_t              _worst_track_latency;
 919         bool                    _have_captured;
 920         float                   _meter_hold;
 921         float                   _meter_falloff;
 922         bool                    _non_soloed_outs_muted;
 923         uint32_t                _listen_cnt;
 924         uint32_t                _solo_isolated_cnt;
 925         bool                    _writable;
 926         bool                    _was_seamless;
 927
 928         void initialize_latencies ();
 929         void set_worst_io_latencies ();
 930         void set_worst_playback_latency ();
 931         void set_worst_capture_latency ();
 932         void set_worst_io_latencies_x (IOChange, void *) {
 933                 set_worst_io_latencies ();
 934         }
 935         void post_capture_latency ();
 936         void post_playback_latency ();
 937
 938         void update_latency_compensation_proxy (void* ignored);
 939
 940         void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
 941
 942         void process_scrub          (pframes_t);
 943         void process_without_events (pframes_t);
 944         void process_with_events    (pframes_t);
 945         void process_audition       (pframes_t);
 946         void process_export         (pframes_t);
 947         int  process_export_fw      (pframes_t);
 948
 949         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
 950         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
 951         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
 952
 953         /* slave tracking */
 954
 955         static const int delta_accumulator_size = 25;
 956         int delta_accumulator_cnt;
 957         int32_t delta_accumulator[delta_accumulator_size];
 958         int32_t average_slave_delta;
 959         int  average_dir;
 960         bool have_first_delta_accumulator;
 961
 962         SlaveState _slave_state;
 963         framepos_t slave_wait_end;
 964
 965         void reset_slave_state ();
 966         bool follow_slave (pframes_t);
 967         void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
 968         void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
 969         void follow_slave_silently (pframes_t nframes, float slave_speed);
 970
 971         void switch_to_sync_source (SyncSource); /* !RT context */
 972         void drop_sync_source ();  /* !RT context */
 973         void use_sync_source (Slave*); /* RT context */
 974
 975         bool post_export_sync;
 976         framepos_t post_export_position;
 977
 978         bool _exporting;
 979         bool _export_rolling;
 980
 981         boost::shared_ptr<ExportHandler> export_handler;
 982         boost::shared_ptr<ExportStatus>  export_status;
 983
 984         int  pre_export ();
 985         int  stop_audio_export ();
 986         void finalize_audio_export ();
 987         bool _pre_export_mmc_enabled;
 988
 989         PBD::ScopedConnection export_freewheel_connection;
 990
 991         void get_track_statistics ();
 992         int  process_routes (pframes_t, bool& need_butler);
 993         int  silent_process_routes (pframes_t, bool& need_butler);
 994
 995         int get_transport_declick_required () {
 996                 if (transport_sub_state & PendingDeclickIn) {
 997                         transport_sub_state &= ~PendingDeclickIn;
 998                         return 1;
 999                 } else if (transport_sub_state & PendingDeclickOut) {
1000                         return -1;
1001                 } else {
1002                         return 0;
1003                 }
1004         }
1005
1006         bool maybe_stop (framepos_t limit);
1007         bool maybe_sync_start (pframes_t &);
1008
1009         void check_declick_out ();
1010
1011         std::string             _path;
1012         std::string             _name;
1013         bool                    _is_new;
1014         bool                    _send_qf_mtc;
1015         /** Number of process frames since the last MTC output (when sending MTC); used to
1016          *  know when to send full MTC messages every so often.
1017          */
1018         pframes_t               _pframes_since_last_mtc;
1019         bool                     session_midi_feedback;
1020         bool                     play_loop;
1021         bool                     loop_changing;
1022         framepos_t               last_loopend;
1023
1024         boost::scoped_ptr<SessionDirectory> _session_dir;
1025
1026         void hookup_io ();
1027         void when_engine_running ();
1028         void graph_reordered ();
1029
1030         /** current snapshot name, without the .ardour suffix */
1031         std::string _current_snapshot_name;
1032
1033         XMLTree*         state_tree;
1034         bool             state_was_pending;
1035         StateOfTheState _state_of_the_state;
1036
1037         void     auto_save();
1038         int      load_options (const XMLNode&);
1039         int      load_state (std::string snapshot_name);
1040
1041         framepos_t _last_roll_location;
1042         framepos_t _last_roll_or_reversal_location;
1043         framepos_t _last_record_location;
1044
1045         bool              pending_locate_roll;
1046         framepos_t        pending_locate_frame;
1047         bool              pending_locate_flush;
1048         bool              pending_abort;
1049         bool              pending_auto_loop;
1050
1051         Butler* _butler;
1052
1053         static const PostTransportWork ProcessCannotProceedMask =
1054                 PostTransportWork (
1055                                 PostTransportInputChange|
1056                                 PostTransportSpeed|
1057                                 PostTransportReverse|
1058                                 PostTransportCurveRealloc|
1059                                 PostTransportAudition|
1060                                 PostTransportLocate|
1061                                 PostTransportStop|
1062                                 PostTransportClearSubstate);
1063
1064         gint _post_transport_work; /* accessed only atomic ops */
1065         PostTransportWork post_transport_work() const        { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1066         void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1067         void add_post_transport_work (PostTransportWork ptw);
1068
1069         void schedule_playback_buffering_adjustment ();
1070         void schedule_capture_buffering_adjustment ();
1071
1072         uint32_t    cumulative_rf_motion;
1073         uint32_t    rf_scale;
1074
1075         void set_rf_speed (float speed);
1076         void reset_rf_scale (framecnt_t frames_moved);
1077
1078         Locations*       _locations;
1079         void              locations_changed ();
1080         void              locations_added (Location*);
1081         void              handle_locations_changed (Locations::LocationList&);
1082
1083         PBD::ScopedConnectionList punch_connections;
1084         void             auto_punch_start_changed (Location *);
1085         void             auto_punch_end_changed (Location *);
1086         void             auto_punch_changed (Location *);
1087
1088         PBD::ScopedConnectionList loop_connections;
1089         void             auto_loop_changed (Location *);
1090
1091         void first_stage_init (std::string path, std::string snapshot_name);
1092         int  second_stage_init ();
1093         void remove_empty_sounds ();
1094
1095         void setup_midi_control ();
1096         int  midi_read (MIDI::Port *);
1097
1098         void enable_record ();
1099
1100         void increment_transport_position (framecnt_t val) {
1101                 if (max_framepos - val < _transport_frame) {
1102                         _transport_frame = max_framepos;
1103                 } else {
1104                         _transport_frame += val;
1105                 }
1106         }
1107
1108         void decrement_transport_position (framecnt_t val) {
1109                 if (val < _transport_frame) {
1110                         _transport_frame -= val;
1111                 } else {
1112                         _transport_frame = 0;
1113                 }
1114         }
1115
1116         void post_transport_motion ();
1117         static void *session_loader_thread (void *arg);
1118
1119         void *do_work();
1120
1121         /* SessionEventManager interface */
1122
1123         void process_event (SessionEvent*);
1124         void set_next_event ();
1125         void cleanup_event (SessionEvent*,int);
1126
1127         /* MIDI Machine Control */
1128
1129         void spp_start (MIDI::Parser&, framepos_t timestamp);
1130         void spp_continue (MIDI::Parser&, framepos_t timestamp);
1131         void spp_stop (MIDI::Parser&, framepos_t timestamp);
1132
1133         void mmc_deferred_play (MIDI::MachineControl &);
1134         void mmc_stop (MIDI::MachineControl &);
1135         void mmc_step (MIDI::MachineControl &, int);
1136         void mmc_pause (MIDI::MachineControl &);
1137         void mmc_record_pause (MIDI::MachineControl &);
1138         void mmc_record_strobe (MIDI::MachineControl &);
1139         void mmc_record_exit (MIDI::MachineControl &);
1140         void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1141         void mmc_fast_forward (MIDI::MachineControl &);
1142         void mmc_rewind (MIDI::MachineControl &);
1143         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1144         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1145         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1146
1147         struct timeval last_mmc_step;
1148         double step_speed;
1149
1150         typedef boost::function<bool()> MidiTimeoutCallback;
1151         typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1152
1153         MidiTimeoutList midi_timeouts;
1154         bool mmc_step_timeout ();
1155
1156         MIDI::byte mtc_msg[16];
1157         MIDI::byte mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
1158         MIDI::byte midi_msg[16];
1159         framepos_t outbound_mtc_timecode_frame;
1160         Timecode::Time transmitting_timecode_time;
1161         int next_quarter_frame_to_send;
1162
1163         double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1164         framecnt_t _frames_per_hour;
1165         framecnt_t _timecode_frames_per_hour;
1166
1167         /* cache the most-recently requested time conversions. This helps when we
1168          * have multiple clocks showing the same time (e.g. the transport frame) */
1169         bool last_timecode_valid;
1170         framepos_t last_timecode_when;
1171         Timecode::Time last_timecode;
1172
1173         bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1174
1175         int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1176
1177         void reset_record_status ();
1178
1179         int no_roll (pframes_t nframes);
1180         int fail_roll (pframes_t nframes);
1181
1182         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1183         bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1184
1185         MidiControlUI* midi_control_ui;
1186
1187         int           start_midi_thread ();
1188
1189         void set_play_loop (bool yn);
1190         void unset_play_loop ();
1191         void overwrite_some_buffers (Track *);
1192         void flush_all_inserts ();
1193         int  micro_locate (framecnt_t distance);
1194         void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1195         void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1196         void force_locate (framepos_t frame, bool with_roll = false);
1197         void set_track_speed (Track *, double speed);
1198         void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1199         void stop_transport (bool abort = false, bool clear_state = false);
1200         void start_transport ();
1201         void realtime_stop (bool abort, bool clear_state);
1202         void realtime_locate ();
1203         void non_realtime_start_scrub ();
1204         void non_realtime_set_speed ();
1205         void non_realtime_locate ();
1206         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1207         void non_realtime_overwrite (int entry_request_count, bool& finished);
1208         void post_transport ();
1209         void engine_halted ();
1210         void xrun_recovery ();
1211
1212         TempoMap    *_tempo_map;
1213         void          tempo_map_changed (const PBD::PropertyChange&);
1214
1215         /* edit/mix groups */
1216
1217         int load_route_groups (const XMLNode&, int);
1218
1219         std::list<RouteGroup *> _route_groups;
1220         RouteGroup*             _all_route_group;
1221
1222         /* routes stuff */
1223
1224         boost::shared_ptr<Graph> _process_graph;
1225
1226         SerializedRCUManager<RouteList>  routes;
1227
1228         void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1229         uint32_t destructive_index;
1230
1231         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1232         boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1233
1234         void route_processors_changed (RouteProcessorChange);
1235
1236         bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1237         void count_existing_track_channels (ChanCount& in, ChanCount& out);
1238         void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1239                                  bool with_lock, bool connect_inputs = true,
1240                                  ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1241         void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1242
1243         /* mixer stuff */
1244
1245         bool solo_update_disabled;
1246
1247         void route_listen_changed (void *src, boost::weak_ptr<Route>);
1248         void route_mute_changed (void *src);
1249         void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1250         void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1251         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1252
1253         void listen_position_changed ();
1254         void solo_control_mode_changed ();
1255
1256         /* REGION MANAGEMENT */
1257
1258         mutable Glib::Mutex region_lock;
1259
1260         int load_regions (const XMLNode& node);
1261         int load_compounds (const XMLNode& node);
1262
1263         void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1264         void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1265         void route_group_property_changed (RouteGroup *);
1266
1267         /* SOURCES */
1268
1269         mutable Glib::Mutex source_lock;
1270
1271   public:
1272         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1273
1274   private:
1275         SourceMap sources;
1276
1277   public:
1278         SourceMap get_sources() { return sources; }
1279
1280   private:
1281         int load_sources (const XMLNode& node);
1282         XMLNode& get_sources_as_xml ();
1283
1284         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1285
1286         /* PLAYLISTS */
1287
1288         void remove_playlist (boost::weak_ptr<Playlist>);
1289         void track_playlist_changed (boost::weak_ptr<Track>);
1290         void playlist_region_added (boost::weak_ptr<Region>);
1291         void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1292         void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1293
1294         /* NAMED SELECTIONS */
1295
1296         mutable Glib::Mutex named_selection_lock;
1297         typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1298         NamedSelectionList named_selections;
1299
1300         int load_named_selections (const XMLNode&);
1301
1302         NamedSelection *named_selection_factory (std::string name);
1303         NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1304
1305         /* CURVES and AUTOMATION LISTS */
1306         std::map<PBD::ID, AutomationList*> automation_lists;
1307
1308         /* DEFAULT FADE CURVES */
1309
1310         float default_fade_steepness;
1311         float default_fade_msecs;
1312
1313         /* AUDITIONING */
1314
1315         boost::shared_ptr<Auditioner> auditioner;
1316         void set_audition (boost::shared_ptr<Region>);
1317         void non_realtime_set_audition ();
1318         boost::shared_ptr<Region> pending_audition_region;
1319
1320         /* EXPORT */
1321
1322         /* FLATTEN */
1323
1324         int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1325
1326         /* INSERT AND SEND MANAGEMENT */
1327
1328         boost::dynamic_bitset<uint32_t> send_bitset;
1329         boost::dynamic_bitset<uint32_t> aux_send_bitset;
1330         boost::dynamic_bitset<uint32_t> return_bitset;
1331         boost::dynamic_bitset<uint32_t> insert_bitset;
1332
1333         /* S/W RAID */
1334
1335         struct space_and_path {
1336                 uint32_t blocks; /* 4kB blocks */
1337                 std::string path;
1338
1339                 space_and_path() {
1340                         blocks = 0;
1341                 }
1342         };
1343
1344         struct space_and_path_ascending_cmp {
1345                 bool operator() (space_and_path a, space_and_path b) {
1346                         return a.blocks > b.blocks;
1347                 }
1348         };
1349
1350         void setup_raid_path (std::string path);
1351
1352         std::vector<space_and_path> session_dirs;
1353         std::vector<space_and_path>::iterator last_rr_session_dir;
1354         uint32_t _total_free_4k_blocks;
1355         Glib::Mutex space_lock;
1356
1357         bool no_questions_about_missing_files;
1358
1359         std::string get_best_session_directory_for_new_source ();
1360
1361         mutable gint _playback_load;
1362         mutable gint _capture_load;
1363
1364         /* I/O bundles */
1365
1366         SerializedRCUManager<BundleList> _bundles;
1367         XMLNode* _bundle_xml_node;
1368         int load_bundles (XMLNode const &);
1369
1370         UndoHistory      _history;
1371         /** current undo transaction, or 0 */
1372         UndoTransaction* _current_trans;
1373         /** GQuarks to describe the reversible commands that are currently in progress.
1374          *  These may be nested, in which case more recently-started commands are toward
1375          *  the front of the list.
1376          */
1377         std::list<GQuark> _current_trans_quarks;
1378
1379         void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
1380         int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
1381         void reset_jack_connection (jack_client_t* jack);
1382         void process_rtop (SessionEvent*);
1383
1384         void  update_latency (bool playback);
1385
1386         XMLNode& state(bool);
1387
1388         /* click track */
1389         typedef std::list<Click*> Clicks;
1390         Clicks                  clicks;
1391         bool                   _clicking;
1392         boost::shared_ptr<IO>  _click_io;
1393         boost::shared_ptr<Amp> _click_gain;
1394         Sample*                 click_data;
1395         Sample*                 click_emphasis_data;
1396         framecnt_t              click_length;
1397         framecnt_t              click_emphasis_length;
1398         mutable Glib::RWLock    click_lock;
1399
1400         static const Sample     default_click[];
1401         static const framecnt_t default_click_length;
1402         static const Sample     default_click_emphasis[];
1403         static const framecnt_t default_click_emphasis_length;
1404
1405         Click *get_click();
1406         framepos_t _clicks_cleared;
1407         void   setup_click_sounds (int which);
1408         void   setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1409         void   clear_clicks ();
1410         void   click (framepos_t start, framecnt_t nframes);
1411
1412         std::vector<Route*> master_outs;
1413
1414         /* range playback */
1415
1416         std::list<AudioRange> current_audio_range;
1417         bool _play_range;
1418         void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1419         void unset_play_range ();
1420
1421         /* main outs */
1422         uint32_t main_outs;
1423
1424         boost::shared_ptr<Route> _master_out;
1425         boost::shared_ptr<Route> _monitor_out;
1426
1427         void auto_connect_master_bus ();
1428
1429         /* Windows VST support */
1430
1431         long _windows_vst_callback (
1432                 WindowsVSTPlugin*,
1433                 long opcode,
1434                 long index,
1435                 long value,
1436                 void* ptr,
1437                 float opt
1438                 );
1439
1440         /* number of hardware ports we're using,
1441            based on max (requested,available)
1442         */
1443
1444         ChanCount n_physical_outputs;
1445         ChanCount n_physical_inputs;
1446
1447         int find_all_sources (std::string path, std::set<std::string>& result);
1448         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1449
1450         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1451         Glib::Mutex controllables_lock;
1452         Controllables controllables;
1453
1454         boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1455
1456         void reset_native_file_format();
1457         bool first_file_data_format_reset;
1458         bool first_file_header_format_reset;
1459
1460         void config_changed (std::string, bool);
1461
1462         XMLNode& get_control_protocol_state ();
1463
1464         void set_history_depth (uint32_t depth);
1465         void sync_order_keys ();
1466
1467         static bool _disable_all_loaded_plugins;
1468
1469         SessionMetadata * _metadata;
1470
1471         mutable bool have_looped; ///< Used in ::audible_frame(*)
1472
1473         void update_have_rec_enabled_track ();
1474         gint _have_rec_enabled_track;
1475
1476         static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1477
1478         /* realtime "apply to set of routes" operations */
1479         template<typename T> SessionEvent*
1480                 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1481                               void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1482                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1483                 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1484                 ev->rt_return = after;
1485                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1486
1487                 return ev;
1488         }
1489
1490         void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1491         void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1492         void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1493         void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1494         void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1495         void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1496         void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1497         void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1498
1499         /** temporary list of Diskstreams used only during load of 2.X sessions */
1500         std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1501
1502         void add_session_range_location (framepos_t, framepos_t);
1503
1504         void setup_midi_machine_control ();
1505
1506         void route_order_key_changed ();
1507
1508         void step_edit_status_change (bool);
1509         uint32_t _step_editors;
1510
1511         /** true if timecode transmission by the transport is suspended, otherwise false */
1512         mutable gint _suspend_timecode_transmission;
1513
1514         void update_locations_after_tempo_map_change (Locations::LocationList &);
1515
1516         void start_time_changed (framepos_t);
1517         void end_time_changed (framepos_t);
1518
1519         void set_track_monitor_input_status (bool);
1520         framepos_t compute_stop_limit () const;
1521
1522         boost::shared_ptr<Speakers> _speakers;
1523         void load_nested_sources (const XMLNode& node);
1524
1525         /** The directed graph of routes that is currently being used for audio processing
1526             and solo/mute computations.
1527         */
1528         GraphEdges _current_route_graph;
1529
1530         uint32_t next_control_id () const;
1531         bool ignore_route_processor_changes;
1532
1533         MidiClockTicker* midi_clock;
1534 };
1535
1536 } // namespace ARDOUR
1537
1538 #endif /* __ardour_session_h__ */