Move Diskstream ownership to Track, so that Session no longer holds lists of Diskstre...
[ardour.git] / libs / ardour / ardour / diskstream.h
index a835e4b57157f39280a7de130ced2527064e9124..97a512cf3f8b8bf38b13399c80efe85308332bf2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2006 Paul Davis 
+    Copyright (C) 2000-2006 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 #include <cmath>
 #include <time.h>
 
-#include <sigc++/signal.h>
-
 #include <boost/utility.hpp>
 
 #include "evoral/types.hpp"
 
-#include "pbd/fastlog.h"
-#include "pbd/ringbufferNPT.h"
-#include "pbd/stateful.h"
-#include "pbd/statefuldestructible.h" 
-
 #include "ardour/ardour.h"
-#include "ardour/configuration.h"
+#include "ardour/chan_count.h"
 #include "ardour/location.h"
 #include "ardour/session_object.h"
 #include "ardour/types.h"
 #include "ardour/utils.h"
-#include "ardour/chan_count.h"
+#include "ardour/public_diskstream.h"
 
 struct tm;
 
 namespace ARDOUR {
 
-class AudioEngine;
 class IO;
 class Playlist;
 class Processor;
 class Region;
-class Send;
 class Session;
+class Track;   
 
-class Diskstream : public SessionObject, public boost::noncopyable
-{      
+class Diskstream : public SessionObject, public PublicDiskstream
+{
   public:
        enum Flag {
                Recordable  = 0x1,
                Hidden      = 0x2,
-               Destructive = 0x4
+               Destructive = 0x4,
+               NonLayered   = 0x8
        };
 
-       Diskstream (Session &, const string& name, Flag f = Recordable);
+       Diskstream (Session &, const std::string& name, Flag f = Recordable);
        Diskstream (Session &, const XMLNode&);
        virtual ~Diskstream();
-       
-       bool set_name (const string& str);
 
-       ARDOUR::IO* io() const { return _io; }
-       void set_io (ARDOUR::IO& io);
+       bool set_name (const std::string& str);
+
+       boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
+       void set_track (ARDOUR::Track *);
 
        virtual float playback_buffer_load() const = 0;
        virtual float capture_buffer_load() const = 0;
@@ -85,28 +78,30 @@ class Diskstream : public SessionObject, public boost::noncopyable
        AlignStyle alignment_style() const { return _alignment_style; }
        void       set_align_style (AlignStyle);
        void       set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
-       
+
        nframes_t roll_delay() const { return _roll_delay; }
        void      set_roll_delay (nframes_t);
 
        bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
        virtual void set_record_enabled (bool yn) = 0;
+       virtual void get_input_sources () = 0;
 
        bool destructive() const { return _flags & Destructive; }
-       virtual int set_destructive (bool yn) { return -1; }
-       virtual bool can_become_destructive (bool& requires_bounce) const { return false; }
+       virtual int set_destructive (bool /*yn*/) { return -1; }
+       virtual int set_non_layered (bool /*yn*/) { return -1; }
+       virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
 
        bool           hidden()      const { return _flags & Hidden; }
        bool           recordable()  const { return _flags & Recordable; }
+       bool           non_layered()  const { return _flags & NonLayered; }
        bool           reversed()    const { return _actual_speed < 0.0f; }
        double         speed()       const { return _visible_speed; }
-       
+
        virtual void punch_in()  {}
        virtual void punch_out() {}
 
-       void set_speed (double);
        void non_realtime_set_speed ();
-       virtual void non_realtime_locate (nframes_t location) {};
+       virtual void non_realtime_locate (nframes_t /*location*/) {};
        virtual void playlist_modified ();
 
        boost::shared_ptr<Playlist> playlist () { return _playlist; }
@@ -119,7 +114,7 @@ class Diskstream : public SessionObject, public boost::noncopyable
        nframes_t current_capture_end()   const { return capture_start_frame + capture_captured; }
        nframes_t get_capture_start_frame (uint32_t n=0);
        nframes_t get_captured_frames (uint32_t n=0);
-       
+
        ChanCount n_channels() { return _n_channels; }
 
        static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
@@ -127,8 +122,8 @@ class Diskstream : public SessionObject, public boost::noncopyable
 
        /* Stateful */
        virtual XMLNode& get_state(void) = 0;
-       virtual int      set_state(const XMLNode& node) = 0;
-       
+       virtual int      set_state(const XMLNode&, int version) = 0;
+
        virtual void monitor_input (bool) {}
 
        nframes_t    capture_offset() const { return _capture_offset; }
@@ -146,20 +141,29 @@ class Diskstream : public SessionObject, public boost::noncopyable
        void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
 
        void move_processor_automation (boost::weak_ptr<Processor>,
-                       list< Evoral::RangeMove<nframes_t> > const &);
+                       std::list<Evoral::RangeMove<framepos_t> > const &);
+
+       /** For non-butler contexts (allocates temporary working buffers) */
+       virtual int do_refill_with_alloc() = 0;
+       virtual void set_block_size (nframes_t) = 0;
+
+       bool pending_overwrite () const {
+               return _pending_overwrite;
+       }
 
-       sigc::signal<void>            RecordEnableChanged;
-       sigc::signal<void>            SpeedChanged;
-       sigc::signal<void>            ReverseChanged;
-       sigc::signal<void>            PlaylistChanged;
-       sigc::signal<void>            AlignmentStyleChanged;
-       sigc::signal<void,Location *> LoopSet;
+       PBD::Signal0<void>            RecordEnableChanged;
+       PBD::Signal0<void>            SpeedChanged;
+       PBD::Signal0<void>            ReverseChanged;
+       PBD::Signal0<void>            PlaylistChanged;
+       PBD::Signal0<void>            AlignmentStyleChanged;
+       PBD::Signal1<void,Location *> LoopSet;
 
-       static sigc::signal<void>     DiskOverrun;
-       static sigc::signal<void>     DiskUnderrun;
+       static PBD::Signal0<void>     DiskOverrun;
+       static PBD::Signal0<void>     DiskUnderrun;
 
   protected:
        friend class Session;
+       friend class Butler;
 
        /* the Session is the only point of access for these because they require
         * that the Session is "inactive" while they are called.
@@ -167,7 +171,6 @@ class Diskstream : public SessionObject, public boost::noncopyable
 
        virtual void set_pending_overwrite (bool) = 0;
        virtual int  overwrite_existing_buffers () = 0;
-       virtual void set_block_size (nframes_t) = 0;
        virtual int  internal_playback_seek (nframes_t distance) = 0;
        virtual int  can_internal_playback_seek (nframes_t distance) = 0;
        virtual int  rename_write_sources () = 0;
@@ -184,18 +187,16 @@ class Diskstream : public SessionObject, public boost::noncopyable
   protected:
        friend class Track;
 
-       virtual void prepare ();
-       virtual int  process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
+       virtual int  process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler) = 0;
        virtual bool commit  (nframes_t nframes) = 0;
-       virtual void recover (); /* called if commit will not be called, but process was */
 
        //private:
-       
+
        enum TransitionType {
                CaptureStart = 0,
                CaptureEnd
        };
-       
+
        struct CaptureTransition {
                TransitionType   type;
                nframes_t   capture_val; ///< The start or end file frame position
@@ -204,29 +205,24 @@ class Diskstream : public SessionObject, public boost::noncopyable
        /* The two central butler operations */
        virtual int do_flush (RunContext context, bool force = false) = 0;
        virtual int do_refill () = 0;
-       
-       /** For non-butler contexts (allocates temporary working buffers) */
-       virtual int do_refill_with_alloc() = 0;
-       
+
        /* XXX fix this redundancy ... */
 
-       virtual void playlist_changed (Change);
+       virtual void playlist_changed (const PBD::PropertyChange&);
        virtual void playlist_deleted (boost::weak_ptr<Playlist>);
-       virtual void playlist_ranges_moved (list< Evoral::RangeMove<nframes_t> > const &);
+       virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &);
 
-       virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
+       virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
        virtual void transport_looped (nframes_t transport_frame) = 0;
 
        struct CaptureInfo {
-           uint32_t start;
-           uint32_t frames;
+               uint32_t start;
+               uint32_t frames;
        };
 
-       virtual void init (Flag);
-
        virtual int use_new_write_source (uint32_t n=0) = 0;
 
-       virtual int find_and_use_playlist (const string&) = 0;
+       virtual int find_and_use_playlist (const std::string&) = 0;
 
        virtual void allocate_temporary_buffers () = 0;
 
@@ -236,11 +232,15 @@ class Diskstream : public SessionObject, public boost::noncopyable
 
        virtual int use_pending_capture_data (XMLNode& node) = 0;
 
-       virtual void get_input_sources () = 0;
-       virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record) = 0;
+       virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
+       virtual void prepare_record_status (nframes_t /*capture_start_frame*/) {}
        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);
+
+       void calculate_record_range(OverlapType ot, sframes_t transport_frame, nframes_t nframes,
+                       nframes_t& rec_nframes, nframes_t& rec_offset);
 
        static nframes_t disk_io_chunk_frames;
        std::vector<CaptureInfo*>  capture_info;
@@ -248,7 +248,8 @@ class Diskstream : public SessionObject, public boost::noncopyable
 
        uint32_t i_am_the_modifier;
 
-       ARDOUR::IO*  _io;
+       boost::shared_ptr<ARDOUR::IO>  _io;
+       Track*       _track;
        ChanCount    _n_channels;
 
        boost::shared_ptr<Playlist> _playlist;
@@ -259,7 +260,7 @@ class Diskstream : public SessionObject, public boost::noncopyable
        /* items needed for speed change logic */
        bool         _buffer_reallocation_required;
        bool         _seek_required;
-       
+
        bool          force_refill;
        nframes_t     capture_start_frame;
        nframes_t     capture_captured;
@@ -273,28 +274,21 @@ class Diskstream : public SessionObject, public boost::noncopyable
        AlignStyle   _alignment_style;
        bool         _scrubbing;
        bool         _slaved;
-       bool         _processed;
        Location*     loop_location;
        nframes_t     overwrite_frame;
        off_t         overwrite_offset;
-       bool          pending_overwrite;
+       bool          _pending_overwrite;
        bool          overwrite_queued;
        IOChange      input_change_pending;
        nframes_t     wrap_buffer_size;
        nframes_t     speed_buffer_size;
 
-       uint64_t      last_phase;
-       
-       /// diskstream speed in 40.24 fixed point math
-       uint64_t      phi;
-       
-       /// target diskstream speed in 40.24 fixed point math
-       uint64_t      target_phi;
-       
-       nframes_t     file_frame;               
+       double        _speed;
+       double        _target_speed;
+
+       nframes_t     file_frame;
        nframes_t     playback_sample;
        nframes_t     playback_distance;
-       bool          commit_should_unlock;
 
        uint32_t     _read_data_count;
        uint32_t     _write_data_count;
@@ -309,12 +303,13 @@ class Diskstream : public SessionObject, public boost::noncopyable
        nframes_t scrub_buffer_size;
        nframes_t scrub_offset;
 
-       sigc::connection ports_created_c;
-       sigc::connection plmod_connection;
-       sigc::connection plgone_connection;
-       sigc::connection plregion_connection;
-       
+       PBD::ScopedConnectionList playlist_connections;
+
+       PBD::ScopedConnection ic_connection;
+
        Flag _flags;
+
+       void route_going_away ();
 };
 
 }; /* namespace ARDOUR */