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