X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fregion.h;h=b55d77f4990ffed8e129d62f0c77fc197cf5747d;hb=022818b4a796f52c0a91eea42e65aec0bc7bed43;hp=3c94dad6fd0de0bc6793d13538cb050dd6a52101;hpb=868f557f2612903f72614a2b3a317c7a528188d1;p=ardour.git diff --git a/libs/ardour/ardour/region.h b/libs/ardour/ardour/region.h index 3c94dad6fd..b55d77f499 100644 --- a/libs/ardour/ardour/region.h +++ b/libs/ardour/ardour/region.h @@ -15,48 +15,45 @@ along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - $Id$ */ #ifndef __ardour_region_h__ #define __ardour_region_h__ +#include +#include +#include + #include #include -#include -#include +#include +#include +#include +#include class XMLNode; namespace ARDOUR { class Playlist; -class Source; +class Filter; +class ExportSpecification; enum RegionEditState { EditChangesNothing = 0, - EditChangesName = 1, - EditChangesID = 2 -}; - -struct RegionState : public StateManager::State { - - RegionState (std::string why) : StateManager::State (why) {} - - jack_nframes_t _start; - jack_nframes_t _length; - jack_nframes_t _position; - uint32_t _flags; - jack_nframes_t _sync_position; - layer_t _layer; - string _name; - mutable RegionEditState _first_edit; + EditChangesName = 1, + EditChangesID = 2 }; -class Region : public Stateful, public StateManager +class Region + : public SessionObject + , public boost::enable_shared_from_this + , public Readable { public: + typedef std::vector > SourceList; + enum Flag { Muted = 0x1, Opaque = 0x2, @@ -76,10 +73,16 @@ class Region : public Stateful, public StateManager RightOfSplit = 0x8000, Hidden = 0x10000, DoNotSaveState = 0x20000, + PositionLocked = 0x40000, // range_guarantoor = USHRT_MAX }; + enum PositionLockStyle { + AudioTime, + MusicTime + }; + static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut); static Change FadeChanged; @@ -90,77 +93,105 @@ class Region : public Stateful, public StateManager static Change LayerChanged; static Change HiddenChanged; - Region (jack_nframes_t start, jack_nframes_t length, - const string& name, layer_t = 0, Flag flags = DefaultFlags); - Region (const Region&, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags); - Region (const Region&); - Region (const XMLNode&); - ~Region(); + sigc::signal StateChanged; + static sigc::signal > 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; } + + /** + * Thats how the region parameters play together: + * 
+	 * |------------------------------------------------------------------- track
+	 *                    |..........[------------------].....| region
+	 * |-----------------------------| _position
+	 *                               |------------------| _length
+	 *                    |----------| _start
+	 *
+ */ + nframes_t position () const { return _position; } + 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 */ - ARDOUR::id_t id() const { return _id; } + nframes_t last_position() const { return _last_position; } + nframes_t last_length() const { return _last_length; } - /* Note: changing the name of a Region does not constitute an edit */ + 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; } - string name() const { return _name; } - void set_name (string str); + void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift); - jack_nframes_t position () const { return _position; } - jack_nframes_t start () const { return _start; } - jack_nframes_t length() const { return _length; } - layer_t layer () const { return _layer; } - jack_nframes_t sync_offset(int& dir) const; - jack_nframes_t sync_position() const; + nframes_t sync_offset(int& dir) const; + nframes_t sync_position() const; + nframes_t sync_point () const; - jack_nframes_t adjust_to_sync (jack_nframes_t); + nframes_t adjust_to_sync (nframes_t) const; /* first_frame() is an alias; last_frame() just hides some math */ - jack_nframes_t first_frame() const { return _position; } - jack_nframes_t last_frame() const { return _position + _length - 1; } + nframes_t first_frame() const { return _position; } + nframes_t last_frame() const { return _position + _length - 1; } - bool hidden() const { return _flags & Hidden; } - bool muted() const { return _flags & Muted; } - bool opaque () const { return _flags & Opaque; } - bool envelope_active () const { return _flags & EnvelopeActive; } - bool locked() const { return _flags & Locked; } - bool automatic() const { return _flags & Automatic; } + Flag flags() const { return _flags; } + bool hidden() const { return _flags & Hidden; } + bool muted() const { return _flags & Muted; } + bool opaque () const { return _flags & Opaque; } + bool locked() const { return _flags & Locked; } + bool position_locked() const { return _flags & PositionLocked; } + bool automatic() const { return _flags & Automatic; } bool whole_file() const { return _flags & WholeFile ; } - Flag flags() const { return _flags; } + 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); + void recompute_position_from_lock_style (); virtual bool should_save_state () const { return !(_flags & DoNotSaveState); }; void freeze (); void thaw (const string& why); - bool covers (jack_nframes_t frame) const { - return _position <= frame && frame < _position + _length; + bool covers (nframes_t frame) const { + return first_frame() <= frame && frame <= last_frame(); } - OverlapType coverage (jack_nframes_t start, jack_nframes_t end) const { - return ARDOUR::coverage (_position, _position + _length - 1, start, end); + OverlapType coverage (nframes_t start, nframes_t end) const { + return ARDOUR::coverage (first_frame(), last_frame(), start, end); } - - virtual jack_nframes_t read_at (Sample *buf, Sample *mixdown_buffer, - float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt, - uint32_t chan_n = 0, - jack_nframes_t read_frames = 0, - jack_nframes_t skip_frames = 0) const = 0; - + + bool equivalent (boost::shared_ptr) const; + bool size_equivalent (boost::shared_ptr) const; + bool overlap_equivalent (boost::shared_ptr) const; + bool region_list_equivalent (boost::shared_ptr) const; + bool source_equivalent (boost::shared_ptr) const; + /* EDITING OPERATIONS */ - void set_length (jack_nframes_t, void *src); - void set_start (jack_nframes_t, void *src); - void set_position (jack_nframes_t, void *src); - void set_position_on_top (jack_nframes_t, void *src); - void special_set_position (jack_nframes_t); - void nudge_position (long, void *src); + void set_length (nframes_t, void *src); + void set_start (nframes_t, void *src); + void set_position (nframes_t, void *src); + void set_position_on_top (nframes_t, void *src); + void special_set_position (nframes_t); + 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); - void trim_start (jack_nframes_t new_position, void *src); - void trim_front (jack_nframes_t new_position, void *src); - void trim_end (jack_nframes_t new_position, void *src); - void trim_to (jack_nframes_t position, jack_nframes_t length, void *src); + void trim_start (nframes_t new_position, void *src); + void trim_front (nframes_t new_position, void *src); + void trim_end (nframes_t new_position, void *src); + void trim_to (nframes_t position, nframes_t length, void *src); void set_layer (layer_t l); /* ONLY Playlist can call this */ void raise (); @@ -168,90 +199,135 @@ class Region : public Stateful, public StateManager void raise_to_top (); void lower_to_bottom (); - void set_sync_position (jack_nframes_t n); + void set_sync_position (nframes_t n); void clear_sync_position (); void set_hidden (bool yn); void set_muted (bool yn); void set_opaque (bool yn); - void set_envelope_active (bool yn); void set_locked (bool yn); + void set_position_locked (bool yn); + + int apply (Filter&); virtual uint32_t read_data_count() const { return _read_data_count; } - ARDOUR::Playlist* playlist() const { return _playlist; } + boost::shared_ptr playlist() const { return _playlist.lock(); } + virtual void set_playlist (boost::weak_ptr); - virtual UndoAction get_memento() const = 0; + void source_deleted (boost::shared_ptr); + + boost::shared_ptr source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; } + uint32_t n_channels() const { return _sources.size(); } - void set_playlist (ARDOUR::Playlist*); + const SourceList& sources() const { return _sources; } + const SourceList& master_sources() const { return _master_sources; } - virtual void lock_sources () {} - virtual void unlock_sources () {} + std::vector master_source_names(); + void set_master_sources (const SourceList&); + + /* automation */ + + virtual boost::shared_ptr + control(const Evoral::Parameter& id, bool create=false) = 0; + virtual boost::shared_ptr + control(const Evoral::Parameter& id) const = 0; + /* serialization */ + XMLNode& get_state (); virtual XMLNode& state (bool); - XMLNode& get_state (); - int set_state (const XMLNode&); + virtual int set_state (const XMLNode&); + virtual int set_live_state (const XMLNode&, Change&, bool send); - sigc::signal GoingAway; + 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); + + 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; - /* This is emitted only when a new id is assigned. Therefore, - in a pure Region copy, it will not be emitted. + virtual int get_transients (AnalysisFeatureList&, bool force_new = false) { + // no transients, but its OK + return 0; + } + + virtual int separate_by_channel (ARDOUR::Session&, + std::vector< boost::shared_ptr >&) const { + return 0; + } - It must be emitted by derived classes, not Region - itself, to permit dynamic_cast<> to be used to - infer the type of Region. - */ + void invalidate_transients (); - static sigc::signal CheckNewRegion; + protected: + friend class RegionFactory; - virtual Region* get_parent() = 0; + Region (boost::shared_ptr src, nframes_t start, nframes_t length, + const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags); + Region (const SourceList& srcs, nframes_t start, nframes_t length, + const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags); - uint64_t last_layer_op() const { return _last_layer_op; } - void set_last_layer_op (uint64_t when); + Region (boost::shared_ptr, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags); + Region (boost::shared_ptr, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags); + Region (boost::shared_ptr); + Region (boost::shared_ptr src, const XMLNode&); + Region (const SourceList& srcs, const XMLNode&); + + Region (Session& s, nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags); protected: + void copy_stuff (boost::shared_ptr, nframes_t start, nframes_t length, const string& name, layer_t, Flag flags); - jack_nframes_t _start; - jack_nframes_t _length; - jack_nframes_t _position; - Flag _flags; - jack_nframes_t _sync_position; - layer_t _layer; - string _name; - mutable RegionEditState _first_edit; - int _frozen; - Glib::Mutex lock; - ARDOUR::id_t _id; - ARDOUR::Playlist* _playlist; - mutable uint32_t _read_data_count; // modified in read() - Change pending_changed; - uint64_t _last_layer_op; // timestamp - XMLNode& get_short_state (); /* used only by Session */ - /* state management */ - void send_change (Change); - void send_state_changed (); - - /* derived classes need these during their own state management calls */ - void store_state (RegionState&) const; - Change restore_and_return_flags (RegionState&); - - void trim_to_internal (jack_nframes_t position, jack_nframes_t length, void *src); + 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 (jack_nframes_t) = 0; - virtual bool verify_start_and_length (jack_nframes_t, jack_nframes_t) = 0; - virtual bool verify_start_mutable (jack_nframes_t&_start) = 0; - virtual bool verify_length (jack_nframes_t) = 0; + 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; + + 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 + Glib::Mutex _lock; + SourceList _sources; + /** Used when timefx are applied, so we can always use the original source */ + SourceList _master_sources; + + boost::weak_ptr _playlist; }; } /* namespace ARDOUR */