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