use a note tracker to resolve notes cut off during render by the end of the region
[ardour.git] / libs / ardour / rb_effect.cc
index e31cebe6021f3bbda6625a7151331956aca6ef6d..e2807b2b98c94eee006ab8f413047ed990dcb82c 100644 (file)
@@ -1,36 +1,40 @@
 /*
-    Copyright (C) 2004-2007 Paul Davis
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2008-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2008-2014 David Robillard <d@drobilla.net>
+ * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2019 Robin Gareus <robin@gareus.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #include <algorithm>
 #include <cmath>
 
+#include <rubberband/RubberBandStretcher.h>
+
 #include "pbd/error.h"
-#include "rubberband/RubberBandStretcher.h"
 
-#include "ardour/types.h"
-#include "ardour/stretch.h"
+#include "ardour/audioregion.h"
+#include "ardour/audiosource.h"
 #include "ardour/pitch.h"
-#include "ardour/audiofilesource.h"
+#include "ardour/progress.h"
 #include "ardour/session.h"
-#include "ardour/audioregion.h"
+#include "ardour/stretch.h"
+#include "ardour/types.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -52,7 +56,7 @@ RBEffect::RBEffect (Session& s, TimeFXRequest& req)
        , tsr (req)
 
 {
-       tsr.progress = 0.0f;
+
 }
 
 RBEffect::~RBEffect ()
@@ -60,7 +64,7 @@ RBEffect::~RBEffect ()
 }
 
 int
-RBEffect::run (boost::shared_ptr<Region> r, Progress*)
+RBEffect::run (boost::shared_ptr<Region> r, Progress* progress)
 {
        boost::shared_ptr<AudioRegion> region = boost::dynamic_pointer_cast<AudioRegion> (r);
 
@@ -70,18 +74,15 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
        }
 
        SourceList nsrcs;
-       nframes_t done;
        int ret = -1;
-       const nframes_t bufsize = 256;
+       const samplecnt_t bufsize = 256;
        gain_t* gain_buffer = 0;
        Sample** buffers = 0;
        char suffix[32];
        string new_name;
        string::size_type at;
-       nframes_t pos = 0;
-       int avail = 0;
        boost::shared_ptr<AudioRegion> result;
-       
+
        cerr << "RBEffect: source region: position = " << region->position()
             << ", start = " << region->start()
             << ", length = " << region->length()
@@ -95,11 +96,11 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
           1. The region has not been stretched before.
 
-          In this case, we just want to read region->length() frames
+          In this case, we just want to read region->length() samples
           from region->start().
 
           We will create a new region of region->length() *
-          tsr.time_fraction frames.  The new region will have its
+          tsr.time_fraction samples.  The new region will have its
           start set to 0 (because it has a new audio file that begins
           at the start of the stretched area) and its ancestral_start
           set to region->start() (so that we know where to begin
@@ -107,25 +108,25 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
           2. The region has been stretched before.
 
-          The region starts at region->start() frames into its
+          The region starts at region->start() samples into its
           (possibly previously stretched) source file.  But we don't
           want to read from its source file; we want to read from the
           file it was originally stretched from.
 
           The region's source begins at region->ancestral_start()
-          frames into its master source file.  Thus, we need to start
+          samples into its master source file.  Thus, we need to start
           reading at region->ancestral_start() + (region->start() /
-          region->stretch()) frames into the master source.  This
+          region->stretch()) samples into the master source.  This
           value will also become the ancestral_start for the new
           region.
 
           We cannot use region->ancestral_length() to establish how
-          many frames to read, because it won't be up to date if the
+          many samples to read, because it won't be up to date if the
           region has been trimmed since it was last stretched.  We
-          must read region->length() / region->stretch() frames and
+          must read region->length() / region->stretch() samples and
           stretch them by tsr.time_fraction * region->stretch(), for
           a new region of region->length() * tsr.time_fraction
-          frames.
+          samples.
 
           Case 1 is of course a special case of 2, where
           region->ancestral_start() == 0 and region->stretch() == 1.
@@ -136,7 +137,7 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
           region->start().  This calculation is used regardless of
           whether we are reading from a master or
           previously-stretched region.  In order to read from a point
-          n frames into the master source, we need to provide n -
+          n samples into the master source, we need to provide n -
           region->start() + region->position() as our position
           argument to master_read_at().
 
@@ -148,19 +149,19 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
        double stretch = region->stretch() * tsr.time_fraction;
        double shift = region->shift() * tsr.pitch_fraction;
 
-       nframes_t read_start = region->ancestral_start() +
-               nframes_t(region->start() / (double)region->stretch());
+       samplecnt_t read_start = region->ancestral_start() +
+               samplecnt_t(region->start() / (double)region->stretch());
 
-       nframes_t read_duration =
-               nframes_t(region->length() / (double)region->stretch());
+       samplecnt_t read_duration =
+               samplecnt_t(region->length() / (double)region->stretch());
 
        uint32_t channels = region->n_channels();
 
        RubberBandStretcher stretcher
-               (session.frame_rate(), channels,
+               (session.sample_rate(), channels,
                 (RubberBandStretcher::Options) tsr.opts, stretch, shift);
 
-       tsr.progress = 0.0f;
+       progress->set_progress (0);
        tsr.done = false;
 
        stretcher.setExpectedInputDuration(read_duration);
@@ -182,6 +183,10 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
        /* create new sources */
 
+       samplepos_t pos   = 0;
+       samplecnt_t avail = 0;
+       samplecnt_t done  = 0;
+
        if (make_new_sources (region, nsrcs, suffix)) {
                goto out;
        }
@@ -199,23 +204,17 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
        /* study first, process afterwards. */
 
-       pos = 0;
-       avail = 0;
-       done = 0;
-
        try {
                while (pos < read_duration && !tsr.cancel) {
 
-                       nframes_t this_read = 0;
+                       samplecnt_t this_read = 0;
 
                        for (uint32_t i = 0; i < channels; ++i) {
 
-                               this_read = 0;
-
-                               nframes_t this_time;
+                               samplepos_t this_time;
                                this_time = min(bufsize, read_duration - pos);
 
-                               nframes_t this_position;
+                               samplepos_t this_position;
                                this_position = read_start + pos -
                                        region->start() + region->position();
 
@@ -238,7 +237,7 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
                        pos += this_read;
                        done += this_read;
 
-                       tsr.progress = ((float) done / read_duration) * 0.25;
+                       progress->set_progress (((float) done / read_duration) * 0.25);
 
                        stretcher.study(buffers, this_read, pos == read_duration);
                }
@@ -248,15 +247,14 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
                while (pos < read_duration && !tsr.cancel) {
 
-                       nframes_t this_read = 0;
+                       samplecnt_t this_read = 0;
 
                        for (uint32_t i = 0; i < channels; ++i) {
 
-                               this_read = 0;
-                               nframes_t this_time;
+                               samplepos_t this_time;
                                this_time = min(bufsize, read_duration - pos);
 
-                               nframes_t this_position;
+                               samplepos_t this_position;
                                this_position = read_start + pos -
                                        region->start() + region->position();
 
@@ -279,15 +277,15 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
                        pos += this_read;
                        done += this_read;
 
-                       tsr.progress = 0.25 + ((float) done / read_duration) * 0.75;
+                       progress->set_progress (0.25 + ((float) done / read_duration) * 0.75);
 
                        stretcher.process(buffers, this_read, pos == read_duration);
 
-                       int avail = 0;
+                       samplecnt_t avail = 0;
 
                        while ((avail = stretcher.available()) > 0) {
 
-                               this_read = min(bufsize, uint32_t(avail));
+                               this_read = min (bufsize, avail);
 
                                stretcher.retrieve(buffers, this_read);
 
@@ -306,9 +304,9 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
                        }
                }
 
-               while ((avail = stretcher.available()) >= 0) {
+               while ((avail = stretcher.available()) > 0) {
 
-                       uint32_t this_read = min(bufsize, uint32_t(avail));
+                       samplecnt_t this_read = min (bufsize, avail);
 
                        stretcher.retrieve(buffers, this_read);
 
@@ -328,7 +326,7 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
                }
 
        } catch (runtime_error& err) {
-               error << _("timefx code failure. please notify ardour-developers.") << endmsg;
+               error << string_compose (_("programming error: %1"), X_("timefx code failure")) << endmsg;
                error << err.what() << endmsg;
                goto out;
        }
@@ -344,7 +342,9 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
        new_name += suffix;
 
-       ret = finish (region, nsrcs, new_name);
+       if (!tsr.cancel) {
+               ret = finish (region, nsrcs, new_name);
+       }
 
        /* now reset ancestral data for each new region */
 
@@ -355,13 +355,16 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
                                          stretch,
                                          shift);
                (*x)->set_master_sources (region->master_sources());
-               (*x)->set_length( (*x)->length() * stretch, this);
+               /* multiply the old (possibly previously stretched) region length by the extra
+                  stretch this time around to get its new length. this is a non-music based edit atm.
+               */
+               (*x)->set_length ((*x)->length() * tsr.time_fraction, 0);
        }
 
        /* stretch region gain envelope */
        /* XXX: assuming we've only processed one input region into one result here */
 
-       if (tsr.time_fraction != 1) {
+       if (ret == 0 && tsr.time_fraction != 1) {
                result = boost::dynamic_pointer_cast<AudioRegion> (results.front());
                assert (result);
                result->envelope()->x_scale (tsr.time_fraction);
@@ -373,7 +376,7 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
 
        if (buffers) {
                for (uint32_t i = 0; i < channels; ++i) {
-                       delete buffers[i];
+                       delete [] buffers[i];
                }
                delete [] buffers;
        }
@@ -384,8 +387,6 @@ RBEffect::run (boost::shared_ptr<Region> r, Progress*)
                }
        }
 
-       tsr.done = true;
-
        return ret;
 }