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