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>
36 #include "pbd/stateful.h"
37 #include "pbd/statefuldestructible.h"
38 #include "pbd/sequence_property.h"
39 #include "pbd/stacktrace.h"
41 #include "evoral/types.hpp"
43 #include "ardour/ardour.h"
44 #include "ardour/region.h"
45 #include "ardour/session_object.h"
46 #include "ardour/data_type.h"
54 namespace Properties {
55 /* fake the type, since regions are handled by SequenceProperty which doesn't
56 care about such things.
58 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> regions;
61 class LIBARDOUR_API RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
64 RegionListProperty (Playlist&);
66 RegionListProperty* clone () const;
67 void get_content_as_xml (boost::shared_ptr<Region>, XMLNode &) const;
68 boost::shared_ptr<Region> get_content_from_xml (XMLNode const &) const;
71 RegionListProperty* create () const;
73 /* copy construction only by ourselves */
74 RegionListProperty (RegionListProperty const & p);
76 friend class Playlist;
77 /* we live and die with our playlist, no lifetime management needed */
81 class LIBARDOUR_API Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
84 static void make_property_quarks ();
86 Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
87 Playlist (Session&, std::string name, DataType type, bool hidden = false);
88 Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
89 Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
93 void update (const RegionListProperty::ChangeRecord&);
94 void clear_owned_changes ();
95 void rdiff (std::vector<Command*>&) const;
97 boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
99 uint32_t max_source_level () 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 bool all_regions_empty() const;
122 std::pair<framepos_t, framepos_t> get_extent () const;
123 layer_t top_layer() const;
125 EditMode get_edit_mode() const { return _edit_mode; }
126 void set_edit_mode (EditMode);
128 /* Editing operations */
130 void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
131 void remove_region (boost::shared_ptr<Region>);
132 void remove_region_by_source (boost::shared_ptr<Source>);
133 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
134 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
135 void get_source_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
136 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
137 void split_region (boost::shared_ptr<Region>, framepos_t position);
138 void split (framepos_t at);
139 void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
140 void partition (framepos_t start, framepos_t end, bool cut = false);
141 void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
142 void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
143 boost::shared_ptr<Region> combine (const RegionList&);
144 void uncombine (boost::shared_ptr<Region>);
146 void shuffle (boost::shared_ptr<Region>, int dir);
147 void ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
148 void ripple (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude) {
151 el.push_back (exclude);
152 ripple (at, distance, &el);
155 void update_after_tempo_map_change ();
157 boost::shared_ptr<Playlist> cut (std::list<AudioRange>&, bool result_is_hidden = true);
158 boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
159 int paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
161 const RegionListProperty& region_list () const { return regions; }
163 boost::shared_ptr<RegionList> regions_at (framepos_t frame);
164 uint32_t count_regions_at (framepos_t) const;
165 boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
166 boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<framepos_t>);
167 boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<framepos_t>);
168 uint32_t region_use_count (boost::shared_ptr<Region>) const;
169 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
170 boost::shared_ptr<Region> top_region_at (framepos_t frame);
171 boost::shared_ptr<Region> top_unmuted_region_at (framepos_t frame);
172 boost::shared_ptr<Region> find_next_region (framepos_t frame, RegionPoint point, int dir);
173 framepos_t find_next_region_boundary (framepos_t frame, int dir);
174 bool region_is_shuffle_constrained (boost::shared_ptr<Region>);
175 bool has_region_at (framepos_t const) const;
177 bool uses_source (boost::shared_ptr<const Source> src) const;
179 framepos_t find_next_transient (framepos_t position, int dir);
181 void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
183 XMLNode& get_state ();
184 virtual int set_state (const XMLNode&, int version);
185 XMLNode& get_template ();
187 PBD::Signal1<void,bool> InUse;
188 PBD::Signal0<void> ContentsChanged;
189 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
190 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
191 PBD::Signal0<void> NameChanged;
192 PBD::Signal0<void> LayeringChanged;
194 /** Emitted when regions have moved (not when regions have only been trimmed) */
195 PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
197 /** Emitted when regions are extended; the ranges passed are the new extra time ranges
198 that these regions now occupy.
200 PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
202 static std::string bump_name (std::string old_name, Session&);
205 void thaw (bool from_undo = false);
207 void raise_region (boost::shared_ptr<Region>);
208 void lower_region (boost::shared_ptr<Region>);
209 void raise_region_to_top (boost::shared_ptr<Region>);
210 void lower_region_to_bottom (boost::shared_ptr<Region>);
212 const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
213 void set_orig_track_id (const PBD::ID& did);
215 /* destructive editing */
217 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
219 void sync_all_regions_with_regions ();
221 /* special case function used by UI selection objects, which have playlists that actually own the regions
225 void drop_regions ();
227 virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
228 return boost::shared_ptr<Crossfade> ();
231 framepos_t find_next_top_layer_position (framepos_t) const;
232 uint32_t combine_ops() const { return _combine_ops; }
234 void set_layer (boost::shared_ptr<Region>, double);
236 void set_capture_insertion_in_progress (bool yn);
239 friend class Session;
242 class RegionReadLock : public Glib::Threads::RWLock::ReaderLock {
244 RegionReadLock (Playlist *pl) : Glib::Threads::RWLock::ReaderLock (pl->region_lock) {}
248 class RegionWriteLock : public Glib::Threads::RWLock::WriterLock {
250 RegionWriteLock (Playlist *pl, bool do_block_notify = true)
251 : Glib::Threads::RWLock::WriterLock (pl->region_lock)
253 , block_notify (do_block_notify) {
255 playlist->delay_notifications();
260 Glib::Threads::RWLock::WriterLock::release ();
262 playlist->release_notifications ();
269 RegionListProperty regions; /* the current list of regions in the playlist */
270 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
271 PBD::ScopedConnectionList region_state_changed_connections;
274 mutable gint block_notifications;
275 mutable gint ignore_state_changes;
276 std::set<boost::shared_ptr<Region> > pending_adds;
277 std::set<boost::shared_ptr<Region> > pending_removes;
278 RegionList pending_bounds;
279 bool pending_contents_change;
280 bool pending_layering;
282 /** Movements of time ranges caused by region moves; note that
283 * region trims are not included in this list; it is used to
284 * do automation-follows-regions.
286 std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
287 /** Extra sections added to regions during trims */
288 std::list< Evoral::Range<framepos_t> > pending_region_extensions;
289 uint32_t in_set_state;
291 bool first_set_state;
302 bool _capture_insertion_underway;
304 PBD::ID _orig_track_id;
305 uint32_t _combine_ops;
307 void init (bool hide);
309 bool holding_state () const {
310 return g_atomic_int_get (&block_notifications) != 0 ||
311 g_atomic_int_get (&ignore_state_changes) != 0;
314 void delay_notifications ();
315 void release_notifications (bool from_undo = false);
316 virtual void flush_notifications (bool from_undo = false);
317 void clear_pending ();
319 void _set_sort_id ();
321 boost::shared_ptr<RegionList> regions_touched_locked (framepos_t start, framepos_t end);
323 void notify_region_removed (boost::shared_ptr<Region>);
324 void notify_region_added (boost::shared_ptr<Region>);
325 void notify_layering_changed ();
326 void notify_contents_changed ();
327 void notify_state_changed (const PBD::PropertyChange&);
328 void notify_region_moved (boost::shared_ptr<Region>);
329 void notify_region_start_trimmed (boost::shared_ptr<Region>);
330 void notify_region_end_trimmed (boost::shared_ptr<Region>);
332 void mark_session_dirty();
334 void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
335 virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
337 void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
338 void region_deleted (boost::shared_ptr<Region>);
340 void sort_regions ();
342 void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
343 void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
345 void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
346 void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
347 void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
349 void core_ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
350 void ripple_locked (framepos_t at, framecnt_t distance, RegionList *exclude);
351 void ripple_unlocked (framepos_t at, framecnt_t distance, RegionList *exclude);
354 virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
356 virtual XMLNode& state (bool);
358 bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
360 int remove_region_internal (boost::shared_ptr<Region>);
361 void copy_regions (RegionList&) const;
362 void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
364 std::pair<framepos_t, framepos_t> _get_extent() const;
366 boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
367 std::list<AudioRange>& ranges, bool result_is_hidden);
368 boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
369 boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
376 void _split_region (boost::shared_ptr<Region>, framepos_t position);
378 typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
380 /* this is called before we create a new compound region */
381 virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
382 /* this is called before we create a new compound region */
383 virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
384 /* this is called before we remove a compound region and replace it
385 with its constituent regions
387 virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
390 friend class RegionReadLock;
391 friend class RegionWriteLock;
392 mutable Glib::Threads::RWLock region_lock;
395 void setup_layering_indices (RegionList const &);
396 void coalesce_and_check_crossfades (std::list<Evoral::Range<framepos_t> >);
397 boost::shared_ptr<RegionList> find_regions_at (framepos_t);
400 } /* namespace ARDOUR */
402 #endif /* __ardour_playlist_h__ */