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