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