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