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         const TempoMap& tempo_map() const { return *_tempo_map; }
 552
 553         /* region info  */
 554
 555         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
 556
 557         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 558         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 559         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 560
 561         /* source management */
 562
 563         void import_files (ImportStatus&);
 564         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 565         std::string build_tmp_convert_name (std::string file);
 566
 567         boost::shared_ptr<ExportHandler> get_export_handler ();
 568         boost::shared_ptr<ExportStatus> get_export_status ();
 569
 570         int start_audio_export (framepos_t position);
 571
 572         PBD::Signal1<int, framecnt_t> ProcessExport;
 573         static PBD::Signal2<void,std::string, std::string> Exported;
 574
 575         void add_source (boost::shared_ptr<Source>);
 576         void remove_source (boost::weak_ptr<Source>);
 577
 578         void  cleanup_regions();
 579         int  cleanup_sources (CleanupReport&);
 580         int  cleanup_trash_sources (CleanupReport&);
 581
 582         int destroy_sources (std::list<boost::shared_ptr<Source> >);
 583
 584         int remove_last_capture ();
 585
 586         /** handlers should return 0 for "everything OK", and any other value for
 587          * "cannot setup audioengine".
 588          */
 589         static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
 590
 591         /** handlers should return -1 for "stop cleanup",
 592             0 for "yes, delete this playlist",
 593             1 for "no, don't delete this playlist".
 594         */
 595         static PBD::Signal1<int,boost::shared_ptr<Playlist> >  AskAboutPlaylistDeletion;
 596
 597         /** handlers should return 0 for "ignore the rate mismatch",
 598             !0 for "do not use this session"
 599         */
 600         static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
 601
 602         /** handlers should return !0 for use pending state, 0 for ignore it.
 603         */
 604         static PBD::Signal0<int> AskAboutPendingState;
 605
 606         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
 607                 size_t, std::string const &, uint32_t, bool destructive);
 608
 609         boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
 610         boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
 611
 612         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 613         boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
 614         boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
 615         uint32_t count_sources_by_origin (const std::string&);
 616
 617         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 618
 619         /* Curves and AutomationLists (TODO when they go away) */
 620         void add_automation_list(AutomationList*);
 621
 622         /* auditioning */
 623
 624         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 625         void audition_playlist ();
 626         void audition_region (boost::shared_ptr<Region>);
 627         void cancel_audition ();
 628         bool is_auditioning () const;
 629
 630         PBD::Signal1<void,bool> AuditionActive;
 631
 632         /* flattening stuff */
 633
 634         boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
 635                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 636                                                    boost::shared_ptr<Processor> endpoint,
 637                                                          bool include_endpoint, bool for_export, bool for_freeze);
 638         int freeze_all (InterThreadInfo&);
 639
 640         /* session-wide solo/mute/rec-enable */
 641
 642         bool soloing() const { return _non_soloed_outs_muted; }
 643         bool listening() const { return _listen_cnt > 0; }
 644         bool solo_isolated() const { return _solo_isolated_cnt > 0; }
 645
 646         static const SessionEvent::RTeventCallback rt_cleanup;
 647
 648         void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 649         void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
 650         void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
 651         void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 652         void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 653         void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 654         void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 655         void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
 656         void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
 657
 658         PBD::Signal1<void,bool> SoloActive;
 659         PBD::Signal0<void> SoloChanged;
 660         PBD::Signal0<void> IsolatedChanged;
 661
 662         /* monitor/master out */
 663
 664         void add_monitor_section ();
 665         void remove_monitor_section ();
 666
 667         boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
 668         boost::shared_ptr<Route> master_out() const { return _master_out; }
 669
 670         void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
 671         void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
 672         void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
 673         void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
 674         void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
 675         void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
 676         void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
 677
 678         static void set_disable_all_loaded_plugins (bool yn) {
 679                 _disable_all_loaded_plugins = yn;
 680         }
 681         static bool get_disable_all_loaded_plugins() {
 682                 return _disable_all_loaded_plugins;
 683         }
 684
 685         uint32_t next_send_id();
 686         uint32_t next_aux_send_id();
 687         uint32_t next_return_id();
 688         uint32_t next_insert_id();
 689         void mark_send_id (uint32_t);
 690         void mark_aux_send_id (uint32_t);
 691         void mark_return_id (uint32_t);
 692         void mark_insert_id (uint32_t);
 693         void unmark_send_id (uint32_t);
 694         void unmark_aux_send_id (uint32_t);
 695         void unmark_return_id (uint32_t);
 696         void unmark_insert_id (uint32_t);
 697
 698         /* s/w "RAID" management */
 699
 700         boost::optional<framecnt_t> available_capture_duration();
 701
 702         /* I/O bundles */
 703
 704         void add_bundle (boost::shared_ptr<Bundle>);
 705         void remove_bundle (boost::shared_ptr<Bundle>);
 706         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 707
 708         PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
 709         PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
 710
 711         void midi_panic ();
 712
 713         /* History (for editors, mixers, UIs etc.) */
 714
 715         /** Undo some transactions.
 716          * @param n Number of transactions to undo.
 717          */
 718         void undo (uint32_t n) {
 719                 _history.undo (n);
 720         }
 721
 722         void redo (uint32_t n) {
 723                 _history.redo (n);
 724         }
 725
 726         UndoHistory& history() { return _history; }
 727
 728         uint32_t undo_depth() const { return _history.undo_depth(); }
 729         uint32_t redo_depth() const { return _history.redo_depth(); }
 730         std::string next_undo() const { return _history.next_undo(); }
 731         std::string next_redo() const { return _history.next_redo(); }
 732
 733         void begin_reversible_command (const std::string& cmd_name);
 734         void begin_reversible_command (GQuark);
 735         void commit_reversible_command (Command* cmd = 0);
 736
 737         void add_command (Command *const cmd) {
 738                 assert (_current_trans);
 739                 _current_trans->add_command (cmd);
 740         }
 741
 742         /** @return The list of operations that are currently in progress */
 743         std::list<GQuark> const & current_operations () {
 744                 return _current_trans_quarks;
 745         }
 746
 747         bool operation_in_progress (GQuark) const;
 748
 749         void add_commands (std::vector<Command*> const & cmds);
 750
 751         std::map<PBD::ID,PBD::StatefulDestructible*> registry;
 752
 753         // these commands are implemented in libs/ardour/session_command.cc
 754         Command* memento_command_factory(XMLNode* n);
 755         Command* stateful_diff_command_factory (XMLNode *);
 756         void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
 757
 758         /* clicking */
 759
 760         boost::shared_ptr<IO> click_io() { return _click_io; }
 761         boost::shared_ptr<Amp> click_gain() { return _click_gain; }
 762
 763         /* disk, buffer loads */
 764
 765         uint32_t playback_load ();
 766         uint32_t capture_load ();
 767
 768         /* ranges */
 769
 770         void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
 771         void request_cancel_play_range ();
 772         bool get_play_range () const { return _play_range; }
 773
 774         void maybe_update_session_range (framepos_t, framepos_t);
 775
 776         /* buffers for gain and pan */
 777
 778         gain_t* gain_automation_buffer () const;
 779         gain_t* send_gain_automation_buffer () const;
 780         pan_t** pan_automation_buffer () const;
 781
 782         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
 783
 784         /* VST support */
 785
 786         static int  vst_current_loading_id;
 787         static const char* vst_can_do_strings[];
 788         static const int vst_can_do_string_count;
 789
 790         static intptr_t vst_callback (
 791                 AEffect* effect,
 792                 int32_t opcode,
 793                 int32_t index,
 794                 intptr_t value,
 795                 void* ptr,
 796                 float opt
 797                 );
 798
 799         static PBD::Signal0<void> SendFeedback;
 800
 801         /* Speakers */
 802
 803         boost::shared_ptr<Speakers> get_speakers ();
 804
 805         /* Controllables */
 806
 807         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
 808         boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
 809
 810         void add_controllable (boost::shared_ptr<PBD::Controllable>);
 811         void remove_controllable (PBD::Controllable*);
 812
 813         boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
 814
 815         SessionConfiguration config;
 816
 817         bool exporting () const {
 818                 return _exporting;
 819         }
 820
 821         bool bounce_processing() const {
 822                 return _bounce_processing_active;
 823         }
 824
 825         /* this is a private enum, but setup_enum_writer() needs it,
 826            and i can't find a way to give that function
 827            friend access. sigh.
 828         */
 829
 830         enum PostTransportWork {
 831                 PostTransportStop               = 0x1,
 832                 PostTransportDuration           = 0x2,
 833                 PostTransportLocate             = 0x4,
 834                 PostTransportRoll               = 0x8,
 835                 PostTransportAbort              = 0x10,
 836                 PostTransportOverWrite          = 0x20,
 837                 PostTransportSpeed              = 0x40,
 838                 PostTransportAudition           = 0x80,
 839                 PostTransportReverse            = 0x100,
 840                 PostTransportInputChange        = 0x200,
 841                 PostTransportCurveRealloc       = 0x400,
 842                 PostTransportClearSubstate      = 0x800,
 843                 PostTransportAdjustPlaybackBuffering  = 0x1000,
 844                 PostTransportAdjustCaptureBuffering   = 0x2000
 845         };
 846
 847         enum SlaveState {
 848                 Stopped,
 849                 Waiting,
 850                 Running
 851         };
 852
 853         SlaveState slave_state() const { return _slave_state; }
 854         Slave* slave() const { return _slave; }
 855
 856         boost::shared_ptr<SessionPlaylists> playlists;
 857
 858         void send_mmc_locate (framepos_t);
 859         void queue_full_time_code () { _send_timecode_update = true; }
 860         void queue_song_position_pointer () { /* currently does nothing */ }
 861
 862         bool step_editing() const { return (_step_editors > 0); }
 863
 864         void request_suspend_timecode_transmission ();
 865         void request_resume_timecode_transmission ();
 866         bool timecode_transmission_suspended () const;
 867
 868         std::vector<std::string> source_search_path(DataType) const;
 869         void ensure_search_path_includes (const std::string& path, DataType type);
 870         void remove_dir_from_search_path (const std::string& path, DataType type);
 871
 872         std::list<std::string> unknown_processors () const;
 873
 874         /** Emitted when a feedback cycle has been detected within Ardour's signal
 875             processing path.  Until it is fixed (by the user) some (unspecified)
 876             routes will not be run.
 877         */
 878         static PBD::Signal0<void> FeedbackDetected;
 879
 880         /** Emitted when a graph sort has successfully completed, which means
 881             that it has no feedback cycles.
 882         */
 883         static PBD::Signal0<void> SuccessfulGraphSort;
 884
 885         /* handlers can return an integer value:
 886            0: config.set_audio_search_path() or config.set_midi_search_path() was used
 887            to modify the search path and we should try to find it again.
 888            1: quit entire session load
 889            2: as 0, but don't ask about other missing files
 890            3: don't ask about other missing files, and just mark this one missing
 891            -1: just mark this one missing
 892            any other value: as -1
 893         */
 894         static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
 895
 896         /** Emitted when the session wants Ardour to quit */
 897         static PBD::Signal0<void> Quit;
 898
 899         /** Emitted when Ardour is asked to load a session in an older session
 900          * format, and makes a backup copy.
 901          */
 902         static PBD::Signal2<void,std::string,std::string> VersionMismatch;
 903
 904         SceneChanger* scene_changer() const { return _scene_changer; }
 905
 906         boost::shared_ptr<Port> ltc_input_port() const;
 907         boost::shared_ptr<Port> ltc_output_port() const;
 908
 909         boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
 910         boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
 911
 912         MIDI::Port* midi_input_port () const;
 913         MIDI::Port* midi_output_port () const;
 914         MIDI::Port* mmc_output_port () const;
 915         MIDI::Port* mmc_input_port () const;
 916
 917         MIDI::Port* scene_input_port () const;
 918         MIDI::Port* scene_output_port () const;
 919
 920         boost::shared_ptr<MidiPort> scene_in () const;
 921         boost::shared_ptr<MidiPort> scene_out () const;
 922
 923         boost::shared_ptr<MidiPort> midi_clock_output_port () const;
 924         boost::shared_ptr<MidiPort> midi_clock_input_port () const;
 925         boost::shared_ptr<MidiPort> mtc_output_port () const;
 926         boost::shared_ptr<MidiPort> mtc_input_port () const;
 927
 928         MIDI::MachineControl& mmc() { return *_mmc; }
 929
 930   protected:
 931         friend class AudioEngine;
 932         void set_block_size (pframes_t nframes);
 933         void set_frame_rate (framecnt_t nframes);
 934         void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
 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         Glib::Threads::Mutex save_state_lock;
1130
1131         int      load_options (const XMLNode&);
1132         int      load_state (std::string snapshot_name);
1133
1134         framepos_t _last_roll_location;
1135         /** the session frame time at which we last rolled, located, or changed transport direction */
1136         framepos_t _last_roll_or_reversal_location;
1137         framepos_t _last_record_location;
1138
1139         bool              pending_locate_roll;
1140         framepos_t        pending_locate_frame;
1141         bool              pending_locate_flush;
1142         bool              pending_abort;
1143         bool              pending_auto_loop;
1144
1145         Butler* _butler;
1146
1147         static const PostTransportWork ProcessCannotProceedMask =
1148                 PostTransportWork (
1149                                 PostTransportInputChange|
1150                                 PostTransportSpeed|
1151                                 PostTransportReverse|
1152                                 PostTransportCurveRealloc|
1153                                 PostTransportAudition|
1154                                 PostTransportLocate|
1155                                 PostTransportStop|
1156                                 PostTransportClearSubstate);
1157
1158         gint _post_transport_work; /* accessed only atomic ops */
1159         PostTransportWork post_transport_work() const        { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1160         void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1161         void add_post_transport_work (PostTransportWork ptw);
1162
1163         void schedule_playback_buffering_adjustment ();
1164         void schedule_capture_buffering_adjustment ();
1165
1166         uint32_t    cumulative_rf_motion;
1167         uint32_t    rf_scale;
1168
1169         void set_rf_speed (float speed);
1170         void reset_rf_scale (framecnt_t frames_moved);
1171
1172         Locations*       _locations;
1173         void              location_added (Location*);
1174         void              location_removed (Location*);
1175         void              locations_changed ();
1176         void             _locations_changed (const Locations::LocationList&);
1177
1178         void              update_skips (Location*, bool consolidate);
1179         Locations::LocationList consolidate_skips (Location*);
1180         void              sync_locations_to_skips (const Locations::LocationList&);
1181         PBD::ScopedConnectionList skip_connections;
1182
1183         PBD::ScopedConnectionList punch_connections;
1184         void             auto_punch_start_changed (Location *);
1185         void             auto_punch_end_changed (Location *);
1186         void             auto_punch_changed (Location *);
1187
1188         PBD::ScopedConnectionList loop_connections;
1189         void             auto_loop_changed (Location *);
1190         void             auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1191
1192         int  ensure_engine (uint32_t desired_sample_rate);
1193         void pre_engine_init (std::string path);
1194         int  post_engine_init ();
1195         int  immediately_post_engine ();
1196         void remove_empty_sounds ();
1197
1198         void setup_midi_control ();
1199         int  midi_read (MIDI::Port *);
1200
1201         void enable_record ();
1202
1203         void increment_transport_position (framecnt_t val) {
1204                 if (max_framepos - val < _transport_frame) {
1205                         _transport_frame = max_framepos;
1206                 } else {
1207                         _transport_frame += val;
1208                 }
1209         }
1210
1211         void decrement_transport_position (framecnt_t val) {
1212                 if (val < _transport_frame) {
1213                         _transport_frame -= val;
1214                 } else {
1215                         _transport_frame = 0;
1216                 }
1217         }
1218
1219         void post_transport_motion ();
1220         static void *session_loader_thread (void *arg);
1221
1222         void *do_work();
1223
1224         /* SessionEventManager interface */
1225
1226         void process_event (SessionEvent*);
1227         void set_next_event ();
1228         void cleanup_event (SessionEvent*,int);
1229
1230         /* MIDI Machine Control */
1231
1232         void spp_start ();
1233         void spp_continue ();
1234         void spp_stop ();
1235
1236         void mmc_deferred_play (MIDI::MachineControl &);
1237         void mmc_stop (MIDI::MachineControl &);
1238         void mmc_step (MIDI::MachineControl &, int);
1239         void mmc_pause (MIDI::MachineControl &);
1240         void mmc_record_pause (MIDI::MachineControl &);
1241         void mmc_record_strobe (MIDI::MachineControl &);
1242         void mmc_record_exit (MIDI::MachineControl &);
1243         void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1244         void mmc_fast_forward (MIDI::MachineControl &);
1245         void mmc_rewind (MIDI::MachineControl &);
1246         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1247         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1248         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1249
1250         struct timeval last_mmc_step;
1251         double step_speed;
1252
1253         typedef boost::function<bool()> MidiTimeoutCallback;
1254         typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1255
1256         MidiTimeoutList midi_timeouts;
1257         bool mmc_step_timeout ();
1258         void send_immediate_mmc (MIDI::MachineControlCommand);
1259
1260         MIDI::byte mtc_msg[16];
1261         MIDI::byte mtc_timecode_bits;   /* encoding of SMTPE type for MTC */
1262         MIDI::byte midi_msg[16];
1263         double outbound_mtc_timecode_frame;
1264         Timecode::Time transmitting_timecode_time;
1265         int next_quarter_frame_to_send;
1266
1267         double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1268         framecnt_t _frames_per_hour;
1269         framecnt_t _timecode_frames_per_hour;
1270
1271         /* cache the most-recently requested time conversions. This helps when we
1272          * have multiple clocks showing the same time (e.g. the transport frame) */
1273         bool last_timecode_valid;
1274         framepos_t last_timecode_when;
1275         Timecode::Time last_timecode;
1276
1277         bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1278
1279         int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1280
1281         LTCEncoder*       ltc_encoder;
1282         ltcsnd_sample_t*  ltc_enc_buf;
1283
1284         Timecode::TimecodeFormat ltc_enc_tcformat;
1285         int32_t           ltc_buf_off;
1286         int32_t           ltc_buf_len;
1287
1288         double            ltc_speed;
1289         int32_t           ltc_enc_byte;
1290         framepos_t        ltc_enc_pos;
1291         double            ltc_enc_cnt;
1292         framepos_t        ltc_enc_off;
1293         bool              restarting;
1294         framepos_t        ltc_prev_cycle;
1295
1296         framepos_t        ltc_timecode_offset;
1297         bool              ltc_timecode_negative_offset;
1298
1299         LatencyRange      ltc_out_latency;
1300
1301         void ltc_tx_initialize();
1302         void ltc_tx_cleanup();
1303         void ltc_tx_reset();
1304         void ltc_tx_resync_latency();
1305         void ltc_tx_recalculate_position();
1306         void ltc_tx_parse_offset();
1307         void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1308
1309         void reset_record_status ();
1310
1311         int no_roll (pframes_t nframes);
1312         int fail_roll (pframes_t nframes);
1313
1314         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1315         bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1316
1317         MidiControlUI* midi_control_ui;
1318
1319         int           start_midi_thread ();
1320
1321         void set_play_loop (bool yn, double speed);
1322         void unset_play_loop ();
1323         void overwrite_some_buffers (Track *);
1324         void flush_all_inserts ();
1325         int  micro_locate (framecnt_t distance);
1326         void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1327         void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1328         void force_locate (framepos_t frame, bool with_roll = false);
1329         void set_track_speed (Track *, double speed);
1330         void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1331         void stop_transport (bool abort = false, bool clear_state = false);
1332         void start_transport ();
1333         void realtime_stop (bool abort, bool clear_state);
1334         void realtime_locate ();
1335         void non_realtime_start_scrub ();
1336         void non_realtime_set_speed ();
1337         void non_realtime_locate ();
1338         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1339         void non_realtime_overwrite (int entry_request_count, bool& finished);
1340         void post_transport ();
1341         void engine_halted ();
1342         void xrun_recovery ();
1343
1344     /* These are synchronous and so can only be called from within the process
1345      * cycle
1346      */
1347
1348     int  send_full_time_code (framepos_t, pframes_t nframes);
1349     void send_song_position_pointer (framepos_t);
1350
1351         TempoMap    *_tempo_map;
1352         void          tempo_map_changed (const PBD::PropertyChange&);
1353
1354         /* edit/mix groups */
1355
1356         int load_route_groups (const XMLNode&, int);
1357
1358         std::list<RouteGroup *> _route_groups;
1359         RouteGroup*             _all_route_group;
1360
1361         /* routes stuff */
1362
1363         boost::shared_ptr<Graph> _process_graph;
1364
1365         SerializedRCUManager<RouteList>  routes;
1366
1367         void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1368         void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1369         bool _adding_routes_in_progress;
1370         uint32_t destructive_index;
1371
1372         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1373         boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1374
1375         void route_processors_changed (RouteProcessorChange);
1376
1377         bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1378         void count_existing_track_channels (ChanCount& in, ChanCount& out);
1379         void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1380                                  bool with_lock, bool connect_inputs = true,
1381                                  ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1382         void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1383
1384         /* track numbering */
1385
1386         void reassign_track_numbers ();
1387         uint32_t _track_number_decimals;
1388
1389         /* mixer stuff */
1390
1391         bool solo_update_disabled;
1392
1393         void route_listen_changed (void *src, boost::weak_ptr<Route>);
1394         void route_mute_changed (void *src);
1395         void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1396         void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1397         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1398
1399         void listen_position_changed ();
1400         void solo_control_mode_changed ();
1401
1402         /* REGION MANAGEMENT */
1403
1404         mutable Glib::Threads::Mutex region_lock;
1405
1406         int load_regions (const XMLNode& node);
1407         int load_compounds (const XMLNode& node);
1408
1409         void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1410         void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1411         void route_group_property_changed (RouteGroup *);
1412
1413         /* SOURCES */
1414
1415         mutable Glib::Threads::Mutex source_lock;
1416
1417   public:
1418         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1419
1420   private:
1421         SourceMap sources;
1422
1423   private:
1424         int load_sources (const XMLNode& node);
1425         XMLNode& get_sources_as_xml ();
1426
1427         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1428
1429         /* PLAYLISTS */
1430
1431         void remove_playlist (boost::weak_ptr<Playlist>);
1432         void track_playlist_changed (boost::weak_ptr<Track>);
1433         void playlist_region_added (boost::weak_ptr<Region>);
1434         void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1435         void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1436
1437         /* CURVES and AUTOMATION LISTS */
1438         std::map<PBD::ID, AutomationList*> automation_lists;
1439
1440         /* DEFAULT FADE CURVES */
1441
1442         float default_fade_steepness;
1443         float default_fade_msecs;
1444
1445         /* AUDITIONING */
1446
1447         boost::shared_ptr<Auditioner> auditioner;
1448         void set_audition (boost::shared_ptr<Region>);
1449         void non_realtime_set_audition ();
1450         boost::shared_ptr<Region> pending_audition_region;
1451
1452         /* EXPORT */
1453
1454         /* FLATTEN */
1455
1456         int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1457
1458         /* INSERT AND SEND MANAGEMENT */
1459
1460         boost::dynamic_bitset<uint32_t> send_bitset;
1461         boost::dynamic_bitset<uint32_t> aux_send_bitset;
1462         boost::dynamic_bitset<uint32_t> return_bitset;
1463         boost::dynamic_bitset<uint32_t> insert_bitset;
1464
1465         /* S/W RAID */
1466
1467         struct space_and_path {
1468                 uint32_t blocks;     ///< 4kB blocks
1469                 bool blocks_unknown; ///< true if blocks is unknown
1470                 std::string path;
1471
1472                 space_and_path ()
1473                         : blocks (0)
1474                         , blocks_unknown (true)
1475                 {}
1476         };
1477
1478         struct space_and_path_ascending_cmp {
1479                 bool operator() (space_and_path a, space_and_path b) {
1480                         if (a.blocks_unknown != b.blocks_unknown) {
1481                                 return !a.blocks_unknown;
1482                         }
1483                         return a.blocks > b.blocks;
1484                 }
1485         };
1486
1487         void setup_raid_path (std::string path);
1488
1489         std::vector<space_and_path> session_dirs;
1490         std::vector<space_and_path>::iterator last_rr_session_dir;
1491         uint32_t _total_free_4k_blocks;
1492         /** If this is true, _total_free_4k_blocks is not definite,
1493             as one or more of the session directories' filesystems
1494             could not report free space.
1495         */
1496         bool _total_free_4k_blocks_uncertain;
1497         Glib::Threads::Mutex space_lock;
1498
1499         bool no_questions_about_missing_files;
1500
1501         std::string get_best_session_directory_for_new_audio ();
1502
1503         mutable gint _playback_load;
1504         mutable gint _capture_load;
1505
1506         /* I/O bundles */
1507
1508         SerializedRCUManager<BundleList> _bundles;
1509         XMLNode* _bundle_xml_node;
1510         int load_bundles (XMLNode const &);
1511
1512         UndoHistory      _history;
1513         /** current undo transaction, or 0 */
1514         UndoTransaction* _current_trans;
1515         /** GQuarks to describe the reversible commands that are currently in progress.
1516          *  These may be nested, in which case more recently-started commands are toward
1517          *  the front of the list.
1518          */
1519         std::list<GQuark> _current_trans_quarks;
1520
1521         int  backend_sync_callback (TransportState, framepos_t);
1522
1523         void process_rtop (SessionEvent*);
1524
1525         void  update_latency (bool playback);
1526
1527         XMLNode& state(bool);
1528
1529         /* click track */
1530         typedef std::list<Click*> Clicks;
1531         Clicks                  clicks;
1532         bool                   _clicking;
1533         boost::shared_ptr<IO>  _click_io;
1534         boost::shared_ptr<Amp> _click_gain;
1535         Sample*                 click_data;
1536         Sample*                 click_emphasis_data;
1537         framecnt_t              click_length;
1538         framecnt_t              click_emphasis_length;
1539         mutable Glib::Threads::RWLock    click_lock;
1540
1541         static const Sample     default_click[];
1542         static const framecnt_t default_click_length;
1543         static const Sample     default_click_emphasis[];
1544         static const framecnt_t default_click_emphasis_length;
1545
1546         Click *get_click();
1547         framepos_t _clicks_cleared;
1548         void   setup_click_sounds (int which);
1549         void   setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1550         void   clear_clicks ();
1551         void   click (framepos_t start, framecnt_t nframes);
1552
1553         std::vector<Route*> master_outs;
1554
1555         /* range playback */
1556
1557         std::list<AudioRange> current_audio_range;
1558         bool _play_range;
1559         void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1560         void unset_play_range ();
1561
1562         /* main outs */
1563         uint32_t main_outs;
1564
1565         boost::shared_ptr<Route> _master_out;
1566         boost::shared_ptr<Route> _monitor_out;
1567
1568         void auto_connect_master_bus ();
1569
1570         /* Windows VST support */
1571
1572         long _windows_vst_callback (
1573                 WindowsVSTPlugin*,
1574                 long opcode,
1575                 long index,
1576                 long value,
1577                 void* ptr,
1578                 float opt
1579                 );
1580
1581         int find_all_sources (std::string path, std::set<std::string>& result);
1582         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1583
1584         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1585         Glib::Threads::Mutex controllables_lock;
1586         Controllables controllables;
1587
1588         boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1589
1590         void reset_native_file_format();
1591         bool first_file_data_format_reset;
1592         bool first_file_header_format_reset;
1593
1594         void config_changed (std::string, bool);
1595
1596         XMLNode& get_control_protocol_state ();
1597
1598         void set_history_depth (uint32_t depth);
1599
1600         static bool _disable_all_loaded_plugins;
1601
1602         mutable bool have_looped; ///< Used in ::audible_frame(*)
1603
1604         void update_have_rec_enabled_track ();
1605         gint _have_rec_enabled_track;
1606
1607         static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1608
1609         /* realtime "apply to set of routes" operations */
1610         template<typename T> SessionEvent*
1611                 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1612                               void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1613                 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1614                 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1615                 ev->rt_return = after;
1616                 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1617
1618                 return ev;
1619         }
1620
1621         void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1622         void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1623         void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1624         void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1625         void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1626         void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1627         void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1628         void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1629
1630         /** temporary list of Diskstreams used only during load of 2.X sessions */
1631         std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1632
1633         void add_session_range_location (framepos_t, framepos_t);
1634
1635         void setup_midi_machine_control ();
1636
1637         void step_edit_status_change (bool);
1638         uint32_t _step_editors;
1639
1640         /** true if timecode transmission by the transport is suspended, otherwise false */
1641         mutable gint _suspend_timecode_transmission;
1642
1643         void update_locations_after_tempo_map_change (const Locations::LocationList &);
1644
1645         void start_time_changed (framepos_t);
1646         void end_time_changed (framepos_t);
1647
1648         void set_track_monitor_input_status (bool);
1649         framepos_t compute_stop_limit () const;
1650
1651         boost::shared_ptr<Speakers> _speakers;
1652         void load_nested_sources (const XMLNode& node);
1653
1654         /** The directed graph of routes that is currently being used for audio processing
1655             and solo/mute computations.
1656         */
1657         GraphEdges _current_route_graph;
1658
1659         uint32_t next_control_id () const;
1660         uint32_t _order_hint;
1661         bool ignore_route_processor_changes;
1662
1663         MidiClockTicker* midi_clock;
1664
1665         boost::shared_ptr<IO>   _ltc_input;
1666         boost::shared_ptr<IO>   _ltc_output;
1667
1668         void reconnect_ltc_input ();
1669         void reconnect_ltc_output ();
1670
1671         /* Scene Changing */
1672         SceneChanger* _scene_changer;
1673
1674         /* persistent, non-track related MIDI ports */
1675         MidiPortManager* _midi_ports;
1676         MIDI::MachineControl* _mmc;
1677
1678         void setup_ltc ();
1679         void setup_click ();
1680         void setup_click_state (const XMLNode*);
1681         void setup_bundles ();
1682
1683         static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1684 };
1685
1686
1687 } // namespace ARDOUR
1688
1689 #endif /* __ardour_session_h__ */