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