turn off relevant fade in/out before creating peakfiles for compound region sources
[ardour.git] / libs / ardour / audio_playlist.cc
index 6e8b35a07238e8661058cef8f5453f42ab9fa85d..59c791b8fbd797fa5c7d3585d969ec512752007b 100644 (file)
 
 #include <cstdlib>
 
-
 #include "ardour/types.h"
+#include "ardour/debug.h"
 #include "ardour/configuration.h"
 #include "ardour/audioplaylist.h"
 #include "ardour/audioregion.h"
 #include "ardour/crossfade.h"
-#include "ardour/crossfade_compare.h"
+#include "ardour/region_sorters.h"
 #include "ardour/session.h"
 #include "pbd/enumwriter.h"
 
@@ -37,11 +37,76 @@ using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
 
+namespace ARDOUR {
+       namespace Properties {
+               PBD::PropertyDescriptor<bool> crossfades;
+       }
+}
+
+void
+AudioPlaylist::make_property_quarks ()
+{
+        Properties::crossfades.property_id = g_quark_from_static_string (X_("crossfades"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for crossfades = %1\n", Properties::crossfades.property_id));
+}
+
+CrossfadeListProperty::CrossfadeListProperty (AudioPlaylist& pl)
+        : SequenceProperty<std::list<boost::shared_ptr<Crossfade> > > (Properties::crossfades.property_id, boost::bind (&AudioPlaylist::update, &pl, _1))
+        , _playlist (pl)
+{
+       
+}
+
+CrossfadeListProperty::CrossfadeListProperty (CrossfadeListProperty const & p)
+       : PBD::SequenceProperty<std::list<boost::shared_ptr<Crossfade> > > (p)
+       , _playlist (p._playlist)
+{
+
+}
+
+
+CrossfadeListProperty *
+CrossfadeListProperty::create () const
+{
+       return new CrossfadeListProperty (_playlist);
+}
+
+CrossfadeListProperty *
+CrossfadeListProperty::clone () const
+{
+       return new CrossfadeListProperty (*this);
+}
+
+void
+CrossfadeListProperty::get_content_as_xml (boost::shared_ptr<Crossfade> xfade, XMLNode & node) const
+{
+       /* Crossfades are not written to any state when they are no
+          longer in use, so we must write their state here.
+       */
+
+       XMLNode& c = xfade->get_state ();
+       node.add_child_nocopy (c);
+}
+
+boost::shared_ptr<Crossfade>
+CrossfadeListProperty::get_content_from_xml (XMLNode const & node) const
+{
+       XMLNodeList const c = node.children ();
+       assert (c.size() == 1);
+       return boost::shared_ptr<Crossfade> (new Crossfade (_playlist, *c.front()));
+}
+
+
 AudioPlaylist::AudioPlaylist (Session& session, const XMLNode& node, bool hidden)
        : Playlist (session, node, DataType::AUDIO, hidden)
+       , _crossfades (*this)
 {
+#ifndef NDEBUG
        const XMLProperty* prop = node.property("type");
        assert(!prop || DataType(prop->value()) == DataType::AUDIO);
+#endif
+
+       add_property (_crossfades);
 
        in_set_state++;
        set_state (node, Stateful::loading_state_version);
@@ -50,12 +115,17 @@ AudioPlaylist::AudioPlaylist (Session& session, const XMLNode& node, bool hidden
 
 AudioPlaylist::AudioPlaylist (Session& session, string name, bool hidden)
        : Playlist (session, name, DataType::AUDIO, hidden)
+       , _crossfades (*this)
 {
+       add_property (_crossfades);
 }
 
 AudioPlaylist::AudioPlaylist (boost::shared_ptr<const AudioPlaylist> other, string name, bool hidden)
        : Playlist (other, name, hidden)
+       , _crossfades (*this)
 {
+       add_property (_crossfades);
+       
        RegionList::const_iterator in_o  = other->regions.begin();
        RegionList::iterator in_n = regions.begin();
 
@@ -94,9 +164,91 @@ AudioPlaylist::AudioPlaylist (boost::shared_ptr<const AudioPlaylist> other, stri
        }
 }
 
-AudioPlaylist::AudioPlaylist (boost::shared_ptr<const AudioPlaylist> other, nframes_t start, nframes_t cnt, string name, bool hidden)
+AudioPlaylist::AudioPlaylist (boost::shared_ptr<const AudioPlaylist> other, framepos_t start, framecnt_t cnt, string name, bool hidden)
        : Playlist (other, start, cnt, name, hidden)
+       , _crossfades (*this)
 {
+       RegionLock rlock2 (const_cast<AudioPlaylist*> (other.get()));
+       in_set_state++;
+       
+       add_property (_crossfades);
+
+       framepos_t const end = start + cnt - 1;
+
+       /* Audio regions that have been created by the Playlist constructor
+          will currently have the same fade in/out as the regions that they
+          were created from.  This is wrong, so reset the fades here.
+       */
+
+       RegionList::iterator ours = regions.begin ();
+
+       for (RegionList::const_iterator i = other->regions.begin(); i != other->regions.end(); ++i) {
+               boost::shared_ptr<AudioRegion> region = boost::dynamic_pointer_cast<AudioRegion> (*i);
+               assert (region);
+
+               framecnt_t fade_in = 64;
+               framecnt_t fade_out = 64;
+               framepos_t position;
+               framecnt_t len;
+               frameoffset_t offset;
+
+               switch (region->coverage (start, end)) {
+               case OverlapNone:
+                       continue;
+
+               case OverlapInternal:
+               {
+                       framecnt_t const offset = start - region->position ();
+                       framecnt_t const trim = region->last_frame() - end;
+                       if (region->fade_in()->back()->when > offset) {
+                               fade_in = region->fade_in()->back()->when - offset;
+                       }
+                       if (region->fade_out()->back()->when > trim) {
+                               fade_out = region->fade_out()->back()->when - trim;
+                       }
+                       break;
+               }
+
+               case OverlapStart: {
+                       position = region->position() - start;
+                       len = end - region->position();
+
+                       if (end > region->position() + region->fade_in()->back()->when)
+                               fade_in = region->fade_in()->back()->when;  //end is after fade-in, preserve the fade-in
+                       if (end > region->last_frame() - region->fade_out()->back()->when)
+                               fade_out = region->fade_out()->back()->when - ( region->last_frame() - end );  //end is inside the fadeout, preserve the fades endpoint
+                       break;
+               }
+               
+               case OverlapEnd: {
+                       position = 0;
+                       offset = start - region->position();
+                       len = region->length() - offset;
+
+                       if (start < region->last_frame() - region->fade_out()->back()->when)  //start is before fade-out, preserve the fadeout
+                               fade_out = region->fade_out()->back()->when;
+                       
+                       if (start < region->position() + region->fade_in()->back()->when)
+                               fade_in = region->fade_in()->back()->when - (start - region->position());  //end is inside the fade-in, preserve the fade-in endpoint
+                       break;
+               }
+               
+               case OverlapExternal:
+                       fade_in = region->fade_in()->back()->when;
+                       fade_out = region->fade_out()->back()->when;
+                       break;
+               }
+
+               boost::shared_ptr<AudioRegion> our_region = boost::dynamic_pointer_cast<AudioRegion> (*ours);
+               assert (our_region);
+
+               our_region->set_fade_in_length (fade_in);
+               our_region->set_fade_out_length (fade_out);
+               ++ours;
+       }
+
+       in_set_state--;
+
        /* this constructor does NOT notify others (session) */
 }
 
@@ -111,14 +263,11 @@ struct RegionSortByLayer {
     }
 };
 
-ARDOUR::nframes_t
-AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nframes_t start,
-                    nframes_t cnt, unsigned chan_n)
+ARDOUR::framecnt_t
+AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, framepos_t start,
+                    framecnt_t cnt, unsigned chan_n)
 {
-       nframes_t ret = cnt;
-       nframes_t end;
-       nframes_t read_frames;
-       nframes_t skip_frames;
+       framecnt_t ret = cnt;
 
        /* optimizing this memset() away involves a lot of conditionals
           that may well cause more of a hit due to cache misses
@@ -141,9 +290,9 @@ AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nf
 
        Glib::RecMutex::Lock rm (region_lock);
 
-       end =  start + cnt - 1;
-       read_frames = 0;
-       skip_frames = 0;
+       framepos_t const end = start + cnt - 1;
+       framecnt_t read_frames = 0;
+       framecnt_t skip_frames = 0;
        _read_data_count = 0;
 
        _read_data_count = 0;
@@ -163,7 +312,7 @@ AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nf
                if ((*i)->coverage (start, end) != OverlapNone) {
                        relevant_regions[(*i)->layer()].push_back (*i);
                        relevant_layers.push_back ((*i)->layer());
-               }
+                }
        }
 
        for (Crossfades::iterator i = _crossfades.begin(); i != _crossfades.end(); ++i) {
@@ -188,8 +337,10 @@ AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nf
                vector<boost::shared_ptr<Region> > r (relevant_regions[*l]);
                vector<boost::shared_ptr<Crossfade> >& x (relevant_xfades[*l]);
 
+
                for (vector<boost::shared_ptr<Region> >::iterator i = r.begin(); i != r.end(); ++i) {
                        boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(*i);
+                        DEBUG_TRACE (DEBUG::AudioPlayback, string_compose ("read from region %1\n", ar->name()));
                        assert(ar);
                        ar->read_at (buf, mixdown_buffer, gain_buffer, start, cnt, chan_n, read_frames, skip_frames);
                        _read_data_count += ar->read_data_count();
@@ -236,9 +387,9 @@ AudioPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 
 
 void
-AudioPlaylist::flush_notifications ()
+AudioPlaylist::flush_notifications (bool from_undo)
 {
-       Playlist::flush_notifications();
+       Playlist::flush_notifications (from_undo);
 
        if (in_flush) {
                return;
@@ -365,9 +516,6 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
        }
 
        for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
-
-               nframes_t xfade_length;
-
                other = boost::dynamic_pointer_cast<AudioRegion> (*i);
 
                if (other == region) {
@@ -378,6 +526,10 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
                        continue;
                }
 
+                if (other->position() == r->position() && other->length() == r->length()) {
+                        /* precise overlay of two regions - no xfade */
+                        continue;
+                }
 
                if (other->layer() < region->layer()) {
                        top = region;
@@ -397,6 +549,7 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
                touched_regions = 0;
 
                try {
+                       framecnt_t xfade_length;
                        switch (c) {
                        case OverlapNone:
                                break;
@@ -662,17 +815,15 @@ bool
 AudioPlaylist::destroy_region (boost::shared_ptr<Region> region)
 {
        boost::shared_ptr<AudioRegion> r = boost::dynamic_pointer_cast<AudioRegion> (region);
+
+        if (!r) {
+                return false;
+        }
+
        bool changed = false;
        Crossfades::iterator c, ctmp;
        set<boost::shared_ptr<Crossfade> > unique_xfades;
 
-       if (r == 0) {
-               fatal << _("programming error: non-audio Region passed to remove_overlap in audio playlist")
-                     << endmsg;
-               /*NOTREACHED*/
-               return false;
-       }
-
        {
                RegionLock rlock (this);
 
@@ -770,15 +921,13 @@ AudioPlaylist::region_changed (const PropertyChange& what_changed, boost::shared
 }
 
 void
-AudioPlaylist::crossfades_at (nframes_t frame, Crossfades& clist)
+AudioPlaylist::crossfades_at (framepos_t frame, Crossfades& clist)
 {
        RegionLock rlock (this);
 
        for (Crossfades::iterator i = _crossfades.begin(); i != _crossfades.end(); ++i) {
-               nframes_t start, end;
-
-               start = (*i)->position();
-               end = start + (*i)->overlap_length(); // not length(), important difference
+               framepos_t const start = (*i)->position ();
+               framepos_t const end = start + (*i)->overlap_length(); // not length(), important difference
 
                if (frame >= start && frame <= end) {
                        clist.push_back (*i);
@@ -794,3 +943,244 @@ AudioPlaylist::foreach_crossfade (boost::function<void (boost::shared_ptr<Crossf
                s (*i);
        }
 }
+
+void
+AudioPlaylist::update (const CrossfadeListProperty::ChangeRecord& change)
+{
+       for (CrossfadeListProperty::ChangeContainer::const_iterator i = change.added.begin(); i != change.added.end(); ++i) {
+               add_crossfade (*i);
+       }
+
+       /* don't remove crossfades here; they will be dealt with by the dependency code */
+}
+
+boost::shared_ptr<Crossfade>
+AudioPlaylist::find_crossfade (const PBD::ID& id) const
+{
+       Crossfades::const_iterator i = _crossfades.begin ();
+       while (i != _crossfades.end() && (*i)->id() != id) {
+               ++i;
+       }
+
+       if (i == _crossfades.end()) {
+               return boost::shared_ptr<Crossfade> ();
+       }
+
+       return *i;
+}
+
+struct crossfade_triple {
+    boost::shared_ptr<Region> old_in;
+    boost::shared_ptr<Region> new_in;
+    boost::shared_ptr<Region> new_out;
+};
+
+void
+AudioPlaylist::copy_dependents (const vector<TwoRegions>& old_and_new, boost::shared_ptr<Playlist> other)
+{
+       boost::shared_ptr<AudioPlaylist> other_audio = boost::dynamic_pointer_cast<AudioPlaylist>(other);
+
+       if (!other_audio) {
+               return;
+       }
+
+       /* our argument is a vector of old and new regions. Each old region
+          might be participant in a crossfade that is already present. Each new
+          region is a copy of the old region, present in the other playlist.
+
+          our task is to find all the relevant xfades in our playlist (involving
+          the "old" regions) and place copies of them in the other playlist.
+       */
+
+       typedef map<boost::shared_ptr<Crossfade>,crossfade_triple> CrossfadeInfo;
+       CrossfadeInfo crossfade_info;
+
+       /* build up a record that links crossfades, old regions and new regions
+        */
+
+       for (vector<TwoRegions>::const_iterator on = old_and_new.begin(); on != old_and_new.end(); ++on) {
+
+               for (Crossfades::iterator i = _crossfades.begin(); i != _crossfades.end(); ++i) {
+
+                       if ((*i)->in() == on->first) {
+                               
+                               CrossfadeInfo::iterator cf;
+
+                               if ((cf = crossfade_info.find (*i)) != crossfade_info.end()) {
+
+                                       /* already have a record for the old fade-in region, 
+                                          so note the new fade-in region
+                                       */
+                                       
+                                       cf->second.new_in = on->second;
+                                       
+                               } else {
+                                       
+                                       /* add a record of this crossfade, keeping an association
+                                          with the new fade-in region
+                                       */
+                                       
+                                       crossfade_triple ct;
+                                       
+                                       ct.old_in = on->first;
+                                       ct.new_in = on->second;
+
+                                       crossfade_info[*i] = ct;
+                               }
+
+                       } else if ((*i)->out() == on->first) {
+                               
+                               /* this old region is the fade-out region of this crossfade */
+                               
+                               CrossfadeInfo::iterator cf;
+                               
+                               if ((cf = crossfade_info.find (*i)) != crossfade_info.end()) {
+                                       
+                                       /* already have a record for this crossfade, so just keep
+                                          an association for the new fade out region
+                                       */
+                                       
+                                       cf->second.new_out = on->second;
+
+                               } else {
+                                       
+                                       /* add a record of this crossfade, keeping an association
+                                          with the new fade-in region
+                                       */
+
+                                       crossfade_triple ct;
+
+                                       ct.old_in = on->first;
+                                       ct.new_out = on->second;
+
+                                       crossfade_info[*i] = ct;
+                               }
+                       }
+               }
+       }
+
+       for (CrossfadeInfo::iterator ci = crossfade_info.begin(); ci != crossfade_info.end(); ++ci) {
+               
+               /* for each crossfade that involves at least two of the old regions,
+                  create a new identical crossfade with the new regions
+               */
+               
+               if (!ci->second.new_in || !ci->second.new_out) {
+                       continue;
+               }
+
+               boost::shared_ptr<Crossfade> new_xfade (new Crossfade (ci->first, 
+                                                                      boost::dynamic_pointer_cast<AudioRegion>(ci->second.new_in),
+                                                                      boost::dynamic_pointer_cast<AudioRegion>(ci->second.new_out)));
+               
+               /* add it at the right position - which must be at the start
+                * of the fade-in region
+                */
+
+               new_xfade->set_position (ci->second.new_in->position(), this);
+               other_audio->add_crossfade (new_xfade);
+       }
+}
+
+void
+AudioPlaylist::pre_combine (vector<boost::shared_ptr<Region> >& copies)
+{
+       RegionSortByPosition cmp;
+       boost::shared_ptr<AudioRegion> ar;
+
+       sort (copies.begin(), copies.end(), cmp);
+
+       ar = boost::dynamic_pointer_cast<AudioRegion> (copies.front());
+
+       /* copy the fade in of the first into the compound region */
+
+       if (ar) {
+               ar->set_fade_in_active (false);
+       }
+
+       ar = boost::dynamic_pointer_cast<AudioRegion> (copies.back());
+
+       if (ar) {
+               ar->set_fade_out_active (false);
+       }
+}
+
+void
+AudioPlaylist::post_combine (vector<boost::shared_ptr<Region> >& originals, boost::shared_ptr<Region> compound_region)
+{
+       RegionSortByPosition cmp;
+       boost::shared_ptr<AudioRegion> ar;
+       boost::shared_ptr<AudioRegion> cr;
+
+       if ((cr = boost::dynamic_pointer_cast<AudioRegion> (compound_region)) == 0) {
+               return;
+       }
+
+       sort (originals.begin(), originals.end(), cmp);
+
+       ar = boost::dynamic_pointer_cast<AudioRegion> (originals.front());
+
+       /* copy the fade in of the first into the compound region */
+
+       if (ar) {
+               cr->set_fade_in (ar->fade_in());
+               ar->set_fade_in_active (false);
+       }
+
+       ar = boost::dynamic_pointer_cast<AudioRegion> (originals.back());
+
+       if (ar) {
+               /* copy the fade out of the last into the compound region */
+               cr->set_fade_out (ar->fade_out());
+               ar->set_fade_out_active (false);
+       }
+}
+
+void
+AudioPlaylist::pre_uncombine (vector<boost::shared_ptr<Region> >& originals, boost::shared_ptr<Region> compound_region)
+{
+       boost::shared_ptr<AudioRegion> ar;
+       boost::shared_ptr<AudioRegion> cr = boost::dynamic_pointer_cast<AudioRegion>(compound_region);
+
+       if (!cr) {
+               return;
+       }
+
+       /* no need to call clear_changes() on the originals because that is
+        * done within Playlist::uncombine ()
+        */
+
+       if ((ar = boost::dynamic_pointer_cast<AudioRegion> (originals.front())) != 0) {
+
+               /* copy the compound region's fade in back into the first
+                  original region.
+               */
+
+               if (cr->fade_in()->back()->when <= ar->length()) {
+                       /* don't do this if the fade is longer than the
+                        * region
+                        */
+                       ar->set_fade_in (cr->fade_in());
+               }
+
+               ar->set_fade_in_active (true);
+               _session.add_command (new StatefulDiffCommand (originals.front()));
+       }
+
+       if ((ar = boost::dynamic_pointer_cast<AudioRegion> (originals.back())) != 0) {
+
+               /* copy the compound region's fade out back into the last
+                  original region.
+               */
+
+               if (cr->fade_out()->back()->when <= ar->length()) {
+                       /* don't do this if the fade is longer than the
+                        * region
+                        */
+                       ar->set_fade_out (cr->fade_out());
+               }
+
+               ar->set_fade_out_active (true);
+               _session.add_command (new StatefulDiffCommand (originals.back()));
+       }
+}