introduce the idea of buffering presets, along with 3 possible settings (plus custom).

[ardour.git] / libs / ardour / ardour / diskstream.h

diff --git a/libs/ardour/ardour/diskstream.h b/libs/ardour/ardour/diskstream.h
index bbc3a85dbe9f40cbbd0ae771c0efe7d7bc4492dc..0e82459981d51e255b8ce3c1da361db1df8fca6c 100644 (file)
--- a/libs/ardour/ardour/diskstream.h
+++ b/libs/ardour/ardour/diskstream.h
@@ -34,6 +34,7 @@
 #include "ardour/ardour.h"
 #include "ardour/chan_count.h"
 #include "ardour/session_object.h"
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/utils.h"
 #include "ardour/public_diskstream.h"
@@ -49,11 +50,12 @@ class Source;
 class Session;
 class Track;
 class Location;
+class BufferSet;
 
 /** Parent class for classes which can stream data to and from disk.
  *  These are used by Tracks to get playback and put recorded data.
  */
-class Diskstream : public SessionObject, public PublicDiskstream
+class LIBARDOUR_API Diskstream : public SessionObject, public PublicDiskstream
 {
   public:
        enum Flag {
@@ -68,6 +70,17 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual ~Diskstream();
 
        virtual bool set_name (const std::string& str);
+       virtual bool set_write_source_name (const std::string& str);
+
+       std::string write_source_name () const {
+               if (_write_source_name.empty()) {
+                       return name();
+               } else {
+                       return _write_source_name;
+               }
+       }
+
+       virtual std::string steal_write_source_name () { return std::string(); }
 
        boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
        void set_track (ARDOUR::Track *);
@@ -91,7 +104,9 @@ class Diskstream : public SessionObject, public PublicDiskstream
        void       set_roll_delay (framecnt_t);
 
        bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
+       bool         record_safe () const { return g_atomic_int_get (&_record_safe); }
        virtual void set_record_enabled (bool yn) = 0;
+       virtual void set_record_safe (bool yn) = 0;
 
        bool destructive() const { return _flags & Destructive; }
        virtual int set_destructive (bool /*yn*/) { return -1; }
@@ -125,15 +140,21 @@ class Diskstream : public SessionObject, public PublicDiskstream
 
        ChanCount n_channels() { return _n_channels; }
 
-       static framecnt_t disk_io_frames() { return disk_io_chunk_frames; }
-       static void set_disk_io_chunk_frames (framecnt_t n) { disk_io_chunk_frames = n; }
+       static framecnt_t disk_read_frames() { return disk_read_chunk_frames; }
+       static framecnt_t disk_write_frames() { return disk_write_chunk_frames; }
+       static void set_disk_read_chunk_frames (framecnt_t n) { disk_read_chunk_frames = n; }
+       static void set_disk_write_chunk_frames (framecnt_t n) { disk_write_chunk_frames = n; }
+       static framecnt_t default_disk_read_chunk_frames ();
+       static framecnt_t default_disk_write_chunk_frames ();
+
+       static void set_buffering_parameters (BufferingPreset bp);
 
        /* Stateful */
        virtual XMLNode& get_state(void);
        virtual int      set_state(const XMLNode&, int version);
 
-       virtual void request_jack_monitors_input (bool) {}
-       virtual void ensure_jack_monitors_input (bool) {}
+       virtual void request_input_monitoring (bool) {}
+       virtual void ensure_input_monitoring (bool) {}
 
        framecnt_t   capture_offset() const { return _capture_offset; }
        virtual void set_capture_offset ();
@@ -159,6 +180,7 @@ class Diskstream : public SessionObject, public PublicDiskstream
        }
 
        PBD::Signal0<void>            RecordEnableChanged;
+       PBD::Signal0<void>            RecordSafeChanged;
        PBD::Signal0<void>            SpeedChanged;
        PBD::Signal0<void>            ReverseChanged;
        /* Emitted when this diskstream is set to use a different playlist */
@@ -191,7 +213,8 @@ class Diskstream : public SessionObject, public PublicDiskstream
   protected:
        friend class Track;
 
-       virtual int  process (framepos_t transport_frame, pframes_t nframes, framecnt_t &) = 0;
+    virtual int  process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
+    virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
        virtual bool commit  (framecnt_t) = 0;
 
        //private:
@@ -241,16 +264,26 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual void set_align_style_from_io() {}
        virtual void setup_destructive_playlist () {}
        virtual void use_destructive_playlist () {}
-       virtual void prepare_to_stop (framepos_t pos);
+       virtual void prepare_to_stop (framepos_t transport_pos, framepos_t audible_frame);
+
+       void engage_record_enable ();
+       void disengage_record_enable ();
+       void engage_record_safe ();
+       void disengage_record_safe ();
+
+        virtual bool prep_record_enable () = 0;
+        virtual bool prep_record_disable () = 0;
 
        void calculate_record_range (
                Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
                framecnt_t& rec_nframes, framecnt_t& rec_offset
                );
 
-       static framecnt_t disk_io_chunk_frames;
+       static framecnt_t disk_read_chunk_frames;
+       static framecnt_t disk_write_chunk_frames;
+
        std::vector<CaptureInfo*> capture_info;
-       mutable Glib::Mutex capture_info_lock;
+       mutable Glib::Threads::Mutex capture_info_lock;
 
        uint32_t i_am_the_modifier;
 
@@ -260,7 +293,8 @@ class Diskstream : public SessionObject, public PublicDiskstream
 
        boost::shared_ptr<Playlist> _playlist;
 
-       mutable gint _record_enabled;
+       gint         _record_enabled;
+       gint         _record_safe;
        double       _visible_speed;
        double       _actual_speed;
        /* items needed for speed change logic */
@@ -301,7 +335,9 @@ class Diskstream : public SessionObject, public PublicDiskstream
 
        bool          in_set_state;
 
-       Glib::Mutex state_lock;
+       std::string   _write_source_name;
+
+       Glib::Threads::Mutex state_lock;
 
        PBD::ScopedConnectionList playlist_connections;
 
@@ -311,6 +347,12 @@ class Diskstream : public SessionObject, public PublicDiskstream
        XMLNode* deprecated_io_node;
 
        void route_going_away ();
+
+       static bool get_buffering_presets (BufferingPreset bp,
+                                          framecnt_t& read_chunk_size,
+                                          framecnt_t& read_buffer_size,
+                                          framecnt_t& write_chunk_size,
+                                          framecnt_t& write_buffer_size);
 };
 
 }; /* namespace ARDOUR */