remove cruft
[ardour.git] / libs / ardour / ardour / region.h
index 8be4709fbf227f772cef31b574c30552db23653f..9df4bdee7ada370a995db2e878871c62ee7849b9 100644 (file)
 
 class XMLNode;
 
-
 namespace ARDOUR {
 
 namespace Properties {
-       extern PBD::PropertyDescriptor<bool>              muted;
-       extern PBD::PropertyDescriptor<bool>              opaque;
-       extern PBD::PropertyDescriptor<bool>              locked;
-       extern PBD::PropertyDescriptor<bool>              automatic;
-       extern PBD::PropertyDescriptor<bool>              whole_file;
-       extern PBD::PropertyDescriptor<bool>              import;
-       extern PBD::PropertyDescriptor<bool>              external;
-       extern PBD::PropertyDescriptor<bool>              sync_marked;
-       extern PBD::PropertyDescriptor<bool>              left_of_split;
-       extern PBD::PropertyDescriptor<bool>              right_of_split;
-       extern PBD::PropertyDescriptor<bool>              hidden;
-       extern PBD::PropertyDescriptor<bool>              position_locked;
-       extern PBD::PropertyDescriptor<bool>              valid_transients;
-       extern PBD::PropertyDescriptor<framepos_t>        start;
-       extern PBD::PropertyDescriptor<framecnt_t>        length;
-       extern PBD::PropertyDescriptor<framepos_t>        position;
-       extern PBD::PropertyDescriptor<framecnt_t>        sync_position;
-       extern PBD::PropertyDescriptor<layer_t>           layer;
-       extern PBD::PropertyDescriptor<framepos_t>        ancestral_start;
-       extern PBD::PropertyDescriptor<framecnt_t>        ancestral_length;
-       extern PBD::PropertyDescriptor<float>             stretch;
-       extern PBD::PropertyDescriptor<float>             shift;
-       extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              muted;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              opaque;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              locked;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              video_locked;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              automatic;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              whole_file;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              import;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              external;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              sync_marked;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              left_of_split;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              right_of_split;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              hidden;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              position_locked;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              valid_transients;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t>        start;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t>        length;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t>        position;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t>        sync_position;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<layer_t>           layer;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t>        ancestral_start;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t>        ancestral_length;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<float>             stretch;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<float>             shift;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<uint64_t>          layering_index;
 };
 
 class Playlist;
@@ -72,14 +73,14 @@ class Filter;
 class ExportSpecification;
 class Progress;
 
-enum RegionEditState {
+enum LIBARDOUR_API RegionEditState {
        EditChangesNothing = 0,
        EditChangesName    = 1,
        EditChangesID      = 2
 };
 
 
-class Region
+class LIBARDOUR_API Region
        : public SessionObject
        , public boost::enable_shared_from_this<Region>
        , public Readable
@@ -127,11 +128,10 @@ 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;
-       framepos_t sync_point () const;
 
        framepos_t adjust_to_sync (framepos_t) const;
 
@@ -140,16 +140,34 @@ 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; }
+       bool video_locked ()     const { return _video_locked; }
        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; }
@@ -167,8 +185,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;
@@ -176,8 +200,8 @@ 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;
-       bool uses_source_path (const std::string&) const;
 
        std::string source_string () const;
 
@@ -187,7 +211,7 @@ class Region
        void set_length (framecnt_t);
        void set_start (framepos_t);
        void set_position (framepos_t);
-       void set_position_on_top (framepos_t);
+       void set_initial_position (framepos_t);
        void special_set_position (framepos_t);
        virtual void update_after_tempo_map_change ();
        void nudge_position (frameoffset_t);
@@ -195,11 +219,13 @@ class Region
        bool at_natural_position () const;
        void move_to_natural_position ();
 
-       void trim_start (framepos_t new_position);
+       void move_start (frameoffset_t distance);
        void trim_front (framepos_t new_position);
        void trim_end (framepos_t new_position);
        void trim_to (framepos_t position, framecnt_t length);
 
+       virtual void fade_range (framepos_t, framepos_t) {}
+
        void cut_front (framepos_t new_position);
        void cut_end (framepos_t new_position);
 
@@ -217,6 +243,7 @@ class Region
        void set_automatic (bool yn);
        void set_opaque (bool yn);
        void set_locked (bool yn);
+       void set_video_locked (bool yn);
        void set_position_locked (bool yn);
 
        int apply (Filter &, Progress* progress = 0);
@@ -253,14 +280,12 @@ class Region
 
        virtual boost::shared_ptr<Region> get_parent() const;
 
-       uint64_t last_layer_op() const { return _last_layer_op; }
-       void set_last_layer_op (uint64_t when);
+       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; }
 
-       virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
-
        virtual void add_transient (framepos_t) {
                // no transients, but its OK
        }
@@ -285,7 +310,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;
        }
@@ -297,14 +322,6 @@ class Region
 
        void invalidate_transients ();
 
-       void set_pending_explicit_relayer (bool p) {
-               _pending_explicit_relayer = p;
-       }
-
-       bool pending_explicit_relayer () const {
-               return _pending_explicit_relayer;
-       }
-
        void drop_sources ();
 
   protected:
@@ -330,12 +347,38 @@ class Region
        }
 
   protected:
+
        void send_change (const PBD::PropertyChange&);
+       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 (framecnt_t);
+       virtual void set_start_internal (framecnt_t);
+
+       DataType _type;
+
+       PBD::Property<bool>        _sync_marked;
+       PBD::Property<bool>        _left_of_split;
+       PBD::Property<bool>        _right_of_split;
+       PBD::Property<bool>        _valid_transients;
+       PBD::Property<framepos_t>  _start;
+       PBD::Property<framecnt_t>  _length;
+       PBD::Property<framepos_t>  _position;
+       /** Sync position relative to the start of our file */
+       PBD::Property<framepos_t>  _sync_position;
+
+       SourceList              _sources;
+       /** Used when timefx are applied, so we can always use the original source */
+       SourceList              _master_sources;
+
+       AnalysisFeatureList     _transients;
+
+       boost::weak_ptr<ARDOUR::Playlist> _playlist;
+
+  private:
        void mid_thaw (const PBD::PropertyChange&);
 
        void trim_to_internal (framepos_t position, framecnt_t length);
-       virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
-       virtual void set_length_internal (framepos_t pos);
        void modify_front (framepos_t new_position, bool reset_fade);
        void modify_end (framepos_t new_position, bool reset_fade);
 
@@ -345,59 +388,36 @@ class Region
        bool verify_start (framepos_t);
        bool verify_start_and_length (framepos_t, framecnt_t&);
        bool verify_start_mutable (framepos_t&_start);
-       bool verify_length (framecnt_t);
+       bool verify_length (framecnt_t&);
 
        virtual void recompute_at_start () = 0;
        virtual void recompute_at_end () = 0;
 
-       DataType _type;
-
        PBD::Property<bool>        _muted;
        PBD::Property<bool>        _opaque;
        PBD::Property<bool>        _locked;
+       PBD::Property<bool>        _video_locked;
        PBD::Property<bool>        _automatic;
        PBD::Property<bool>        _whole_file;
        PBD::Property<bool>        _import;
        PBD::Property<bool>        _external;
-       PBD::Property<bool>        _sync_marked;
-       PBD::Property<bool>        _left_of_split;
-       PBD::Property<bool>        _right_of_split;
        PBD::Property<bool>        _hidden;
        PBD::Property<bool>        _position_locked;
-       PBD::Property<bool>        _valid_transients;
-       PBD::Property<framepos_t>  _start;
-       PBD::Property<framecnt_t>  _length;
-       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;
        PBD::Property<framepos_t>  _ancestral_start;
        PBD::Property<framecnt_t>  _ancestral_length;
        PBD::Property<float>       _stretch;
        PBD::Property<float>       _shift;
        PBD::EnumProperty<PositionLockStyle> _position_lock_style;
+       PBD::Property<uint64_t>    _layering_index;
 
        framecnt_t              _last_length;
        framepos_t              _last_position;
        mutable RegionEditState _first_edit;
        Timecode::BBT_Time      _bbt_time;
-       AnalysisFeatureList     _transients;
-
-       uint64_t                _last_layer_op;  ///< timestamp
-       SourceList              _sources;
-       /** Used when timefx are applied, so we can always use the original source */
-       SourceList              _master_sources;
-
-       /** true if this region has had its layer explicitly set since the playlist last relayered */
-       bool                    _pending_explicit_relayer;
-
-       boost::weak_ptr<ARDOUR::Playlist> _playlist;
-
-       virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
+       layer_t                 _layer;
 
        void register_properties ();
 
-protected:
        void use_sources (SourceList const &);
 };