subtle changes to accomplish two goals (1) playhead should stop where the user presse...
[ardour.git] / libs / ardour / ardour / diskstream.h
index c0ea341e8f45e059db9d6c1a4b5b46e58ffc0540..c960e925c81046ce651a6288f34b90a027bde117 100644 (file)
@@ -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,8 +50,12 @@ class Source;
 class Session;
 class Track;
 class Location;
+class BufferSet;
 
-class Diskstream : public SessionObject, public PublicDiskstream
+/** 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 LIBARDOUR_API Diskstream : public SessionObject, public PublicDiskstream
 {
   public:
        enum Flag {
@@ -65,10 +70,25 @@ 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 *);
 
+       /** @return A number between 0 and 1, where 0 indicates that the playback buffer
+        *  is dry (ie the disk subsystem could not keep up) and 1 indicates that the
+        *  buffer is full.
+        */
        virtual float playback_buffer_load() const = 0;
        virtual float capture_buffer_load() const = 0;
 
@@ -125,7 +145,8 @@ class Diskstream : public SessionObject, public PublicDiskstream
        virtual XMLNode& get_state(void);
        virtual int      set_state(const XMLNode&, int version);
 
-       virtual void monitor_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 ();
@@ -153,6 +174,7 @@ class Diskstream : public SessionObject, public PublicDiskstream
        PBD::Signal0<void>            RecordEnableChanged;
        PBD::Signal0<void>            SpeedChanged;
        PBD::Signal0<void>            ReverseChanged;
+       /* Emitted when this diskstream is set to use a different playlist */
        PBD::Signal0<void>            PlaylistChanged;
        PBD::Signal0<void>            AlignmentStyleChanged;
        PBD::Signal1<void,Location *> LoopSet;
@@ -182,7 +204,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:
@@ -232,14 +255,22 @@ 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 calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
-                       framecnt_t& rec_nframes, framecnt_t& rec_offset);
+       void engage_record_enable ();
+       void disengage_record_enable ();
+
+        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;
        std::vector<CaptureInfo*> capture_info;
-       mutable Glib::Mutex capture_info_lock;
+       mutable Glib::Threads::Mutex capture_info_lock;
 
        uint32_t i_am_the_modifier;
 
@@ -271,7 +302,6 @@ class Diskstream : public SessionObject, public PublicDiskstream
        int           last_possibly_recording;
        AlignStyle   _alignment_style;
        AlignChoice  _alignment_choice;
-       bool         _scrubbing;
        bool         _slaved;
        Location*     loop_location;
        framepos_t    overwrite_frame;
@@ -291,7 +321,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;