libs/ardour/audioregion.cc

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <cmath>
  21 #include <climits>
  22 #include <cfloat>
  23 #include <algorithm>
  24
  25 #include <set>
  26
  27 #include <boost/scoped_array.hpp>
  28
  29 #include <glibmm/threads.h>
  30
  31 #include "pbd/basename.h"
  32 #include "pbd/xml++.h"
  33 #include "pbd/stacktrace.h"
  34 #include "pbd/enumwriter.h"
  35 #include "pbd/convert.h"
  36
  37 #include "evoral/Curve.hpp"
  38
  39 #include "ardour/audioregion.h"
  40 #include "ardour/session.h"
  41 #include "ardour/dB.h"
  42 #include "ardour/debug.h"
  43 #include "ardour/playlist.h"
  44 #include "ardour/audiofilesource.h"
  45 #include "ardour/region_factory.h"
  46 #include "ardour/runtime_functions.h"
  47 #include "ardour/transient_detector.h"
  48 #include "ardour/progress.h"
  49
  50 #include "i18n.h"
  51 #include <locale.h>
  52
  53 using namespace std;
  54 using namespace ARDOUR;
  55 using namespace PBD;
  56
  57 namespace ARDOUR {
  58         namespace Properties {
  59                 PBD::PropertyDescriptor<bool> envelope_active;
  60                 PBD::PropertyDescriptor<bool> default_fade_in;
  61                 PBD::PropertyDescriptor<bool> default_fade_out;
  62                 PBD::PropertyDescriptor<bool> fade_in_active;
  63                 PBD::PropertyDescriptor<bool> fade_out_active;
  64                 PBD::PropertyDescriptor<float> scale_amplitude;
  65                 PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_in;
  66                 PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_in;
  67                 PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_out;
  68                 PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_out;
  69                 PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > envelope;
  70         }
  71 }
  72
  73 static const double VERY_SMALL_SIGNAL = 0.0000001;  //-140dB
  74
  75 /* Curve manipulations */
  76
  77 static void
  78 reverse_curve (boost::shared_ptr<Evoral::ControlList> dst, boost::shared_ptr<const Evoral::ControlList> src)
  79 {
  80         size_t len = src->back()->when;
  81         for (Evoral::ControlList::const_reverse_iterator it = src->rbegin(); it!=src->rend(); it++) {
  82                 dst->fast_simple_add (len - (*it)->when, (*it)->value);
  83         }
  84 }
  85
  86 static void
  87 generate_inverse_power_curve (boost::shared_ptr<Evoral::ControlList> dst, boost::shared_ptr<const Evoral::ControlList> src)
  88 {
  89         // calc inverse curve using sum of squares
  90         for (Evoral::ControlList::const_iterator it = src->begin(); it!=src->end(); ++it ) {
  91                 float value = (*it)->value;
  92                 value = 1 - powf(value,2);
  93                 value = sqrtf(value);
  94                 dst->fast_simple_add ( (*it)->when, value );
  95         }
  96 }
  97
  98 static void
  99 generate_db_fade (boost::shared_ptr<Evoral::ControlList> dst, double len, int num_steps, float dB_drop)
 100 {
 101         dst->clear ();
 102         dst->fast_simple_add (0, 1);
 103
 104         //generate a fade-out curve by successively applying a gain drop
 105         float fade_speed = dB_to_coefficient(dB_drop / (float) num_steps);
 106         for (int i = 1; i < (num_steps-1); i++) {
 107                 float coeff = 1.0;
 108                 for (int j = 0; j < i; j++) {
 109                         coeff *= fade_speed;
 110                 }
 111                 dst->fast_simple_add (len*(double)i/(double)num_steps, coeff);
 112         }
 113
 114         dst->fast_simple_add (len, VERY_SMALL_SIGNAL);
 115 }
 116
 117 static void
 118 merge_curves (boost::shared_ptr<Evoral::ControlList> dst,
 119               boost::shared_ptr<const Evoral::ControlList> curve1,
 120               boost::shared_ptr<const Evoral::ControlList> curve2)
 121 {
 122         Evoral::ControlList::EventList::size_type size = curve1->size();
 123
 124         //curve lengths must match for now
 125         if (size != curve2->size()) {
 126                 return;
 127         }
 128
 129         Evoral::ControlList::const_iterator c1 = curve1->begin();
 130         int count = 0;
 131         for (Evoral::ControlList::const_iterator c2 = curve2->begin(); c2!=curve2->end(); c2++ ) {
 132                 float v1 = accurate_coefficient_to_dB((*c1)->value);
 133                 float v2 = accurate_coefficient_to_dB((*c2)->value);
 134
 135                 double interp = v1 * ( 1.0-( (double)count / (double)size) );
 136                 interp += v2 * ( (double)count / (double)size );
 137
 138                 interp = dB_to_coefficient(interp);
 139                 dst->fast_simple_add ( (*c1)->when, interp );
 140                 c1++;
 141                 count++;
 142         }
 143 }
 144
 145 void
 146 AudioRegion::make_property_quarks ()
 147 {
 148         Properties::envelope_active.property_id = g_quark_from_static_string (X_("envelope-active"));
 149         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for envelope-active = %1\n",     Properties::envelope_active.property_id));
 150         Properties::default_fade_in.property_id = g_quark_from_static_string (X_("default-fade-in"));
 151         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for default-fade-in = %1\n",     Properties::default_fade_in.property_id));
 152         Properties::default_fade_out.property_id = g_quark_from_static_string (X_("default-fade-out"));
 153         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for default-fade-out = %1\n",    Properties::default_fade_out.property_id));
 154         Properties::fade_in_active.property_id = g_quark_from_static_string (X_("fade-in-active"));
 155         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-in-active = %1\n",      Properties::fade_in_active.property_id));
 156         Properties::fade_out_active.property_id = g_quark_from_static_string (X_("fade-out-active"));
 157         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fade-out-active = %1\n",     Properties::fade_out_active.property_id));
 158         Properties::scale_amplitude.property_id = g_quark_from_static_string (X_("scale-amplitude"));
 159         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for scale-amplitude = %1\n",     Properties::scale_amplitude.property_id));
 160         Properties::fade_in.property_id = g_quark_from_static_string (X_("FadeIn"));
 161         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for FadeIn = %1\n",              Properties::fade_in.property_id));
 162         Properties::inverse_fade_in.property_id = g_quark_from_static_string (X_("InverseFadeIn"));
 163         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for InverseFadeIn = %1\n",       Properties::inverse_fade_in.property_id));
 164         Properties::fade_out.property_id = g_quark_from_static_string (X_("FadeOut"));
 165         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for FadeOut = %1\n",             Properties::fade_out.property_id));
 166         Properties::inverse_fade_out.property_id = g_quark_from_static_string (X_("InverseFadeOut"));
 167         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for InverseFadeOut = %1\n",      Properties::inverse_fade_out.property_id));
 168         Properties::envelope.property_id = g_quark_from_static_string (X_("Envelope"));
 169         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for Envelope = %1\n",            Properties::envelope.property_id));
 170 }
 171
 172 void
 173 AudioRegion::register_properties ()
 174 {
 175         /* no need to register parent class properties */
 176
 177         add_property (_envelope_active);
 178         add_property (_default_fade_in);
 179         add_property (_default_fade_out);
 180         add_property (_fade_in_active);
 181         add_property (_fade_out_active);
 182         add_property (_scale_amplitude);
 183         add_property (_fade_in);
 184         add_property (_inverse_fade_in);
 185         add_property (_fade_out);
 186         add_property (_inverse_fade_out);
 187         add_property (_envelope);
 188 }
 189
 190 #define AUDIOREGION_STATE_DEFAULT \
 191         _envelope_active (Properties::envelope_active, false) \
 192         , _default_fade_in (Properties::default_fade_in, true) \
 193         , _default_fade_out (Properties::default_fade_out, true) \
 194         , _fade_in_active (Properties::fade_in_active, true) \
 195         , _fade_out_active (Properties::fade_out_active, true) \
 196         , _scale_amplitude (Properties::scale_amplitude, 1.0) \
 197         , _fade_in (Properties::fade_in, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter (FadeInAutomation)))) \
 198         , _inverse_fade_in (Properties::inverse_fade_in, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter (FadeInAutomation)))) \
 199         , _fade_out (Properties::fade_out, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter (FadeOutAutomation)))) \
 200         , _inverse_fade_out (Properties::inverse_fade_out, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter (FadeOutAutomation))))
 201
 202 #define AUDIOREGION_COPY_STATE(other) \
 203         _envelope_active (Properties::envelope_active, other->_envelope_active) \
 204         , _default_fade_in (Properties::default_fade_in, other->_default_fade_in) \
 205         , _default_fade_out (Properties::default_fade_out, other->_default_fade_out) \
 206         , _fade_in_active (Properties::fade_in_active, other->_fade_in_active) \
 207         , _fade_out_active (Properties::fade_out_active, other->_fade_out_active) \
 208         , _scale_amplitude (Properties::scale_amplitude, other->_scale_amplitude) \
 209         , _fade_in (Properties::fade_in, boost::shared_ptr<AutomationList> (new AutomationList (*other->_fade_in.val()))) \
 210         , _inverse_fade_in (Properties::fade_in, boost::shared_ptr<AutomationList> (new AutomationList (*other->_inverse_fade_in.val()))) \
 211         , _fade_out (Properties::fade_in, boost::shared_ptr<AutomationList> (new AutomationList (*other->_fade_out.val()))) \
 212         , _inverse_fade_out (Properties::fade_in, boost::shared_ptr<AutomationList> (new AutomationList (*other->_inverse_fade_out.val())))
 213 /* a Session will reset these to its chosen defaults by calling AudioRegion::set_default_fade() */
 214
 215 void
 216 AudioRegion::init ()
 217 {
 218         register_properties ();
 219
 220         suspend_property_changes();
 221         set_default_fades ();
 222         set_default_envelope ();
 223         resume_property_changes();
 224
 225         listen_to_my_curves ();
 226         connect_to_analysis_changed ();
 227         connect_to_header_position_offset_changed ();
 228 }
 229
 230 /** Constructor for use by derived types only */
 231 AudioRegion::AudioRegion (Session& s, framepos_t start, framecnt_t len, std::string name)
 232         : Region (s, start, len, name, DataType::AUDIO)
 233         , AUDIOREGION_STATE_DEFAULT
 234         , _envelope (Properties::envelope, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter(EnvelopeAutomation))))
 235         , _automatable (s)
 236         , _fade_in_suspended (0)
 237         , _fade_out_suspended (0)
 238 {
 239         init ();
 240         assert (_sources.size() == _master_sources.size());
 241 }
 242
 243 /** Basic AudioRegion constructor */
 244 AudioRegion::AudioRegion (const SourceList& srcs)
 245         : Region (srcs)
 246         , AUDIOREGION_STATE_DEFAULT
 247         , _envelope (Properties::envelope, boost::shared_ptr<AutomationList> (new AutomationList (Evoral::Parameter(EnvelopeAutomation))))
 248         , _automatable(srcs[0]->session())
 249         , _fade_in_suspended (0)
 250         , _fade_out_suspended (0)
 251 {
 252         init ();
 253         assert (_sources.size() == _master_sources.size());
 254 }
 255
 256 AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other)
 257         : Region (other)
 258         , AUDIOREGION_COPY_STATE (other)
 259           /* As far as I can see, the _envelope's times are relative to region position, and have nothing
 260              to do with sources (and hence _start).  So when we copy the envelope, we just use the supplied offset.
 261           */
 262         , _envelope (Properties::envelope, boost::shared_ptr<AutomationList> (new AutomationList (*other->_envelope.val(), 0, other->_length)))
 263         , _automatable (other->session())
 264         , _fade_in_suspended (0)
 265         , _fade_out_suspended (0)
 266 {
 267         /* don't use init here, because we got fade in/out from the other region
 268         */
 269         register_properties ();
 270         listen_to_my_curves ();
 271         connect_to_analysis_changed ();
 272         connect_to_header_position_offset_changed ();
 273
 274         assert(_type == DataType::AUDIO);
 275         assert (_sources.size() == _master_sources.size());
 276 }
 277
 278 AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other, framecnt_t offset)
 279         : Region (other, offset)
 280         , AUDIOREGION_COPY_STATE (other)
 281           /* As far as I can see, the _envelope's times are relative to region position, and have nothing
 282              to do with sources (and hence _start).  So when we copy the envelope, we just use the supplied offset.
 283           */
 284         , _envelope (Properties::envelope, boost::shared_ptr<AutomationList> (new AutomationList (*other->_envelope.val(), offset, other->_length)))
 285         , _automatable (other->session())
 286         , _fade_in_suspended (0)
 287         , _fade_out_suspended (0)
 288 {
 289         /* don't use init here, because we got fade in/out from the other region
 290         */
 291         register_properties ();
 292         listen_to_my_curves ();
 293         connect_to_analysis_changed ();
 294         connect_to_header_position_offset_changed ();
 295
 296         assert(_type == DataType::AUDIO);
 297         assert (_sources.size() == _master_sources.size());
 298 }
 299
 300 AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other, const SourceList& srcs)
 301         : Region (boost::static_pointer_cast<const Region>(other), srcs)
 302         , AUDIOREGION_COPY_STATE (other)
 303         , _envelope (Properties::envelope, boost::shared_ptr<AutomationList> (new AutomationList (*other->_envelope.val())))
 304         , _automatable (other->session())
 305         , _fade_in_suspended (0)
 306         , _fade_out_suspended (0)
 307 {
 308         /* make-a-sort-of-copy-with-different-sources constructor (used by audio filter) */
 309
 310         register_properties ();
 311
 312         listen_to_my_curves ();
 313         connect_to_analysis_changed ();
 314         connect_to_header_position_offset_changed ();
 315
 316         assert (_sources.size() == _master_sources.size());
 317 }
 318
 319 AudioRegion::AudioRegion (SourceList& srcs)
 320         : Region (srcs)
 321         , AUDIOREGION_STATE_DEFAULT
 322         , _envelope (Properties::envelope, boost::shared_ptr<AutomationList> (new AutomationList(Evoral::Parameter(EnvelopeAutomation))))
 323         , _automatable(srcs[0]->session())
 324         , _fade_in_suspended (0)
 325         , _fade_out_suspended (0)
 326 {
 327         init ();
 328
 329         assert(_type == DataType::AUDIO);
 330         assert (_sources.size() == _master_sources.size());
 331 }
 332
 333 AudioRegion::~AudioRegion ()
 334 {
 335 }
 336
 337 void
 338 AudioRegion::post_set (const PropertyChange& /*ignored*/)
 339 {
 340         if (!_sync_marked) {
 341                 _sync_position = _start;
 342         }
 343
 344         /* return to default fades if the existing ones are too long */
 345
 346         if (_left_of_split) {
 347                 if (_fade_in->back()->when >= _length) {
 348                         set_default_fade_in ();
 349                 }
 350                 set_default_fade_out ();
 351                 _left_of_split = false;
 352         }
 353
 354         if (_right_of_split) {
 355                 if (_fade_out->back()->when >= _length) {
 356                         set_default_fade_out ();
 357                 }
 358
 359                 set_default_fade_in ();
 360                 _right_of_split = false;
 361         }
 362
 363         /* If _length changed, adjust our gain envelope accordingly */
 364         _envelope->truncate_end (_length);
 365 }
 366
 367 void
 368 AudioRegion::connect_to_analysis_changed ()
 369 {
 370         for (SourceList::const_iterator i = _sources.begin(); i != _sources.end(); ++i) {
 371                 (*i)->AnalysisChanged.connect_same_thread (*this, boost::bind (&AudioRegion::invalidate_transients, this));
 372         }
 373 }
 374
 375 void
 376 AudioRegion::connect_to_header_position_offset_changed ()
 377 {
 378         set<boost::shared_ptr<Source> > unique_srcs;
 379
 380         for (SourceList::const_iterator i = _sources.begin(); i != _sources.end(); ++i) {
 381
 382                 /* connect only once to HeaderPositionOffsetChanged, even if sources are replicated
 383                  */
 384
 385                 if (unique_srcs.find (*i) == unique_srcs.end ()) {
 386                         unique_srcs.insert (*i);
 387                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (*i);
 388                         if (afs) {
 389                                 afs->HeaderPositionOffsetChanged.connect_same_thread (*this, boost::bind (&AudioRegion::source_offset_changed, this));
 390                         }
 391                 }
 392         }
 393 }
 394
 395 void
 396 AudioRegion::listen_to_my_curves ()
 397 {
 398         _envelope->StateChanged.connect_same_thread (*this, boost::bind (&AudioRegion::envelope_changed, this));
 399         _fade_in->StateChanged.connect_same_thread (*this, boost::bind (&AudioRegion::fade_in_changed, this));
 400         _fade_out->StateChanged.connect_same_thread (*this, boost::bind (&AudioRegion::fade_out_changed, this));
 401 }
 402
 403 void
 404 AudioRegion::set_envelope_active (bool yn)
 405 {
 406         if (envelope_active() != yn) {
 407                 _envelope_active = yn;
 408                 send_change (PropertyChange (Properties::envelope_active));
 409         }
 410 }
 411
 412 ARDOUR::framecnt_t
 413 AudioRegion::read_peaks (PeakData *buf, framecnt_t npeaks, framecnt_t offset, framecnt_t cnt, uint32_t chan_n, double samples_per_unit) const
 414 {
 415         if (chan_n >= _sources.size()) {
 416                 return 0;
 417         }
 418
 419         if (audio_source(chan_n)->read_peaks (buf, npeaks, offset, cnt, samples_per_unit)) {
 420                 return 0;
 421         } else {
 422                 if (_scale_amplitude != 1.0f) {
 423                         for (framecnt_t n = 0; n < npeaks; ++n) {
 424                                 buf[n].max *= _scale_amplitude;
 425                                 buf[n].min *= _scale_amplitude;
 426                         }
 427                 }
 428                 return cnt;
 429         }
 430 }
 431
 432 /** @param buf Buffer to write data to (existing data will be overwritten).
 433  *  @param pos Position to read from as an offset from the region position.
 434  *  @param cnt Number of frames to read.
 435  *  @param channel Channel to read from.
 436  */
 437 framecnt_t
 438 AudioRegion::read (Sample* buf, framepos_t pos, framecnt_t cnt, int channel) const
 439 {
 440         /* raw read, no fades, no gain, nada */
 441         return read_from_sources (_sources, _length, buf, _position + pos, cnt, channel);
 442 }
 443
 444 framecnt_t
 445 AudioRegion::master_read_at (Sample *buf, Sample* /*mixdown_buffer*/, float* /*gain_buffer*/,
 446                              framepos_t position, framecnt_t cnt, uint32_t chan_n) const
 447 {
 448         /* do not read gain/scaling/fades and do not count this disk i/o in statistics */
 449
 450         assert (cnt >= 0);
 451         return read_from_sources (
 452                 _master_sources, _master_sources.front()->length (_master_sources.front()->timeline_position()),
 453                 buf, position, cnt, chan_n
 454                 );
 455 }
 456
 457 /** @param buf Buffer to mix data into.
 458  *  @param mixdown_buffer Scratch buffer for audio data.
 459  *  @param gain_buffer Scratch buffer for gain data.
 460  *  @param position Position within the session to read from.
 461  *  @param cnt Number of frames to read.
 462  *  @param chan_n Channel number to read.
 463  */
 464 framecnt_t
 465 AudioRegion::read_at (Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
 466                       framepos_t position,
 467                       framecnt_t cnt,
 468                       uint32_t chan_n) const
 469 {
 470         /* We are reading data from this region into buf (possibly via mixdown_buffer).
 471            The caller has verified that we cover the desired section.
 472         */
 473
 474         /* See doc/region_read.svg for a drawing which might help to explain
 475            what is going on.
 476         */
 477
 478         assert (cnt >= 0);
 479
 480         if (n_channels() == 0) {
 481                 return 0;
 482         }
 483
 484         /* WORK OUT WHERE TO GET DATA FROM */
 485
 486         framecnt_t to_read;
 487
 488         assert (position >= _position);
 489         frameoffset_t const internal_offset = position - _position;
 490
 491         if (internal_offset >= _length) {
 492                 return 0; /* read nothing */
 493         }
 494
 495         if ((to_read = min (cnt, _length - internal_offset)) == 0) {
 496                 return 0; /* read nothing */
 497         }
 498
 499
 500         /* COMPUTE DETAILS OF ANY FADES INVOLVED IN THIS READ */
 501
 502         /* Amount (length) of fade in that we are dealing with in this read */
 503         framecnt_t fade_in_limit = 0;
 504
 505         /* Offset from buf / mixdown_buffer of the start
 506            of any fade out that we are dealing with
 507         */
 508         frameoffset_t fade_out_offset = 0;
 509
 510         /* Amount (length) of fade out that we are dealing with in this read */
 511         framecnt_t fade_out_limit = 0;
 512
 513         framecnt_t fade_interval_start = 0;
 514
 515         /* Fade in */
 516
 517         if (_fade_in_active && _session.config.get_use_region_fades()) {
 518
 519                 framecnt_t fade_in_length = (framecnt_t) _fade_in->back()->when;
 520
 521                 /* see if this read is within the fade in */
 522
 523                 if (internal_offset < fade_in_length) {
 524                         fade_in_limit = min (to_read, fade_in_length - internal_offset);
 525                 }
 526         }
 527
 528         /* Fade out */
 529
 530         if (_fade_out_active && _session.config.get_use_region_fades()) {
 531
 532                 /* see if some part of this read is within the fade out */
 533
 534                 /* .................        >|            REGION
 535                                              _length
 536
 537                                  {           }            FADE
 538                                              fade_out_length
 539                                  ^
 540                                  _length - fade_out_length
 541                         |--------------|
 542                         ^internal_offset
 543                                        ^internal_offset + to_read
 544
 545                                        we need the intersection of [internal_offset,internal_offset+to_read] with
 546                                        [_length - fade_out_length, _length]
 547
 548                 */
 549
 550
 551                 fade_interval_start = max (internal_offset, _length - framecnt_t (_fade_out->back()->when));
 552                 framecnt_t fade_interval_end = min(internal_offset + to_read, _length.val());
 553
 554                 if (fade_interval_end > fade_interval_start) {
 555                         /* (part of the) the fade out is in this buffer */
 556                         fade_out_limit = fade_interval_end - fade_interval_start;
 557                         fade_out_offset = fade_interval_start - internal_offset;
 558                 }
 559         }
 560
 561         /* READ DATA FROM THE SOURCE INTO mixdown_buffer.
 562            We can never read directly into buf, since it may contain data
 563            from a region `below' this one in the stack, and our fades (if they exist)
 564            may need to mix with the existing data.
 565         */
 566
 567         if (read_from_sources (_sources, _length, mixdown_buffer, position, to_read, chan_n) != to_read) {
 568                 return 0;
 569         }
 570
 571         /* APPLY REGULAR GAIN CURVES AND SCALING TO mixdown_buffer */
 572
 573         if (envelope_active())  {
 574                 _envelope->curve().get_vector (internal_offset, internal_offset + to_read, gain_buffer, to_read);
 575
 576                 if (_scale_amplitude != 1.0f) {
 577                         for (framecnt_t n = 0; n < to_read; ++n) {
 578                                 mixdown_buffer[n] *= gain_buffer[n] * _scale_amplitude;
 579                         }
 580                 } else {
 581                         for (framecnt_t n = 0; n < to_read; ++n) {
 582                                 mixdown_buffer[n] *= gain_buffer[n];
 583                         }
 584                 }
 585         } else if (_scale_amplitude != 1.0f) {
 586                 apply_gain_to_buffer (mixdown_buffer, to_read, _scale_amplitude);
 587         }
 588
 589         /* APPLY FADES TO THE DATA IN mixdown_buffer AND MIX THE RESULTS INTO
 590          * buf. The key things to realize here: (1) the fade being applied is
 591          * (as of April 26th 2012) just the inverse of the fade in curve (2)
 592          * "buf" contains data from lower regions already. So this operation
 593          * fades out the existing material.
 594          */
 595
 596         if (fade_in_limit != 0) {
 597
 598                 if (opaque()) {
 599                         if (_inverse_fade_in) {
 600
 601                                 /* explicit inverse fade in curve (e.g. for constant
 602                                  * power), so we have to fetch it.
 603                                  */
 604
 605                                 _inverse_fade_in->curve().get_vector (internal_offset, internal_offset + fade_in_limit, gain_buffer, fade_in_limit);
 606
 607                                 /* Fade the data from lower layers out */
 608                                 for (framecnt_t n = 0; n < fade_in_limit; ++n) {
 609                                         buf[n] *= gain_buffer[n];
 610                                 }
 611
 612                                 /* refill gain buffer with the fade in */
 613
 614                                 _fade_in->curve().get_vector (internal_offset, internal_offset + fade_in_limit, gain_buffer, fade_in_limit);
 615
 616                         } else {
 617
 618                                 /* no explicit inverse fade in, so just use (1 - fade
 619                                  * in) for the fade out of lower layers
 620                                  */
 621
 622                                 _fade_in->curve().get_vector (internal_offset, internal_offset + fade_in_limit, gain_buffer, fade_in_limit);
 623
 624                                 for (framecnt_t n = 0; n < fade_in_limit; ++n) {
 625                                         buf[n] *= 1 - gain_buffer[n];
 626                                 }
 627                         }
 628                 } else {
 629                         _fade_in->curve().get_vector (internal_offset, internal_offset + fade_in_limit, gain_buffer, fade_in_limit);
 630                 }
 631
 632                 /* Mix our newly-read data in, with the fade */
 633                 for (framecnt_t n = 0; n < fade_in_limit; ++n) {
 634                         buf[n] += mixdown_buffer[n] * gain_buffer[n];
 635                 }
 636         }
 637
 638         if (fade_out_limit != 0) {
 639
 640                 framecnt_t const curve_offset = fade_interval_start - (_length - _fade_out->back()->when);
 641
 642                 if (opaque()) {
 643                         if (_inverse_fade_out) {
 644
 645                                 _inverse_fade_out->curve().get_vector (curve_offset, curve_offset + fade_out_limit, gain_buffer, fade_out_limit);
 646
 647                                 /* Fade the data from lower levels in */
 648                                 for (framecnt_t n = 0, m = fade_out_offset; n < fade_out_limit; ++n, ++m) {
 649                                         buf[m] *= gain_buffer[n];
 650                                 }
 651
 652                                 /* fetch the actual fade out */
 653
 654                                 _fade_out->curve().get_vector (curve_offset, curve_offset + fade_out_limit, gain_buffer, fade_out_limit);
 655
 656                         } else {
 657
 658                                 /* no explicit inverse fade out (which is
 659                                  * actually a fade in), so just use (1 - fade
 660                                  * out) for the fade in of lower layers
 661                                  */
 662
 663                                 _fade_out->curve().get_vector (curve_offset, curve_offset + fade_out_limit, gain_buffer, fade_out_limit);
 664
 665                                 for (framecnt_t n = 0, m = fade_out_offset; n < fade_out_limit; ++n, ++m) {
 666                                         buf[m] *= 1 - gain_buffer[n];
 667                                 }
 668                         }
 669                 } else {
 670                         _fade_out->curve().get_vector (curve_offset, curve_offset + fade_out_limit, gain_buffer, fade_out_limit);
 671                 }
 672
 673                 /* Mix our newly-read data with whatever was already there,
 674                    with the fade out applied to our data.
 675                 */
 676                 for (framecnt_t n = 0, m = fade_out_offset; n < fade_out_limit; ++n, ++m) {
 677                         buf[m] += mixdown_buffer[m] * gain_buffer[n];
 678                 }
 679         }
 680
 681         /* MIX OR COPY THE REGION BODY FROM mixdown_buffer INTO buf */
 682
 683         framecnt_t const N = to_read - fade_in_limit - fade_out_limit;
 684         if (N > 0) {
 685                 if (opaque ()) {
 686                         DEBUG_TRACE (DEBUG::AudioPlayback, string_compose ("Region %1 memcpy into buf @ %2 + %3, from mixdown buffer @ %4 + %5, len = %6 cnt was %7\n",
 687                                                                            name(), buf, fade_in_limit, mixdown_buffer, fade_in_limit, N, cnt));
 688                         memcpy (buf + fade_in_limit, mixdown_buffer + fade_in_limit, N * sizeof (Sample));
 689                 } else {
 690                         mix_buffers_no_gain (buf + fade_in_limit, mixdown_buffer + fade_in_limit, N);
 691                 }
 692         }
 693
 694         return to_read;
 695 }
 696
 697 /** Read data directly from one of our sources, accounting for the situation when the track has a different channel
 698  *  count to the region.
 699  *
 700  *  @param srcs Source list to get our source from.
 701  *  @param limit Furthest that we should read, as an offset from the region position.
 702  *  @param buf Buffer to write data into (existing contents of the buffer will be overwritten)
 703  *  @param position Position to read from, in session frames.
 704  *  @param cnt Number of frames to read.
 705  *  @param chan_n Channel to read from.
 706  *  @return Number of frames read.
 707  */
 708
 709 framecnt_t
 710 AudioRegion::read_from_sources (SourceList const & srcs, framecnt_t limit, Sample* buf, framepos_t position, framecnt_t cnt, uint32_t chan_n) const
 711 {
 712         frameoffset_t const internal_offset = position - _position;
 713         if (internal_offset >= limit) {
 714                 return 0;
 715         }
 716
 717         framecnt_t const to_read = min (cnt, limit - internal_offset);
 718         if (to_read == 0) {
 719                 return 0;
 720         }
 721
 722         if (chan_n < n_channels()) {
 723
 724                 boost::shared_ptr<AudioSource> src = boost::dynamic_pointer_cast<AudioSource> (srcs[chan_n]);
 725                 if (src->read (buf, _start + internal_offset, to_read) != to_read) {
 726                         return 0; /* "read nothing" */
 727                 }
 728
 729         } else {
 730
 731                 /* track is N-channel, this region has fewer channels; silence the ones
 732                    we don't have.
 733                 */
 734
 735                 if (Config->get_replicate_missing_region_channels()) {
 736
 737                         /* copy an existing channel's data in for this non-existant one */
 738
 739                         uint32_t channel = n_channels() % chan_n;
 740                         boost::shared_ptr<AudioSource> src = boost::dynamic_pointer_cast<AudioSource> (srcs[channel]);
 741
 742                         if (src->read (buf, _start + internal_offset, to_read) != to_read) {
 743                                 return 0; /* "read nothing" */
 744                         }
 745
 746                 } else {
 747
 748                         /* use silence */
 749                         memset (buf, 0, sizeof (Sample) * to_read);
 750                 }
 751         }
 752
 753         return to_read;
 754 }
 755
 756 XMLNode&
 757 AudioRegion::state ()
 758 {
 759         XMLNode& node (Region::state ());
 760         XMLNode *child;
 761         char buf[64];
 762         LocaleGuard lg (X_("POSIX"));
 763
 764         snprintf (buf, sizeof (buf), "%u", (uint32_t) _sources.size());
 765         node.add_property ("channels", buf);
 766
 767         child = node.add_child ("Envelope");
 768
 769         bool default_env = false;
 770
 771         // If there are only two points, the points are in the start of the region and the end of the region
 772         // so, if they are both at 1.0f, that means the default region.
 773
 774         if (_envelope->size() == 2 &&
 775             _envelope->front()->value == 1.0f &&
 776             _envelope->back()->value==1.0f) {
 777                 if (_envelope->front()->when == 0 && _envelope->back()->when == _length) {
 778                         default_env = true;
 779                 }
 780         }
 781
 782         if (default_env) {
 783                 child->add_property ("default", "yes");
 784         } else {
 785                 child->add_child_nocopy (_envelope->get_state ());
 786         }
 787
 788         child = node.add_child (X_("FadeIn"));
 789
 790         if (_default_fade_in) {
 791                 child->add_property ("default", "yes");
 792         } else {
 793                 child->add_child_nocopy (_fade_in->get_state ());
 794         }
 795
 796         if (_inverse_fade_in) {
 797                 child = node.add_child (X_("InverseFadeIn"));
 798                 child->add_child_nocopy (_inverse_fade_in->get_state ());
 799         }
 800
 801         child = node.add_child (X_("FadeOut"));
 802
 803         if (_default_fade_out) {
 804                 child->add_property ("default", "yes");
 805         } else {
 806                 child->add_child_nocopy (_fade_out->get_state ());
 807         }
 808
 809         if (_inverse_fade_out) {
 810                 child = node.add_child (X_("InverseFadeOut"));
 811                 child->add_child_nocopy (_inverse_fade_out->get_state ());
 812         }
 813
 814         return node;
 815 }
 816
 817 int
 818 AudioRegion::_set_state (const XMLNode& node, int version, PropertyChange& what_changed, bool send)
 819 {
 820         const XMLNodeList& nlist = node.children();
 821         const XMLProperty *prop;
 822         LocaleGuard lg (X_("POSIX"));
 823         boost::shared_ptr<Playlist> the_playlist (_playlist.lock());
 824
 825         suspend_property_changes ();
 826
 827         if (the_playlist) {
 828                 the_playlist->freeze ();
 829         }
 830
 831
 832         /* this will set all our State members and stuff controlled by the Region.
 833            It should NOT send any changed signals - that is our responsibility.
 834         */
 835
 836         Region::_set_state (node, version, what_changed, false);
 837
 838         if ((prop = node.property ("scale-gain")) != 0) {
 839                 float a = atof (prop->value().c_str());
 840                 if (a != _scale_amplitude) {
 841                         _scale_amplitude = a;
 842                         what_changed.add (Properties::scale_amplitude);
 843                 }
 844         }
 845
 846         /* Now find envelope description and other related child items */
 847
 848         _envelope->freeze ();
 849
 850         for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
 851                 XMLNode *child;
 852                 XMLProperty *prop;
 853
 854                 child = (*niter);
 855
 856                 if (child->name() == "Envelope") {
 857
 858                         _envelope->clear ();
 859
 860                         if ((prop = child->property ("default")) != 0 || _envelope->set_state (*child, version)) {
 861                                 set_default_envelope ();
 862                         }
 863
 864                         _envelope->truncate_end (_length);
 865
 866
 867                 } else if (child->name() == "FadeIn") {
 868
 869                         _fade_in->clear ();
 870
 871                         if (((prop = child->property ("default")) != 0 && string_is_affirmative (prop->value())) || (prop = child->property ("steepness")) != 0) {
 872                                 set_default_fade_in ();
 873                         } else {
 874                                 XMLNode* grandchild = child->child ("AutomationList");
 875                                 if (grandchild) {
 876                                         _fade_in->set_state (*grandchild, version);
 877                                 }
 878                         }
 879
 880                         if ((prop = child->property ("active")) != 0) {
 881                                 if (string_is_affirmative (prop->value())) {
 882                                         set_fade_in_active (true);
 883                                 } else {
 884                                         set_fade_in_active (false);
 885                                 }
 886                         }
 887
 888                 } else if (child->name() == "FadeOut") {
 889
 890                         _fade_out->clear ();
 891
 892                         if (((prop = child->property ("default")) != 0 && (string_is_affirmative (prop->value()))) || (prop = child->property ("steepness")) != 0) {
 893                                 set_default_fade_out ();
 894                         } else {
 895                                 XMLNode* grandchild = child->child ("AutomationList");
 896                                 if (grandchild) {
 897                                         _fade_out->set_state (*grandchild, version);
 898                                 }
 899                         }
 900
 901                         if ((prop = child->property ("active")) != 0) {
 902                                 if (string_is_affirmative (prop->value())) {
 903                                         set_fade_out_active (true);
 904                                 } else {
 905                                         set_fade_out_active (false);
 906                                 }
 907                         }
 908
 909                 } else if (child->name() == "InverseFadeIn") {
 910                         XMLNode* grandchild = child->child ("AutomationList");
 911                         if (grandchild) {
 912                                 _inverse_fade_in->set_state (*grandchild, version);
 913                         }
 914                 } else if (child->name() == "InverseFadeOut") {
 915                         XMLNode* grandchild = child->child ("AutomationList");
 916                         if (grandchild) {
 917                                 _inverse_fade_out->set_state (*grandchild, version);
 918                         }
 919                 }
 920         }
 921
 922         _envelope->thaw ();
 923         resume_property_changes ();
 924
 925         if (send) {
 926                 send_change (what_changed);
 927         }
 928
 929         if (the_playlist) {
 930                 the_playlist->thaw ();
 931         }
 932
 933         return 0;
 934 }
 935
 936 int
 937 AudioRegion::set_state (const XMLNode& node, int version)
 938 {
 939         PropertyChange what_changed;
 940         return _set_state (node, version, what_changed, true);
 941 }
 942
 943 void
 944 AudioRegion::set_fade_in_shape (FadeShape shape)
 945 {
 946         set_fade_in (shape, (framecnt_t) _fade_in->back()->when);
 947 }
 948
 949 void
 950 AudioRegion::set_fade_out_shape (FadeShape shape)
 951 {
 952         set_fade_out (shape, (framecnt_t) _fade_out->back()->when);
 953 }
 954
 955 void
 956 AudioRegion::set_fade_in (boost::shared_ptr<AutomationList> f)
 957 {
 958         _fade_in->freeze ();
 959         *(_fade_in.val()) = *f;
 960         _fade_in->thaw ();
 961         _default_fade_in = false;
 962
 963         send_change (PropertyChange (Properties::fade_in));
 964 }
 965
 966 void
 967 AudioRegion::set_fade_in (FadeShape shape, framecnt_t len)
 968 {
 969         boost::shared_ptr<Evoral::ControlList> c1 (new Evoral::ControlList (FadeInAutomation));
 970         boost::shared_ptr<Evoral::ControlList> c2 (new Evoral::ControlList (FadeInAutomation));
 971         boost::shared_ptr<Evoral::ControlList> c3 (new Evoral::ControlList (FadeInAutomation));
 972
 973         _fade_in->freeze ();
 974         _fade_in->clear ();
 975         _inverse_fade_in->clear ();
 976
 977         switch (shape) {
 978         case FadeLinear:
 979                 _fade_in->fast_simple_add (0.0, 0.0);
 980                 _fade_in->fast_simple_add (len, 1.0);
 981                 reverse_curve (_inverse_fade_in.val(), _fade_in.val());
 982                 break;
 983
 984         case FadeFast:
 985                 generate_db_fade (_fade_in.val(), len, 10, -60);
 986                 reverse_curve (c1, _fade_in.val());
 987                 _fade_in->copy_events (*c1);
 988                 generate_inverse_power_curve (_inverse_fade_in.val(), _fade_in.val());
 989                 break;
 990
 991         case FadeSlow:
 992                 generate_db_fade (c1, len, 10, -1);  // start off with a slow fade
 993                 generate_db_fade (c2, len, 10, -80); // end with a fast fade
 994                 merge_curves (_fade_in.val(), c1, c2);
 995                 reverse_curve (c3, _fade_in.val());
 996                 _fade_in->copy_events (*c3);
 997                 generate_inverse_power_curve (_inverse_fade_in.val(), _fade_in.val());
 998                 break;
 999
1000         case FadeConstantPower:
1001                 for (int i = 0; i < 9; ++i) {
1002                         float dist = (float) i / 10.0f;
1003                         _fade_in->fast_simple_add (len*dist, sin (dist*M_PI/2));
1004                 }
1005                 _fade_in->fast_simple_add (len, 1.0);
1006                 reverse_curve (_inverse_fade_in.val(), _fade_in.val());
1007                 break;
1008
1009         case FadeSymmetric:
1010                 //start with a nearly linear cuve
1011                 _fade_in->fast_simple_add (0, 1);
1012                 _fade_in->fast_simple_add (0.5*len, 0.6);
1013                 //now generate a fade-out curve by successively applying a gain drop
1014                 const float breakpoint = 0.7;  //linear for first 70%
1015                 const int num_steps = 9;
1016                 for (int i = 2; i < num_steps; i++) {
1017                         float coeff = (1.0-breakpoint);
1018                         for (int j = 0; j < i; j++) {
1019                                 coeff *= 0.5;  //6dB drop per step
1020                         }
1021                         _fade_in->fast_simple_add (len* (breakpoint+((1.0-breakpoint)*(double)i/(double)num_steps)), coeff);
1022                 }
1023                 _fade_in->fast_simple_add (len, VERY_SMALL_SIGNAL);
1024                 reverse_curve (c3, _fade_in.val());
1025                 _fade_in->copy_events (*c3);
1026                 reverse_curve (_inverse_fade_in.val(), _fade_in.val());
1027                 break;
1028         }
1029
1030         _default_fade_in = false;
1031         _fade_in->thaw ();
1032         send_change (PropertyChange (Properties::fade_in));
1033 }
1034
1035 void
1036 AudioRegion::set_fade_out (boost::shared_ptr<AutomationList> f)
1037 {
1038         _fade_out->freeze ();
1039         *(_fade_out.val()) = *f;
1040         _fade_out->thaw ();
1041         _default_fade_out = false;
1042
1043         send_change (PropertyChange (Properties::fade_in));
1044 }
1045
1046 void
1047 AudioRegion::set_fade_out (FadeShape shape, framecnt_t len)
1048 {
1049         boost::shared_ptr<Evoral::ControlList> c1 (new Evoral::ControlList (FadeOutAutomation));
1050         boost::shared_ptr<Evoral::ControlList> c2 (new Evoral::ControlList (FadeOutAutomation));
1051
1052         _fade_out->freeze ();
1053         _fade_out->clear ();
1054         _inverse_fade_out->clear ();
1055
1056         switch (shape) {
1057         case FadeLinear:
1058                 _fade_out->fast_simple_add (0.0, 1.0);
1059                 _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
1060                 reverse_curve (_inverse_fade_out.val(), _fade_out.val());
1061                 break;
1062
1063         case FadeFast:
1064                 generate_db_fade (_fade_out.val(), len, 10, -60);
1065                 generate_inverse_power_curve (_inverse_fade_out.val(), _fade_out.val());
1066                 break;
1067
1068         case FadeSlow:
1069                 generate_db_fade (c1, len, 10, -1);  //start off with a slow fade
1070                 generate_db_fade (c2, len, 10, -80);  //end with a fast fade
1071                 merge_curves (_fade_out.val(), c1, c2);
1072                 generate_inverse_power_curve (_inverse_fade_out.val(), _fade_out.val());
1073                 break;
1074
1075         case FadeConstantPower:
1076                 //constant-power fades use a sin/cos relationship
1077                 //the cutoff is abrupt but it has the benefit of being symmetrical
1078                 _fade_out->fast_simple_add (0.0, 1.0);
1079                 for (int i = 1; i < 9; i++ ) {
1080                         float dist = (float)i/10.0;
1081                         _fade_out->fast_simple_add ((len * dist), cos(dist*M_PI/2));
1082                 }
1083                 _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
1084                 reverse_curve (_inverse_fade_out.val(), _fade_out.val());
1085                 break;
1086
1087         case FadeSymmetric:
1088                 //start with a nearly linear cuve
1089                 _fade_out->fast_simple_add (0, 1);
1090                 _fade_out->fast_simple_add (0.5*len, 0.6);
1091
1092                 //now generate a fade-out curve by successively applying a gain drop
1093                 const float breakpoint = 0.7;  //linear for first 70%
1094                 const int num_steps = 9;
1095                 for (int i = 2; i < num_steps; i++) {
1096                         float coeff = (1.0-breakpoint);
1097                         for (int j = 0; j < i; j++) {
1098                                 coeff *= 0.5;  //6dB drop per step
1099                         }
1100                         _fade_out->fast_simple_add (len* (breakpoint+((1.0-breakpoint)*(double)i/(double)num_steps)), coeff);
1101                 }
1102                 _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
1103                 reverse_curve (_inverse_fade_out.val(), _fade_out.val());
1104                 break;
1105         }
1106
1107         _default_fade_out = false;
1108         _fade_out->thaw ();
1109         send_change (PropertyChange (Properties::fade_out));
1110 }
1111
1112 void
1113 AudioRegion::set_fade_in_length (framecnt_t len)
1114 {
1115         if (len > _length) {
1116                 len = _length - 1;
1117         }
1118
1119         if (len < 64) {
1120                 len = 64;
1121         }
1122
1123         bool changed = _fade_in->extend_to (len);
1124
1125         if (changed) {
1126                 if (_inverse_fade_in) {
1127                         _inverse_fade_in->extend_to (len);
1128                 }
1129
1130                 _default_fade_in = false;
1131                 send_change (PropertyChange (Properties::fade_in));
1132         }
1133 }
1134
1135 void
1136 AudioRegion::set_fade_out_length (framecnt_t len)
1137 {
1138         if (len > _length) {
1139                 len = _length - 1;
1140         }
1141
1142         if (len < 64) {
1143                 len = 64;
1144         }
1145
1146         bool changed =  _fade_out->extend_to (len);
1147
1148         if (changed) {
1149
1150                 if (_inverse_fade_out) {
1151                         _inverse_fade_out->extend_to (len);
1152                 }
1153                 _default_fade_out = false;
1154
1155                 send_change (PropertyChange (Properties::fade_out));
1156         }
1157 }
1158
1159 void
1160 AudioRegion::set_fade_in_active (bool yn)
1161 {
1162         if (yn == _fade_in_active) {
1163                 return;
1164         }
1165
1166         _fade_in_active = yn;
1167         send_change (PropertyChange (Properties::fade_in_active));
1168 }
1169
1170 void
1171 AudioRegion::set_fade_out_active (bool yn)
1172 {
1173         if (yn == _fade_out_active) {
1174                 return;
1175         }
1176         _fade_out_active = yn;
1177         send_change (PropertyChange (Properties::fade_out_active));
1178 }
1179
1180 bool
1181 AudioRegion::fade_in_is_default () const
1182 {
1183         return _fade_in->size() == 2 && _fade_in->front()->when == 0 && _fade_in->back()->when == 64;
1184 }
1185
1186 bool
1187 AudioRegion::fade_out_is_default () const
1188 {
1189         return _fade_out->size() == 2 && _fade_out->front()->when == 0 && _fade_out->back()->when == 64;
1190 }
1191
1192 void
1193 AudioRegion::set_default_fade_in ()
1194 {
1195         _fade_in_suspended = 0;
1196         set_fade_in (FadeLinear, 64);
1197 }
1198
1199 void
1200 AudioRegion::set_default_fade_out ()
1201 {
1202         _fade_out_suspended = 0;
1203         set_fade_out (FadeLinear, 64);
1204 }
1205
1206 void
1207 AudioRegion::set_default_fades ()
1208 {
1209         set_default_fade_in ();
1210         set_default_fade_out ();
1211 }
1212
1213 void
1214 AudioRegion::set_default_envelope ()
1215 {
1216         _envelope->freeze ();
1217         _envelope->clear ();
1218         _envelope->fast_simple_add (0, 1.0f);
1219         _envelope->fast_simple_add (_length, 1.0f);
1220         _envelope->thaw ();
1221 }
1222
1223 void
1224 AudioRegion::recompute_at_end ()
1225 {
1226         /* our length has changed. recompute a new final point by interpolating
1227            based on the the existing curve.
1228         */
1229
1230         _envelope->freeze ();
1231         _envelope->truncate_end (_length);
1232         _envelope->thaw ();
1233
1234         suspend_property_changes();
1235
1236         if (_left_of_split) {
1237                 set_default_fade_out ();
1238                 _left_of_split = false;
1239         } else if (_fade_out->back()->when > _length) {
1240                 _fade_out->extend_to (_length);
1241                 send_change (PropertyChange (Properties::fade_out));
1242         }
1243
1244         if (_fade_in->back()->when > _length) {
1245                 _fade_in->extend_to (_length);
1246                 send_change (PropertyChange (Properties::fade_in));
1247         }
1248
1249         resume_property_changes();
1250 }
1251
1252 void
1253 AudioRegion::recompute_at_start ()
1254 {
1255         /* as above, but the shift was from the front */
1256
1257         _envelope->truncate_start (_length);
1258
1259         suspend_property_changes();
1260
1261         if (_right_of_split) {
1262                 set_default_fade_in ();
1263                 _right_of_split = false;
1264         } else if (_fade_in->back()->when > _length) {
1265                 _fade_in->extend_to (_length);
1266                 send_change (PropertyChange (Properties::fade_in));
1267         }
1268
1269         if (_fade_out->back()->when > _length) {
1270                 _fade_out->extend_to (_length);
1271                 send_change (PropertyChange (Properties::fade_out));
1272         }
1273
1274         resume_property_changes();
1275 }
1276
1277 int
1278 AudioRegion::separate_by_channel (Session& /*session*/, vector<boost::shared_ptr<Region> >& v) const
1279 {
1280         SourceList srcs;
1281         string new_name;
1282         int n = 0;
1283
1284         if (_sources.size() < 2) {
1285                 return 0;
1286         }
1287
1288         for (SourceList::const_iterator i = _sources.begin(); i != _sources.end(); ++i) {
1289                 srcs.clear ();
1290                 srcs.push_back (*i);
1291
1292                 new_name = _name;
1293
1294                 if (_sources.size() == 2) {
1295                         if (n == 0) {
1296                                 new_name += "-L";
1297                         } else {
1298                                 new_name += "-R";
1299                         }
1300                 } else {
1301                         new_name += '-';
1302                         new_name += ('0' + n + 1);
1303                 }
1304
1305                 /* create a copy with just one source. prevent if from being thought of as
1306                    "whole file" even if it covers the entire source file(s).
1307                  */
1308
1309                 PropertyList plist;
1310
1311                 plist.add (Properties::start, _start.val());
1312                 plist.add (Properties::length, _length.val());
1313                 plist.add (Properties::name, new_name);
1314                 plist.add (Properties::layer, layer ());
1315
1316                 v.push_back(RegionFactory::create (srcs, plist));
1317                 v.back()->set_whole_file (false);
1318
1319                 ++n;
1320         }
1321
1322         return 0;
1323 }
1324
1325 framecnt_t
1326 AudioRegion::read_raw_internal (Sample* buf, framepos_t pos, framecnt_t cnt, int channel) const
1327 {
1328         return audio_source(channel)->read (buf, pos, cnt);
1329 }
1330
1331 void
1332 AudioRegion::set_scale_amplitude (gain_t g)
1333 {
1334         boost::shared_ptr<Playlist> pl (playlist());
1335
1336         _scale_amplitude = g;
1337
1338         /* tell the diskstream we're in */
1339
1340         if (pl) {
1341                 pl->ContentsChanged();
1342         }
1343
1344         /* tell everybody else */
1345
1346         send_change (PropertyChange (Properties::scale_amplitude));
1347 }
1348
1349 /** @return the maximum (linear) amplitude of the region, or a -ve
1350  *  number if the Progress object reports that the process was cancelled.
1351  */
1352 double
1353 AudioRegion::maximum_amplitude (Progress* p) const
1354 {
1355         framepos_t fpos = _start;
1356         framepos_t const fend = _start + _length;
1357         double maxamp = 0;
1358
1359         framecnt_t const blocksize = 64 * 1024;
1360         Sample buf[blocksize];
1361
1362         while (fpos < fend) {
1363
1364                 uint32_t n;
1365
1366                 framecnt_t const to_read = min (fend - fpos, blocksize);
1367
1368                 for (n = 0; n < n_channels(); ++n) {
1369
1370                         /* read it in */
1371
1372                         if (read_raw_internal (buf, fpos, to_read, n) != to_read) {
1373                                 return 0;
1374                         }
1375
1376                         maxamp = compute_peak (buf, to_read, maxamp);
1377                 }
1378
1379                 fpos += to_read;
1380                 if (p) {
1381                         p->set_progress (float (fpos - _start) / _length);
1382                         if (p->cancelled ()) {
1383                                 return -1;
1384                         }
1385                 }
1386         }
1387
1388         return maxamp;
1389 }
1390
1391 /** Normalize using a given maximum amplitude and target, so that region
1392  *  _scale_amplitude becomes target / max_amplitude.
1393  */
1394 void
1395 AudioRegion::normalize (float max_amplitude, float target_dB)
1396 {
1397         gain_t target = dB_to_coefficient (target_dB);
1398
1399         if (target == 1.0f) {
1400                 /* do not normalize to precisely 1.0 (0 dBFS), to avoid making it appear
1401                    that we may have clipped.
1402                 */
1403                 target -= FLT_EPSILON;
1404         }
1405
1406         if (max_amplitude == 0.0f) {
1407                 /* don't even try */
1408                 return;
1409         }
1410
1411         if (max_amplitude == target) {
1412                 /* we can't do anything useful */
1413                 return;
1414         }
1415
1416         set_scale_amplitude (target / max_amplitude);
1417 }
1418
1419 void
1420 AudioRegion::fade_in_changed ()
1421 {
1422         send_change (PropertyChange (Properties::fade_in));
1423 }
1424
1425 void
1426 AudioRegion::fade_out_changed ()
1427 {
1428         send_change (PropertyChange (Properties::fade_out));
1429 }
1430
1431 void
1432 AudioRegion::envelope_changed ()
1433 {
1434         send_change (PropertyChange (Properties::envelope));
1435 }
1436
1437 void
1438 AudioRegion::suspend_fade_in ()
1439 {
1440         if (++_fade_in_suspended == 1) {
1441                 if (fade_in_is_default()) {
1442                         set_fade_in_active (false);
1443                 }
1444         }
1445 }
1446
1447 void
1448 AudioRegion::resume_fade_in ()
1449 {
1450         if (--_fade_in_suspended == 0 && _fade_in_suspended) {
1451                 set_fade_in_active (true);
1452         }
1453 }
1454
1455 void
1456 AudioRegion::suspend_fade_out ()
1457 {
1458         if (++_fade_out_suspended == 1) {
1459                 if (fade_out_is_default()) {
1460                         set_fade_out_active (false);
1461                 }
1462         }
1463 }
1464
1465 void
1466 AudioRegion::resume_fade_out ()
1467 {
1468         if (--_fade_out_suspended == 0 &&_fade_out_suspended) {
1469                 set_fade_out_active (true);
1470         }
1471 }
1472
1473 bool
1474 AudioRegion::speed_mismatch (float sr) const
1475 {
1476         if (_sources.empty()) {
1477                 /* impossible, but ... */
1478                 return false;
1479         }
1480
1481         float fsr = audio_source()->sample_rate();
1482
1483         return fsr != sr;
1484 }
1485
1486 void
1487 AudioRegion::source_offset_changed ()
1488 {
1489         /* XXX this fixes a crash that should not occur. It does occur
1490            becauses regions are not being deleted when a session
1491            is unloaded. That bug must be fixed.
1492         */
1493
1494         if (_sources.empty()) {
1495                 return;
1496         }
1497
1498         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(_sources.front());
1499
1500         if (afs && afs->destructive()) {
1501                 // set_start (source()->natural_position(), this);
1502                 set_position (source()->natural_position());
1503         }
1504 }
1505
1506 boost::shared_ptr<AudioSource>
1507 AudioRegion::audio_source (uint32_t n) const
1508 {
1509         // Guaranteed to succeed (use a static cast for speed?)
1510         return boost::dynamic_pointer_cast<AudioSource>(source(n));
1511 }
1512
1513 int
1514 AudioRegion::adjust_transients (frameoffset_t delta)
1515 {
1516         for (AnalysisFeatureList::iterator x = _transients.begin(); x != _transients.end(); ++x) {
1517                 (*x) = (*x) + delta;
1518         }
1519
1520         send_change (PropertyChange (Properties::valid_transients));
1521
1522         return 0;
1523 }
1524
1525 int
1526 AudioRegion::update_transient (framepos_t old_position, framepos_t new_position)
1527 {
1528         for (AnalysisFeatureList::iterator x = _transients.begin(); x != _transients.end(); ++x) {
1529                 if ((*x) == old_position) {
1530                         (*x) = new_position;
1531                         send_change (PropertyChange (Properties::valid_transients));
1532
1533                         break;
1534                 }
1535         }
1536
1537         return 0;
1538 }
1539
1540 void
1541 AudioRegion::add_transient (framepos_t where)
1542 {
1543         _transients.push_back(where);
1544         _valid_transients = true;
1545
1546         send_change (PropertyChange (Properties::valid_transients));
1547 }
1548
1549 void
1550 AudioRegion::remove_transient (framepos_t where)
1551 {
1552         _transients.remove(where);
1553         _valid_transients = true;
1554
1555         send_change (PropertyChange (Properties::valid_transients));
1556 }
1557
1558 int
1559 AudioRegion::set_transients (AnalysisFeatureList& results)
1560 {
1561         _transients.clear();
1562         _transients = results;
1563         _valid_transients = true;
1564
1565         send_change (PropertyChange (Properties::valid_transients));
1566
1567         return 0;
1568 }
1569
1570 int
1571 AudioRegion::get_transients (AnalysisFeatureList& results, bool force_new)
1572 {
1573         boost::shared_ptr<Playlist> pl = playlist();
1574
1575         if (!pl) {
1576                 return -1;
1577         }
1578
1579         if (_valid_transients && !force_new) {
1580                 results = _transients;
1581                 return 0;
1582         }
1583
1584         SourceList::iterator s;
1585
1586         for (s = _sources.begin() ; s != _sources.end(); ++s) {
1587                 if (!(*s)->has_been_analysed()) {
1588                         cerr << "For " << name() << " source " << (*s)->name() << " has not been analyzed\n";
1589                         break;
1590                 }
1591         }
1592
1593         if (s == _sources.end()) {
1594                 /* all sources are analyzed, merge data from each one */
1595
1596                 for (s = _sources.begin() ; s != _sources.end(); ++s) {
1597
1598                         /* find the set of transients within the bounds of this region */
1599
1600                         AnalysisFeatureList::iterator low = lower_bound ((*s)->transients.begin(),
1601                                                                          (*s)->transients.end(),
1602                                                                          _start);
1603
1604                         AnalysisFeatureList::iterator high = upper_bound ((*s)->transients.begin(),
1605                                                                           (*s)->transients.end(),
1606                                                                           _start + _length);
1607
1608                         /* and add them */
1609
1610                         results.insert (results.end(), low, high);
1611                 }
1612
1613                 TransientDetector::cleanup_transients (results, pl->session().frame_rate(), 3.0);
1614
1615                 /* translate all transients to current position */
1616
1617                 for (AnalysisFeatureList::iterator x = results.begin(); x != results.end(); ++x) {
1618                         (*x) -= _start;
1619                         (*x) += _position;
1620                 }
1621
1622                 _transients = results;
1623                 _valid_transients = true;
1624
1625                 return 0;
1626         }
1627
1628         /* no existing/complete transient info */
1629
1630         static bool analyse_dialog_shown = false; /* global per instance of Ardour */
1631
1632         if (!Config->get_auto_analyse_audio()) {
1633                 if (!analyse_dialog_shown) {
1634                         pl->session().Dialog (_("\
1635 You have requested an operation that requires audio analysis.\n\n\
1636 You currently have \"auto-analyse-audio\" disabled, which means \
1637 that transient data must be generated every time it is required.\n\n\
1638 If you are doing work that will require transient data on a \
1639 regular basis, you should probably enable \"auto-analyse-audio\" \
1640 then quit ardour and restart.\n\n\
1641 This dialog will not display again.  But you may notice a slight delay \
1642 in this and future transient-detection operations.\n\
1643 "));
1644                         analyse_dialog_shown = true;
1645                 }
1646         }
1647
1648         TransientDetector t (pl->session().frame_rate());
1649         bool existing_results = !results.empty();
1650
1651         _transients.clear ();
1652         _valid_transients = false;
1653
1654         for (uint32_t i = 0; i < n_channels(); ++i) {
1655
1656                 AnalysisFeatureList these_results;
1657
1658                 t.reset ();
1659
1660                 if (t.run ("", this, i, these_results)) {
1661                         return -1;
1662                 }
1663
1664                 /* translate all transients to give absolute position */
1665
1666                 for (AnalysisFeatureList::iterator i = these_results.begin(); i != these_results.end(); ++i) {
1667                         (*i) += _position;
1668                 }
1669
1670                 /* merge */
1671
1672                 _transients.insert (_transients.end(), these_results.begin(), these_results.end());
1673         }
1674
1675         if (!results.empty()) {
1676                 if (existing_results) {
1677
1678                         /* merge our transients into the existing ones, then clean up
1679                            those.
1680                         */
1681
1682                         results.insert (results.end(), _transients.begin(), _transients.end());
1683                         TransientDetector::cleanup_transients (results, pl->session().frame_rate(), 3.0);
1684                 }
1685
1686                 /* make sure ours are clean too */
1687
1688                 TransientDetector::cleanup_transients (_transients, pl->session().frame_rate(), 3.0);
1689
1690         } else {
1691
1692                 TransientDetector::cleanup_transients (_transients, pl->session().frame_rate(), 3.0);
1693                 results = _transients;
1694         }
1695
1696         _valid_transients = true;
1697
1698         return 0;
1699 }
1700
1701 /** Find areas of `silence' within a region.
1702  *
1703  *  @param threshold Threshold below which signal is considered silence (as a sample value)
1704  *  @param min_length Minimum length of silent period to be reported.
1705  *  @return Silent intervals, measured relative to the region start in the source
1706  */
1707
1708 AudioIntervalResult
1709 AudioRegion::find_silence (Sample threshold, framecnt_t min_length, InterThreadInfo& itt) const
1710 {
1711         framecnt_t const block_size = 64 * 1024;
1712         boost::scoped_array<Sample> loudest (new Sample[block_size]);
1713         boost::scoped_array<Sample> buf (new Sample[block_size]);
1714
1715         framepos_t pos = _start;
1716         framepos_t const end = _start + _length - 1;
1717
1718         AudioIntervalResult silent_periods;
1719
1720         bool in_silence = false;
1721         frameoffset_t silence_start = 0;
1722
1723         while (pos < end && !itt.cancel) {
1724
1725                 /* fill `loudest' with the loudest absolute sample at each instant, across all channels */
1726                 memset (loudest.get(), 0, sizeof (Sample) * block_size);
1727                 for (uint32_t n = 0; n < n_channels(); ++n) {
1728
1729                         read_raw_internal (buf.get(), pos, block_size, n);
1730                         for (framecnt_t i = 0; i < block_size; ++i) {
1731                                 loudest[i] = max (loudest[i], abs (buf[i]));
1732                         }
1733                 }
1734
1735                 /* now look for silence */
1736                 for (framecnt_t i = 0; i < block_size; ++i) {
1737                         bool const silence = abs (loudest[i]) < threshold;
1738                         if (silence && !in_silence) {
1739                                 /* non-silence to silence */
1740                                 in_silence = true;
1741                                 silence_start = pos + i;
1742                         } else if (!silence && in_silence) {
1743                                 /* silence to non-silence */
1744                                 in_silence = false;
1745                                 if (pos + i - 1 - silence_start >= min_length) {
1746                                         silent_periods.push_back (std::make_pair (silence_start, pos + i - 1));
1747                                 }
1748                         }
1749                 }
1750
1751                 pos += block_size;
1752                 itt.progress = (end-pos)/(double)_length;
1753         }
1754
1755         if (in_silence && end - 1 - silence_start >= min_length) {
1756                 /* last block was silent, so finish off the last period */
1757                 silent_periods.push_back (std::make_pair (silence_start, end));
1758         }
1759
1760         itt.done = true;
1761
1762         return silent_periods;
1763 }
1764
1765 Evoral::Range<framepos_t>
1766 AudioRegion::body_range () const
1767 {
1768         return Evoral::Range<framepos_t> (first_frame() + _fade_in->back()->when + 1, last_frame() - _fade_out->back()->when);
1769 }
1770
1771 boost::shared_ptr<Region>
1772 AudioRegion::get_single_other_xfade_region (bool start) const
1773 {
1774         boost::shared_ptr<Playlist> pl (playlist());
1775
1776         if (!pl) {
1777                 /* not currently in a playlist - xfade length is unbounded
1778                    (and irrelevant)
1779                 */
1780                 return boost::shared_ptr<AudioRegion> ();
1781         }
1782
1783         boost::shared_ptr<RegionList> rl;
1784
1785         if (start) {
1786                 rl = pl->regions_at (position());
1787         } else {
1788                 rl = pl->regions_at (last_frame());
1789         }
1790
1791         RegionList::iterator i;
1792         boost::shared_ptr<Region> other;
1793         uint32_t n = 0;
1794
1795         /* count and find the other region in a single pass through the list */
1796
1797         for (i = rl->begin(); i != rl->end(); ++i) {
1798                 if ((*i).get() != this) {
1799                         other = *i;
1800                 }
1801                 ++n;
1802         }
1803
1804         if (n != 2) {
1805                 /* zero or multiple regions stacked here - don't care about xfades */
1806                 return boost::shared_ptr<AudioRegion> ();
1807         }
1808
1809         return other;
1810 }
1811
1812 framecnt_t
1813 AudioRegion::verify_xfade_bounds (framecnt_t len, bool start)
1814 {
1815         /* this is called from a UI to check on whether a new proposed
1816            length for an xfade is legal or not. it returns the legal
1817            length corresponding to @a len which may be shorter than or
1818            equal to @a len itself.
1819         */
1820
1821         boost::shared_ptr<Region> other = get_single_other_xfade_region (start);
1822         framecnt_t maxlen;
1823
1824         if (!other) {
1825                 /* zero or > 2 regions here, don't care about len, but
1826                    it can't be longer than the region itself.
1827                  */
1828                 return min (length(), len);
1829         }
1830
1831         /* we overlap a single region. clamp the length of an xfade to
1832            the maximum possible duration of the overlap (if the other
1833            region were trimmed appropriately).
1834         */
1835
1836         if (start) {
1837                 maxlen = other->latest_possible_frame() - position();
1838         } else {
1839                 maxlen = last_frame() - other->earliest_possible_position();
1840         }
1841
1842         return min (length(), min (maxlen, len));
1843
1844 }
1845
1846 extern "C" {
1847
1848         int region_read_peaks_from_c (void *arg, uint32_t npeaks, uint32_t start, uint32_t cnt, intptr_t data, uint32_t n_chan, double samples_per_unit)
1849 {
1850         return ((AudioRegion *) arg)->read_peaks ((PeakData *) data, (framecnt_t) npeaks, (framepos_t) start, (framecnt_t) cnt, n_chan,samples_per_unit);
1851 }
1852
1853 uint32_t region_length_from_c (void *arg)
1854 {
1855
1856         return ((AudioRegion *) arg)->length();
1857 }
1858
1859 uint32_t sourcefile_length_from_c (void *arg, double zoom_factor)
1860 {
1861         return ( (AudioRegion *) arg)->audio_source()->available_peaks (zoom_factor) ;
1862 }
1863
1864 } /* extern "C" */