Merge with 2.0-ongoing R3082.
[ardour.git] / libs / ardour / ardour / region.h
index 496dc7874ebed8d416fbab9bb291753d460dcd80..4196aac886bea1799af86bf39ae4146589c44bfe 100644 (file)
 #include <boost/enable_shared_from_this.hpp>
 
 #include <pbd/undo.h>
-#include <pbd/statefuldestructible.h> 
 
 #include <ardour/ardour.h>
 #include <ardour/data_type.h>
+#include <ardour/automatable.h>
+#include <ardour/readable.h>
 
 class XMLNode;
 
@@ -36,6 +37,7 @@ namespace ARDOUR {
 
 class Playlist;
 class Filter;
+class ExportSpecification;
 
 enum RegionEditState {
        EditChangesNothing = 0,
@@ -43,7 +45,7 @@ enum RegionEditState {
        EditChangesID      = 2
 };
 
-class Region : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Region>
+class Region : public Automatable, public boost::enable_shared_from_this<Region>, public Readable
 {
   public:
        typedef std::vector<boost::shared_ptr<Source> > SourceList;
@@ -72,6 +74,11 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
                range_guarantoor = USHRT_MAX
        };
 
+       enum PositionLockStyle {
+               AudioTime,
+               MusicTime
+       };
+
        static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
 
        static Change FadeChanged;
@@ -86,10 +93,8 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
 
        virtual ~Region();
 
-       /* Note: changing the name of a Region does not constitute an edit */
-
-       string name() const { return _name; }
-       void set_name (string str);
+       /** Note: changing the name of a Region does not constitute an edit */
+       bool set_name (const std::string& str);
 
        const DataType& data_type() const { return _type; }
 
@@ -97,7 +102,19 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        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;
 
@@ -119,13 +136,16 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        bool captured()   const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
        bool can_move()   const { return !(_flags & (Locked|PositionLocked)); }
 
+       PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
+       void set_position_lock_style (PositionLockStyle ps);
+
        virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 
        void freeze ();
        void thaw (const string& why);
 
        bool covers (nframes_t frame) const {
-               return first_frame() <= frame && frame < last_frame();
+               return first_frame() <= frame && frame <= last_frame();
        }
 
        OverlapType coverage (nframes_t start, nframes_t end) const {
@@ -145,7 +165,8 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        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 (long, void *src);
+       void update_position_after_tempo_map_change ();
+       void nudge_position (nframes64_t, void *src);
 
        bool at_natural_position () const;
        void move_to_natural_position (void *src);
@@ -156,6 +177,8 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        void trim_to (nframes_t position, nframes_t length, void *src);
        
        void set_layer (layer_t l); /* ONLY Playlist can call this */
+       void raise ();
+       void lower ();
        void raise_to_top ();
        void lower_to_bottom ();
 
@@ -179,11 +202,12 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
        uint32_t                  n_channels()          const { return _sources.size(); }
 
-       std::vector<string> master_source_names();
-       
        const SourceList& sources() const { return _sources; }
        const SourceList& master_sources() const { return _master_sources; }
 
+       std::vector<string> master_source_names();
+       void set_master_sources (SourceList&);
+       
        /* serialization */
        
        XMLNode&         get_state ();
@@ -199,22 +223,29 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        virtual bool is_dependent() const { return false; }
        virtual bool depends_on (boost::shared_ptr<Region> other) const { return false; }
 
+       virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
+
+       virtual int get_transients (AnalysisFeatureList&, bool force_new = false) { 
+               // no transients, but its OK
+               return 0;
+       }
+
+       void invalidate_transients ();  
+
   protected:
        friend class RegionFactory;
 
        Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length, 
                const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
-       Region (SourceList& srcs, nframes_t start, nframes_t length, 
+       Region (const SourceList& srcs, nframes_t start, nframes_t length, 
                const string& name, DataType type, 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 (boost::shared_ptr<Source> src, const XMLNode&);
-       Region (SourceList& srcs, const XMLNode&);
+       Region (const SourceList& srcs, const XMLNode&);
 
-       /* this one is for derived types of derived types */
-
-       Region (nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
+       Region (Session& s, nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
 
   protected:
        XMLNode& get_short_state (); /* used only by Session */
@@ -222,28 +253,39 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        void send_change (Change);
 
        void trim_to_internal (nframes_t position, nframes_t length, void *src);
+       void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
 
        bool copied() const { return _flags & Copied; }
        void maybe_uncopy ();
        void first_edit ();
        
-       virtual bool verify_start (nframes_t);
-       virtual bool verify_start_and_length (nframes_t, nframes_t);
-       virtual bool verify_start_mutable (nframes_t&_start);
-       virtual bool verify_length (nframes_t);
+       bool verify_start (nframes_t);
+       bool verify_start_and_length (nframes_t, nframes_t&);
+       bool verify_start_mutable (nframes_t&_start);
+       bool verify_length (nframes_t);
+       
        virtual void recompute_at_start () = 0;
        virtual void recompute_at_end () = 0;
 
-       string                  _name;
        DataType                _type;
        Flag                    _flags;
        nframes_t               _start;
        nframes_t               _length;
+       nframes_t               _last_length;
        nframes_t               _position;
+       nframes_t               _last_position;
+       PositionLockStyle       _positional_lock_style;
        nframes_t               _sync_position;
        layer_t                 _layer;
        mutable RegionEditState _first_edit;
        int                     _frozen;
+       nframes64_t             _ancestral_start;
+       nframes64_t             _ancestral_length;
+       float                   _stretch;
+       float                   _shift;
+       BBT_Time                _bbt_time;
+       AnalysisFeatureList     _transients;
+       bool                    _valid_transients;
        mutable uint32_t        _read_data_count;  ///< modified in read()
        Change                  _pending_changed;
        uint64_t                _last_layer_op;  ///< timestamp