Region pulse is no longer a property.
[ardour.git] / libs / ardour / ardour / region.h
index a238ff90385b268df3309e9a69f2e695d89d945f..fc14e98cb89c9ad01b7f54e114e520cd62afd578 100644 (file)
@@ -27,7 +27,6 @@
 
 #include "pbd/undo.h"
 #include "pbd/signals.h"
-
 #include "ardour/ardour.h"
 #include "ardour/data_type.h"
 #include "ardour/automatable.h"
 
 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;
-       extern PBD::PropertyDescriptor<uint64_t>          layering_index;
+       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<double>            beat;
+       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;
@@ -73,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
@@ -101,8 +101,6 @@ class Region
 
        const DataType& data_type () const { return _type; }
 
-       AnalysisFeatureList transients () { return _transients; };
-
        /** How the region parameters play together:
         *
         * POSITION: first frame of the region along the timeline
@@ -132,7 +130,6 @@ class Region
 
        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;
 
@@ -141,16 +138,33 @@ 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 valid_transients () const { return _valid_transients; }
+       bool video_locked ()     const { return _video_locked; }
        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; }
@@ -158,9 +172,13 @@ class Region
        Trimmable::CanTrim can_trim () const;
 
        PositionLockStyle position_lock_style () const { return _position_lock_style; }
-
        void set_position_lock_style (PositionLockStyle ps);
-       void recompute_position_from_lock_style ();
+       void recompute_position_from_lock_style (const int32_t sub_num);
+
+       double beat () const { return _beat; }
+       void set_beat (double beat) { _beat = beat; }
+       double pulse () const { return _pulse; }
+       void set_pulse (double pulse) { _pulse = pulse; }
 
        void suspend_property_changes ();
 
@@ -168,8 +186,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,30 +201,35 @@ 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 uses_source (boost::shared_ptr<const Source>) const;
+       bool any_source_equivalent (boost::shared_ptr<const Region>) const;
+       bool uses_source (boost::shared_ptr<const Source>, bool shallow = false) const;
+       void deep_sources (std::set<boost::shared_ptr<Source> >&) const;
 
        std::string source_string () const;
 
 
        /* EDITING OPERATIONS */
 
-       void set_length (framecnt_t);
+       void set_length (framecnt_t, const int32_t sub_num);
        void set_start (framepos_t);
-       void set_position (framepos_t);
+       void set_position (framepos_t, int32_t sub_num = 0);
+       void set_initial_position (framepos_t);
        void special_set_position (framepos_t);
-       virtual void update_after_tempo_map_change ();
+       virtual void update_after_tempo_map_change (bool send_change = true);
        void nudge_position (frameoffset_t);
 
        bool at_natural_position () const;
        void move_to_natural_position ();
 
-       void trim_start (framepos_t new_position);
-       void trim_front (framepos_t new_position);
-       void trim_end (framepos_t new_position);
-       void trim_to (framepos_t position, framecnt_t length);
+       void move_start (frameoffset_t distance, const int32_t sub_num = 0);
+       void trim_front (framepos_t new_position, const int32_t sub_num = 0);
+       void trim_end (framepos_t new_position, const int32_t sub_num = 0);
+       void trim_to (framepos_t position, framecnt_t length, const int32_t sub_num = 0);
 
-       void cut_front (framepos_t new_position);
-       void cut_end (framepos_t new_position);
+       virtual void fade_range (framepos_t, framepos_t) {}
+
+       void cut_front (framepos_t new_position, const int32_t sub_num = 0);
+       void cut_end (framepos_t new_position, const int32_t sub_num = 0);
 
        void set_layer (layer_t l); /* ONLY Playlist can call this */
        void raise ();
@@ -216,6 +245,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);
@@ -262,37 +292,45 @@ class Region
                // no transients, but its OK
        }
 
-       virtual int update_transient (framepos_t /* old_position */, framepos_t /* new_position */) {
+       virtual void clear_transients () {
                // no transients, but its OK
-               return 0;
        }
 
-       virtual void remove_transient (framepos_t /* where */) {
+       virtual void update_transient (framepos_t /* old_position */, framepos_t /* new_position */) {
                // no transients, but its OK
        }
 
-       virtual int set_transients (AnalysisFeatureList&) {
+       virtual void remove_transient (framepos_t /* where */) {
                // no transients, but its OK
-               return 0;
        }
 
-       virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
-               (void) force_new;
+       virtual void set_onsets (AnalysisFeatureList&) {
                // no transients, but its OK
-               return 0;
        }
 
-       virtual int adjust_transients (frameoffset_t /*delta*/) {
+       /** merges _onsets and _user_transients into given list
+        * and removed exact duplicates.
+        */
+       void transients (AnalysisFeatureList&);
+
+       /** merges _onsets OR _transients with _user_transients into given list
+        * if _onsets and _transients are unset, run analysis.
+        * list is not thinned, duplicates remain in place.
+        *
+        * intended for: Playlist::find_next_transient ()
+        */
+       virtual void get_transients (AnalysisFeatureList&) {
                // no transients, but its OK
-               return 0;
        }
 
+       bool has_transients () const;
+
        virtual int separate_by_channel (ARDOUR::Session&,
                        std::vector< boost::shared_ptr<Region> >&) const {
                return 0;
        }
 
-       void invalidate_transients ();
+       void maybe_invalidate_transients ();
 
        void drop_sources ();
 
@@ -306,7 +344,7 @@ class Region
        Region (boost::shared_ptr<const Region>);
 
        /** Construct a region from another region, at an offset within that region */
-       Region (boost::shared_ptr<const Region>, frameoffset_t start_offset);
+       Region (boost::shared_ptr<const Region>, frameoffset_t start_offset, const int32_t sub_num);
 
        /** Construct a region as a copy of another region, but with different sources */
        Region (boost::shared_ptr<const Region>, const SourceList&);
@@ -323,10 +361,12 @@ class Region
        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);
-       
+       virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute, const int32_t sub_num);
+       virtual void set_length_internal (framecnt_t, const int32_t sub_num);
+       virtual void set_start_internal (framecnt_t, const int32_t sub_num = 0);
+       bool verify_start_and_length (framepos_t, framecnt_t&);
+       void first_edit ();
+
        DataType _type;
 
        PBD::Property<bool>        _sync_marked;
@@ -336,31 +376,43 @@ class Region
        PBD::Property<framepos_t>  _start;
        PBD::Property<framecnt_t>  _length;
        PBD::Property<framepos_t>  _position;
+       PBD::Property<double>      _beat;
        /** Sync position relative to the start of our file */
        PBD::Property<framepos_t>  _sync_position;
-       
+
+       double                  _pulse;
+
        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;
-       
+
+       void merge_features (AnalysisFeatureList&, const AnalysisFeatureList&, const frameoffset_t) const;
+
+       AnalysisFeatureList     _onsets; // used by the Ferret (Aubio OnsetDetector)
+
+       // _transient_user_start is covered by  _valid_transients
+       AnalysisFeatureList     _user_transients; // user added
+       framepos_t              _transient_user_start; // region's _start relative to user_transients
+
+       // these are used by Playlist::find_next_transient() in absence of onsets
+       AnalysisFeatureList     _transients; // Source Analysis (QM Transient), user read-only
+       framepos_t              _transient_analysis_start;
+       framepos_t              _transient_analysis_end;
+
   private:
        void mid_thaw (const PBD::PropertyChange&);
 
-       void trim_to_internal (framepos_t position, framecnt_t length);
-       void modify_front (framepos_t new_position, bool reset_fade);
-       void modify_end (framepos_t new_position, bool reset_fade);
+       virtual void trim_to_internal (framepos_t position, framecnt_t length, const int32_t sub_num);
+       void modify_front (framepos_t new_position, bool reset_fade, const int32_t sub_num);
+       void modify_end (framepos_t new_position, bool reset_fade, const int32_t sub_num);
 
        void maybe_uncopy ();
-       void first_edit ();
 
        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;
@@ -368,6 +420,7 @@ class Region
        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;
@@ -384,7 +437,6 @@ class Region
        framecnt_t              _last_length;
        framepos_t              _last_position;
        mutable RegionEditState _first_edit;
-       Timecode::BBT_Time      _bbt_time;
        layer_t                 _layer;
 
        void register_properties ();