libs/ardour/ardour/session.h

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