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