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