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/data_type.h"
47 class PlaylistOverlapCacheTest;
48 class PlaylistLayeringTest;
57 namespace Properties {
58 /* fake the type, since regions are handled by SequenceProperty which doesn't
59 care about such things.
61 extern PBD::PropertyDescriptor<bool> regions;
64 class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
67 RegionListProperty (Playlist&);
69 RegionListProperty* clone () const;
70 void get_content_as_xml (boost::shared_ptr<Region>, XMLNode &) const;
71 boost::shared_ptr<Region> get_content_from_xml (XMLNode const &) const;
74 RegionListProperty* create () const;
76 /* copy construction only by ourselves */
77 RegionListProperty (RegionListProperty const & p);
79 friend class Playlist;
80 /* we live and die with our playlist, no lifetime management needed */
84 class Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
87 typedef std::list<boost::shared_ptr<Region> > RegionList;
88 static void make_property_quarks ();
90 Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
91 Playlist (Session&, std::string name, DataType type, bool hidden = false);
92 Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
93 Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
97 void update (const RegionListProperty::ChangeRecord&);
98 void clear_owned_changes ();
99 void rdiff (std::vector<Command*>&) const;
101 boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
103 uint32_t max_source_level () const;
105 void set_region_ownership ();
107 virtual void clear (bool with_signals=true);
108 virtual void dump () const;
112 bool used () const { return _refcnt != 0; }
114 bool set_name (const std::string& str);
115 int sort_id() { return _sort_id; }
117 const DataType& data_type() const { return _type; }
119 bool frozen() const { return _frozen; }
120 void set_frozen (bool yn);
122 bool hidden() const { return _hidden; }
124 uint32_t n_regions() const;
125 std::pair<framepos_t, framepos_t> get_extent () const;
126 layer_t top_layer() const;
128 EditMode get_edit_mode() const { return _edit_mode; }
129 void set_edit_mode (EditMode);
131 /* Editing operations */
133 void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
134 void remove_region (boost::shared_ptr<Region>);
135 void remove_region_by_source (boost::shared_ptr<Source>);
136 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
137 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
138 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
139 void split_region (boost::shared_ptr<Region>, framepos_t position);
140 void split (framepos_t at);
141 void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
142 void partition (framepos_t start, framepos_t end, bool cut = false);
143 void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
144 void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
145 boost::shared_ptr<Region> combine (const RegionList&);
146 void uncombine (boost::shared_ptr<Region>);
148 void shuffle (boost::shared_ptr<Region>, int dir);
149 void update_after_tempo_map_change ();
151 boost::shared_ptr<Playlist> cut (std::list<AudioRange>&, bool result_is_hidden = true);
152 boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
153 int paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
155 const RegionListProperty& region_list () const { return regions; }
157 RegionList* regions_at (framepos_t frame);
158 uint32_t count_regions_at (framepos_t) const;
159 uint32_t count_joined_regions () const;
160 RegionList* regions_touched (framepos_t start, framepos_t end);
161 RegionList* regions_to_read (framepos_t start, framepos_t end);
162 uint32_t region_use_count (boost::shared_ptr<Region>) const;
163 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
164 boost::shared_ptr<Region> top_region_at (framepos_t frame);
165 boost::shared_ptr<Region> top_unmuted_region_at (framepos_t frame);
166 boost::shared_ptr<Region> find_next_region (framepos_t frame, RegionPoint point, int dir);
167 framepos_t find_next_region_boundary (framepos_t frame, int dir);
168 bool region_is_shuffle_constrained (boost::shared_ptr<Region>);
169 bool has_region_at (framepos_t const) const;
171 bool uses_source (boost::shared_ptr<const Source> src) const;
173 framepos_t find_next_transient (framepos_t position, int dir);
175 void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
177 XMLNode& get_state ();
178 int set_state (const XMLNode&, int version);
179 XMLNode& get_template ();
181 PBD::Signal1<void,bool> InUse;
182 PBD::Signal0<void> ContentsChanged;
183 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
184 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
185 PBD::Signal0<void> NameChanged;
186 PBD::Signal0<void> LayeringChanged;
188 /** Emitted when regions have moved (not when regions have only been trimmed) */
189 PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
191 /** Emitted when regions are extended; the ranges passed are the new extra time ranges
192 that these regions now occupy.
194 PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
196 static std::string bump_name (std::string old_name, Session&);
199 void thaw (bool from_undo = false);
201 void raise_region (boost::shared_ptr<Region>);
202 void lower_region (boost::shared_ptr<Region>);
203 void raise_region_to_top (boost::shared_ptr<Region>);
204 void lower_region_to_bottom (boost::shared_ptr<Region>);
206 const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
207 void set_orig_track_id (const PBD::ID& did);
209 /* destructive editing */
211 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
213 void sync_all_regions_with_regions ();
215 /* special case function used by UI selection objects, which have playlists that actually own the regions
219 void drop_regions ();
221 virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
222 return boost::shared_ptr<Crossfade> ();
225 framepos_t find_next_top_layer_position (framepos_t) const;
226 uint32_t combine_ops() const { return _combine_ops; }
228 void relayer (boost::shared_ptr<Region>);
229 void relayer (boost::shared_ptr<Region>, double);
230 void suspend_relayer ();
231 void resume_relayer ();
234 friend class Session;
238 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
239 playlist->region_lock.lock();
241 playlist->delay_notifications();
245 playlist->region_lock.unlock();
247 playlist->release_notifications ();
254 friend class RegionLock;
256 RegionListProperty regions; /* the current list of regions in the playlist */
257 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
258 PBD::ScopedConnectionList region_state_changed_connections;
261 mutable gint block_notifications;
262 mutable gint ignore_state_changes;
263 mutable Glib::RecMutex region_lock;
264 std::set<boost::shared_ptr<Region> > pending_adds;
265 std::set<boost::shared_ptr<Region> > pending_removes;
266 RegionList pending_bounds;
267 bool pending_contents_change;
268 bool pending_layering;
270 /** Movements of time ranges caused by region moves; note that
271 * region trims are not included in this list; it is used to
272 * do automation-follows-regions.
274 std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
275 /** Extra sections added to regions during trims */
276 std::list< Evoral::Range<framepos_t> > pending_region_extensions;
278 std::string last_save_reason;
279 uint32_t in_set_state;
281 bool first_set_state;
292 PBD::ID _orig_track_id;
293 framecnt_t freeze_length;
295 uint32_t _combine_ops;
297 void init (bool hide);
299 bool holding_state () const {
300 return g_atomic_int_get (&block_notifications) != 0 ||
301 g_atomic_int_get (&ignore_state_changes) != 0;
304 void delay_notifications ();
305 void release_notifications (bool from_undo = false);
306 virtual void flush_notifications (bool from_undo = false);
307 void clear_pending ();
309 void _set_sort_id ();
311 void notify_region_removed (boost::shared_ptr<Region>);
312 void notify_region_added (boost::shared_ptr<Region>);
313 void notify_layering_changed ();
314 void notify_contents_changed ();
315 void notify_state_changed (const PBD::PropertyChange&);
316 void notify_region_moved (boost::shared_ptr<Region>);
317 void notify_region_start_trimmed (boost::shared_ptr<Region>);
318 void notify_region_end_trimmed (boost::shared_ptr<Region>);
320 void mark_session_dirty();
322 void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
323 virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
325 void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
326 void region_deleted (boost::shared_ptr<Region>);
328 void sort_regions ();
330 void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
331 void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
333 void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
334 void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
335 void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
337 virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
339 virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
340 virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
341 virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
343 virtual XMLNode& state (bool);
345 bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
347 int remove_region_internal (boost::shared_ptr<Region>);
348 RegionList *find_regions_at (framepos_t);
349 void copy_regions (RegionList&) const;
350 void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
352 std::pair<framepos_t, framepos_t> _get_extent() const;
354 boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
355 std::list<AudioRange>& ranges, bool result_is_hidden);
356 boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
357 boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
359 void relayer (RegionList const &);
363 void unset_freeze_parent (Playlist*);
364 void unset_freeze_child (Playlist*);
366 void _split_region (boost::shared_ptr<Region>, framepos_t position);
368 typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
369 virtual void copy_dependents (const std::vector<TwoRegions>&, Playlist*) const { }
372 boost::shared_ptr<Region> region;
378 /* this is called before we create a new compound region */
379 virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
380 /* this is called before we create a new compound region */
381 virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
382 /* this is called before we remove a compound region and replace it
383 with its constituent regions
385 virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
388 friend class ::PlaylistOverlapCacheTest;
389 friend class ::PlaylistLayeringTest;
391 /** A class which is used to store temporary (fractional)
392 * layer assignments for some regions.
394 class TemporaryLayers
397 void set (boost::shared_ptr<Region>, double);
398 double get (boost::shared_ptr<Region>) const;
401 typedef std::map<boost::shared_ptr<Region>, double> Map;
405 /** Class to sort by temporary layer, for use with std::list<>::sort() */
406 class SortByTemporaryLayer
409 SortByTemporaryLayer (TemporaryLayers const & t)
410 : _temporary_layers (t) {}
412 bool operator() (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) const {
413 return _temporary_layers.get (a) < _temporary_layers.get (b);
417 Playlist::TemporaryLayers const & _temporary_layers;
420 /** A cache of what overlaps what, for a given playlist in a given state.
421 * Divides a playlist up into time periods and notes which regions cover those
422 * periods, so that get() is reasonably quick.
427 OverlapCache (Playlist *);
429 RegionList get (Evoral::Range<framepos_t>) const;
432 std::pair<int, int> cache_indices (Evoral::Range<framepos_t>) const;
434 double _division_size;
435 std::vector<RegionList> _cache;
436 Evoral::Range<framepos_t> _range;
438 static int const _divisions;
441 TemporaryLayers compute_temporary_layers (RegionList const &);
442 void commit_temporary_layers (TemporaryLayers const &);
444 RegionList recursive_regions_touched (boost::shared_ptr<Region>, OverlapCache const &, boost::shared_ptr<Region>) const;
445 void recursive_regions_touched_sub (boost::shared_ptr<Region>, OverlapCache const &, boost::shared_ptr<Region>, RegionList &) const;
447 void timestamp_layer_op (LayerOp, boost::shared_ptr<Region>);
448 uint64_t layer_op_counter;
450 bool _relayer_suspended;
453 } /* namespace ARDOUR */
455 #endif /* __ardour_playlist_h__ */