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