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