Fix uninitialised variable causing garbage output from panners in some cases.
[ardour.git] / libs / ardour / audioregion.cc
index 33a81c4f27856356df812f082106b8a9a54185b8..248da959367a24ddbecf7bdde47429e0a29203c6 100644 (file)
@@ -37,7 +37,6 @@
 #include "evoral/Curve.hpp"
 
 #include "ardour/audioregion.h"
-#include "ardour/debug.h"
 #include "ardour/session.h"
 #include "ardour/dB.h"
 #include "ardour/playlist.h"
@@ -62,6 +61,10 @@ namespace ARDOUR {
                PBD::PropertyDescriptor<bool> fade_in_active;
                PBD::PropertyDescriptor<bool> fade_out_active;
                PBD::PropertyDescriptor<float> scale_amplitude;
+               PBD::PropertyDescriptor<bool> fade_out_is_xfade;
+               PBD::PropertyDescriptor<bool> fade_out_is_short;
+               PBD::PropertyDescriptor<bool> fade_in_is_xfade;
+               PBD::PropertyDescriptor<bool> fade_in_is_short;
        }
 }
 
@@ -75,14 +78,14 @@ reverse_curve (boost::shared_ptr<Evoral::ControlList> dst, boost::shared_ptr<con
        size_t len = src->back()->when;
        
        for (Evoral::ControlList::const_iterator it = src->begin(); it!=src->end(); it++) {
-               dst->add ( len - (*it)->when, (*it)->value );
+               dst->add (len - (*it)->when, (*it)->value);
        }
 }
 
 static void
 generate_inverse_power_curve (boost::shared_ptr<Evoral::ControlList> dst, boost::shared_ptr<const Evoral::ControlList> src)
 {
-       //calc inverse curve using sum of squares
+       // calc inverse curve using sum of squares
        for (Evoral::ControlList::const_iterator it = src->begin(); it!=src->end(); ++it ) {
                float value = (*it)->value;
                value = 1 - powf(value,2);
@@ -91,21 +94,10 @@ generate_inverse_power_curve (boost::shared_ptr<Evoral::ControlList> dst, boost:
        }
 }
 
-/*
-static void
-generate_inverse_coefficient_curve (boost::shared_ptr<Evoral::ControlList> dst, boost::shared_ptr<const Evoral::ControlList> src)
-{
-       //calc inverse gain coefficient curve
-       for (Evoral::ControlList::const_iterator it = src->begin(); it!=src->end(); ++it ) {
-               float value = 1.0 - (*it)->value;
-               dst->fast_simple_add ( (*it)->when, value );
-       }
-}
-*/
-
 static void
 generate_db_fade (boost::shared_ptr<Evoral::ControlList> dst, double len, int num_steps, float dB_drop)
 {
+       dst->clear ();
        dst->fast_simple_add (0, 1);
 
        //generate a fade-out curve by successively applying a gain drop
@@ -164,6 +156,14 @@ AudioRegion::make_property_quarks ()
        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-out-active = %1\n",     Properties::fade_out_active.property_id));
        Properties::scale_amplitude.property_id = g_quark_from_static_string (X_("scale-amplitude"));
        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for scale-amplitude = %1\n",     Properties::scale_amplitude.property_id));
+       Properties::fade_out_is_xfade.property_id = g_quark_from_static_string (X_("fade-out-is-xfade"));
+       DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-out-is-xfade = %1\n",   Properties::fade_out_is_xfade.property_id));
+       Properties::fade_out_is_short.property_id = g_quark_from_static_string (X_("fade-out-is-short"));
+       DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-out-is-short = %1\n",   Properties::fade_out_is_short.property_id));
+       Properties::fade_in_is_xfade.property_id = g_quark_from_static_string (X_("fade-in-is-xfade"));
+       DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-in-is-xfade = %1\n",    Properties::fade_in_is_xfade.property_id));
+       Properties::fade_in_is_short.property_id = g_quark_from_static_string (X_("fade-in-is-short"));
+       DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-in-is-short = %1\n",    Properties::fade_in_is_short.property_id));
 }
 
 void
@@ -177,6 +177,10 @@ AudioRegion::register_properties ()
        add_property (_fade_in_active);
        add_property (_fade_out_active);
        add_property (_scale_amplitude);
+       add_property (_fade_out_is_xfade);
+       add_property (_fade_out_is_short);
+       add_property (_fade_in_is_xfade);
+       add_property (_fade_in_is_short);
 }
 
 #define AUDIOREGION_STATE_DEFAULT \
@@ -185,7 +189,11 @@ AudioRegion::register_properties ()
        , _default_fade_out (Properties::default_fade_out, true) \
        , _fade_in_active (Properties::fade_in_active, true) \
        , _fade_out_active (Properties::fade_out_active, true) \
-       , _scale_amplitude (Properties::scale_amplitude, 1.0)
+       , _scale_amplitude (Properties::scale_amplitude, 1.0) \
+       , _fade_in_is_xfade (Properties::fade_in_is_xfade, false) \
+       , _fade_out_is_xfade (Properties::fade_out_is_xfade, false) \
+       , _fade_in_is_short (Properties::fade_in_is_short, false) \
+       , _fade_out_is_short (Properties::fade_out_is_short, false) 
 
 #define AUDIOREGION_COPY_STATE(other) \
        _envelope_active (Properties::envelope_active, other->_envelope_active) \
@@ -193,7 +201,11 @@ AudioRegion::register_properties ()
        , _default_fade_out (Properties::default_fade_out, other->_default_fade_out) \
        , _fade_in_active (Properties::fade_in_active, other->_fade_in_active) \
        , _fade_out_active (Properties::fade_out_active, other->_fade_out_active) \
-       , _scale_amplitude (Properties::scale_amplitude, other->_scale_amplitude)
+       , _scale_amplitude (Properties::scale_amplitude, other->_scale_amplitude) \
+       , _fade_in_is_xfade (Properties::fade_in_is_xfade, other->_fade_in_is_xfade) \
+       , _fade_out_is_xfade (Properties::fade_out_is_xfade, other->_fade_out_is_xfade) \
+       , _fade_in_is_short (Properties::fade_in_is_short, other->_fade_in_is_short) \
+       , _fade_out_is_short (Properties::fade_out_is_short, other->_fade_out_is_short)
 /* a Session will reset these to its chosen defaults by calling AudioRegion::set_default_fade() */
 
 void
@@ -223,8 +235,6 @@ AudioRegion::AudioRegion (Session& s, framepos_t start, framecnt_t len, std::str
        , _envelope (new AutomationList(Evoral::Parameter(EnvelopeAutomation)))
        , _fade_in_suspended (0)
        , _fade_out_suspended (0)
-       , _fade_in_is_xfade (false)
-       , _fade_out_is_xfade (false)
 {
        init ();
        assert (_sources.size() == _master_sources.size());
@@ -242,8 +252,6 @@ AudioRegion::AudioRegion (const SourceList& srcs)
        , _envelope (new AutomationList(Evoral::Parameter(EnvelopeAutomation)))
        , _fade_in_suspended (0)
        , _fade_out_suspended (0)
-       , _fade_in_is_xfade (false)
-       , _fade_out_is_xfade (false)
 {
        init ();
        assert (_sources.size() == _master_sources.size());
@@ -263,8 +271,6 @@ AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other)
        , _envelope (new AutomationList (*other->_envelope, 0, other->_length))
        , _fade_in_suspended (0)
        , _fade_out_suspended (0)
-       , _fade_in_is_xfade (false)
-       , _fade_out_is_xfade (false)
 {
        /* don't use init here, because we got fade in/out from the other region
        */
@@ -291,8 +297,6 @@ AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other, framecnt_t
        , _envelope (new AutomationList (*other->_envelope, offset, other->_length))
        , _fade_in_suspended (0)
        , _fade_out_suspended (0)
-       , _fade_in_is_xfade (false)
-       , _fade_out_is_xfade (false)
 {
        /* don't use init here, because we got fade in/out from the other region
        */
@@ -316,8 +320,6 @@ AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other, const Sour
        , _envelope (new AutomationList (*other->_envelope))
        , _fade_in_suspended (0)
        , _fade_out_suspended (0)
-       , _fade_in_is_xfade (false)
-       , _fade_out_is_xfade (false)
 {
        /* make-a-sort-of-copy-with-different-sources constructor (used by audio filter) */
 
@@ -341,8 +343,6 @@ AudioRegion::AudioRegion (SourceList& srcs)
        , _envelope (new AutomationList(Evoral::Parameter(EnvelopeAutomation)))
        , _fade_in_suspended (0)
        , _fade_out_suspended (0)
-       , _fade_in_is_xfade (false)
-       , _fade_out_is_xfade (false)
 {
        init ();
 
@@ -585,8 +585,8 @@ AudioRegion::read_at (Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
 
        /* READ DATA FROM THE SOURCE INTO mixdown_buffer.
           We can never read directly into buf, since it may contain data
-          from a transparent region `below' this one in the stack; we
-          must always mix.
+          from a region `below' this one in the stack, and our fades (if they exist)
+          may need to mix with the existing data.
        */
 
        if (read_from_sources (_sources, _length, mixdown_buffer, position, to_read, chan_n) != to_read) {
@@ -703,9 +703,16 @@ AudioRegion::read_at (Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
        }
 
        
-       /* MIX THE REGION BODY FROM mixdown_buffer INTO buf */
+       /* MIX OR COPY THE REGION BODY FROM mixdown_buffer INTO buf */
 
-       mix_buffers_no_gain (buf + fade_in_limit, mixdown_buffer + fade_in_limit, to_read - fade_in_limit - fade_out_limit);
+       framecnt_t const N = to_read - fade_in_limit - fade_out_limit;
+       if (N > 0) {
+               if (opaque ()) {
+                       memcpy (buf + fade_in_limit, mixdown_buffer + fade_in_limit, N * sizeof (Sample));
+               } else {
+                       mix_buffers_no_gain (buf + fade_in_limit, mixdown_buffer + fade_in_limit, N);
+               }
+       }
 
        return to_read;
 }
@@ -799,7 +806,6 @@ AudioRegion::state ()
        }
 
        child = node.add_child (X_("FadeIn"));
-       child->add_property ("is-xfade", (_fade_in_is_xfade ? "yes" : "no"));
 
        if (_default_fade_in) {
                child->add_property ("default", "yes");
@@ -813,7 +819,6 @@ AudioRegion::state ()
        }
 
        child = node.add_child (X_("FadeOut"));
-       child->add_property ("is-xfade", (_fade_out_is_xfade ? "yes" : "no"));
 
        if (_default_fade_out) {
                child->add_property ("default", "yes");
@@ -892,12 +897,6 @@ AudioRegion::_set_state (const XMLNode& node, int version, PropertyChange& what_
                                }
                        }
 
-                       if ((prop = child->property ("is-xfade")) != 0) {
-                               _fade_in_is_xfade = string_is_affirmative (prop->value());
-                       } else {
-                               _fade_in_is_xfade = false;
-                       }
-
                        if ((prop = child->property ("active")) != 0) {
                                if (string_is_affirmative (prop->value())) {
                                        set_fade_in_active (true);
@@ -906,6 +905,12 @@ AudioRegion::_set_state (const XMLNode& node, int version, PropertyChange& what_
                                }
                        }
 
+                       /* legacy a3 */
+
+                       if ((prop = child->property ("is-xfade")) != 0) {
+                               _fade_in_is_xfade = string_is_affirmative (prop->value());
+                       }
+
                } else if (child->name() == "FadeOut") {
 
                        _fade_out->clear ();
@@ -918,14 +923,8 @@ AudioRegion::_set_state (const XMLNode& node, int version, PropertyChange& what_
                                        _fade_out->set_state (*grandchild, version);
                                }
                        }
-
-                       if ((prop = child->property ("is-xfade")) != 0) {
-                               _fade_out_is_xfade = string_is_affirmative (prop->value());
-                       } else {
-                               _fade_out_is_xfade = false;
-                       }
-       
-               if ((prop = child->property ("active")) != 0) {
+                       
+                       if ((prop = child->property ("active")) != 0) {
                                if (string_is_affirmative (prop->value())) {
                                        set_fade_out_active (true);
                                } else {
@@ -933,6 +932,12 @@ AudioRegion::_set_state (const XMLNode& node, int version, PropertyChange& what_
                                }
                        }
 
+                       /* legacy a3 */
+
+                       if ((prop = child->property ("is-xfade")) != 0) {
+                               _fade_out_is_xfade = string_is_affirmative (prop->value());
+                       }
+                       
                } else if (child->name() == "InvFadeIn") {
                        XMLNode* grandchild = child->child ("AutomationList");
                        if (grandchild) {
@@ -1019,6 +1024,8 @@ AudioRegion::set_fade_in (FadeShape shape, framecnt_t len)
                generate_db_fade (c1, len, 10, -1);  // start off with a slow fade
                generate_db_fade (c2, len, 10, -80); // end with a fast fade
                merge_curves (_fade_in, c1, c2);
+               reverse_curve (c3, _fade_in);
+               _fade_in->copy_events (*c3);
                generate_inverse_power_curve (_inverse_fade_in, _fade_in);
                break;
 
@@ -1032,20 +1039,22 @@ AudioRegion::set_fade_in (FadeShape shape, framecnt_t len)
                break;
                
        case FadeSymmetric:
-               // starts kind of like a constant power but has a slower fadeout
-               // however it is NOT constant power and there will be a level drop in the middle of the crossfade
-               c1->fast_simple_add (0.0, 1.0);
-               for ( int i = 1; i < 9; i++ ) {
-                       float dist = (float)i/10.0;
-                       c1->fast_simple_add ((len * dist), cos(dist*M_PI/10.0));
+               //start with a nearly linear cuve
+               _fade_in->fast_simple_add (0, 1);
+               _fade_in->fast_simple_add (0.5*len, 0.6);
+               //now generate a fade-out curve by successively applying a gain drop
+               const float breakpoint = 0.7;  //linear for first 70%
+               const int num_steps = 9;
+               for (int i = 2; i < num_steps; i++) {
+                       float coeff = (1.0-breakpoint);
+                       for (int j = 0; j < i; j++) {
+                               coeff *= 0.5;  //6dB drop per step
+                       }
+                       _fade_in->fast_simple_add (len* (breakpoint+((1.0-breakpoint)*(double)i/(double)num_steps)), coeff);
                }
-               c1->fast_simple_add (len, VERY_SMALL_SIGNAL);
-
-               //curve 2 is a slow fade at end
-               generate_db_fade (c2, len, 10, -30 );
-
-               merge_curves (c3, c1, c2);
-               reverse_curve (_fade_in, c3);
+               _fade_in->fast_simple_add (len, VERY_SMALL_SIGNAL);
+               reverse_curve (c3, _fade_in);
+               _fade_in->copy_events (*c3);
                reverse_curve (_inverse_fade_in, _fade_in );
                break;
        }
@@ -1084,13 +1093,13 @@ AudioRegion::set_fade_out (FadeShape shape, framecnt_t len)
                break;
                
        case FadeFast: 
-               generate_db_fade (_fade_out, len, 10, -60 );
+               generate_db_fade (_fade_out, len, 10, -60);
                generate_inverse_power_curve (_inverse_fade_out, _fade_out);
                break;
                
        case FadeSlow: 
-               generate_db_fade (c1, len, 10, -1 );  //start off with a slow fade
-               generate_db_fade (c2, len, 10, -80 );  //end with a fast fade
+               generate_db_fade (c1, len, 10, -1);  //start off with a slow fade
+               generate_db_fade (c2, len, 10, -80);  //end with a fast fade
                merge_curves (_fade_out, c1, c2);
                generate_inverse_power_curve (_inverse_fade_out, _fade_out);
                break;
@@ -1108,19 +1117,21 @@ AudioRegion::set_fade_out (FadeShape shape, framecnt_t len)
                break;
                
        case FadeSymmetric:
-               //starts kind of like a constant power but has a slower fadeout
-               //however it is NOT constant power and there will be a level drop in the middle of the crossfade
-               c1->fast_simple_add (0.0, 1.0);
-               for ( int i = 1; i < 9; i++ ) {
-                       float dist = (float)i/10.0;
-                       c1->fast_simple_add ((len * dist), cos(dist*M_PI/10.0));  //cheesy way of making a flat line
+               //start with a nearly linear cuve
+               _fade_out->fast_simple_add (0, 1);
+               _fade_out->fast_simple_add (0.5*len, 0.6);
+
+               //now generate a fade-out curve by successively applying a gain drop
+               const float breakpoint = 0.7;  //linear for first 70%
+               const int num_steps = 9;
+               for (int i = 2; i < num_steps; i++) {
+                       float coeff = (1.0-breakpoint);
+                       for (int j = 0; j < i; j++) {
+                               coeff *= 0.5;  //6dB drop per step
+                       }
+                       _fade_out->fast_simple_add (len* (breakpoint+((1.0-breakpoint)*(double)i/(double)num_steps)), coeff);
                }
-               c1->fast_simple_add (len, VERY_SMALL_SIGNAL);
-
-               //curve 2 is a slow fade at end
-               generate_db_fade (c2, len, 10, -30);
-
-               merge_curves (_fade_out,  c1, c2);
+               _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
                reverse_curve (_inverse_fade_out, _fade_out);
                break;
        }
@@ -1150,7 +1161,7 @@ AudioRegion::set_fade_in_length (framecnt_t len)
 
                if (_session.config.get_xfade_model() == FullCrossfade &&
                    _session.config.get_auto_xfade() && 
-                   _fade_in_is_xfade) {
+                   _fade_in_is_xfade && !_fade_in_is_short) {
 
                        /* trim a single other region below us to the new start
                           of the fade.
@@ -1189,7 +1200,7 @@ AudioRegion::set_fade_out_length (framecnt_t len)
                
                if (_session.config.get_xfade_model() == FullCrossfade &&
                    _session.config.get_auto_xfade() && 
-                   _fade_out_is_xfade) {
+                   _fade_out_is_xfade && !_fade_out_is_short) {
 
                        /* trim a single other region below us to the new start
                           of the fade.
@@ -1243,6 +1254,7 @@ AudioRegion::set_default_fade_in ()
 {
        _fade_in_suspended = 0;
        _fade_in_is_xfade = false;
+       _fade_in_is_short = true;
        set_fade_in (FadeLinear, 64);
 }
 
@@ -1251,6 +1263,7 @@ AudioRegion::set_default_fade_out ()
 {
        _fade_out_suspended = 0;
        _fade_out_is_xfade = false;
+       _fade_out_is_short = true;
        set_fade_out (FadeLinear, 64);
 }
 
@@ -1822,13 +1835,46 @@ AudioRegion::body_range () const
 void
 AudioRegion::set_fade_in_is_xfade (bool yn)
 {
+       if (yn == _fade_in_is_xfade) {
+               return;
+       }
+
        _fade_in_is_xfade = yn;
+       send_change (PropertyChange (Properties::fade_in_is_xfade));
 }
 
 void
 AudioRegion::set_fade_out_is_xfade (bool yn)
 {
+       if (yn == _fade_out_is_xfade) {
+               return;
+       }
+
        _fade_out_is_xfade = yn;
+       send_change (PropertyChange (Properties::fade_out_is_xfade));
+}
+
+void
+AudioRegion::set_fade_in_is_short (bool yn)
+{
+       if (yn == _fade_in_is_short) {
+               return;
+       }
+
+       _fade_in_is_short = yn;
+       send_change (PropertyChange (Properties::fade_in_is_short));
+
+}
+
+void
+AudioRegion::set_fade_out_is_short (bool yn)
+{
+       if (yn == _fade_out_is_short) {
+               return;
+       }
+
+       _fade_out_is_short = yn;
+       send_change (PropertyChange (Properties::fade_out_is_short));
 }
 
 boost::shared_ptr<Region>
@@ -1875,12 +1921,20 @@ AudioRegion::get_single_other_xfade_region (bool start) const
 framecnt_t
 AudioRegion::verify_xfade_bounds (framecnt_t len, bool start)
 {
+       /* this is called from a UI to check on whether a new proposed
+          length for an xfade is legal or not. it returns the legal
+          length corresponding to @a len which may be shorter than or
+          equal to @a len itself.
+       */
+
        boost::shared_ptr<Region> other = get_single_other_xfade_region (start);
        framecnt_t maxlen;
 
        if (!other) {
-               /* zero or > 2 regions here, don't care about len */
-               return len;
+               /* zero or > 2 regions here, don't care about len, but
+                  it can't be longer than the region itself.
+                */
+               return min (length(), len);
        }
 
        /* we overlap a single region. clamp the length of an xfade to
@@ -1894,7 +1948,7 @@ AudioRegion::verify_xfade_bounds (framecnt_t len, bool start)
                maxlen = last_frame() - other->earliest_possible_position();
        }
 
-       return min (maxlen, len);
+       return min (length(), min (maxlen, len));
                
 }