2 Copyright (C) 2000 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_playlist_h__
21 #define __ardour_playlist_h__
27 #include <boost/shared_ptr.hpp>
28 #include <boost/enable_shared_from_this.hpp>
29 #include <boost/utility.hpp>
37 #include "pbd/stateful.h"
38 #include "pbd/statefuldestructible.h"
39 #include "pbd/sequence_property.h"
41 #include "evoral/types.hpp"
43 #include "ardour/ardour.h"
44 #include "ardour/session_object.h"
45 #include "ardour/crossfade_compare.h"
46 #include "ardour/data_type.h"
55 namespace Properties {
56 /* fake the type, since regions are handled by SequenceProperty which doesn't
57 care about such things.
59 extern PBD::PropertyDescriptor<bool> regions;
62 class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
65 RegionListProperty (Playlist&);
67 RegionListProperty* clone () const;
68 void get_content_as_xml (boost::shared_ptr<Region>, XMLNode &) const;
69 boost::shared_ptr<Region> get_content_from_xml (XMLNode const &) const;
72 RegionListProperty* create () const;
74 /* copy construction only by ourselves */
75 RegionListProperty (RegionListProperty const & p);
77 friend class Playlist;
78 /* we live and die with our playlist, no lifetime management needed */
82 class Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
85 typedef std::list<boost::shared_ptr<Region> > RegionList;
86 static void make_property_quarks ();
88 Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
89 Playlist (Session&, std::string name, DataType type, bool hidden = false);
90 Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
91 Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
95 void update (const RegionListProperty::ChangeRecord&);
96 void clear_owned_changes ();
97 void rdiff (std::vector<Command*>&) const;
99 boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
101 void set_region_ownership ();
103 virtual void clear (bool with_signals=true);
104 virtual void dump () const;
108 bool used () const { return _refcnt != 0; }
110 bool set_name (const std::string& str);
111 int sort_id() { return _sort_id; }
113 const DataType& data_type() const { return _type; }
115 bool frozen() const { return _frozen; }
116 void set_frozen (bool yn);
118 bool hidden() const { return _hidden; }
120 uint32_t n_regions() const;
121 std::pair<framepos_t, framepos_t> get_extent () const;
122 layer_t top_layer() const;
124 EditMode get_edit_mode() const { return _edit_mode; }
125 void set_edit_mode (EditMode);
127 /* Editing operations */
129 void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
130 void remove_region (boost::shared_ptr<Region>);
131 void remove_region_by_source (boost::shared_ptr<Source>);
132 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
133 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
134 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
135 void split_region (boost::shared_ptr<Region>, framepos_t position);
136 void split (framepos_t at);
137 void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
138 void partition (framepos_t start, framepos_t end, bool cut = false);
139 void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
140 void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
141 void shuffle (boost::shared_ptr<Region>, int dir);
142 void update_after_tempo_map_change ();
144 boost::shared_ptr<Playlist> cut (std::list<AudioRange>&, bool result_is_hidden = true);
145 boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
146 int paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
148 const RegionListProperty& region_list () const { return regions; }
150 RegionList* regions_at (framepos_t frame);
151 uint32_t count_regions_at (framepos_t);
152 RegionList* regions_touched (framepos_t start, framepos_t end);
153 RegionList* regions_to_read (framepos_t start, framepos_t end);
154 uint32_t region_use_count (boost::shared_ptr<Region>) const;
155 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
156 boost::shared_ptr<Region> top_region_at (framepos_t frame);
157 boost::shared_ptr<Region> top_unmuted_region_at (framepos_t frame);
158 boost::shared_ptr<Region> find_next_region (framepos_t frame, RegionPoint point, int dir);
159 framepos_t find_next_region_boundary (framepos_t frame, int dir);
160 bool region_is_shuffle_constrained (boost::shared_ptr<Region>);
161 bool has_region_at (framepos_t const) const;
164 framepos_t find_next_transient (framepos_t position, int dir);
166 void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
168 XMLNode& get_state ();
169 int set_state (const XMLNode&, int version);
170 XMLNode& get_template ();
172 PBD::Signal1<void,bool> InUse;
173 PBD::Signal0<void> ContentsChanged;
174 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
175 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
176 PBD::Signal0<void> NameChanged;
177 PBD::Signal0<void> LengthChanged;
178 PBD::Signal0<void> LayeringChanged;
180 /** Emitted when regions have moved (not when regions have only been trimmed) */
181 PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
183 static std::string bump_name (std::string old_name, Session&);
186 void thaw (bool from_undo = false);
188 void raise_region (boost::shared_ptr<Region>);
189 void lower_region (boost::shared_ptr<Region>);
190 void raise_region_to_top (boost::shared_ptr<Region>);
191 void lower_region_to_bottom (boost::shared_ptr<Region>);
193 uint32_t read_data_count() const { return _read_data_count; }
195 /* XXX: use of diskstream here is a little unfortunate */
196 const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
197 void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
199 /* destructive editing */
201 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
203 /* special case function used by UI selection objects, which have playlists that actually own the regions
207 void drop_regions ();
209 bool explicit_relayering () const {
210 return _explicit_relayering;
213 void set_explicit_relayering (bool e);
215 virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
216 return boost::shared_ptr<Crossfade> ();
219 framepos_t find_next_top_layer_position (framepos_t) const;
222 friend class Session;
226 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
227 playlist->region_lock.lock();
229 playlist->delay_notifications();
233 playlist->region_lock.unlock();
235 playlist->release_notifications ();
242 friend class RegionLock;
244 RegionListProperty regions; /* the current list of regions in the playlist */
245 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
246 PBD::ScopedConnectionList region_state_changed_connections;
249 mutable gint block_notifications;
250 mutable gint ignore_state_changes;
251 mutable Glib::RecMutex region_lock;
252 std::set<boost::shared_ptr<Region> > pending_adds;
253 std::set<boost::shared_ptr<Region> > pending_removes;
254 RegionList pending_bounds;
255 bool pending_contents_change;
256 bool pending_layering;
259 /** Movements of time ranges caused by region moves; note that
260 * region trims are not included in this list; it is used to
261 * do automation-follows-regions.
263 std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
265 std::string last_save_reason;
266 uint32_t in_set_state;
268 bool first_set_state;
279 uint32_t _read_data_count;
280 PBD::ID _orig_diskstream_id;
281 uint64_t layer_op_counter;
282 framecnt_t freeze_length;
285 /** true if relayering should be done using region's current layers and their `pending explicit relayer'
286 * flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
287 * Explicit relayering is used by tracks in stacked regionview mode.
289 bool _explicit_relayering;
291 void init (bool hide);
293 bool holding_state () const {
294 return g_atomic_int_get (&block_notifications) != 0 ||
295 g_atomic_int_get (&ignore_state_changes) != 0;
298 void delay_notifications ();
299 void release_notifications (bool from_undo = false);
300 virtual void flush_notifications (bool from_undo = false);
301 void clear_pending ();
303 void _set_sort_id ();
305 void notify_region_removed (boost::shared_ptr<Region>);
306 void notify_region_added (boost::shared_ptr<Region>);
307 void notify_length_changed ();
308 void notify_layering_changed ();
309 void notify_contents_changed ();
310 void notify_state_changed (const PBD::PropertyChange&);
311 void notify_region_moved (boost::shared_ptr<Region>);
313 void mark_session_dirty();
315 void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
316 virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
318 void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
319 void region_deleted (boost::shared_ptr<Region>);
321 void sort_regions ();
323 void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
324 void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
326 void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
327 void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
328 void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
330 virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
332 virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
333 virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
334 virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
336 virtual XMLNode& state (bool);
338 bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
340 int remove_region_internal (boost::shared_ptr<Region>);
341 RegionList *find_regions_at (framepos_t);
342 void copy_regions (RegionList&) const;
343 void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
345 std::pair<framepos_t, framepos_t> _get_extent() const;
347 boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
348 std::list<AudioRange>& ranges, bool result_is_hidden);
349 boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
350 boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
352 int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
357 void unset_freeze_parent (Playlist*);
358 void unset_freeze_child (Playlist*);
360 void timestamp_layer_op (boost::shared_ptr<Region>);
362 void _split_region (boost::shared_ptr<Region>, framepos_t position);
365 } /* namespace ARDOUR */
367 #endif /* __ardour_playlist_h__ */