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>
35 #include <sigc++/signal.h>
38 #include "pbd/stateful.h"
39 #include "pbd/statefuldestructible.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/location.h"
47 #include "ardour/data_type.h"
54 class Playlist : public SessionObject,
55 public boost::noncopyable,
56 public boost::enable_shared_from_this<Playlist> {
58 typedef list<boost::shared_ptr<Region> > RegionList;
60 Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
61 Playlist (Session&, string name, DataType type, bool hidden = false);
62 Playlist (boost::shared_ptr<const Playlist>, string name, bool hidden = false);
63 Playlist (boost::shared_ptr<const Playlist>, nframes_t start, nframes_t cnt, string name, bool hidden = false);
67 void set_region_ownership ();
69 virtual void clear (bool with_signals=true);
70 virtual void dump () const;
74 bool used () const { return _refcnt != 0; }
76 bool set_name (const string& str);
78 const DataType& data_type() const { return _type; }
80 bool frozen() const { return _frozen; }
81 void set_frozen (bool yn);
83 bool hidden() const { return _hidden; }
85 uint32_t n_regions() const;
86 nframes_t get_maximum_extent () const;
87 layer_t top_layer() const;
89 EditMode get_edit_mode() const { return _edit_mode; }
90 void set_edit_mode (EditMode);
92 /* Editing operations */
94 void add_region (boost::shared_ptr<Region>, nframes_t position, float times = 1);
95 void remove_region (boost::shared_ptr<Region>);
96 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
97 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
98 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, nframes_t pos);
99 void split_region (boost::shared_ptr<Region>, nframes_t position);
100 void split (nframes64_t at);
101 void shift (nframes64_t at, nframes64_t distance, bool move_intersected, bool ignore_music_glue);
102 void partition (nframes_t start, nframes_t end, bool just_top_level);
103 void duplicate (boost::shared_ptr<Region>, nframes_t position, float times);
104 void nudge_after (nframes_t start, nframes_t distance, bool forwards);
105 void shuffle (boost::shared_ptr<Region>, int dir);
106 void update_after_tempo_map_change ();
108 boost::shared_ptr<Playlist> cut (list<AudioRange>&, bool result_is_hidden = true);
109 boost::shared_ptr<Playlist> copy (list<AudioRange>&, bool result_is_hidden = true);
110 int paste (boost::shared_ptr<Playlist>, nframes_t position, float times);
112 RegionList* regions_at (nframes_t frame);
113 RegionList* regions_touched (nframes_t start, nframes_t end);
114 RegionList* regions_to_read (nframes_t start, nframes_t end);
115 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
116 boost::shared_ptr<Region> top_region_at (nframes_t frame);
117 boost::shared_ptr<Region> find_next_region (nframes_t frame, RegionPoint point, int dir);
118 nframes64_t find_next_region_boundary (nframes64_t frame, int dir);
119 bool region_is_shuffle_constrained (boost::shared_ptr<Region>);
121 nframes64_t find_next_transient (nframes64_t position, int dir);
123 template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>, void *), void *arg);
124 template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>));
126 XMLNode& get_state ();
127 int set_state (const XMLNode&);
128 XMLNode& get_template ();
130 sigc::signal<void,bool> InUse;
131 sigc::signal<void> Modified;
132 sigc::signal<void> NameChanged;
133 sigc::signal<void> LengthChanged;
134 sigc::signal<void, list< Evoral::RangeMove<nframes_t> > const &> RangesMoved;
136 static string bump_name (string old_name, Session&);
141 void raise_region (boost::shared_ptr<Region>);
142 void lower_region (boost::shared_ptr<Region>);
143 void raise_region_to_top (boost::shared_ptr<Region>);
144 void lower_region_to_bottom (boost::shared_ptr<Region>);
146 uint32_t read_data_count() const { return _read_data_count; }
148 const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
149 void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
151 /* destructive editing */
153 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
155 /* special case function used by UI selection objects, which have playlists that actually own the regions
159 void drop_regions ();
162 friend class Session;
166 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
167 playlist->region_lock.lock();
169 playlist->delay_notifications();
173 playlist->region_lock.unlock();
175 playlist->release_notifications ();
182 friend class RegionLock;
184 RegionList regions; /* the current list of regions in the playlist */
185 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
186 std::list<sigc::connection> region_state_changed_connections;
188 mutable gint block_notifications;
189 mutable gint ignore_state_changes;
190 mutable Glib::Mutex region_lock;
191 std::set<boost::shared_ptr<Region> > pending_adds;
192 std::set<boost::shared_ptr<Region> > pending_removes;
193 RegionList pending_bounds;
194 bool pending_modified;
196 list< Evoral::RangeMove<nframes_t> > pending_range_moves;
198 string last_save_reason;
199 uint32_t in_set_state;
200 bool first_set_state;
211 uint32_t _read_data_count;
212 PBD::ID _orig_diskstream_id;
213 uint64_t layer_op_counter;
214 nframes_t freeze_length;
216 void init (bool hide);
218 bool holding_state () const {
219 return g_atomic_int_get (&block_notifications) != 0 ||
220 g_atomic_int_get (&ignore_state_changes) != 0;
223 void delay_notifications ();
224 void release_notifications ();
225 virtual void flush_notifications ();
227 void notify_region_removed (boost::shared_ptr<Region>);
228 void notify_region_added (boost::shared_ptr<Region>);
229 void notify_length_changed ();
230 void notify_layering_changed ();
231 void notify_modified ();
232 void notify_state_changed (Change);
233 void notify_region_moved (boost::shared_ptr<Region>);
235 void mark_session_dirty();
237 void region_changed_proxy (Change, boost::weak_ptr<Region>);
238 virtual bool region_changed (Change, boost::shared_ptr<Region>);
240 void region_bounds_changed (Change, boost::shared_ptr<Region>);
241 void region_deleted (boost::shared_ptr<Region>);
243 void sort_regions ();
245 void possibly_splice (nframes_t at, nframes64_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
246 void possibly_splice_unlocked(nframes_t at, nframes64_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
248 void core_splice (nframes_t at, nframes64_t distance, boost::shared_ptr<Region> exclude);
249 void splice_locked (nframes_t at, nframes64_t distance, boost::shared_ptr<Region> exclude);
250 void splice_unlocked (nframes_t at, nframes64_t distance, boost::shared_ptr<Region> exclude);
252 virtual void finalize_split_region (boost::shared_ptr<Region> original, boost::shared_ptr<Region> left, boost::shared_ptr<Region> right) {}
254 virtual void check_dependents (boost::shared_ptr<Region> region, bool norefresh) {}
255 virtual void refresh_dependents (boost::shared_ptr<Region> region) {}
256 virtual void remove_dependents (boost::shared_ptr<Region> region) {}
258 virtual XMLNode& state (bool);
260 boost::shared_ptr<Region> region_by_id (PBD::ID);
262 bool add_region_internal (boost::shared_ptr<Region>, nframes_t position);
264 int remove_region_internal (boost::shared_ptr<Region>);
265 RegionList *find_regions_at (nframes_t frame);
266 void copy_regions (RegionList&) const;
267 void partition_internal (nframes_t start, nframes_t end, bool cutting, RegionList& thawlist);
269 nframes_t _get_maximum_extent() const;
271 boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(nframes_t, nframes_t, bool),
272 list<AudioRange>& ranges, bool result_is_hidden);
273 boost::shared_ptr<Playlist> cut (nframes_t start, nframes_t cnt, bool result_is_hidden);
274 boost::shared_ptr<Playlist> copy (nframes_t start, nframes_t cnt, bool result_is_hidden);
276 int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
279 void unset_freeze_parent (Playlist*);
280 void unset_freeze_child (Playlist*);
282 void timestamp_layer_op (boost::shared_ptr<Region>);
284 void _split_region (boost::shared_ptr<Region>, nframes_t position);
287 } /* namespace ARDOUR */
289 #endif /* __ardour_playlist_h__ */