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