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