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