2 * Copyright (C) 2009-2011 Carl Hetherington <carl@carlh.net>
3 * Copyright (C) 2009-2016 Paul Davis <paul@linuxaudiosystems.com>
4 * Copyright (C) 2011-2012 David Robillard <d@drobilla.net>
5 * Copyright (C) 2013-2016 John Emmas <john@creativepost.co.uk>
6 * Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
7 * Copyright (C) 2016 Tim Mayberry <mojofunk@gmail.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include "ardour/debug.h"
26 #include "ardour/playlist.h"
27 #include "ardour/playlist_factory.h"
28 #include "ardour/session_playlists.h"
29 #include "ardour/track.h"
31 #include "pbd/compose.h"
32 #include "pbd/xml++.h"
36 using namespace ARDOUR;
38 SessionPlaylists::~SessionPlaylists ()
40 DEBUG_TRACE (DEBUG::Destruction, "delete playlists\n");
42 for (List::iterator i = playlists.begin(); i != playlists.end(); ) {
43 SessionPlaylists::List::iterator tmp;
48 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for used playlist %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
49 boost::shared_ptr<Playlist> keeper (*i);
50 (*i)->drop_references ();
55 DEBUG_TRACE (DEBUG::Destruction, "delete unused playlists\n");
56 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ) {
62 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for unused playlist %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
63 boost::shared_ptr<Playlist> keeper (*i);
64 (*i)->drop_references ();
70 unused_playlists.clear ();
74 SessionPlaylists::add (boost::shared_ptr<Playlist> playlist)
76 Glib::Threads::Mutex::Lock lm (lock);
78 bool const existing = find (playlists.begin(), playlists.end(), playlist) != playlists.end();
81 playlists.insert (playlists.begin(), playlist);
82 playlist->InUse.connect_same_thread (*this, boost::bind (&SessionPlaylists::track, this, _1, boost::weak_ptr<Playlist>(playlist)));
83 playlist->DropReferences.connect_same_thread (
84 *this, boost::bind (&SessionPlaylists::remove_weak, this, boost::weak_ptr<Playlist> (playlist))
92 SessionPlaylists::remove_weak (boost::weak_ptr<Playlist> playlist)
94 boost::shared_ptr<Playlist> p = playlist.lock ();
101 SessionPlaylists::remove (boost::shared_ptr<Playlist> playlist)
103 Glib::Threads::Mutex::Lock lm (lock);
107 i = find (playlists.begin(), playlists.end(), playlist);
108 if (i != playlists.end()) {
112 i = find (unused_playlists.begin(), unused_playlists.end(), playlist);
113 if (i != unused_playlists.end()) {
114 unused_playlists.erase (i);
119 SessionPlaylists::update_tracking ()
121 /* This is intended to be called during session-load, after loading
122 * playlists and re-assigning them to tracks (refcnt is up to date).
123 * Check playlist refcnt, move unused playlist to unused_playlists
124 * array (which may be the case when loading old sessions)
126 for (List::iterator i = playlists.begin(); i != playlists.end(); ) {
127 if ((*i)->hidden () || (*i)->used ()) {
132 warning << _("Session State: Unused playlist was listed as used.") << endmsg;
134 assert (unused_playlists.find (*i) == unused_playlists.end());
135 unused_playlists.insert (*i);
137 List::iterator rm = i;
139 playlists.erase (rm);
144 SessionPlaylists::track (bool inuse, boost::weak_ptr<Playlist> wpl)
146 boost::shared_ptr<Playlist> pl(wpl.lock());
155 /* its not supposed to be visible */
160 Glib::Threads::Mutex::Lock lm (lock);
164 unused_playlists.insert (pl);
166 if ((x = playlists.find (pl)) != playlists.end()) {
173 playlists.insert (pl);
175 if ((x = unused_playlists.find (pl)) != unused_playlists.end()) {
176 unused_playlists.erase (x);
183 SessionPlaylists::n_playlists () const
185 Glib::Threads::Mutex::Lock lm (lock);
186 return playlists.size();
189 boost::shared_ptr<Playlist>
190 SessionPlaylists::by_name (string name)
192 Glib::Threads::Mutex::Lock lm (lock);
194 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
195 if ((*i)->name() == name) {
200 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
201 if ((*i)->name() == name) {
206 return boost::shared_ptr<Playlist>();
209 boost::shared_ptr<Playlist>
210 SessionPlaylists::by_id (const PBD::ID& id)
212 Glib::Threads::Mutex::Lock lm (lock);
214 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
215 if ((*i)->id() == id) {
220 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
221 if ((*i)->id() == id) {
226 return boost::shared_ptr<Playlist>();
230 SessionPlaylists::unassigned (std::list<boost::shared_ptr<Playlist> > & list)
232 Glib::Threads::Mutex::Lock lm (lock);
234 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
235 if (!(*i)->get_orig_track_id().to_s().compare ("0")) {
240 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
241 if (!(*i)->get_orig_track_id().to_s().compare ("0")) {
248 SessionPlaylists::get (vector<boost::shared_ptr<Playlist> >& s) const
250 Glib::Threads::Mutex::Lock lm (lock);
252 for (List::const_iterator i = playlists.begin(); i != playlists.end(); ++i) {
256 for (List::const_iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
262 SessionPlaylists::destroy_region (boost::shared_ptr<Region> r)
264 Glib::Threads::Mutex::Lock lm (lock);
266 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
267 (*i)->destroy_region (r);
270 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
271 (*i)->destroy_region (r);
276 SessionPlaylists::find_equivalent_playlist_regions (boost::shared_ptr<Region> region, vector<boost::shared_ptr<Region> >& result)
278 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i)
279 (*i)->get_region_list_equivalent_regions (region, result);
282 /** Return the number of playlists (not regions) that contain @a src
283 * Important: this counts usage in both used and not-used playlists.
286 SessionPlaylists::source_use_count (boost::shared_ptr<const Source> src) const
290 /* XXXX this can go wildly wrong in the presence of circular references
291 * between compound regions.
294 for (List::const_iterator p = playlists.begin(); p != playlists.end(); ++p) {
295 if ((*p)->uses_source (src)) {
301 for (List::const_iterator p = unused_playlists.begin(); p != unused_playlists.end(); ++p) {
302 if ((*p)->uses_source (src)) {
312 SessionPlaylists::sync_all_regions_with_regions ()
314 Glib::Threads::Mutex::Lock lm (lock);
316 for (List::const_iterator p = playlists.begin(); p != playlists.end(); ++p) {
317 (*p)->sync_all_regions_with_regions ();
322 SessionPlaylists::update_after_tempo_map_change ()
324 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
325 (*i)->update_after_tempo_map_change ();
328 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
329 (*i)->update_after_tempo_map_change ();
336 bool operator()(const boost::shared_ptr<Playlist>& p1, const boost::shared_ptr<Playlist>& p2)
338 return p1->id () < p2->id ();
342 typedef std::set<boost::shared_ptr<Playlist> > List;
343 typedef std::set<boost::shared_ptr<Playlist>, id_compare> IDSortedList;
346 get_id_sorted_playlists (const List& playlists, IDSortedList& id_sorted_playlists)
348 for (List::const_iterator i = playlists.begin(); i != playlists.end(); ++i) {
349 id_sorted_playlists.insert(*i);
353 } // anonymous namespace
356 SessionPlaylists::add_state (XMLNode* node, bool save_template, bool include_unused)
358 XMLNode* child = node->add_child ("Playlists");
360 IDSortedList id_sorted_playlists;
361 get_id_sorted_playlists (playlists, id_sorted_playlists);
363 for (IDSortedList::iterator i = id_sorted_playlists.begin (); i != id_sorted_playlists.end (); ++i) {
364 if (!(*i)->hidden ()) {
366 child->add_child_nocopy ((*i)->get_template ());
368 child->add_child_nocopy ((*i)->get_state ());
373 if (!include_unused) {
377 child = node->add_child ("UnusedPlaylists");
379 IDSortedList id_sorted_unused_playlists;
380 get_id_sorted_playlists (unused_playlists, id_sorted_unused_playlists);
382 for (IDSortedList::iterator i = id_sorted_unused_playlists.begin ();
383 i != id_sorted_unused_playlists.end (); ++i) {
384 if (!(*i)->hidden()) {
385 if (!(*i)->empty()) {
387 child->add_child_nocopy ((*i)->get_template());
389 child->add_child_nocopy ((*i)->get_state());
396 /** @return true for `stop cleanup', otherwise false */
398 SessionPlaylists::maybe_delete_unused (boost::function<int(boost::shared_ptr<Playlist>)> ask)
400 vector<boost::shared_ptr<Playlist> > playlists_tbd;
402 bool delete_remaining = false;
403 bool keep_remaining = false;
405 for (List::iterator x = unused_playlists.begin(); x != unused_playlists.end(); ++x) {
407 if (keep_remaining) {
411 if (delete_remaining) {
412 playlists_tbd.push_back (*x);
416 int status = ask (*x);
424 // keep this and all later
425 keep_remaining = true;
429 // delete this and all later
430 delete_remaining = true;
435 playlists_tbd.push_back (*x);
444 /* now delete any that were marked for deletion */
446 for (vector<boost::shared_ptr<Playlist> >::iterator x = playlists_tbd.begin(); x != playlists_tbd.end(); ++x) {
447 boost::shared_ptr<Playlist> keeper (*x);
448 (*x)->drop_references ();
451 playlists_tbd.clear ();
457 SessionPlaylists::load (Session& session, const XMLNode& node)
460 XMLNodeConstIterator niter;
461 boost::shared_ptr<Playlist> playlist;
463 nlist = node.children();
465 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
467 if ((playlist = XMLPlaylistFactory (session, **niter)) == 0) {
468 error << _("Session: cannot create Playlist from XML description.") << endmsg;
476 SessionPlaylists::load_unused (Session& session, const XMLNode& node)
479 XMLNodeConstIterator niter;
480 boost::shared_ptr<Playlist> playlist;
482 nlist = node.children();
484 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
486 if ((playlist = XMLPlaylistFactory (session, **niter)) == 0) {
487 error << _("Session: cannot create Playlist from XML description.") << endmsg;
491 // now manually untrack it
493 track (false, boost::weak_ptr<Playlist> (playlist));
499 boost::shared_ptr<Playlist>
500 SessionPlaylists::XMLPlaylistFactory (Session& session, const XMLNode& node)
503 return PlaylistFactory::create (session, node);
506 catch (failed_constructor& err) {
507 return boost::shared_ptr<Playlist>();
511 boost::shared_ptr<Crossfade>
512 SessionPlaylists::find_crossfade (const PBD::ID& id)
514 Glib::Threads::Mutex::Lock lm (lock);
516 boost::shared_ptr<Crossfade> c;
518 for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
519 c = (*i)->find_crossfade (id);
525 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
526 c = (*i)->find_crossfade (id);
532 return boost::shared_ptr<Crossfade> ();
536 SessionPlaylists::region_use_count (boost::shared_ptr<Region> region) const
538 Glib::Threads::Mutex::Lock lm (lock);
541 for (List::const_iterator i = playlists.begin(); i != playlists.end(); ++i) {
542 cnt += (*i)->region_use_count (region);
545 for (List::const_iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
546 cnt += (*i)->region_use_count (region);
552 vector<boost::shared_ptr<Playlist> >
553 SessionPlaylists::get_used () const
555 vector<boost::shared_ptr<Playlist> > pl;
557 Glib::Threads::Mutex::Lock lm (lock);
559 for (List::const_iterator i = playlists.begin(); i != playlists.end(); ++i) {
566 vector<boost::shared_ptr<Playlist> >
567 SessionPlaylists::get_unused () const
569 vector<boost::shared_ptr<Playlist> > pl;
571 Glib::Threads::Mutex::Lock lm (lock);
573 for (List::const_iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
580 /** @return list of Playlists that are associated with a track */
581 vector<boost::shared_ptr<Playlist> >
582 SessionPlaylists::playlists_for_track (boost::shared_ptr<Track> tr) const
584 vector<boost::shared_ptr<Playlist> > pl;
587 vector<boost::shared_ptr<Playlist> > pl_tr;
589 for (vector<boost::shared_ptr<Playlist> >::iterator i = pl.begin(); i != pl.end(); ++i) {
590 if ( ((*i)->get_orig_track_id() == tr->id()) ||
591 (tr->playlist()->id() == (*i)->id()) ||
592 ((*i)->shared_with (tr->id())) )
594 pl_tr.push_back (*i);
602 SessionPlaylists::foreach (boost::function<void(boost::shared_ptr<const Playlist>)> functor, bool incl_unused)
604 Glib::Threads::Mutex::Lock lm (lock);
605 for (List::iterator i = playlists.begin(); i != playlists.end(); i++) {
606 if (!(*i)->hidden()) {
613 for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); i++) {
614 if (!(*i)->hidden()) {