X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fregion.h;h=3ee829ed122dee2860e456cfa6b7c58b848e4210;hb=25ca45f3959d5838a9c637ecc8687511d835140b;hp=60ccf6698465fed03fdb5b70f1e0d527022d95a6;hpb=ce7a5e1c9fa3edf2d9cc66875505e402a0aaa6f6;p=ardour.git diff --git a/libs/ardour/ardour/region.h b/libs/ardour/ardour/region.h index 60ccf66984..3ee829ed12 100644 --- a/libs/ardour/ardour/region.h +++ b/libs/ardour/ardour/region.h @@ -31,8 +31,10 @@ #include "ardour/ardour.h" #include "ardour/data_type.h" #include "ardour/automatable.h" +#include "ardour/movable.h" #include "ardour/readable.h" #include "ardour/session_object.h" +#include "ardour/trimmable.h" class XMLNode; @@ -40,32 +42,37 @@ class XMLNode; namespace ARDOUR { namespace Properties { - extern PBD::PropertyDescriptor muted; - extern PBD::PropertyDescriptor opaque; - extern PBD::PropertyDescriptor locked; - extern PBD::PropertyDescriptor automatic; - extern PBD::PropertyDescriptor whole_file; - extern PBD::PropertyDescriptor import; - extern PBD::PropertyDescriptor external; - extern PBD::PropertyDescriptor sync_marked; - extern PBD::PropertyDescriptor left_of_split; - extern PBD::PropertyDescriptor right_of_split; - extern PBD::PropertyDescriptor hidden; - extern PBD::PropertyDescriptor position_locked; - extern PBD::PropertyDescriptor start; - extern PBD::PropertyDescriptor length; - extern PBD::PropertyDescriptor position; - extern PBD::PropertyDescriptor sync_position; - extern PBD::PropertyDescriptor layer; - extern PBD::PropertyDescriptor ancestral_start; - extern PBD::PropertyDescriptor ancestral_length; - extern PBD::PropertyDescriptor stretch; - extern PBD::PropertyDescriptor shift; + extern PBD::PropertyDescriptor muted; + extern PBD::PropertyDescriptor opaque; + extern PBD::PropertyDescriptor locked; + extern PBD::PropertyDescriptor video_locked; + extern PBD::PropertyDescriptor automatic; + extern PBD::PropertyDescriptor whole_file; + extern PBD::PropertyDescriptor import; + extern PBD::PropertyDescriptor external; + extern PBD::PropertyDescriptor sync_marked; + extern PBD::PropertyDescriptor left_of_split; + extern PBD::PropertyDescriptor right_of_split; + extern PBD::PropertyDescriptor hidden; + extern PBD::PropertyDescriptor position_locked; + extern PBD::PropertyDescriptor valid_transients; + extern PBD::PropertyDescriptor start; + extern PBD::PropertyDescriptor length; + extern PBD::PropertyDescriptor position; + extern PBD::PropertyDescriptor sync_position; + extern PBD::PropertyDescriptor layer; + extern PBD::PropertyDescriptor ancestral_start; + extern PBD::PropertyDescriptor ancestral_length; + extern PBD::PropertyDescriptor stretch; + extern PBD::PropertyDescriptor shift; + extern PBD::PropertyDescriptor position_lock_style; + extern PBD::PropertyDescriptor layering_index; }; class Playlist; class Filter; class ExportSpecification; +class Progress; enum RegionEditState { EditChangesNothing = 0, @@ -78,100 +85,116 @@ class Region : public SessionObject , public boost::enable_shared_from_this , public Readable + , public Trimmable + , public Movable { public: typedef std::vector > SourceList; static void make_property_quarks (); - - enum PositionLockStyle { - AudioTime, - MusicTime - }; - - static PBD::PropertyChange FadeChanged; - static PBD::PropertyChange SyncOffsetChanged; - static PBD::PropertyChange MuteChanged; - static PBD::PropertyChange OpacityChanged; - static PBD::PropertyChange LockChanged; - static PBD::PropertyChange LayerChanged; - static PBD::PropertyChange HiddenChanged; - - PBD::Signal1 StateChanged; - static PBD::Signal1 > RegionPropertyChanged; - - void unlock_property_changes () { _no_property_changes = false; } - void block_property_changes () { _no_property_changes = true; } - + + static PBD::Signal2, const PBD::PropertyChange&> RegionPropertyChanged; + virtual ~Region(); - + /** 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; } + 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 * START: first frame of the region within its source(s) * LENGTH: number of frames the region represents */ - sframes_t position () const { return _position; } - sframes_t start () const { return _start; } - framecnt_t length() const { return _length; } - layer_t layer () const { return _layer; } + framepos_t position () const { return _position; } + framepos_t start () const { return _start; } + framecnt_t length () const { return _length; } + layer_t layer () const { return _layer; } framecnt_t source_length(uint32_t n) const; + uint32_t max_source_level () const; /* these two are valid ONLY during a StateChanged signal handler */ - sframes_t last_position() const { return _last_position; } - framecnt_t last_length() const { return _last_length; } + framepos_t last_position () const { return _last_position; } + framecnt_t last_length () const { return _last_length; } - sframes_t ancestral_start () const { return _ancestral_start; } + framepos_t ancestral_start () const { return _ancestral_start; } framecnt_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); + float stretch () const { return _stretch; } + float shift () const { return _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; + 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; /* first_frame() is an alias; last_frame() just hides some math */ - framepos_t first_frame() const { return _position; } - framepos_t last_frame() const { return _position + _length - 1; } - - 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 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 sync_marked() const { return _sync_marked; } - bool external() const { return _external; } - bool import() const { return _import; } - - PositionLockStyle positional_lock_style() const { return _positional_lock_style; } + 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 last_range () const { + return Evoral::Range (_last_position, _last_position + _last_length - 1); + } + + Evoral::Range range () const { + return Evoral::Range (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 && !_locked; } + bool sync_marked () const { return _sync_marked; } + bool external () const { return _external; } + bool import () const { return _import; } + + 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 freeze (); - void thaw (); + void suspend_property_changes (); bool covers (framepos_t frame) const { 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; @@ -179,25 +202,31 @@ class Region bool overlap_equivalent (boost::shared_ptr) const; bool region_list_equivalent (boost::shared_ptr) const; bool source_equivalent (boost::shared_ptr) const; + bool any_source_equivalent (boost::shared_ptr) const; bool uses_source (boost::shared_ptr) const; + std::string source_string () const; + + /* EDITING OPERATIONS */ - void set_length (framecnt_t, void *src); - void set_start (framepos_t, void *src); - void set_position (framepos_t, void *src); - void set_position_on_top (framepos_t, void *src); + void set_length (framecnt_t); + void set_start (framepos_t); + void set_position (framepos_t); void special_set_position (framepos_t); - void update_position_after_tempo_map_change (); - void nudge_position (frameoffset_t, void *src); + virtual void update_after_tempo_map_change (); + void nudge_position (frameoffset_t); bool at_natural_position () const; - void move_to_natural_position (void *src); + 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 trim_start (framepos_t new_position, void *src); - void trim_front (framepos_t new_position, void *src); - void trim_end (framepos_t new_position, void *src); - void trim_to (framepos_t position, framecnt_t length, void *src); + void cut_front (framepos_t new_position); + void cut_end (framepos_t new_position); void set_layer (layer_t l); /* ONLY Playlist can call this */ void raise (); @@ -213,22 +242,23 @@ 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&); + int apply (Filter &, Progress* progress = 0); - virtual uint64_t read_data_count() const { return _read_data_count; } - - boost::shared_ptr playlist() const { return _playlist.lock(); } + boost::shared_ptr playlist () const { return _playlist.lock(); } virtual void set_playlist (boost::weak_ptr); void source_deleted (boost::weak_ptr); + bool is_compound () const; + boost::shared_ptr source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; } - uint32_t n_channels() const { return _sources.size(); } + uint32_t n_channels() const { return _sources.size(); } - const SourceList& sources() const { return _sources; } - const SourceList& master_sources() const { return _master_sources; } + const SourceList& sources () const { return _sources; } + const SourceList& master_sources () const { return _master_sources; } std::vector master_source_names(); void set_master_sources (const SourceList&); @@ -236,26 +266,42 @@ class Region /* automation */ virtual boost::shared_ptr - control(const Evoral::Parameter& id, bool create=false) = 0; + control (const Evoral::Parameter& id, bool create=false) = 0; virtual boost::shared_ptr - control(const Evoral::Parameter& id) const = 0; + control (const Evoral::Parameter& id) const = 0; /* serialization */ XMLNode& get_state (); - virtual XMLNode& state (bool); + virtual XMLNode& state (); virtual int set_state (const XMLNode&, int version); virtual boost::shared_ptr 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 /*other*/) const { return false; } - virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0; + virtual void add_transient (framepos_t) { + // no transients, but its OK + } + + virtual int update_transient (framepos_t /* old_position */, framepos_t /* new_position */) { + // no transients, but its OK + return 0; + } + + virtual void remove_transient (framepos_t /* where */) { + // no transients, but its OK + } + + virtual int set_transients (AnalysisFeatureList&) { + // no transients, but its OK + return 0; + } virtual int get_transients (AnalysisFeatureList&, bool force_new = false) { (void) force_new; @@ -263,6 +309,11 @@ class Region return 0; } + virtual int adjust_transients (frameoffset_t /*delta*/) { + // no transients, but its OK + return 0; + } + virtual int separate_by_channel (ARDOUR::Session&, std::vector< boost::shared_ptr >&) const { return 0; @@ -270,41 +321,65 @@ 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: friend class RegionFactory; - /** Construct a region from a single source */ - Region (boost::shared_ptr src); /** Construct a region from multiple sources*/ Region (const SourceList& srcs); + + /** Construct a region from another region */ + Region (boost::shared_ptr); + /** Construct a region from another region, at an offset within that region */ - Region (boost::shared_ptr, frameoffset_t start_offset = 0, bool start_relative = true); + Region (boost::shared_ptr, frameoffset_t start_offset); + /** Construct a region as a copy of another region, but with different sources */ Region (boost::shared_ptr, const SourceList&); - /** normal Region copy constructor */ - Region (boost::shared_ptr); - - /** Construct a region from 1 source and XML state */ - Region (boost::shared_ptr src, const XMLNode&); - /** Construct a region from multiple sources and XML state */ - Region (const SourceList& srcs, const XMLNode&); /** Constructor for derived types only */ Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType); + virtual bool can_trim_start_before_source_start () const { + return false; + } + protected: - void send_change (PBD::PropertyChange); - void trim_to_internal (framepos_t position, framecnt_t length, void *src); + 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 _sync_marked; + PBD::Property _left_of_split; + PBD::Property _right_of_split; + PBD::Property _valid_transients; + PBD::Property _start; + PBD::Property _length; + PBD::Property _position; + /** Sync position relative to the start of our file */ + PBD::Property _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 _playlist; + + 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); void maybe_uncopy (); void first_edit (); @@ -316,59 +391,32 @@ class Region virtual void recompute_at_start () = 0; virtual void recompute_at_end () = 0; - - DataType _type; - bool _no_property_changes; PBD::Property _muted; PBD::Property _opaque; PBD::Property _locked; + PBD::Property _video_locked; PBD::Property _automatic; PBD::Property _whole_file; PBD::Property _import; PBD::Property _external; - PBD::Property _sync_marked; - PBD::Property _left_of_split; - PBD::Property _right_of_split; PBD::Property _hidden; PBD::Property _position_locked; - PBD::Property _start; - PBD::Property _length; - PBD::Property _position; - PBD::Property _sync_position; - PBD::Property _layer; PBD::Property _ancestral_start; PBD::Property _ancestral_length; PBD::Property _stretch; PBD::Property _shift; + PBD::EnumProperty _position_lock_style; + PBD::Property _layering_index; framecnt_t _last_length; framepos_t _last_position; - PositionLockStyle _positional_lock_style; mutable RegionEditState _first_edit; - int _frozen; - BBT_Time _bbt_time; - AnalysisFeatureList _transients; - bool _valid_transients; - mutable uint64_t _read_data_count; ///< modified in read() - PBD::PropertyChange _pending_changed; - uint64_t _last_layer_op; ///< timestamp - Glib::Mutex _lock; - 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 _playlist; - - virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal); + Timecode::BBT_Time _bbt_time; + layer_t _layer; - PBD::PropertyChange set_property (const PBD::PropertyBase&); void register_properties (); -private: void use_sources (SourceList const &); };