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