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