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