libs/ardour/ardour/session.h

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