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.
21 #ifndef __ardour_region_h__
22 #define __ardour_region_h__
25 #include <boost/shared_ptr.hpp>
26 #include <boost/enable_shared_from_this.hpp>
29 #include <pbd/statefuldestructible.h>
31 #include <ardour/ardour.h>
32 #include <ardour/state_manager.h>
33 #include <ardour/data_type.h>
41 enum RegionEditState {
42 EditChangesNothing = 0,
47 struct RegionState : public StateManager::State
49 RegionState (std::string why) : StateManager::State (why) {}
51 jack_nframes_t _start;
52 jack_nframes_t _length;
53 jack_nframes_t _position;
55 jack_nframes_t _sync_position;
58 mutable RegionEditState _first_edit;
61 class Region : public PBD::StatefulDestructible, public StateManager, public boost::enable_shared_from_this<Region>
64 typedef std::vector<boost::shared_ptr<Source> > SourceList;
71 DefaultFadeOut = 0x10,
82 RightOfSplit = 0x8000,
84 DoNotSaveState = 0x20000,
86 range_guarantoor = USHRT_MAX
89 static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
91 static Change FadeChanged;
92 static Change SyncOffsetChanged;
93 static Change MuteChanged;
94 static Change OpacityChanged;
95 static Change LockChanged;
96 static Change LayerChanged;
97 static Change HiddenChanged;
101 /* Note: changing the name of a Region does not constitute an edit */
103 string name() const { return _name; }
104 void set_name (string str);
106 const DataType& data_type() const { return _type; }
108 jack_nframes_t position () const { return _position; }
109 jack_nframes_t start () const { return _start; }
110 jack_nframes_t length() const { return _length; }
111 layer_t layer () const { return _layer; }
113 jack_nframes_t sync_offset(int& dir) const;
114 jack_nframes_t sync_position() const;
116 jack_nframes_t adjust_to_sync (jack_nframes_t);
118 /* first_frame() is an alias; last_frame() just hides some math */
120 jack_nframes_t first_frame() const { return _position; }
121 jack_nframes_t last_frame() const { return _position + _length - 1; }
123 Flag flags() const { return _flags; }
124 bool hidden() const { return _flags & Hidden; }
125 bool muted() const { return _flags & Muted; }
126 bool opaque () const { return _flags & Opaque; }
127 bool locked() const { return _flags & Locked; }
128 bool automatic() const { return _flags & Automatic; }
129 bool whole_file() const { return _flags & WholeFile ; }
130 bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
132 virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
135 void thaw (const string& why);
137 bool covers (jack_nframes_t frame) const {
138 return _position <= frame && frame < _position + _length;
141 OverlapType coverage (jack_nframes_t start, jack_nframes_t end) const {
142 return ARDOUR::coverage (_position, _position + _length - 1, start, end);
145 bool equivalent (boost::shared_ptr<const Region>) const;
146 bool size_equivalent (boost::shared_ptr<const Region>) const;
147 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
148 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
149 bool source_equivalent (boost::shared_ptr<const Region>) const;
151 /* EDITING OPERATIONS */
153 void set_length (jack_nframes_t, void *src);
154 void set_start (jack_nframes_t, void *src);
155 void set_position (jack_nframes_t, void *src);
156 void set_position_on_top (jack_nframes_t, void *src);
157 void special_set_position (jack_nframes_t);
158 void nudge_position (long, void *src);
160 void move_to_natural_position (void *src);
162 void trim_start (jack_nframes_t new_position, void *src);
163 void trim_front (jack_nframes_t new_position, void *src);
164 void trim_end (jack_nframes_t new_position, void *src);
165 void trim_to (jack_nframes_t position, jack_nframes_t length, void *src);
167 void set_layer (layer_t l); /* ONLY Playlist can call this */
170 void raise_to_top ();
171 void lower_to_bottom ();
173 void set_sync_position (jack_nframes_t n);
174 void clear_sync_position ();
175 void set_hidden (bool yn);
176 void set_muted (bool yn);
177 void set_opaque (bool yn);
178 void set_locked (bool yn);
180 virtual uint32_t read_data_count() const { return _read_data_count; }
182 ARDOUR::Playlist* playlist() const { return _playlist; }
184 virtual UndoAction get_memento() const = 0;
186 void set_playlist (ARDOUR::Playlist*);
188 void source_deleted (boost::shared_ptr<Source>);
190 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
191 uint32_t n_channels() const { return _sources.size(); }
193 std::vector<string> master_source_names();
198 XMLNode& get_state ();
199 virtual XMLNode& state (bool);
200 virtual int set_state (const XMLNode&);
202 boost::shared_ptr<Region> get_parent();
204 uint64_t last_layer_op() const { return _last_layer_op; }
205 void set_last_layer_op (uint64_t when);
208 friend class RegionFactory;
210 Region (boost::shared_ptr<Source> src, jack_nframes_t start, jack_nframes_t length,
211 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
212 Region (SourceList& srcs, jack_nframes_t start, jack_nframes_t length,
213 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
214 Region (boost::shared_ptr<const Region>, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
215 Region (boost::shared_ptr<const Region>);
216 Region (boost::shared_ptr<Source> src, const XMLNode&);
217 Region (SourceList& srcs, const XMLNode&);
220 XMLNode& get_short_state (); /* used only by Session */
222 /* state management */
224 void send_change (Change);
226 /* derived classes need these during their own state management calls */
228 void store_state (RegionState&) const;
229 Change restore_and_return_flags (RegionState&);
231 void trim_to_internal (jack_nframes_t position, jack_nframes_t length, void *src);
233 bool copied() const { return _flags & Copied; }
234 void maybe_uncopy ();
237 bool verify_start (jack_nframes_t);
238 bool verify_start_and_length (jack_nframes_t, jack_nframes_t);
239 bool verify_start_mutable (jack_nframes_t&_start);
240 bool verify_length (jack_nframes_t);
241 virtual void recompute_at_start () = 0;
242 virtual void recompute_at_end () = 0;
249 jack_nframes_t _start;
250 jack_nframes_t _length;
251 jack_nframes_t _position;
252 jack_nframes_t _sync_position;
254 mutable RegionEditState _first_edit;
256 mutable uint32_t _read_data_count; ///< modified in read()
257 Change _pending_changed;
258 uint64_t _last_layer_op; ///< timestamp
260 ARDOUR::Playlist* _playlist;
262 /** Used when timefx are applied, so we can always use the original source */
263 SourceList _master_sources;
266 } /* namespace ARDOUR */
268 #endif /* __ardour_region_h__ */