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>
29 #include <ardour/ardour.h>
30 #include <ardour/data_type.h>
31 #include <ardour/automatable.h>
32 #include <ardour/readable.h>
40 class ExportSpecification;
42 enum RegionEditState {
43 EditChangesNothing = 0,
48 class Region : public Automatable, public boost::enable_shared_from_this<Region>, public Readable
51 typedef std::vector<boost::shared_ptr<Source> > SourceList;
58 DefaultFadeOut = 0x10,
69 RightOfSplit = 0x8000,
71 DoNotSaveState = 0x20000,
72 PositionLocked = 0x40000,
74 range_guarantoor = USHRT_MAX
77 enum PositionLockStyle {
82 static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
84 static Change FadeChanged;
85 static Change SyncOffsetChanged;
86 static Change MuteChanged;
87 static Change OpacityChanged;
88 static Change LockChanged;
89 static Change LayerChanged;
90 static Change HiddenChanged;
92 sigc::signal<void,Change> StateChanged;
93 static sigc::signal<void,boost::shared_ptr<ARDOUR::Region> > RegionPropertyChanged;
97 /** Note: changing the name of a Region does not constitute an edit */
98 bool set_name (const std::string& str);
100 const DataType& data_type() const { return _type; }
103 * Thats how the region parameters play together:
105 * |------------------------------------------------------------------- track
106 * |..........[------------------].....| region
107 * |-----------------------------| _position
108 * |------------------| _length
109 * |----------| _start
112 nframes_t position () const { return _position; }
113 nframes_t start () const { return _start; }
114 nframes_t length() const { return _length; }
115 layer_t layer () const { return _layer; }
117 /* these two are valid ONLY during a StateChanged signal handler */
119 nframes_t last_position() const { return _last_position; }
120 nframes_t last_length() const { return _last_length; }
122 nframes64_t ancestral_start () const { return _ancestral_start; }
123 nframes64_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 nframes_t sync_offset(int& dir) const;
130 nframes_t sync_position() const;
132 nframes_t adjust_to_sync (nframes_t);
134 /* first_frame() is an alias; last_frame() just hides some math */
136 nframes_t first_frame() const { return _position; }
137 nframes_t last_frame() const { return _position + _length - 1; }
139 Flag flags() const { return _flags; }
140 bool hidden() const { return _flags & Hidden; }
141 bool muted() const { return _flags & Muted; }
142 bool opaque () const { return _flags & Opaque; }
143 bool locked() const { return _flags & Locked; }
144 bool position_locked() const { return _flags & PositionLocked; }
145 bool automatic() const { return _flags & Automatic; }
146 bool whole_file() const { return _flags & WholeFile ; }
147 bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
148 bool can_move() const { return !(_flags & (Locked|PositionLocked)); }
150 PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
151 void set_position_lock_style (PositionLockStyle ps);
152 void recompute_position_from_lock_style ();
154 virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
157 void thaw (const string& why);
159 bool covers (nframes_t frame) const {
160 return first_frame() <= frame && frame <= last_frame();
163 OverlapType coverage (nframes_t start, nframes_t end) const {
164 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
167 bool equivalent (boost::shared_ptr<const Region>) const;
168 bool size_equivalent (boost::shared_ptr<const Region>) const;
169 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
170 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
171 bool source_equivalent (boost::shared_ptr<const Region>) const;
173 /* EDITING OPERATIONS */
175 void set_length (nframes_t, void *src);
176 void set_start (nframes_t, void *src);
177 void set_position (nframes_t, void *src);
178 void set_position_on_top (nframes_t, void *src);
179 void special_set_position (nframes_t);
180 void update_position_after_tempo_map_change ();
181 void nudge_position (nframes64_t, void *src);
183 bool at_natural_position () const;
184 void move_to_natural_position (void *src);
186 void trim_start (nframes_t new_position, void *src);
187 void trim_front (nframes_t new_position, void *src);
188 void trim_end (nframes_t new_position, void *src);
189 void trim_to (nframes_t position, nframes_t length, void *src);
191 void set_layer (layer_t l); /* ONLY Playlist can call this */
194 void raise_to_top ();
195 void lower_to_bottom ();
197 void set_sync_position (nframes_t n);
198 void clear_sync_position ();
199 void set_hidden (bool yn);
200 void set_muted (bool yn);
201 void set_opaque (bool yn);
202 void set_locked (bool yn);
203 void set_position_locked (bool yn);
207 virtual uint32_t read_data_count() const { return _read_data_count; }
209 boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
210 virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
212 void source_deleted (boost::shared_ptr<Source>);
214 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
215 uint32_t n_channels() const { return _sources.size(); }
217 const SourceList& sources() const { return _sources; }
218 const SourceList& master_sources() const { return _master_sources; }
220 std::vector<string> master_source_names();
221 void set_master_sources (const SourceList&);
225 XMLNode& get_state ();
226 virtual XMLNode& state (bool);
227 virtual int set_state (const XMLNode&);
228 virtual int set_live_state (const XMLNode&, Change&, bool send);
230 virtual boost::shared_ptr<Region> get_parent() const;
232 uint64_t last_layer_op() const { return _last_layer_op; }
233 void set_last_layer_op (uint64_t when);
235 virtual bool is_dependent() const { return false; }
236 virtual bool depends_on (boost::shared_ptr<Region> other) const { return false; }
238 virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
240 virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
241 // no transients, but its OK
245 void invalidate_transients ();
248 friend class RegionFactory;
250 Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length,
251 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
252 Region (const SourceList& srcs, nframes_t start, nframes_t length,
253 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
255 Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
256 Region (boost::shared_ptr<const Region>);
257 Region (boost::shared_ptr<Source> src, const XMLNode&);
258 Region (const SourceList& srcs, const XMLNode&);
260 Region (Session& s, nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
263 XMLNode& get_short_state (); /* used only by Session */
265 void send_change (Change);
267 void trim_to_internal (nframes_t position, nframes_t length, void *src);
268 void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
270 bool copied() const { return _flags & Copied; }
271 void maybe_uncopy ();
274 bool verify_start (nframes_t);
275 bool verify_start_and_length (nframes_t, nframes_t&);
276 bool verify_start_mutable (nframes_t&_start);
277 bool verify_length (nframes_t);
279 virtual void recompute_at_start () = 0;
280 virtual void recompute_at_end () = 0;
286 nframes_t _last_length;
288 nframes_t _last_position;
289 PositionLockStyle _positional_lock_style;
290 nframes_t _sync_position;
292 mutable RegionEditState _first_edit;
294 nframes64_t _ancestral_start;
295 nframes64_t _ancestral_length;
299 AnalysisFeatureList _transients;
300 bool _valid_transients;
301 mutable uint32_t _read_data_count; ///< modified in read()
302 Change _pending_changed;
303 uint64_t _last_layer_op; ///< timestamp
306 /** Used when timefx are applied, so we can always use the original source */
307 SourceList _master_sources;
309 boost::weak_ptr<ARDOUR::Playlist> _playlist;
312 } /* namespace ARDOUR */
314 #endif /* __ardour_region_h__ */