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