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