libs/ardour/playlist.cc

   1 /*
   2     Copyright (C) 2000-2003 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
  20 #include <stdint.h>
  21 #include <set>
  22 #include <algorithm>
  23 #include <string>
  24
  25 #include <boost/lexical_cast.hpp>
  26
  27 #include "pbd/convert.h"
  28 #include "pbd/stateful_diff_command.h"
  29 #include "pbd/xml++.h"
  30
  31 #include "ardour/debug.h"
  32 #include "ardour/playlist.h"
  33 #include "ardour/session.h"
  34 #include "ardour/region.h"
  35 #include "ardour/region_factory.h"
  36 #include "ardour/region_sorters.h"
  37 #include "ardour/playlist_factory.h"
  38 #include "ardour/playlist_source.h"
  39 #include "ardour/transient_detector.h"
  40 #include "ardour/session_playlists.h"
  41 #include "ardour/source_factory.h"
  42
  43 #include "i18n.h"
  44
  45 using namespace std;
  46 using namespace ARDOUR;
  47 using namespace PBD;
  48
  49 namespace ARDOUR {
  50         namespace Properties {
  51                 PBD::PropertyDescriptor<bool> regions;
  52         }
  53 }
  54
  55 struct ShowMeTheList {
  56     ShowMeTheList (boost::shared_ptr<Playlist> pl, const string& n) : playlist (pl), name (n) {}
  57     ~ShowMeTheList () {
  58             cerr << ">>>>" << name << endl; playlist->dump(); cerr << "<<<<" << name << endl << endl;
  59     };
  60     boost::shared_ptr<Playlist> playlist;
  61     string name;
  62 };
  63
  64
  65
  66 void
  67 Playlist::make_property_quarks ()
  68 {
  69         Properties::regions.property_id = g_quark_from_static_string (X_("regions"));
  70         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for regions = %1\n",
  71                                                         Properties::regions.property_id));
  72 }
  73
  74 RegionListProperty::RegionListProperty (Playlist& pl)
  75         : SequenceProperty<std::list<boost::shared_ptr<Region> > > (Properties::regions.property_id, boost::bind (&Playlist::update, &pl, _1))
  76         , _playlist (pl)
  77 {
  78
  79 }
  80
  81 RegionListProperty::RegionListProperty (RegionListProperty const & p)
  82         : PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > > (p)
  83         , _playlist (p._playlist)
  84 {
  85
  86 }
  87
  88 RegionListProperty *
  89 RegionListProperty::clone () const
  90 {
  91         return new RegionListProperty (*this);
  92 }
  93
  94 RegionListProperty *
  95 RegionListProperty::create () const
  96 {
  97         return new RegionListProperty (_playlist);
  98 }
  99
 100 void
 101 RegionListProperty::get_content_as_xml (boost::shared_ptr<Region> region, XMLNode & node) const
 102 {
 103         /* All regions (even those which are deleted) have their state saved by other
 104            code, so we can just store ID here.
 105         */
 106
 107         node.add_property ("id", region->id().to_s ());
 108 }
 109
 110 boost::shared_ptr<Region>
 111 RegionListProperty::get_content_from_xml (XMLNode const & node) const
 112 {
 113         XMLProperty const * prop = node.property ("id");
 114         assert (prop);
 115
 116         PBD::ID id (prop->value ());
 117
 118         boost::shared_ptr<Region> ret = _playlist.region_by_id (id);
 119
 120         if (!ret) {
 121                 ret = RegionFactory::region_by_id (id);
 122         }
 123
 124         return ret;
 125 }
 126
 127 Playlist::Playlist (Session& sess, string nom, DataType type, bool hide)
 128         : SessionObject(sess, nom)
 129         , regions (*this)
 130         , _type(type)
 131 {
 132         init (hide);
 133         first_set_state = false;
 134         _name = nom;
 135         _set_sort_id ();
 136 }
 137
 138 Playlist::Playlist (Session& sess, const XMLNode& node, DataType type, bool hide)
 139         : SessionObject(sess, "unnamed playlist")
 140         , regions (*this)
 141         , _type(type)
 142 {
 143 #ifndef NDEBUG
 144         XMLProperty const * prop = node.property("type");
 145         assert(!prop || DataType(prop->value()) == _type);
 146 #endif
 147
 148         init (hide);
 149         _name = "unnamed"; /* reset by set_state */
 150         _set_sort_id ();
 151
 152         /* set state called by derived class */
 153 }
 154
 155 Playlist::Playlist (boost::shared_ptr<const Playlist> other, string namestr, bool hide)
 156         : SessionObject(other->_session, namestr)
 157         , regions (*this)
 158         , _type(other->_type)
 159         , _orig_track_id (other->_orig_track_id)
 160 {
 161         init (hide);
 162
 163         RegionList tmp;
 164         other->copy_regions (tmp);
 165
 166         in_set_state++;
 167
 168         for (list<boost::shared_ptr<Region> >::iterator x = tmp.begin(); x != tmp.end(); ++x) {
 169                 add_region_internal( (*x), (*x)->position());
 170         }
 171
 172         in_set_state--;
 173
 174         _splicing  = other->_splicing;
 175         _rippling  = other->_rippling;
 176         _nudging   = other->_nudging;
 177         _edit_mode = other->_edit_mode;
 178
 179         in_set_state = 0;
 180         first_set_state = false;
 181         in_flush = false;
 182         in_partition = false;
 183         subcnt = 0;
 184         _frozen = other->_frozen;
 185 }
 186
 187 Playlist::Playlist (boost::shared_ptr<const Playlist> other, framepos_t start, framecnt_t cnt, string str, bool hide)
 188         : SessionObject(other->_session, str)
 189         , regions (*this)
 190         , _type(other->_type)
 191         , _orig_track_id (other->_orig_track_id)
 192 {
 193         RegionReadLock rlock2 (const_cast<Playlist*> (other.get()));
 194
 195         framepos_t end = start + cnt - 1;
 196
 197         init (hide);
 198
 199         in_set_state++;
 200
 201         for (RegionList::const_iterator i = other->regions.begin(); i != other->regions.end(); ++i) {
 202
 203                 boost::shared_ptr<Region> region;
 204                 boost::shared_ptr<Region> new_region;
 205                 frameoffset_t offset = 0;
 206                 framepos_t position = 0;
 207                 framecnt_t len = 0;
 208                 string    new_name;
 209                 Evoral::OverlapType overlap;
 210
 211                 region = *i;
 212
 213                 overlap = region->coverage (start, end);
 214
 215                 switch (overlap) {
 216                 case Evoral::OverlapNone:
 217                         continue;
 218
 219                 case Evoral::OverlapInternal:
 220                         offset = start - region->position();
 221                         position = 0;
 222                         len = cnt;
 223                         break;
 224
 225                 case Evoral::OverlapStart:
 226                         offset = 0;
 227                         position = region->position() - start;
 228                         len = end - region->position();
 229                         break;
 230
 231                 case Evoral::OverlapEnd:
 232                         offset = start - region->position();
 233                         position = 0;
 234                         len = region->length() - offset;
 235                         break;
 236
 237                 case Evoral::OverlapExternal:
 238                         offset = 0;
 239                         position = region->position() - start;
 240                         len = region->length();
 241                         break;
 242                 }
 243
 244                 RegionFactory::region_name (new_name, region->name(), false);
 245
 246                 PropertyList plist;
 247
 248                 plist.add (Properties::start, region->start() + offset);
 249                 plist.add (Properties::length, len);
 250                 plist.add (Properties::name, new_name);
 251                 plist.add (Properties::layer, region->layer());
 252                 plist.add (Properties::layering_index, region->layering_index());
 253
 254                 new_region = RegionFactory::create (region, plist);
 255
 256                 add_region_internal (new_region, position);
 257         }
 258
 259         //keep track of any dead space at end (for pasting into Ripple or Splice mode)
 260         //at the end of construction, any length of cnt beyond the extents of the regions is end_space
 261         _end_space = cnt - (get_extent().second - get_extent().first);
 262
 263         in_set_state--;
 264         first_set_state = false;
 265 }
 266
 267 void
 268 Playlist::use ()
 269 {
 270         ++_refcnt;
 271         InUse (true); /* EMIT SIGNAL */
 272 }
 273
 274 void
 275 Playlist::release ()
 276 {
 277         if (_refcnt > 0) {
 278                 _refcnt--;
 279         }
 280
 281         if (_refcnt == 0) {
 282                 InUse (false); /* EMIT SIGNAL */
 283         }
 284 }
 285
 286 void
 287 Playlist::copy_regions (RegionList& newlist) const
 288 {
 289         RegionReadLock rlock (const_cast<Playlist *> (this));
 290
 291         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
 292                 newlist.push_back (RegionFactory::create (*i, true));
 293         }
 294 }
 295
 296 void
 297 Playlist::init (bool hide)
 298 {
 299         add_property (regions);
 300         _xml_node_name = X_("Playlist");
 301
 302         g_atomic_int_set (&block_notifications, 0);
 303         g_atomic_int_set (&ignore_state_changes, 0);
 304         pending_contents_change = false;
 305         pending_layering = false;
 306         first_set_state = true;
 307         _refcnt = 0;
 308         _hidden = hide;
 309         _splicing = false;
 310         _rippling = false;
 311         _shuffling = false;
 312         _nudging = false;
 313         in_set_state = 0;
 314         in_undo = false;
 315         _edit_mode = Config->get_edit_mode();
 316         in_flush = false;
 317         in_partition = false;
 318         subcnt = 0;
 319         _frozen = false;
 320         _capture_insertion_underway = false;
 321         _combine_ops = 0;
 322         _end_space = 0;
 323
 324         _session.history().BeginUndoRedo.connect_same_thread (*this, boost::bind (&Playlist::begin_undo, this));
 325         _session.history().EndUndoRedo.connect_same_thread (*this, boost::bind (&Playlist::end_undo, this));
 326
 327         ContentsChanged.connect_same_thread (*this, boost::bind (&Playlist::mark_session_dirty, this));
 328 }
 329
 330 Playlist::~Playlist ()
 331 {
 332         DEBUG_TRACE (DEBUG::Destruction, string_compose ("Playlist %1 destructor\n", _name));
 333
 334         {
 335                 RegionReadLock rl (this);
 336
 337                 for (set<boost::shared_ptr<Region> >::iterator i = all_regions.begin(); i != all_regions.end(); ++i) {
 338                         (*i)->set_playlist (boost::shared_ptr<Playlist>());
 339                 }
 340         }
 341
 342         /* GoingAway must be emitted by derived classes */
 343 }
 344
 345 void
 346 Playlist::_set_sort_id ()
 347 {
 348         /*
 349           Playlists are given names like <track name>.<id>
 350           or <track name>.<edit group name>.<id> where id
 351           is an integer. We extract the id and sort by that.
 352         */
 353
 354         size_t dot_position = _name.val().find_last_of(".");
 355
 356         if (dot_position == string::npos) {
 357                 _sort_id = 0;
 358         } else {
 359                 string t = _name.val().substr(dot_position + 1);
 360
 361                 try {
 362                         _sort_id = boost::lexical_cast<int>(t);
 363                 }
 364
 365                 catch (boost::bad_lexical_cast e) {
 366                         _sort_id = 0;
 367                 }
 368         }
 369 }
 370
 371 bool
 372 Playlist::set_name (const string& str)
 373 {
 374         /* in a typical situation, a playlist is being used
 375            by one diskstream and also is referenced by the
 376            Session. if there are more references than that,
 377            then don't change the name.
 378         */
 379
 380         if (_refcnt > 2) {
 381                 return false;
 382         }
 383
 384         bool ret =  SessionObject::set_name(str);
 385         if (ret) {
 386                 _set_sort_id ();
 387         }
 388         return ret;
 389 }
 390
 391 /***********************************************************************
 392  CHANGE NOTIFICATION HANDLING
 393
 394  Notifications must be delayed till the region_lock is released. This
 395  is necessary because handlers for the signals may need to acquire
 396  the lock (e.g. to read from the playlist).
 397  ***********************************************************************/
 398
 399 void
 400 Playlist::begin_undo ()
 401 {
 402         in_undo = true;
 403         freeze ();
 404 }
 405
 406 void
 407 Playlist::end_undo ()
 408 {
 409         thaw (true);
 410         in_undo = false;
 411 }
 412
 413 void
 414 Playlist::freeze ()
 415 {
 416         delay_notifications ();
 417         g_atomic_int_inc (&ignore_state_changes);
 418 }
 419
 420 /** @param from_undo true if this thaw is triggered by the end of an undo on this playlist */
 421 void
 422 Playlist::thaw (bool from_undo)
 423 {
 424         g_atomic_int_dec_and_test (&ignore_state_changes);
 425         release_notifications (from_undo);
 426 }
 427
 428
 429 void
 430 Playlist::delay_notifications ()
 431 {
 432         g_atomic_int_inc (&block_notifications);
 433 }
 434
 435 /** @param from_undo true if this release is triggered by the end of an undo on this playlist */
 436 void
 437 Playlist::release_notifications (bool from_undo)
 438 {
 439         if (g_atomic_int_dec_and_test (&block_notifications)) {
 440                 flush_notifications (from_undo);
 441         }
 442 }
 443
 444 void
 445 Playlist::notify_contents_changed ()
 446 {
 447         if (holding_state ()) {
 448                 pending_contents_change = true;
 449         } else {
 450                 pending_contents_change = false;
 451                 ContentsChanged(); /* EMIT SIGNAL */
 452         }
 453 }
 454
 455 void
 456 Playlist::notify_layering_changed ()
 457 {
 458         if (holding_state ()) {
 459                 pending_layering = true;
 460         } else {
 461                 pending_layering = false;
 462                 LayeringChanged(); /* EMIT SIGNAL */
 463         }
 464 }
 465
 466 void
 467 Playlist::notify_region_removed (boost::shared_ptr<Region> r)
 468 {
 469         if (holding_state ()) {
 470                 pending_removes.insert (r);
 471                 pending_contents_change = true;
 472         } else {
 473                 /* this might not be true, but we have to act
 474                    as though it could be.
 475                 */
 476                 pending_contents_change = false;
 477                 RegionRemoved (boost::weak_ptr<Region> (r)); /* EMIT SIGNAL */
 478                 ContentsChanged (); /* EMIT SIGNAL */
 479         }
 480 }
 481
 482 void
 483 Playlist::notify_region_moved (boost::shared_ptr<Region> r)
 484 {
 485         Evoral::RangeMove<framepos_t> const move (r->last_position (), r->length (), r->position ());
 486
 487         if (holding_state ()) {
 488
 489                 pending_range_moves.push_back (move);
 490
 491         } else {
 492
 493                 list< Evoral::RangeMove<framepos_t> > m;
 494                 m.push_back (move);
 495                 RangesMoved (m, false);
 496         }
 497
 498 }
 499
 500 void
 501 Playlist::notify_region_start_trimmed (boost::shared_ptr<Region> r)
 502 {
 503         if (r->position() >= r->last_position()) {
 504                 /* trimmed shorter */
 505                 return;
 506         }
 507
 508         Evoral::Range<framepos_t> const extra (r->position(), r->last_position());
 509
 510         if (holding_state ()) {
 511
 512                 pending_region_extensions.push_back (extra);
 513
 514         } else {
 515
 516                 list<Evoral::Range<framepos_t> > r;
 517                 r.push_back (extra);
 518                 RegionsExtended (r);
 519
 520         }
 521 }
 522
 523 void
 524 Playlist::notify_region_end_trimmed (boost::shared_ptr<Region> r)
 525 {
 526         if (r->length() < r->last_length()) {
 527                 /* trimmed shorter */
 528         }
 529
 530         Evoral::Range<framepos_t> const extra (r->position() + r->last_length(), r->position() + r->length());
 531
 532         if (holding_state ()) {
 533
 534                 pending_region_extensions.push_back (extra);
 535
 536         } else {
 537
 538                 list<Evoral::Range<framepos_t> > r;
 539                 r.push_back (extra);
 540                 RegionsExtended (r);
 541         }
 542 }
 543
 544
 545 void
 546 Playlist::notify_region_added (boost::shared_ptr<Region> r)
 547 {
 548         /* the length change might not be true, but we have to act
 549            as though it could be.
 550         */
 551
 552         if (holding_state()) {
 553                 pending_adds.insert (r);
 554                 pending_contents_change = true;
 555         } else {
 556                 r->clear_changes ();
 557                 pending_contents_change = false;
 558                 RegionAdded (boost::weak_ptr<Region> (r)); /* EMIT SIGNAL */
 559                 ContentsChanged (); /* EMIT SIGNAL */
 560
 561         }
 562 }
 563
 564 /** @param from_undo true if this flush is triggered by the end of an undo on this playlist */
 565 void
 566 Playlist::flush_notifications (bool from_undo)
 567 {
 568         set<boost::shared_ptr<Region> >::iterator s;
 569         bool regions_changed = false;
 570
 571         if (in_flush) {
 572                 return;
 573         }
 574
 575         in_flush = true;
 576
 577         if (!pending_bounds.empty() || !pending_removes.empty() || !pending_adds.empty()) {
 578                 regions_changed = true;
 579         }
 580
 581         /* XXX: it'd be nice if we could use pending_bounds for
 582            RegionsExtended and RegionsMoved.
 583         */
 584
 585         /* we have no idea what order the regions ended up in pending
 586            bounds (it could be based on selection order, for example).
 587            so, to preserve layering in the "most recently moved is higher"
 588            model, sort them by existing layer, then timestamp them.
 589         */
 590
 591         // RegionSortByLayer cmp;
 592         // pending_bounds.sort (cmp);
 593
 594         list<Evoral::Range<framepos_t> > crossfade_ranges;
 595
 596         for (RegionList::iterator r = pending_bounds.begin(); r != pending_bounds.end(); ++r) {
 597                 crossfade_ranges.push_back ((*r)->last_range ());
 598                 crossfade_ranges.push_back ((*r)->range ());
 599         }
 600
 601         for (s = pending_removes.begin(); s != pending_removes.end(); ++s) {
 602                 crossfade_ranges.push_back ((*s)->range ());
 603                 remove_dependents (*s);
 604                 RegionRemoved (boost::weak_ptr<Region> (*s)); /* EMIT SIGNAL */
 605         }
 606
 607         for (s = pending_adds.begin(); s != pending_adds.end(); ++s) {
 608                 crossfade_ranges.push_back ((*s)->range ());
 609                 /* don't emit RegionAdded signal until relayering is done,
 610                    so that the region is fully setup by the time
 611                    anyone hears that its been added
 612                 */
 613         }
 614
 615         /* notify about contents/region changes first so that layering changes
 616          * in a UI will take place on the new contents.
 617          */
 618
 619         if (regions_changed || pending_contents_change) {
 620                 pending_layering = true;
 621                 ContentsChanged (); /* EMIT SIGNAL */
 622         }
 623
 624         for (s = pending_adds.begin(); s != pending_adds.end(); ++s) {
 625                 (*s)->clear_changes ();
 626                 RegionAdded (boost::weak_ptr<Region> (*s)); /* EMIT SIGNAL */
 627         }
 628
 629         if ((regions_changed && !in_set_state) || pending_layering) {
 630                 relayer ();
 631         }
 632
 633         coalesce_and_check_crossfades (crossfade_ranges);
 634
 635         if (!pending_range_moves.empty ()) {
 636                 /* We don't need to check crossfades for these as pending_bounds has
 637                    already covered it.
 638                 */
 639                 RangesMoved (pending_range_moves, from_undo);
 640         }
 641
 642         if (!pending_region_extensions.empty ()) {
 643                 RegionsExtended (pending_region_extensions);
 644         }
 645
 646         clear_pending ();
 647
 648         in_flush = false;
 649 }
 650
 651  void
 652  Playlist::clear_pending ()
 653  {
 654          pending_adds.clear ();
 655          pending_removes.clear ();
 656          pending_bounds.clear ();
 657          pending_range_moves.clear ();
 658          pending_region_extensions.clear ();
 659          pending_contents_change = false;
 660  }
 661
 662  /*************************************************************
 663    PLAYLIST OPERATIONS
 664   *************************************************************/
 665
 666 /** Note: this calls set_layer (..., DBL_MAX) so it will reset the layering index of region */
 667  void
 668  Playlist::add_region (boost::shared_ptr<Region> region, framepos_t position, float times, bool auto_partition)
 669  {
 670          RegionWriteLock rlock (this);
 671          times = fabs (times);
 672
 673          int itimes = (int) floor (times);
 674
 675          framepos_t pos = position;
 676
 677          if (times == 1 && auto_partition){
 678                  partition(pos - 1, (pos + region->length()), true);
 679          }
 680
 681          if (itimes >= 1) {
 682                  add_region_internal (region, pos);
 683                  set_layer (region, DBL_MAX);
 684                  pos += region->length();
 685                  --itimes;
 686          }
 687
 688
 689          /* note that itimes can be zero if we being asked to just
 690             insert a single fraction of the region.
 691          */
 692
 693          for (int i = 0; i < itimes; ++i) {
 694                  boost::shared_ptr<Region> copy = RegionFactory::create (region, true);
 695                  add_region_internal (copy, pos);
 696                  set_layer (copy, DBL_MAX);
 697                  pos += region->length();
 698          }
 699
 700          framecnt_t length = 0;
 701
 702          if (floor (times) != times) {
 703                  length = (framecnt_t) floor (region->length() * (times - floor (times)));
 704                  string name;
 705                  RegionFactory::region_name (name, region->name(), false);
 706
 707                  {
 708                          PropertyList plist;
 709
 710                          plist.add (Properties::start, region->start());
 711                          plist.add (Properties::length, length);
 712                          plist.add (Properties::name, name);
 713                          plist.add (Properties::layer, region->layer());
 714
 715                          boost::shared_ptr<Region> sub = RegionFactory::create (region, plist);
 716                          add_region_internal (sub, pos);
 717                          set_layer (sub, DBL_MAX);
 718                  }
 719          }
 720
 721          possibly_splice_unlocked (position, (pos + length) - position, region);
 722  }
 723
 724  void
 725  Playlist::set_region_ownership ()
 726  {
 727          RegionWriteLock rl (this);
 728          RegionList::iterator i;
 729          boost::weak_ptr<Playlist> pl (shared_from_this());
 730
 731          for (i = regions.begin(); i != regions.end(); ++i) {
 732                  (*i)->set_playlist (pl);
 733          }
 734  }
 735
 736  bool
 737  Playlist::add_region_internal (boost::shared_ptr<Region> region, framepos_t position)
 738  {
 739          if (region->data_type() != _type) {
 740                  return false;
 741          }
 742
 743          RegionSortByPosition cmp;
 744
 745          if (!first_set_state) {
 746                  boost::shared_ptr<Playlist> foo (shared_from_this());
 747                  region->set_playlist (boost::weak_ptr<Playlist>(foo));
 748          }
 749
 750          region->set_position (position);
 751
 752          regions.insert (upper_bound (regions.begin(), regions.end(), region, cmp), region);
 753          all_regions.insert (region);
 754
 755          possibly_splice_unlocked (position, region->length(), region);
 756
 757          if (!holding_state ()) {
 758                  /* layers get assigned from XML state, and are not reset during undo/redo */
 759                  relayer ();
 760          }
 761
 762          /* we need to notify the existence of new region before checking dependents. Ick. */
 763
 764          notify_region_added (region);
 765
 766          region->PropertyChanged.connect_same_thread (region_state_changed_connections, boost::bind (&Playlist::region_changed_proxy, this, _1, boost::weak_ptr<Region> (region)));
 767
 768          return true;
 769  }
 770
 771  void
 772  Playlist::replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos)
 773  {
 774          RegionWriteLock rlock (this);
 775
 776          bool old_sp = _splicing;
 777          _splicing = true;
 778
 779          remove_region_internal (old);
 780          add_region_internal (newr, pos);
 781          set_layer (newr, old->layer ());
 782
 783          _splicing = old_sp;
 784
 785          possibly_splice_unlocked (pos, old->length() - newr->length());
 786  }
 787
 788  void
 789  Playlist::remove_region (boost::shared_ptr<Region> region)
 790  {
 791          RegionWriteLock rlock (this);
 792          remove_region_internal (region);
 793  }
 794
 795  int
 796  Playlist::remove_region_internal (boost::shared_ptr<Region> region)
 797  {
 798          RegionList::iterator i;
 799
 800          if (!in_set_state) {
 801                  /* unset playlist */
 802                  region->set_playlist (boost::weak_ptr<Playlist>());
 803          }
 804
 805          /* XXX should probably freeze here .... */
 806
 807          for (i = regions.begin(); i != regions.end(); ++i) {
 808                  if (*i == region) {
 809
 810                          framepos_t pos = (*i)->position();
 811                          framecnt_t distance = (*i)->length();
 812
 813                          regions.erase (i);
 814
 815                          possibly_splice_unlocked (pos, -distance);
 816
 817                          if (!holding_state ()) {
 818                                  relayer ();
 819                                  remove_dependents (region);
 820                          }
 821
 822                          notify_region_removed (region);
 823                          break;
 824                  }
 825          }
 826
 827          return -1;
 828  }
 829
 830  void
 831  Playlist::get_equivalent_regions (boost::shared_ptr<Region> other, vector<boost::shared_ptr<Region> >& results)
 832  {
 833          if (Config->get_use_overlap_equivalency()) {
 834                  for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 835                          if ((*i)->overlap_equivalent (other)) {
 836                                  results.push_back (*i);
 837                          }
 838                  }
 839          } else {
 840                  for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 841                          if ((*i)->equivalent (other)) {
 842                                  results.push_back (*i);
 843                          }
 844                  }
 845          }
 846  }
 847
 848  void
 849  Playlist::get_region_list_equivalent_regions (boost::shared_ptr<Region> other, vector<boost::shared_ptr<Region> >& results)
 850  {
 851          for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 852
 853                  if ((*i) && (*i)->region_list_equivalent (other)) {
 854                          results.push_back (*i);
 855                  }
 856          }
 857  }
 858
 859  void
 860  Playlist::get_source_equivalent_regions (boost::shared_ptr<Region> other, vector<boost::shared_ptr<Region> >& results)
 861  {
 862          for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 863
 864                  if ((*i) && (*i)->any_source_equivalent (other)) {
 865                          results.push_back (*i);
 866                  }
 867          }
 868  }
 869
 870  void
 871  Playlist::partition (framepos_t start, framepos_t end, bool cut)
 872  {
 873          RegionList thawlist;
 874
 875          partition_internal (start, end, cut, thawlist);
 876
 877          for (RegionList::iterator i = thawlist.begin(); i != thawlist.end(); ++i) {
 878                  (*i)->resume_property_changes ();
 879          }
 880  }
 881
 882 /** Go through each region on the playlist and cut them at start and end, removing the section between
 883  *  start and end if cutting == true.  Regions that lie entirely within start and end are always
 884  *  removed.
 885  */
 886
 887  void
 888  Playlist::partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist)
 889  {
 890          RegionList new_regions;
 891
 892          {
 893                  RegionWriteLock rlock (this);
 894
 895                  boost::shared_ptr<Region> region;
 896                  boost::shared_ptr<Region> current;
 897                  string new_name;
 898                  RegionList::iterator tmp;
 899                  Evoral::OverlapType overlap;
 900                  framepos_t pos1, pos2, pos3, pos4;
 901
 902                  in_partition = true;
 903
 904                  /* need to work from a copy, because otherwise the regions we add during the process
 905                     get operated on as well.
 906                  */
 907
 908                  RegionList copy = regions.rlist();
 909
 910                  for (RegionList::iterator i = copy.begin(); i != copy.end(); i = tmp) {
 911
 912                          tmp = i;
 913                          ++tmp;
 914
 915                          current = *i;
 916
 917                          if (current->first_frame() >= start && current->last_frame() < end) {
 918
 919                                  if (cutting) {
 920                                          remove_region_internal (current);
 921                                  }
 922
 923                                  continue;
 924                          }
 925
 926                          /* coverage will return OverlapStart if the start coincides
 927                             with the end point. we do not partition such a region,
 928                             so catch this special case.
 929                          */
 930
 931                          if (current->first_frame() >= end) {
 932                                  continue;
 933                          }
 934
 935                          if ((overlap = current->coverage (start, end)) == Evoral::OverlapNone) {
 936                                  continue;
 937                          }
 938
 939                          pos1 = current->position();
 940                          pos2 = start;
 941                          pos3 = end;
 942                          pos4 = current->last_frame();
 943
 944                          if (overlap == Evoral::OverlapInternal) {
 945                                  /* split: we need 3 new regions, the front, middle and end.
 946                                     cut:   we need 2 regions, the front and end.
 947                                  */
 948
 949                                  /*
 950                                           start                 end
 951                            ---------------*************************------------
 952                                           P1  P2              P3  P4
 953                            SPLIT:
 954                            ---------------*****++++++++++++++++====------------
 955                            CUT
 956                            ---------------*****----------------====------------
 957
 958                                  */
 959
 960                                  if (!cutting) {
 961                                          /* "middle" ++++++ */
 962
 963                                          RegionFactory::region_name (new_name, current->name(), false);
 964
 965                                          PropertyList plist;
 966
 967                                          plist.add (Properties::start, current->start() + (pos2 - pos1));
 968                                          plist.add (Properties::length, pos3 - pos2);
 969                                          plist.add (Properties::name, new_name);
 970                                          plist.add (Properties::layer, current->layer ());
 971                                          plist.add (Properties::layering_index, current->layering_index ());
 972                                          plist.add (Properties::automatic, true);
 973                                          plist.add (Properties::left_of_split, true);
 974                                          plist.add (Properties::right_of_split, true);
 975
 976                                          region = RegionFactory::create (current, plist);
 977                                          add_region_internal (region, start);
 978                                          new_regions.push_back (region);
 979                                  }
 980
 981                                  /* "end" ====== */
 982
 983                                  RegionFactory::region_name (new_name, current->name(), false);
 984
 985                                  PropertyList plist;
 986
 987                                  plist.add (Properties::start, current->start() + (pos3 - pos1));
 988                                  plist.add (Properties::length, pos4 - pos3);
 989                                  plist.add (Properties::name, new_name);
 990                                  plist.add (Properties::layer, current->layer ());
 991                                  plist.add (Properties::layering_index, current->layering_index ());
 992                                  plist.add (Properties::automatic, true);
 993                                  plist.add (Properties::right_of_split, true);
 994
 995                                  region = RegionFactory::create (current, plist);
 996
 997                                  add_region_internal (region, end);
 998                                  new_regions.push_back (region);
 999
1000                                  /* "front" ***** */
1001
1002                                  current->suspend_property_changes ();
1003                                  thawlist.push_back (current);
1004                                  current->cut_end (pos2 - 1);
1005
1006                          } else if (overlap == Evoral::OverlapEnd) {
1007
1008                                  /*
1009                                                                start           end
1010                                      ---------------*************************------------
1011                                                     P1           P2         P4   P3
1012                                      SPLIT:
1013                                      ---------------**************+++++++++++------------
1014                                      CUT:
1015                                      ---------------**************-----------------------
1016                                  */
1017
1018                                  if (!cutting) {
1019
1020                                          /* end +++++ */
1021
1022                                          RegionFactory::region_name (new_name, current->name(), false);
1023
1024                                          PropertyList plist;
1025
1026                                          plist.add (Properties::start, current->start() + (pos2 - pos1));
1027                                          plist.add (Properties::length, pos4 - pos2);
1028                                          plist.add (Properties::name, new_name);
1029                                          plist.add (Properties::layer, current->layer ());
1030                                          plist.add (Properties::layering_index, current->layering_index ());
1031                                          plist.add (Properties::automatic, true);
1032                                          plist.add (Properties::left_of_split, true);
1033
1034                                          region = RegionFactory::create (current, plist);
1035
1036                                          add_region_internal (region, start);
1037                                          new_regions.push_back (region);
1038                                  }
1039
1040                                  /* front ****** */
1041
1042                                  current->suspend_property_changes ();
1043                                  thawlist.push_back (current);
1044                                  current->cut_end (pos2 - 1);
1045
1046                          } else if (overlap == Evoral::OverlapStart) {
1047
1048                                  /* split: we need 2 regions: the front and the end.
1049                                     cut: just trim current to skip the cut area
1050                                  */
1051
1052                                  /*
1053                                                          start           end
1054                                      ---------------*************************------------
1055                                         P2          P1 P3                   P4
1056
1057                                      SPLIT:
1058                                      ---------------****+++++++++++++++++++++------------
1059                                      CUT:
1060                                      -------------------*********************------------
1061
1062                                  */
1063
1064                                  if (!cutting) {
1065                                          /* front **** */
1066                                          RegionFactory::region_name (new_name, current->name(), false);
1067
1068                                          PropertyList plist;
1069
1070                                          plist.add (Properties::start, current->start());
1071                                          plist.add (Properties::length, pos3 - pos1);
1072                                          plist.add (Properties::name, new_name);
1073                                          plist.add (Properties::layer, current->layer ());
1074                                          plist.add (Properties::layering_index, current->layering_index ());
1075                                          plist.add (Properties::automatic, true);
1076                                          plist.add (Properties::right_of_split, true);
1077
1078                                          region = RegionFactory::create (current, plist);
1079
1080                                          add_region_internal (region, pos1);
1081                                          new_regions.push_back (region);
1082                                  }
1083
1084                                  /* end */
1085
1086                                  current->suspend_property_changes ();
1087                                  thawlist.push_back (current);
1088                                  current->trim_front (pos3);
1089                          } else if (overlap == Evoral::OverlapExternal) {
1090
1091                                  /* split: no split required.
1092                                     cut: remove the region.
1093                                  */
1094
1095                                  /*
1096                                         start                                      end
1097                                      ---------------*************************------------
1098                                         P2          P1 P3                   P4
1099
1100                                      SPLIT:
1101                                      ---------------*************************------------
1102                                      CUT:
1103                                      ----------------------------------------------------
1104
1105                                  */
1106
1107                                  if (cutting) {
1108                                          remove_region_internal (current);
1109                                  }
1110
1111                                  new_regions.push_back (current);
1112                          }
1113                  }
1114
1115                  in_partition = false;
1116          }
1117
1118         //keep track of any dead space at end (for pasting into Ripple or Splice mode)
1119         framepos_t wanted_length = end-start;
1120         _end_space = wanted_length - get_extent().second-get_extent().first;
1121  }
1122
1123  boost::shared_ptr<Playlist>
1124  Playlist::cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t,bool), list<AudioRange>& ranges, bool result_is_hidden)
1125  {
1126          boost::shared_ptr<Playlist> ret;
1127          boost::shared_ptr<Playlist> pl;
1128          framepos_t start;
1129
1130          if (ranges.empty()) {
1131                  return boost::shared_ptr<Playlist>();
1132          }
1133
1134          start = ranges.front().start;
1135
1136          for (list<AudioRange>::iterator i = ranges.begin(); i != ranges.end(); ++i) {
1137
1138                  pl = (this->*pmf)((*i).start, (*i).length(), result_is_hidden);
1139
1140                  if (i == ranges.begin()) {
1141                          ret = pl;
1142                  } else {
1143
1144                          /* paste the next section into the nascent playlist,
1145                             offset to reflect the start of the first range we
1146                             chopped.
1147                          */
1148
1149                          ret->paste (pl, (*i).start - start, 1.0f);
1150                  }
1151          }
1152
1153          return ret;
1154  }
1155
1156  boost::shared_ptr<Playlist>
1157  Playlist::cut (list<AudioRange>& ranges, bool result_is_hidden)
1158  {
1159          boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t,framecnt_t,bool) = &Playlist::cut;
1160          return cut_copy (pmf, ranges, result_is_hidden);
1161  }
1162
1163  boost::shared_ptr<Playlist>
1164  Playlist::copy (list<AudioRange>& ranges, bool result_is_hidden)
1165  {
1166          boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t,framecnt_t,bool) = &Playlist::copy;
1167          return cut_copy (pmf, ranges, result_is_hidden);
1168  }
1169
1170  boost::shared_ptr<Playlist>
1171  Playlist::cut (framepos_t start, framecnt_t cnt, bool result_is_hidden)
1172  {
1173          boost::shared_ptr<Playlist> the_copy;
1174          RegionList thawlist;
1175          char buf[32];
1176
1177          snprintf (buf, sizeof (buf), "%" PRIu32, ++subcnt);
1178          string new_name = _name;
1179          new_name += '.';
1180          new_name += buf;
1181
1182          if ((the_copy = PlaylistFactory::create (shared_from_this(), start, cnt, new_name, result_is_hidden)) == 0) {
1183                  return boost::shared_ptr<Playlist>();
1184          }
1185
1186          partition_internal (start, start+cnt-1, true, thawlist);
1187
1188          for (RegionList::iterator i = thawlist.begin(); i != thawlist.end(); ++i) {
1189                  (*i)->resume_property_changes();
1190          }
1191
1192          return the_copy;
1193  }
1194
1195  boost::shared_ptr<Playlist>
1196  Playlist::copy (framepos_t start, framecnt_t cnt, bool result_is_hidden)
1197  {
1198          char buf[32];
1199
1200          snprintf (buf, sizeof (buf), "%" PRIu32, ++subcnt);
1201          string new_name = _name;
1202          new_name += '.';
1203          new_name += buf;
1204
1205         // cnt = min (_get_extent().second - start, cnt);  (We need the full range length when copy/pasting in Ripple.  Why was this limit here?  It's not in CUT... )
1206
1207          return PlaylistFactory::create (shared_from_this(), start, cnt, new_name, result_is_hidden);
1208  }
1209
1210  int
1211  Playlist::paste (boost::shared_ptr<Playlist> other, framepos_t position, float times)
1212  {
1213          times = fabs (times);
1214
1215          {
1216                  RegionReadLock rl2 (other.get());
1217
1218                  int itimes = (int) floor (times);
1219                  framepos_t pos = position;
1220                  framecnt_t const shift = other->_get_extent().second;
1221                  layer_t top = top_layer ();
1222
1223                  {
1224                          RegionWriteLock rl1 (this);
1225                          while (itimes--) {
1226                                  for (RegionList::iterator i = other->regions.begin(); i != other->regions.end(); ++i) {
1227                                          boost::shared_ptr<Region> copy_of_region = RegionFactory::create (*i, true);
1228
1229                                          /* put these new regions on top of all existing ones, but preserve
1230                                             the ordering they had in the original playlist.
1231                                          */
1232
1233                                          add_region_internal (copy_of_region, (*i)->position() + pos);
1234                                          set_layer (copy_of_region, copy_of_region->layer() + top);
1235                                  }
1236                                  pos += shift;
1237                          }
1238                  }
1239          }
1240
1241          return 0;
1242  }
1243
1244
1245  void
1246  Playlist::duplicate (boost::shared_ptr<Region> region, framepos_t position, float times)
1247  {
1248          duplicate(region, position, region->length(), times);
1249  }
1250
1251 /** @param gap from the beginning of the region to the next beginning */
1252  void
1253  Playlist::duplicate (boost::shared_ptr<Region> region, framepos_t position, framecnt_t gap, float times)
1254  {
1255          times = fabs (times);
1256
1257          RegionWriteLock rl (this);
1258          int itimes = (int) floor (times);
1259
1260          while (itimes--) {
1261                  boost::shared_ptr<Region> copy = RegionFactory::create (region, true);
1262                  add_region_internal (copy, position);
1263                  set_layer (copy, DBL_MAX);
1264                  position += gap;
1265          }
1266
1267          if (floor (times) != times) {
1268                  framecnt_t length = (framecnt_t) floor (region->length() * (times - floor (times)));
1269                  string name;
1270                  RegionFactory::region_name (name, region->name(), false);
1271
1272                  {
1273                          PropertyList plist;
1274
1275                          plist.add (Properties::start, region->start());
1276                          plist.add (Properties::length, length);
1277                          plist.add (Properties::name, name);
1278
1279                          boost::shared_ptr<Region> sub = RegionFactory::create (region, plist);
1280                          add_region_internal (sub, position);
1281                          set_layer (sub, DBL_MAX);
1282                  }
1283          }
1284  }
1285
1286 /** @param gap from the beginning of the region to the next beginning */
1287 /** @param end the first frame that does _not_ contain a duplicated frame */
1288 void
1289 Playlist::duplicate_until (boost::shared_ptr<Region> region, framepos_t position, framecnt_t gap, framepos_t end)
1290 {
1291          RegionWriteLock rl (this);
1292
1293          while (position + region->length() - 1 < end) {
1294                  boost::shared_ptr<Region> copy = RegionFactory::create (region, true);
1295                  add_region_internal (copy, position);
1296                  set_layer (copy, DBL_MAX);
1297                  position += gap;
1298          }
1299
1300          if (position < end) {
1301                  framecnt_t length = min (region->length(), end - position);
1302                  string name;
1303                  RegionFactory::region_name (name, region->name(), false);
1304
1305                  {
1306                          PropertyList plist;
1307
1308                          plist.add (Properties::start, region->start());
1309                          plist.add (Properties::length, length);
1310                          plist.add (Properties::name, name);
1311
1312                          boost::shared_ptr<Region> sub = RegionFactory::create (region, plist);
1313                          add_region_internal (sub, position);
1314                          set_layer (sub, DBL_MAX);
1315                  }
1316          }
1317 }
1318
1319 void
1320 Playlist::duplicate_range (AudioRange& range, float times)
1321 {
1322         boost::shared_ptr<Playlist> pl = copy (range.start, range.length(), true);
1323         framecnt_t offset = range.end - range.start;
1324         paste (pl, range.start + offset, times);
1325 }
1326
1327 void
1328 Playlist::duplicate_ranges (std::list<AudioRange>& ranges, float /* times */)
1329 {
1330         if (ranges.empty()) {
1331                 return;
1332         }
1333
1334         framepos_t min_pos = max_framepos;
1335         framepos_t max_pos = 0;
1336
1337         for (std::list<AudioRange>::const_iterator i = ranges.begin();
1338              i != ranges.end();
1339              ++i) {
1340                 min_pos = min (min_pos, (*i).start);
1341                 max_pos = max (max_pos, (*i).end);
1342         }
1343
1344         framecnt_t offset = max_pos - min_pos;
1345
1346         for (list<AudioRange>::iterator i = ranges.begin(); i != ranges.end(); ++i) {
1347                 boost::shared_ptr<Playlist> pl = copy ((*i).start, (*i).length(), true);
1348                 paste (pl, (*i).start + offset, 1.0f); // times ??
1349         }
1350 }
1351
1352  void
1353  Playlist::shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue)
1354  {
1355          RegionWriteLock rlock (this);
1356          RegionList copy (regions.rlist());
1357          RegionList fixup;
1358
1359          for (RegionList::iterator r = copy.begin(); r != copy.end(); ++r) {
1360
1361                  if ((*r)->last_frame() < at) {
1362                          /* too early */
1363                          continue;
1364                  }
1365
1366                  if (at > (*r)->first_frame() && at < (*r)->last_frame()) {
1367                          /* intersected region */
1368                          if (!move_intersected) {
1369                                  continue;
1370                          }
1371                  }
1372
1373                  /* do not move regions glued to music time - that
1374                     has to be done separately.
1375                  */
1376
1377                  if (!ignore_music_glue && (*r)->position_lock_style() != AudioTime) {
1378                          fixup.push_back (*r);
1379                          continue;
1380                  }
1381
1382                  (*r)->set_position ((*r)->position() + distance);
1383          }
1384
1385          /* XXX: may not be necessary; Region::post_set should do this, I think */
1386          for (RegionList::iterator r = fixup.begin(); r != fixup.end(); ++r) {
1387                  (*r)->recompute_position_from_lock_style ();
1388          }
1389  }
1390
1391  void
1392  Playlist::split (framepos_t at)
1393  {
1394          RegionWriteLock rlock (this);
1395          RegionList copy (regions.rlist());
1396
1397          /* use a copy since this operation can modify the region list
1398           */
1399
1400          for (RegionList::iterator r = copy.begin(); r != copy.end(); ++r) {
1401                  _split_region (*r, at);
1402          }
1403  }
1404
1405  void
1406  Playlist::split_region (boost::shared_ptr<Region> region, framepos_t playlist_position)
1407  {
1408          RegionWriteLock rl (this);
1409          _split_region (region, playlist_position);
1410  }
1411
1412  void
1413  Playlist::_split_region (boost::shared_ptr<Region> region, framepos_t playlist_position)
1414  {
1415          if (!region->covers (playlist_position)) {
1416                  return;
1417          }
1418
1419          if (region->position() == playlist_position ||
1420              region->last_frame() == playlist_position) {
1421                  return;
1422          }
1423
1424          boost::shared_ptr<Region> left;
1425          boost::shared_ptr<Region> right;
1426          frameoffset_t before;
1427          frameoffset_t after;
1428          string before_name;
1429          string after_name;
1430
1431          /* split doesn't change anything about length, so don't try to splice */
1432
1433          bool old_sp = _splicing;
1434          _splicing = true;
1435
1436          before = playlist_position - region->position();
1437          after = region->length() - before;
1438
1439          RegionFactory::region_name (before_name, region->name(), false);
1440
1441          {
1442                  PropertyList plist;
1443
1444                  plist.add (Properties::length, before);
1445                  plist.add (Properties::name, before_name);
1446                  plist.add (Properties::left_of_split, true);
1447                  plist.add (Properties::layering_index, region->layering_index ());
1448                  plist.add (Properties::layer, region->layer ());
1449
1450                  /* note: we must use the version of ::create with an offset here,
1451                     since it supplies that offset to the Region constructor, which
1452                     is necessary to get audio region gain envelopes right.
1453                  */
1454                  left = RegionFactory::create (region, 0, plist);
1455          }
1456
1457          RegionFactory::region_name (after_name, region->name(), false);
1458
1459          {
1460                  PropertyList plist;
1461
1462                  plist.add (Properties::length, after);
1463                  plist.add (Properties::name, after_name);
1464                  plist.add (Properties::right_of_split, true);
1465                  plist.add (Properties::layering_index, region->layering_index ());
1466                  plist.add (Properties::layer, region->layer ());
1467
1468                  /* same note as above */
1469                  right = RegionFactory::create (region, before, plist);
1470          }
1471
1472          add_region_internal (left, region->position());
1473          add_region_internal (right, region->position() + before);
1474          remove_region_internal (region);
1475
1476          _splicing = old_sp;
1477  }
1478
1479  void
1480  Playlist::possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude)
1481  {
1482          if (_splicing || in_set_state) {
1483                  /* don't respond to splicing moves or state setting */
1484                  return;
1485          }
1486
1487          if (_edit_mode == Splice) {
1488                  splice_locked (at, distance, exclude);
1489          }
1490  }
1491
1492  void
1493  Playlist::possibly_splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude)
1494  {
1495          if (_splicing || in_set_state) {
1496                  /* don't respond to splicing moves or state setting */
1497                  return;
1498          }
1499
1500          if (_edit_mode == Splice) {
1501                  splice_unlocked (at, distance, exclude);
1502          }
1503  }
1504
1505  void
1506  Playlist::splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude)
1507  {
1508          {
1509                  RegionWriteLock rl (this);
1510                  core_splice (at, distance, exclude);
1511          }
1512  }
1513
1514  void
1515  Playlist::splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude)
1516  {
1517          core_splice (at, distance, exclude);
1518  }
1519
1520  void
1521  Playlist::core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude)
1522  {
1523          _splicing = true;
1524
1525          for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1526
1527                  if (exclude && (*i) == exclude) {
1528                          continue;
1529                  }
1530
1531                  if ((*i)->position() >= at) {
1532                          framepos_t new_pos = (*i)->position() + distance;
1533                          if (new_pos < 0) {
1534                                  new_pos = 0;
1535                          } else if (new_pos >= max_framepos - (*i)->length()) {
1536                                  new_pos = max_framepos - (*i)->length();
1537                          }
1538
1539                          (*i)->set_position (new_pos);
1540                  }
1541          }
1542
1543          _splicing = false;
1544
1545          notify_contents_changed ();
1546 }
1547
1548 void
1549 Playlist::ripple_locked (framepos_t at, framecnt_t distance, RegionList *exclude)
1550 {
1551         {
1552                 RegionWriteLock rl (this);
1553                 core_ripple (at, distance, exclude);
1554         }
1555 }
1556
1557 void
1558 Playlist::ripple_unlocked (framepos_t at, framecnt_t distance, RegionList *exclude)
1559 {
1560         core_ripple (at, distance, exclude);
1561 }
1562
1563 void
1564 Playlist::core_ripple (framepos_t at, framecnt_t distance, RegionList *exclude)
1565 {
1566         if (distance == 0) {
1567                 return;
1568         }
1569
1570         _rippling = true;
1571         RegionListProperty copy = regions;
1572         for (RegionList::iterator i = copy.begin(); i != copy.end(); ++i) {
1573                 assert (i != copy.end());
1574
1575                 if (exclude) {
1576                         if (std::find(exclude->begin(), exclude->end(), (*i)) != exclude->end()) {
1577                                 continue;
1578                         }
1579                 }
1580
1581                 if ((*i)->position() >= at) {
1582                         framepos_t new_pos = (*i)->position() + distance;
1583                         framepos_t limit = max_framepos - (*i)->length();
1584                         if (new_pos < 0) {
1585                                 new_pos = 0;
1586                         } else if (new_pos >= limit ) {
1587                                 new_pos = limit;
1588                         }
1589
1590                         (*i)->set_position (new_pos);
1591                 }
1592         }
1593
1594         _rippling = false;
1595         notify_contents_changed ();
1596 }
1597
1598
1599 void
1600 Playlist::region_bounds_changed (const PropertyChange& what_changed, boost::shared_ptr<Region> region)
1601 {
1602          if (in_set_state || _splicing || _rippling || _nudging || _shuffling) {
1603                  return;
1604          }
1605
1606          if (what_changed.contains (Properties::position)) {
1607
1608                  /* remove it from the list then add it back in
1609                     the right place again.
1610                  */
1611
1612                  RegionSortByPosition cmp;
1613
1614                  RegionList::iterator i = find (regions.begin(), regions.end(), region);
1615
1616                  if (i == regions.end()) {
1617                          /* the region bounds are being modified but its not currently
1618                             in the region list. we will use its bounds correctly when/if
1619                             it is added
1620                          */
1621                          return;
1622                  }
1623
1624                  regions.erase (i);
1625                  regions.insert (upper_bound (regions.begin(), regions.end(), region, cmp), region);
1626          }
1627
1628          if (what_changed.contains (Properties::position) || what_changed.contains (Properties::length)) {
1629
1630                  frameoffset_t delta = 0;
1631
1632                  if (what_changed.contains (Properties::position)) {
1633                          delta = region->position() - region->last_position();
1634                  }
1635
1636                  if (what_changed.contains (Properties::length)) {
1637                          delta += region->length() - region->last_length();
1638                  }
1639
1640                  if (delta) {
1641                          possibly_splice (region->last_position() + region->last_length(), delta, region);
1642                  }
1643
1644                  if (holding_state ()) {
1645                          pending_bounds.push_back (region);
1646                  } else {
1647                          notify_contents_changed ();
1648                          relayer ();
1649                          list<Evoral::Range<framepos_t> > xf;
1650                          xf.push_back (Evoral::Range<framepos_t> (region->last_range()));
1651                          xf.push_back (Evoral::Range<framepos_t> (region->range()));
1652                          coalesce_and_check_crossfades (xf);
1653                  }
1654          }
1655  }
1656
1657  void
1658  Playlist::region_changed_proxy (const PropertyChange& what_changed, boost::weak_ptr<Region> weak_region)
1659  {
1660          boost::shared_ptr<Region> region (weak_region.lock());
1661
1662          if (!region) {
1663                  return;
1664          }
1665
1666          /* this makes a virtual call to the right kind of playlist ... */
1667
1668          region_changed (what_changed, region);
1669  }
1670
1671  bool
1672  Playlist::region_changed (const PropertyChange& what_changed, boost::shared_ptr<Region> region)
1673  {
1674          PropertyChange our_interests;
1675          PropertyChange bounds;
1676          PropertyChange pos_and_length;
1677          bool save = false;
1678
1679          if (in_set_state || in_flush) {
1680                  return false;
1681          }
1682
1683          our_interests.add (Properties::muted);
1684          our_interests.add (Properties::layer);
1685          our_interests.add (Properties::opaque);
1686
1687          bounds.add (Properties::start);
1688          bounds.add (Properties::position);
1689          bounds.add (Properties::length);
1690
1691          pos_and_length.add (Properties::position);
1692          pos_and_length.add (Properties::length);
1693
1694          if (what_changed.contains (bounds)) {
1695                  region_bounds_changed (what_changed, region);
1696                  save = !(_splicing || _nudging);
1697          }
1698
1699          if (what_changed.contains (Properties::position) && !what_changed.contains (Properties::length)) {
1700                  notify_region_moved (region);
1701          } else if (!what_changed.contains (Properties::position) && what_changed.contains (Properties::length)) {
1702                  notify_region_end_trimmed (region);
1703          } else if (what_changed.contains (Properties::position) && what_changed.contains (Properties::length)) {
1704                  notify_region_start_trimmed (region);
1705          }
1706
1707          /* don't notify about layer changes, since we are the only object that can initiate
1708             them, and we notify in ::relayer()
1709          */
1710
1711          if (what_changed.contains (our_interests)) {
1712                  save = true;
1713          }
1714
1715          mark_session_dirty ();
1716
1717          return save;
1718  }
1719
1720  void
1721  Playlist::drop_regions ()
1722  {
1723          RegionWriteLock rl (this);
1724          regions.clear ();
1725          all_regions.clear ();
1726  }
1727
1728  void
1729  Playlist::sync_all_regions_with_regions ()
1730  {
1731          RegionWriteLock rl (this);
1732
1733          all_regions.clear ();
1734
1735          for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1736                  all_regions.insert (*i);
1737          }
1738  }
1739
1740  void
1741  Playlist::clear (bool with_signals)
1742  {
1743          {
1744                  RegionWriteLock rl (this);
1745
1746                  region_state_changed_connections.drop_connections ();
1747
1748                  for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1749                          pending_removes.insert (*i);
1750                  }
1751
1752                  regions.clear ();
1753
1754                  for (set<boost::shared_ptr<Region> >::iterator s = pending_removes.begin(); s != pending_removes.end(); ++s) {
1755                          remove_dependents (*s);
1756                  }
1757          }
1758
1759          if (with_signals) {
1760
1761                  for (set<boost::shared_ptr<Region> >::iterator s = pending_removes.begin(); s != pending_removes.end(); ++s) {
1762                          RegionRemoved (boost::weak_ptr<Region> (*s)); /* EMIT SIGNAL */
1763                  }
1764
1765                  pending_removes.clear ();
1766                  pending_contents_change = false;
1767                  ContentsChanged ();
1768          }
1769
1770  }
1771
1772  /* *********************************************************************
1773   FINDING THINGS
1774   **********************************************************************/
1775
1776 boost::shared_ptr<RegionList>
1777 Playlist::regions_at (framepos_t frame)
1778 {
1779         RegionReadLock rlock (this);
1780         return find_regions_at (frame);
1781 }
1782
1783  uint32_t
1784  Playlist::count_regions_at (framepos_t frame) const
1785  {
1786          RegionReadLock rlock (const_cast<Playlist*>(this));
1787          uint32_t cnt = 0;
1788
1789          for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
1790                  if ((*i)->covers (frame)) {
1791                          cnt++;
1792                  }
1793          }
1794
1795          return cnt;
1796  }
1797
1798  boost::shared_ptr<Region>
1799  Playlist::top_region_at (framepos_t frame)
1800
1801  {
1802          RegionReadLock rlock (this);
1803          boost::shared_ptr<RegionList> rlist = find_regions_at (frame);
1804          boost::shared_ptr<Region> region;
1805
1806          if (rlist->size()) {
1807                  RegionSortByLayer cmp;
1808                  rlist->sort (cmp);
1809                  region = rlist->back();
1810          }
1811
1812          return region;
1813  }
1814
1815  boost::shared_ptr<Region>
1816  Playlist::top_unmuted_region_at (framepos_t frame)
1817
1818  {
1819          RegionReadLock rlock (this);
1820          boost::shared_ptr<RegionList> rlist = find_regions_at (frame);
1821
1822          for (RegionList::iterator i = rlist->begin(); i != rlist->end(); ) {
1823
1824                  RegionList::iterator tmp = i;
1825
1826                  ++tmp;
1827
1828                  if ((*i)->muted()) {
1829                          rlist->erase (i);
1830                  }
1831
1832                  i = tmp;
1833          }
1834
1835          boost::shared_ptr<Region> region;
1836
1837          if (rlist->size()) {
1838                  RegionSortByLayer cmp;
1839                  rlist->sort (cmp);
1840                  region = rlist->back();
1841          }
1842
1843          return region;
1844  }
1845
1846 boost::shared_ptr<RegionList>
1847 Playlist::find_regions_at (framepos_t frame)
1848 {
1849         /* Caller must hold lock */
1850
1851         boost::shared_ptr<RegionList> rlist (new RegionList);
1852
1853         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1854                 if ((*i)->covers (frame)) {
1855                         rlist->push_back (*i);
1856                 }
1857         }
1858
1859         return rlist;
1860 }
1861
1862 boost::shared_ptr<RegionList>
1863 Playlist::regions_with_start_within (Evoral::Range<framepos_t> range)
1864 {
1865         RegionReadLock rlock (this);
1866         boost::shared_ptr<RegionList> rlist (new RegionList);
1867
1868         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1869                 if ((*i)->first_frame() >= range.from && (*i)->first_frame() <= range.to) {
1870                         rlist->push_back (*i);
1871                 }
1872         }
1873
1874         return rlist;
1875 }
1876
1877 boost::shared_ptr<RegionList>
1878 Playlist::regions_with_end_within (Evoral::Range<framepos_t> range)
1879 {
1880         RegionReadLock rlock (this);
1881         boost::shared_ptr<RegionList> rlist (new RegionList);
1882
1883         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1884                 if ((*i)->last_frame() >= range.from && (*i)->last_frame() <= range.to) {
1885                         rlist->push_back (*i);
1886                 }
1887         }
1888
1889         return rlist;
1890 }
1891
1892 /** @param start Range start.
1893  *  @param end Range end.
1894  *  @return regions which have some part within this range.
1895  */
1896 boost::shared_ptr<RegionList>
1897 Playlist::regions_touched (framepos_t start, framepos_t end)
1898 {
1899         RegionReadLock rlock (this);
1900         return regions_touched_locked (start, end);
1901 }
1902
1903 boost::shared_ptr<RegionList>
1904 Playlist::regions_touched_locked (framepos_t start, framepos_t end)
1905 {
1906         boost::shared_ptr<RegionList> rlist (new RegionList);
1907
1908         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1909                 if ((*i)->coverage (start, end) != Evoral::OverlapNone) {
1910                         rlist->push_back (*i);
1911                 }
1912         }
1913
1914         return rlist;
1915 }
1916
1917 framepos_t
1918 Playlist::find_next_transient (framepos_t from, int dir)
1919 {
1920         RegionReadLock rlock (this);
1921         AnalysisFeatureList points;
1922         AnalysisFeatureList these_points;
1923
1924         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1925                 if (dir > 0) {
1926                         if ((*i)->last_frame() < from) {
1927                                 continue;
1928                         }
1929                 } else {
1930                         if ((*i)->first_frame() > from) {
1931                                 continue;
1932                         }
1933                 }
1934
1935                 (*i)->get_transients (these_points);
1936
1937                 /* add first frame, just, err, because */
1938
1939                 these_points.push_back ((*i)->first_frame());
1940
1941                 points.insert (points.end(), these_points.begin(), these_points.end());
1942                 these_points.clear ();
1943         }
1944
1945         if (points.empty()) {
1946                 return -1;
1947         }
1948
1949         TransientDetector::cleanup_transients (points, _session.frame_rate(), 3.0);
1950         bool reached = false;
1951
1952         if (dir > 0) {
1953                 for (AnalysisFeatureList::const_iterator x = points.begin(); x != points.end(); ++x) {
1954                         if ((*x) >= from) {
1955                                 reached = true;
1956                         }
1957
1958                         if (reached && (*x) > from) {
1959                                 return *x;
1960                         }
1961                 }
1962         } else {
1963                 for (AnalysisFeatureList::reverse_iterator x = points.rbegin(); x != points.rend(); ++x) {
1964                         if ((*x) <= from) {
1965                                 reached = true;
1966                         }
1967
1968                         if (reached && (*x) < from) {
1969                                 return *x;
1970                         }
1971                 }
1972         }
1973
1974         return -1;
1975 }
1976
1977 boost::shared_ptr<Region>
1978 Playlist::find_next_region (framepos_t frame, RegionPoint point, int dir)
1979 {
1980         RegionReadLock rlock (this);
1981         boost::shared_ptr<Region> ret;
1982         framepos_t closest = max_framepos;
1983
1984         bool end_iter = false;
1985
1986         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
1987
1988                 if(end_iter) break;
1989
1990                 frameoffset_t distance;
1991                 boost::shared_ptr<Region> r = (*i);
1992                 framepos_t pos = 0;
1993
1994                 switch (point) {
1995                 case Start:
1996                         pos = r->first_frame ();
1997                         break;
1998                 case End:
1999                         pos = r->last_frame ();
2000                         break;
2001                 case SyncPoint:
2002                         pos = r->sync_position ();
2003                         break;
2004                 }
2005
2006                 switch (dir) {
2007                 case 1: /* forwards */
2008
2009                         if (pos > frame) {
2010                                 if ((distance = pos - frame) < closest) {
2011                                         closest = distance;
2012                                         ret = r;
2013                                         end_iter = true;
2014                                 }
2015                         }
2016
2017                         break;
2018
2019                 default: /* backwards */
2020
2021                         if (pos < frame) {
2022                                 if ((distance = frame - pos) < closest) {
2023                                         closest = distance;
2024                                         ret = r;
2025                                 }
2026                         } else {
2027                                 end_iter = true;
2028                         }
2029
2030                         break;
2031                 }
2032         }
2033
2034         return ret;
2035 }
2036
2037  framepos_t
2038  Playlist::find_next_region_boundary (framepos_t frame, int dir)
2039  {
2040          RegionReadLock rlock (this);
2041
2042          framepos_t closest = max_framepos;
2043          framepos_t ret = -1;
2044
2045          if (dir > 0) {
2046
2047                  for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
2048
2049                          boost::shared_ptr<Region> r = (*i);
2050                          frameoffset_t distance;
2051                          const framepos_t first_frame = r->first_frame();
2052                          const framepos_t last_frame = r->last_frame();
2053
2054                          if (first_frame > frame) {
2055
2056                                  distance = first_frame - frame;
2057
2058                                  if (distance < closest) {
2059                                          ret = first_frame;
2060                                          closest = distance;
2061                                  }
2062                          }
2063
2064                          if (last_frame > frame) {
2065
2066                                  distance = last_frame - frame;
2067
2068                                  if (distance < closest) {
2069                                          ret = last_frame;
2070                                          closest = distance;
2071                                  }
2072                          }
2073                  }
2074
2075          } else {
2076
2077                  for (RegionList::reverse_iterator i = regions.rbegin(); i != regions.rend(); ++i) {
2078
2079                          boost::shared_ptr<Region> r = (*i);
2080                          frameoffset_t distance;
2081                          const framepos_t first_frame = r->first_frame();
2082                          const framepos_t last_frame = r->last_frame();
2083
2084                          if (last_frame < frame) {
2085
2086                                  distance = frame - last_frame;
2087
2088                                  if (distance < closest) {
2089                                          ret = last_frame;
2090                                          closest = distance;
2091                                  }
2092                          }
2093
2094                          if (first_frame < frame) {
2095
2096                                  distance = frame - first_frame;
2097
2098                                  if (distance < closest) {
2099                                          ret = first_frame;
2100                                          closest = distance;
2101                                  }
2102                          }
2103                  }
2104          }
2105
2106          return ret;
2107  }
2108
2109
2110  /***********************************************************************/
2111
2112
2113
2114
2115  void
2116  Playlist::mark_session_dirty ()
2117  {
2118          if (!in_set_state && !holding_state ()) {
2119                  _session.set_dirty();
2120          }
2121  }
2122
2123  void
2124  Playlist::rdiff (vector<Command*>& cmds) const
2125  {
2126          RegionReadLock rlock (const_cast<Playlist *> (this));
2127          Stateful::rdiff (cmds);
2128  }
2129
2130  void
2131  Playlist::clear_owned_changes ()
2132  {
2133          RegionReadLock rlock (this);
2134          Stateful::clear_owned_changes ();
2135  }
2136
2137  void
2138  Playlist::update (const RegionListProperty::ChangeRecord& change)
2139  {
2140          DEBUG_TRACE (DEBUG::Properties, string_compose ("Playlist %1 updates from a change record with %2 adds %3 removes\n",
2141                                                          name(), change.added.size(), change.removed.size()));
2142
2143          freeze ();
2144          /* add the added regions */
2145          for (RegionListProperty::ChangeContainer::const_iterator i = change.added.begin(); i != change.added.end(); ++i) {
2146                  add_region_internal ((*i), (*i)->position());
2147          }
2148          /* remove the removed regions */
2149          for (RegionListProperty::ChangeContainer::const_iterator i = change.removed.begin(); i != change.removed.end(); ++i) {
2150                  remove_region (*i);
2151          }
2152
2153          thaw ();
2154  }
2155
2156  int
2157  Playlist::set_state (const XMLNode& node, int version)
2158  {
2159          XMLNode *child;
2160          XMLNodeList nlist;
2161          XMLNodeConstIterator niter;
2162          XMLPropertyList plist;
2163          XMLPropertyConstIterator piter;
2164          XMLProperty const * prop;
2165          boost::shared_ptr<Region> region;
2166          string region_name;
2167          bool seen_region_nodes = false;
2168          int ret = 0;
2169
2170          in_set_state++;
2171
2172          if (node.name() != "Playlist") {
2173                  in_set_state--;
2174                  return -1;
2175          }
2176
2177          freeze ();
2178
2179          plist = node.properties();
2180
2181          set_id (node);
2182
2183          for (piter = plist.begin(); piter != plist.end(); ++piter) {
2184
2185                  prop = *piter;
2186
2187                  if (prop->name() == X_("name")) {
2188                          _name = prop->value();
2189                          _set_sort_id ();
2190                  } else if (prop->name() == X_("orig-diskstream-id")) {
2191                          /* XXX legacy session: fix up later */
2192                          _orig_track_id = prop->value ();
2193                  } else if (prop->name() == X_("orig-track-id")) {
2194                          _orig_track_id = prop->value ();
2195                  } else if (prop->name() == X_("frozen")) {
2196                          _frozen = string_is_affirmative (prop->value());
2197                  } else if (prop->name() == X_("combine-ops")) {
2198                          _combine_ops = atoi (prop->value());
2199                  }
2200          }
2201
2202          clear (true);
2203
2204          nlist = node.children();
2205
2206          for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2207
2208                  child = *niter;
2209
2210                  if (child->name() == "Region") {
2211
2212                          seen_region_nodes = true;
2213
2214                          if ((prop = child->property ("id")) == 0) {
2215                                  error << _("region state node has no ID, ignored") << endmsg;
2216                                  continue;
2217                          }
2218
2219                          ID id = prop->value ();
2220
2221                          if ((region = region_by_id (id))) {
2222
2223                                  region->suspend_property_changes ();
2224
2225                                  if (region->set_state (*child, version)) {
2226                                          region->resume_property_changes ();
2227                                          continue;
2228                                  }
2229
2230                          } else if ((region = RegionFactory::create (_session, *child, true)) != 0) {
2231                                  region->suspend_property_changes ();
2232                          } else {
2233                                  error << _("Playlist: cannot create region from XML") << endmsg;
2234                                 return -1;
2235                         }
2236
2237                          {
2238                                  RegionWriteLock rlock (this);
2239                                  add_region_internal (region, region->position());
2240                          }
2241
2242                         region->resume_property_changes ();
2243
2244                 }
2245         }
2246
2247         if (seen_region_nodes && regions.empty()) {
2248                 ret = -1;
2249         }
2250
2251         thaw ();
2252         notify_contents_changed ();
2253
2254         in_set_state--;
2255         first_set_state = false;
2256
2257         return ret;
2258 }
2259
2260 XMLNode&
2261 Playlist::get_state()
2262 {
2263         return state (true);
2264 }
2265
2266 XMLNode&
2267 Playlist::get_template()
2268 {
2269         return state (false);
2270 }
2271
2272 /** @param full_state true to include regions in the returned state, otherwise false.
2273  */
2274 XMLNode&
2275 Playlist::state (bool full_state)
2276 {
2277         XMLNode *node = new XMLNode (X_("Playlist"));
2278         char buf[64];
2279
2280         node->add_property (X_("id"), id().to_s());
2281         node->add_property (X_("name"), _name);
2282         node->add_property (X_("type"), _type.to_string());
2283
2284         _orig_track_id.print (buf, sizeof (buf));
2285         node->add_property (X_("orig-track-id"), buf);
2286         node->add_property (X_("frozen"), _frozen ? "yes" : "no");
2287
2288         if (full_state) {
2289                 RegionReadLock rlock (this);
2290
2291                 snprintf (buf, sizeof (buf), "%u", _combine_ops);
2292                 node->add_property ("combine-ops", buf);
2293
2294                 for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
2295                         node->add_child_nocopy ((*i)->get_state());
2296                 }
2297         }
2298
2299         if (_extra_xml) {
2300                 node->add_child_copy (*_extra_xml);
2301         }
2302
2303         return *node;
2304 }
2305
2306 bool
2307 Playlist::empty() const
2308 {
2309         RegionReadLock rlock (const_cast<Playlist *>(this));
2310         return regions.empty();
2311 }
2312
2313 uint32_t
2314 Playlist::n_regions() const
2315 {
2316         RegionReadLock rlock (const_cast<Playlist *>(this));
2317         return regions.size();
2318 }
2319
2320 /** @return true if the all_regions list is empty, ie this playlist
2321  *  has never had a region added to it.
2322  */
2323 bool
2324 Playlist::all_regions_empty() const
2325 {
2326         RegionReadLock rl (const_cast<Playlist *> (this));
2327         return all_regions.empty();
2328 }
2329
2330 pair<framepos_t, framepos_t>
2331 Playlist::get_extent () const
2332 {
2333         RegionReadLock rlock (const_cast<Playlist *>(this));
2334         return _get_extent ();
2335 }
2336
2337 pair<framepos_t, framepos_t>
2338 Playlist::get_extent_with_endspace () const
2339 {
2340         pair<framepos_t, framepos_t> l = get_extent();
2341         l.second += _end_space;
2342         return l;
2343 }
2344
2345 pair<framepos_t, framepos_t>
2346 Playlist::_get_extent () const
2347 {
2348         pair<framepos_t, framepos_t> ext (max_framepos, 0);
2349
2350         if (regions.empty()) {
2351                 ext.first = 0;
2352                 return ext;
2353         }
2354
2355         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2356                 pair<framepos_t, framepos_t> const e ((*i)->position(), (*i)->position() + (*i)->length());
2357                 if (e.first < ext.first) {
2358                         ext.first = e.first;
2359                 }
2360                 if (e.second > ext.second) {
2361                         ext.second = e.second;
2362                 }
2363         }
2364
2365         return ext;
2366 }
2367
2368 string
2369 Playlist::bump_name (string name, Session &session)
2370 {
2371         string newname = name;
2372
2373         do {
2374                 newname = bump_name_once (newname, '.');
2375         } while (session.playlists->by_name (newname)!=NULL);
2376
2377         return newname;
2378 }
2379
2380
2381 layer_t
2382 Playlist::top_layer() const
2383 {
2384         RegionReadLock rlock (const_cast<Playlist *> (this));
2385         layer_t top = 0;
2386
2387         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2388                 top = max (top, (*i)->layer());
2389         }
2390         return top;
2391 }
2392
2393 void
2394 Playlist::set_edit_mode (EditMode mode)
2395 {
2396         _edit_mode = mode;
2397 }
2398
2399 struct RelayerSort {
2400         bool operator () (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) {
2401                 return a->layering_index() < b->layering_index();
2402         }
2403 };
2404
2405 /** Set a new layer for a region.  This adjusts the layering indices of all
2406  *  regions in the playlist to put the specified region in the appropriate
2407  *  place.  The actual layering will be fixed up when relayer() happens.
2408  */
2409
2410 void
2411 Playlist::set_layer (boost::shared_ptr<Region> region, double new_layer)
2412 {
2413         /* Remove the layer we are setting from our region list, and sort it
2414         *  using the layer indeces.
2415         */
2416
2417         RegionList copy = regions.rlist();
2418         copy.remove (region);
2419         copy.sort (RelayerSort ());
2420
2421         /* Put region back in the right place */
2422         RegionList::iterator i = copy.begin();
2423         while (i != copy.end ()) {
2424                 if ((*i)->layer() > new_layer) {
2425                         break;
2426                 }
2427                 ++i;
2428         }
2429
2430         copy.insert (i, region);
2431
2432         setup_layering_indices (copy);
2433 }
2434
2435 void
2436 Playlist::setup_layering_indices (RegionList const & regions)
2437 {
2438         uint64_t j = 0;
2439
2440         for (RegionList::const_iterator k = regions.begin(); k != regions.end(); ++k) {
2441                 (*k)->set_layering_index (j++);
2442         }
2443 }
2444
2445 struct LaterHigherSort {
2446         bool operator () (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) {
2447                 return a->position() < b->position();
2448         }
2449 };
2450
2451 /** Take the layering indices of each of our regions, compute the layers
2452  *  that they should be on, and write the layers back to the regions.
2453  */
2454 void
2455 Playlist::relayer ()
2456 {
2457         /* never compute layers when setting from XML */
2458
2459         if (in_set_state) {
2460                 return;
2461         }
2462
2463         /* Build up a new list of regions on each layer, stored in a set of lists
2464            each of which represent some period of time on some layer.  The idea
2465            is to avoid having to search the entire region list to establish whether
2466            each region overlaps another */
2467
2468         /* how many pieces to divide this playlist's time up into */
2469         int const divisions = 512;
2470
2471         /* find the start and end positions of the regions on this playlist */
2472         framepos_t start = INT64_MAX;
2473         framepos_t end = 0;
2474         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2475                 start = min (start, (*i)->position());
2476                 end = max (end, (*i)->position() + (*i)->length());
2477         }
2478
2479         /* hence the size of each time division */
2480         double const division_size = (end - start) / double (divisions);
2481
2482         vector<vector<RegionList> > layers;
2483         layers.push_back (vector<RegionList> (divisions));
2484
2485         /* Sort our regions into layering index order (for manual layering) or position order (for later is higher)*/
2486         RegionList copy = regions.rlist();
2487         switch (Config->get_layer_model()) {
2488                 case LaterHigher:
2489                         copy.sort (LaterHigherSort ());
2490                         break;
2491                 case Manual:
2492                         copy.sort (RelayerSort ());
2493                         break;
2494         }
2495
2496         DEBUG_TRACE (DEBUG::Layering, "relayer() using:\n");
2497         for (RegionList::iterator i = copy.begin(); i != copy.end(); ++i) {
2498                 DEBUG_TRACE (DEBUG::Layering, string_compose ("\t%1 %2\n", (*i)->name(), (*i)->layering_index()));
2499         }
2500
2501         for (RegionList::iterator i = copy.begin(); i != copy.end(); ++i) {
2502
2503                 /* find the time divisions that this region covers; if there are no regions on the list,
2504                    division_size will equal 0 and in this case we'll just say that
2505                    start_division = end_division = 0.
2506                 */
2507                 int start_division = 0;
2508                 int end_division = 0;
2509
2510                 if (division_size > 0) {
2511                         start_division = floor ( ((*i)->position() - start) / division_size);
2512                         end_division = floor ( ((*i)->position() + (*i)->length() - start) / division_size );
2513                         if (end_division == divisions) {
2514                                 end_division--;
2515                         }
2516                 }
2517
2518                 assert (divisions == 0 || end_division < divisions);
2519
2520                 /* find the lowest layer that this region can go on */
2521                 size_t j = layers.size();
2522                 while (j > 0) {
2523                         /* try layer j - 1; it can go on if it overlaps no other region
2524                            that is already on that layer
2525                         */
2526
2527                         bool overlap = false;
2528                         for (int k = start_division; k <= end_division; ++k) {
2529                                 RegionList::iterator l = layers[j-1][k].begin ();
2530                                 while (l != layers[j-1][k].end()) {
2531                                         if ((*l)->overlap_equivalent (*i)) {
2532                                                 overlap = true;
2533                                                 break;
2534                                         }
2535                                         l++;
2536                                 }
2537
2538                                 if (overlap) {
2539                                         break;
2540                                 }
2541                         }
2542
2543                         if (overlap) {
2544                                 /* overlap, so we must use layer j */
2545                                 break;
2546                         }
2547
2548                         --j;
2549                 }
2550
2551                 if (j == layers.size()) {
2552                         /* we need a new layer for this region */
2553                         layers.push_back (vector<RegionList> (divisions));
2554                 }
2555
2556                 /* put a reference to this region in each of the divisions that it exists in */
2557                 for (int k = start_division; k <= end_division; ++k) {
2558                         layers[j][k].push_back (*i);
2559                 }
2560
2561                 (*i)->set_layer (j);
2562         }
2563
2564         /* It's a little tricky to know when we could avoid calling this; e.g. if we are
2565            relayering because we just removed the only region on the top layer, nothing will
2566            appear to have changed, but the StreamView must still sort itself out.  We could
2567            probably keep a note of the top layer last time we relayered, and check that,
2568            but premature optimisation &c...
2569         */
2570         notify_layering_changed ();
2571
2572         /* This relayer() may have been called as a result of a region removal, in which
2573            case we need to setup layering indices to account for the one that has just
2574            gone away.
2575         */
2576         setup_layering_indices (copy);
2577 }
2578
2579 void
2580 Playlist::raise_region (boost::shared_ptr<Region> region)
2581 {
2582         set_layer (region, region->layer() + 1.5);
2583         relayer ();
2584 }
2585
2586 void
2587 Playlist::lower_region (boost::shared_ptr<Region> region)
2588 {
2589         set_layer (region, region->layer() - 1.5);
2590         relayer ();
2591 }
2592
2593 void
2594 Playlist::raise_region_to_top (boost::shared_ptr<Region> region)
2595 {
2596         set_layer (region, DBL_MAX);
2597         relayer ();
2598 }
2599
2600 void
2601 Playlist::lower_region_to_bottom (boost::shared_ptr<Region> region)
2602 {
2603         set_layer (region, -0.5);
2604         relayer ();
2605 }
2606
2607 void
2608 Playlist::nudge_after (framepos_t start, framecnt_t distance, bool forwards)
2609 {
2610         RegionList::iterator i;
2611         bool moved = false;
2612
2613         _nudging = true;
2614
2615         {
2616                 RegionWriteLock rlock (const_cast<Playlist *> (this));
2617
2618                 for (i = regions.begin(); i != regions.end(); ++i) {
2619
2620                         if ((*i)->position() >= start) {
2621
2622                                 framepos_t new_pos;
2623
2624                                 if (forwards) {
2625
2626                                         if ((*i)->last_frame() > max_framepos - distance) {
2627                                                 new_pos = max_framepos - (*i)->length();
2628                                         } else {
2629                                                 new_pos = (*i)->position() + distance;
2630                                         }
2631
2632                                 } else {
2633
2634                                         if ((*i)->position() > distance) {
2635                                                 new_pos = (*i)->position() - distance;
2636                                         } else {
2637                                                 new_pos = 0;
2638                                         }
2639                                 }
2640
2641                                 (*i)->set_position (new_pos);
2642                                 moved = true;
2643                         }
2644                 }
2645         }
2646
2647         if (moved) {
2648                 _nudging = false;
2649                 notify_contents_changed ();
2650         }
2651
2652 }
2653
2654 bool
2655 Playlist::uses_source (boost::shared_ptr<const Source> src) const
2656 {
2657         RegionReadLock rlock (const_cast<Playlist*> (this));
2658
2659         for (set<boost::shared_ptr<Region> >::const_iterator r = all_regions.begin(); r != all_regions.end(); ++r) {
2660                 if ((*r)->uses_source (src)) {
2661                         return true;
2662                 }
2663         }
2664
2665         return false;
2666 }
2667
2668 boost::shared_ptr<Region>
2669 Playlist::find_region (const ID& id) const
2670 {
2671         RegionReadLock rlock (const_cast<Playlist*> (this));
2672
2673         /* searches all regions currently in use by the playlist */
2674
2675         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2676                 if ((*i)->id() == id) {
2677                         return *i;
2678                 }
2679         }
2680
2681         return boost::shared_ptr<Region> ();
2682 }
2683
2684 uint32_t
2685 Playlist::region_use_count (boost::shared_ptr<Region> r) const
2686 {
2687         RegionReadLock rlock (const_cast<Playlist*> (this));
2688         uint32_t cnt = 0;
2689
2690         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2691                 if ((*i) == r) {
2692                         cnt++;
2693                 }
2694         }
2695
2696         RegionFactory::CompoundAssociations& cassocs (RegionFactory::compound_associations());
2697         for (RegionFactory::CompoundAssociations::iterator it = cassocs.begin(); it != cassocs.end(); ++it) {
2698                 /* check if region is used in a compound */
2699                 if (it->second == r) {
2700                         /* region is referenced as 'original' of a compound */
2701                         ++cnt;
2702                         break;
2703                 }
2704                 if (r->whole_file() && r->max_source_level() > 0) {
2705                         /* region itself ia a compound.
2706                          * the compound regions are not referenced -> check regions inside compound
2707                          */
2708                         const SourceList& sl = r->sources();
2709                         for (SourceList::const_iterator s = sl.begin(); s != sl.end(); ++s) {
2710                                 boost::shared_ptr<PlaylistSource> ps = boost::dynamic_pointer_cast<PlaylistSource>(*s);
2711                                 if (!ps) continue;
2712                                 if (ps->playlist()->region_use_count(it->first)) {
2713                                         // break out of both loops
2714                                         return ++cnt;
2715                                 }
2716                         }
2717                 }
2718         }
2719         return cnt;
2720 }
2721
2722 boost::shared_ptr<Region>
2723 Playlist::region_by_id (const ID& id) const
2724 {
2725         /* searches all regions ever added to this playlist */
2726
2727         for (set<boost::shared_ptr<Region> >::const_iterator i = all_regions.begin(); i != all_regions.end(); ++i) {
2728                 if ((*i)->id() == id) {
2729                         return *i;
2730                 }
2731         }
2732         return boost::shared_ptr<Region> ();
2733 }
2734
2735 void
2736 Playlist::dump () const
2737 {
2738         boost::shared_ptr<Region> r;
2739
2740         cerr << "Playlist \"" << _name << "\" " << endl
2741              << regions.size() << " regions "
2742              << endl;
2743
2744         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
2745                 r = *i;
2746                 cerr << "  " << r->name() << " ["
2747                      << r->start() << "+" << r->length()
2748                      << "] at "
2749                      << r->position()
2750                      << " on layer "
2751                      << r->layer ()
2752                      << endl;
2753         }
2754 }
2755
2756 void
2757 Playlist::set_frozen (bool yn)
2758 {
2759         _frozen = yn;
2760 }
2761
2762 void
2763 Playlist::shuffle (boost::shared_ptr<Region> region, int dir)
2764 {
2765         bool moved = false;
2766
2767         if (region->locked()) {
2768                 return;
2769         }
2770
2771         _shuffling = true;
2772
2773         {
2774                 RegionWriteLock rlock (const_cast<Playlist*> (this));
2775
2776
2777                 if (dir > 0) {
2778
2779                         RegionList::iterator next;
2780
2781                         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
2782                                 if ((*i) == region) {
2783                                         next = i;
2784                                         ++next;
2785
2786                                         if (next != regions.end()) {
2787
2788                                                 if ((*next)->locked()) {
2789                                                         break;
2790                                                 }
2791
2792                                                 framepos_t new_pos;
2793
2794                                                 if ((*next)->position() != region->last_frame() + 1) {
2795                                                         /* they didn't used to touch, so after shuffle,
2796                                                            just have them swap positions.
2797                                                         */
2798                                                         new_pos = (*next)->position();
2799                                                 } else {
2800                                                         /* they used to touch, so after shuffle,
2801                                                            make sure they still do. put the earlier
2802                                                            region where the later one will end after
2803                                                            it is moved.
2804                                                         */
2805                                                         new_pos = region->position() + (*next)->length();
2806                                                 }
2807
2808                                                 (*next)->set_position (region->position());
2809                                                 region->set_position (new_pos);
2810
2811                                                 /* avoid a full sort */
2812
2813                                                 regions.erase (i); // removes the region from the list */
2814                                                 next++;
2815                                                 regions.insert (next, region); // adds it back after next
2816
2817                                                 moved = true;
2818                                         }
2819                                         break;
2820                                 }
2821                         }
2822                 } else {
2823
2824                         RegionList::iterator prev = regions.end();
2825
2826                         for (RegionList::iterator i = regions.begin(); i != regions.end(); prev = i, ++i) {
2827                                 if ((*i) == region) {
2828
2829                                         if (prev != regions.end()) {
2830
2831                                                 if ((*prev)->locked()) {
2832                                                         break;
2833                                                 }
2834
2835                                                 framepos_t new_pos;
2836                                                 if (region->position() != (*prev)->last_frame() + 1) {
2837                                                         /* they didn't used to touch, so after shuffle,
2838                                                            just have them swap positions.
2839                                                         */
2840                                                         new_pos = region->position();
2841                                                 } else {
2842                                                         /* they used to touch, so after shuffle,
2843                                                            make sure they still do. put the earlier
2844                                                            one where the later one will end after
2845                                                         */
2846                                                         new_pos = (*prev)->position() + region->length();
2847                                                 }
2848
2849                                                 region->set_position ((*prev)->position());
2850                                                 (*prev)->set_position (new_pos);
2851
2852                                                 /* avoid a full sort */
2853
2854                                                 regions.erase (i); // remove region
2855                                                 regions.insert (prev, region); // insert region before prev
2856
2857                                                 moved = true;
2858                                         }
2859
2860                                         break;
2861                                 }
2862                         }
2863                 }
2864         }
2865
2866         _shuffling = false;
2867
2868         if (moved) {
2869
2870                 relayer ();
2871                 notify_contents_changed();
2872         }
2873
2874 }
2875
2876 bool
2877 Playlist::region_is_shuffle_constrained (boost::shared_ptr<Region>)
2878 {
2879         RegionReadLock rlock (const_cast<Playlist*> (this));
2880
2881         if (regions.size() > 1) {
2882                 return true;
2883         }
2884
2885         return false;
2886 }
2887
2888 void
2889 Playlist::ripple (framepos_t at, framecnt_t distance, RegionList *exclude)
2890 {
2891         ripple_locked (at, distance, exclude);
2892 }
2893
2894 void
2895 Playlist::update_after_tempo_map_change ()
2896 {
2897         RegionWriteLock rlock (const_cast<Playlist*> (this));
2898         RegionList copy (regions.rlist());
2899
2900         freeze ();
2901
2902         for (RegionList::iterator i = copy.begin(); i != copy.end(); ++i) {
2903                 (*i)->update_after_tempo_map_change ();
2904         }
2905
2906         thaw ();
2907         notify_contents_changed();
2908 }
2909
2910 void
2911 Playlist::foreach_region (boost::function<void(boost::shared_ptr<Region>)> s)
2912 {
2913         RegionReadLock rl (this);
2914         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
2915                 s (*i);
2916         }
2917 }
2918
2919 bool
2920 Playlist::has_region_at (framepos_t const p) const
2921 {
2922         RegionReadLock (const_cast<Playlist *> (this));
2923
2924         RegionList::const_iterator i = regions.begin ();
2925         while (i != regions.end() && !(*i)->covers (p)) {
2926                 ++i;
2927         }
2928
2929         return (i != regions.end());
2930 }
2931
2932 /** Remove any region that uses a given source */
2933 void
2934 Playlist::remove_region_by_source (boost::shared_ptr<Source> s)
2935 {
2936         RegionWriteLock rl (this);
2937
2938         RegionList::iterator i = regions.begin();
2939         while (i != regions.end()) {
2940                 RegionList::iterator j = i;
2941                 ++j;
2942
2943                 if ((*i)->uses_source (s)) {
2944                         remove_region_internal (*i);
2945                 }
2946
2947                 i = j;
2948         }
2949 }
2950
2951 /** Look from a session frame time and find the start time of the next region
2952  *  which is on the top layer of this playlist.
2953  *  @param t Time to look from.
2954  *  @return Position of next top-layered region, or max_framepos if there isn't one.
2955  */
2956 framepos_t
2957 Playlist::find_next_top_layer_position (framepos_t t) const
2958 {
2959         RegionReadLock rlock (const_cast<Playlist *> (this));
2960
2961         layer_t const top = top_layer ();
2962
2963         RegionList copy = regions.rlist ();
2964         copy.sort (RegionSortByPosition ());
2965
2966         for (RegionList::const_iterator i = copy.begin(); i != copy.end(); ++i) {
2967                 if ((*i)->position() >= t && (*i)->layer() == top) {
2968                         return (*i)->position();
2969                 }
2970         }
2971
2972         return max_framepos;
2973 }
2974
2975 boost::shared_ptr<Region>
2976 Playlist::combine (const RegionList& r)
2977 {
2978         PropertyList plist;
2979         uint32_t channels = 0;
2980         uint32_t layer = 0;
2981         framepos_t earliest_position = max_framepos;
2982         vector<TwoRegions> old_and_new_regions;
2983         vector<boost::shared_ptr<Region> > originals;
2984         vector<boost::shared_ptr<Region> > copies;
2985         string parent_name;
2986         string child_name;
2987         uint32_t max_level = 0;
2988
2989         /* find the maximum depth of all the regions we're combining */
2990
2991         for (RegionList::const_iterator i = r.begin(); i != r.end(); ++i) {
2992                 max_level = max (max_level, (*i)->max_source_level());
2993         }
2994
2995         parent_name = RegionFactory::compound_region_name (name(), combine_ops(), max_level, true);
2996         child_name = RegionFactory::compound_region_name (name(), combine_ops(), max_level, false);
2997
2998         boost::shared_ptr<Playlist> pl = PlaylistFactory::create (_type, _session, parent_name, true);
2999
3000         for (RegionList::const_iterator i = r.begin(); i != r.end(); ++i) {
3001                 earliest_position = min (earliest_position, (*i)->position());
3002         }
3003
3004         /* enable this so that we do not try to create xfades etc. as we add
3005          * regions
3006          */
3007
3008         pl->in_partition = true;
3009
3010         /* sort by position then layer.
3011          * route_time_axis passes 'selected_regions' - which is not sorted.
3012          * here we need the top-most first, then every layer's region sorted by position.
3013          */
3014         RegionList sorted(r);
3015         sorted.sort(RegionSortByLayerAndPosition());
3016
3017         for (RegionList::const_iterator i = sorted.begin(); i != sorted.end(); ++i) {
3018
3019                 /* copy the region */
3020
3021                 boost::shared_ptr<Region> original_region = (*i);
3022                 boost::shared_ptr<Region> copied_region = RegionFactory::create (original_region, false);
3023
3024                 old_and_new_regions.push_back (TwoRegions (original_region,copied_region));
3025                 originals.push_back (original_region);
3026                 copies.push_back (copied_region);
3027
3028                 RegionFactory::add_compound_association (original_region, copied_region);
3029
3030                 /* make position relative to zero */
3031
3032                 pl->add_region (copied_region, original_region->position() - earliest_position);
3033                 copied_region->set_layer (original_region->layer ());
3034
3035                 /* use the maximum number of channels for any region */
3036
3037                 channels = max (channels, original_region->n_channels());
3038
3039                 /* it will go above the layer of the highest existing region */
3040
3041                 layer = max (layer, original_region->layer());
3042         }
3043
3044         pl->in_partition = false;
3045
3046         pre_combine (copies);
3047
3048         /* now create a new PlaylistSource for each channel in the new playlist */
3049
3050         SourceList sources;
3051         pair<framepos_t,framepos_t> extent = pl->get_extent();
3052
3053         for (uint32_t chn = 0; chn < channels; ++chn) {
3054                 sources.push_back (SourceFactory::createFromPlaylist (_type, _session, pl, id(), parent_name, chn, 0, extent.second, false, false));
3055
3056         }
3057
3058         /* now a new whole-file region using the list of sources */
3059
3060         plist.add (Properties::start, 0);
3061         plist.add (Properties::length, extent.second);
3062         plist.add (Properties::name, parent_name);
3063         plist.add (Properties::whole_file, true);
3064
3065         boost::shared_ptr<Region> parent_region = RegionFactory::create (sources, plist, true);
3066
3067         /* now the non-whole-file region that we will actually use in the
3068          * playlist
3069          */
3070
3071         plist.clear ();
3072         plist.add (Properties::start, 0);
3073         plist.add (Properties::length, extent.second);
3074         plist.add (Properties::name, child_name);
3075         plist.add (Properties::layer, layer+1);
3076
3077         boost::shared_ptr<Region> compound_region = RegionFactory::create (parent_region, plist, true);
3078
3079         /* remove all the selected regions from the current playlist
3080          */
3081
3082         freeze ();
3083
3084         for (RegionList::const_iterator i = r.begin(); i != r.end(); ++i) {
3085                 remove_region (*i);
3086         }
3087
3088         /* do type-specific stuff with the originals and the new compound
3089            region
3090         */
3091
3092         post_combine (originals, compound_region);
3093
3094         /* add the new region at the right location */
3095
3096         add_region (compound_region, earliest_position);
3097
3098         _combine_ops++;
3099
3100         thaw ();
3101
3102         return compound_region;
3103 }
3104
3105 void
3106 Playlist::uncombine (boost::shared_ptr<Region> target)
3107 {
3108         boost::shared_ptr<PlaylistSource> pls;
3109         boost::shared_ptr<const Playlist> pl;
3110         vector<boost::shared_ptr<Region> > originals;
3111         vector<TwoRegions> old_and_new_regions;
3112
3113         // (1) check that its really a compound region
3114
3115         if ((pls = boost::dynamic_pointer_cast<PlaylistSource>(target->source (0))) == 0) {
3116                 return;
3117         }
3118
3119         pl = pls->playlist();
3120
3121         framepos_t adjusted_start = 0; // gcc isn't smart enough
3122         framepos_t adjusted_end = 0;   // gcc isn't smart enough
3123
3124         /* the leftmost (earliest) edge of the compound region
3125            starts at zero in its source, or larger if it
3126            has been trimmed or content-scrolled.
3127
3128            the rightmost (latest) edge of the compound region
3129            relative to its source is the starting point plus
3130            the length of the region.
3131         */
3132
3133         // (2) get all the original regions
3134
3135         const RegionList& rl (pl->region_list().rlist());
3136         RegionFactory::CompoundAssociations& cassocs (RegionFactory::compound_associations());
3137         frameoffset_t move_offset = 0;
3138
3139         /* there are two possibilities here:
3140            1) the playlist that the playlist source was based on
3141            is us, so just add the originals (which belonged to
3142            us anyway) back in the right place.
3143
3144            2) the playlist that the playlist source was based on
3145            is NOT us, so we need to make copies of each of
3146            the original regions that we find, and add them
3147            instead.
3148         */
3149         bool same_playlist = (pls->original() == id());
3150
3151         for (RegionList::const_iterator i = rl.begin(); i != rl.end(); ++i) {
3152
3153                 boost::shared_ptr<Region> current (*i);
3154
3155                 RegionFactory::CompoundAssociations::iterator ca = cassocs.find (*i);
3156
3157                 if (ca == cassocs.end()) {
3158                         continue;
3159                 }
3160
3161                 boost::shared_ptr<Region> original (ca->second);
3162                 cassocs.erase(ca);
3163                 bool modified_region;
3164
3165                 if (i == rl.begin()) {
3166                         move_offset = (target->position() - original->position()) - target->start();
3167                         adjusted_start = original->position() + target->start();
3168                         adjusted_end = adjusted_start + target->length();
3169                 }
3170
3171                 if (!same_playlist) {
3172                         framepos_t pos = original->position();
3173                         /* make a copy, but don't announce it */
3174                         original = RegionFactory::create (original, false);
3175                         /* the pure copy constructor resets position() to zero,
3176                            so fix that up.
3177                         */
3178                         original->set_position (pos);
3179                 }
3180
3181                 /* check to see how the original region (in the
3182                  * playlist before compounding occurred) overlaps
3183                  * with the new state of the compound region.
3184                  */
3185
3186                 original->clear_changes ();
3187                 modified_region = false;
3188
3189                 switch (original->coverage (adjusted_start, adjusted_end)) {
3190                 case Evoral::OverlapNone:
3191                         /* original region does not cover any part
3192                            of the current state of the compound region
3193                         */
3194                         continue;
3195
3196                 case Evoral::OverlapInternal:
3197                         /* overlap is just a small piece inside the
3198                          * original so trim both ends
3199                          */
3200                         original->trim_to (adjusted_start, adjusted_end - adjusted_start);
3201                         modified_region = true;
3202                         break;
3203
3204                 case Evoral::OverlapExternal:
3205                         /* overlap fully covers original, so leave it
3206                            as is
3207                         */
3208                         break;
3209
3210                 case Evoral::OverlapEnd:
3211                         /* overlap starts within but covers end,
3212                            so trim the front of the region
3213                         */
3214                         original->trim_front (adjusted_start);
3215                         modified_region = true;
3216                         break;
3217
3218                 case Evoral::OverlapStart:
3219                         /* overlap covers start but ends within, so
3220                          * trim the end of the region.
3221                          */
3222                         original->trim_end (adjusted_end);
3223                         modified_region = true;
3224                         break;
3225                 }
3226
3227                 if (move_offset) {
3228                         /* fix the position to match any movement of the compound region.
3229                          */
3230                         original->set_position (original->position() + move_offset);
3231                         modified_region = true;
3232                 }
3233
3234                 if (modified_region) {
3235                         _session.add_command (new StatefulDiffCommand (original));
3236                 }
3237
3238                 /* and add to the list of regions waiting to be
3239                  * re-inserted
3240                  */
3241
3242                 originals.push_back (original);
3243                 old_and_new_regions.push_back (TwoRegions (*i, original));
3244         }
3245
3246         pre_uncombine (originals, target);
3247
3248         in_partition = true;
3249         freeze ();
3250
3251         // (3) remove the compound region
3252
3253         remove_region (target);
3254
3255         // (4) add the constituent regions
3256
3257         for (vector<boost::shared_ptr<Region> >::iterator i = originals.begin(); i != originals.end(); ++i) {
3258                 add_region ((*i), (*i)->position());
3259                 set_layer((*i), (*i)->layer());
3260                 if (!RegionFactory::region_by_id((*i)->id())) {
3261                         RegionFactory::map_add(*i);
3262                 }
3263         }
3264
3265         in_partition = false;
3266         thaw ();
3267 }
3268
3269 void
3270 Playlist::fade_range (list<AudioRange>& ranges)
3271 {
3272          for (list<AudioRange>::iterator r = ranges.begin(); r != ranges.end(); ++r) {
3273                  for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
3274                          (*i)->fade_range ((*r).start, (*r).end);
3275                  }
3276          }
3277 }
3278
3279 uint32_t
3280 Playlist::max_source_level () const
3281 {
3282         RegionReadLock rlock (const_cast<Playlist *> (this));
3283         uint32_t lvl = 0;
3284
3285         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
3286                 lvl = max (lvl, (*i)->max_source_level());
3287         }
3288
3289         return lvl;
3290 }
3291
3292 void
3293 Playlist::set_orig_track_id (const PBD::ID& id)
3294 {
3295         _orig_track_id = id;
3296 }
3297
3298 /** Take a list of ranges, coalesce any that can be coalesced, then call
3299  *  check_crossfades for each one.
3300  */
3301 void
3302 Playlist::coalesce_and_check_crossfades (list<Evoral::Range<framepos_t> > ranges)
3303 {
3304         /* XXX: it's a shame that this coalesce algorithm also exists in
3305            TimeSelection::consolidate().
3306         */
3307
3308         /* XXX: xfade: this is implemented in Evoral::RangeList */
3309
3310 restart:
3311         for (list<Evoral::Range<framepos_t> >::iterator i = ranges.begin(); i != ranges.end(); ++i) {
3312                 for (list<Evoral::Range<framepos_t> >::iterator j = ranges.begin(); j != ranges.end(); ++j) {
3313
3314                         if (i == j) {
3315                                 continue;
3316                         }
3317
3318                         // XXX i->from can be > i->to - is this right? coverage() will return OverlapNone in this case
3319                         if (Evoral::coverage (i->from, i->to, j->from, j->to) != Evoral::OverlapNone) {
3320                                 i->from = min (i->from, j->from);
3321                                 i->to = max (i->to, j->to);
3322                                 ranges.erase (j);
3323                                 goto restart;
3324                         }
3325                 }
3326         }
3327 }
3328
3329 void
3330 Playlist::set_capture_insertion_in_progress (bool yn)
3331 {
3332         _capture_insertion_underway = yn;
3333 }