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