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