2 Copyright (C) 2000-2001 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_region_h__
21 #define __ardour_region_h__
24 #include <boost/shared_ptr.hpp>
25 #include <boost/enable_shared_from_this.hpp>
26 #include <boost/utility.hpp>
29 #include "pbd/signals.h"
31 #include "ardour/ardour.h"
32 #include "ardour/data_type.h"
33 #include "ardour/automatable.h"
34 #include "ardour/movable.h"
35 #include "ardour/readable.h"
36 #include "ardour/session_object.h"
37 #include "ardour/trimmable.h"
44 namespace Properties {
45 extern PBD::PropertyDescriptor<bool> muted;
46 extern PBD::PropertyDescriptor<bool> opaque;
47 extern PBD::PropertyDescriptor<bool> locked;
48 extern PBD::PropertyDescriptor<bool> automatic;
49 extern PBD::PropertyDescriptor<bool> whole_file;
50 extern PBD::PropertyDescriptor<bool> import;
51 extern PBD::PropertyDescriptor<bool> external;
52 extern PBD::PropertyDescriptor<bool> sync_marked;
53 extern PBD::PropertyDescriptor<bool> left_of_split;
54 extern PBD::PropertyDescriptor<bool> right_of_split;
55 extern PBD::PropertyDescriptor<bool> hidden;
56 extern PBD::PropertyDescriptor<bool> position_locked;
57 extern PBD::PropertyDescriptor<bool> valid_transients;
58 extern PBD::PropertyDescriptor<framepos_t> start;
59 extern PBD::PropertyDescriptor<framecnt_t> length;
60 extern PBD::PropertyDescriptor<framepos_t> position;
61 extern PBD::PropertyDescriptor<framecnt_t> sync_position;
62 extern PBD::PropertyDescriptor<layer_t> layer;
63 extern PBD::PropertyDescriptor<framepos_t> ancestral_start;
64 extern PBD::PropertyDescriptor<framecnt_t> ancestral_length;
65 extern PBD::PropertyDescriptor<float> stretch;
66 extern PBD::PropertyDescriptor<float> shift;
67 extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
72 class ExportSpecification;
75 enum RegionEditState {
76 EditChangesNothing = 0,
83 : public SessionObject
84 , public boost::enable_shared_from_this<Region>
90 typedef std::vector<boost::shared_ptr<Source> > SourceList;
92 static void make_property_quarks ();
94 static PBD::Signal2<void,boost::shared_ptr<ARDOUR::Region>, const PBD::PropertyChange&> RegionPropertyChanged;
98 /** Note: changing the name of a Region does not constitute an edit */
99 bool set_name (const std::string& str);
101 const DataType& data_type () const { return _type; }
103 AnalysisFeatureList transients () { return _transients; };
105 /** How the region parameters play together:
107 * POSITION: first frame of the region along the timeline
108 * START: first frame of the region within its source(s)
109 * LENGTH: number of frames the region represents
111 framepos_t position () const { return _position; }
112 framepos_t start () const { return _start; }
113 framecnt_t length () const { return _length; }
114 layer_t layer () const { return _layer; }
116 framecnt_t source_length(uint32_t n) const;
118 /* these two are valid ONLY during a StateChanged signal handler */
120 framepos_t last_position () const { return _last_position; }
121 framecnt_t last_length () const { return _last_length; }
123 framepos_t ancestral_start () const { return _ancestral_start; }
124 framecnt_t ancestral_length () const { return _ancestral_length; }
126 float stretch () const { return _stretch; }
127 float shift () const { return _shift; }
129 void set_ancestral_data (framepos_t start, framepos_t length, float stretch, float shift);
131 frameoffset_t sync_offset (int& dir) const;
132 framepos_t sync_position () const;
133 framepos_t sync_point () const;
135 framepos_t adjust_to_sync (framepos_t) const;
137 /* first_frame() is an alias; last_frame() just hides some math */
139 framepos_t first_frame () const { return _position; }
140 framepos_t last_frame () const { return _position + _length - 1; }
142 bool hidden () const { return _hidden; }
143 bool muted () const { return _muted; }
144 bool opaque () const { return _opaque; }
145 bool locked () const { return _locked; }
146 bool position_locked () const { return _position_locked; }
147 bool valid_transients () const { return _valid_transients; }
148 bool automatic () const { return _automatic; }
149 bool whole_file () const { return _whole_file; }
150 bool captured () const { return !(_import || _external); }
151 bool can_move () const { return !_position_locked; }
152 bool sync_marked () const { return _sync_marked; }
153 bool external () const { return _external; }
154 bool import () const { return _import; }
156 Trimmable::CanTrim can_trim () const;
158 PositionLockStyle position_lock_style () const { return _position_lock_style; }
159 void set_position_lock_style (PositionLockStyle ps);
160 void recompute_position_from_lock_style ();
162 void suspend_property_changes ();
164 bool covers (framepos_t frame) const {
165 return first_frame() <= frame && frame <= last_frame();
168 OverlapType coverage (framepos_t start, framepos_t end) const {
169 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
172 bool equivalent (boost::shared_ptr<const Region>) const;
173 bool size_equivalent (boost::shared_ptr<const Region>) const;
174 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
175 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
176 bool source_equivalent (boost::shared_ptr<const Region>) const;
177 bool uses_source (boost::shared_ptr<const Source>) const;
179 /* EDITING OPERATIONS */
181 void set_length (framecnt_t, void *src);
182 void set_start (framepos_t, void *src);
183 void set_position (framepos_t, void *src);
184 void set_position_on_top (framepos_t, void *src);
185 void special_set_position (framepos_t);
186 void update_position_after_tempo_map_change ();
187 void nudge_position (frameoffset_t, void *src);
189 bool at_natural_position () const;
190 void move_to_natural_position (void *src);
192 void trim_start (framepos_t new_position, void *src);
193 void trim_front (framepos_t new_position, void *src);
194 void trim_end (framepos_t new_position, void *src);
195 void trim_to (framepos_t position, framecnt_t length, void *src);
197 void cut_front (framepos_t new_position, void *src);
198 void cut_end (framepos_t new_position, void *src);
200 void set_layer (layer_t l); /* ONLY Playlist can call this */
203 void raise_to_top ();
204 void lower_to_bottom ();
206 void set_sync_position (framepos_t n);
207 void clear_sync_position ();
208 void set_hidden (bool yn);
209 void set_muted (bool yn);
210 void set_whole_file (bool yn);
211 void set_automatic (bool yn);
212 void set_opaque (bool yn);
213 void set_locked (bool yn);
214 void set_position_locked (bool yn);
216 int apply (Filter &, Progress* progress = 0);
218 virtual uint64_t read_data_count () const { return _read_data_count; }
220 boost::shared_ptr<ARDOUR::Playlist> playlist () const { return _playlist.lock(); }
221 virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
223 void source_deleted (boost::weak_ptr<Source>);
225 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
226 uint32_t n_channels() const { return _sources.size(); }
228 const SourceList& sources () const { return _sources; }
229 const SourceList& master_sources () const { return _master_sources; }
231 std::vector<std::string> master_source_names();
232 void set_master_sources (const SourceList&);
236 virtual boost::shared_ptr<Evoral::Control>
237 control (const Evoral::Parameter& id, bool create=false) = 0;
239 virtual boost::shared_ptr<const Evoral::Control>
240 control (const Evoral::Parameter& id) const = 0;
244 XMLNode& get_state ();
245 virtual XMLNode& state ();
246 virtual int set_state (const XMLNode&, int version);
248 virtual boost::shared_ptr<Region> get_parent() const;
250 uint64_t last_layer_op() const { return _last_layer_op; }
251 void set_last_layer_op (uint64_t when);
253 virtual bool is_dependent() const { return false; }
254 virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
256 virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
258 virtual void add_transient (framepos_t) {
259 // no transients, but its OK
262 virtual int update_transient (framepos_t /* old_position */, framepos_t /* new_position */) {
263 // no transients, but its OK
267 virtual void remove_transient (framepos_t /* where */) {
268 // no transients, but its OK
271 virtual int set_transients (AnalysisFeatureList&) {
272 // no transients, but its OK
276 virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
278 // no transients, but its OK
282 virtual int adjust_transients (framepos_t /*delta*/) {
283 // no transients, but its OK
287 virtual int separate_by_channel (ARDOUR::Session&,
288 std::vector< boost::shared_ptr<Region> >&) const {
292 void invalidate_transients ();
294 void set_pending_explicit_relayer (bool p) {
295 _pending_explicit_relayer = p;
298 bool pending_explicit_relayer () const {
299 return _pending_explicit_relayer;
302 void drop_sources ();
305 friend class RegionFactory;
307 /** Construct a region from multiple sources*/
308 Region (const SourceList& srcs);
310 /** Construct a region from another region */
311 Region (boost::shared_ptr<const Region>);
313 /** Construct a region from another region, at an offset within that region */
314 Region (boost::shared_ptr<const Region>, frameoffset_t start_offset);
316 /** Construct a region as a copy of another region, but with different sources */
317 Region (boost::shared_ptr<const Region>, const SourceList&);
319 /** Constructor for derived types only */
320 Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType);
322 virtual bool can_trim_start_before_source_start () const {
327 void send_change (const PBD::PropertyChange&);
328 void mid_thaw (const PBD::PropertyChange&);
330 void trim_to_internal (framepos_t position, framecnt_t length, void *src);
331 virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
332 virtual void set_length_internal (framepos_t pos);
333 void modify_front (framepos_t new_position, bool reset_fade, void* src);
334 void modify_end (framepos_t new_position, bool reset_fade, void* src);
336 void maybe_uncopy ();
339 bool verify_start (framepos_t);
340 bool verify_start_and_length (framepos_t, framecnt_t&);
341 bool verify_start_mutable (framepos_t&_start);
342 bool verify_length (framecnt_t);
344 virtual void recompute_at_start () = 0;
345 virtual void recompute_at_end () = 0;
349 PBD::Property<bool> _muted;
350 PBD::Property<bool> _opaque;
351 PBD::Property<bool> _locked;
352 PBD::Property<bool> _automatic;
353 PBD::Property<bool> _whole_file;
354 PBD::Property<bool> _import;
355 PBD::Property<bool> _external;
356 PBD::Property<bool> _sync_marked;
357 PBD::Property<bool> _left_of_split;
358 PBD::Property<bool> _right_of_split;
359 PBD::Property<bool> _hidden;
360 PBD::Property<bool> _position_locked;
361 PBD::Property<bool> _valid_transients;
362 PBD::Property<framepos_t> _start;
363 PBD::Property<framecnt_t> _length;
364 PBD::Property<framepos_t> _position;
365 /** Sync position relative to the start of our file */
366 PBD::Property<framepos_t> _sync_position;
367 PBD::Property<layer_t> _layer;
368 PBD::Property<framepos_t> _ancestral_start;
369 PBD::Property<framecnt_t> _ancestral_length;
370 PBD::Property<float> _stretch;
371 PBD::Property<float> _shift;
372 PBD::EnumProperty<PositionLockStyle> _position_lock_style;
374 framecnt_t _last_length;
375 framepos_t _last_position;
376 mutable RegionEditState _first_edit;
377 Timecode::BBT_Time _bbt_time;
378 AnalysisFeatureList _transients;
380 mutable uint64_t _read_data_count; ///< modified in read()
381 uint64_t _last_layer_op; ///< timestamp
383 /** Used when timefx are applied, so we can always use the original source */
384 SourceList _master_sources;
386 /** true if this region has had its layer explicitly set since the playlist last relayered */
387 bool _pending_explicit_relayer;
389 boost::weak_ptr<ARDOUR::Playlist> _playlist;
391 virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
393 void register_properties ();
396 void use_sources (SourceList const &);
399 } /* namespace ARDOUR */
401 #endif /* __ardour_region_h__ */