Add AutomationControl::parameter() for terseness.
[ardour.git] / libs / ardour / audio_playlist.cc
index be8680882f86baf199df01f84f0d52db142d760a..d28d88488ed651b853eb7b8d231142ec127a2f32 100644 (file)
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #include <algorithm>
@@ -31,6 +30,7 @@
 #include <ardour/crossfade.h>
 #include <ardour/crossfade_compare.h>
 #include <ardour/session.h>
+#include <pbd/enumwriter.h>
 
 #include "i18n.h"
 
@@ -40,52 +40,47 @@ using namespace std;
 using namespace PBD;
 
 AudioPlaylist::AudioPlaylist (Session& session, const XMLNode& node, bool hidden)
-       : Playlist (session, node, hidden)
+       : Playlist (session, node, DataType::AUDIO, hidden)
 {
-       in_set_state = true;
-       set_state (node);
-       in_set_state = false;
+       const XMLProperty* prop = node.property("type");
+       assert(!prop || DataType(prop->value()) == DataType::AUDIO);
 
-       if (!hidden) {
-               PlaylistCreated (this); /* EMIT SIGNAL */
-       }
+       in_set_state++;
+       set_state (node);
+       in_set_state--;
 }
 
 AudioPlaylist::AudioPlaylist (Session& session, string name, bool hidden)
-       : Playlist (session, name, hidden)
+       : Playlist (session, name, DataType::AUDIO, hidden)
 {
-       if (!hidden) {
-               PlaylistCreated (this); /* EMIT SIGNAL */
-       }
-
 }
 
-AudioPlaylist::AudioPlaylist (const AudioPlaylist& other, string name, bool hidden)
+AudioPlaylist::AudioPlaylist (boost::shared_ptr<const AudioPlaylist> other, string name, bool hidden)
        : Playlist (other, name, hidden)
 {
-       RegionList::const_iterator in_o  = other.regions.begin();
+       RegionList::const_iterator in_o  = other->regions.begin();
        RegionList::iterator in_n = regions.begin();
 
-       while (in_o != other.regions.end()) {
+       while (in_o != other->regions.end()) {
                boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(*in_o);
 
                // We look only for crossfades which begin with the current region, so we don't get doubles
-               for (list<Crossfade *>::const_iterator xfades = other._crossfades.begin(); xfades != other._crossfades.end(); ++xfades) {
+               for (Crossfades::const_iterator xfades = other->_crossfades.begin(); xfades != other->_crossfades.end(); ++xfades) {
                        if ((*xfades)->in() == ar) {
                                // We found one! Now copy it!
 
-                               RegionList::const_iterator out_o = other.regions.begin();
+                               RegionList::const_iterator out_o = other->regions.begin();
                                RegionList::const_iterator out_n = regions.begin();
 
-                               while (out_o != other.regions.end()) {
+                               while (out_o != other->regions.end()) {
                                        
                                        boost::shared_ptr<AudioRegion>ar2 = boost::dynamic_pointer_cast<AudioRegion>(*out_o);
                                        
                                        if ((*xfades)->out() == ar2) {
                                                boost::shared_ptr<AudioRegion>in  = boost::dynamic_pointer_cast<AudioRegion>(*in_n);
                                                boost::shared_ptr<AudioRegion>out = boost::dynamic_pointer_cast<AudioRegion>(*out_n);
-                                               Crossfade *new_fade = new Crossfade (*(*xfades), in, out);
-                                               add_crossfade(*new_fade);
+                                               boost::shared_ptr<Crossfade> new_fade = boost::shared_ptr<Crossfade> (new Crossfade (*xfades, in, out));
+                                               add_crossfade(new_fade);
                                                break;
                                        }
                                        
@@ -99,13 +94,9 @@ AudioPlaylist::AudioPlaylist (const AudioPlaylist& other, string name, bool hidd
                in_o++;
                in_n++;
        }
-
-       if (!hidden) {
-               PlaylistCreated (this); /* EMIT SIGNAL */
-       }
 }
 
-AudioPlaylist::AudioPlaylist (const AudioPlaylist& other, nframes_t start, nframes_t cnt, string name, bool hidden)
+AudioPlaylist::AudioPlaylist (boost::shared_ptr<const AudioPlaylist> other, nframes_t start, nframes_t cnt, string name, bool hidden)
        : Playlist (other, start, cnt, name, hidden)
 {
        /* this constructor does NOT notify others (session) */
@@ -113,33 +104,26 @@ AudioPlaylist::AudioPlaylist (const AudioPlaylist& other, nframes_t start, nfram
 
 AudioPlaylist::~AudioPlaylist ()
 {
-       set<Crossfade*> all_xfades;
-
        GoingAway (); /* EMIT SIGNAL */
 
        /* drop connections to signals */
 
        notify_callbacks ();
-
-       for (Crossfades::iterator x = _crossfades.begin(); x != _crossfades.end(); ++x) {
-               delete *x;
-       }
+       
+       _crossfades.clear ();
 }
 
 struct RegionSortByLayer {
-    bool operator() (boost::shared_ptr<Region>a, boost::shared_ptr<Region>b) {
+    bool operator() (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) {
            return a->layer() < b->layer();
     }
 };
 
-nframes_t
+ARDOUR::nframes_t
 AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nframes_t start,
                     nframes_t cnt, unsigned chan_n)
 {
-       nframes_t ret = cnt;
        nframes_t end;
-       nframes_t read_frames;
-       nframes_t skip_frames;
 
        /* optimizing this memset() away involves a lot of conditionals
           that may well cause more of a hit due to cache misses 
@@ -164,12 +148,10 @@ AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nf
 
        end =  start + cnt - 1;
 
-       read_frames = 0;
-       skip_frames = 0;
        _read_data_count = 0;
 
        map<uint32_t,vector<boost::shared_ptr<Region> > > relevant_regions;
-       map<uint32_t,vector<Crossfade*> > relevant_xfades;
+       map<uint32_t,vector<boost::shared_ptr<Crossfade> > > relevant_xfades;
        vector<uint32_t> relevant_layers;
 
        for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
@@ -199,16 +181,16 @@ AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nf
        for (vector<uint32_t>::iterator l = relevant_layers.begin(); l != relevant_layers.end(); ++l) {
 
                vector<boost::shared_ptr<Region> > r (relevant_regions[*l]);
-               vector<Crossfade*>& x (relevant_xfades[*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);
                        assert(ar);
-                       ar->read_at (buf, mixdown_buffer, gain_buffer, start, cnt, chan_n, read_frames, skip_frames);
+                       ar->read_at (buf, mixdown_buffer, gain_buffer, start, cnt, chan_n);
                        _read_data_count += ar->read_data_count();
                }
                
-               for (vector<Crossfade*>::iterator i = x.begin(); i != x.end(); ++i) {
+               for (vector<boost::shared_ptr<Crossfade> >::iterator i = x.begin(); i != x.end(); ++i) {
                        (*i)->read_at (buf, mixdown_buffer, gain_buffer, start, cnt, chan_n);
 
                        /* don't JACK up _read_data_count, since its the same data as we just
@@ -217,15 +199,18 @@ AudioPlaylist::read (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nf
                }
        }
 
-       return ret;
+       return cnt;
 }
 
 
 void
 AudioPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 {
-       Crossfades::iterator i, tmp;
        boost::shared_ptr<AudioRegion> r = boost::dynamic_pointer_cast<AudioRegion> (region);
+
+       if (in_set_state) {
+               return;
+       }
        
        if (r == 0) {
                fatal << _("programming error: non-audio Region passed to remove_overlap in audio playlist")
@@ -233,16 +218,13 @@ AudioPlaylist::remove_dependents (boost::shared_ptr<Region> region)
                return;
        }
 
-       for (i = _crossfades.begin(); i != _crossfades.end(); ) {
-               tmp = i;
-               tmp++;
-
+       for (Crossfades::iterator i = _crossfades.begin(); i != _crossfades.end(); ) {
                
                if ((*i)->involves (r)) {
-                       delete *i;
+                       i = _crossfades.erase (i);
+               } else {
+                       ++i;
                }
-               
-               i = tmp;
        }
 }
 
@@ -272,7 +254,7 @@ void
 AudioPlaylist::refresh_dependents (boost::shared_ptr<Region> r)
 {
        boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(r);
-       set<Crossfade*> updated;
+       set<boost::shared_ptr<Crossfade> > updated;
 
        if (ar == 0) {
                return;
@@ -290,9 +272,14 @@ AudioPlaylist::refresh_dependents (boost::shared_ptr<Region> r)
                if ((*x)->involves (ar)) {
 
                        if (find (updated.begin(), updated.end(), *x) == updated.end()) {
-                               if ((*x)->refresh ()) {
-                                       /* not invalidated by the refresh */
-                                       updated.insert (*x);
+                               try { 
+                                       if ((*x)->refresh ()) {
+                                               updated.insert (*x);
+                                       }
+                               }
+
+                               catch (Crossfade::NoCrossfadeHere& err) {
+                                       // relax, Invalidated during refresh
                                }
                        }
                }
@@ -313,29 +300,29 @@ AudioPlaylist::finalize_split_region (boost::shared_ptr<Region> o, boost::shared
                tmp = x;
                ++tmp;
 
-               Crossfade *fade = 0;
+               boost::shared_ptr<Crossfade> fade;
                
                if ((*x)->_in == orig) {
                        if (! (*x)->covers(right->position())) {
-                               fade = new Crossfade (**x, left, (*x)->_out);
+                               fade = boost::shared_ptr<Crossfade> (new Crossfade (*x, left, (*x)->_out));
                        } else {
                                // Overlap, the crossfade is copied on the left side of the right region instead
-                               fade = new Crossfade (**x, right, (*x)->_out);
+                               fade = boost::shared_ptr<Crossfade> (new Crossfade (*x, right, (*x)->_out));
                        }
                }
                
                if ((*x)->_out == orig) {
                        if (! (*x)->covers(right->position())) {
-                               fade = new Crossfade (**x, (*x)->_in, right);
+                               fade = boost::shared_ptr<Crossfade> (new Crossfade (*x, (*x)->_in, right));
                        } else {
                                // Overlap, the crossfade is copied on the right side of the left region instead
-                               fade = new Crossfade (**x, (*x)->_in, left);
+                               fade = boost::shared_ptr<Crossfade> (new Crossfade (*x, (*x)->_in, left));
                        }
                }
                
                if (fade) {
                        _crossfades.remove (*x);
-                       add_crossfade (*fade);
+                       add_crossfade (fade);
                }
                x = tmp;
        }
@@ -348,7 +335,7 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
        boost::shared_ptr<AudioRegion> region;
        boost::shared_ptr<AudioRegion> top;
        boost::shared_ptr<AudioRegion> bottom;
-       Crossfade*   xfade;
+       boost::shared_ptr<Crossfade>   xfade;
 
        if (in_set_state || in_partition) {
                return;
@@ -364,12 +351,15 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
                refresh_dependents (r);
        }
 
+
        if (!Config->get_auto_xfade()) {
                return;
        }
 
        for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 
+               nframes_t xfade_length;
+
                other = boost::dynamic_pointer_cast<AudioRegion> (*i);
 
                if (other == region) {
@@ -379,6 +369,7 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
                if (other->muted() || region->muted()) {
                        continue;
                }
+               
 
                if (other->layer() < region->layer()) {
                        top = region;
@@ -388,43 +379,56 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
                        bottom = region;
                }
 
+
+
+               OverlapType c = top->coverage (bottom->position(), bottom->last_frame());
+
                try {
+                       switch (c) {
+                       case OverlapNone:
+                               break;
+
+                       case OverlapInternal:
+                                /* {=============== top  =============}
+                                 *     [ ----- bottom  ------- ]
+                                 */
+                               break;
+
+                       case OverlapExternal:
+
+                               /*     [ -------- top ------- ]
+                                * {=========== bottom =============}
+                                */
                                
-                       if (top->coverage (bottom->position(), bottom->last_frame()) != OverlapNone) {
+                               /* to avoid discontinuities at the region boundaries of an internal
+                                  overlap (this region is completely within another), we create
+                                  two hidden crossfades at each boundary. this is not dependent
+                                  on the auto-xfade option, because we require it as basic
+                                  audio engineering.
+                               */
                                
-                               /* check if the upper region is within the lower region */
+                               xfade_length = min ((nframes_t) 720, top->length());
                                
-                               if (top->first_frame() > bottom->first_frame() &&
-                                   top->last_frame() < bottom->last_frame()) {
-                                       
-                                       
-                                       /*     [ -------- top ------- ]
-                                        * {=========== bottom =============}
-                                        */
-                                       
-                                       /* to avoid discontinuities at the region boundaries of an internal
-                                          overlap (this region is completely within another), we create
-                                          two hidden crossfades at each boundary. this is not dependent
-                                          on the auto-xfade option, because we require it as basic
-                                          audio engineering.
+                               xfade = boost::shared_ptr<Crossfade> (new Crossfade (top, bottom, xfade_length, top->first_frame(), StartOfIn));
+                               add_crossfade (xfade);
+
+                               if (top_region_at (top->last_frame() - 1) == top) {
+                                       /* 
+                                          only add a fade out if there is no region on top of the end of 'top' (which 
+                                          would cover it).
                                        */
                                        
-                                       nframes_t xfade_length = min ((nframes_t) 720, top->length());
-                                       
-                                                           /*  in,      out */
-                                       xfade = new Crossfade (top, bottom, xfade_length, top->first_frame(), StartOfIn);
-                                       add_crossfade (*xfade);
-                                       xfade = new Crossfade (bottom, top, xfade_length, top->last_frame() - xfade_length, EndOfOut);
-                                       add_crossfade (*xfade);
-                                       
-                               } else {
-
-                                       xfade = new Crossfade (other, region, Config->get_xfade_model(), Config->get_xfades_active());
-                                       add_crossfade (*xfade);
+                                       xfade = boost::shared_ptr<Crossfade> (new Crossfade (bottom, top, xfade_length, top->last_frame() - xfade_length, EndOfOut));
+                                       add_crossfade (xfade);
                                }
-                       } 
+                               break;
+                               
+                       default:
+                               xfade = boost::shared_ptr<Crossfade> (new Crossfade (region, other, Config->get_xfade_model(), Config->get_xfades_active()));
+                               add_crossfade (xfade);
+                       }
                }
-               
+
                catch (failed_constructor& err) {
                        continue;
                }
@@ -437,29 +441,29 @@ AudioPlaylist::check_dependents (boost::shared_ptr<Region> r, bool norefresh)
 }
 
 void
-AudioPlaylist::add_crossfade (Crossfade& xfade)
+AudioPlaylist::add_crossfade (boost::shared_ptr<Crossfade> xfade)
 {
        Crossfades::iterator ci;
 
        for (ci = _crossfades.begin(); ci != _crossfades.end(); ++ci) {
-               if (*(*ci) == xfade) { // Crossfade::operator==()
+               if (*(*ci) == *xfade) { // Crossfade::operator==()
                        break;
                }
        }
        
        if (ci != _crossfades.end()) {
-               delete &xfade;
+               // it will just go away
        } else {
-               _crossfades.push_back (&xfade);
+               _crossfades.push_back (xfade);
 
-               xfade.Invalidated.connect (mem_fun (*this, &AudioPlaylist::crossfade_invalidated));
-               xfade.StateChanged.connect (mem_fun (*this, &AudioPlaylist::crossfade_changed));
+               xfade->Invalidated.connect (mem_fun (*this, &AudioPlaylist::crossfade_invalidated));
+               xfade->StateChanged.connect (mem_fun (*this, &AudioPlaylist::crossfade_changed));
 
-               notify_crossfade_added (&xfade);
+               notify_crossfade_added (xfade);
        }
 }
        
-void AudioPlaylist::notify_crossfade_added (Crossfade *x)
+void AudioPlaylist::notify_crossfade_added (boost::shared_ptr<Crossfade> x)
 {
        if (g_atomic_int_get(&block_notifications)) {
                _pending_xfade_adds.insert (_pending_xfade_adds.end(), x);
@@ -469,9 +473,10 @@ void AudioPlaylist::notify_crossfade_added (Crossfade *x)
 }
 
 void
-AudioPlaylist::crossfade_invalidated (Crossfade* xfade)
+AudioPlaylist::crossfade_invalidated (boost::shared_ptr<Region> r)
 {
        Crossfades::iterator i;
+       boost::shared_ptr<Crossfade> xfade = boost::dynamic_pointer_cast<Crossfade> (r);
 
        xfade->in()->resume_fade_in ();
        xfade->out()->resume_fade_out ();
@@ -488,6 +493,9 @@ AudioPlaylist::set_state (const XMLNode& node)
        XMLNodeList nlist;
        XMLNodeConstIterator niter;
 
+       in_set_state++;
+       freeze ();
+
        Playlist::set_state (node);
 
        nlist = node.children();
@@ -501,7 +509,7 @@ AudioPlaylist::set_state (const XMLNode& node)
                }
 
                try {
-                       Crossfade* xfade = new Crossfade (*((const Playlist *)this), *child);
+                       boost::shared_ptr<Crossfade> xfade = boost::shared_ptr<Crossfade> (new Crossfade (*((const Playlist *)this), *child));
                        _crossfades.push_back (xfade);
                        xfade->Invalidated.connect (mem_fun (*this, &AudioPlaylist::crossfade_invalidated));
                        xfade->StateChanged.connect (mem_fun (*this, &AudioPlaylist::crossfade_changed));
@@ -516,25 +524,16 @@ AudioPlaylist::set_state (const XMLNode& node)
                }
        }
 
+       thaw ();
+       in_set_state--;
+
        return 0;
 }
 
 void
 AudioPlaylist::clear (bool with_signals)
 {
-       for (Crossfades::iterator i = _crossfades.begin(); i != _crossfades.end(); ) {
-
-               Crossfades::iterator tmp;
-               tmp = i;
-               ++tmp;
-
-               delete *i;
-
-               i = tmp;
-       }
-
        _crossfades.clear ();
-       
        Playlist::clear (with_signals);
 }
 
@@ -556,7 +555,7 @@ void
 AudioPlaylist::dump () const
 {
        boost::shared_ptr<Region>r;
-       Crossfade *x;
+       boost::shared_ptr<Crossfade> x;
 
        cerr << "Playlist \"" << _name << "\" " << endl
             << regions.size() << " regions "
@@ -596,7 +595,7 @@ AudioPlaylist::destroy_region (boost::shared_ptr<Region> region)
        boost::shared_ptr<AudioRegion> r = boost::dynamic_pointer_cast<AudioRegion> (region);
        bool changed = false;
        Crossfades::iterator c, ctmp;
-       set<Crossfade*> unique_xfades;
+       set<boost::shared_ptr<Crossfade> > unique_xfades;
 
        if (r == 0) {
                fatal << _("programming error: non-audio Region passed to remove_overlap in audio playlist")
@@ -607,12 +606,10 @@ AudioPlaylist::destroy_region (boost::shared_ptr<Region> region)
 
        { 
                RegionLock rlock (this);
-               RegionList::iterator i;
-               RegionList::iterator tmp;
 
-               for (i = regions.begin(); i != regions.end(); ) {
+               for (RegionList::iterator i = regions.begin(); i != regions.end(); ) {
                        
-                       tmp = i;
+                       RegionList::iterator tmp = i;
                        ++tmp;
                        
                        if ((*i) == region) {
@@ -622,6 +619,21 @@ AudioPlaylist::destroy_region (boost::shared_ptr<Region> region)
                        
                        i = tmp;
                }
+
+               for (set<boost::shared_ptr<Region> >::iterator x = all_regions.begin(); x != all_regions.end(); ) {
+
+                       set<boost::shared_ptr<Region> >::iterator xtmp = x;
+                       ++xtmp;
+                       
+                       if ((*x) == region) {
+                               all_regions.erase (x);
+                               changed = true;
+                       }
+                       
+                       x = xtmp;
+               }
+
+               region->set_playlist (boost::shared_ptr<Playlist>());
        }
 
        for (c = _crossfades.begin(); c != _crossfades.end(); ) {
@@ -636,10 +648,6 @@ AudioPlaylist::destroy_region (boost::shared_ptr<Region> region)
                c = ctmp;
        }
 
-       for (set<Crossfade*>::iterator c = unique_xfades.begin(); c != unique_xfades.end(); ++c) {
-               delete *c;
-       }
-
        if (changed) {
                /* overload this, it normally means "removed", not destroyed */
                notify_region_removed (region);