libs/ardour/ardour/session.h

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