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/readable.h"
35 #include "ardour/session_object.h"
42 namespace Properties {
43 extern PBD::PropertyDescriptor<bool> muted;
44 extern PBD::PropertyDescriptor<bool> opaque;
45 extern PBD::PropertyDescriptor<bool> locked;
46 extern PBD::PropertyDescriptor<bool> automatic;
47 extern PBD::PropertyDescriptor<bool> whole_file;
48 extern PBD::PropertyDescriptor<bool> import;
49 extern PBD::PropertyDescriptor<bool> external;
50 extern PBD::PropertyDescriptor<bool> sync_marked;
51 extern PBD::PropertyDescriptor<bool> left_of_split;
52 extern PBD::PropertyDescriptor<bool> right_of_split;
53 extern PBD::PropertyDescriptor<bool> hidden;
54 extern PBD::PropertyDescriptor<bool> position_locked;
55 extern PBD::PropertyDescriptor<framepos_t> start;
56 extern PBD::PropertyDescriptor<framecnt_t> length;
57 extern PBD::PropertyDescriptor<framepos_t> position;
58 extern PBD::PropertyDescriptor<framecnt_t> sync_position;
59 extern PBD::PropertyDescriptor<layer_t> layer;
60 extern PBD::PropertyDescriptor<framepos_t> ancestral_start;
61 extern PBD::PropertyDescriptor<framecnt_t> ancestral_length;
62 extern PBD::PropertyDescriptor<float> stretch;
63 extern PBD::PropertyDescriptor<float> shift;
68 class ExportSpecification;
70 enum RegionEditState {
71 EditChangesNothing = 0,
78 : public SessionObject
79 , public boost::enable_shared_from_this<Region>
83 typedef std::vector<boost::shared_ptr<Source> > SourceList;
85 static void make_property_quarks ();
87 enum PositionLockStyle {
92 static PBD::Signal2<void,boost::shared_ptr<ARDOUR::Region>, const PBD::PropertyChange&> RegionPropertyChanged;
94 void unlock_property_changes () { _no_property_changes = false; }
95 void block_property_changes () { _no_property_changes = true; }
99 /** Note: changing the name of a Region does not constitute an edit */
100 bool set_name (const std::string& str);
102 const DataType& data_type() const { return _type; }
104 /** How the region parameters play together:
106 * POSITION: first frame of the region along the timeline
107 * START: first frame of the region within its source(s)
108 * LENGTH: number of frames the region represents
110 sframes_t position () const { return _position; }
111 sframes_t start () const { return _start; }
112 framecnt_t length() const { return _length; }
113 layer_t layer () const { return _layer; }
115 framecnt_t source_length(uint32_t n) const;
117 /* these two are valid ONLY during a StateChanged signal handler */
119 sframes_t last_position() const { return _last_position; }
120 framecnt_t last_length() const { return _last_length; }
122 sframes_t ancestral_start () const { return _ancestral_start; }
123 framecnt_t ancestral_length () const { return _ancestral_length; }
124 float stretch() const { return _stretch; }
125 float shift() const { return _shift; }
127 void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
129 frameoffset_t sync_offset(int& dir) const;
130 framepos_t sync_position() const;
131 framepos_t sync_point () const;
133 framepos_t adjust_to_sync (framepos_t) const;
135 /* first_frame() is an alias; last_frame() just hides some math */
137 framepos_t first_frame() const { return _position; }
138 framepos_t last_frame() const { return _position + _length - 1; }
140 bool hidden() const { return _hidden; }
141 bool muted() const { return _muted; }
142 bool opaque () const { return _opaque; }
143 bool locked() const { return _locked; }
144 bool position_locked() const { return _position_locked; }
145 bool automatic() const { return _automatic; }
146 bool whole_file() const { return _whole_file; }
147 bool captured() const { return !(_import || _external); }
148 bool can_move() const { return !_position_locked; }
149 bool sync_marked() const { return _sync_marked; }
150 bool external() const { return _external; }
151 bool import() const { return _import; }
153 PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
154 void set_position_lock_style (PositionLockStyle ps);
155 void recompute_position_from_lock_style ();
160 bool covers (framepos_t frame) const {
161 return first_frame() <= frame && frame <= last_frame();
164 OverlapType coverage (framepos_t start, framepos_t end) const {
165 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
168 bool equivalent (boost::shared_ptr<const Region>) const;
169 bool size_equivalent (boost::shared_ptr<const Region>) const;
170 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
171 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
172 bool source_equivalent (boost::shared_ptr<const Region>) const;
173 bool uses_source (boost::shared_ptr<const Source>) const;
175 /* EDITING OPERATIONS */
177 void set_length (framecnt_t, void *src);
178 void set_start (framepos_t, void *src);
179 void set_position (framepos_t, void *src);
180 void set_position_on_top (framepos_t, void *src);
181 void special_set_position (framepos_t);
182 void update_position_after_tempo_map_change ();
183 void nudge_position (frameoffset_t, void *src);
185 bool at_natural_position () const;
186 void move_to_natural_position (void *src);
188 void trim_start (framepos_t new_position, void *src);
189 void trim_front (framepos_t new_position, void *src);
190 void trim_end (framepos_t new_position, void *src);
191 void trim_to (framepos_t position, framecnt_t length, void *src);
193 void set_layer (layer_t l); /* ONLY Playlist can call this */
196 void raise_to_top ();
197 void lower_to_bottom ();
199 void set_sync_position (framepos_t n);
200 void clear_sync_position ();
201 void set_hidden (bool yn);
202 void set_muted (bool yn);
203 void set_whole_file (bool yn);
204 void set_automatic (bool yn);
205 void set_opaque (bool yn);
206 void set_locked (bool yn);
207 void set_position_locked (bool yn);
211 virtual uint64_t read_data_count() const { return _read_data_count; }
213 boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
214 virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
216 void source_deleted (boost::weak_ptr<Source>);
218 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
219 uint32_t n_channels() const { return _sources.size(); }
221 const SourceList& sources() const { return _sources; }
222 const SourceList& master_sources() const { return _master_sources; }
224 std::vector<std::string> master_source_names();
225 void set_master_sources (const SourceList&);
229 virtual boost::shared_ptr<Evoral::Control>
230 control(const Evoral::Parameter& id, bool create=false) = 0;
232 virtual boost::shared_ptr<const Evoral::Control>
233 control(const Evoral::Parameter& id) const = 0;
237 XMLNode& get_state ();
238 virtual XMLNode& state (bool);
239 virtual int set_state (const XMLNode&, int version);
241 virtual boost::shared_ptr<Region> get_parent() const;
243 uint64_t last_layer_op() const { return _last_layer_op; }
244 void set_last_layer_op (uint64_t when);
246 virtual bool is_dependent() const { return false; }
247 virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
249 virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
251 virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
253 // no transients, but its OK
257 virtual int separate_by_channel (ARDOUR::Session&,
258 std::vector< boost::shared_ptr<Region> >&) const {
262 void invalidate_transients ();
264 void set_pending_explicit_relayer (bool p) {
265 _pending_explicit_relayer = p;
268 bool pending_explicit_relayer () const {
269 return _pending_explicit_relayer;
273 friend class RegionFactory;
275 /** Construct a region from multiple sources*/
276 Region (const SourceList& srcs);
277 /** Construct a region from another region, at an offset within that region */
278 Region (boost::shared_ptr<const Region>, frameoffset_t start_offset = 0, bool start_relative = true);
279 /** Construct a region as a copy of another region, but with different sources */
280 Region (boost::shared_ptr<const Region>, const SourceList&);
281 /** normal Region copy constructor */
282 Region (boost::shared_ptr<const Region>);
284 /** Constructor for derived types only */
285 Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType);
288 void send_change (const PBD::PropertyChange&);
290 void trim_to_internal (framepos_t position, framecnt_t length, void *src);
291 virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
293 void maybe_uncopy ();
296 bool verify_start (framepos_t);
297 bool verify_start_and_length (framepos_t, framecnt_t&);
298 bool verify_start_mutable (framepos_t&_start);
299 bool verify_length (framecnt_t);
301 virtual void recompute_at_start () = 0;
302 virtual void recompute_at_end () = 0;
305 bool _no_property_changes;
307 PBD::Property<bool> _muted;
308 PBD::Property<bool> _opaque;
309 PBD::Property<bool> _locked;
310 PBD::Property<bool> _automatic;
311 PBD::Property<bool> _whole_file;
312 PBD::Property<bool> _import;
313 PBD::Property<bool> _external;
314 PBD::Property<bool> _sync_marked;
315 PBD::Property<bool> _left_of_split;
316 PBD::Property<bool> _right_of_split;
317 PBD::Property<bool> _hidden;
318 PBD::Property<bool> _position_locked;
319 PBD::Property<framepos_t> _start;
320 PBD::Property<framecnt_t> _length;
321 PBD::Property<framepos_t> _position;
322 PBD::Property<framepos_t> _sync_position;
323 PBD::Property<layer_t> _layer;
324 PBD::Property<framepos_t> _ancestral_start;
325 PBD::Property<framecnt_t> _ancestral_length;
326 PBD::Property<float> _stretch;
327 PBD::Property<float> _shift;
329 framecnt_t _last_length;
330 framepos_t _last_position;
331 PositionLockStyle _positional_lock_style;
332 mutable RegionEditState _first_edit;
335 AnalysisFeatureList _transients;
336 bool _valid_transients;
337 mutable uint64_t _read_data_count; ///< modified in read()
338 PBD::PropertyChange _pending_changed;
339 uint64_t _last_layer_op; ///< timestamp
342 /** Used when timefx are applied, so we can always use the original source */
343 SourceList _master_sources;
345 /** true if this region has had its layer explicitly set since the playlist last relayered */
346 bool _pending_explicit_relayer;
348 boost::weak_ptr<ARDOUR::Playlist> _playlist;
350 virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
352 bool set_property (const PBD::PropertyBase&);
353 void register_properties ();
356 void use_sources (SourceList const &);
359 } /* namespace ARDOUR */
361 #endif /* __ardour_region_h__ */