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