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