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