libs/ardour/ardour/session.h

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