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>
28 #include <pbd/statefuldestructible.h>
30 #include <ardour/ardour.h>
31 #include <ardour/data_type.h>
39 enum RegionEditState {
40 EditChangesNothing = 0,
45 class Region : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Region>
48 typedef std::vector<boost::shared_ptr<Source> > SourceList;
55 DefaultFadeOut = 0x10,
66 RightOfSplit = 0x8000,
68 DoNotSaveState = 0x20000,
69 PositionLocked = 0x40000,
71 range_guarantoor = USHRT_MAX
74 static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
76 static Change FadeChanged;
77 static Change SyncOffsetChanged;
78 static Change MuteChanged;
79 static Change OpacityChanged;
80 static Change LockChanged;
81 static Change LayerChanged;
82 static Change HiddenChanged;
84 sigc::signal<void,Change> StateChanged;
88 /* Note: changing the name of a Region does not constitute an edit */
90 string name() const { return _name; }
91 void set_name (string str);
93 const DataType& data_type() const { return _type; }
95 nframes_t position () const { return _position; }
96 nframes_t start () const { return _start; }
97 nframes_t length() const { return _length; }
98 layer_t layer () const { return _layer; }
100 nframes_t sync_offset(int& dir) const;
101 nframes_t sync_position() const;
103 nframes_t adjust_to_sync (nframes_t);
105 /* first_frame() is an alias; last_frame() just hides some math */
107 nframes_t first_frame() const { return _position; }
108 nframes_t last_frame() const { return _position + _length - 1; }
110 Flag flags() const { return _flags; }
111 bool hidden() const { return _flags & Hidden; }
112 bool muted() const { return _flags & Muted; }
113 bool opaque () const { return _flags & Opaque; }
114 bool locked() const { return _flags & Locked; }
115 bool position_locked() const { return _flags & PositionLocked; }
116 bool automatic() const { return _flags & Automatic; }
117 bool whole_file() const { return _flags & WholeFile ; }
118 bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
119 bool can_move() const { return !(_flags & (Locked|PositionLocked)); }
121 virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
124 void thaw (const string& why);
126 bool covers (nframes_t frame) const {
127 return first_frame() <= frame && frame < last_frame();
130 OverlapType coverage (nframes_t start, nframes_t end) const {
131 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
134 bool equivalent (boost::shared_ptr<const Region>) const;
135 bool size_equivalent (boost::shared_ptr<const Region>) const;
136 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
137 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
138 bool source_equivalent (boost::shared_ptr<const Region>) const;
140 /* EDITING OPERATIONS */
142 void set_length (nframes_t, void *src);
143 void set_start (nframes_t, void *src);
144 void set_position (nframes_t, void *src);
145 void set_position_on_top (nframes_t, void *src);
146 void special_set_position (nframes_t);
147 void nudge_position (long, void *src);
149 bool at_natural_position () const;
150 void move_to_natural_position (void *src);
152 void trim_start (nframes_t new_position, void *src);
153 void trim_front (nframes_t new_position, void *src);
154 void trim_end (nframes_t new_position, void *src);
155 void trim_to (nframes_t position, nframes_t length, void *src);
157 void set_layer (layer_t l); /* ONLY Playlist can call this */
158 void raise_to_top ();
159 void lower_to_bottom ();
161 void set_sync_position (nframes_t n);
162 void clear_sync_position ();
163 void set_hidden (bool yn);
164 void set_muted (bool yn);
165 void set_opaque (bool yn);
166 void set_locked (bool yn);
167 void set_position_locked (bool yn);
169 virtual uint32_t read_data_count() const { return _read_data_count; }
171 boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
172 virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
174 void source_deleted (boost::shared_ptr<Source>);
176 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
177 uint32_t n_channels() const { return _sources.size(); }
179 std::vector<string> master_source_names();
181 const SourceList& sources() const { return _sources; }
182 const SourceList& master_sources() const { return _master_sources; }
186 XMLNode& get_state ();
187 virtual XMLNode& state (bool);
188 virtual int set_state (const XMLNode&);
189 virtual int set_live_state (const XMLNode&, Change&, bool send);
191 virtual boost::shared_ptr<Region> get_parent() const;
193 uint64_t last_layer_op() const { return _last_layer_op; }
194 void set_last_layer_op (uint64_t when);
196 virtual bool is_dependent() const { return false; }
197 virtual bool depends_on (boost::shared_ptr<Region> other) const { return false; }
200 friend class RegionFactory;
202 Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length,
203 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
204 Region (SourceList& srcs, nframes_t start, nframes_t length,
205 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
207 Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
208 Region (boost::shared_ptr<const Region>);
209 Region (boost::shared_ptr<Source> src, const XMLNode&);
210 Region (SourceList& srcs, const XMLNode&);
212 /* this one is for derived types of derived types */
214 Region (nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
217 XMLNode& get_short_state (); /* used only by Session */
219 void send_change (Change);
221 void trim_to_internal (nframes_t position, nframes_t length, void *src);
223 bool copied() const { return _flags & Copied; }
224 void maybe_uncopy ();
227 virtual bool verify_start (nframes_t);
228 virtual bool verify_start_and_length (nframes_t, nframes_t);
229 virtual bool verify_start_mutable (nframes_t&_start);
230 virtual bool verify_length (nframes_t);
231 virtual void recompute_at_start () = 0;
232 virtual void recompute_at_end () = 0;
240 nframes_t _sync_position;
242 mutable RegionEditState _first_edit;
244 mutable uint32_t _read_data_count; ///< modified in read()
245 Change _pending_changed;
246 uint64_t _last_layer_op; ///< timestamp
248 boost::weak_ptr<ARDOUR::Playlist> _playlist;
250 /** Used when timefx are applied, so we can always use the original source */
251 SourceList _master_sources;
254 } /* namespace ARDOUR */
256 #endif /* __ardour_region_h__ */