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