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