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