libs/ardour/ardour/session.h

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