new tempo handling from drmoore; don't follow playhead when doing requested_return...
[ardour.git] / libs / ardour / ardour / region.h
index 3773a3b893fe21a52c03d2aa36a4cddebdb8dc7e..3aae8c47677fd826e14caa9b1a2b8612049d2b75 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_region_h__
 #define __ardour_region_h__
 
+#include <boost/shared_ptr.hpp>
+#include <boost/enable_shared_from_this.hpp>
+
 #include <pbd/undo.h>
+#include <pbd/statefuldestructible.h> 
 
 #include <ardour/ardour.h>
-#include <ardour/state_manager.h>
 
 class XMLNode;
 
 namespace ARDOUR {
 
 class Playlist;
-class Source;
 
 enum RegionEditState {
        EditChangesNothing = 0,
@@ -39,21 +40,7 @@ enum RegionEditState {
        EditChangesID      = 2
 };
 
-struct RegionState : public StateManager::State
-{
-       RegionState (std::string why) : StateManager::State (why) {}
-
-       jack_nframes_t          _start;
-       jack_nframes_t          _length;
-       jack_nframes_t          _position;
-       uint32_t                _flags;
-       jack_nframes_t          _sync_position;
-       layer_t                 _layer;
-       string                  _name;        
-       mutable RegionEditState _first_edit;
-};
-
-class Region : public Stateful, public StateManager
+class Region : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Region>
 {
   public:
        enum Flag {
@@ -89,34 +76,41 @@ class Region : public Stateful, public StateManager
        static Change LayerChanged;
        static Change HiddenChanged;
 
-       Region (jack_nframes_t start, jack_nframes_t length, 
-               const string& name, layer_t = 0, Flag flags = DefaultFlags);
-       Region (const Region&, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
-       Region (const Region&);
-       Region (const XMLNode&);
-       virtual ~Region();
+       sigc::signal<void,Change> StateChanged;
 
-       const PBD::ID& id() const { return _id; }
+       virtual ~Region();
 
        /* Note: changing the name of a Region does not constitute an edit */
 
        string name() const { return _name; }
        void set_name (string str);
 
-       jack_nframes_t position () const { return _position; }
-       jack_nframes_t start ()    const { return _start; }
-       jack_nframes_t length()    const { return _length; }
-       layer_t        layer ()    const { return _layer; }
-       
-       jack_nframes_t sync_offset(int& dir) const;
-       jack_nframes_t sync_position() const;
+       nframes_t position () const { return _position; }
+       nframes_t start ()    const { return _start; }
+       nframes_t length()    const { return _length; }
+       layer_t   layer ()    const { return _layer; }
+
+       /* these two are valid ONLY during a StateChanged signal handler */
+
+       nframes_t last_position() const { return _last_position; }
+       nframes_t last_length() const { return _last_length; }
+
+       nframes64_t ancestral_start () const { return _ancestral_start; }
+       nframes64_t ancestral_length () const { return _ancestral_length; }
+       float stretch() const { return _stretch; }
+       float shift() const { return _shift; }
+
+       void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
+
+       nframes_t sync_offset(int& dir) const;
+       nframes_t sync_position() const;
 
-       jack_nframes_t adjust_to_sync (jack_nframes_t);
+       nframes_t adjust_to_sync (nframes_t);
        
        /* first_frame() is an alias; last_frame() just hides some math */
 
-       jack_nframes_t first_frame() const { return _position; }
-       jack_nframes_t last_frame() const { return _position + _length - 1; }
+       nframes_t first_frame() const { return _position; }
+       nframes_t last_frame() const { return _position + _length - 1; }
 
        bool hidden()     const { return _flags & Hidden; }
        bool muted()      const { return _flags & Muted; }
@@ -131,37 +125,38 @@ class Region : public Stateful, public StateManager
        void freeze ();
        void thaw (const string& why);
 
-       bool covers (jack_nframes_t frame) const {
-               return _position <= frame && frame < _position + _length;
+       bool covers (nframes_t frame) const {
+               return first_frame() <= frame && frame <= last_frame();
        }
 
-       OverlapType coverage (jack_nframes_t start, jack_nframes_t end) const {
-               return ARDOUR::coverage (_position, _position + _length - 1, start, end);
+       OverlapType coverage (nframes_t start, nframes_t end) const {
+               return ARDOUR::coverage (first_frame(), last_frame(), start, end);
        }
        
-       bool equivalent (const Region&) const;
-       bool size_equivalent (const Region&) const;
-       bool overlap_equivalent (const Region&) const;
-       bool region_list_equivalent (const Region&) const;
-       virtual bool source_equivalent (const Region&) const = 0;
+       bool equivalent (boost::shared_ptr<const Region>) const;
+       bool size_equivalent (boost::shared_ptr<const Region>) const;
+       bool overlap_equivalent (boost::shared_ptr<const Region>) const;
+       bool region_list_equivalent (boost::shared_ptr<const Region>) const;
+       virtual bool source_equivalent (boost::shared_ptr<const Region>) const = 0;
        
        virtual bool speed_mismatch (float) const = 0;
 
        /* EDITING OPERATIONS */
 
-       void set_length (jack_nframes_t, void *src);
-       void set_start (jack_nframes_t, void *src);
-       void set_position (jack_nframes_t, void *src);
-       void set_position_on_top (jack_nframes_t, void *src);
-       void special_set_position (jack_nframes_t);
-       void nudge_position (long, void *src);
+       void set_length (nframes_t, void *src);
+       void set_start (nframes_t, void *src);
+       void set_position (nframes_t, void *src);
+       void set_position_on_top (nframes_t, void *src);
+       void special_set_position (nframes_t);
+       void nudge_position (nframes64_t, void *src);
 
+       bool at_natural_position () const;
        void move_to_natural_position (void *src);
 
-       void trim_start (jack_nframes_t new_position, void *src);
-       void trim_front (jack_nframes_t new_position, void *src);
-       void trim_end (jack_nframes_t new_position, void *src);
-       void trim_to (jack_nframes_t position, jack_nframes_t length, void *src);
+       void trim_start (nframes_t new_position, void *src);
+       void trim_front (nframes_t new_position, void *src);
+       void trim_end (nframes_t new_position, void *src);
+       void trim_to (nframes_t position, nframes_t length, void *src);
        
        void set_layer (layer_t l); /* ONLY Playlist can call this */
        void raise ();
@@ -169,88 +164,79 @@ class Region : public Stateful, public StateManager
        void raise_to_top ();
        void lower_to_bottom ();
 
-       void set_sync_position (jack_nframes_t n);
+       void set_sync_position (nframes_t n);
        void clear_sync_position ();
        void set_hidden (bool yn);
        void set_muted (bool yn);
-       void set_opaque (bool yn);
+        void set_opaque (bool yn);
        void set_locked (bool yn);
 
        virtual uint32_t read_data_count() const { return _read_data_count; }
 
-       ARDOUR::Playlist* playlist() const { return _playlist; }
-
-       virtual UndoAction get_memento() const = 0;
-
-       void set_playlist (ARDOUR::Playlist*);
-
-       virtual void lock_sources () {}
-       virtual void unlock_sources () {}
+       boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
+       virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 
        /* serialization */
        
        XMLNode&         get_state ();
        virtual XMLNode& state (bool);
        virtual int      set_state (const XMLNode&);
+       virtual int      set_live_state (const XMLNode&, Change&, bool send);
 
-       sigc::signal<void,Region*> GoingAway;
-
-       /* This is emitted only when a new id is assigned. Therefore,
-          in a pure Region copy, it will not be emitted.
-
-          It must be emitted by derived classes, not Region
-          itself, to permit dynamic_cast<> to be used to 
-          infer the type of Region.
-       */
-
-       static sigc::signal<void,Region*> CheckNewRegion;
-
-       virtual Region* get_parent() = 0;
+       virtual boost::shared_ptr<Region> get_parent() const = 0;
        
        uint64_t last_layer_op() const { return _last_layer_op; }
        void set_last_layer_op (uint64_t when);
 
   protected:
-       XMLNode& get_short_state (); /* used only by Session */
+       friend class RegionFactory;
 
-       /* state management */
+       Region (nframes_t start, nframes_t length, 
+               const string& name, layer_t = 0, Flag flags = DefaultFlags);
+       Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
+       Region (boost::shared_ptr<const Region>);
+       Region (const XMLNode&);
 
-       void send_change (Change);
 
-       /* derived classes need these during their own state management calls */
+  protected:
+       XMLNode& get_short_state (); /* used only by Session */
+
+       void send_change (Change);
 
-       void   store_state (RegionState&) const;
-       Change restore_and_return_flags (RegionState&);
-       
-       void trim_to_internal (jack_nframes_t position, jack_nframes_t length, void *src);
+       void trim_to_internal (nframes_t position, nframes_t length, void *src);
 
        bool copied() const { return _flags & Copied; }
        void maybe_uncopy ();
        void first_edit ();
        
-       virtual bool verify_start (jack_nframes_t) = 0;
-       virtual bool verify_start_and_length (jack_nframes_t, jack_nframes_t) = 0;
-       virtual bool verify_start_mutable (jack_nframes_t&_start) = 0;
-       virtual bool verify_length (jack_nframes_t) = 0;
+       virtual bool verify_start (nframes_t) = 0;
+       virtual bool verify_start_and_length (nframes_t, nframes_t&) = 0;
+       virtual bool verify_start_mutable (nframes_t&_start) = 0;
+       virtual bool verify_length (nframes_t&) = 0;
        virtual void recompute_at_start () = 0;
        virtual void recompute_at_end () = 0;
        
        
-       jack_nframes_t          _start;
-       jack_nframes_t          _length;
-       jack_nframes_t          _position;
-       Flag                     _flags;
-       jack_nframes_t          _sync_position;
+       nframes_t               _start;
+       nframes_t               _length;
+       nframes_t               _last_length;
+       nframes_t               _position;
+       nframes_t               _last_position;
+       Flag                    _flags;
+       nframes_t               _sync_position;
        layer_t                 _layer;
        string                  _name;        
        mutable RegionEditState _first_edit;
        int                     _frozen;
        Glib::Mutex             lock;
-       PBD::ID                 _id;
-       ARDOUR::Playlist*       _playlist;
+       boost::weak_ptr<ARDOUR::Playlist> _playlist;
        mutable uint32_t        _read_data_count; // modified in read()
        Change                   pending_changed;
        uint64_t                _last_layer_op; // timestamp
+       nframes64_t             _ancestral_start;
+       nframes64_t             _ancestral_length;
+       float                   _stretch;
+       float                   _shift;
 };
 
 } /* namespace ARDOUR */