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>
43 #include <ardour/state_manager.h>
44 #include <ardour/data_type.h>
51 class Playlist : public StateManager, public PBD::StatefulDestructible {
53 typedef list<boost::shared_ptr<Region> > RegionList;
55 Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
56 Playlist (Session&, string name, DataType type, bool hidden = false);
57 Playlist (const Playlist&, string name, bool hidden = false);
58 Playlist (const Playlist&, jack_nframes_t start, jack_nframes_t cnt, string name, bool hidden = false);
60 virtual void clear (bool with_save = true);
61 virtual void dump () const;
62 virtual UndoAction get_memento() const = 0;
66 uint32_t refcnt() const { return _refcnt; }
68 const string& name() const { return _name; }
69 void set_name (const string& str);
71 const DataType& data_type() const { return _type; }
73 bool frozen() const { return _frozen; }
74 void set_frozen (bool yn);
76 bool hidden() const { return _hidden; }
78 jack_nframes_t get_maximum_extent () const;
79 layer_t top_layer() const;
81 EditMode get_edit_mode() const { return _edit_mode; }
82 void set_edit_mode (EditMode);
84 PBD::ID id() { return _id; }
85 /* Editing operations */
87 void add_region (boost::shared_ptr<Region>, jack_nframes_t position, float times = 1, bool with_save = true);
88 void remove_region (boost::shared_ptr<Region>);
89 void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
90 void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
91 void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, jack_nframes_t pos);
92 void split_region (boost::shared_ptr<Region>, jack_nframes_t position);
93 void partition (jack_nframes_t start, jack_nframes_t end, bool just_top_level);
94 void duplicate (boost::shared_ptr<Region>, jack_nframes_t position, float times);
95 void nudge_after (jack_nframes_t start, jack_nframes_t distance, bool forwards);
97 boost::shared_ptr<Region> find_region (const PBD::ID&) const;
99 Playlist* cut (list<AudioRange>&, bool result_is_hidden = true);
100 Playlist* copy (list<AudioRange>&, bool result_is_hidden = true);
101 int paste (Playlist&, jack_nframes_t position, float times);
103 uint32_t read_data_count() { return _read_data_count; }
105 RegionList* regions_at (jack_nframes_t frame);
106 RegionList* regions_touched (jack_nframes_t start, jack_nframes_t end);
107 boost::shared_ptr<Region> top_region_at (jack_nframes_t frame);
109 boost::shared_ptr<Region> find_next_region (jack_nframes_t frame, RegionPoint point, int dir);
111 template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>, void *), void *arg);
112 template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>));
114 XMLNode& get_state ();
115 int set_state (const XMLNode&);
116 XMLNode& get_template ();
118 sigc::signal<void,boost::shared_ptr<Region> > RegionAdded;
119 sigc::signal<void,boost::shared_ptr<Region> > RegionRemoved;
120 sigc::signal<void,Playlist*,bool> InUse;
121 sigc::signal<void> Modified;
122 sigc::signal<void> NameChanged;
123 sigc::signal<void> LengthChanged;
124 sigc::signal<void> LayeringChanged;
125 sigc::signal<void> StatePushed;
127 static sigc::signal<void,Playlist*> PlaylistCreated;
129 static string bump_name (string old_name, Session&);
130 static string bump_name_once (string old_name);
135 void raise_region (boost::shared_ptr<Region>);
136 void lower_region (boost::shared_ptr<Region>);
137 void raise_region_to_top (boost::shared_ptr<Region>);
138 void lower_region_to_bottom (boost::shared_ptr<Region>);
140 uint32_t read_data_count() const { return _read_data_count; }
142 Session& session() { return _session; }
144 const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
145 void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
147 /* destructive editing */
149 virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
152 friend class Session;
153 virtual ~Playlist (); /* members of the public use unref() */
157 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
158 playlist->region_lock.lock();
160 playlist->delay_notifications();
164 playlist->region_lock.unlock();
166 playlist->release_notifications ();
173 friend class RegionLock;
179 mutable gint block_notifications;
180 mutable gint ignore_state_changes;
181 mutable Glib::Mutex region_lock;
182 RegionList pending_removals;
183 RegionList pending_adds;
184 RegionList pending_bounds;
185 bool pending_modified;
188 string last_save_reason;
199 uint32_t _read_data_count;
200 PBD::ID _orig_diskstream_id;
201 uint64_t layer_op_counter;
202 jack_nframes_t freeze_length;
204 void init (bool hide);
206 bool holding_state () const {
207 return g_atomic_int_get (&block_notifications) != 0 ||
208 g_atomic_int_get (&ignore_state_changes) != 0;
211 /* prevent the compiler from ever generating these */
213 Playlist (const Playlist&);
214 Playlist (Playlist&);
216 void delay_notifications ();
217 void release_notifications ();
218 virtual void flush_notifications ();
220 void notify_region_removed (boost::shared_ptr<Region>);
221 void notify_region_added (boost::shared_ptr<Region>);
222 void notify_length_changed ();
223 void notify_layering_changed ();
224 void notify_modified ();
225 void notify_state_changed (Change);
227 void mark_session_dirty();
229 void region_changed_proxy (Change, boost::shared_ptr<Region>);
230 virtual bool region_changed (Change, boost::shared_ptr<Region>);
232 void region_bounds_changed (Change, boost::shared_ptr<Region>);
233 void region_deleted (boost::shared_ptr<Region>);
235 void sort_regions ();
237 void possibly_splice ();
238 void possibly_splice_unlocked();
240 void splice_locked ();
241 void splice_unlocked ();
244 virtual void finalize_split_region (boost::shared_ptr<Region> original, boost::shared_ptr<Region> left, boost::shared_ptr<Region> right) {}
246 virtual void check_dependents (boost::shared_ptr<Region> region, bool norefresh) {}
247 virtual void refresh_dependents (boost::shared_ptr<Region> region) {}
248 virtual void remove_dependents (boost::shared_ptr<Region> region) {}
250 virtual XMLNode& state (bool);
252 /* override state_manager::save_state so we can check in_set_state() */
254 void save_state (std::string why);
255 void maybe_save_state (std::string why);
257 void add_region_internal (boost::shared_ptr<Region>, jack_nframes_t position, bool delay_sort = false);
259 int remove_region_internal (boost::shared_ptr<Region>, bool delay_sort = false);
260 RegionList *find_regions_at (jack_nframes_t frame);
261 void copy_regions (RegionList&) const;
262 void partition_internal (jack_nframes_t start, jack_nframes_t end, bool cutting, RegionList& thawlist);
264 jack_nframes_t _get_maximum_extent() const;
266 Playlist* cut_copy (Playlist* (Playlist::*pmf)(jack_nframes_t, jack_nframes_t, bool),
267 list<AudioRange>& ranges, bool result_is_hidden);
268 Playlist *cut (jack_nframes_t start, jack_nframes_t cnt, bool result_is_hidden);
269 Playlist *copy (jack_nframes_t start, jack_nframes_t cnt, bool result_is_hidden);
272 int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
275 static Playlist* copyPlaylist (const Playlist&, jack_nframes_t start, jack_nframes_t length,
276 string name, bool result_is_hidden);
278 void unset_freeze_parent (Playlist*);
279 void unset_freeze_child (Playlist*);
281 void timestamp_layer_op (boost::shared_ptr<Region>);
286 } /* namespace ARDOUR */
288 #endif /* __ardour_playlist_h__ */