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