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