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