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