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