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>
30 #include <ardour/ardour.h>
31 #include <ardour/data_type.h>
32 #include <ardour/automatable.h>
33 #include <ardour/readable.h>
34 #include <ardour/session_object.h>
42 class ExportSpecification;
44 enum RegionEditState {
45 EditChangesNothing = 0,
51 : public SessionObject
52 , public boost::noncopyable
53 , public boost::enable_shared_from_this<Region>
57 typedef std::vector<boost::shared_ptr<Source> > SourceList;
64 DefaultFadeOut = 0x10,
75 RightOfSplit = 0x8000,
77 DoNotSaveState = 0x20000,
78 PositionLocked = 0x40000,
80 range_guarantoor = USHRT_MAX
83 enum PositionLockStyle {
88 static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
90 static Change FadeChanged;
91 static Change SyncOffsetChanged;
92 static Change MuteChanged;
93 static Change OpacityChanged;
94 static Change LockChanged;
95 static Change LayerChanged;
96 static Change HiddenChanged;
98 sigc::signal<void,Change> StateChanged;
99 static sigc::signal<void,boost::shared_ptr<ARDOUR::Region> > RegionPropertyChanged;
103 /** Note: changing the name of a Region does not constitute an edit */
104 bool set_name (const std::string& str);
106 const DataType& data_type() const { return _type; }
109 * Thats how the region parameters play together:
111 * |------------------------------------------------------------------- track
112 * |..........[------------------].....| region
113 * |-----------------------------| _position
114 * |------------------| _length
115 * |----------| _start
118 nframes_t position () const { return _position; }
119 nframes_t start () const { return _start; }
120 nframes_t length() const { return _length; }
121 layer_t layer () const { return _layer; }
123 sframes_t source_length(uint32_t n) const;
125 /* these two are valid ONLY during a StateChanged signal handler */
127 nframes_t last_position() const { return _last_position; }
128 nframes_t last_length() const { return _last_length; }
130 nframes64_t ancestral_start () const { return _ancestral_start; }
131 nframes64_t ancestral_length () const { return _ancestral_length; }
132 float stretch() const { return _stretch; }
133 float shift() const { return _shift; }
135 void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
137 nframes_t sync_offset(int& dir) const;
138 nframes_t sync_position() const;
139 nframes_t sync_point () const;
141 nframes_t adjust_to_sync (nframes_t) const;
143 /* first_frame() is an alias; last_frame() just hides some math */
145 nframes_t first_frame() const { return _position; }
146 nframes_t last_frame() const { return _position + _length - 1; }
148 Flag flags() const { return _flags; }
149 bool hidden() const { return _flags & Hidden; }
150 bool muted() const { return _flags & Muted; }
151 bool opaque () const { return _flags & Opaque; }
152 bool locked() const { return _flags & Locked; }
153 bool position_locked() const { return _flags & PositionLocked; }
154 bool automatic() const { return _flags & Automatic; }
155 bool whole_file() const { return _flags & WholeFile ; }
156 bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
157 bool can_move() const { return !(_flags & (Locked|PositionLocked)); }
159 PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
160 void set_position_lock_style (PositionLockStyle ps);
161 void recompute_position_from_lock_style ();
163 virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
166 void thaw (const string& why);
168 bool covers (nframes_t frame) const {
169 return first_frame() <= frame && frame <= last_frame();
172 OverlapType coverage (nframes_t start, nframes_t end) const {
173 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
176 bool equivalent (boost::shared_ptr<const Region>) const;
177 bool size_equivalent (boost::shared_ptr<const Region>) const;
178 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
179 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
180 bool source_equivalent (boost::shared_ptr<const Region>) const;
182 /* EDITING OPERATIONS */
184 void set_length (nframes_t, void *src);
185 void set_start (nframes_t, void *src);
186 void set_position (nframes_t, void *src);
187 void set_position_on_top (nframes_t, void *src);
188 void special_set_position (nframes_t);
189 void update_position_after_tempo_map_change ();
190 void nudge_position (nframes64_t, void *src);
192 bool at_natural_position () const;
193 void move_to_natural_position (void *src);
195 void trim_start (nframes_t new_position, void *src);
196 void trim_front (nframes_t new_position, void *src);
197 void trim_end (nframes_t new_position, void *src);
198 void trim_to (nframes_t position, nframes_t length, 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 (nframes_t n);
207 void clear_sync_position ();
208 void set_hidden (bool yn);
209 void set_muted (bool yn);
210 void set_opaque (bool yn);
211 void set_locked (bool yn);
212 void set_position_locked (bool yn);
216 virtual uint32_t read_data_count() const { return _read_data_count; }
218 boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
219 virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
221 void source_deleted (boost::shared_ptr<Source>);
223 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
224 uint32_t n_channels() const { return _sources.size(); }
226 const SourceList& sources() const { return _sources; }
227 const SourceList& master_sources() const { return _master_sources; }
229 std::vector<string> master_source_names();
230 void set_master_sources (const SourceList&);
234 virtual boost::shared_ptr<Evoral::Control>
235 control(const Evoral::Parameter& id, bool create=false) = 0;
237 virtual boost::shared_ptr<const Evoral::Control>
238 control(const Evoral::Parameter& id) const = 0;
242 XMLNode& get_state ();
243 virtual XMLNode& state (bool);
244 virtual int set_state (const XMLNode&);
245 virtual int set_live_state (const XMLNode&, Change&, bool send);
247 virtual boost::shared_ptr<Region> get_parent() const;
249 uint64_t last_layer_op() const { return _last_layer_op; }
250 void set_last_layer_op (uint64_t when);
252 virtual bool is_dependent() const { return false; }
253 virtual bool depends_on (boost::shared_ptr<Region> other) const { return false; }
255 virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
257 virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
258 // no transients, but its OK
262 virtual int separate_by_channel (ARDOUR::Session&,
263 std::vector< boost::shared_ptr<Region> >&) const {
267 void invalidate_transients ();
270 friend class RegionFactory;
272 Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length,
273 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
274 Region (const SourceList& srcs, nframes_t start, nframes_t length,
275 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
277 Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
278 Region (boost::shared_ptr<const Region>, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
279 Region (boost::shared_ptr<const Region>);
280 Region (boost::shared_ptr<Source> src, const XMLNode&);
281 Region (const SourceList& srcs, const XMLNode&);
283 Region (Session& s, nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
286 void copy_stuff (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t, Flag flags);
288 XMLNode& get_short_state (); /* used only by Session */
290 void send_change (Change);
292 void trim_to_internal (nframes_t position, nframes_t length, void *src);
293 virtual void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
295 bool copied() const { return _flags & Copied; }
296 void maybe_uncopy ();
299 bool verify_start (nframes_t);
300 bool verify_start_and_length (nframes_t, nframes_t&);
301 bool verify_start_mutable (nframes_t&_start);
302 bool verify_length (nframes_t);
304 virtual void recompute_at_start () = 0;
305 virtual void recompute_at_end () = 0;
311 nframes_t _last_length;
313 nframes_t _last_position;
314 PositionLockStyle _positional_lock_style;
315 nframes_t _sync_position;
317 mutable RegionEditState _first_edit;
319 nframes64_t _ancestral_start;
320 nframes64_t _ancestral_length;
324 AnalysisFeatureList _transients;
325 bool _valid_transients;
326 mutable uint32_t _read_data_count; ///< modified in read()
327 Change _pending_changed;
328 uint64_t _last_layer_op; ///< timestamp
331 /** Used when timefx are applied, so we can always use the original source */
332 SourceList _master_sources;
334 boost::weak_ptr<ARDOUR::Playlist> _playlist;
337 } /* namespace ARDOUR */
339 #endif /* __ardour_region_h__ */