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