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