Set the revision mechanism independent from the VCS name
[ardour.git] / libs / ardour / ardour / region.h
index 4315ed7aa8d9b502d6108f8e8b886e488194308c..eaa23cc8f6c014d792dcc48770b8c1c91a0adcc6 100644 (file)
@@ -45,6 +45,9 @@ namespace Properties {
        extern PBD::PropertyDescriptor<bool>              muted;
        extern PBD::PropertyDescriptor<bool>              opaque;
        extern PBD::PropertyDescriptor<bool>              locked;
+#ifdef WITH_VIDEOTIMELINE
+       extern PBD::PropertyDescriptor<bool>              video_locked;
+#endif
        extern PBD::PropertyDescriptor<bool>              automatic;
        extern PBD::PropertyDescriptor<bool>              whole_file;
        extern PBD::PropertyDescriptor<bool>              import;
@@ -65,6 +68,7 @@ namespace Properties {
        extern PBD::PropertyDescriptor<float>             stretch;
        extern PBD::PropertyDescriptor<float>             shift;
        extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
+       extern PBD::PropertyDescriptor<uint64_t>          layering_index;
 };
 
 class Playlist;
@@ -112,7 +116,6 @@ class Region
        framepos_t start ()     const { return _start; }
        framecnt_t length ()    const { return _length; }
        layer_t    layer ()     const { return _layer; }
-       Evoral::Range<framepos_t> bounds () const;
 
        framecnt_t source_length(uint32_t n) const;
        uint32_t   max_source_level () const;
@@ -128,7 +131,7 @@ class Region
        float stretch () const { return _stretch; }
        float shift ()   const { return _shift; }
 
-       void set_ancestral_data (framepos_t start, framepos_t length, float stretch, float shift);
+       void set_ancestral_data (framepos_t start, framecnt_t length, float stretch, float shift);
 
        frameoffset_t sync_offset (int& dir) const;
        framepos_t sync_position () const;
@@ -141,16 +144,36 @@ class Region
        framepos_t first_frame () const { return _position; }
        framepos_t last_frame ()  const { return _position + _length - 1; }
 
+       /** Return the earliest possible value of _position given the
+        *  value of _start within the region's sources
+        */
+       framepos_t earliest_possible_position () const;
+       /** Return the last possible value of _last_frame given the
+        *  value of _startin the regions's sources
+        */
+       framepos_t latest_possible_frame () const;
+
+       Evoral::Range<framepos_t> last_range () const {
+               return Evoral::Range<framepos_t> (_last_position, _last_position + _last_length - 1);
+       }
+       
+       Evoral::Range<framepos_t> range () const {
+               return Evoral::Range<framepos_t> (first_frame(), last_frame());
+       }
+
        bool hidden ()           const { return _hidden; }
        bool muted ()            const { return _muted; }
        bool opaque ()           const { return _opaque; }
        bool locked ()           const { return _locked; }
        bool position_locked ()  const { return _position_locked; }
+#ifdef WITH_VIDEOTIMELINE
+       bool video_locked ()     const { return _video_locked; }
+#endif
        bool valid_transients () const { return _valid_transients; }
        bool automatic ()        const { return _automatic; }
        bool whole_file ()       const { return _whole_file; }
        bool captured ()         const { return !(_import || _external); }
-       bool can_move ()         const { return !_position_locked; }
+       bool can_move ()         const { return !_position_locked && !_locked; }
        bool sync_marked ()      const { return _sync_marked; }
        bool external ()         const { return _external; }
        bool import ()           const { return _import; }
@@ -168,8 +191,14 @@ class Region
                return first_frame() <= frame && frame <= last_frame();
        }
 
-       OverlapType coverage (framepos_t start, framepos_t end) const {
-               return ARDOUR::coverage (first_frame(), last_frame(), start, end);
+       /** @return coverage of this region with the given range;
+        *  OverlapInternal: the range is internal to this region.
+        *  OverlapStart:    the range overlaps the start of this region.
+        *  OverlapEnd:      the range overlaps the end of this region.
+        *  OverlapExternal: the range overlaps all of this region.
+        */
+       Evoral::OverlapType coverage (framepos_t start, framepos_t end) const {
+               return Evoral::coverage (first_frame(), last_frame(), start, end);
        }
 
        bool equivalent (boost::shared_ptr<const Region>) const;
@@ -177,6 +206,7 @@ class Region
        bool overlap_equivalent (boost::shared_ptr<const Region>) const;
        bool region_list_equivalent (boost::shared_ptr<const Region>) const;
        bool source_equivalent (boost::shared_ptr<const Region>) const;
+       bool any_source_equivalent (boost::shared_ptr<const Region>) const;
        bool uses_source (boost::shared_ptr<const Source>) const;
 
        std::string source_string () const;
@@ -202,7 +232,7 @@ class Region
        void cut_front (framepos_t new_position);
        void cut_end (framepos_t new_position);
 
-       void set_layer (layer_t l); /* ONLY Playlist should call this */
+       void set_layer (layer_t l); /* ONLY Playlist can call this */
        void raise ();
        void lower ();
        void raise_to_top ();
@@ -216,6 +246,9 @@ class Region
        void set_automatic (bool yn);
        void set_opaque (bool yn);
        void set_locked (bool yn);
+#ifdef WITH_VIDEOTIMELINE
+       void set_video_locked (bool yn);
+#endif
        void set_position_locked (bool yn);
 
        int apply (Filter &, Progress* progress = 0);
@@ -252,8 +285,8 @@ class Region
 
        virtual boost::shared_ptr<Region> get_parent() const;
 
-       uint64_t last_layer_op (LayerOp) const;
-       void set_last_layer_op (LayerOp, uint64_t);
+       uint64_t layering_index () const { return _layering_index; }
+       void set_layering_index (uint64_t when) { _layering_index = when; }
 
        virtual bool is_dependent() const { return false; }
        virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
@@ -282,7 +315,7 @@ class Region
                return 0;
        }
 
-       virtual int adjust_transients (framepos_t /*delta*/) {
+       virtual int adjust_transients (frameoffset_t /*delta*/) {
                // no transients, but its OK
                return 0;
        }
@@ -296,11 +329,6 @@ class Region
 
        void drop_sources ();
 
-       /** @return our bounds the last time our relayer() method was called */
-       Evoral::Range<framepos_t> last_relayer_bounds () const {
-               return Evoral::Range<framepos_t> (_last_relayer_bounds_from, _last_relayer_bounds_to);
-       }
-
   protected:
        friend class RegionFactory;
 
@@ -329,7 +357,8 @@ class Region
        virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
        void post_set (const PBD::PropertyChange&);
        virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
-       virtual void set_length_internal (framepos_t pos);
+       virtual void set_length_internal (framecnt_t);
+       virtual void set_start_internal (framecnt_t);
        
        DataType _type;
 
@@ -342,7 +371,6 @@ class Region
        PBD::Property<framepos_t>  _position;
        /** Sync position relative to the start of our file */
        PBD::Property<framepos_t>  _sync_position;
-       PBD::Property<layer_t>     _layer;
        
        SourceList              _sources;
        /** Used when timefx are applied, so we can always use the original source */
@@ -373,6 +401,9 @@ class Region
        PBD::Property<bool>        _muted;
        PBD::Property<bool>        _opaque;
        PBD::Property<bool>        _locked;
+#ifdef WITH_VIDEOTIMELINE
+       PBD::Property<bool>        _video_locked;
+#endif
        PBD::Property<bool>        _automatic;
        PBD::Property<bool>        _whole_file;
        PBD::Property<bool>        _import;
@@ -384,17 +415,13 @@ class Region
        PBD::Property<float>       _stretch;
        PBD::Property<float>       _shift;
        PBD::EnumProperty<PositionLockStyle> _position_lock_style;
+       PBD::Property<uint64_t>    _layering_index;
 
-       /* XXX: could use a Evoral::Range<> but I'm too lazy to make PBD::Property serialize such a thing nicely */
-       PBD::Property<framepos_t> _last_relayer_bounds_from; ///< from of our bounds last time relayer() was called
-       PBD::Property<framepos_t> _last_relayer_bounds_to; ///< to of our bounds last time relayer() was called
-       PBD::Property<uint64_t> _last_layer_op_add;
-       PBD::Property<uint64_t> _last_layer_op_bounds_change;
-       
        framecnt_t              _last_length;
        framepos_t              _last_position;
        mutable RegionEditState _first_edit;
        Timecode::BBT_Time      _bbt_time;
+       layer_t                 _layer;
 
        void register_properties ();