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