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 std::pair<framepos_t, framepos_t> get_extent_with_endspace() const;
124 layer_t top_layer() const;
126 EditMode get_edit_mode() const { return _edit_mode; }
127 void set_edit_mode (EditMode);
129 /* Editing operations */
131 void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
132 void remove_region (boost::shared_ptr<Region>);
133 void remove_region_by_source (boost::shared_ptr<Source>);
134 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
135 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
136 void get_source_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
137 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
138 void split_region (boost::shared_ptr<Region>, framepos_t position);
139 void split (framepos_t at);
140 void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
141 void partition (framepos_t start, framepos_t end, bool cut = false);
142 void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
143 void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
144 boost::shared_ptr<Region> combine (const RegionList&);
145 void uncombine (boost::shared_ptr<Region>);
146 void fade_range (std::list<AudioRange>&);
148 void shuffle (boost::shared_ptr<Region>, int dir);
149 void ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
150 void ripple (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude) {
153 el.push_back (exclude);
154 ripple (at, distance, &el);
157 void update_after_tempo_map_change ();
159 boost::shared_ptr<Playlist> cut (std::list<AudioRange>&, bool result_is_hidden = true);
160 boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
161 int paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
163 const RegionListProperty& region_list () const { return regions; }
165 boost::shared_ptr<RegionList> regions_at (framepos_t frame);
166 uint32_t count_regions_at (framepos_t) const;
167 boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
168 boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<framepos_t>);
169 boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<framepos_t>);
170 uint32_t region_use_count (boost::shared_ptr<Region>) const;
171 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
172 boost::shared_ptr<Region> top_region_at (framepos_t frame);
173 boost::shared_ptr<Region> top_unmuted_region_at (framepos_t frame);
174 boost::shared_ptr<Region> find_next_region (framepos_t frame, RegionPoint point, int dir);
175 framepos_t find_next_region_boundary (framepos_t frame, int dir);
176 bool region_is_shuffle_constrained (boost::shared_ptr<Region>);
177 bool has_region_at (framepos_t const) const;
179 bool uses_source (boost::shared_ptr<const Source> src) const;
181 framepos_t find_next_transient (framepos_t position, int dir);
183 void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
185 XMLNode& get_state ();
186 virtual int set_state (const XMLNode&, int version);
187 XMLNode& get_template ();
189 PBD::Signal1<void,bool> InUse;
190 PBD::Signal0<void> ContentsChanged;
191 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
192 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
193 PBD::Signal0<void> NameChanged;
194 PBD::Signal0<void> LayeringChanged;
196 /** Emitted when regions have moved (not when regions have only been trimmed) */
197 PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
199 /** Emitted when regions are extended; the ranges passed are the new extra time ranges
200 that these regions now occupy.
202 PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
204 static std::string bump_name (std::string old_name, Session&);
207 void thaw (bool from_undo = false);
209 void raise_region (boost::shared_ptr<Region>);
210 void lower_region (boost::shared_ptr<Region>);
211 void raise_region_to_top (boost::shared_ptr<Region>);
212 void lower_region_to_bottom (boost::shared_ptr<Region>);
214 const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
215 void set_orig_track_id (const PBD::ID& did);
217 /* destructive editing */
219 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
221 void sync_all_regions_with_regions ();
223 /* special case function used by UI selection objects, which have playlists that actually own the regions
227 void drop_regions ();
229 virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
230 return boost::shared_ptr<Crossfade> ();
233 framepos_t find_next_top_layer_position (framepos_t) const;
234 uint32_t combine_ops() const { return _combine_ops; }
236 void set_layer (boost::shared_ptr<Region>, double);
238 void set_capture_insertion_in_progress (bool yn);
241 friend class Session;
244 class RegionReadLock : public Glib::Threads::RWLock::ReaderLock {
246 RegionReadLock (Playlist *pl) : Glib::Threads::RWLock::ReaderLock (pl->region_lock) {}
250 class RegionWriteLock : public Glib::Threads::RWLock::WriterLock {
252 RegionWriteLock (Playlist *pl, bool do_block_notify = true)
253 : Glib::Threads::RWLock::WriterLock (pl->region_lock)
255 , block_notify (do_block_notify) {
257 playlist->delay_notifications();
262 Glib::Threads::RWLock::WriterLock::release ();
264 playlist->release_notifications ();
271 RegionListProperty regions; /* the current list of regions in the playlist */
272 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
273 PBD::ScopedConnectionList region_state_changed_connections;
276 mutable gint block_notifications;
277 mutable gint ignore_state_changes;
278 std::set<boost::shared_ptr<Region> > pending_adds;
279 std::set<boost::shared_ptr<Region> > pending_removes;
280 RegionList pending_bounds;
281 bool pending_contents_change;
282 bool pending_layering;
284 /** Movements of time ranges caused by region moves; note that
285 * region trims are not included in this list; it is used to
286 * do automation-follows-regions.
288 std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
289 /** Extra sections added to regions during trims */
290 std::list< Evoral::Range<framepos_t> > pending_region_extensions;
291 uint32_t in_set_state;
293 bool first_set_state;
304 bool _capture_insertion_underway;
306 PBD::ID _orig_track_id;
307 uint32_t _combine_ops;
309 void init (bool hide);
311 bool holding_state () const {
312 return g_atomic_int_get (&block_notifications) != 0 ||
313 g_atomic_int_get (&ignore_state_changes) != 0;
316 void delay_notifications ();
317 void release_notifications (bool from_undo = false);
318 virtual void flush_notifications (bool from_undo = false);
319 void clear_pending ();
321 void _set_sort_id ();
323 boost::shared_ptr<RegionList> regions_touched_locked (framepos_t start, framepos_t end);
325 void notify_region_removed (boost::shared_ptr<Region>);
326 void notify_region_added (boost::shared_ptr<Region>);
327 void notify_layering_changed ();
328 void notify_contents_changed ();
329 void notify_state_changed (const PBD::PropertyChange&);
330 void notify_region_moved (boost::shared_ptr<Region>);
331 void notify_region_start_trimmed (boost::shared_ptr<Region>);
332 void notify_region_end_trimmed (boost::shared_ptr<Region>);
334 void mark_session_dirty();
336 void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
337 virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
339 void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
340 void region_deleted (boost::shared_ptr<Region>);
342 void sort_regions ();
344 void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
345 void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
347 void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
348 void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
349 void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
351 void core_ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
352 void ripple_locked (framepos_t at, framecnt_t distance, RegionList *exclude);
353 void ripple_unlocked (framepos_t at, framecnt_t distance, RegionList *exclude);
356 virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
358 virtual XMLNode& state (bool);
360 bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
362 int remove_region_internal (boost::shared_ptr<Region>);
363 void copy_regions (RegionList&) const;
364 void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
366 std::pair<framepos_t, framepos_t> _get_extent() const;
368 boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
369 std::list<AudioRange>& ranges, bool result_is_hidden);
370 boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
371 boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
378 void _split_region (boost::shared_ptr<Region>, framepos_t position);
380 typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
382 /* this is called before we create a new compound region */
383 virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
384 /* this is called before we create a new compound region */
385 virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
386 /* this is called before we remove a compound region and replace it
387 with its constituent regions
389 virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
392 friend class RegionReadLock;
393 friend class RegionWriteLock;
394 mutable Glib::Threads::RWLock region_lock;
397 void setup_layering_indices (RegionList const &);
398 void coalesce_and_check_crossfades (std::list<Evoral::Range<framepos_t> >);
399 boost::shared_ptr<RegionList> find_regions_at (framepos_t);
401 framepos_t _end_space; //this is used when we are pasting a range with extra space at the end
404 } /* namespace ARDOUR */
406 #endif /* __ardour_playlist_h__ */