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
 481         static int rename_template (string old_name, string new_name);
 482
 483         static int delete_template (string name);
 484
 485         sigc::signal<void,string> StateSaved;
 486         sigc::signal<void> StateReady;
 487
 488         vector<string*>* possible_states() const;
 489         static vector<string*>* possible_states(string path);
 490
 491         XMLNode& get_state();
 492         int      set_state(const XMLNode& node); // not idempotent
 493         XMLNode& get_template();
 494
 495         void add_instant_xml (XMLNode&, const std::string& dir);
 496
 497         enum StateOfTheState {
 498                 Clean = 0x0,
 499                 Dirty = 0x1,
 500                 CannotSave = 0x2,
 501                 Deletion = 0x4,
 502                 InitialConnecting = 0x8,
 503                 Loading = 0x10,
 504                 InCleanup = 0x20
 505         };
 506
 507         StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 508
 509         RouteGroup* add_edit_group (string);
 510         RouteGroup* add_mix_group (string);
 511
 512         void remove_edit_group (RouteGroup&);
 513         void remove_mix_group (RouteGroup&);
 514
 515         RouteGroup *mix_group_by_name (string);
 516         RouteGroup *edit_group_by_name (string);
 517
 518         sigc::signal<void,RouteGroup*> edit_group_added;
 519         sigc::signal<void,RouteGroup*> mix_group_added;
 520         sigc::signal<void> edit_group_removed;
 521         sigc::signal<void> mix_group_removed;
 522
 523         void foreach_edit_group (sigc::slot<void,RouteGroup*> sl) {
 524                 for (list<RouteGroup *>::iterator i = edit_groups.begin(); i != edit_groups.end(); i++) {
 525                         sl (*i);
 526                 }
 527         }
 528
 529         void foreach_mix_group (sigc::slot<void,RouteGroup*> sl) {
 530                 for (list<RouteGroup *>::iterator i = mix_groups.begin(); i != mix_groups.end(); i++) {
 531                         sl (*i);
 532                 }
 533         }
 534
 535         /* fundamental operations. duh. */
 536
 537         boost::shared_ptr<AudioTrack> new_audio_track (int input_channels, int output_channels, TrackMode mode = Normal);
 538         boost::shared_ptr<Route>      new_audio_route (int input_channels, int output_channels);
 539
 540         void   remove_route (boost::shared_ptr<Route>);
 541
 542         void   resort_routes ();
 543         void   resort_routes_using (boost::shared_ptr<RouteList>);
 544
 545         AudioEngine &engine() { return _engine; };
 546
 547         /* configuration. there should really be accessors/mutators
 548            for these
 549         */
 550
 551         float   meter_hold () { return _meter_hold; }
 552         void    set_meter_hold (float);
 553         sigc::signal<void> MeterHoldChanged;
 554
 555         float   meter_falloff () { return _meter_falloff; }
 556         void    set_meter_falloff (float);
 557         sigc::signal<void> MeterFalloffChanged;
 558
 559         int32_t  max_level;
 560         int32_t  min_level;
 561         string  click_emphasis_sound;
 562         string  click_sound;
 563         bool    click_requested;
 564         jack_nframes_t over_length_short;
 565         jack_nframes_t over_length_long;
 566         bool    send_midi_timecode;
 567         bool    send_midi_machine_control;
 568         float   shuttle_speed_factor;
 569         float   shuttle_speed_threshold;
 570         float   rf_speed;
 571         float   smpte_frames_per_second;
 572         bool    smpte_drop_frames;
 573         AnyTime preroll;
 574         AnyTime postroll;
 575
 576         /* Time */
 577
 578         jack_nframes_t transport_frame () const {return _transport_frame; }
 579         jack_nframes_t audible_frame () const;
 580
 581         int  set_smpte_type (float fps, bool drop_frames);
 582
 583         void bbt_time (jack_nframes_t when, BBT_Time&);
 584         void smpte_to_sample( SMPTE::Time& smpte, jack_nframes_t& sample, bool use_offset, bool use_subframes ) const;
 585         void sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const;
 586         void smpte_time (SMPTE::Time &);
 587         void smpte_time (jack_nframes_t when, SMPTE::Time&);
 588         void smpte_time_subframes (jack_nframes_t when, SMPTE::Time&);
 589
 590         void smpte_duration (jack_nframes_t, SMPTE::Time&) const;
 591         void smpte_duration_string (char *, jack_nframes_t) const;
 592
 593         void           set_smpte_offset (jack_nframes_t);
 594         jack_nframes_t smpte_offset () const { return _smpte_offset; }
 595         void           set_smpte_offset_negative (bool);
 596         bool           smpte_offset_negative () const { return _smpte_offset_negative; }
 597
 598         jack_nframes_t convert_to_frames_at (jack_nframes_t position, AnyTime&);
 599
 600         static sigc::signal<void> SMPTEOffsetChanged;
 601         sigc::signal<void> SMPTETypeChanged;
 602
 603         void        request_slave_source (SlaveSource, jack_nframes_t pos = 0);
 604         SlaveSource slave_source() const { return _slave_type; }
 605         bool        synced_to_jack() const { return _slave_type == JACK; }
 606         float       transport_speed() const { return _transport_speed; }
 607         bool        transport_stopped() const { return _transport_speed == 0.0f; }
 608         bool        transport_rolling() const { return _transport_speed != 0.0f; }
 609
 610         int jack_slave_sync (jack_nframes_t);
 611
 612         TempoMap& tempo_map() { return *_tempo_map; }
 613
 614         /* region info  */
 615
 616         sigc::signal<void,AudioRegion *> AudioRegionAdded;
 617         sigc::signal<void,AudioRegion *> AudioRegionRemoved;
 618
 619         int region_name (string& result, string base = string(""), bool newlevel = false) const;
 620         string new_region_name (string);
 621         string path_from_region_name (string name, string identifier);
 622
 623         AudioRegion* find_whole_file_parent (AudioRegion&);
 624         void find_equivalent_playlist_regions (Region&, std::vector<Region*>& result);
 625
 626         AudioRegion *XMLRegionFactory (const XMLNode&, bool full);
 627
 628         template<class T> void foreach_audio_region (T *obj, void (T::*func)(AudioRegion *));
 629
 630         /* source management */
 631
 632         struct import_status : public InterThreadInfo {
 633             string doing_what;
 634
 635             /* control info */
 636             bool multichan;
 637             bool sample_convert;
 638             volatile bool freeze;
 639             string pathname;
 640
 641             /* result */
 642             std::vector<AudioRegion*> new_regions;
 643
 644         };
 645
 646         int import_audiofile (import_status&);
 647         bool sample_rate_convert (import_status&, string infile, string& outfile);
 648         string build_tmp_convert_name (string file);
 649
 650         Session::SlaveSource post_export_slave;
 651         jack_nframes_t post_export_position;
 652
 653         int start_audio_export (ARDOUR::AudioExportSpecification&);
 654         int stop_audio_export (ARDOUR::AudioExportSpecification&);
 655
 656         void add_audio_source (AudioSource *);
 657         void remove_source (Source *);
 658         int  cleanup_audio_file_source (AudioFileSource&);
 659
 660         struct cleanup_report {
 661             vector<string> paths;
 662             int32_t space;
 663         };
 664
 665         int  cleanup_sources (cleanup_report&);
 666         int  cleanup_trash_sources (cleanup_report&);
 667
 668         int destroy_region (Region*);
 669         int destroy_regions (list<Region*>);
 670
 671         int remove_last_capture ();
 672
 673         /* handlers should return -1 for "stop cleanup", 0 for
 674            "yes, delete this playlist" and 1 for "no, don't delete
 675            this playlist.
 676         */
 677
 678         sigc::signal<int,ARDOUR::Playlist*> AskAboutPlaylistDeletion;
 679
 680
 681         /* handlers should return !0 for use pending state, 0 for
 682            ignore it.
 683         */
 684
 685         static sigc::signal<int> AskAboutPendingState;
 686
 687         sigc::signal<void,Source *> SourceAdded;
 688         sigc::signal<void,Source *> SourceRemoved;
 689
 690         AudioFileSource *create_audio_source_for_session (ARDOUR::AudioDiskstream&, uint32_t which_channel, bool destructive);
 691
 692         Source *source_by_id (const PBD::ID&);
 693
 694         /* playlist management */
 695
 696         Playlist* playlist_by_name (string name);
 697         void add_playlist (Playlist *);
 698         sigc::signal<void,Playlist*> PlaylistAdded;
 699         sigc::signal<void,Playlist*> PlaylistRemoved;
 700
 701         uint32_t n_playlists() const;
 702
 703         template<class T> void foreach_playlist (T *obj, void (T::*func)(Playlist *));
 704
 705         /* named selections */
 706
 707         NamedSelection* named_selection_by_name (string name);
 708         void add_named_selection (NamedSelection *);
 709         void remove_named_selection (NamedSelection *);
 710
 711         template<class T> void foreach_named_selection (T& obj, void (T::*func)(NamedSelection&));
 712         sigc::signal<void> NamedSelectionAdded;
 713         sigc::signal<void> NamedSelectionRemoved;
 714
 715         /* fade curves */
 716
 717         float get_default_fade_length () const { return default_fade_msecs; }
 718         float get_default_fade_steepness () const { return default_fade_steepness; }
 719         void set_default_fade (float steepness, float msecs);
 720
 721         /* auditioning */
 722
 723         boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
 724         void audition_playlist ();
 725         void audition_region (Region&);
 726         void cancel_audition ();
 727         bool is_auditioning () const;
 728
 729         sigc::signal<void,bool> AuditionActive;
 730
 731         /* flattening stuff */
 732
 733         int write_one_audio_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt, bool overwrite, vector<AudioSource*>&,
 734                                    InterThreadInfo& wot);
 735         int freeze (InterThreadInfo&);
 736
 737         /* session-wide solo/mute/rec-enable */
 738
 739         enum SoloModel {
 740                 InverseMute,
 741                 SoloBus
 742         };
 743
 744         bool soloing() const { return currently_soloing; }
 745
 746         SoloModel solo_model() const { return _solo_model; }
 747         void set_solo_model (SoloModel);
 748
 749         bool solo_latched() const { return _solo_latched; }
 750         void set_solo_latched (bool yn);
 751
 752         void set_all_solo (bool);
 753         void set_all_mute (bool);
 754
 755         sigc::signal<void,bool> SoloActive;
 756
 757         void record_disenable_all ();
 758         void record_enable_all ();
 759
 760         /* control/master out */
 761
 762         boost::shared_ptr<IO> control_out() const { return _control_out; }
 763         boost::shared_ptr<IO> master_out() const { return _master_out; }
 764
 765         /* insert/send management */
 766
 767         uint32_t n_port_inserts() const { return _port_inserts.size(); }
 768         uint32_t n_plugin_inserts() const { return _plugin_inserts.size(); }
 769         uint32_t n_sends() const { return _sends.size(); }
 770
 771         string next_send_name();
 772         string next_insert_name();
 773
 774         /* s/w "RAID" management */
 775
 776         jack_nframes_t available_capture_duration();
 777
 778         /* I/O Connections */
 779
 780         template<class T> void foreach_connection (T *obj, void (T::*func)(Connection *));
 781         void add_connection (Connection *);
 782         void remove_connection (Connection *);
 783         Connection *connection_by_name (string) const;
 784
 785         sigc::signal<void,Connection *> ConnectionAdded;
 786         sigc::signal<void,Connection *> ConnectionRemoved;
 787
 788         /* MIDI */
 789
 790         int set_mtc_port (string port_tag);
 791         int set_mmc_port (string port_tag);
 792         int set_midi_port (string port_tag);
 793         MIDI::Port *mtc_port() const { return _mtc_port; }
 794         MIDI::Port *mmc_port() const { return _mmc_port; }
 795         MIDI::Port *midi_port() const { return _midi_port; }
 796
 797         sigc::signal<void> MTC_PortChanged;
 798         sigc::signal<void> MMC_PortChanged;
 799         sigc::signal<void> MIDI_PortChanged;
 800
 801         void set_trace_midi_input (bool, MIDI::Port* port = 0);
 802         void set_trace_midi_output (bool, MIDI::Port* port = 0);
 803
 804         bool get_trace_midi_input(MIDI::Port *port = 0);
 805         bool get_trace_midi_output(MIDI::Port *port = 0);
 806
 807         void send_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
 808
 809         void deliver_midi (MIDI::Port*, MIDI::byte*, int32_t size);
 810
 811         /* Scrubbing */
 812
 813         void start_scrub (jack_nframes_t where);
 814         void stop_scrub ();
 815         void set_scrub_speed (float);
 816         jack_nframes_t scrub_buffer_size() const;
 817         sigc::signal<void> ScrubReady;
 818
 819         /* History (for editors, mixers, UIs etc.) */
 820
 821         void undo (uint32_t n) {
 822                 history.undo (n);
 823         }
 824         void redo (uint32_t n) {
 825                 history.redo (n);
 826         }
 827
 828         uint32_t undo_depth() const { return history.undo_depth(); }
 829         uint32_t redo_depth() const { return history.redo_depth(); }
 830         string next_undo() const { return history.next_undo(); }
 831         string next_redo() const { return history.next_redo(); }
 832
 833         void begin_reversible_command (string cmd_name);
 834         void commit_reversible_command (Command* cmd = 0);
 835
 836         void add_command (Command *const cmd) {
 837                 current_trans.add_command (cmd);
 838         }
 839
 840         // these commands are implemented in libs/ardour/session_command.cc
 841         class GlobalSoloStateCommand : public Command
 842         {
 843             GlobalRouteBooleanState before, after;
 844             void *src;
 845             Session &sess;
 846         public:
 847             GlobalSoloStateCommand(Session &, void *src);
 848             void operator()();
 849             void undo();
 850             XMLNode &serialize();
 851             void mark();
 852         };
 853
 854         class GlobalMuteStateCommand : public Command
 855         {
 856             GlobalRouteBooleanState before, after;
 857             void *src;
 858             Session &sess;
 859         public:
 860             GlobalMuteStateCommand(Session &, void *src);
 861             void operator()();
 862             void undo();
 863             XMLNode &serialize();
 864             void mark();
 865         };
 866
 867         class GlobalRecordEnableStateCommand : public Command
 868         {
 869             GlobalRouteBooleanState before, after;
 870             void *src;
 871             Session &sess;
 872         public:
 873             GlobalRecordEnableStateCommand(Session &, void *src);
 874             void operator()();
 875             void undo();
 876             XMLNode &serialize();
 877             void mark();
 878         };
 879
 880         class GlobalMeteringStateCommand : public Command
 881         {
 882             GlobalRouteMeterState before, after;
 883             void *src;
 884             Session &sess;
 885         public:
 886             GlobalMeteringStateCommand(Session &, void *src);
 887             void operator()();
 888             void undo();
 889             XMLNode &serialize();
 890             void mark();
 891         };
 892
 893         /* edit mode */
 894
 895         void set_edit_mode (EditMode);
 896         EditMode get_edit_mode () const { return _edit_mode; }
 897
 898         /* clicking */
 899
 900         boost::shared_ptr<IO>  click_io() { return _click_io; }
 901         void set_clicking (bool yn);
 902         bool get_clicking() const;
 903
 904         void set_click_sound (string path);
 905         void set_click_emphasis_sound (string path);
 906
 907         /* tempo FX */
 908
 909         struct TimeStretchRequest {
 910             ARDOUR::AudioRegion* region;
 911             float                fraction; /* session: read ; GUI: write */
 912             float                progress; /* session: write ; GUI: read */
 913             bool                 running;  /* read/write */
 914             bool                 quick_seek; /* GUI: write */
 915             bool                 antialias;  /* GUI: write */
 916
 917             TimeStretchRequest () : region (0) {}
 918         };
 919
 920         AudioRegion* tempoize_region (TimeStretchRequest&);
 921
 922         string raid_path() const;
 923         void   set_raid_path(string);
 924
 925         /* need to call this whenever we change native file formats */
 926
 927         void reset_native_file_format();
 928
 929         /* disk, buffer loads */
 930
 931         uint32_t playback_load ();
 932         uint32_t capture_load ();
 933         uint32_t playback_load_min ();
 934         uint32_t capture_load_min ();
 935
 936         void reset_playback_load_min ();
 937         void reset_capture_load_min ();
 938
 939         float read_data_rate () const;
 940         float write_data_rate () const;
 941
 942         /* ranges */
 943
 944         void set_audio_range (list<AudioRange>&);
 945         void set_music_range (list<MusicRange>&);
 946
 947         void request_play_range (bool yn);
 948         bool get_play_range () const { return _play_range; }
 949
 950         /* favorite dirs */
 951         typedef vector<string> FavoriteDirs;
 952
 953         static int read_favorite_dirs (FavoriteDirs&);
 954
 955         static int write_favorite_dirs (FavoriteDirs&);
 956
 957         /* file suffixes */
 958
 959         static const char* template_suffix() { return _template_suffix; }
 960         static const char* statefile_suffix() { return _statefile_suffix; }
 961         static const char* pending_suffix() { return _pending_suffix; }
 962
 963         /* buffers for gain and pan */
 964
 965         gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
 966         pan_t** pan_automation_buffer() const { return _pan_automation_buffer; }
 967
 968         /* buffers for conversion */
 969         enum RunContext {
 970                 ButlerContext = 0,
 971                 TransportContext,
 972                 ExportContext
 973         };
 974
 975         char *  conversion_buffer(RunContext context) { return _conversion_buffers[context]; }
 976
 977         /* VST support */
 978
 979         static long vst_callback (AEffect* effect,
 980                                   long opcode,
 981                                   long index,
 982                                   long value,
 983                                   void* ptr,
 984                                   float opt);
 985
 986         typedef float (*compute_peak_t)                         (Sample *, jack_nframes_t, float);
 987         typedef void  (*apply_gain_to_buffer_t)         (Sample *, jack_nframes_t, float);
 988         typedef void  (*mix_buffers_with_gain_t)        (Sample *, Sample *, jack_nframes_t, float);
 989         typedef void  (*mix_buffers_no_gain_t)          (Sample *, Sample *, jack_nframes_t);
 990
 991         static compute_peak_t                   compute_peak;
 992         static apply_gain_to_buffer_t   apply_gain_to_buffer;
 993         static mix_buffers_with_gain_t  mix_buffers_with_gain;
 994         static mix_buffers_no_gain_t    mix_buffers_no_gain;
 995
 996         static sigc::signal<void> SendFeedback;
 997
 998         /* Controllables */
 999
1000         PBD::Controllable* controllable_by_id (const PBD::ID&);
1001
1002   protected:
1003         friend class AudioEngine;
1004         void set_block_size (jack_nframes_t nframes);
1005         void set_frame_rate (jack_nframes_t nframes);
1006
1007   protected:
1008         friend class Diskstream;
1009         void stop_butler ();
1010         void wait_till_butler_finished();
1011
1012   protected:
1013         friend class Route;
1014         void schedule_curve_reallocation ();
1015         void update_latency_compensation (bool, bool);
1016
1017   private:
1018         int  create (bool& new_session, string* mix_template, jack_nframes_t initial_length);
1019
1020         static const char* _template_suffix;
1021         static const char* _statefile_suffix;
1022         static const char* _pending_suffix;
1023
1024         enum SubState {
1025                 PendingDeclickIn   = 0x1,
1026                 PendingDeclickOut  = 0x2,
1027                 StopPendingCapture = 0x4,
1028                 AutoReturning      = 0x10,
1029                 PendingLocate      = 0x20,
1030                 PendingSetLoop     = 0x40
1031         };
1032
1033         /* stuff used in process() should be close together to
1034            maximise cache hits
1035         */
1036
1037         typedef void (Session::*process_function_type)(jack_nframes_t);
1038
1039         AudioEngine            &_engine;
1040         mutable gint            processing_prohibited;
1041         process_function_type    process_function;
1042         process_function_type    last_process_function;
1043         jack_nframes_t          _current_frame_rate;
1044         int                      transport_sub_state;
1045         mutable gint           _record_status;
1046         jack_nframes_t          _transport_frame;
1047         Location*                end_location;
1048         Location*                start_location;
1049         Slave                  *_slave;
1050         SlaveSource             _slave_type;
1051         volatile float          _transport_speed;
1052         volatile float          _desired_transport_speed;
1053         float                   _last_transport_speed;
1054         jack_nframes_t          _last_slave_transport_frame;
1055         jack_nframes_t           maximum_output_latency;
1056         jack_nframes_t           last_stop_frame;
1057         vector<Sample *>        _passthru_buffers;
1058         vector<Sample *>        _silent_buffers;
1059         vector<Sample *>        _send_buffers;
1060         map<RunContext,char*>   _conversion_buffers;
1061         jack_nframes_t           current_block_size;
1062         jack_nframes_t          _worst_output_latency;
1063         jack_nframes_t          _worst_input_latency;
1064         jack_nframes_t          _worst_track_latency;
1065         bool                    _have_captured;
1066         float                   _meter_hold;
1067         float                   _meter_falloff;
1068         bool                    _end_location_is_free;
1069
1070         void set_worst_io_latencies ();
1071         void set_worst_io_latencies_x (IOChange asifwecare, void *ignored) {
1072                 set_worst_io_latencies ();
1073         }
1074
1075         void update_latency_compensation_proxy (void* ignored);
1076
1077         void ensure_passthru_buffers (uint32_t howmany);
1078
1079         void process_scrub          (jack_nframes_t);
1080         void process_without_events (jack_nframes_t);
1081         void process_with_events    (jack_nframes_t);
1082         void process_audition       (jack_nframes_t);
1083         int  process_export         (jack_nframes_t, ARDOUR::AudioExportSpecification*);
1084
1085         /* slave tracking */
1086
1087         static const int delta_accumulator_size = 25;
1088         int delta_accumulator_cnt;
1089         long delta_accumulator[delta_accumulator_size];
1090         long average_slave_delta;
1091         int  average_dir;
1092         bool have_first_delta_accumulator;
1093
1094         enum SlaveState {
1095                 Stopped,
1096                 Waiting,
1097                 Running
1098         };
1099
1100         SlaveState slave_state;
1101         jack_nframes_t slave_wait_end;
1102
1103         void reset_slave_state ();
1104         bool follow_slave (jack_nframes_t, jack_nframes_t);
1105
1106         bool _exporting;
1107         int prepare_to_export (ARDOUR::AudioExportSpecification&);
1108
1109         void prepare_diskstreams ();
1110         void commit_diskstreams (jack_nframes_t, bool& session_requires_butler);
1111         int  process_routes (jack_nframes_t, jack_nframes_t);
1112         int  silent_process_routes (jack_nframes_t, jack_nframes_t);
1113
1114         bool get_rec_monitors_input () {
1115                 if (actively_recording()) {
1116                         return true;
1117                 } else {
1118                         if (auto_input) {
1119                                 return false;
1120                         } else {
1121                                 return true;
1122                         }
1123                 }
1124         }
1125
1126         int get_transport_declick_required () {
1127
1128                 if (transport_sub_state & PendingDeclickIn) {
1129                         transport_sub_state &= ~PendingDeclickIn;
1130                         return 1;
1131                 } else if (transport_sub_state & PendingDeclickOut) {
1132                         return -1;
1133                 } else {
1134                         return 0;
1135                 }
1136         }
1137
1138         bool maybe_stop (jack_nframes_t limit) {
1139                 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1140                         stop_transport ();
1141                         return true;
1142                 }
1143                 return false;
1144         }
1145
1146         void check_declick_out ();
1147
1148         MIDI::MachineControl*    mmc;
1149         MIDI::Port*             _mmc_port;
1150         MIDI::Port*             _mtc_port;
1151         MIDI::Port*             _midi_port;
1152         string                  _path;
1153         string                  _name;
1154         bool                     do_not_record_plugins;
1155
1156         /* toggles */
1157
1158         bool auto_play;
1159         bool punch_in;
1160         bool punch_out;
1161         bool auto_loop;
1162         bool seamless_loop;
1163         bool loop_changing;
1164         jack_nframes_t last_loopend;
1165         bool auto_input;
1166         bool crossfades_active;
1167         bool all_safe;
1168         bool auto_return;
1169         bool monitor_in;
1170         bool send_mtc;
1171         bool send_mmc;
1172         bool mmc_control;
1173         bool midi_control;
1174
1175         RingBuffer<Event*> pending_events;
1176
1177         void hookup_io ();
1178         void when_engine_running ();
1179         sigc::connection first_time_running;
1180         void graph_reordered ();
1181
1182         string _current_snapshot_name;
1183
1184         XMLTree* state_tree;
1185         bool     state_was_pending;
1186         StateOfTheState _state_of_the_state;
1187
1188         void     auto_save();
1189         int      load_options (const XMLNode&);
1190         XMLNode& get_options () const;
1191         int      load_state (string snapshot_name);
1192
1193         jack_nframes_t   _last_roll_location;
1194         jack_nframes_t   _last_record_location;
1195         bool              pending_locate_roll;
1196         jack_nframes_t    pending_locate_frame;
1197
1198         bool              pending_locate_flush;
1199         bool              pending_abort;
1200         bool              pending_auto_loop;
1201
1202         Sample*           butler_mixdown_buffer;
1203         float*            butler_gain_buffer;
1204         pthread_t         butler_thread;
1205         Glib::Mutex       butler_request_lock;
1206         Glib::Cond        butler_paused;
1207         bool              butler_should_run;
1208         mutable gint      butler_should_do_transport_work;
1209         int               butler_request_pipe[2];
1210
1211         struct ButlerRequest {
1212             enum Type {
1213                     Wake,
1214                     Run,
1215                     Pause,
1216                     Quit
1217             };
1218         };
1219
1220         enum PostTransportWork {
1221                 PostTransportStop               = 0x1,
1222                 PostTransportDisableRecord      = 0x2,
1223                 PostTransportPosition           = 0x8,
1224                 PostTransportDidRecord          = 0x20,
1225                 PostTransportDuration           = 0x40,
1226                 PostTransportLocate             = 0x80,
1227                 PostTransportRoll               = 0x200,
1228                 PostTransportAbort              = 0x800,
1229                 PostTransportOverWrite          = 0x1000,
1230                 PostTransportSpeed              = 0x2000,
1231                 PostTransportAudition           = 0x4000,
1232                 PostTransportScrub              = 0x8000,
1233                 PostTransportReverse            = 0x10000,
1234                 PostTransportInputChange        = 0x20000,
1235                 PostTransportCurveRealloc       = 0x40000
1236         };
1237
1238         static const PostTransportWork ProcessCannotProceedMask =
1239                 PostTransportWork (PostTransportInputChange|
1240                                    PostTransportSpeed|
1241                                    PostTransportReverse|
1242                                    PostTransportCurveRealloc|
1243                                    PostTransportScrub|
1244                                    PostTransportAudition|
1245                                    PostTransportLocate|
1246                                    PostTransportStop);
1247
1248         PostTransportWork post_transport_work;
1249
1250         void             summon_butler ();
1251         void             schedule_butler_transport_work ();
1252         int              start_butler_thread ();
1253         void             terminate_butler_thread ();
1254         static void    *_butler_thread_work (void *arg);
1255         void*            butler_thread_work ();
1256
1257         uint32_t    cumulative_rf_motion;
1258         uint32_t    rf_scale;
1259
1260         void set_rf_speed (float speed);
1261         void reset_rf_scale (jack_nframes_t frames_moved);
1262
1263         Locations        _locations;
1264         void              locations_changed ();
1265         void              locations_added (Location*);
1266         void              handle_locations_changed (Locations::LocationList&);
1267
1268         sigc::connection auto_punch_start_changed_connection;
1269         sigc::connection auto_punch_end_changed_connection;
1270         sigc::connection auto_punch_changed_connection;
1271         void             auto_punch_start_changed (Location *);
1272         void             auto_punch_end_changed (Location *);
1273         void             auto_punch_changed (Location *);
1274
1275         sigc::connection auto_loop_start_changed_connection;
1276         sigc::connection auto_loop_end_changed_connection;
1277         sigc::connection auto_loop_changed_connection;
1278         void             auto_loop_changed (Location *);
1279
1280         typedef list<Event *> Events;
1281         Events           events;
1282         Events           immediate_events;
1283         Events::iterator next_event;
1284
1285         /* there can only ever be one of each of these */
1286
1287         Event *auto_loop_event;
1288         Event *punch_out_event;
1289         Event *punch_in_event;
1290
1291         /* events */
1292
1293         void dump_events () const;
1294         void queue_event (Event *ev);
1295         void merge_event (Event*);
1296         void replace_event (Event::Type, jack_nframes_t action_frame, jack_nframes_t target = 0);
1297         bool _replace_event (Event*);
1298         bool _remove_event (Event *);
1299         void _clear_event_type (Event::Type);
1300
1301         void first_stage_init (string path, string snapshot_name);
1302         int  second_stage_init (bool new_tracks);
1303         void find_current_end ();
1304         void remove_empty_sounds ();
1305
1306         void setup_midi_control ();
1307         int  midi_read (MIDI::Port *);
1308
1309         void enable_record ();
1310
1311         void increment_transport_position (uint32_t val) {
1312                 if (max_frames - val < _transport_frame) {
1313                         _transport_frame = max_frames;
1314                 } else {
1315                         _transport_frame += val;
1316                 }
1317         }
1318
1319         void decrement_transport_position (uint32_t val) {
1320                 if (val < _transport_frame) {
1321                         _transport_frame -= val;
1322                 } else {
1323                         _transport_frame = 0;
1324                 }
1325         }
1326
1327         void post_transport_motion ();
1328         static void *session_loader_thread (void *arg);
1329
1330         void *do_work();
1331
1332         void set_next_event ();
1333         void process_event (Event *);
1334
1335         /* MIDI Machine Control */
1336
1337         void deliver_mmc (MIDI::MachineControl::Command, jack_nframes_t);
1338         void deliver_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
1339         void deliver_data (MIDI::Port* port, MIDI::byte*, int32_t size);
1340
1341         void spp_start (MIDI::Parser&);
1342         void spp_continue (MIDI::Parser&);
1343         void spp_stop (MIDI::Parser&);
1344
1345         void mmc_deferred_play (MIDI::MachineControl &);
1346         void mmc_stop (MIDI::MachineControl &);
1347         void mmc_step (MIDI::MachineControl &, int);
1348         void mmc_pause (MIDI::MachineControl &);
1349         void mmc_record_pause (MIDI::MachineControl &);
1350         void mmc_record_strobe (MIDI::MachineControl &);
1351         void mmc_record_exit (MIDI::MachineControl &);
1352         void mmc_track_record_status (MIDI::MachineControl &,
1353                                       uint32_t track, bool enabled);
1354         void mmc_fast_forward (MIDI::MachineControl &);
1355         void mmc_rewind (MIDI::MachineControl &);
1356         void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1357         void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1358         void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1359
1360         struct timeval last_mmc_step;
1361         double step_speed;
1362
1363         typedef sigc::slot<bool> MidiTimeoutCallback;
1364         typedef list<MidiTimeoutCallback> MidiTimeoutList;
1365
1366         MidiTimeoutList midi_timeouts;
1367         bool mmc_step_timeout ();
1368
1369         MIDI::byte mmc_buffer[32];
1370         MIDI::byte mtc_msg[16];
1371         MIDI::byte mtc_smpte_bits;   /* encoding of SMTPE type for MTC */
1372         MIDI::byte midi_msg[16];
1373         jack_nframes_t  outbound_mtc_smpte_frame;
1374         SMPTE::Time transmitting_smpte_time;
1375         int next_quarter_frame_to_send;
1376
1377         double _frames_per_smpte_frame; /* has to be floating point because of drop frame */
1378         jack_nframes_t _frames_per_hour;
1379         jack_nframes_t _smpte_frames_per_hour;
1380         jack_nframes_t _smpte_offset;
1381         bool _smpte_offset_negative;
1382
1383         /* cache the most-recently requested time conversions.
1384            this helps when we have multiple clocks showing the
1385            same time (e.g. the transport frame)
1386         */
1387
1388         bool       last_smpte_valid;
1389         jack_nframes_t  last_smpte_when;
1390         SMPTE::Time last_smpte;
1391
1392         int send_full_time_code ();
1393         int send_midi_time_code ();
1394
1395         void send_full_time_code_in_another_thread ();
1396         void send_midi_time_code_in_another_thread ();
1397         void send_time_code_in_another_thread (bool full);
1398         void send_mmc_in_another_thread (MIDI::MachineControl::Command, jack_nframes_t frame = 0);
1399
1400         jack_nframes_t adjust_apparent_position (jack_nframes_t frames);
1401
1402         void reset_record_status ();
1403
1404         int no_roll (jack_nframes_t nframes, jack_nframes_t offset);
1405
1406         bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work); }
1407         bool process_can_proceed() const { return !(post_transport_work & ProcessCannotProceedMask); }
1408
1409         struct MIDIRequest {
1410
1411             enum Type {
1412                     SendFullMTC,
1413                     SendMTC,
1414                     SendMMC,
1415                     PortChange,
1416                     SendMessage,
1417                     Deliver,
1418                     Quit
1419             };
1420
1421             Type type;
1422             MIDI::MachineControl::Command mmc_cmd;
1423             jack_nframes_t locate_frame;
1424
1425             // for SendMessage type
1426
1427             MIDI::Port * port;
1428             MIDI::channel_t chan;
1429             union {
1430                 MIDI::EventTwoBytes data;
1431                 MIDI::byte* buf;
1432             };
1433
1434             union {
1435                 MIDI::eventType ev;
1436                 int32_t size;
1437             };
1438
1439             MIDIRequest () {}
1440
1441             void *operator new(size_t ignored) {
1442                     return pool.alloc ();
1443             };
1444
1445             void operator delete(void *ptr, size_t size) {
1446                     pool.release (ptr);
1447             }
1448
1449           private:
1450             static MultiAllocSingleReleasePool pool;
1451         };
1452
1453         Glib::Mutex       midi_lock;
1454         pthread_t       midi_thread;
1455         int             midi_request_pipe[2];
1456         mutable  gint   butler_active;
1457         RingBuffer<MIDIRequest*> midi_requests;
1458
1459         int           start_midi_thread ();
1460         void          terminate_midi_thread ();
1461         void          poke_midi_thread ();
1462         static void *_midi_thread_work (void *arg);
1463         void          midi_thread_work ();
1464         void          change_midi_ports ();
1465         int           use_config_midi_ports ();
1466
1467         bool waiting_to_start;
1468
1469         void set_auto_loop (bool yn);
1470         void overwrite_some_buffers (Diskstream*);
1471         void flush_all_redirects ();
1472         void locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1473         void start_locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1474         void force_locate (jack_nframes_t frame, bool with_roll = false);
1475         void set_diskstream_speed (Diskstream*, float speed);
1476         void set_transport_speed (float speed, bool abort = false);
1477         void stop_transport (bool abort = false);
1478         void start_transport ();
1479         void actually_start_transport ();
1480         void realtime_stop (bool abort);
1481         void non_realtime_start_scrub ();
1482         void non_realtime_set_speed ();
1483         void non_realtime_stop (bool abort);
1484         void non_realtime_overwrite ();
1485         void non_realtime_buffer_fill ();
1486         void butler_transport_work ();
1487         void post_transport ();
1488         void engine_halted ();
1489         void xrun_recovery ();
1490
1491         TempoMap    *_tempo_map;
1492         void          tempo_map_changed (Change);
1493
1494         /* edit/mix groups */
1495
1496         int load_route_groups (const XMLNode&, bool is_edit);
1497         int load_edit_groups (const XMLNode&);
1498         int load_mix_groups (const XMLNode&);
1499
1500
1501         list<RouteGroup *> edit_groups;
1502         list<RouteGroup *> mix_groups;
1503
1504         /* disk-streams */
1505
1506         DiskstreamList  diskstreams;
1507         mutable Glib::RWLock diskstream_lock;
1508         uint32_t dstream_buffer_size;
1509         void add_diskstream (Diskstream*);
1510         int  load_diskstreams (const XMLNode&);
1511
1512         /* routes stuff */
1513
1514         SerializedRCUManager<RouteList>  routes;
1515
1516         void   add_route (boost::shared_ptr<Route>);
1517         uint32_t destructive_index;
1518
1519         int load_routes (const XMLNode&);
1520         boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&);
1521
1522         /* mixer stuff */
1523
1524         bool      _solo_latched;
1525         SoloModel _solo_model;
1526         bool       solo_update_disabled;
1527         bool       currently_soloing;
1528
1529         void route_mute_changed (void *src);
1530         void route_solo_changed (void *src, boost::shared_ptr<Route>);
1531         void catch_up_on_solo ();
1532         void update_route_solo_state ();
1533         void modify_solo_mute (bool, bool);
1534         void strip_portname_for_solo (string& portname);
1535
1536         /* REGION MANAGEMENT */
1537
1538         mutable Glib::Mutex region_lock;
1539         typedef map<PBD::ID,AudioRegion *> AudioRegionList;
1540         AudioRegionList audio_regions;
1541
1542         void region_renamed (Region *);
1543         void region_changed (Change, Region *);
1544         void add_region (Region *);
1545         void remove_region (Region *);
1546
1547         int load_regions (const XMLNode& node);
1548
1549         /* SOURCES */
1550
1551         mutable Glib::Mutex audio_source_lock;
1552         typedef std::map<PBD::ID,AudioSource *> AudioSourceList;
1553
1554         AudioSourceList audio_sources;
1555
1556         int load_sources (const XMLNode& node);
1557         XMLNode& get_sources_as_xml ();
1558
1559         Source *XMLSourceFactory (const XMLNode&);
1560
1561         /* PLAYLISTS */
1562
1563         mutable Glib::Mutex playlist_lock;
1564         typedef set<Playlist *> PlaylistList;
1565         PlaylistList playlists;
1566         PlaylistList unused_playlists;
1567
1568         int load_playlists (const XMLNode&);
1569         int load_unused_playlists (const XMLNode&);
1570         void remove_playlist (Playlist *);
1571         void track_playlist (Playlist *, bool);
1572
1573         Playlist *playlist_factory (string name);
1574         Playlist *XMLPlaylistFactory (const XMLNode&);
1575
1576         void playlist_length_changed (Playlist *);
1577         void diskstream_playlist_changed (Diskstream *);
1578
1579         /* NAMED SELECTIONS */
1580
1581         mutable Glib::Mutex named_selection_lock;
1582         typedef set<NamedSelection *> NamedSelectionList;
1583         NamedSelectionList named_selections;
1584
1585         int load_named_selections (const XMLNode&);
1586
1587         NamedSelection *named_selection_factory (string name);
1588         NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1589
1590         /* DEFAULT FADE CURVES */
1591
1592         float default_fade_steepness;
1593         float default_fade_msecs;
1594
1595         /* AUDITIONING */
1596
1597         boost::shared_ptr<Auditioner> auditioner;
1598         void set_audition (AudioRegion*);
1599         void non_realtime_set_audition ();
1600         AudioRegion *pending_audition_region;
1601
1602         /* EXPORT */
1603
1604         /* FLATTEN */
1605
1606         int flatten_one_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt);
1607
1608         /* INSERT AND SEND MANAGEMENT */
1609
1610         list<PortInsert *>   _port_inserts;
1611         list<PluginInsert *> _plugin_inserts;
1612         list<Send *>         _sends;
1613         uint32_t          send_cnt;
1614         uint32_t          insert_cnt;
1615
1616         void add_redirect (Redirect *);
1617         void remove_redirect (Redirect *);
1618
1619         /* S/W RAID */
1620
1621         struct space_and_path {
1622             uint32_t blocks; /* 4kB blocks */
1623             string path;
1624
1625             space_and_path() {
1626                     blocks = 0;
1627             }
1628         };
1629
1630         struct space_and_path_ascending_cmp {
1631             bool operator() (space_and_path a, space_and_path b) {
1632                     return a.blocks > b.blocks;
1633             }
1634         };
1635
1636         void setup_raid_path (string path);
1637
1638         vector<space_and_path> session_dirs;
1639         vector<space_and_path>::iterator last_rr_session_dir;
1640         uint32_t _total_free_4k_blocks;
1641         Glib::Mutex space_lock;
1642
1643         static const char* sound_dir_name;
1644         static const char* tape_dir_name;
1645         static const char* dead_sound_dir_name;
1646         static const char* peak_dir_name;
1647
1648         string discover_best_sound_dir (bool destructive = false);
1649         int ensure_sound_dir (string, string&);
1650         void refresh_disk_space ();
1651
1652         mutable gint _playback_load;
1653         mutable gint _capture_load;
1654         mutable gint _playback_load_min;
1655         mutable gint _capture_load_min;
1656
1657         /* I/O Connections */
1658
1659         typedef list<Connection *> ConnectionList;
1660         mutable Glib::Mutex connection_lock;
1661         ConnectionList _connections;
1662         int load_connections (const XMLNode&);
1663
1664         int set_slave_source (SlaveSource, jack_nframes_t);
1665
1666         void reverse_diskstream_buffers ();
1667
1668         UndoHistory history;
1669         UndoTransaction current_trans;
1670
1671         GlobalRouteBooleanState get_global_route_boolean (bool (Route::*method)(void) const);
1672         GlobalRouteMeterState get_global_route_metering ();
1673
1674         void set_global_route_boolean (GlobalRouteBooleanState s, void (Route::*method)(bool, void*), void *arg);
1675         void set_global_route_metering (GlobalRouteMeterState s, void *arg);
1676
1677         void set_global_mute (GlobalRouteBooleanState s, void *src);
1678         void set_global_solo (GlobalRouteBooleanState s, void *src);
1679         void set_global_record_enable (GlobalRouteBooleanState s, void *src);
1680
1681         void jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int);
1682         int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
1683         void record_enable_change_all (bool yn);
1684
1685         XMLNode& state(bool);
1686
1687         /* click track */
1688
1689         struct Click {
1690             jack_nframes_t start;
1691             jack_nframes_t duration;
1692             jack_nframes_t offset;
1693             const Sample *data;
1694
1695             Click (jack_nframes_t s, jack_nframes_t d, const Sample *b)
1696                     : start (s), duration (d), data (b) { offset = 0; }
1697
1698             void *operator new(size_t ignored) {
1699                     return pool.alloc ();
1700             };
1701
1702             void operator delete(void *ptr, size_t size) {
1703                     pool.release (ptr);
1704             }
1705
1706           private:
1707             static Pool pool;
1708         };
1709
1710         typedef list<Click*> Clicks;
1711
1712         Clicks          clicks;
1713         bool           _clicking;
1714         boost::shared_ptr<IO> _click_io;
1715         Sample*         click_data;
1716         Sample*         click_emphasis_data;
1717         jack_nframes_t  click_length;
1718         jack_nframes_t  click_emphasis_length;
1719         mutable Glib::RWLock click_lock;
1720
1721         static const Sample         default_click[];
1722         static const jack_nframes_t default_click_length;
1723         static const Sample         default_click_emphasis[];
1724         static const jack_nframes_t default_click_emphasis_length;
1725
1726         Click *get_click();
1727         void   setup_click_sounds (int which);
1728         void   clear_clicks ();
1729         void   click (jack_nframes_t start, jack_nframes_t nframes, jack_nframes_t offset);
1730
1731         vector<Route*> master_outs;
1732
1733         EditMode _edit_mode;
1734         EditMode pending_edit_mode;
1735
1736         /* range playback */
1737
1738         list<AudioRange> current_audio_range;
1739         bool _play_range;
1740         void set_play_range (bool yn);
1741         void setup_auto_play ();
1742
1743         /* main outs */
1744         uint32_t main_outs;
1745
1746         boost::shared_ptr<IO> _master_out;
1747         boost::shared_ptr<IO> _control_out;
1748
1749         AutoConnectOption input_auto_connect;
1750         AutoConnectOption output_auto_connect;
1751
1752         gain_t* _gain_automation_buffer;
1753         pan_t** _pan_automation_buffer;
1754         void allocate_pan_automation_buffers (jack_nframes_t nframes, uint32_t howmany, bool force);
1755         uint32_t _npan_buffers;
1756
1757         /* VST support */
1758
1759         long _vst_callback (VSTPlugin*,
1760                             long opcode,
1761                             long index,
1762                             long value,
1763                             void* ptr,
1764                             float opt);
1765
1766         /* number of hardware audio ports we're using,
1767            based on max (requested,available)
1768         */
1769
1770         uint32_t n_physical_outputs;
1771         uint32_t n_physical_inputs;
1772
1773         void remove_pending_capture_state ();
1774
1775         int find_all_sources (std::string path, std::set<std::string>& result);
1776         int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1777
1778         LayerModel layer_model;
1779         CrossfadeModel xfade_model;
1780
1781         typedef std::list<PBD::Controllable*> Controllables;
1782         Glib::Mutex controllables_lock;
1783         Controllables controllables;
1784
1785         void add_controllable (PBD::Controllable*);
1786         void remove_controllable (PBD::Controllable*);
1787 };
1788
1789 } // namespace ARDOUR
1790
1791 #endif /* __ardour_session_h__ */