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