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