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.
21 #ifndef __ardour_playlist_h__
22 #define __ardour_playlist_h__
28 #include <boost/shared_ptr.hpp>
34 #include <sigc++/signal.h>
37 #include <pbd/stateful.h>
38 #include <pbd/statefuldestructible.h>
40 #include <ardour/ardour.h>
41 #include <ardour/crossfade_compare.h>
42 #include <ardour/location.h>
49 class Playlist : public PBD::StatefulDestructible {
51 typedef list<boost::shared_ptr<Region> > RegionList;
53 Playlist (Session&, const XMLNode&, bool hidden = false);
54 Playlist (Session&, string name, bool hidden = false);
55 Playlist (const Playlist&, string name, bool hidden = false);
56 Playlist (const Playlist&, nframes_t start, nframes_t cnt, string name, bool hidden = false);
58 virtual void clear (bool with_signals=true);
59 virtual void dump () const;
63 uint32_t refcnt() const { return _refcnt; }
65 const string& name() const { return _name; }
66 void set_name (const string& str);
68 bool frozen() const { return _frozen; }
69 void set_frozen (bool yn);
71 bool hidden() const { return _hidden; }
73 nframes_t get_maximum_extent () const;
74 layer_t top_layer() const;
76 EditMode get_edit_mode() const { return _edit_mode; }
77 void set_edit_mode (EditMode);
79 /* Editing operations */
81 void add_region (boost::shared_ptr<Region>, nframes_t position, float times = 1);
82 void remove_region (boost::shared_ptr<Region>);
83 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
84 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
85 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, nframes_t pos);
86 void split_region (boost::shared_ptr<Region>, nframes_t position);
87 void partition (nframes_t start, nframes_t end, bool just_top_level);
88 void duplicate (boost::shared_ptr<Region>, nframes_t position, float times);
89 void nudge_after (nframes_t start, nframes_t distance, bool forwards);
91 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
93 Playlist* cut (list<AudioRange>&, bool result_is_hidden = true);
94 Playlist* copy (list<AudioRange>&, bool result_is_hidden = true);
95 int paste (Playlist&, nframes_t position, float times);
97 uint32_t read_data_count() { return _read_data_count; }
99 RegionList* regions_at (nframes_t frame);
100 RegionList* regions_touched (nframes_t start, nframes_t end);
101 boost::shared_ptr<Region> top_region_at (nframes_t frame);
103 boost::shared_ptr<Region> find_next_region (nframes_t frame, RegionPoint point, int dir);
105 template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>, void *), void *arg);
106 template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>));
108 XMLNode& get_state ();
109 int set_state (const XMLNode&);
110 XMLNode& get_template ();
112 sigc::signal<void,Playlist*,bool> InUse;
113 sigc::signal<void> Modified;
114 sigc::signal<void> NameChanged;
115 sigc::signal<void> LengthChanged;
116 sigc::signal<void> LayeringChanged;
117 sigc::signal<void> StatePushed;
119 static sigc::signal<void,Playlist*> PlaylistCreated;
121 static string bump_name (string old_name, Session&);
122 static string bump_name_once (string old_name);
127 void raise_region (boost::shared_ptr<Region>);
128 void lower_region (boost::shared_ptr<Region>);
129 void raise_region_to_top (boost::shared_ptr<Region>);
130 void lower_region_to_bottom (boost::shared_ptr<Region>);
132 uint32_t read_data_count() const { return _read_data_count; }
134 Session& session() { return _session; }
136 const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
137 void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
139 /* destructive editing */
141 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
144 friend class Session;
145 virtual ~Playlist (); /* members of the public use unref() */
149 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
150 playlist->region_lock.lock();
152 playlist->delay_notifications();
156 playlist->region_lock.unlock();
158 playlist->release_notifications ();
165 friend class RegionLock;
167 RegionList regions; /* the current list of regions in the playlist */
168 std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
171 mutable gint block_notifications;
172 mutable gint ignore_state_changes;
173 mutable Glib::Mutex region_lock;
174 std::set<boost::shared_ptr<Region> > pending_adds;
175 std::set<boost::shared_ptr<Region> > pending_removes;
176 RegionList pending_bounds;
177 bool pending_modified;
180 string last_save_reason;
181 uint32_t in_set_state;
191 uint32_t _read_data_count;
192 PBD::ID _orig_diskstream_id;
193 uint64_t layer_op_counter;
194 nframes_t freeze_length;
196 void init (bool hide);
198 bool holding_state () const {
199 return g_atomic_int_get (&block_notifications) != 0 ||
200 g_atomic_int_get (&ignore_state_changes) != 0;
203 /* prevent the compiler from ever generating these */
205 Playlist (const Playlist&);
206 Playlist (Playlist&);
208 void delay_notifications ();
209 void release_notifications ();
210 virtual void flush_notifications ();
212 void notify_region_removed (boost::shared_ptr<Region>);
213 void notify_region_added (boost::shared_ptr<Region>);
214 void notify_length_changed ();
215 void notify_layering_changed ();
216 void notify_modified ();
217 void notify_state_changed (Change);
219 void mark_session_dirty();
221 void region_changed_proxy (Change, boost::weak_ptr<Region>);
222 virtual bool region_changed (Change, boost::shared_ptr<Region>);
224 void region_bounds_changed (Change, boost::shared_ptr<Region>);
225 void region_deleted (boost::shared_ptr<Region>);
227 void sort_regions ();
229 void possibly_splice ();
230 void possibly_splice_unlocked();
232 void splice_locked ();
233 void splice_unlocked ();
236 virtual void finalize_split_region (boost::shared_ptr<Region> original, boost::shared_ptr<Region> left, boost::shared_ptr<Region> right) {}
238 virtual void check_dependents (boost::shared_ptr<Region> region, bool norefresh) {}
239 virtual void refresh_dependents (boost::shared_ptr<Region> region) {}
240 virtual void remove_dependents (boost::shared_ptr<Region> region) {}
242 virtual XMLNode& state (bool);
244 boost::shared_ptr<Region> region_by_id (PBD::ID);
246 void add_region_internal (boost::shared_ptr<Region>, nframes_t position, bool delay_sort = false);
248 int remove_region_internal (boost::shared_ptr<Region>, bool delay_sort = false);
249 RegionList *find_regions_at (nframes_t frame);
250 void copy_regions (RegionList&) const;
251 void partition_internal (nframes_t start, nframes_t end, bool cutting, RegionList& thawlist);
253 nframes_t _get_maximum_extent() const;
255 Playlist* cut_copy (Playlist* (Playlist::*pmf)(nframes_t, nframes_t, bool),
256 list<AudioRange>& ranges, bool result_is_hidden);
257 Playlist *cut (nframes_t start, nframes_t cnt, bool result_is_hidden);
258 Playlist *copy (nframes_t start, nframes_t cnt, bool result_is_hidden);
261 int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
264 static Playlist* copyPlaylist (const Playlist&, nframes_t start, nframes_t length,
265 string name, bool result_is_hidden);
267 void unset_freeze_parent (Playlist*);
268 void unset_freeze_child (Playlist*);
270 void timestamp_layer_op (boost::shared_ptr<Region>);
273 } /* namespace ARDOUR */
275 #endif /* __ardour_playlist_h__ */