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