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 <sndfile.h>
  37
  38 #include <glibmm/thread.h>
  39
  40 #include "pbd/error.h"
  41 #include "pbd/pool.h"
  42 #include "pbd/rcu.h"
  43 #include "pbd/statefuldestructible.h"
  44 #include "pbd/undo.h"
  45
  46 #include "midi++/mmc.h"
  47 #include "midi++/types.h"
  48
  49 #include "pbd/destructible.h"
  50 #include "pbd/stateful.h"
  51
  52 #include "ardour/ardour.h"
  53 #include "ardour/chan_count.h"
  54 #include "ardour/rc_configuration.h"
  55 #include "ardour/session_configuration.h"
  56 #include "ardour/location.h"
  57 #include "ardour/smpte.h"
  58 #include "ardour/interpolation.h"
  59
  60 class XMLTree;
  61 class XMLNode;
  62 class AEffect;
  63
  64 namespace MIDI {
  65         class Port;
  66 }
  67
  68 namespace PBD {
  69         class Controllable;
  70 }
  71
  72 namespace Evoral {
  73         class Curve;
  74 }
  75
  76 namespace ARDOUR {
  77
  78 class AudioDiskstream;
  79 class AudioEngine;
  80 class AudioFileSource;
  81 class AudioRegion;
  82 class AudioSource;
  83 class AudioTrack;
  84 class Auditioner;
  85 class AutomationList;
  86 class AuxInput;
  87 class BufferSet;
  88 class Bundle;
  89 class ControlProtocolInfo;
  90 class Diskstream;
  91 class ExportHandler;
  92 class ExportStatus;
  93 class IO;
  94 class IOProcessor;
  95 class MidiDiskstream;
  96 class MidiRegion;
  97 class MidiSource;
  98 class MidiTrack;
  99 class NamedSelection;
 100 class Playlist;
 101 class PluginInsert;
 102 class Port;
 103 class PortInsert;
 104 class Processor;
 105 class Region;
 106 class Return;
 107 class Route;
 108 class RouteGroup;
 109 class SMFSource;
 110 class Send;
 111 class SessionDirectory;
 112 class SessionMetadata;
 113 class Slave;
 114 class Source;
 115 class TempoMap;
 116 class VSTPlugin;
 117
 118 class Session : public PBD::StatefulDestructible, public boost::noncopyable
 119 {
 120   private:
 121         typedef std::pair<boost::weak_ptr<Route>,bool> RouteBooleanState;
 122         typedef std::vector<RouteBooleanState> GlobalRouteBooleanState;
 123         typedef std::pair<boost::weak_ptr<Route>,MeterPoint> RouteMeterState;
 124         typedef std::vector<RouteMeterState> GlobalRouteMeterState;
 125
 126   public:
 127         enum RecordState {
 128                 Disabled = 0,
 129                 Enabled = 1,
 130                 Recording = 2
 131         };
 132
 133         struct Event {
 134                 enum Type {
 135                         SetTransportSpeed,
 136                         SetDiskstreamSpeed,
 137                         Locate,
 138                         LocateRoll,
 139                         LocateRollLocate,
 140                         SetLoop,
 141                         PunchIn,
 142                         PunchOut,
 143                         RangeStop,
 144                         RangeLocate,
 145                         Overwrite,
 146                         SetSlaveSource,
 147                         Audition,
 148                         InputConfigurationChange,
 149                         SetAudioRange,
 150                         SetPlayRange,
 151
 152                         /* only one of each of these events can be queued at any one time */
 153
 154                         StopOnce,
 155                         AutoLoop
 156                 };
 157
 158                 enum Action {
 159                         Add,
 160                         Remove,
 161                         Replace,
 162                         Clear
 163                 };
 164
 165                 Type             type;
 166                 Action           action;
 167                 nframes_t        action_frame;
 168                 nframes_t        target_frame;
 169                 double           speed;
 170
 171                 union {
 172                         void*        ptr;
 173                         bool         yes_or_no;
 174                         nframes_t    target2_frame;
 175                         SlaveSource  slave;
 176                         Route*       route;
 177                 };
 178
 179                 std::list<AudioRange> audio_range;
 180                 std::list<MusicRange> music_range;
 181
 182                 boost::shared_ptr<Region> region;
 183
 184                 Event(Type t, Action a, nframes_t when, nframes_t where, double spd, bool yn = false)
 185                         : type (t)
 186                         , action (a)
 187                         , action_frame (when)
 188                         , target_frame (where)
 189                         , speed (spd)
 190                         , yes_or_no (yn)
 191                 {}
 192
 193                 void set_ptr (void* p) {
 194                         ptr = p;
 195                 }
 196
 197                 bool before (const Event& other) const {
 198                         return action_frame < other.action_frame;
 199                 }
 200
 201                 bool after (const Event& other) const {
 202                         return action_frame > other.action_frame;
 203                 }
 204
 205                 static bool compare (const Event *e1, const Event *e2) {
 206                         return e1->before (*e2);
 207                 }
 208
 209                 void *operator new (size_t ignored) {
 210                         return pool.alloc ();
 211                 }
 212
 213                 void operator delete(void *ptr, size_t size) {
 214                         pool.release (ptr);
 215                 }
 216
 217                 static const nframes_t Immediate = 0;
 218
 219                 private:
 220                 static MultiAllocSingleReleasePool pool;
 221         };
 222
 223         /* creating from an XML file */
 224
 225         Session (AudioEngine&,
 226                         const std::string& fullpath,
 227                         const std::string& snapshot_name,
 228                         std::string mix_template = "");
 229
 230         /* creating a new Session */
 231
 232         Session (AudioEngine&,
 233                         std::string fullpath,
 234                         std::string snapshot_name,
 235                         AutoConnectOption input_auto_connect,
 236                         AutoConnectOption output_auto_connect,
 237                         uint32_t control_out_channels,
 238                         uint32_t master_out_channels,
 239                         uint32_t n_physical_in,
 240                         uint32_t n_physical_out,
 241                         nframes_t initial_length);
 242
 243         virtual ~Session ();
 244
 245         std::string path() const { return _path; }
 246         std::string name() const { return _name; }
 247         std::string snap_name() const { return _current_snapshot_name; }
 248         std::string raid_path () const;
 249
 250         void set_snap_name ();
 251
 252         void set_dirty ();
 253         void set_clean ();
 254         bool dirty() const { return _state_of_the_state & Dirty; }
 255         void set_deletion_in_progress ();
 256         void clear_deletion_in_progress ();
 257         bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
 258         sigc::signal<void> DirtyChanged;
 259
 260         const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
 261
 262         static sigc::signal<void> AutoBindingOn;
 263         static sigc::signal<void> AutoBindingOff;
 264
 265         static sigc::signal<void,std::string> Dialog;
 266
 267         std::string sound_dir (bool with_path = true) const;
 268         std::string peak_dir () const;
 269         std::string dead_sound_dir () const;
 270         std::string automation_dir () const;
 271         std::string analysis_dir() const;
 272
 273         int ensure_subdirs ();
 274
 275         Glib::ustring peak_path (Glib::ustring) const;
 276
 277         static std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
 278
 279         std::string peak_path_from_audio_path (std::string) const;
 280         std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
 281         std::string new_midi_source_name (const std::string&);
 282         std::string new_source_path_from_name (DataType type, const std::string&);
 283         RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
 284
 285         void process (nframes_t nframes);
 286
 287         BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
 288         BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
 289         BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
 290
 291         void add_diskstream (boost::shared_ptr<Diskstream>);
 292         boost::shared_ptr<Diskstream> diskstream_by_id (const PBD::ID& id);
 293         boost::shared_ptr<Diskstream> diskstream_by_name (std::string name);
 294         bool have_rec_enabled_diskstream () const;
 295
 296         bool have_captured() const { return _have_captured; }
 297
 298         void refill_all_diskstream_buffers ();
 299         uint32_t audio_diskstream_buffer_size() const { return audio_dstream_buffer_size; }
 300         uint32_t midi_diskstream_buffer_size() const { return midi_dstream_buffer_size; }
 301
 302         uint32_t get_next_diskstream_id() const { return n_diskstreams(); }
 303         uint32_t n_diskstreams() const;
 304
 305         typedef std::list<boost::shared_ptr<Diskstream> > DiskstreamList;
 306
 307         int load_routes (const XMLNode&);
 308         boost::shared_ptr<RouteList> get_routes() const {
 309                 return routes.reader ();
 310         }
 311
 312         uint32_t nroutes() const { return routes.reader()->size(); }
 313         uint32_t ntracks () const;
 314         uint32_t nbusses () const;
 315
 316         boost::shared_ptr<BundleList> bundles () {
 317                 return _bundles.reader ();
 318         }
 319
 320         struct RoutePublicOrderSorter {
 321             bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
 322         };
 323
 324         void sync_order_keys (std::string const &);
 325
 326         template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
 327         template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
 328         template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
 329
 330         boost::shared_ptr<Route> route_by_name (std::string);
 331         boost::shared_ptr<Route> route_by_id (PBD::ID);
 332         boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
 333
 334         bool route_name_unique (std::string) const;
 335         bool route_name_internal (std::string) const;
 336
 337         bool get_record_enabled() const {
 338                 return (record_status () >= Enabled);
 339         }
 340
 341         RecordState record_status() const {
 342                 return (RecordState) g_atomic_int_get (&_record_status);
 343         }
 344
 345         bool actively_recording () {
 346                 return record_status() == Recording;
 347         }
 348
 349         bool record_enabling_legal () const;
 350         void maybe_enable_record ();
 351         void disable_record (bool rt_context, bool force = false);
 352         void step_back_from_record ();
 353
 354         void maybe_write_autosave ();
 355
 356         /* Proxy signal for region hidden changes */
 357
 358         sigc::signal<void,boost::shared_ptr<Region> > RegionHiddenChange;
 359
 360         /* Emitted when all i/o connections are complete */
 361
 362         sigc::signal<void> IOConnectionsComplete;
 363
 364         /* Record status signals */
 365
 366         sigc::signal<void> RecordStateChanged;
 367
 368         /* Transport mechanism signals */
 369
 370         sigc::signal<void> TransportStateChange; /* generic */
 371         sigc::signal<void,nframes_t> PositionChanged; /* sent after any non-sequential motion */
 372         sigc::signal<void> DurationChanged;
 373         sigc::signal<void,nframes_t> Xrun;
 374         sigc::signal<void> TransportLooped;
 375
 376         /** emitted when a locate has occurred */
 377         sigc::signal<void> Located;
 378
 379         sigc::signal<void,RouteList&> RouteAdded;
 380         sigc::signal<void> RouteGroupChanged;
 381
 382         void request_roll_at_and_return (nframes_t start, nframes_t return_to);
 383         void request_bounded_roll (nframes_t start, nframes_t end);
 384         void request_stop (bool abort = false);
 385         void request_locate (nframes_t frame, bool with_roll = false);
 386
 387         void request_play_loop (bool yn);
 388         bool get_play_loop () const { return play_loop; }
 389
 390         nframes_t  last_transport_start() const { return _last_roll_location; }
 391         void goto_end ()   { request_locate (end_location->start(), false);}
 392         void goto_start () { request_locate (start_location->start(), false); }
 393         void set_session_start (nframes_t start) { start_location->set_start(start); }
 394         void set_session_end (nframes_t end) { end_location->set_start(end); config.set_end_marker_is_free (false); }
 395         void use_rf_shuttle_speed ();
 396         void allow_auto_play (bool yn);
 397         void request_transport_speed (double speed);
 398         void request_overwrite_buffer (Diskstream*);
 399         void request_diskstream_speed (Diskstream&, double speed);
 400         void request_input_change_handling ();
 401
 402         bool locate_pending() const { return static_cast<bool>(post_transport_work&PostTransportLocate); }
 403         bool transport_locked () const;
 404
 405         int wipe ();
 406
 407         int remove_region_from_region_list (boost::shared_ptr<Region>);
 408
 409         nframes_t get_maximum_extent () const;
 410         nframes_t current_end_frame() const { return end_location->start(); }
 411         nframes_t current_start_frame() const { return start_location->start(); }
 412         /// "actual" sample rate of session, set by current audioengine rate, pullup/down etc.
 413         nframes_t frame_rate() const   { return _current_frame_rate; }
 414         /// "native" sample rate of session, regardless of current audioengine rate, pullup/down etc
 415         nframes_t nominal_frame_rate() const   { return _nominal_frame_rate; }
 416         nframes_t frames_per_hour() const { return _frames_per_hour; }
 417
 418         double frames_per_smpte_frame() const { return _frames_per_smpte_frame; }
 419         nframes_t smpte_frames_per_hour() const { return _smpte_frames_per_hour; }
 420
 421         MIDI::byte get_mtc_smpte_bits() const {
 422                 return mtc_smpte_bits;   /* encoding of SMTPE type for MTC */
 423         }
 424
 425         float smpte_frames_per_second() const;
 426         bool smpte_drop_frames() const;
 427
 428         /* Locations */
 429
 430         Locations *locations() { return &_locations; }
 431
 432         sigc::signal<void,Location*>    auto_loop_location_changed;
 433         sigc::signal<void,Location*>    auto_punch_location_changed;
 434         sigc::signal<void>              locations_modified;
 435
 436         void set_auto_punch_location (Location *);
 437         void set_auto_loop_location (Location *);
 438         int location_name(std::string& result, std::string base = std::string(""));
 439
 440         void reset_input_monitor_state ();
 441
 442         void add_event (nframes_t action_frame, Event::Type type, nframes_t target_frame = 0);
 443         void remove_event (nframes_t frame, Event::Type type);
 444         void clear_events (Event::Type type);
 445
 446         nframes_t get_block_size()        const { return current_block_size; }
 447         nframes_t worst_output_latency () const { return _worst_output_latency; }
 448         nframes_t worst_input_latency ()  const { return _worst_input_latency; }
 449         nframes_t worst_track_latency ()  const { return _worst_track_latency; }
 450
 451         int save_state (std::string snapshot_name, bool pending = false);
 452         int restore_state (std::string snapshot_name);
 453         int save_template (std::string template_name);
 454         int save_history (std::string snapshot_name = "");
 455         int restore_history (std::string snapshot_name);
 456         void remove_state (std::string snapshot_name);
 457         void rename_state (std::string old_name, std::string new_name);
 458         void remove_pending_capture_state ();
 459
 460         static int rename_template (std::string old_name, std::string new_name);
 461         static int delete_template (std::string name);
 462
 463         sigc::signal<void,std::string> StateSaved;
 464         sigc::signal<void> StateReady;
 465
 466         std::vector<std::string*>* possible_states() const;
 467         static std::vector<std::string*>* possible_states (std::string path);
 468
 469         XMLNode& get_state();
 470         int      set_state(const XMLNode& node); // not idempotent
 471         XMLNode& get_template();
 472
 473         /// The instant xml file is written to the session directory
 474         void add_instant_xml (XMLNode&, bool write_to_config = true);
 475         XMLNode* instant_xml (const std::string& str);
 476
 477         enum StateOfTheState {
 478                 Clean = 0x0,
 479                 Dirty = 0x1,
 480                 CannotSave = 0x2,
 481                 Deletion = 0x4,
 482                 InitialConnecting = 0x8,
 483                 Loading = 0x10,
 484                 InCleanup = 0x20
 485         };
 486
 487         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 488
 489         void add_route_group (RouteGroup *);
 490         void remove_route_group (RouteGroup&);
 491
 492         RouteGroup *route_group_by_name (std::string);
 493
 494         sigc::signal<void,RouteGroup*> route_group_added;
 495         sigc::signal<void>             route_group_removed;
 496
 497         void foreach_route_group (sigc::slot<void,RouteGroup*> sl) {
 498                 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); i++) {
 499                         sl (*i);
 500                 }
 501         }
 502
 503         /* fundamental operations. duh. */
 504
 505         std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
 506                 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
 507                 );
 508
 509         RouteList new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
 510
 511         std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
 512                 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
 513                 );
 514
 515         void   remove_route (boost::shared_ptr<Route>);
 516         void   resort_routes ();
 517         void   resort_routes_using (boost::shared_ptr<RouteList>);
 518
 519         void   set_remote_control_ids();
 520
 521         AudioEngine & engine() { return _engine; }
 522         AudioEngine const & engine () const { return _engine; }
 523
 524         int32_t  max_level;
 525         int32_t  min_level;
 526
 527         /* Time */
 528
 529         nframes_t transport_frame () const {return _transport_frame; }
 530         nframes_t audible_frame () const;
 531         nframes64_t requested_return_frame() const { return _requested_return_frame; }
 532
 533         enum PullupFormat {
 534                 pullup_Plus4Plus1,
 535                 pullup_Plus4,
 536                 pullup_Plus4Minus1,
 537                 pullup_Plus1,
 538                 pullup_None,
 539                 pullup_Minus1,
 540                 pullup_Minus4Plus1,
 541                 pullup_Minus4,
 542                 pullup_Minus4Minus1
 543         };
 544
 545         void sync_time_vars();
 546
 547         void bbt_time (nframes_t when, BBT_Time&);
 548         void smpte_to_sample(SMPTE::Time& smpte, nframes_t& sample, bool use_offset, bool use_subframes) const;
 549         void sample_to_smpte(nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes) const;
 550         void smpte_time (SMPTE::Time &);
 551         void smpte_time (nframes_t when, SMPTE::Time&);
 552         void smpte_time_subframes (nframes_t when, SMPTE::Time&);
 553
 554         void smpte_duration (nframes_t, SMPTE::Time&) const;
 555         void smpte_duration_string (char *, nframes_t) const;
 556
 557         void           set_smpte_offset (nframes_t);
 558         nframes_t      smpte_offset () const { return _smpte_offset; }
 559         void           set_smpte_offset_negative (bool);
 560         bool           smpte_offset_negative () const { return _smpte_offset_negative; }
 561
 562         nframes_t convert_to_frames_at (nframes_t position, AnyTime const &);
 563
 564         static sigc::signal<void> StartTimeChanged;
 565         static sigc::signal<void> EndTimeChanged;
 566         static sigc::signal<void> SMPTEOffsetChanged;
 567
 568         void   request_slave_source (SlaveSource);
 569         bool   synced_to_jack() const { return Config->get_slave_source() == JACK; }
 570
 571         double transport_speed() const { return _transport_speed; }
 572         bool   transport_stopped() const { return _transport_speed == 0.0f; }
 573         bool   transport_rolling() const { return _transport_speed != 0.0f; }
 574
 575         void set_silent (bool yn);
 576         bool silent () { return _silent; }
 577
 578         int jack_slave_sync (nframes_t);
 579
 580         TempoMap& tempo_map() { return *_tempo_map; }
 581
 582         /// signals the current transport position in frames, bbt and smpte time (in that order)
 583         sigc::signal<void, const nframes_t&, const BBT_Time&, const SMPTE::Time&> tick;
 584
 585         /* region info  */
 586
 587         void add_regions (std::vector<boost::shared_ptr<Region> >&);
 588
 589         sigc::signal<void,boost::weak_ptr<Region> > RegionAdded;
 590         sigc::signal<void,std::vector<boost::weak_ptr<Region> >& > RegionsAdded;
 591         sigc::signal<void,boost::weak_ptr<Region> > RegionRemoved;
 592
 593         int region_name (std::string& result, std::string base = std::string(""), bool newlevel = false);
 594         std::string new_region_name (std::string);
 595         std::string path_from_region_name (DataType type, std::string name, std::string identifier);
 596
 597         boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>);
 598
 599         void find_equivalent_playlist_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >& result);
 600
 601         boost::shared_ptr<Region>      XMLRegionFactory (const XMLNode&, bool full);
 602         boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
 603         boost::shared_ptr<MidiRegion>  XMLMidiRegionFactory (const XMLNode&, bool full);
 604
 605         template<class T> void foreach_region (T *obj, void (T::*func)(boost::shared_ptr<Region>));
 606
 607         /* source management */
 608
 609         struct ImportStatus : public InterThreadInfo {
 610                 std::string doing_what;
 611
 612                 /* control info */
 613                 uint32_t total;
 614                 SrcQuality quality;
 615                 volatile bool freeze;
 616                 std::vector<Glib::ustring> paths;
 617                 bool replace_existing_source;
 618
 619                 /* result */
 620                 SourceList sources;
 621         };
 622
 623         void import_audiofiles (ImportStatus&);
 624         bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
 625         std::string build_tmp_convert_name (std::string file);
 626
 627         boost::shared_ptr<ExportHandler> get_export_handler ();
 628         boost::shared_ptr<ExportStatus> get_export_status ();
 629
 630         int  start_audio_export (nframes_t position, bool realtime);
 631
 632         sigc::signal<int, nframes_t> ProcessExport;
 633         sigc::signal<void> ExportReadFinished;
 634         static sigc::signal<void, std::string, std::string> Exported;
 635
 636         void add_source (boost::shared_ptr<Source>);
 637         void remove_source (boost::weak_ptr<Source>);
 638
 639         struct cleanup_report {
 640                 std::vector<std::string> paths;
 641                 int64_t        space;
 642         };
 643
 644         int  cleanup_sources (cleanup_report&);
 645         int  cleanup_trash_sources (cleanup_report&);
 646
 647         int destroy_region (boost::shared_ptr<Region>);
 648         int destroy_regions (std::list<boost::shared_ptr<Region> >);
 649
 650         int remove_last_capture ();
 651
 652         /** handlers should return -1 for "stop cleanup",
 653             0 for "yes, delete this playlist",
 654             1 for "no, don't delete this playlist".
 655         */
 656         sigc::signal<int,boost::shared_ptr<ARDOUR::Playlist> > AskAboutPlaylistDeletion;
 657
 658         /** handlers should return 0 for "ignore the rate mismatch",
 659             !0 for "do not use this session"
 660         */
 661         static sigc::signal<int,nframes_t, nframes_t> AskAboutSampleRateMismatch;
 662
 663         /** handlers should return !0 for use pending state, 0 for ignore it.
 664         */
 665         static sigc::signal<int> AskAboutPendingState;
 666
 667         boost::shared_ptr<AudioFileSource> create_audio_source_for_session (ARDOUR::AudioDiskstream&, uint32_t which_channel, bool destructive);
 668
 669         boost::shared_ptr<MidiSource> create_midi_source_for_session (ARDOUR::MidiDiskstream&);
 670
 671         boost::shared_ptr<Source> source_by_id (const PBD::ID&);
 672         boost::shared_ptr<Source> source_by_path_and_channel (const Glib::ustring&, uint16_t);
 673
 674         /* playlist management */
 675
 676         boost::shared_ptr<Playlist> playlist_by_name (std::string name);
 677         void unassigned_playlists (std::list<boost::shared_ptr<Playlist> > & list);
 678         void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
 679         sigc::signal<void,boost::shared_ptr<Playlist> > PlaylistAdded;
 680         sigc::signal<void,boost::shared_ptr<Playlist> > PlaylistRemoved;
 681
 682         uint32_t n_playlists() const;
 683
 684         template<class T> void foreach_playlist (T *obj, void (T::*func)(boost::shared_ptr<Playlist>));
 685         void get_playlists (std::vector<boost::shared_ptr<Playlist> >&);
 686
 687         /* named selections */
 688
 689         NamedSelection* named_selection_by_name (std::string name);
 690         void add_named_selection (NamedSelection *);
 691         void remove_named_selection (NamedSelection *);
 692
 693         template<class T> void foreach_named_selection (T& obj, void (T::*func)(NamedSelection&));
 694         sigc::signal<void> NamedSelectionAdded;
 695         sigc::signal<void> NamedSelectionRemoved;
 696
 697         /* Curves and AutomationLists (TODO when they go away) */
 698         void add_automation_list(AutomationList*);
 699
 700         /* fade curves */
 701
 702         float get_default_fade_length () const { return default_fade_msecs; }
 703         float get_default_fade_steepness () const { return default_fade_steepness; }
 704         void set_default_fade (float steepness, float msecs);
 705
 706         /* auditioning */
 707
 708         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 709         void audition_playlist ();
 710         void audition_region (boost::shared_ptr<Region>);
 711         void cancel_audition ();
 712         bool is_auditioning () const;
 713
 714         sigc::signal<void,bool> AuditionActive;
 715
 716         /* flattening stuff */
 717
 718         boost::shared_ptr<Region> write_one_track (AudioTrack&, nframes_t start, nframes_t end,
 719                                                    bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
 720                                                    bool enable_processing = true);
 721         int freeze (InterThreadInfo&);
 722
 723         /* session-wide solo/mute/rec-enable */
 724
 725         bool soloing() const { return _non_soloed_outs_muted; }
 726         bool listening() const { return _listen_cnt > 0; }
 727
 728         void set_all_solo (bool);
 729         void set_all_mute (bool);
 730         void set_all_listen (bool);
 731
 732         sigc::signal<void,bool> SoloActive;
 733         sigc::signal<void> SoloChanged;
 734
 735         void record_disenable_all ();
 736         void record_enable_all ();
 737
 738         /* control/master out */
 739
 740         boost::shared_ptr<Route> control_out() const { return _control_out; }
 741         boost::shared_ptr<Route> master_out() const { return _master_out; }
 742
 743         void globally_add_internal_sends (boost::shared_ptr<Route> dest);
 744         void add_internal_sends (boost::shared_ptr<Route> dest, boost::shared_ptr<RouteList> senders);
 745
 746         static void set_disable_all_loaded_plugins (bool yn) {
 747                 _disable_all_loaded_plugins = yn;
 748         }
 749         static bool get_disable_all_loaded_plugins() {
 750                 return _disable_all_loaded_plugins;
 751         }
 752
 753         uint32_t next_send_id();
 754         uint32_t next_return_id();
 755         uint32_t next_insert_id();
 756         void mark_send_id (uint32_t);
 757         void mark_return_id (uint32_t);
 758         void mark_insert_id (uint32_t);
 759
 760         /* s/w "RAID" management */
 761
 762         nframes_t available_capture_duration();
 763
 764         /* I/O bundles */
 765
 766         void add_bundle (boost::shared_ptr<Bundle>);
 767         void remove_bundle (boost::shared_ptr<Bundle>);
 768         boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
 769
 770         sigc::signal<void,boost::shared_ptr<Bundle> > BundleAdded;
 771         sigc::signal<void,boost::shared_ptr<Bundle> > BundleRemoved;
 772
 773         /* MIDI control */
 774
 775         void midi_panic(void);
 776         int set_mtc_port (std::string port_tag);
 777         int set_mmc_port (std::string port_tag);
 778         int set_midi_port (std::string port_tag);
 779         int set_midi_clock_port (std::string port_tag);
 780         MIDI::Port *mtc_port() const { return _mtc_port; }
 781         MIDI::Port *mmc_port() const { return _mmc_port; }
 782         MIDI::Port *midi_port() const { return _midi_port; }
 783         MIDI::Port *midi_clock_port() const { return _midi_clock_port; }
 784
 785         sigc::signal<void> MTC_PortChanged;
 786         sigc::signal<void> MMC_PortChanged;
 787         sigc::signal<void> MIDI_PortChanged;
 788         sigc::signal<void> MIDIClock_PortChanged;
 789
 790         void set_trace_midi_input (bool, MIDI::Port* port = 0);
 791         void set_trace_midi_output (bool, MIDI::Port* port = 0);
 792
 793         bool get_trace_midi_input(MIDI::Port *port = 0);
 794         bool get_trace_midi_output(MIDI::Port *port = 0);
 795
 796         void set_mmc_receive_device_id (uint32_t id);
 797         void set_mmc_send_device_id (uint32_t id);
 798
 799         /* Scrubbing */
 800
 801         void start_scrub (nframes_t where);
 802         void stop_scrub ();
 803         void set_scrub_speed (float);
 804         nframes_t scrub_buffer_size() const;
 805         sigc::signal<void> ScrubReady;
 806
 807         /* History (for editors, mixers, UIs etc.) */
 808
 809         /** Undo some transactions.
 810          * @param n Number of transactions to undo.
 811          */
 812         void undo (uint32_t n) {
 813                 _history.undo (n);
 814         }
 815
 816         void redo (uint32_t n) {
 817                 _history.redo (n);
 818         }
 819
 820         UndoHistory& history() { return _history; }
 821
 822         uint32_t undo_depth() const { return _history.undo_depth(); }
 823         uint32_t redo_depth() const { return _history.redo_depth(); }
 824         std::string next_undo() const { return _history.next_undo(); }
 825         std::string next_redo() const { return _history.next_redo(); }
 826
 827         void begin_reversible_command (const std::string& cmd_name);
 828         void commit_reversible_command (Command* cmd = 0);
 829
 830         void add_command (Command *const cmd) {
 831                 assert(!_current_trans.empty ());
 832                 _current_trans.top()->add_command (cmd);
 833         }
 834
 835         std::map<PBD::ID, PBD::StatefulThingWithGoingAway*> registry;
 836
 837         // these commands are implemented in libs/ardour/session_command.cc
 838         Command* memento_command_factory(XMLNode* n);
 839         void register_with_memento_command_factory(PBD::ID, PBD::StatefulThingWithGoingAway*);
 840
 841         Command* global_state_command_factory (const XMLNode& n);
 842
 843         class GlobalRouteStateCommand : public Command
 844         {
 845           public:
 846                 GlobalRouteStateCommand (Session&, void*);
 847                 GlobalRouteStateCommand (Session&, const XMLNode& node);
 848                 int set_state (const XMLNode&);
 849                 XMLNode& get_state ();
 850
 851           protected:
 852                 GlobalRouteBooleanState before, after;
 853                 Session& sess;
 854                 void* src;
 855
 856         };
 857
 858         class GlobalSoloStateCommand : public GlobalRouteStateCommand
 859         {
 860           public:
 861                 GlobalSoloStateCommand (Session &, void *src);
 862                 GlobalSoloStateCommand (Session&, const XMLNode&);
 863                 void operator()(); //redo
 864                 void undo();
 865                 XMLNode &get_state();
 866                 void mark();
 867         };
 868
 869         class GlobalMuteStateCommand : public GlobalRouteStateCommand
 870         {
 871           public:
 872                 GlobalMuteStateCommand(Session &, void *src);
 873                 GlobalMuteStateCommand (Session&, const XMLNode&);
 874                 void operator()(); // redo
 875                 void undo();
 876                 XMLNode &get_state();
 877                 void mark();
 878         };
 879
 880         class GlobalRecordEnableStateCommand : public GlobalRouteStateCommand
 881         {
 882           public:
 883                 GlobalRecordEnableStateCommand(Session &, void *src);
 884                 GlobalRecordEnableStateCommand (Session&, const XMLNode&);
 885                 void operator()(); // redo
 886                 void undo();
 887                 XMLNode &get_state();
 888                 void mark();
 889         };
 890
 891         class GlobalMeteringStateCommand : public Command
 892         {
 893           public:
 894                 GlobalMeteringStateCommand(Session &, void *src);
 895                 GlobalMeteringStateCommand (Session&, const XMLNode&);
 896                 void operator()();
 897                 void undo();
 898                 XMLNode &get_state();
 899                 int set_state (const XMLNode&);
 900                 void mark();
 901
 902           protected:
 903                 Session& sess;
 904                 void* src;
 905                 GlobalRouteMeterState before;
 906                 GlobalRouteMeterState after;
 907         };
 908
 909         /* clicking */
 910
 911         boost::shared_ptr<IO> click_io() { return _click_io; }
 912
 913         /* disk, buffer loads */
 914
 915         uint32_t playback_load ();
 916         uint32_t capture_load ();
 917         uint32_t playback_load_min ();
 918         uint32_t capture_load_min ();
 919
 920         void reset_playback_load_min ();
 921         void reset_capture_load_min ();
 922
 923         float read_data_rate () const; // in usec
 924         float write_data_rate () const;
 925
 926         /* ranges */
 927
 928         void set_audio_range (std::list<AudioRange>&);
 929         void set_music_range (std::list<MusicRange>&);
 930
 931         void request_play_range (bool yn);
 932         bool get_play_range () const { return _play_range; }
 933
 934         /* buffers for gain and pan */
 935
 936         gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
 937         pan_t** pan_automation_buffer () const  { return _pan_automation_buffer; }
 938
 939         void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
 940
 941         /* VST support */
 942
 943         static long vst_callback (AEffect* effect,
 944                         long opcode,
 945                         long index,
 946                         long value,
 947                         void* ptr,
 948                         float opt);
 949
 950         static sigc::signal<void> SendFeedback;
 951
 952         /* Controllables */
 953
 954         boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
 955
 956         void add_controllable (boost::shared_ptr<PBD::Controllable>);
 957         void remove_controllable (PBD::Controllable*);
 958
 959         SessionMetadata & metadata () { return *_metadata; }
 960
 961         SessionConfiguration config;
 962
 963   protected:
 964         friend class AudioEngine;
 965         void set_block_size (nframes_t nframes);
 966         void set_frame_rate (nframes_t nframes);
 967
 968   protected:
 969         friend class Diskstream;
 970         void stop_butler ();
 971         void wait_till_butler_finished();
 972
 973   protected:
 974         friend class Route;
 975         void schedule_curve_reallocation ();
 976         void update_latency_compensation (bool, bool);
 977
 978   private:
 979         int  create (bool& new_session, const std::string& mix_template, nframes_t initial_length);
 980         void destroy ();
 981
 982         nframes_t compute_initial_length ();
 983
 984         enum SubState {
 985                 PendingDeclickIn   = 0x1,
 986                 PendingDeclickOut  = 0x2,
 987                 StopPendingCapture = 0x4,
 988                 AutoReturning      = 0x10,
 989                 PendingLocate      = 0x20,
 990                 PendingSetLoop     = 0x40
 991         };
 992
 993         /* stuff used in process() should be close together to
 994            maximise cache hits
 995         */
 996
 997         typedef void (Session::*process_function_type)(nframes_t);
 998
 999         AudioEngine&            _engine;
1000         mutable gint             processing_prohibited;
1001         process_function_type    process_function;
1002         process_function_type    last_process_function;
1003         bool                     waiting_for_sync_offset;
1004         nframes_t               _base_frame_rate;
1005         nframes_t               _current_frame_rate;  //this includes video pullup offset
1006         nframes_t               _nominal_frame_rate;  //ignores audioengine setting, "native" SR
1007         int                      transport_sub_state;
1008         mutable gint            _record_status;
1009         volatile nframes_t      _transport_frame;
1010         Location*                end_location;
1011         Location*                start_location;
1012         Slave*                  _slave;
1013         bool                    _silent;
1014
1015     // varispeed playback
1016         volatile double             _transport_speed;
1017         double                      _last_transport_speed;
1018         double                      _target_transport_speed;
1019         FixedPointLinearInterpolation  interpolation;
1020
1021         bool                     auto_play_legal;
1022         nframes_t               _last_slave_transport_frame;
1023         nframes_t                maximum_output_latency;
1024         volatile nframes64_t    _requested_return_frame;
1025         BufferSet*              _scratch_buffers;
1026         BufferSet*              _silent_buffers;
1027         BufferSet*              _mix_buffers;
1028         nframes_t                current_block_size;
1029         nframes_t               _worst_output_latency;
1030         nframes_t               _worst_input_latency;
1031         nframes_t               _worst_track_latency;
1032         bool                    _have_captured;
1033         float                   _meter_hold;
1034         float                   _meter_falloff;
1035         bool                    _non_soloed_outs_muted;
1036         uint32_t                _listen_cnt;
1037
1038         void set_worst_io_latencies ();
1039         void set_worst_io_latencies_x (IOChange asifwecare, void *ignored) {
1040                 set_worst_io_latencies ();
1041         }
1042
1043         void update_latency_compensation_proxy (void* ignored);
1044
1045         void ensure_buffers (ChanCount howmany);
1046
1047         void process_scrub          (nframes_t);
1048         void process_without_events (nframes_t);
1049         void process_with_events    (nframes_t);
1050         void process_audition       (nframes_t);
1051         void process_export         (nframes_t);
1052         int  process_export_fw      (nframes_t);
1053
1054         void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1055         void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1056         bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1057
1058         /* slave tracking */
1059
1060         static const int delta_accumulator_size = 25;
1061         int delta_accumulator_cnt;
1062         long delta_accumulator[delta_accumulator_size];
1063         long average_slave_delta;
1064         int  average_dir;
1065         bool have_first_delta_accumulator;
1066
1067         enum SlaveState {
1068                 Stopped,
1069                 Waiting,
1070                 Running
1071         };
1072
1073         SlaveState slave_state;
1074         nframes_t slave_wait_end;
1075
1076         void reset_slave_state ();
1077         bool follow_slave (nframes_t);
1078         void calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta);
1079         void track_slave_state(float slave_speed, nframes_t slave_transport_frame,
1080                                nframes_t this_delta, bool starting);
1081         void follow_slave_silently(nframes_t nframes, float slave_speed);
1082
1083         void set_slave_source (SlaveSource);
1084
1085         SlaveSource post_export_slave;
1086         nframes_t post_export_position;
1087
1088         bool _exporting;
1089         bool _exporting_realtime;
1090
1091         boost::shared_ptr<ExportHandler> export_handler;
1092         boost::shared_ptr<ExportStatus>  export_status;
1093
1094         int  pre_export ();
1095         int  stop_audio_export ();
1096         void finalize_audio_export ();
1097
1098         sigc::connection export_freewheel_connection;
1099
1100         void prepare_diskstreams ();
1101         void commit_diskstreams (nframes_t, bool& session_requires_butler);
1102         int  process_routes (nframes_t);
1103         int  silent_process_routes (nframes_t);
1104
1105         bool get_rec_monitors_input () {
1106                 if (actively_recording()) {
1107                         return true;
1108                 } else {
1109                         if (config.get_auto_input()) {
1110                                 return false;
1111                         } else {
1112                                 return true;
1113                         }
1114                 }
1115         }
1116
1117         int get_transport_declick_required () {
1118                 if (transport_sub_state & PendingDeclickIn) {
1119                         transport_sub_state &= ~PendingDeclickIn;
1120                         return 1;
1121                 } else if (transport_sub_state & PendingDeclickOut) {
1122                         return -1;
1123                 } else {
1124                         return 0;
1125                 }
1126         }
1127
1128         bool maybe_stop (nframes_t limit) {
1129                 if (   (_transport_speed > 0.0f && _transport_frame >= limit)
1130                     || (_transport_speed < 0.0f && _transport_frame == 0)    ) {
1131                         stop_transport ();
1132                         return true;
1133                 }
1134                 return false;
1135         }
1136
1137         bool maybe_sync_start (nframes_t&);
1138
1139         void check_declick_out ();
1140
1141         MIDI::MachineControl*    mmc;
1142         MIDI::Port*             _mmc_port;
1143         MIDI::Port*             _mtc_port;
1144         MIDI::Port*             _midi_port;
1145         MIDI::Port*             _midi_clock_port;
1146         std::string             _path;
1147         std::string             _name;
1148         bool                     session_send_mmc;
1149         bool                     session_send_mtc;
1150         bool                     session_midi_feedback;
1151         bool                     play_loop;
1152         bool                     loop_changing;
1153         nframes_t                last_loopend;
1154
1155         boost::scoped_ptr<SessionDirectory> _session_dir;
1156
1157         RingBuffer<Event*> pending_events;
1158
1159         void hookup_io ();
1160         void when_engine_running ();
1161         void graph_reordered ();
1162
1163         std::string _current_snapshot_name;
1164
1165         XMLTree* state_tree;
1166         bool     state_was_pending;
1167         StateOfTheState _state_of_the_state;
1168
1169         void     auto_save();
1170         int      load_options (const XMLNode&);
1171         int      load_state (std::string snapshot_name);
1172
1173         nframes_t _last_roll_location;
1174         nframes_t _last_record_location;
1175
1176         bool              pending_locate_roll;
1177         nframes_t         pending_locate_frame;
1178         bool              pending_locate_flush;
1179         bool              pending_abort;
1180         bool              pending_auto_loop;
1181
1182         Sample*           butler_mixdown_buffer;
1183         float*            butler_gain_buffer;
1184         pthread_t         butler_thread;
1185         Glib::Mutex       butler_request_lock;
1186         Glib::Cond        butler_paused;
1187         bool              butler_should_run;
1188         mutable gint      butler_should_do_transport_work;
1189         int               butler_request_pipe[2];
1190
1191         inline bool transport_work_requested() const {
1192                 return g_atomic_int_get(&butler_should_do_transport_work);
1193         }
1194
1195         struct ButlerRequest {
1196                 enum Type {
1197                         Wake,
1198                         Run,
1199                         Pause,
1200                         Quit
1201                 };
1202         };
1203
1204         enum PostTransportWork {
1205                 PostTransportStop               = 0x1,
1206                 PostTransportDisableRecord      = 0x2,
1207                 PostTransportPosition           = 0x8,
1208                 PostTransportDidRecord          = 0x20,
1209                 PostTransportDuration           = 0x40,
1210                 PostTransportLocate             = 0x80,
1211                 PostTransportRoll               = 0x200,
1212                 PostTransportAbort              = 0x800,
1213                 PostTransportOverWrite          = 0x1000,
1214                 PostTransportSpeed              = 0x2000,
1215                 PostTransportAudition           = 0x4000,
1216                 PostTransportScrub              = 0x8000,
1217                 PostTransportReverse            = 0x10000,
1218                 PostTransportInputChange        = 0x20000,
1219                 PostTransportCurveRealloc       = 0x40000
1220         };
1221
1222         static const PostTransportWork ProcessCannotProceedMask =
1223                 PostTransportWork (
1224                                 PostTransportInputChange|
1225                                 PostTransportSpeed|
1226                                 PostTransportReverse|
1227                                 PostTransportCurveRealloc|
1228                                 PostTransportScrub|
1229                                 PostTransportAudition|
1230                                 PostTransportLocate|
1231                                 PostTransportStop);
1232
1233         PostTransportWork post_transport_work;
1234
1235         void             summon_butler ();
1236         void             schedule_butler_transport_work ();
1237         int              start_butler_thread ();
1238         void             terminate_butler_thread ();
1239         static void    *_butler_thread_work (void *arg);
1240         void*            butler_thread_work ();
1241
1242         uint32_t    cumulative_rf_motion;
1243         uint32_t    rf_scale;
1244
1245         void set_rf_speed (float speed);
1246         void reset_rf_scale (nframes_t frames_moved);
1247
1248         Locations        _locations;
1249         void              locations_changed ();
1250         void              locations_added (Location*);
1251         void              handle_locations_changed (Locations::LocationList&);
1252
1253         sigc::connection auto_punch_start_changed_connection;
1254         sigc::connection auto_punch_end_changed_connection;
1255         sigc::connection auto_punch_changed_connection;
1256         void             auto_punch_start_changed (Location *);
1257         void             auto_punch_end_changed (Location *);
1258         void             auto_punch_changed (Location *);
1259
1260         sigc::connection auto_loop_start_changed_connection;
1261         sigc::connection auto_loop_end_changed_connection;
1262         sigc::connection auto_loop_changed_connection;
1263         void             auto_loop_changed (Location *);
1264
1265         typedef std::list<Event *> Events;
1266         Events           events;
1267         Events           immediate_events;
1268         Events::iterator next_event;
1269
1270         /* there can only ever be one of each of these */
1271
1272         Event *auto_loop_event;
1273         Event *punch_out_event;
1274         Event *punch_in_event;
1275
1276         /* events */
1277
1278         void dump_events () const;
1279         void queue_event (Event *ev);
1280         void merge_event (Event*);
1281         void replace_event (Event::Type, nframes_t action_frame, nframes_t target = 0);
1282         bool _replace_event (Event*);
1283         bool _remove_event (Event *);
1284         void _clear_event_type (Event::Type);
1285
1286         void first_stage_init (std::string path, std::string snapshot_name);
1287         int  second_stage_init (bool new_tracks);
1288         void find_current_end ();
1289         void remove_empty_sounds ();
1290
1291         void setup_midi_control ();
1292         int  midi_read (MIDI::Port *);
1293
1294         void enable_record ();
1295
1296         void increment_transport_position (uint32_t val) {
1297                 if (max_frames - val < _transport_frame) {
1298                         _transport_frame = max_frames;
1299                 } else {
1300                         _transport_frame += val;
1301                 }
1302         }
1303
1304         void decrement_transport_position (uint32_t val) {
1305                 if (val < _transport_frame) {
1306                         _transport_frame -= val;
1307                 } else {
1308                         _transport_frame = 0;
1309                 }
1310         }
1311
1312         void post_transport_motion ();
1313         static void *session_loader_thread (void *arg);
1314
1315         void *do_work();
1316
1317         void set_next_event ();
1318         void process_event (Event *ev);
1319
1320         /* MIDI Machine Control */
1321
1322         void deliver_mmc (MIDI::MachineControl::Command, nframes_t);
1323
1324         void spp_start (MIDI::Parser&, nframes_t timestamp);
1325         void spp_continue (MIDI::Parser&, nframes_t timestamp);
1326         void spp_stop (MIDI::Parser&, nframes_t timestamp);
1327
1328         void mmc_deferred_play (MIDI::MachineControl &);
1329         void mmc_stop (MIDI::MachineControl &);
1330         void mmc_step (MIDI::MachineControl &, int);
1331         void mmc_pause (MIDI::MachineControl &);
1332         void mmc_record_pause (MIDI::MachineControl &);
1333         void mmc_record_strobe (MIDI::MachineControl &);
1334         void mmc_record_exit (MIDI::MachineControl &);
1335         void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1336         void mmc_fast_forward (MIDI::MachineControl &);
1337         void mmc_rewind (MIDI::MachineControl &);
1338         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1339         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1340         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1341
1342         struct timeval last_mmc_step;
1343         double step_speed;
1344
1345         typedef sigc::slot<bool> MidiTimeoutCallback;
1346         typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1347
1348         MidiTimeoutList midi_timeouts;
1349         bool mmc_step_timeout ();
1350
1351         MIDI::byte mmc_buffer[32];
1352         MIDI::byte mtc_msg[16];
1353         MIDI::byte mtc_smpte_bits;   /* encoding of SMTPE type for MTC */
1354         MIDI::byte midi_msg[16];
1355         nframes_t  outbound_mtc_smpte_frame;
1356         SMPTE::Time transmitting_smpte_time;
1357         int next_quarter_frame_to_send;
1358
1359         double _frames_per_smpte_frame; /* has to be floating point because of drop frame */
1360         nframes_t _frames_per_hour;
1361         nframes_t _smpte_frames_per_hour;
1362         nframes_t _smpte_offset;
1363         bool _smpte_offset_negative;
1364
1365         /* cache the most-recently requested time conversions. This helps when we
1366          * have multiple clocks showing the same time (e.g. the transport frame) */
1367         bool           last_smpte_valid;
1368         nframes_t last_smpte_when;
1369         SMPTE::Time    last_smpte;
1370
1371         bool _send_smpte_update; ///< Flag to send a full frame (SMPTE) MTC message this cycle
1372
1373         int send_full_time_code(nframes_t nframes);
1374         int send_midi_time_code_for_cycle(nframes_t nframes);
1375
1376         nframes_t adjust_apparent_position (nframes_t frames);
1377
1378         void reset_record_status ();
1379
1380         int no_roll (nframes_t nframes);
1381         int fail_roll (nframes_t nframes);
1382
1383         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work); }
1384         bool process_can_proceed() const { return !(post_transport_work & ProcessCannotProceedMask); }
1385
1386         struct MIDIRequest {
1387                 enum Type {
1388                         PortChange,
1389                         Quit
1390                 };
1391                 Type type;
1392         };
1393
1394         Glib::Mutex  midi_lock;
1395         pthread_t    midi_thread;
1396         int          midi_request_pipe[2];
1397         RingBuffer<MIDIRequest*> midi_requests;
1398
1399         int           start_midi_thread ();
1400         void          terminate_midi_thread ();
1401         void          poke_midi_thread ();
1402         static void *_midi_thread_work (void *arg);
1403         void          midi_thread_work ();
1404         void          change_midi_ports ();
1405         int           use_config_midi_ports ();
1406
1407         void set_play_loop (bool yn);
1408         void overwrite_some_buffers (Diskstream*);
1409         void flush_all_inserts ();
1410         int  micro_locate (nframes_t distance);
1411         void locate (nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1412         void start_locate (nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1413         void force_locate (nframes_t frame, bool with_roll = false);
1414         void set_diskstream_speed (Diskstream*, double speed);
1415         void set_transport_speed (double speed, bool abort = false);
1416         void stop_transport (bool abort = false);
1417         void start_transport ();
1418         void realtime_stop (bool abort);
1419         void non_realtime_start_scrub ();
1420         void non_realtime_set_speed ();
1421         void non_realtime_locate ();
1422         void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1423         void non_realtime_overwrite (int entry_request_count, bool& finished);
1424         void butler_transport_work ();
1425         void post_transport ();
1426         void engine_halted ();
1427         void xrun_recovery ();
1428
1429         TempoMap    *_tempo_map;
1430         void          tempo_map_changed (Change);
1431
1432         /* edit/mix groups */
1433
1434         int load_route_groups (const XMLNode&);
1435
1436         std::list<RouteGroup *> _route_groups;
1437
1438         /* disk-streams */
1439
1440         SerializedRCUManager<DiskstreamList>  diskstreams;
1441
1442         uint32_t audio_dstream_buffer_size;
1443         uint32_t midi_dstream_buffer_size;
1444         int load_diskstreams (const XMLNode&);
1445
1446         /* routes stuff */
1447
1448         SerializedRCUManager<RouteList>  routes;
1449
1450         void add_routes (RouteList&, bool save);
1451         uint32_t destructive_index;
1452
1453         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&);
1454
1455         /* mixer stuff */
1456
1457         bool solo_update_disabled;
1458
1459         void route_listen_changed (void *src, boost::weak_ptr<Route>);
1460         void route_mute_changed (void *src);
1461         void route_solo_changed (void *src, boost::weak_ptr<Route>);
1462         void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1463
1464         void listen_position_changed ();
1465         void solo_control_mode_changed ();
1466
1467         /* REGION MANAGEMENT */
1468
1469         std::map<std::string,uint32_t> region_name_map;
1470         void update_region_name_map (boost::shared_ptr<Region>);
1471
1472         mutable Glib::Mutex region_lock;
1473         typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionList;
1474         RegionList regions;
1475
1476         void add_region (boost::shared_ptr<Region>);
1477         void region_changed (Change, boost::weak_ptr<Region>);
1478         void remove_region (boost::weak_ptr<Region>);
1479
1480         int load_regions (const XMLNode& node);
1481
1482         void route_group_changed ();
1483
1484         /* SOURCES */
1485
1486         mutable Glib::Mutex source_lock;
1487         typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1488
1489         SourceMap sources;
1490
1491   public:
1492         SourceMap get_sources() { return sources; }
1493
1494   private:
1495         int load_sources (const XMLNode& node);
1496         XMLNode& get_sources_as_xml ();
1497
1498         boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1499
1500         /* PLAYLISTS */
1501
1502         mutable Glib::Mutex playlist_lock;
1503         typedef std::set<boost::shared_ptr<Playlist> > PlaylistList;
1504         PlaylistList playlists;
1505         PlaylistList unused_playlists;
1506
1507         int load_playlists (const XMLNode&);
1508         int load_unused_playlists (const XMLNode&);
1509         void remove_playlist (boost::weak_ptr<Playlist>);
1510         void track_playlist (bool, boost::weak_ptr<Playlist>);
1511
1512         boost::shared_ptr<Playlist> playlist_factory (std::string name);
1513         boost::shared_ptr<Playlist> XMLPlaylistFactory (const XMLNode&);
1514
1515         void playlist_length_changed ();
1516         void diskstream_playlist_changed (boost::shared_ptr<Diskstream>);
1517
1518         /* NAMED SELECTIONS */
1519
1520         mutable Glib::Mutex named_selection_lock;
1521         typedef std::set<NamedSelection *> NamedSelectionList;
1522         NamedSelectionList named_selections;
1523
1524         int load_named_selections (const XMLNode&);
1525
1526         NamedSelection *named_selection_factory (std::string name);
1527         NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1528
1529         /* CURVES and AUTOMATION LISTS */
1530         std::map<PBD::ID, AutomationList*> automation_lists;
1531
1532         /* DEFAULT FADE CURVES */
1533
1534         float default_fade_steepness;
1535         float default_fade_msecs;
1536
1537         /* AUDITIONING */
1538
1539         boost::shared_ptr<Auditioner> auditioner;
1540         void set_audition (boost::shared_ptr<Region>);
1541         void non_realtime_set_audition ();
1542         boost::shared_ptr<Region> pending_audition_region;
1543
1544         /* EXPORT */
1545
1546         /* FLATTEN */
1547
1548         int flatten_one_track (AudioTrack&, nframes_t start, nframes_t cnt);
1549
1550         /* INSERT AND SEND MANAGEMENT */
1551
1552         boost::dynamic_bitset<uint32_t> send_bitset;
1553         boost::dynamic_bitset<uint32_t> return_bitset;
1554         boost::dynamic_bitset<uint32_t> insert_bitset;
1555
1556         void add_processor (Processor *);
1557         void remove_processor (Processor *);
1558
1559         /* S/W RAID */
1560
1561         struct space_and_path {
1562                 uint32_t blocks; /* 4kB blocks */
1563                 std::string path;
1564
1565                 space_and_path() {
1566                         blocks = 0;
1567                 }
1568         };
1569
1570         struct space_and_path_ascending_cmp {
1571                 bool operator() (space_and_path a, space_and_path b) {
1572                         return a.blocks > b.blocks;
1573                 }
1574         };
1575
1576         void setup_raid_path (std::string path);
1577
1578         std::vector<space_and_path> session_dirs;
1579         std::vector<space_and_path>::iterator last_rr_session_dir;
1580         uint32_t _total_free_4k_blocks;
1581         Glib::Mutex space_lock;
1582
1583         std::string get_best_session_directory_for_new_source ();
1584         void refresh_disk_space ();
1585
1586         mutable gint _playback_load;
1587         mutable gint _capture_load;
1588         mutable gint _playback_load_min;
1589         mutable gint _capture_load_min;
1590
1591         /* I/O bundles */
1592
1593         SerializedRCUManager<BundleList> _bundles;
1594         XMLNode* _bundle_xml_node;
1595         int load_bundles (XMLNode const &);
1596
1597         void reverse_diskstream_buffers ();
1598
1599         UndoHistory                  _history;
1600         std::stack<UndoTransaction*> _current_trans;
1601
1602         GlobalRouteBooleanState get_global_route_boolean (bool (Route::*method)(void) const);
1603         GlobalRouteMeterState get_global_route_metering ();
1604
1605         void set_global_route_boolean (GlobalRouteBooleanState s, void (Route::*method)(bool, void*), void *arg);
1606         void set_global_route_metering (GlobalRouteMeterState s, void *arg);
1607
1608         void set_global_mute (GlobalRouteBooleanState s, void *src);
1609         void set_global_solo (GlobalRouteBooleanState s, void *src);
1610         void set_global_record_enable (GlobalRouteBooleanState s, void *src);
1611
1612         void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
1613         int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
1614         void reset_jack_connection (jack_client_t* jack);
1615         void record_enable_change_all (bool yn);
1616
1617         XMLNode& state(bool);
1618
1619         /* click track */
1620
1621         struct Click {
1622                 nframes_t start;
1623                 nframes_t duration;
1624                 nframes_t offset;
1625                 const Sample *data;
1626
1627                 Click (nframes_t s, nframes_t d, const Sample *b)
1628                         : start (s), duration (d), data (b) { offset = 0; }
1629
1630                 void *operator new(size_t ignored) {
1631                         return pool.alloc ();
1632                 };
1633
1634                 void operator delete(void *ptr, size_t size) {
1635                         pool.release (ptr);
1636                 }
1637
1638           private:
1639                 static Pool pool;
1640         };
1641
1642         typedef std::list<Click*> Clicks;
1643
1644         Clicks                 clicks;
1645         bool                  _clicking;
1646         boost::shared_ptr<IO> _click_io;
1647         Sample*                click_data;
1648         Sample*                click_emphasis_data;
1649         nframes_t              click_length;
1650         nframes_t              click_emphasis_length;
1651         mutable Glib::RWLock   click_lock;
1652
1653         static const Sample    default_click[];
1654         static const nframes_t default_click_length;
1655         static const Sample    default_click_emphasis[];
1656         static const nframes_t default_click_emphasis_length;
1657
1658         Click *get_click();
1659         void   setup_click_sounds (int which);
1660         void   clear_clicks ();
1661         void   click (nframes_t start, nframes_t nframes);
1662
1663         std::vector<Route*> master_outs;
1664
1665         /* range playback */
1666
1667         std::list<AudioRange> current_audio_range;
1668         bool _play_range;
1669         void set_play_range (bool yn);
1670         void setup_auto_play ();
1671
1672         /* main outs */
1673         uint32_t main_outs;
1674
1675         boost::shared_ptr<Route> _master_out;
1676         boost::shared_ptr<Route> _control_out;
1677
1678         gain_t* _gain_automation_buffer;
1679         pan_t** _pan_automation_buffer;
1680         void allocate_pan_automation_buffers (nframes_t nframes, uint32_t howmany, bool force);
1681         uint32_t _npan_buffers;
1682
1683         /* VST support */
1684
1685         long _vst_callback (VSTPlugin*,
1686                         long opcode,
1687                         long index,
1688                         long value,
1689                         void* ptr,
1690                         float opt);
1691
1692         /* number of hardware ports we're using,
1693            based on max (requested,available)
1694         */
1695
1696         uint32_t n_physical_outputs;
1697         uint32_t n_physical_inputs;
1698
1699         uint32_t n_physical_audio_outputs;
1700         uint32_t n_physical_audio_inputs;
1701
1702         uint32_t n_physical_midi_outputs;
1703         uint32_t n_physical_midi_inputs;
1704
1705         int find_all_sources (std::string path, std::set<std::string>& result);
1706         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1707
1708         typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1709         Glib::Mutex controllables_lock;
1710         Controllables controllables;
1711
1712         void reset_native_file_format();
1713         bool first_file_data_format_reset;
1714         bool first_file_header_format_reset;
1715
1716         void config_changed (std::string, bool);
1717
1718         XMLNode& get_control_protocol_state ();
1719
1720         void set_history_depth (uint32_t depth);
1721         void sync_order_keys ();
1722
1723         static bool _disable_all_loaded_plugins;
1724
1725         SessionMetadata * _metadata;
1726
1727         mutable bool have_looped; ///< Used in ::audible_frame(*)
1728
1729         void update_have_rec_enabled_diskstream ();
1730         gint _have_rec_enabled_diskstream;
1731 };
1732
1733 } // namespace ARDOUR
1734
1735 #endif /* __ardour_session_h__ */