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