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