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"
40 #include "evoral/types.hpp"
42 #include "ardour/ardour.h"
43 #include "ardour/session_object.h"
44 #include "ardour/crossfade_compare.h"
45 #include "ardour/location.h"
46 #include "ardour/data_type.h"
53 class Playlist : public SessionObject
54 , public boost::enable_shared_from_this<Playlist> {
56 typedef std::list<boost::shared_ptr<Region> > RegionList;
58 Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
59 Playlist (Session&, std::string name, DataType type, bool hidden = false);
60 Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
61 Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
65 void set_region_ownership ();
67 virtual void clear (bool with_signals=true);
68 virtual void dump () const;
72 bool used () const { return _refcnt != 0; }
74 bool set_name (const std::string& str);
76 const DataType& data_type() const { return _type; }
78 bool frozen() const { return _frozen; }
79 void set_frozen (bool yn);
81 bool hidden() const { return _hidden; }
83 uint32_t n_regions() const;
84 framecnt_t get_maximum_extent () const;
85 layer_t top_layer() const;
87 EditMode get_edit_mode() const { return _edit_mode; }
88 void set_edit_mode (EditMode);
90 /* Editing operations */
92 void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
93 void remove_region (boost::shared_ptr<Region>);
94 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
95 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
96 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
97 void split_region (boost::shared_ptr<Region>, framepos_t position);
98 void split (framepos_t at);
99 void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
100 void partition (framepos_t start, framepos_t end, bool cut = false);
101 void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
102 void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
103 void shuffle (boost::shared_ptr<Region>, int dir);
104 void update_after_tempo_map_change ();
106 boost::shared_ptr<Playlist> cut (std::list<AudioRange>&, bool result_is_hidden = true);
107 boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
108 int paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
110 const RegionList& region_list () const { return regions; }
112 RegionList* regions_at (framepos_t frame);
113 RegionList* regions_touched (framepos_t start, framepos_t end);
114 RegionList* regions_to_read (framepos_t start, framepos_t end);
115 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
116 boost::shared_ptr<Region> top_region_at (framepos_t frame);
117 boost::shared_ptr<Region> top_unmuted_region_at (framepos_t frame);
118 boost::shared_ptr<Region> find_next_region (framepos_t frame, RegionPoint point, int dir);
119 framepos_t find_next_region_boundary (framepos_t frame, int dir);
120 bool region_is_shuffle_constrained (boost::shared_ptr<Region>);
121 bool has_region_at (framepos_t const) const;
124 framepos_t find_next_transient (framepos_t position, int dir);
126 void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
128 XMLNode& get_state ();
129 int set_state (const XMLNode&, int version);
130 XMLNode& get_template ();
132 PBD::Signal1<void,bool> InUse;
133 PBD::Signal0<void> ContentsChanged;
134 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
135 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
136 PBD::Signal0<void> NameChanged;
137 PBD::Signal0<void> LengthChanged;
138 PBD::Signal0<void> LayeringChanged;
139 PBD::Signal1<void,std::list< Evoral::RangeMove<framepos_t> > const &> RangesMoved;
141 static std::string bump_name (std::string old_name, Session&);
146 void raise_region (boost::shared_ptr<Region>);
147 void lower_region (boost::shared_ptr<Region>);
148 void raise_region_to_top (boost::shared_ptr<Region>);
149 void lower_region_to_bottom (boost::shared_ptr<Region>);
151 uint32_t read_data_count() const { return _read_data_count; }
153 const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
154 void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
156 /* destructive editing */
158 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
160 /* special case function used by UI selection objects, which have playlists that actually own the regions
164 void drop_regions ();
166 bool explicit_relayering () const {
167 return _explicit_relayering;
170 void set_explicit_relayering (bool e);
173 friend class Session;
177 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
178 playlist->region_lock.lock();
180 playlist->delay_notifications();
184 playlist->region_lock.unlock();
186 playlist->release_notifications ();
193 friend class RegionLock;
195 RegionList regions; /* the current list of regions in the playlist */
196 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
197 PBD::ScopedConnectionList region_state_changed_connections;
199 mutable gint block_notifications;
200 mutable gint ignore_state_changes;
201 mutable Glib::RecMutex region_lock;
202 std::set<boost::shared_ptr<Region> > pending_adds;
203 std::set<boost::shared_ptr<Region> > pending_removes;
204 RegionList pending_bounds;
205 bool pending_contents_change;
206 bool pending_layering;
208 std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
210 std::string last_save_reason;
211 uint32_t in_set_state;
212 bool first_set_state;
223 uint32_t _read_data_count;
224 PBD::ID _orig_diskstream_id;
225 uint64_t layer_op_counter;
226 framecnt_t freeze_length;
229 /** true if relayering should be done using region's current layers and their `pending explicit relayer'
230 * flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
231 * Explicit relayering is used by tracks in stacked regionview mode.
233 bool _explicit_relayering;
235 void init (bool hide);
237 bool holding_state () const {
238 return g_atomic_int_get (&block_notifications) != 0 ||
239 g_atomic_int_get (&ignore_state_changes) != 0;
242 void delay_notifications ();
243 void release_notifications ();
244 virtual void flush_notifications ();
245 void clear_pending ();
247 void notify_region_removed (boost::shared_ptr<Region>);
248 void notify_region_added (boost::shared_ptr<Region>);
249 void notify_length_changed ();
250 void notify_layering_changed ();
251 void notify_contents_changed ();
252 void notify_state_changed (const PBD::PropertyChange&);
253 void notify_region_moved (boost::shared_ptr<Region>);
255 void mark_session_dirty();
257 void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
258 virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
260 void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
261 void region_deleted (boost::shared_ptr<Region>);
263 void sort_regions ();
265 void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
266 void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
268 void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
269 void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
270 void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
272 virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
274 virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
275 virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
276 virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
278 virtual XMLNode& state (bool);
280 boost::shared_ptr<Region> region_by_id (PBD::ID);
282 bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
284 int remove_region_internal (boost::shared_ptr<Region>);
285 RegionList *find_regions_at (framepos_t frame);
286 void copy_regions (RegionList&) const;
287 void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
289 framecnt_t _get_maximum_extent() const;
291 boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
292 std::list<AudioRange>& ranges, bool result_is_hidden);
293 boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
294 boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
296 int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
299 void unset_freeze_parent (Playlist*);
300 void unset_freeze_child (Playlist*);
302 void timestamp_layer_op (boost::shared_ptr<Region>);
304 void _split_region (boost::shared_ptr<Region>, framepos_t position);
307 } /* namespace ARDOUR */
309 #endif /* __ardour_playlist_h__ */