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