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/data_type.h>
40 enum RegionEditState {
41 EditChangesNothing = 0,
46 class Region : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Region>
49 typedef std::vector<boost::shared_ptr<Source> > SourceList;
56 DefaultFadeOut = 0x10,
67 RightOfSplit = 0x8000,
69 DoNotSaveState = 0x20000,
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 automatic() const { return _flags & Automatic; }
116 bool whole_file() const { return _flags & WholeFile ; }
117 bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
119 virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
122 void thaw (const string& why);
124 bool covers (nframes_t frame) const {
125 return first_frame() <= frame && frame < last_frame();
128 OverlapType coverage (nframes_t start, nframes_t end) const {
129 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
132 bool equivalent (boost::shared_ptr<const Region>) const;
133 bool size_equivalent (boost::shared_ptr<const Region>) const;
134 bool overlap_equivalent (boost::shared_ptr<const Region>) const;
135 bool region_list_equivalent (boost::shared_ptr<const Region>) const;
136 bool source_equivalent (boost::shared_ptr<const Region>) const;
138 /* EDITING OPERATIONS */
140 void set_length (nframes_t, void *src);
141 void set_start (nframes_t, void *src);
142 void set_position (nframes_t, void *src);
143 void set_position_on_top (nframes_t, void *src);
144 void special_set_position (nframes_t);
145 void nudge_position (long, void *src);
147 void move_to_natural_position (void *src);
149 void trim_start (nframes_t new_position, void *src);
150 void trim_front (nframes_t new_position, void *src);
151 void trim_end (nframes_t new_position, void *src);
152 void trim_to (nframes_t position, nframes_t length, void *src);
154 void set_layer (layer_t l); /* ONLY Playlist can call this */
157 void raise_to_top ();
158 void lower_to_bottom ();
160 void set_sync_position (nframes_t n);
161 void clear_sync_position ();
162 void set_hidden (bool yn);
163 void set_muted (bool yn);
164 void set_opaque (bool yn);
165 void set_locked (bool yn);
167 virtual uint32_t read_data_count() const { return _read_data_count; }
169 ARDOUR::Playlist* playlist() const { return _playlist; }
171 void set_playlist (ARDOUR::Playlist*);
173 void source_deleted (boost::shared_ptr<Source>);
175 boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
176 uint32_t n_channels() const { return _sources.size(); }
178 std::vector<string> master_source_names();
183 XMLNode& get_state ();
184 virtual XMLNode& state (bool);
185 virtual int set_state (const XMLNode&);
186 virtual int set_live_state (const XMLNode&, Change&, bool send);
188 boost::shared_ptr<Region> get_parent();
190 uint64_t last_layer_op() const { return _last_layer_op; }
191 void set_last_layer_op (uint64_t when);
194 friend class RegionFactory;
196 Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length,
197 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
198 Region (SourceList& srcs, nframes_t start, nframes_t length,
199 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
201 Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
202 Region (boost::shared_ptr<const Region>);
203 Region (boost::shared_ptr<Source> src, const XMLNode&);
204 Region (SourceList& srcs, const XMLNode&);
207 XMLNode& get_short_state (); /* used only by Session */
209 void send_change (Change);
211 void trim_to_internal (nframes_t position, nframes_t length, void *src);
213 bool copied() const { return _flags & Copied; }
214 void maybe_uncopy ();
217 bool verify_start (jack_nframes_t);
218 bool verify_start_and_length (jack_nframes_t, jack_nframes_t);
219 bool verify_start_mutable (jack_nframes_t&_start);
220 bool verify_length (jack_nframes_t);
221 virtual void recompute_at_start () = 0;
222 virtual void recompute_at_end () = 0;
232 nframes_t _sync_position;
234 mutable RegionEditState _first_edit;
236 mutable uint32_t _read_data_count; ///< modified in read()
237 Change _pending_changed;
238 uint64_t _last_layer_op; ///< timestamp
240 ARDOUR::Playlist* _playlist;
242 /** Used when timefx are applied, so we can always use the original source */
243 SourceList _master_sources;
246 } /* namespace ARDOUR */
248 #endif /* __ardour_region_h__ */