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 <exception>
  26 #include <list>
  27 #include <map>
  28 #include <set>
  29 #include <string>
  30 #include <vector>
  31 #include <stdint.h>
  32
  33 #include <boost/dynamic_bitset.hpp>
  34 #include <boost/scoped_ptr.hpp>
  35 #include <boost/weak_ptr.hpp>
  36 #include <boost/utility.hpp>
  37
  38 #include <glibmm/threads.h>
  39
  40 #include <ltc.h>
  41
  42 #include "pbd/error.h"
  43 #include "pbd/event_loop.h"
  44 #include "pbd/rcu.h"
  45 #include "pbd/reallocpool.h"
  46 #include "pbd/statefuldestructible.h"
  47 #include "pbd/signals.h"
  48 #include "pbd/undo.h"
  49
  50 #include "lua/luastate.h"
  51
  52 #include "evoral/Range.hpp"
  53
  54 #include "midi++/types.h"
  55 #include "midi++/mmc.h"
  56
  57 #include "timecode/time.h"
  58
  59 #include "ardour/ardour.h"
  60 #include "ardour/chan_count.h"
  61 #include "ardour/delivery.h"
  62 #include "ardour/interthread_info.h"
  63 #include "ardour/luascripting.h"
  64 #include "ardour/location.h"
  65 #include "ardour/monitor_processor.h"
  66 #include "ardour/rc_configuration.h"
  67 #include "ardour/session_configuration.h"
  68 #include "ardour/session_event.h"
  69 #include "ardour/interpolation.h"
  70 #include "ardour/route.h"
  71 #include "ardour/route_graph.h"
  72
  73
  74 class XMLTree;
  75 class XMLNode;
  76 struct _AEffect;
  77 typedef struct _AEffect AEffect;
  78
  79 namespace MIDI {
  80 class Port;
  81 class MachineControl;
  82 class Parser;
  83 }
  84
  85 namespace PBD {
  86 class Controllable;
  87 class ControllableDescriptor;
  88 }
  89
  90 namespace luabridge {
  91         class LuaRef;
  92 }
  93
  94 namespace Evoral {
  95 class Curve;
  96 }
  97
  98 namespace ARDOUR {
  99
 100 class Amp;
 101 class AudioEngine;
 102 class AudioFileSource;
 103 class AudioRegion;
 104 class AudioSource;
 105 class AudioTrack;
 106 class Auditioner;
 107 class AutomationList;
 108 class AuxInput;
 109 class BufferSet;
 110 class Bundle;
 111 class Butler;
 112 class Click;
 113 class Diskstream;
 114 class ExportHandler;
 115 class ExportStatus;
 116 class Graph;
 117 class IO;
 118 class IOProcessor;
 119 class ImportStatus;
 120 class MidiClockTicker;
 121 class MidiControlUI;
 122 class MidiPortManager;
 123 class MidiPort;
 124 class MidiRegion;
 125 class MidiSource;
 126 class MidiTrack;
 127 class Playlist;
 128 class PluginInsert;
 129 class PluginInfo;
 130 class Port;
 131 class PortInsert;
 132 class ProcessThread;
 133 class Processor;
 134 class Region;
 135 class Return;
 136 class Route;
 137 class RouteGroup;
 138 class SMFSource;
 139 class Send;
 140 class SceneChanger;
 141 class SessionDirectory;
 142 class SessionMetadata;
 143 class SessionPlaylists;
 144 class Slave;
 145 class Source;
 146 class Speakers;
 147 class TempoMap;
 148 class Track;
 149 class WindowsVSTPlugin;
 150
 151 extern void setup_enum_writer ();
 152
 153 class LIBARDOUR_API SessionException: public std::exception {
 154 public:
 155         explicit SessionException(const std::string msg) : _message(msg) {}
 156         virtual ~SessionException() throw() {}
 157
 158         virtual const char* what() const throw() { return _message.c_str(); }
 159
 160 private:
 161         std::string _message;
 162 };
 163
 164 /** Ardour Session */
 165 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
 166 {
 167   public:
 168         enum RecordState {
 169                 Disabled = 0,
 170                 Enabled = 1,
 171                 Recording = 2
 172         };
 173
 174         /* a new session might have non-empty mix_template, an existing session should always have an empty one.
 175            the bus profile can be null if no master out bus is required.
 176         */
 177
 178         Session (AudioEngine&,
 179                  const std::string& fullpath,
 180                  const std::string& snapshot_name,
 181                  BusProfile* bus_profile = 0,
 182                  std::string mix_template = "");
 183
 184         virtual ~Session ();
 185
 186         static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
 187         static std::string get_snapshot_from_instant (const std::string& session_dir);
 188
 189         /** a monotonic counter used for naming user-visible things uniquely
 190          * (curently the sidechain port).
 191          * Use sparingly to keep the numbers low, prefer PBD::ID for all
 192          * internal, not user-visible IDs */
 193         static unsigned int next_name_id ();
 194
 195         std::string path() const { return _path; }
 196         std::string name() const { return _name; }
 197         std::string snap_name() const { return _current_snapshot_name; }
 198         std::string raid_path () const;
 199         bool path_is_within_session (const std::string&);
 200
 201         bool writable() const { return _writable; }
 202         void set_dirty ();
 203         void set_clean ();
 204         bool dirty() const { return _state_of_the_state & Dirty; }
 205         void set_deletion_in_progress ();
 206         void clear_deletion_in_progress ();
 207         bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
 208         bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
 209         bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
 210         bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
 211
 212         PBD::Signal0<void> DirtyChanged;
 213
 214         PBD::Signal1<void, bool> RouteAddedOrRemoved;
 215
 216         const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
 217
 218         static PBD::Signal1<void,std::string> Dialog;
 219
 220         PBD::Signal0<void> BatchUpdateStart;
 221         PBD::Signal0<void> BatchUpdateEnd;
 222
 223         int ensure_subdirs ();
 224
 225         std::string automation_dir () const;  ///< Automation data
 226         std::string analysis_dir () const;    ///< Analysis data
 227         std::string plugins_dir () const;     ///< Plugin state
 228         std::string externals_dir () const;   ///< Links to external files
 229
 230         std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
 231
 232         bool audio_source_name_is_unique (const std::string& name);
 233         std::string format_audio_source_name (const std::string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists);
 234         std::string new_audio_source_path_for_embedded (const std::string& existing_path);
 235         std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
 236         std::string new_midi_source_path (const std::string&);
 237         /** create a new track or bus from a template (XML path)
 238          * @param how_many how many tracks or busses to create
 239          * @param template_path path to xml template file
 240          * @param name name (prefix) of the route to create
 241          * @param pd Playlist disposition
 242          * @return list of newly created routes
 243          */
 244         RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
 245         RouteList new_route_from_template (uint32_t how_many, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
 246         std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
 247
 248         int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
 249
 250         void process (pframes_t nframes);
 251
 252         BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
 253         BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
 254         BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
 255         BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
 256         BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
 257
 258         bool have_rec_enabled_track () const;
 259     bool have_rec_disabled_track () const;
 260
 261         bool have_captured() const { return _have_captured; }
 262
 263         void refill_all_track_buffers ();
 264         Butler* butler() { return _butler; }
 265         void butler_transport_work ();
 266
 267         void refresh_disk_space ();
 268
 269         int load_diskstreams_2X (XMLNode const &, int);
 270
 271         int load_routes (const XMLNode&, int);
 272         boost::shared_ptr<RouteList> get_routes() const {
 273                 return routes.reader ();
 274         }
 275
 276         boost::shared_ptr<RouteList> get_tracks() const;
 277         boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
 278         boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
 279
 280         uint32_t nroutes() const { return routes.reader()->size(); }
 281         uint32_t ntracks () const;
 282         uint32_t nbusses () const;
 283
 284         boost::shared_ptr<BundleList> bundles () {
 285                 return _bundles.reader ();
 286         }
 287
 288         struct LIBARDOUR_API RoutePublicOrderSorter {
 289                 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
 290         };
 291
 292         void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
 293         void notify_remote_id_change ();
 294         void sync_order_keys ();
 295
 296         template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
 297         template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
 298         template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
 299
 300         static char session_name_is_legal (const std::string&);
 301         bool io_name_is_legal (const std::string&);
 302         boost::shared_ptr<Route> route_by_name (std::string);
 303         boost::shared_ptr<Route> route_by_id (PBD::ID);
 304         boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
 305         boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt);
 306         boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
 307         void routes_using_input_from (const std::string& str, RouteList& rl);
 308
 309         bool route_name_unique (std::string) const;
 310         bool route_name_internal (std::string) const;
 311
 312         uint32_t track_number_decimals () const {
 313                 return _track_number_decimals;
 314         }
 315
 316         bool get_record_enabled() const {
 317                 return (record_status () >= Enabled);
 318         }
 319
 320         RecordState record_status() const {
 321                 return (RecordState) g_atomic_int_get (&_record_status);
 322         }
 323
 324         bool actively_recording () const {
 325                 return record_status() == Recording;
 326         }
 327
 328         bool record_enabling_legal () const;
 329         void maybe_enable_record ();
 330         void disable_record (bool rt_context, bool force = false);
 331         void step_back_from_record ();
 332
 333         void set_all_tracks_record_enabled(bool);
 334
 335         void maybe_write_autosave ();
 336
 337         /* Emitted when all i/o connections are complete */
 338
 339         PBD::Signal0<void> IOConnectionsComplete;
 340
 341         /* Timecode status signals */
 342         PBD::Signal1<void, bool> MTCSyncStateChanged;
 343         PBD::Signal1<void, bool> LTCSyncStateChanged;
 344
 345         /* Record status signals */
 346
 347         PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
 348         /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
 349            from the previous signal and session state.
 350         */
 351         PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
 352
 353         /* Emited when session is loaded */
 354         PBD::Signal0<void> SessionLoaded;
 355
 356         /* Transport mechanism signals */
 357
 358         /** Emitted on the following changes in transport state:
 359          *  - stop (from the butler thread)
 360          *  - change in whether or not we are looping (from the process thread)
 361          *  - change in the play range (from the process thread)
 362          *  - start (from the process thread)
 363          *  - engine halted
 364          */
 365         PBD::Signal0<void> TransportStateChange;
 366
 367         PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
 368         PBD::Signal1<void,framepos_t> Xrun;
 369         PBD::Signal0<void> TransportLooped;
 370
 371         /** emitted when a locate has occurred */
 372         PBD::Signal0<void> Located;
 373
 374         PBD::Signal1<void,RouteList&> RouteAdded;
 375         /** Emitted when a property of one of our route groups changes.
 376          *  The parameter is the RouteGroup that has changed.
 377          */
 378         PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
 379         /** Emitted when a route is added to one of our route groups.
 380          *  First parameter is the RouteGroup, second is the route.
 381          */
 382         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
 383         /** Emitted when a route is removed from one of our route groups.
 384          *  First parameter is the RouteGroup, second is the route.
 385          */
 386         PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
 387
 388         /* Step Editing status changed */
 389         PBD::Signal1<void,bool> StepEditStatusChange;
 390
 391         /* Timecode state signals */
 392         PBD::Signal0<void> MtcOrLtcInputPortChanged;
 393
 394         void queue_event (SessionEvent*);
 395
 396         void request_roll_at_and_return (framepos_t start, framepos_t return_to);
 397         void request_bounded_roll (framepos_t start, framepos_t end);
 398         void request_stop (bool abort = false, bool clear_state = false);
 399         void request_locate (framepos_t frame, bool with_roll = false);
 400
 401         void request_play_loop (bool yn, bool leave_rolling = false);
 402         bool get_play_loop () const { return play_loop; }
 403
 404         framepos_t last_transport_start () const { return _last_roll_location; }
 405         void goto_end ();
 406         void goto_start ();
 407         void use_rf_shuttle_speed ();
 408         void allow_auto_play (bool yn);
 409         void request_transport_speed (double speed, bool as_default = true);
 410         void request_transport_speed_nonzero (double, bool as_default = true);
 411         void request_overwrite_buffer (Track *);
 412         void adjust_playback_buffering();
 413         void adjust_capture_buffering();
 414         void request_track_speed (Track *, double speed);
 415         void request_input_change_handling ();
 416
 417         bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
 418         bool transport_locked () const;
 419
 420         int wipe ();
 421
 422         framepos_t current_end_frame () const;
 423         framepos_t current_start_frame () const;
 424         /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
 425         framecnt_t frame_rate () const { return _current_frame_rate; }
 426         /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
 427         framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
 428         framecnt_t frames_per_hour () const { return _frames_per_hour; }
 429
 430         double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
 431         framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
 432
 433         MIDI::byte get_mtc_timecode_bits() const {
 434                 return mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
 435         }
 436
 437         double timecode_frames_per_second() const;
 438         bool timecode_drop_frames() const;
 439
 440         /* Locations */
 441
 442         Locations *locations() { return _locations; }
 443
 444         PBD::Signal1<void,Location*>    auto_loop_location_changed;
 445         PBD::Signal1<void,Location*>    auto_punch_location_changed;
 446         PBD::Signal0<void>              locations_modified;
 447
 448         void set_auto_punch_location (Location *);
 449         void set_auto_loop_location (Location *);
 450         void set_session_extents (framepos_t start, framepos_t end);
 451         int location_name(std::string& result, std::string base = std::string(""));
 452
 453         pframes_t get_block_size()        const { return current_block_size; }
 454         framecnt_t worst_output_latency () const { return _worst_output_latency; }
 455         framecnt_t worst_input_latency ()  const { return _worst_input_latency; }
 456         framecnt_t worst_track_latency ()  const { return _worst_track_latency; }
 457         framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
 458
 459         struct SaveAs {
 460                 std::string new_parent_folder;  /* parent folder where new session folder will be created */
 461                 std::string new_name;           /* name of newly saved session */
 462                 bool        switch_to;     /* true if we should be working on newly saved session after save-as; false otherwise */
 463                 bool        include_media; /* true if the newly saved session should contain references to media */
 464                 bool        copy_media;    /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
 465                 bool        copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
 466
 467                 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
 468
 469                 /* emitted as we make progress. 3 arguments passed to signal
 470                  * handler:
 471                  *
 472                  *  1: percentage complete measured as a fraction (0-1.0) of
 473                  *     total data copying done.
 474                  *  2: number of files copied so far
 475                  *  3: total number of files to copy
 476                  *
 477                  * Handler should return true for save-as to continue, or false
 478                  * to stop (and remove all evidence of partial save-as).
 479                  */
 480                 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
 481
 482                 /* if save_as() returns non-zero, this string will indicate the reason why.
 483                  */
 484                 std::string failure_message;
 485         };
 486
 487         int save_as (SaveAs&);
 488         /** save session
 489          * @param snapshot_name name of the session (use an empty string for the current name)
 490          * @param pending save a 'recovery', not full state (default: false)
 491          * @param switch_to_snapshot switch to given snapshot after saving (default: false)
 492          * @param template_only save a session template (default: false)
 493          * @return zero on success
 494          */
 495         int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
 496         int restore_state (std::string snapshot_name);
 497         int save_template (std::string template_name, bool replace_existing = false);
 498         int save_history (std::string snapshot_name = "");
 499         int restore_history (std::string snapshot_name);
 500         void remove_state (std::string snapshot_name);
 501         void rename_state (std::string old_name, std::string new_name);
 502         void remove_pending_capture_state ();
 503         int rename (const std::string&);
 504         bool get_nsm_state () const { return _under_nsm_control; }
 505         void set_nsm_state (bool state) { _under_nsm_control = state; }
 506         bool save_default_options ();
 507
 508         PBD::Signal1<void,std::string> StateSaved;
 509         PBD::Signal0<void> StateReady;
 510
 511         /* emitted when session needs to be saved due to some internal
 512          * event or condition (i.e. not in response to a user request).
 513          *
 514          * Only one object should
 515          * connect to this signal and take responsibility.
 516          *
 517          * Argument is the snapshot name to use when saving.
 518          */
 519         PBD::Signal1<void,std::string> SaveSessionRequested;
 520
 521         /* emitted during a session save to allow other entities to add state, via
 522          * extra XML, to the session state
 523          */
 524         PBD::Signal0<void> SessionSaveUnderway;
 525
 526         std::vector<std::string> possible_states() const;
 527         static std::vector<std::string> possible_states (std::string path);
 528
 529         XMLNode& get_state();
 530         int      set_state(const XMLNode& node, int version); // not idempotent
 531         XMLNode& get_template();
 532
 533         /// The instant xml file is written to the session directory
 534         void add_instant_xml (XMLNode&, bool write_to_config = true);
 535         XMLNode* instant_xml (const std::string& str);
 536
 537         enum StateOfTheState {
 538                 Clean = 0x0,
 539                 Dirty = 0x1,
 540                 CannotSave = 0x2,
 541                 Deletion = 0x4,
 542                 InitialConnecting = 0x8,
 543                 Loading = 0x10,
 544                 InCleanup = 0x20,
 545                 PeakCleanup = 0x40
 546         };
 547
 548         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 549
 550         class StateProtector {
 551                                                 public:
 552                 StateProtector (Session* s) : _session (s) {
 553                         g_atomic_int_inc (&s->_suspend_save);
 554                 }
 555                 ~StateProtector () {
 556                         if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
 557                                 while (_session->_save_queued) {
 558                                         _session->_save_queued = false;
 559                                         _session->save_state ("");
 560                                 }
 561                         }
 562                 }
 563                                                 private:
 564                 Session * _session;
 565         };
 566
 567         void add_route_group (RouteGroup *);
 568         void remove_route_group (RouteGroup&);
 569         void reorder_route_groups (std::list<RouteGroup*>);
 570
 571         RouteGroup* route_group_by_name (std::string);
 572         RouteGroup& all_route_group() const;
 573
 574         PBD::Signal1<void,RouteGroup*> route_group_added;
 575         PBD::Signal0<void>             route_group_removed;
 576         PBD::Signal0<void>             route_groups_reordered;
 577
 578         void foreach_route_group (boost::function<void(RouteGroup*)> f) {
 579                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
 580                         f (*i);
 581                 }
 582         }
 583
 584         std::list<RouteGroup*> const & route_groups () const {
 585                 return _route_groups;
 586         }
 587
 588         /* fundamental operations. duh. */
 589
 590         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 591                 int input_channels,
 592                 int output_channels,
 593                 TrackMode mode = Normal,
 594                 RouteGroup* route_group = 0,
 595                 uint32_t how_many = 1,
 596                 std::string name_template = ""
 597                 );
 598
 599         RouteList new_audio_route (
 600                 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
 601                 );
 602
 603         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 604                 const ChanCount& input, const ChanCount& output,
 605                 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
 606                 TrackMode mode = Normal,
 607                 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
 608                 );
 609
 610         RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template = "", boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>());
 611
 612         void remove_routes (boost::shared_ptr<RouteList>);
 613         void remove_route (boost::shared_ptr<Route>);
 614
 615         void resort_routes ();
 616         void resort_routes_using (boost::shared_ptr<RouteList>);
 617
 618         AudioEngine & engine() { return _engine; }
 619         AudioEngine const & engine () const { return _engine; }
 620
 621         static std::string default_track_name_pattern (DataType);
 622
 623         /* Time */
 624
 625         framepos_t transport_frame () const {return _transport_frame; }
 626         framepos_t record_location () const {return _last_record_location; }
 627         framepos_t audible_frame () const;
 628         framepos_t requested_return_frame() const { return _requested_return_frame; }
 629         void set_requested_return_frame(framepos_t return_to);
 630
 631         enum PullupFormat {
 632                 pullup_Plus4Plus1,
 633                 pullup_Plus4,
 634                 pullup_Plus4Minus1,
 635                 pullup_Plus1,
 636                 pullup_None,
 637                 pullup_Minus1,
 638                 pullup_Minus4Plus1,
 639                 pullup_Minus4,
 640                 pullup_Minus4Minus1
 641         };
 642
 643         void sync_time_vars();
 644
 645         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 646         void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
 647         void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
 648         void timecode_time (Timecode::Time &);
 649         void timecode_time (framepos_t when, Timecode::Time&);
 650         void timecode_time_subframes (framepos_t when, Timecode::Time&);
 651
 652         void timecode_duration (framecnt_t, Timecode::Time&) const;
 653         void timecode_duration_string (char *, size_t len, framecnt_t) const;
 654
 655         framecnt_t convert_to_frames (AnyTime const & position);
 656         framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
 657
 658         static PBD::Signal1<void, framepos_t> StartTimeChanged;
 659         static PBD::Signal1<void, framepos_t> EndTimeChanged;
 660
 661         void   request_sync_source (Slave*);
 662         bool   synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
 663         bool   synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
 664         bool   synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
 665
 666         double transport_speed() const { return _transport_speed; }
 667         bool   transport_stopped() const { return _transport_speed == 0.0f; }
 668         bool   transport_rolling() const { return _transport_speed != 0.0f; }
 669
 670         bool silent () { return _silent; }
 671
 672         TempoMap&       tempo_map()       { return *_tempo_map; }
 673         const TempoMap& tempo_map() const { return *_tempo_map; }
 674
 675         unsigned int    get_xrun_count () const {return _xrun_count; }
 676         void            reset_xrun_count () {_xrun_count = 0; }
 677
 678         /* region info  */
 679
 680         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
 681
 682         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 683         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 684         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 685
 686         /* source management */
 687
 688         void import_files (ImportStatus&);
 689         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 690         std::string build_tmp_convert_name (std::string file);
 691
 692         boost::shared_ptr<ExportHandler> get_export_handler ();
 693         boost::shared_ptr<ExportStatus> get_export_status ();
 694
 695         int start_audio_export (framepos_t position);
 696
 697         PBD::Signal1<int, framecnt_t> ProcessExport;
 698         static PBD::Signal2<void,std::string, std::string> Exported;
 699
 700         void add_source (boost::shared_ptr<Source>);
 701         void remove_source (boost::weak_ptr<Source>);
 702
 703         void cleanup_regions();
 704         bool can_cleanup_peakfiles () const;
 705         int  cleanup_peakfiles ();
 706         int  cleanup_sources (CleanupReport&);
 707         int  cleanup_trash_sources (CleanupReport&);
 708
 709         int destroy_sources (std::list<boost::shared_ptr<Source> >);
 710
 711         int remove_last_capture ();
 712
 713         /** handlers should return 0 for "everything OK", and any other value for
 714          * "cannot setup audioengine".
 715          */
 716         static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
 717
 718         /** handlers should return -1 for "stop cleanup",
 719             0 for "yes, delete this playlist",
 720             1 for "no, don't delete this playlist".
 721         */
 722         static PBD::Signal1<int,boost::shared_ptr<Playlist> >  AskAboutPlaylistDeletion;
 723
 724         /** handlers should return 0 for "ignore the rate mismatch",
 725             !0 for "do not use this session"
 726         */
 727         static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
 728
 729         /** handlers should return !0 for use pending state, 0 for ignore it.
 730          */
 731         static PBD::Signal0<int> AskAboutPendingState;
 732
 733         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
 734                 size_t, std::string const &, uint32_t, bool destructive);
 735
 736         boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
 737         boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
 738
 739         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 740         boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
 741         boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
 742         uint32_t count_sources_by_origin (const std::string&);
 743
 744         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 745
 746         /* Curves and AutomationLists (TODO when they go away) */
 747         void add_automation_list(AutomationList*);
 748
 749         /* auditioning */
 750
 751         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 752         void audition_playlist ();
 753         void audition_region (boost::shared_ptr<Region>);
 754         void cancel_audition ();
 755         bool is_auditioning () const;
 756
 757         PBD::Signal1<void,bool> AuditionActive;
 758
 759         /* session script */
 760         void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
 761         void unregister_lua_function (const std::string& name);
 762         std::vector<std::string> registered_lua_functions ();
 763         uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
 764         void scripts_changed (); // called from lua, updates _n_lua_scripts
 765
 766         /* flattening stuff */
 767
 768         boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
 769                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 770                                                    boost::shared_ptr<Processor> endpoint,
 771                                                    bool include_endpoint, bool for_export, bool for_freeze);
 772         int freeze_all (InterThreadInfo&);
 773
 774         /* session-wide solo/mute/rec-enable */
 775
 776         bool soloing() const { return _non_soloed_outs_muted; }
 777         bool listening() const { return _listen_cnt > 0; }
 778         bool solo_isolated() const { return _solo_isolated_cnt > 0; }
 779
 780         static const SessionEvent::RTeventCallback rt_cleanup;
 781
 782         void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 783         void clear_all_solo_state (boost::shared_ptr<RouteList>);
 784         void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
 785         void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 786         void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 787         void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 788         void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 789         void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 790         void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
 791         void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
 792
 793         PBD::Signal1<void,bool> SoloActive;
 794         PBD::Signal0<void> SoloChanged;
 795         PBD::Signal0<void> IsolatedChanged;
 796         PBD::Signal0<void> MonitorChanged;
 797
 798         PBD::Signal0<void> session_routes_reconnected;
 799
 800         /* monitor/master out */
 801
 802         void add_monitor_section ();
 803         void reset_monitor_section ();
 804         void remove_monitor_section ();
 805         bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
 806
 807         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 808         boost::shared_ptr<Route> master_out() const { return _master_out; }
 809
 810         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 811         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 812         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 813         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 814         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 815         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 816         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 817
 818         static void set_disable_all_loaded_plugins (bool yn) {
 819                 _disable_all_loaded_plugins = yn;
 820         }
 821         static bool get_disable_all_loaded_plugins() {
 822                 return _disable_all_loaded_plugins;
 823         }
 824         static void set_bypass_all_loaded_plugins (bool yn) {
 825                 _bypass_all_loaded_plugins = yn;
 826         }
 827         static bool get_bypass_all_loaded_plugins() {
 828                 return _bypass_all_loaded_plugins;
 829         }
 830
 831         uint32_t next_send_id();
 832         uint32_t next_aux_send_id();
 833         uint32_t next_return_id();
 834         uint32_t next_insert_id();
 835         void mark_send_id (uint32_t);
 836         void mark_aux_send_id (uint32_t);
 837         void mark_return_id (uint32_t);
 838         void mark_insert_id (uint32_t);
 839         void unmark_send_id (uint32_t);
 840         void unmark_aux_send_id (uint32_t);
 841         void unmark_return_id (uint32_t);
 842         void unmark_insert_id (uint32_t);
 843
 844         /* s/w "RAID" management */
 845
 846         boost::optional<framecnt_t> available_capture_duration();
 847
 848         /* I/O bundles */
 849
 850         void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
 851         void remove_bundle (boost::shared_ptr<Bundle>);
 852         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 853
 854         PBD::Signal0<void> BundleAddedOrRemoved;
 855
 856         void midi_panic ();
 857
 858         /* History (for editors, mixers, UIs etc.) */
 859
 860         /** Undo some transactions.
 861          * @param n Number of transactions to undo.
 862          */
 863         void undo (uint32_t n) {
 864                 _history.undo (n);
 865         }
 866
 867         void redo (uint32_t n) {
 868                 _history.redo (n);
 869         }
 870
 871         UndoHistory& history() { return _history; }
 872
 873         uint32_t undo_depth() const { return _history.undo_depth(); }
 874         uint32_t redo_depth() const { return _history.redo_depth(); }
 875         std::string next_undo() const { return _history.next_undo(); }
 876         std::string next_redo() const { return _history.next_redo(); }
 877
 878         void begin_reversible_command (const std::string& cmd_name);
 879         void begin_reversible_command (GQuark);
 880         void abort_reversible_command ();
 881         void commit_reversible_command (Command* cmd = 0);
 882
 883         void add_command (Command *const cmd);
 884
 885         PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible>);
 886
 887         /** @return The list of operations that are currently in progress */
 888         std::list<GQuark> const & current_operations () {
 889                 return _current_trans_quarks;
 890         }
 891
 892         bool operation_in_progress (GQuark) const;
 893
 894         void add_commands (std::vector<Command*> const & cmds);
 895
 896         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 897
 898         // these commands are implemented in libs/ardour/session_command.cc
 899         Command* memento_command_factory(XMLNode* n);
 900         Command* stateful_diff_command_factory (XMLNode *);
 901         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
 902
 903         /* clicking */
 904
 905         boost::shared_ptr<IO> click_io() { return _click_io; }
 906         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
 907
 908         /* disk, buffer loads */
 909
 910         uint32_t playback_load ();
 911         uint32_t capture_load ();
 912
 913         /* ranges */
 914
 915         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
 916         void request_cancel_play_range ();
 917         bool get_play_range () const { return _play_range; }
 918
 919         void maybe_update_session_range (framepos_t, framepos_t);
 920
 921         /* temporary hacks to allow selection to be pushed from GUI into backend.
 922            Whenever we move the selection object into libardour, these will go away.
 923          */
 924         void set_range_selection (framepos_t start, framepos_t end);
 925         void set_object_selection (framepos_t start, framepos_t end);
 926         void clear_range_selection ();
 927         void clear_object_selection ();
 928
 929         /* buffers for gain and pan */
 930
 931         gain_t* gain_automation_buffer () const;
 932         gain_t* trim_automation_buffer () const;
 933         gain_t* send_gain_automation_buffer () const;
 934         pan_t** pan_automation_buffer () const;
 935
 936         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
 937
 938         /* VST support */
 939
 940         static int  vst_current_loading_id;
 941         static const char* vst_can_do_strings[];
 942         static const int vst_can_do_string_count;
 943
 944         static intptr_t vst_callback (
 945                 AEffect* effect,
 946                 int32_t opcode,
 947                 int32_t index,
 948                 intptr_t value,
 949                 void* ptr,
 950                 float opt
 951                 );
 952
 953         static PBD::Signal0<void> SendFeedback;
 954
 955         /* Speakers */
 956
 957         boost::shared_ptr<Speakers> get_speakers ();
 958
 959         /* Controllables */
 960
 961         boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
 962
 963         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
 964         boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
 965
 966         void add_controllable (boost::shared_ptr<PBD::Controllable>);
 967         void remove_controllable (PBD::Controllable*);
 968
 969         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
 970
 971         SessionConfiguration config;
 972
 973         bool exporting () const {
 974                 return _exporting;
 975         }
 976
 977         bool bounce_processing() const {
 978                 return _bounce_processing_active;
 979         }
 980
 981         /* this is a private enum, but setup_enum_writer() needs it,
 982            and i can't find a way to give that function
 983            friend access. sigh.
 984         */
 985
 986         enum PostTransportWork {
 987                 PostTransportStop               = 0x1,
 988                 PostTransportDuration           = 0x2,
 989                 PostTransportLocate             = 0x4,
 990                 PostTransportRoll               = 0x8,
 991                 PostTransportAbort              = 0x10,
 992                 PostTransportOverWrite          = 0x20,
 993                 PostTransportSpeed              = 0x40,
 994                 PostTransportAudition           = 0x80,
 995                 PostTransportReverse            = 0x100,
 996                 PostTransportInputChange        = 0x200,
 997                 PostTransportCurveRealloc       = 0x400,
 998                 PostTransportClearSubstate      = 0x800,
 999                 PostTransportAdjustPlaybackBuffering  = 0x1000,
1000                 PostTransportAdjustCaptureBuffering   = 0x2000
1001         };
1002
1003         enum SlaveState {
1004                 Stopped,
1005                 Waiting,
1006                 Running
1007         };
1008
1009         SlaveState slave_state() const { return _slave_state; }
1010         Slave* slave() const { return _slave; }
1011
1012         boost::shared_ptr<SessionPlaylists> playlists;
1013
1014         void send_mmc_locate (framepos_t);
1015         void queue_full_time_code () { _send_timecode_update = true; }
1016         void queue_song_position_pointer () { /* currently does nothing */ }
1017
1018         bool step_editing() const { return (_step_editors > 0); }
1019
1020         void request_suspend_timecode_transmission ();
1021         void request_resume_timecode_transmission ();
1022         bool timecode_transmission_suspended () const;
1023
1024         std::vector<std::string> source_search_path(DataType) const;
1025         void ensure_search_path_includes (const std::string& path, DataType type);
1026         void remove_dir_from_search_path (const std::string& path, DataType type);
1027
1028         std::list<std::string> unknown_processors () const;
1029
1030         /** Emitted when a feedback cycle has been detected within Ardour's signal
1031             processing path.  Until it is fixed (by the user) some (unspecified)
1032             routes will not be run.
1033         */
1034         static PBD::Signal0<void> FeedbackDetected;
1035
1036         /** Emitted when a graph sort has successfully completed, which means
1037             that it has no feedback cycles.
1038         */
1039         static PBD::Signal0<void> SuccessfulGraphSort;
1040
1041         /* handlers can return an integer value:
1042            0: config.set_audio_search_path() or config.set_midi_search_path() was used
1043            to modify the search path and we should try to find it again.
1044            1: quit entire session load
1045            2: as 0, but don't ask about other missing files
1046            3: don't ask about other missing files, and just mark this one missing
1047            -1: just mark this one missing
1048            any other value: as -1
1049         */
1050         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1051
1052         /** Emitted when the session wants Ardour to quit */
1053         static PBD::Signal0<void> Quit;
1054
1055         /** Emitted when Ardour is asked to load a session in an older session
1056          * format, and makes a backup copy.
1057          */
1058         static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1059
1060         SceneChanger* scene_changer() const { return _scene_changer; }
1061
1062         /* asynchronous MIDI control ports */
1063
1064         boost::shared_ptr<Port> midi_input_port () const;
1065         boost::shared_ptr<Port> midi_output_port () const;
1066         boost::shared_ptr<Port> mmc_output_port () const;
1067         boost::shared_ptr<Port> mmc_input_port () const;
1068         boost::shared_ptr<Port> scene_input_port () const;
1069         boost::shared_ptr<Port> scene_output_port () const;
1070
1071         /* synchronous MIDI ports used for synchronization */
1072
1073         boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1074         boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1075         boost::shared_ptr<MidiPort> mtc_output_port () const;
1076         boost::shared_ptr<MidiPort> mtc_input_port () const;
1077         boost::shared_ptr<Port> ltc_input_port() const;
1078         boost::shared_ptr<Port> ltc_output_port() const;
1079
1080         boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1081         boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1082
1083         MIDI::MachineControl& mmc() { return *_mmc; }
1084
1085         void reconnect_midi_scene_ports (bool);
1086         void reconnect_mtc_ports ();
1087         void reconnect_mmc_ports (bool);
1088
1089         void reconnect_ltc_input ();
1090         void reconnect_ltc_output ();
1091
1092   protected:
1093         friend class AudioEngine;
1094         void set_block_size (pframes_t nframes);
1095         void set_frame_rate (framecnt_t nframes);
1096         void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1097
1098   protected:
1099         friend class Route;
1100         void schedule_curve_reallocation ();
1101         void update_latency_compensation (bool force = false);
1102
1103   private:
1104         int  create (const std::string& mix_template, BusProfile*);
1105         void destroy ();
1106
1107         static guint _name_id_counter;
1108         static void init_name_id_counter (guint n);
1109         static unsigned int name_id_counter ();
1110
1111         enum SubState {
1112                 PendingDeclickIn      = 0x1,  ///< pending de-click fade-in for start
1113                 PendingDeclickOut     = 0x2,  ///< pending de-click fade-out for stop
1114                 StopPendingCapture    = 0x4,
1115                 PendingLoopDeclickIn  = 0x8,  ///< pending de-click fade-in at the start of a loop
1116                 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1117                 PendingLocate         = 0x20,
1118         };
1119
1120         /* stuff used in process() should be close together to
1121            maximise cache hits
1122         */
1123
1124         typedef void (Session::*process_function_type)(pframes_t);
1125
1126         AudioEngine&            _engine;
1127         mutable gint             processing_prohibited;
1128         process_function_type    process_function;
1129         process_function_type    last_process_function;
1130         bool                    _bounce_processing_active;
1131         bool                     waiting_for_sync_offset;
1132         framecnt_t              _base_frame_rate;
1133         framecnt_t              _current_frame_rate;  //this includes video pullup offset
1134         framecnt_t              _nominal_frame_rate;  //ignores audioengine setting, "native" SR
1135         int                      transport_sub_state;
1136         mutable gint            _record_status;
1137         framepos_t              _transport_frame;
1138         Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1139         Slave*                  _slave;
1140         bool                    _silent;
1141
1142         // varispeed playback
1143         double                  _transport_speed;
1144         double                  _default_transport_speed;
1145         double                  _last_transport_speed;
1146         double                  _signalled_varispeed;
1147         double                  _target_transport_speed;
1148         CubicInterpolation       interpolation;
1149
1150         bool                     auto_play_legal;
1151         framepos_t              _last_slave_transport_frame;
1152         framecnt_t               maximum_output_latency;
1153         framepos_t              _requested_return_frame;
1154         pframes_t                current_block_size;
1155         framecnt_t              _worst_output_latency;
1156         framecnt_t              _worst_input_latency;
1157         framecnt_t              _worst_track_latency;
1158         bool                    _have_captured;
1159         bool                    _non_soloed_outs_muted;
1160         bool                    _listening;
1161         uint32_t                _listen_cnt;
1162         uint32_t                _solo_isolated_cnt;
1163         bool                    _writable;
1164         bool                    _was_seamless;
1165         bool                    _under_nsm_control;
1166         unsigned int            _xrun_count;
1167
1168         void mtc_status_changed (bool);
1169         PBD::ScopedConnection mtc_status_connection;
1170         void ltc_status_changed (bool);
1171         PBD::ScopedConnection ltc_status_connection;
1172
1173         void initialize_latencies ();
1174         void set_worst_io_latencies ();
1175         void set_worst_playback_latency ();
1176         void set_worst_capture_latency ();
1177         void set_worst_io_latencies_x (IOChange, void *) {
1178                 set_worst_io_latencies ();
1179         }
1180         void post_capture_latency ();
1181         void post_playback_latency ();
1182
1183         void update_latency_compensation_proxy (void* ignored);
1184
1185         void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1186
1187         void process_scrub          (pframes_t);
1188         void process_without_events (pframes_t);
1189         void process_with_events    (pframes_t);
1190         void process_audition       (pframes_t);
1191         int  process_export         (pframes_t);
1192         int  process_export_fw      (pframes_t);
1193
1194         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1195         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1196         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1197
1198         static const framecnt_t bounce_chunk_size;
1199
1200         /* slave tracking */
1201
1202         static const int delta_accumulator_size = 25;
1203         int delta_accumulator_cnt;
1204         int32_t delta_accumulator[delta_accumulator_size];
1205         int32_t average_slave_delta;
1206         int  average_dir;
1207         bool have_first_delta_accumulator;
1208
1209         SlaveState _slave_state;
1210         gint _mtc_active;
1211         gint _ltc_active;
1212         framepos_t slave_wait_end;
1213
1214         void reset_slave_state ();
1215         bool follow_slave (pframes_t);
1216         void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1217         void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1218         void follow_slave_silently (pframes_t nframes, float slave_speed);
1219
1220         void switch_to_sync_source (SyncSource); /* !RT context */
1221         void drop_sync_source ();  /* !RT context */
1222         void use_sync_source (Slave*); /* RT context */
1223
1224         bool post_export_sync;
1225         framepos_t post_export_position;
1226
1227         bool _exporting;
1228         bool _export_rolling;
1229         framepos_t _export_preroll;
1230
1231         boost::shared_ptr<ExportHandler> export_handler;
1232         boost::shared_ptr<ExportStatus>  export_status;
1233
1234         int  pre_export ();
1235         int  stop_audio_export ();
1236         void finalize_audio_export ();
1237         void finalize_export_internal (bool stop_freewheel);
1238         bool _pre_export_mmc_enabled;
1239
1240         PBD::ScopedConnection export_freewheel_connection;
1241
1242         void get_track_statistics ();
1243         int  process_routes (pframes_t, bool& need_butler);
1244         int  silent_process_routes (pframes_t, bool& need_butler);
1245
1246         /** @return 1 if there is a pending declick fade-in,
1247             -1 if there is a pending declick fade-out,
1248             0 if there is no pending declick.
1249         */
1250         int get_transport_declick_required () {
1251                 if (transport_sub_state & PendingDeclickIn) {
1252                         transport_sub_state &= ~PendingDeclickIn;
1253                         return 1;
1254                 } else if (transport_sub_state & PendingDeclickOut) {
1255                         /* XXX: not entirely sure why we don't clear this */
1256                         return -1;
1257                 } else if (transport_sub_state & PendingLoopDeclickOut) {
1258                         /* Return the declick out first ... */
1259                         transport_sub_state &= ~PendingLoopDeclickOut;
1260                         return -1;
1261                 } else if (transport_sub_state & PendingLoopDeclickIn) {
1262                         /* ... then the declick in on the next call */
1263                         transport_sub_state &= ~PendingLoopDeclickIn;
1264                         return 1;
1265                 } else {
1266                         return 0;
1267                 }
1268         }
1269
1270         bool maybe_stop (framepos_t limit);
1271         bool maybe_sync_start (pframes_t &);
1272
1273         void check_declick_out ();
1274
1275         std::string             _path;
1276         std::string             _name;
1277         bool                    _is_new;
1278         bool                    _send_qf_mtc;
1279         /** Number of process frames since the last MTC output (when sending MTC); used to
1280          *  know when to send full MTC messages every so often.
1281          */
1282         pframes_t               _pframes_since_last_mtc;
1283         bool                     session_midi_feedback;
1284         bool                     play_loop;
1285         bool                     loop_changing;
1286         framepos_t               last_loopend;
1287
1288         boost::scoped_ptr<SessionDirectory> _session_dir;
1289
1290         void hookup_io ();
1291         void graph_reordered ();
1292
1293         /** current snapshot name, without the .ardour suffix */
1294         void set_snapshot_name (const std::string &);
1295         void save_snapshot_name (const std::string &);
1296         std::string _current_snapshot_name;
1297
1298         XMLTree*         state_tree;
1299         bool             state_was_pending;
1300         StateOfTheState _state_of_the_state;
1301
1302         friend class    StateProtector;
1303         gint            _suspend_save; /* atomic */
1304         volatile bool   _save_queued;
1305         Glib::Threads::Mutex save_state_lock;
1306         Glib::Threads::Mutex peak_cleanup_lock;
1307
1308         int      load_options (const XMLNode&);
1309         int      load_state (std::string snapshot_name);
1310
1311         framepos_t _last_roll_location;
1312         /** the session frame time at which we last rolled, located, or changed transport direction */
1313         framepos_t _last_roll_or_reversal_location;
1314         framepos_t _last_record_location;
1315
1316         bool              pending_locate_roll;
1317         framepos_t        pending_locate_frame;
1318         bool              pending_locate_flush;
1319         bool              pending_abort;
1320         bool              pending_auto_loop;
1321
1322         PBD::ReallocPool _mempool;
1323         LuaState lua;
1324         Glib::Threads::Mutex lua_lock;
1325         luabridge::LuaRef * _lua_run;
1326         luabridge::LuaRef * _lua_add;
1327         luabridge::LuaRef * _lua_del;
1328         luabridge::LuaRef * _lua_list;
1329         luabridge::LuaRef * _lua_load;
1330         luabridge::LuaRef * _lua_save;
1331         luabridge::LuaRef * _lua_cleanup;
1332         uint32_t            _n_lua_scripts;
1333
1334         void setup_lua ();
1335         void try_run_lua (pframes_t);
1336
1337         Butler* _butler;
1338
1339         static const PostTransportWork ProcessCannotProceedMask =
1340                 PostTransportWork (
1341                         PostTransportInputChange|
1342                         PostTransportSpeed|
1343                         PostTransportReverse|
1344                         PostTransportCurveRealloc|
1345                         PostTransportAudition|
1346                         PostTransportLocate|
1347                         PostTransportStop|
1348                         PostTransportClearSubstate);
1349
1350         gint _post_transport_work; /* accessed only atomic ops */
1351         PostTransportWork post_transport_work() const        { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1352         void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1353         void add_post_transport_work (PostTransportWork ptw);
1354
1355         void schedule_playback_buffering_adjustment ();
1356         void schedule_capture_buffering_adjustment ();
1357
1358         uint32_t    cumulative_rf_motion;
1359         uint32_t    rf_scale;
1360
1361         void set_rf_speed (float speed);
1362         void reset_rf_scale (framecnt_t frames_moved);
1363
1364         Locations*       _locations;
1365         void location_added (Location*);
1366         void location_removed (Location*);
1367         void locations_changed ();
1368         void _locations_changed (const Locations::LocationList&);
1369
1370         void update_skips (Location*, bool consolidate);
1371         void update_marks (Location* loc);
1372         void consolidate_skips (Location*);
1373         void sync_locations_to_skips ();
1374         void _sync_locations_to_skips ();
1375
1376         PBD::ScopedConnectionList skip_update_connections;
1377         bool _ignore_skips_updates;
1378
1379         PBD::ScopedConnectionList punch_connections;
1380         void             auto_punch_start_changed (Location *);
1381         void             auto_punch_end_changed (Location *);
1382         void             auto_punch_changed (Location *);
1383
1384         PBD::ScopedConnectionList loop_connections;
1385         void             auto_loop_changed (Location *);
1386         void             auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1387
1388         int  ensure_engine (uint32_t desired_sample_rate);
1389         void pre_engine_init (std::string path);
1390         int  post_engine_init ();
1391         int  immediately_post_engine ();
1392         void remove_empty_sounds ();
1393
1394         void session_loaded ();
1395
1396         void setup_midi_control ();
1397         int  midi_read (MIDI::Port *);
1398
1399         void enable_record ();
1400
1401         void increment_transport_position (framecnt_t val) {
1402                 if (max_framepos - val < _transport_frame) {
1403                         _transport_frame = max_framepos;
1404                 } else {
1405                         _transport_frame += val;
1406                 }
1407         }
1408
1409         void decrement_transport_position (framecnt_t val) {
1410                 if (val < _transport_frame) {
1411                         _transport_frame -= val;
1412                 } else {
1413                         _transport_frame = 0;
1414                 }
1415         }
1416
1417         void post_transport_motion ();
1418         static void *session_loader_thread (void *arg);
1419
1420         void *do_work();
1421
1422         /* Signal Forwarding */
1423         void emit_route_signals ();
1424         void emit_thread_run ();
1425         static void *emit_thread (void *);
1426         void emit_thread_start ();
1427         void emit_thread_terminate ();
1428
1429         pthread_t       _rt_emit_thread;
1430         bool            _rt_thread_active;
1431
1432         pthread_mutex_t _rt_emit_mutex;
1433         pthread_cond_t  _rt_emit_cond;
1434         bool            _rt_emit_pending;
1435
1436
1437         /* SessionEventManager interface */
1438
1439         void process_event (SessionEvent*);
1440         void set_next_event ();
1441         void cleanup_event (SessionEvent*,int);
1442
1443         /* MIDI Machine Control */
1444
1445         void spp_start ();
1446         void spp_continue ();
1447         void spp_stop ();
1448
1449         void mmc_deferred_play (MIDI::MachineControl &);
1450         void mmc_stop (MIDI::MachineControl &);
1451         void mmc_step (MIDI::MachineControl &, int);
1452         void mmc_pause (MIDI::MachineControl &);
1453         void mmc_record_pause (MIDI::MachineControl &);
1454         void mmc_record_strobe (MIDI::MachineControl &);
1455         void mmc_record_exit (MIDI::MachineControl &);
1456         void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1457         void mmc_fast_forward (MIDI::MachineControl &);
1458         void mmc_rewind (MIDI::MachineControl &);
1459         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1460         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1461         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1462
1463         struct timeval last_mmc_step;
1464         double step_speed;
1465
1466         typedef boost::function<bool()> MidiTimeoutCallback;
1467         typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1468
1469         MidiTimeoutList midi_timeouts;
1470         bool mmc_step_timeout ();
1471         void send_immediate_mmc (MIDI::MachineControlCommand);
1472
1473         MIDI::byte mtc_msg[16];
1474         MIDI::byte mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
1475         MIDI::byte midi_msg[16];
1476         double outbound_mtc_timecode_frame;
1477         Timecode::Time transmitting_timecode_time;
1478         int next_quarter_frame_to_send;
1479
1480         double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1481         framecnt_t _frames_per_hour;
1482         framecnt_t _timecode_frames_per_hour;
1483
1484         /* cache the most-recently requested time conversions. This helps when we
1485          * have multiple clocks showing the same time (e.g. the transport frame) */
1486         bool last_timecode_valid;
1487         framepos_t last_timecode_when;
1488         Timecode::Time last_timecode;
1489
1490         bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1491
1492         int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1493
1494         LTCEncoder*       ltc_encoder;
1495         ltcsnd_sample_t*  ltc_enc_buf;
1496
1497         Timecode::TimecodeFormat ltc_enc_tcformat;
1498         int32_t           ltc_buf_off;
1499         int32_t           ltc_buf_len;
1500
1501         double            ltc_speed;
1502         int32_t           ltc_enc_byte;
1503         framepos_t        ltc_enc_pos;
1504         double            ltc_enc_cnt;
1505         framepos_t        ltc_enc_off;
1506         bool              restarting;
1507         framepos_t        ltc_prev_cycle;
1508
1509         framepos_t        ltc_timecode_offset;
1510         bool              ltc_timecode_negative_offset;
1511
1512         LatencyRange      ltc_out_latency;
1513
1514         void ltc_tx_initialize();
1515         void ltc_tx_cleanup();
1516         void ltc_tx_reset();
1517         void ltc_tx_resync_latency();
1518         void ltc_tx_recalculate_position();
1519         void ltc_tx_parse_offset();
1520         void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1521
1522         void reset_record_status ();
1523
1524         int no_roll (pframes_t nframes);
1525         int fail_roll (pframes_t nframes);
1526
1527         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1528         bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1529
1530         MidiControlUI* midi_control_ui;
1531
1532         int           start_midi_thread ();
1533
1534         void set_play_loop (bool yn, double speed);
1535         void unset_play_loop ();
1536         void overwrite_some_buffers (Track *);
1537         void flush_all_inserts ();
1538         int  micro_locate (framecnt_t distance);
1539         void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1540         void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1541         void force_locate (framepos_t frame, bool with_roll = false);
1542         void set_track_speed (Track *, double speed);
1543         void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1544         void stop_transport (bool abort = false, bool clear_state = false);
1545         void start_transport ();
1546         void realtime_stop (bool abort, bool clear_state);
1547         void realtime_locate ();
1548         void non_realtime_start_scrub ();
1549         void non_realtime_set_speed ();
1550         void non_realtime_locate ();
1551         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1552         void non_realtime_overwrite (int entry_request_count, bool& finished);
1553         void post_transport ();
1554         void engine_halted ();
1555         void xrun_recovery ();
1556         void set_track_loop (bool);
1557         bool select_playhead_priority_target (framepos_t&);
1558         void follow_playhead_priority ();
1559
1560         /* These are synchronous and so can only be called from within the process
1561          * cycle
1562          */
1563
1564         int  send_full_time_code (framepos_t, pframes_t nframes);
1565         void send_song_position_pointer (framepos_t);
1566
1567         TempoMap    *_tempo_map;
1568         void          tempo_map_changed (const PBD::PropertyChange&);
1569
1570         /* edit/mix groups */
1571
1572         int load_route_groups (const XMLNode&, int);
1573
1574         std::list<RouteGroup *> _route_groups;
1575         RouteGroup*             _all_route_group;
1576
1577         /* routes stuff */
1578
1579         boost::shared_ptr<Graph> _process_graph;
1580
1581         SerializedRCUManager<RouteList>  routes;
1582
1583         void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1584         void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1585         bool _adding_routes_in_progress;
1586         bool _reconnecting_routes_in_progress;
1587         bool _route_deletion_in_progress;
1588
1589         uint32_t destructive_index;
1590
1591         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1592         boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1593
1594         void route_processors_changed (RouteProcessorChange);
1595
1596         bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1597         void count_existing_track_channels (ChanCount& in, ChanCount& out);
1598         void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1599                                  bool with_lock, bool connect_inputs = true,
1600                                  ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1601         void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1602
1603         /* track numbering */
1604
1605         void reassign_track_numbers ();
1606         uint32_t _track_number_decimals;
1607
1608         /* mixer stuff */
1609
1610         void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1611         void route_mute_changed ();
1612         void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1613         void route_solo_isolated_changed (boost::weak_ptr<Route>);
1614         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1615
1616         void listen_position_changed ();
1617         void solo_control_mode_changed ();
1618
1619         /* REGION MANAGEMENT */
1620
1621         mutable Glib::Threads::Mutex region_lock;
1622
1623         int load_regions (const XMLNode& node);
1624         int load_compounds (const XMLNode& node);
1625
1626         void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1627         void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1628         void route_group_property_changed (RouteGroup *);
1629
1630         /* SOURCES */
1631
1632         mutable Glib::Threads::Mutex source_lock;
1633
1634   public:
1635         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1636
1637   private:
1638         void reset_write_sources (bool mark_write_complete, bool force = false);
1639         SourceMap sources;
1640
1641
1642   private:
1643         int load_sources (const XMLNode& node);
1644         XMLNode& get_sources_as_xml ();
1645
1646         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1647
1648         /* PLAYLISTS */
1649
1650         void remove_playlist (boost::weak_ptr<Playlist>);
1651         void track_playlist_changed (boost::weak_ptr<Track>);
1652         void playlist_region_added (boost::weak_ptr<Region>);
1653         void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1654         void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1655
1656         /* CURVES and AUTOMATION LISTS */
1657         std::map<PBD::ID, AutomationList*> automation_lists;
1658
1659         /* DEFAULT FADE CURVES */
1660
1661         float default_fade_steepness;
1662         float default_fade_msecs;
1663
1664         /* AUDITIONING */
1665
1666         boost::shared_ptr<Auditioner> auditioner;
1667         void set_audition (boost::shared_ptr<Region>);
1668         void non_realtime_set_audition ();
1669         boost::shared_ptr<Region> pending_audition_region;
1670
1671         /* EXPORT */
1672
1673         /* FLATTEN */
1674
1675         int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1676
1677         /* INSERT AND SEND MANAGEMENT */
1678
1679         boost::dynamic_bitset<uint32_t> send_bitset;
1680         boost::dynamic_bitset<uint32_t> aux_send_bitset;
1681         boost::dynamic_bitset<uint32_t> return_bitset;
1682         boost::dynamic_bitset<uint32_t> insert_bitset;
1683
1684         /* S/W RAID */
1685
1686         struct space_and_path {
1687                 uint32_t blocks;     ///< 4kB blocks
1688                 bool blocks_unknown; ///< true if blocks is unknown
1689                 std::string path;
1690
1691                 space_and_path ()
1692                         : blocks (0)
1693                         , blocks_unknown (true)
1694                 {}
1695         };
1696
1697         struct space_and_path_ascending_cmp {
1698                 bool operator() (space_and_path a, space_and_path b) {
1699                         if (a.blocks_unknown != b.blocks_unknown) {
1700                                 return !a.blocks_unknown;
1701                         }
1702                         return a.blocks > b.blocks;
1703                 }
1704         };
1705
1706         void setup_raid_path (std::string path);
1707
1708         std::vector<space_and_path> session_dirs;
1709         std::vector<space_and_path>::iterator last_rr_session_dir;
1710         uint32_t _total_free_4k_blocks;
1711         /** If this is true, _total_free_4k_blocks is not definite,
1712             as one or more of the session directories' filesystems
1713             could not report free space.
1714         */
1715         bool _total_free_4k_blocks_uncertain;
1716         Glib::Threads::Mutex space_lock;
1717
1718         bool no_questions_about_missing_files;
1719
1720         std::string get_best_session_directory_for_new_audio ();
1721
1722         mutable gint _playback_load;
1723         mutable gint _capture_load;
1724
1725         /* I/O bundles */
1726
1727         SerializedRCUManager<BundleList> _bundles;
1728         XMLNode* _bundle_xml_node;
1729         int load_bundles (XMLNode const &);
1730
1731         UndoHistory      _history;
1732         /** current undo transaction, or 0 */
1733         UndoTransaction* _current_trans;
1734         /** GQuarks to describe the reversible commands that are currently in progress.
1735          *  These may be nested, in which case more recently-started commands are toward
1736          *  the front of the list.
1737          */
1738         std::list<GQuark> _current_trans_quarks;
1739
1740         int  backend_sync_callback (TransportState, framepos_t);
1741
1742         void process_rtop (SessionEvent*);
1743
1744         void  update_latency (bool playback);
1745
1746         XMLNode& state(bool);
1747
1748         /* click track */
1749         typedef std::list<Click*> Clicks;
1750         Clicks                  clicks;
1751         bool                   _clicking;
1752         boost::shared_ptr<IO>  _click_io;
1753         boost::shared_ptr<Amp> _click_gain;
1754         Sample*                 click_data;
1755         Sample*                 click_emphasis_data;
1756         framecnt_t              click_length;
1757         framecnt_t              click_emphasis_length;
1758         mutable Glib::Threads::RWLock    click_lock;
1759
1760         static const Sample     default_click[];
1761         static const framecnt_t default_click_length;
1762         static const Sample     default_click_emphasis[];
1763         static const framecnt_t default_click_emphasis_length;
1764
1765         Click *get_click();
1766         framepos_t _clicks_cleared;
1767         void   setup_click_sounds (int which);
1768         void   setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1769         void   clear_clicks ();
1770         void   click (framepos_t start, framecnt_t nframes);
1771
1772         std::vector<Route*> master_outs;
1773
1774         /* range playback */
1775
1776         std::list<AudioRange> current_audio_range;
1777         bool _play_range;
1778         void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1779         void unset_play_range ();
1780
1781         /* temporary hacks to allow selection to be pushed from GUI into backend
1782            Whenever we move the selection object into libardour, these will go away.
1783         */
1784         Evoral::Range<framepos_t> _range_selection;
1785         Evoral::Range<framepos_t> _object_selection;
1786
1787         /* main outs */
1788         uint32_t main_outs;
1789
1790         boost::shared_ptr<Route> _master_out;
1791         boost::shared_ptr<Route> _monitor_out;
1792
1793         void auto_connect_master_bus ();
1794
1795         /* Windows VST support */
1796
1797         long _windows_vst_callback (
1798                 WindowsVSTPlugin*,
1799                 long opcode,
1800                 long index,
1801                 long value,
1802                 void* ptr,
1803                 float opt
1804                 );
1805
1806         int find_all_sources (std::string path, std::set<std::string>& result);
1807         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1808
1809         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1810         Glib::Threads::Mutex controllables_lock;
1811         Controllables controllables;
1812
1813         boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1814
1815         void reset_native_file_format();
1816         bool first_file_data_format_reset;
1817         bool first_file_header_format_reset;
1818
1819         void config_changed (std::string, bool);
1820
1821         XMLNode& get_control_protocol_state ();
1822
1823         void set_history_depth (uint32_t depth);
1824
1825         static bool _disable_all_loaded_plugins;
1826         static bool _bypass_all_loaded_plugins;
1827
1828         mutable bool have_looped; ///< Used in ::audible_frame(*)
1829
1830         void update_route_record_state ();
1831         gint _have_rec_enabled_track;
1832         gint _have_rec_disabled_track;
1833
1834         static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1835
1836         /* realtime "apply to set of routes" operations */
1837         template<typename T> SessionEvent*
1838                 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1839                               void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1840                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1841                 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1842                 ev->rt_return = after;
1843                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1844
1845                 return ev;
1846         }
1847
1848         void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1849         void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1850         void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition  /* ignored*/ );
1851         void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1852         void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1853         void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1854         void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1855         void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1856         void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, PBD::Controllable::GroupControlDisposition group_override);
1857
1858         /** temporary list of Diskstreams used only during load of 2.X sessions */
1859         std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1860
1861         void set_session_range_location (framepos_t, framepos_t);
1862
1863         void setup_midi_machine_control ();
1864
1865         void step_edit_status_change (bool);
1866         uint32_t _step_editors;
1867
1868         /** true if timecode transmission by the transport is suspended, otherwise false */
1869         mutable gint _suspend_timecode_transmission;
1870
1871         void update_locations_after_tempo_map_change (const Locations::LocationList &);
1872
1873         void start_time_changed (framepos_t);
1874         void end_time_changed (framepos_t);
1875
1876         void set_track_monitor_input_status (bool);
1877         framepos_t compute_stop_limit () const;
1878
1879         boost::shared_ptr<Speakers> _speakers;
1880         void load_nested_sources (const XMLNode& node);
1881
1882         /** The directed graph of routes that is currently being used for audio processing
1883             and solo/mute computations.
1884         */
1885         GraphEdges _current_route_graph;
1886
1887         uint32_t next_control_id () const;
1888         int32_t _order_hint;
1889         bool ignore_route_processor_changes;
1890
1891         MidiClockTicker* midi_clock;
1892
1893         boost::shared_ptr<IO>   _ltc_input;
1894         boost::shared_ptr<IO>   _ltc_output;
1895
1896         /* Scene Changing */
1897         SceneChanger* _scene_changer;
1898
1899         /* persistent, non-track related MIDI ports */
1900         MidiPortManager* _midi_ports;
1901         MIDI::MachineControl* _mmc;
1902
1903         void setup_ltc ();
1904         void setup_click ();
1905         void setup_click_state (const XMLNode*);
1906         void setup_bundles ();
1907
1908         void save_as_bring_callback (uint32_t, uint32_t, std::string);
1909
1910         static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1911         static const uint32_t session_end_shift;
1912
1913         std::string _template_state_dir;
1914 };
1915
1916
1917 } // namespace ARDOUR
1918
1919 #endif /* __ardour_session_h__ */