minor but important fix for the wrap-buffer case in a recording audio diskstream
[ardour.git] / libs / ardour / crossfade.cc
index 65ad1e25fbbe4d008aaf8f893737bf98f535aa21..dc8d3e3c526f2ec6c2332bb2f9f6ccb13d73e5a0 100644 (file)
 
 */
 
-#include <sigc++/bind.h>
-
-#include "pbd/stacktrace.h"
-
+#include "ardour/debug.h"
 #include "ardour/types.h"
 #include "ardour/crossfade.h"
-#include "ardour/crossfade_compare.h"
 #include "ardour/audioregion.h"
 #include "ardour/playlist.h"
 #include "ardour/utils.h"
 #include "ardour/session.h"
 #include "ardour/source.h"
+#include "ardour/region_factory.h"
 
 #include "i18n.h"
 #include <locale.h>
@@ -37,9 +34,7 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-nframes_t Crossfade::_short_xfade_length = 0;
-Change Crossfade::ActiveChanged = new_change();
-Change Crossfade::FollowOverlapChanged = new_change();
+framecnt_t Crossfade::_short_xfade_length = 0;
 
 /* XXX if and when we ever implement parallel processing of the process()
    callback, these will need to be handled on a per-thread basis.
@@ -48,8 +43,27 @@ Change Crossfade::FollowOverlapChanged = new_change();
 Sample* Crossfade::crossfade_buffer_out = 0;
 Sample* Crossfade::crossfade_buffer_in = 0;
 
+
+#define CROSSFADE_DEFAULT_PROPERTIES \
+       _active (Properties::active, _session.config.get_xfades_active ()) \
+       , _follow_overlap (Properties::follow_overlap, false)
+
+
+namespace ARDOUR {
+       namespace Properties {
+               PropertyDescriptor<bool> follow_overlap;
+       }
+}
+
+void
+Crossfade::make_property_quarks ()
+{
+       Properties::follow_overlap.property_id = g_quark_from_static_string (X_("follow-overlap"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for follow-overlap = %1\n",     Properties::follow_overlap.property_id));
+}
+
 void
-Crossfade::set_buffer_size (nframes_t sz)
+Crossfade::set_buffer_size (framecnt_t sz)
 {
        delete [] crossfade_buffer_out;
        crossfade_buffer_out = 0;
@@ -70,29 +84,29 @@ Crossfade::operator== (const Crossfade& other)
 }
 
 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> in, boost::shared_ptr<AudioRegion> out,
-                     nframes_t length,
-                     nframes_t position,
+                     framecnt_t length,
+                     framepos_t position,
                      AnchorPoint ap)
-       : AudioRegion (in->session(), position, length, "foobar"),
-         _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
-         _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
+       : AudioRegion (in->session(), position, length, in->name() + string ("<>") + out->name())
+       , CROSSFADE_DEFAULT_PROPERTIES
+       , _fade_in (Evoral::Parameter(FadeInAutomation)) // linear (gain coefficient) => -inf..+6dB
+       , _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
 
 {
        _in = in;
        _out = out;
        _anchor_point = ap;
-       _follow_overlap = false;
-
-       _active = _session.config.get_xfades_active ();
        _fixed = true;
+        _follow_overlap = false;
 
        initialize ();
 }
 
 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model, bool act)
-       : AudioRegion (a->session(), 0, 0, "foobar"),
-         _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
-         _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
+       : AudioRegion (a->session(), 0, 0, a->name() + string ("<>") + b->name())
+       , CROSSFADE_DEFAULT_PROPERTIES
+       , _fade_in (Evoral::Parameter(FadeInAutomation)) // linear (gain coefficient) => -inf..+6dB
+       , _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
 {
        _in_update = false;
        _fixed = false;
@@ -107,14 +121,15 @@ Crossfade::Crossfade (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioR
        initialize ();
 }
 
-Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
-       : AudioRegion (playlist.session(), 0, 0, "foobar"),
-         _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
-         _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
+Crossfade::Crossfade (const Playlist& playlist, XMLNode const & node)
+       : AudioRegion (playlist.session(), 0, 0, "unnamed crossfade")
+       , CROSSFADE_DEFAULT_PROPERTIES
+       , _fade_in (Evoral::Parameter(FadeInAutomation)) // linear (gain coefficient) => -inf..+6dB
+       , _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
 
 {
        boost::shared_ptr<Region> r;
-       XMLProperty* prop;
+       XMLProperty const * prop;
        LocaleGuard lg (X_("POSIX"));
 
        /* we have to find the in/out regions before we can do anything else */
@@ -126,8 +141,17 @@ Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
 
        PBD::ID id (prop->value());
 
-       if ((r = playlist.find_region (id)) == 0) {
-               error << string_compose (_("Crossfade: no \"in\" region %1 found in playlist %2"), id, playlist.name())
+       r = playlist.find_region (id);
+
+       if (!r) {
+               /* the `in' region is not in a playlist, which probably means that this crossfade
+                  is in the undo record, so we have to find the region in the global region map.
+               */
+               r = RegionFactory::region_by_id (id);
+       }
+
+       if (!r) {
+               error << string_compose (_("Crossfade: no \"in\" region %1 found in playlist %2 nor in region map"), id, playlist.name())
                      << endmsg;
                throw failed_constructor();
        }
@@ -143,8 +167,14 @@ Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
 
        PBD::ID id2 (prop->value());
 
-       if ((r = playlist.find_region (id2)) == 0) {
-               error << string_compose (_("Crossfade: no \"out\" region %1 found in playlist %2"), id2, playlist.name())
+       r = playlist.find_region (id2);
+
+       if (!r) {
+               r = RegionFactory::region_by_id (id2);
+       }
+
+       if (!r) {
+               error << string_compose (_("Crossfade: no \"out\" region %1 found in playlist %2 nor in region map"), id2, playlist.name())
                      << endmsg;
                throw failed_constructor();
        }
@@ -157,15 +187,16 @@ Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
        initialize();
        _active = true;
 
-       if (set_state (node)) {
+       if (set_state (node, Stateful::loading_state_version)) {
                throw failed_constructor();
        }
 }
 
 Crossfade::Crossfade (boost::shared_ptr<Crossfade> orig, boost::shared_ptr<AudioRegion> newin, boost::shared_ptr<AudioRegion> newout)
-       : AudioRegion (boost::dynamic_pointer_cast<const AudioRegion> (orig)),
-         _fade_in (orig->_fade_in),
-         _fade_out (orig->_fade_out)
+       : AudioRegion (boost::dynamic_pointer_cast<const AudioRegion> (orig), 0)
+       , CROSSFADE_DEFAULT_PROPERTIES
+       , _fade_in (orig->_fade_in)
+       , _fade_out (orig->_fade_out)
 {
        _active           = orig->_active;
        _in_update        = orig->_in_update;
@@ -192,7 +223,6 @@ Crossfade::Crossfade (boost::shared_ptr<Crossfade> orig, boost::shared_ptr<Audio
 
 Crossfade::~Crossfade ()
 {
-       notify_callbacks ();
 }
 
 void
@@ -202,9 +232,18 @@ Crossfade::initialize ()
 
        _sources = _in->sources();
        _sources.insert (_sources.end(), _out->sources().begin(), _out->sources().end());
+
+        for (SourceList::iterator i = _sources.begin(); i != _sources.end(); ++i) {
+                (*i)->inc_use_count ();
+        }
+
        _master_sources = _in->master_sources();
        _master_sources.insert(_master_sources.end(), _out->master_sources().begin(), _out->master_sources().end());
 
+        for (SourceList::iterator i = _master_sources.begin(); i != _master_sources.end(); ++i) {
+                (*i)->inc_use_count ();
+        }
+
        _in_update = false;
 
        _out->suspend_fade_out ();
@@ -269,32 +308,27 @@ Crossfade::initialize ()
        layer_relation = (int32_t) (_in->layer() - _out->layer());
 }
 
-nframes_t
-Crossfade::read_raw_internal (Sample* /*buf*/, sframes_t /*start*/, nframes_t cnt, int /*channel*/) const
+framecnt_t
+Crossfade::read_raw_internal (Sample* buf, framecnt_t start, framecnt_t cnt, int channel) const
 {
-       // FIXME: Why is this disabled?
-#if 0
        Sample* mixdown = new Sample[cnt];
        float* gain = new float[cnt];
-       nframes_t ret;
+       framecnt_t ret;
 
-       ret = read_at (buf, mixdown, gain, start, cnt, chan_n, cnt);
+       ret = read_at (buf, mixdown, gain, start, cnt, channel);
 
        delete [] mixdown;
        delete [] gain;
 
        return ret;
-#endif
-       return cnt;
 }
 
-nframes_t
+framecnt_t
 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
-                   float *gain_buffer, sframes_t start, nframes_t cnt, uint32_t chan_n,
-                   nframes_t read_frames, nframes_t skip_frames) const
+                   float *gain_buffer, framepos_t start, framecnt_t cnt, uint32_t chan_n) const
 {
-       nframes_t offset;
-       nframes_t to_write;
+       frameoffset_t offset;
+       framecnt_t to_write;
 
        if (!_active) {
                return 0;
@@ -316,11 +350,11 @@ Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
 
                start = _position;
                buf += offset;
-               to_write = min (_length, cnt);
+               to_write = min (_length.val(), cnt);
 
        } else {
 
-               to_write = min (nframes_t(_length - (start - _position)), cnt);
+               to_write = min ((_length - (start - _position)), cnt);
 
        }
 
@@ -333,8 +367,8 @@ Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
                memset (crossfade_buffer_in, 0, sizeof (Sample) * to_write);
        }
 
-       _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
-       _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
+       _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n);
+       _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n);
 
        float* fiv = new float[to_write];
        float* fov = new float[to_write];
@@ -348,7 +382,7 @@ Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
           position and length, and so we know precisely how much data they could return.
        */
 
-       for (nframes_t n = 0; n < to_write; ++n) {
+       for (framecnt_t n = 0; n < to_write; ++n) {
                buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
        }
 
@@ -359,9 +393,9 @@ Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
 }
 
 OverlapType
-Crossfade::coverage (nframes_t start, nframes_t end) const
+Crossfade::coverage (framepos_t start, framepos_t end) const
 {
-       nframes_t my_end = _position + _length;
+       framepos_t my_end = _position + _length;
 
        if ((start >= _position) && (end <= my_end)) {
                return OverlapInternal;
@@ -383,7 +417,7 @@ Crossfade::set_active (bool yn)
 {
        if (_active != yn) {
                _active = yn;
-               StateChanged (ActiveChanged);
+               PropertyChanged (PropertyChange (Properties::active));
        }
 }
 
@@ -404,6 +438,13 @@ Crossfade::refresh ()
                return false;
        }
 
+        /* regions must cannot be identically sized and placed */
+
+        if (_in->position() == _out->position() && _in->length() == _out->length()) {
+               Invalidated (shared_from_this());
+                return false;
+        }
+
        /* layer ordering cannot change */
 
        int32_t new_layer_relation = (int32_t) (_in->layer() - _out->layer());
@@ -448,7 +489,11 @@ Crossfade::refresh ()
        }
 
        if (send_signal) {
-               StateChanged (BoundsChanged); /* EMIT SIGNAL */
+               PropertyChange bounds;
+               bounds.add (Properties::start);
+               bounds.add (Properties::position);
+               bounds.add (Properties::length);
+               PropertyChanged (bounds); /* EMIT SIGNAL */
        }
 
        _in_update = false;
@@ -459,7 +504,7 @@ Crossfade::refresh ()
 bool
 Crossfade::update ()
 {
-       nframes_t newlen;
+       framecnt_t newlen;
 
        if (_follow_overlap) {
                newlen = _out->first_frame() + _out->length() - _in->first_frame();
@@ -505,7 +550,7 @@ Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioReg
 {
        boost::shared_ptr<AudioRegion> top;
        boost::shared_ptr<AudioRegion> bottom;
-       nframes_t short_xfade_length;
+       framecnt_t short_xfade_length;
 
        short_xfade_length = _short_xfade_length;
 
@@ -541,8 +586,8 @@ Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioReg
                        } else {
                                _position = top->last_frame() - short_xfade_length;
                        }
-
-                       _length = min (short_xfade_length, top->length());
+                       
+                       set_xfade_length (min (short_xfade_length, top->length()));
                        _follow_overlap = false;
                        _anchor_point = EndOfIn;
                        _active = true;
@@ -576,7 +621,7 @@ Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioReg
                        _in = top;
                        _out = bottom;
                        _position = top->first_frame();
-                       _length = min (short_xfade_length, top->length());
+                       set_xfade_length (min (short_xfade_length, top->length()));
                        _follow_overlap = false;
                        _anchor_point = StartOfIn;
                        _active = true;
@@ -625,11 +670,11 @@ Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioReg
 
                        if (model == FullCrossfade) {
                                _position = bottom->first_frame(); // "{"
-                               _length = _out->first_frame() + _out->length() - _in->first_frame();
+                               set_xfade_length (_out->first_frame() + _out->length() - _in->first_frame());
                                /* leave active alone */
                                _follow_overlap = true;
                        } else {
-                               _length = min (short_xfade_length, top->length());
+                               set_xfade_length (min (short_xfade_length, top->length()));
                                _position = top->last_frame() - _length;  // "]" - length
                                _active = true;
                                _follow_overlap = false;
@@ -649,11 +694,11 @@ Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioReg
                        _anchor_point = StartOfIn;
 
                        if (model == FullCrossfade) {
-                               _length = _out->first_frame() + _out->length() - _in->first_frame();
+                               set_xfade_length (_out->first_frame() + _out->length() - _in->first_frame());
                                /* leave active alone */
                                _follow_overlap = true;
                        } else {
-                               _length = min (short_xfade_length, top->length());
+                               set_xfade_length (min (short_xfade_length, top->length()));
                                _active = true;
                                _follow_overlap = false;
 
@@ -674,6 +719,8 @@ Crossfade::get_state ()
        char buf[64];
        LocaleGuard lg (X_("POSIX"));
 
+       id().print (buf, sizeof (buf));
+       node->add_property ("id", buf);
        _out->id().print (buf, sizeof (buf));
        node->add_property ("out", buf);
        _in->id().print (buf, sizeof (buf));
@@ -681,11 +728,11 @@ Crossfade::get_state ()
        node->add_property ("active", (_active ? "yes" : "no"));
        node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
        node->add_property ("fixed", (_fixed ? "yes" : "no"));
-       snprintf (buf, sizeof(buf), "%" PRIu32, _length);
+       snprintf (buf, sizeof(buf), "%" PRId64, _length.val());
        node->add_property ("length", buf);
        snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
        node->add_property ("anchor-point", buf);
-       snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
+       snprintf (buf, sizeof(buf), "%" PRId64, _position.val());
        node->add_property ("position", buf);
 
        child = node->add_child ("FadeIn");
@@ -695,7 +742,7 @@ Crossfade::get_state ()
 
                pnode = new XMLNode ("point");
 
-               snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
+               snprintf (buf, sizeof (buf), "%" PRId64, (framepos_t) floor ((*ii)->when));
                pnode->add_property ("x", buf);
                snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
                pnode->add_property ("y", buf);
@@ -709,7 +756,7 @@ Crossfade::get_state ()
 
                pnode = new XMLNode ("point");
 
-               snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
+               snprintf (buf, sizeof (buf), "%" PRId64, (framepos_t) floor ((*ii)->when));
                pnode->add_property ("x", buf);
                snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
                pnode->add_property ("y", buf);
@@ -720,7 +767,7 @@ Crossfade::get_state ()
 }
 
 int
-Crossfade::set_state (const XMLNode& node, int version)
+Crossfade::set_state (const XMLNode& node, int /*version*/)
 {
        XMLNodeConstIterator i;
        XMLNodeList children;
@@ -728,14 +775,18 @@ Crossfade::set_state (const XMLNode& node, int version)
        XMLNode* fo;
        const XMLProperty* prop;
        LocaleGuard lg (X_("POSIX"));
-       Change what_changed = Change (0);
-       nframes_t val;
+       PropertyChange what_changed;
+       framepos_t val;
+
+       if ((prop = node.property (X_("id")))) {
+               _id = prop->value();
+       }
 
        if ((prop = node.property ("position")) != 0) {
-               sscanf (prop->value().c_str(), "%" PRIu32, &val);
+               sscanf (prop->value().c_str(), "%" PRId64, &val);
                if (val != _position) {
                        _position = val;
-                       what_changed = Change (what_changed | PositionChanged);
+                       what_changed.add (Properties::position);
                }
        } else {
                warning << _("old-style crossfade information - no position information") << endmsg;
@@ -746,7 +797,7 @@ Crossfade::set_state (const XMLNode& node, int version)
                bool x = string_is_affirmative (prop->value());
                if (x != _active) {
                        _active = x;
-                       what_changed = Change (what_changed | ActiveChanged);
+                       what_changed.add (Properties::active);
                }
        } else {
                _active = true;
@@ -772,10 +823,10 @@ Crossfade::set_state (const XMLNode& node, int version)
 
        if ((prop = node.property ("length")) != 0) {
 
-               sscanf (prop->value().c_str(), "%" PRIu32, &val);
+               sscanf (prop->value().c_str(), "%" PRId64, &val);
                if (val != _length) {
-                       _length = atol (prop->value().c_str());
-                       what_changed = Change (what_changed | LengthChanged);
+                       _length = val;
+                       what_changed.add (Properties::length);
                }
 
        } else {
@@ -806,11 +857,11 @@ Crossfade::set_state (const XMLNode& node, int version)
 
        for (i = children.begin(); i != children.end(); ++i) {
                if ((*i)->name() == "point") {
-                       nframes_t x;
+                       framepos_t x;
                        float y;
 
                        prop = (*i)->property ("x");
-                       sscanf (prop->value().c_str(), "%" PRIu32, &x);
+                       sscanf (prop->value().c_str(), "%" PRId64, &x);
 
                        prop = (*i)->property ("y");
                        sscanf (prop->value().c_str(), "%f", &y);
@@ -819,6 +870,14 @@ Crossfade::set_state (const XMLNode& node, int version)
                }
        }
 
+        if (_fade_in.size() < 2) {
+                /* fade state somehow saved with no points */
+                return -1;
+        }
+
+        _fade_in.front()->value = 0.0;
+        _fade_in.back()->value = 1.0;
+
        _fade_in.thaw ();
 
         /* fade out */
@@ -830,12 +889,12 @@ Crossfade::set_state (const XMLNode& node, int version)
 
        for (i = children.begin(); i != children.end(); ++i) {
                if ((*i)->name() == "point") {
-                       nframes_t x;
+                       framepos_t x;
                        float y;
                        XMLProperty* prop;
 
                        prop = (*i)->property ("x");
-                       sscanf (prop->value().c_str(), "%" PRIu32, &x);
+                       sscanf (prop->value().c_str(), "%" PRId64, &x);
 
                        prop = (*i)->property ("y");
                        sscanf (prop->value().c_str(), "%f", &y);
@@ -844,9 +903,18 @@ Crossfade::set_state (const XMLNode& node, int version)
                }
        }
 
+        if (_fade_out.size() < 2) {
+                /* fade state somehow saved with no points */
+                return -1;
+        }
+
+        _fade_out.front()->value = 1.0;
+        _fade_out.back()->value = 0.0;
+
        _fade_out.thaw ();
 
-       StateChanged (what_changed); /* EMIT SIGNAL */
+       PropertyChanged (what_changed); /* EMIT SIGNAL */
+       FadesChanged (); /* EMIT SIGNAL */
 
        return 0;
 }
@@ -872,13 +940,13 @@ Crossfade::set_follow_overlap (bool yn)
                set_xfade_length (_out->first_frame() + _out->length() - _in->first_frame());
        }
 
-       StateChanged (FollowOverlapChanged);
+       PropertyChanged (PropertyChange (Properties::follow_overlap));
 }
 
-nframes_t
-Crossfade::set_xfade_length (nframes_t len)
+framecnt_t
+Crossfade::set_xfade_length (framecnt_t len)
 {
-       nframes_t limit = 0;
+       framecnt_t limit = 0;
 
        switch (_anchor_point) {
        case StartOfIn:
@@ -906,12 +974,12 @@ Crossfade::set_xfade_length (nframes_t len)
 
        _length = len;
 
-       StateChanged (LengthChanged);
+       PropertyChanged (PropertyChange (Properties::length));
 
        return len;
 }
 
-nframes_t
+framecnt_t
 Crossfade::overlap_length () const
 {
        if (_fixed) {
@@ -921,7 +989,7 @@ Crossfade::overlap_length () const
 }
 
 void
-Crossfade::set_short_xfade_length (nframes_t n)
+Crossfade::set_short_xfade_length (framecnt_t n)
 {
        _short_xfade_length = n;
 }