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