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__
24 #include <boost/shared_ptr.hpp>
25 #include <boost/enable_shared_from_this.hpp>
28 #include <pbd/statefuldestructible.h>
30 #include <ardour/ardour.h>
31 #include <ardour/state_manager.h>
39 enum RegionEditState {
40 EditChangesNothing = 0,
45 struct RegionState : public StateManager::State
47 RegionState (std::string why) : StateManager::State (why) {}
53 nframes_t _sync_position;
56 mutable RegionEditState _first_edit;
59 class Region : public PBD::StatefulDestructible, public StateManager, public boost::enable_shared_from_this<Region>
67 DefaultFadeOut = 0x10,
78 RightOfSplit = 0x8000,
80 DoNotSaveState = 0x20000,
82 range_guarantoor = USHRT_MAX
85 static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
87 static Change FadeChanged;
88 static Change SyncOffsetChanged;
89 static Change MuteChanged;
90 static Change OpacityChanged;
91 static Change LockChanged;
92 static Change LayerChanged;
93 static Change HiddenChanged;
97 /* Note: changing the name of a Region does not constitute an edit */
99 string name() const { return _name; }
100 void set_name (string str);
102 nframes_t position () const { return _position; }
103 nframes_t start () const { return _start; }
104 nframes_t length() const { return _length; }
105 layer_t layer () const { return _layer; }
107 nframes_t sync_offset(int& dir) const;
108 nframes_t sync_position() const;
110 nframes_t adjust_to_sync (nframes_t);
112 /* first_frame() is an alias; last_frame() just hides some math */
114 nframes_t first_frame() const { return _position; }
115 nframes_t last_frame() const { return _position + _length - 1; }
117 bool hidden() const { return _flags & Hidden; }
118 bool muted() const { return _flags & Muted; }
119 bool opaque () const { return _flags & Opaque; }
120 bool locked() const { return _flags & Locked; }
121 bool automatic() const { return _flags & Automatic; }
122 bool whole_file() const { return _flags & WholeFile ; }
123 Flag flags() const { return _flags; }
125 virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
128 void thaw (const string& why);
130 bool covers (nframes_t frame) const {
131 return first_frame() <= frame && frame < last_frame();
134 OverlapType coverage (nframes_t start, nframes_t end) const {
135 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
138 bool equivalent (boost::shared_ptr<const Region>) const;
139 bool size_equivalent (boost::shared_ptr<const Region>) const;
140 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
141 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
142 virtual bool source_equivalent (boost::shared_ptr<const Region>) const = 0;
144 virtual bool speed_mismatch (float) const = 0;
146 /* EDITING OPERATIONS */
148 void set_length (nframes_t, void *src);
149 void set_start (nframes_t, void *src);
150 void set_position (nframes_t, void *src);
151 void set_position_on_top (nframes_t, void *src);
152 void special_set_position (nframes_t);
153 void nudge_position (long, void *src);
155 void move_to_natural_position (void *src);
157 void trim_start (nframes_t new_position, void *src);
158 void trim_front (nframes_t new_position, void *src);
159 void trim_end (nframes_t new_position, void *src);
160 void trim_to (nframes_t position, nframes_t length, void *src);
162 void set_layer (layer_t l); /* ONLY Playlist can call this */
165 void raise_to_top ();
166 void lower_to_bottom ();
168 void set_sync_position (nframes_t n);
169 void clear_sync_position ();
170 void set_hidden (bool yn);
171 void set_muted (bool yn);
172 void set_opaque (bool yn);
173 void set_locked (bool yn);
175 virtual uint32_t read_data_count() const { return _read_data_count; }
177 ARDOUR::Playlist* playlist() const { return _playlist; }
179 virtual UndoAction get_memento() const = 0;
181 void set_playlist (ARDOUR::Playlist*);
183 virtual void lock_sources () {}
184 virtual void unlock_sources () {}
188 XMLNode& get_state ();
189 virtual XMLNode& state (bool);
190 virtual int set_state (const XMLNode&);
192 virtual boost::shared_ptr<Region> get_parent() = 0;
194 uint64_t last_layer_op() const { return _last_layer_op; }
195 void set_last_layer_op (uint64_t when);
198 friend class RegionFactory;
200 Region (nframes_t start, nframes_t length,
201 const string& name, layer_t = 0, Flag flags = DefaultFlags);
202 Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
203 Region (boost::shared_ptr<const Region>);
204 Region (const XMLNode&);
208 XMLNode& get_short_state (); /* used only by Session */
210 /* state management */
212 void send_change (Change);
214 /* derived classes need these during their own state management calls */
216 void store_state (RegionState&) const;
217 Change restore_and_return_flags (RegionState&);
219 void trim_to_internal (nframes_t position, nframes_t length, void *src);
221 bool copied() const { return _flags & Copied; }
222 void maybe_uncopy ();
225 virtual bool verify_start (nframes_t) = 0;
226 virtual bool verify_start_and_length (nframes_t, nframes_t) = 0;
227 virtual bool verify_start_mutable (nframes_t&_start) = 0;
228 virtual bool verify_length (nframes_t) = 0;
229 virtual void recompute_at_start () = 0;
230 virtual void recompute_at_end () = 0;
237 nframes_t _sync_position;
240 mutable RegionEditState _first_edit;
243 ARDOUR::Playlist* _playlist;
244 mutable uint32_t _read_data_count; // modified in read()
245 Change pending_changed;
246 uint64_t _last_layer_op; // timestamp
249 } /* namespace ARDOUR */
251 #endif /* __ardour_region_h__ */