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