libs/ardour/session_playlists.cc

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19 #include <vector>
  20
  21 #include "ardour/debug.h"
  22 #include "ardour/playlist.h"
  23 #include "ardour/playlist_factory.h"
  24 #include "ardour/session_playlists.h"
  25 #include "ardour/track.h"
  26 #include "i18n.h"
  27 #include "pbd/compose.h"
  28 #include "pbd/xml++.h"
  29
  30 using namespace std;
  31 using namespace PBD;
  32 using namespace ARDOUR;
  33
  34 SessionPlaylists::~SessionPlaylists ()
  35 {
  36         DEBUG_TRACE (DEBUG::Destruction, "delete playlists\n");
  37
  38         for (List::iterator i = playlists.begin(); i != playlists.end(); ) {
  39                 SessionPlaylists::List::iterator tmp;
  40
  41                 tmp = i;
  42                 ++tmp;
  43
  44                 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for used playlist %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
  45                 boost::shared_ptr<Playlist> keeper (*i);
  46                 (*i)->drop_references ();
  47
  48                 i = tmp;
  49         }
  50
  51         DEBUG_TRACE (DEBUG::Destruction, "delete unused playlists\n");
  52         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ) {
  53                 List::iterator tmp;
  54
  55                 tmp = i;
  56                 ++tmp;
  57
  58                 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for unused playlist %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
  59                 boost::shared_ptr<Playlist> keeper (*i);
  60                 (*i)->drop_references ();
  61
  62                 i = tmp;
  63         }
  64
  65         playlists.clear ();
  66         unused_playlists.clear ();
  67 }
  68
  69 bool
  70 SessionPlaylists::add (boost::shared_ptr<Playlist> playlist)
  71 {
  72         Glib::Threads::Mutex::Lock lm (lock);
  73
  74         bool const existing = find (playlists.begin(), playlists.end(), playlist) != playlists.end();
  75
  76         if (!existing) {
  77                 playlists.insert (playlists.begin(), playlist);
  78                 playlist->InUse.connect_same_thread (*this, boost::bind (&SessionPlaylists::track, this, _1, boost::weak_ptr<Playlist>(playlist)));
  79                 playlist->DropReferences.connect_same_thread (
  80                         *this, boost::bind (&SessionPlaylists::remove_weak, this, boost::weak_ptr<Playlist> (playlist))
  81                         );
  82         }
  83
  84         return existing;
  85 }
  86
  87 void
  88 SessionPlaylists::remove_weak (boost::weak_ptr<Playlist> playlist)
  89 {
  90         boost::shared_ptr<Playlist> p = playlist.lock ();
  91         if (p) {
  92                 remove (p);
  93         }
  94 }
  95
  96 void
  97 SessionPlaylists::remove (boost::shared_ptr<Playlist> playlist)
  98 {
  99         Glib::Threads::Mutex::Lock lm (lock);
 100
 101         List::iterator i;
 102
 103         i = find (playlists.begin(), playlists.end(), playlist);
 104         if (i != playlists.end()) {
 105                 playlists.erase (i);
 106         }
 107
 108         i = find (unused_playlists.begin(), unused_playlists.end(), playlist);
 109         if (i != unused_playlists.end()) {
 110                 unused_playlists.erase (i);
 111         }
 112 }
 113
 114
 115 void
 116 SessionPlaylists::track (bool inuse, boost::weak_ptr<Playlist> wpl)
 117 {
 118         boost::shared_ptr<Playlist> pl(wpl.lock());
 119
 120         if (!pl) {
 121                 return;
 122         }
 123
 124         List::iterator x;
 125
 126         if (pl->hidden()) {
 127                 /* its not supposed to be visible */
 128                 return;
 129         }
 130
 131         {
 132                 Glib::Threads::Mutex::Lock lm (lock);
 133
 134                 if (!inuse) {
 135
 136                         unused_playlists.insert (pl);
 137
 138                         if ((x = playlists.find (pl)) != playlists.end()) {
 139                                 playlists.erase (x);
 140                         }
 141
 142
 143                 } else {
 144
 145                         playlists.insert (pl);
 146
 147                         if ((x = unused_playlists.find (pl)) != unused_playlists.end()) {
 148                                 unused_playlists.erase (x);
 149                         }
 150                 }
 151         }
 152 }
 153
 154 uint32_t
 155 SessionPlaylists::n_playlists () const
 156 {
 157         Glib::Threads::Mutex::Lock lm (lock);
 158         return playlists.size();
 159 }
 160
 161 boost::shared_ptr<Playlist>
 162 SessionPlaylists::by_name (string name)
 163 {
 164         Glib::Threads::Mutex::Lock lm (lock);
 165
 166         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 167                 if ((*i)->name() == name) {
 168                         return* i;
 169                 }
 170         }
 171
 172         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 173                 if ((*i)->name() == name) {
 174                         return* i;
 175                 }
 176         }
 177
 178         return boost::shared_ptr<Playlist>();
 179 }
 180
 181 boost::shared_ptr<Playlist>
 182 SessionPlaylists::by_id (const PBD::ID& id)
 183 {
 184         Glib::Threads::Mutex::Lock lm (lock);
 185
 186         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 187                 if ((*i)->id() == id) {
 188                         return* i;
 189                 }
 190         }
 191
 192         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 193                 if ((*i)->id() == id) {
 194                         return* i;
 195                 }
 196         }
 197
 198         return boost::shared_ptr<Playlist>();
 199 }
 200
 201 void
 202 SessionPlaylists::unassigned (std::list<boost::shared_ptr<Playlist> > & list)
 203 {
 204         Glib::Threads::Mutex::Lock lm (lock);
 205
 206         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 207                 if (!(*i)->get_orig_track_id().to_s().compare ("0")) {
 208                         list.push_back (*i);
 209                 }
 210         }
 211
 212         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 213                 if (!(*i)->get_orig_track_id().to_s().compare ("0")) {
 214                         list.push_back (*i);
 215                 }
 216         }
 217 }
 218
 219 void
 220 SessionPlaylists::get (vector<boost::shared_ptr<Playlist> >& s) const
 221 {
 222         Glib::Threads::Mutex::Lock lm (lock);
 223
 224         for (List::const_iterator i = playlists.begin(); i != playlists.end(); ++i) {
 225                 s.push_back (*i);
 226         }
 227
 228         for (List::const_iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 229                 s.push_back (*i);
 230         }
 231 }
 232
 233 void
 234 SessionPlaylists::destroy_region (boost::shared_ptr<Region> r)
 235 {
 236         Glib::Threads::Mutex::Lock lm (lock);
 237
 238         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 239                 (*i)->destroy_region (r);
 240         }
 241
 242         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 243                 (*i)->destroy_region (r);
 244         }
 245 }
 246
 247
 248 void
 249 SessionPlaylists::find_equivalent_playlist_regions (boost::shared_ptr<Region> region, vector<boost::shared_ptr<Region> >& result)
 250 {
 251         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i)
 252                 (*i)->get_region_list_equivalent_regions (region, result);
 253 }
 254
 255 /** Return the number of playlists (not regions) that contain @a src
 256  *  Important: this counts usage in both used and not-used playlists.
 257  */
 258 uint32_t
 259 SessionPlaylists::source_use_count (boost::shared_ptr<const Source> src) const
 260 {
 261         uint32_t count = 0;
 262
 263         for (List::const_iterator p = playlists.begin(); p != playlists.end(); ++p) {
 264                 if ((*p)->uses_source (src)) {
 265                         ++count;
 266                         break;
 267                 }
 268         }
 269
 270         for (List::const_iterator p = unused_playlists.begin(); p != unused_playlists.end(); ++p) {
 271                 if ((*p)->uses_source (src)) {
 272                         ++count;
 273                         break;
 274                 }
 275         }
 276
 277         return count;
 278 }
 279
 280 void
 281 SessionPlaylists::sync_all_regions_with_regions ()
 282 {
 283         Glib::Threads::Mutex::Lock lm (lock);
 284
 285         for (List::const_iterator p = playlists.begin(); p != playlists.end(); ++p) {
 286                 (*p)->sync_all_regions_with_regions ();
 287         }
 288 }
 289
 290 void
 291 SessionPlaylists::update_after_tempo_map_change ()
 292 {
 293         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 294                 (*i)->update_after_tempo_map_change ();
 295         }
 296
 297         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 298                 (*i)->update_after_tempo_map_change ();
 299         }
 300 }
 301
 302 void
 303 SessionPlaylists::add_state (XMLNode* node, bool full_state)
 304 {
 305         XMLNode* child = node->add_child ("Playlists");
 306         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 307                 if (!(*i)->hidden()) {
 308                         if (full_state) {
 309                                 child->add_child_nocopy ((*i)->get_state());
 310                         } else {
 311                                 child->add_child_nocopy ((*i)->get_template());
 312                         }
 313                 }
 314         }
 315
 316         child = node->add_child ("UnusedPlaylists");
 317         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 318                 if (!(*i)->hidden()) {
 319                         if (!(*i)->empty()) {
 320                                 if (full_state) {
 321                                         child->add_child_nocopy ((*i)->get_state());
 322                                 } else {
 323                                         child->add_child_nocopy ((*i)->get_template());
 324                                 }
 325                         }
 326                 }
 327         }
 328 }
 329
 330 /** @return true for `stop cleanup', otherwise false */
 331 bool
 332 SessionPlaylists::maybe_delete_unused (boost::function<int(boost::shared_ptr<Playlist>)> ask)
 333 {
 334         vector<boost::shared_ptr<Playlist> > playlists_tbd;
 335
 336         bool delete_remaining = false;
 337         bool keep_remaining = false;
 338
 339         for (List::iterator x = unused_playlists.begin(); x != unused_playlists.end(); ++x) {
 340
 341                 if (keep_remaining) {
 342                         break;
 343                 }
 344
 345                 if (delete_remaining) {
 346                         playlists_tbd.push_back (*x);
 347                         continue;
 348                 }
 349
 350                 int status = ask (*x);
 351
 352                 switch (status) {
 353                 case -1:
 354                         // abort
 355                         return true;
 356
 357                 case -2:
 358                         // keep this and all later
 359                         keep_remaining = true;
 360                         break;
 361
 362                 case 2:
 363                         // delete this and all later
 364                         delete_remaining = true;
 365                         // no break;
 366
 367                 case 1:
 368                         // delete this
 369                         playlists_tbd.push_back (*x);
 370                         break;
 371
 372                 default:
 373                         /* leave it alone */
 374                         break;
 375                 }
 376         }
 377
 378         /* now delete any that were marked for deletion */
 379
 380         for (vector<boost::shared_ptr<Playlist> >::iterator x = playlists_tbd.begin(); x != playlists_tbd.end(); ++x) {
 381                 boost::shared_ptr<Playlist> keeper (*x);
 382                 (*x)->drop_references ();
 383         }
 384
 385         playlists_tbd.clear ();
 386
 387         return false;
 388 }
 389
 390 int
 391 SessionPlaylists::load (Session& session, const XMLNode& node)
 392 {
 393         XMLNodeList nlist;
 394         XMLNodeConstIterator niter;
 395         boost::shared_ptr<Playlist> playlist;
 396
 397         nlist = node.children();
 398
 399         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 400
 401                 if ((playlist = XMLPlaylistFactory (session, **niter)) == 0) {
 402                         error << _("Session: cannot create Playlist from XML description.") << endmsg;
 403                 }
 404         }
 405
 406         return 0;
 407 }
 408
 409 int
 410 SessionPlaylists::load_unused (Session& session, const XMLNode& node)
 411 {
 412         XMLNodeList nlist;
 413         XMLNodeConstIterator niter;
 414         boost::shared_ptr<Playlist> playlist;
 415
 416         nlist = node.children();
 417
 418         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 419
 420                 if ((playlist = XMLPlaylistFactory (session, **niter)) == 0) {
 421                         error << _("Session: cannot create Playlist from XML description.") << endmsg;
 422                         continue;
 423                 }
 424
 425                 // now manually untrack it
 426
 427                 track (false, boost::weak_ptr<Playlist> (playlist));
 428         }
 429
 430         return 0;
 431 }
 432
 433 boost::shared_ptr<Playlist>
 434 SessionPlaylists::XMLPlaylistFactory (Session& session, const XMLNode& node)
 435 {
 436         try {
 437                 return PlaylistFactory::create (session, node);
 438         }
 439
 440         catch (failed_constructor& err) {
 441                 return boost::shared_ptr<Playlist>();
 442         }
 443 }
 444
 445 boost::shared_ptr<Crossfade>
 446 SessionPlaylists::find_crossfade (const PBD::ID& id)
 447 {
 448         Glib::Threads::Mutex::Lock lm (lock);
 449
 450         boost::shared_ptr<Crossfade> c;
 451
 452         for (List::iterator i = playlists.begin(); i != playlists.end(); ++i) {
 453                 c = (*i)->find_crossfade (id);
 454                 if (c) {
 455                         return c;
 456                 }
 457         }
 458
 459         for (List::iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 460                 c = (*i)->find_crossfade (id);
 461                 if (c) {
 462                         return c;
 463                 }
 464         }
 465
 466         return boost::shared_ptr<Crossfade> ();
 467 }
 468
 469 uint32_t
 470 SessionPlaylists::region_use_count (boost::shared_ptr<Region> region) const
 471 {
 472         Glib::Threads::Mutex::Lock lm (lock);
 473         uint32_t cnt = 0;
 474
 475         for (List::const_iterator i = playlists.begin(); i != playlists.end(); ++i) {
 476                 cnt += (*i)->region_use_count (region);
 477         }
 478
 479         for (List::const_iterator i = unused_playlists.begin(); i != unused_playlists.end(); ++i) {
 480                 cnt += (*i)->region_use_count (region);
 481         }
 482
 483         return cnt;
 484 }
 485
 486 /** @return list of Playlists that are associated with a track */
 487 vector<boost::shared_ptr<Playlist> >
 488 SessionPlaylists::playlists_for_track (boost::shared_ptr<Track> tr) const
 489 {
 490         vector<boost::shared_ptr<Playlist> > pl;
 491         get (pl);
 492
 493         vector<boost::shared_ptr<Playlist> > pl_tr;
 494
 495         for (vector<boost::shared_ptr<Playlist> >::iterator i = pl.begin(); i != pl.end(); ++i) {
 496                 if (((*i)->get_orig_track_id() == tr->id()) || (tr->playlist()->id() == (*i)->id())) {
 497                         pl_tr.push_back (*i);
 498                 }
 499         }
 500
 501         return pl_tr;
 502 }