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         Stateful::add_properties (node);
 768
 769         child = node.add_child ("Envelope");
 770
 771         bool default_env = false;
 772
 773         // If there are only two points, the points are in the start of the region and the end of the region
 774         // so, if they are both at 1.0f, that means the default region.
 775
 776         if (_envelope->size() == 2 &&
 777             _envelope->front()->value == 1.0f &&
 778             _envelope->back()->value==1.0f) {
 779                 if (_envelope->front()->when == 0 && _envelope->back()->when == _length) {
 780                         default_env = true;
 781                 }
 782         }
 783
 784         if (default_env) {
 785                 child->add_property ("default", "yes");
 786         } else {
 787                 child->add_child_nocopy (_envelope->get_state ());
 788         }
 789
 790         child = node.add_child (X_("FadeIn"));
 791
 792         if (_default_fade_in) {
 793                 child->add_property ("default", "yes");
 794         } else {
 795                 child->add_child_nocopy (_fade_in->get_state ());
 796         }
 797
 798         if (_inverse_fade_in) {
 799                 child = node.add_child (X_("InvFadeIn"));
 800                 child->add_child_nocopy (_inverse_fade_in->get_state ());
 801         }
 802
 803         child = node.add_child (X_("FadeOut"));
 804
 805         if (_default_fade_out) {
 806                 child->add_property ("default", "yes");
 807         } else {
 808                 child->add_child_nocopy (_fade_out->get_state ());
 809         }
 810
 811         if (_inverse_fade_out) {
 812                 child = node.add_child (X_("InvFadeOut"));
 813                 child->add_child_nocopy (_inverse_fade_out->get_state ());
 814         }
 815
 816         return node;
 817 }
 818
 819 int
 820 AudioRegion::_set_state (const XMLNode& node, int version, PropertyChange& what_changed, bool send)
 821 {
 822         const XMLNodeList& nlist = node.children();
 823         const XMLProperty *prop;
 824         LocaleGuard lg (X_("POSIX"));
 825         boost::shared_ptr<Playlist> the_playlist (_playlist.lock());
 826
 827         suspend_property_changes ();
 828
 829         if (the_playlist) {
 830                 the_playlist->freeze ();
 831         }
 832
 833
 834         /* this will set all our State members and stuff controlled by the Region.
 835            It should NOT send any changed signals - that is our responsibility.
 836         */
 837
 838         Region::_set_state (node, version, what_changed, false);
 839
 840         if ((prop = node.property ("scale-gain")) != 0) {
 841                 float a = atof (prop->value().c_str());
 842                 if (a != _scale_amplitude) {
 843                         _scale_amplitude = a;
 844                         what_changed.add (Properties::scale_amplitude);
 845                 }
 846         }
 847
 848         /* Now find envelope description and other related child items */
 849
 850         _envelope->freeze ();
 851
 852         for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
 853                 XMLNode *child;
 854                 XMLProperty *prop;
 855
 856                 child = (*niter);
 857
 858                 if (child->name() == "Envelope") {
 859
 860                         _envelope->clear ();
 861
 862                         if ((prop = child->property ("default")) != 0 || _envelope->set_state (*child, version)) {
 863                                 set_default_envelope ();
 864                         }
 865
 866                         _envelope->truncate_end (_length);
 867
 868
 869                 } else if (child->name() == "FadeIn") {
 870
 871                         _fade_in->clear ();
 872
 873                         if (((prop = child->property ("default")) != 0 && string_is_affirmative (prop->value())) || (prop = child->property ("steepness")) != 0) {
 874                                 set_default_fade_in ();
 875                         } else {
 876                                 XMLNode* grandchild = child->child ("AutomationList");
 877                                 if (grandchild) {
 878                                         _fade_in->set_state (*grandchild, version);
 879                                 }
 880                         }
 881
 882                         if ((prop = child->property ("active")) != 0) {
 883                                 if (string_is_affirmative (prop->value())) {
 884                                         set_fade_in_active (true);
 885                                 } else {
 886                                         set_fade_in_active (false);
 887                                 }
 888                         }
 889
 890                 } else if (child->name() == "FadeOut") {
 891
 892                         _fade_out->clear ();
 893
 894                         if (((prop = child->property ("default")) != 0 && (string_is_affirmative (prop->value()))) || (prop = child->property ("steepness")) != 0) {
 895                                 set_default_fade_out ();
 896                         } else {
 897                                 XMLNode* grandchild = child->child ("AutomationList");
 898                                 if (grandchild) {
 899                                         _fade_out->set_state (*grandchild, version);
 900                                 }
 901                         }
 902
 903                         if ((prop = child->property ("active")) != 0) {
 904                                 if (string_is_affirmative (prop->value())) {
 905                                         set_fade_out_active (true);
 906                                 } else {
 907                                         set_fade_out_active (false);
 908                                 }
 909                         }
 910
 911                 } else if (child->name() == "InvFadeIn") {
 912                         XMLNode* grandchild = child->child ("AutomationList");
 913                         if (grandchild) {
 914                                 _inverse_fade_in->set_state (*grandchild, version);
 915                         }
 916                 } else if (child->name() == "InvFadeOut") {
 917                         XMLNode* grandchild = child->child ("AutomationList");
 918                         if (grandchild) {
 919                                 _inverse_fade_out->set_state (*grandchild, version);
 920                         }
 921                 }
 922         }
 923
 924         _envelope->thaw ();
 925         resume_property_changes ();
 926
 927         if (send) {
 928                 send_change (what_changed);
 929         }
 930
 931         if (the_playlist) {
 932                 the_playlist->thaw ();
 933         }
 934
 935         return 0;
 936 }
 937
 938 int
 939 AudioRegion::set_state (const XMLNode& node, int version)
 940 {
 941         PropertyChange what_changed;
 942         return _set_state (node, version, what_changed, true);
 943 }
 944
 945 void
 946 AudioRegion::set_fade_in_shape (FadeShape shape)
 947 {
 948         set_fade_in (shape, (framecnt_t) _fade_in->back()->when);
 949 }
 950
 951 void
 952 AudioRegion::set_fade_out_shape (FadeShape shape)
 953 {
 954         set_fade_out (shape, (framecnt_t) _fade_out->back()->when);
 955 }
 956
 957 void
 958 AudioRegion::set_fade_in (boost::shared_ptr<AutomationList> f)
 959 {
 960         _fade_in->freeze ();
 961         *(_fade_in.val()) = *f;
 962         _fade_in->thaw ();
 963         _default_fade_in = false;
 964
 965         send_change (PropertyChange (Properties::fade_in));
 966 }
 967
 968 void
 969 AudioRegion::set_fade_in (FadeShape shape, framecnt_t len)
 970 {
 971         boost::shared_ptr<Evoral::ControlList> c1 (new Evoral::ControlList (FadeInAutomation));
 972         boost::shared_ptr<Evoral::ControlList> c2 (new Evoral::ControlList (FadeInAutomation));
 973         boost::shared_ptr<Evoral::ControlList> c3 (new Evoral::ControlList (FadeInAutomation));
 974
 975         _fade_in->freeze ();
 976         _fade_in->clear ();
 977         _inverse_fade_in->clear ();
 978
 979         switch (shape) {
 980         case FadeLinear:
 981                 _fade_in->fast_simple_add (0.0, 0.0);
 982                 _fade_in->fast_simple_add (len, 1.0);
 983                 reverse_curve (_inverse_fade_in.val(), _fade_in.val());
 984                 break;
 985
 986         case FadeFast:
 987                 generate_db_fade (_fade_in.val(), len, 10, -60);
 988                 reverse_curve (c1, _fade_in.val());
 989                 _fade_in->copy_events (*c1);
 990                 generate_inverse_power_curve (_inverse_fade_in.val(), _fade_in.val());
 991                 break;
 992
 993         case FadeSlow:
 994                 generate_db_fade (c1, len, 10, -1);  // start off with a slow fade
 995                 generate_db_fade (c2, len, 10, -80); // end with a fast fade
 996                 merge_curves (_fade_in.val(), c1, c2);
 997                 reverse_curve (c3, _fade_in.val());
 998                 _fade_in->copy_events (*c3);
 999                 generate_inverse_power_curve (_inverse_fade_in.val(), _fade_in.val());
1000                 break;
1001
1002         case FadeConstantPower:
1003                 for (int i = 0; i < 9; ++i) {
1004                         float dist = (float) i / 10.0f;
1005                         _fade_in->fast_simple_add (len*dist, sin (dist*M_PI/2));
1006                 }
1007                 _fade_in->fast_simple_add (len, 1.0);
1008                 reverse_curve (_inverse_fade_in.val(), _fade_in.val());
1009                 break;
1010
1011         case FadeSymmetric:
1012                 //start with a nearly linear cuve
1013                 _fade_in->fast_simple_add (0, 1);
1014                 _fade_in->fast_simple_add (0.5*len, 0.6);
1015                 //now generate a fade-out curve by successively applying a gain drop
1016                 const float breakpoint = 0.7;  //linear for first 70%
1017                 const int num_steps = 9;
1018                 for (int i = 2; i < num_steps; i++) {
1019                         float coeff = (1.0-breakpoint);
1020                         for (int j = 0; j < i; j++) {
1021                                 coeff *= 0.5;  //6dB drop per step
1022                         }
1023                         _fade_in->fast_simple_add (len* (breakpoint+((1.0-breakpoint)*(double)i/(double)num_steps)), coeff);
1024                 }
1025                 _fade_in->fast_simple_add (len, VERY_SMALL_SIGNAL);
1026                 reverse_curve (c3, _fade_in.val());
1027                 _fade_in->copy_events (*c3);
1028                 reverse_curve (_inverse_fade_in.val(), _fade_in.val());
1029                 break;
1030         }
1031
1032         _default_fade_in = false;
1033         _fade_in->thaw ();
1034         send_change (PropertyChange (Properties::fade_in));
1035 }
1036
1037 void
1038 AudioRegion::set_fade_out (boost::shared_ptr<AutomationList> f)
1039 {
1040         _fade_out->freeze ();
1041         *(_fade_out.val()) = *f;
1042         _fade_out->thaw ();
1043         _default_fade_out = false;
1044
1045         send_change (PropertyChange (Properties::fade_in));
1046 }
1047
1048 void
1049 AudioRegion::set_fade_out (FadeShape shape, framecnt_t len)
1050 {
1051         boost::shared_ptr<Evoral::ControlList> c1 (new Evoral::ControlList (FadeOutAutomation));
1052         boost::shared_ptr<Evoral::ControlList> c2 (new Evoral::ControlList (FadeOutAutomation));
1053
1054         _fade_out->freeze ();
1055         _fade_out->clear ();
1056         _inverse_fade_out->clear ();
1057
1058         switch (shape) {
1059         case FadeLinear:
1060                 _fade_out->fast_simple_add (0.0, 1.0);
1061                 _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
1062                 reverse_curve (_inverse_fade_out.val(), _fade_out.val());
1063                 break;
1064
1065         case FadeFast:
1066                 generate_db_fade (_fade_out.val(), len, 10, -60);
1067                 generate_inverse_power_curve (_inverse_fade_out.val(), _fade_out.val());
1068                 break;
1069
1070         case FadeSlow:
1071                 generate_db_fade (c1, len, 10, -1);  //start off with a slow fade
1072                 generate_db_fade (c2, len, 10, -80);  //end with a fast fade
1073                 merge_curves (_fade_out.val(), c1, c2);
1074                 generate_inverse_power_curve (_inverse_fade_out.val(), _fade_out.val());
1075                 break;
1076
1077         case FadeConstantPower:
1078                 //constant-power fades use a sin/cos relationship
1079                 //the cutoff is abrupt but it has the benefit of being symmetrical
1080                 _fade_out->fast_simple_add (0.0, 1.0);
1081                 for (int i = 1; i < 9; i++ ) {
1082                         float dist = (float)i/10.0;
1083                         _fade_out->fast_simple_add ((len * dist), cos(dist*M_PI/2));
1084                 }
1085                 _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
1086                 reverse_curve (_inverse_fade_out.val(), _fade_out.val());
1087                 break;
1088
1089         case FadeSymmetric:
1090                 //start with a nearly linear cuve
1091                 _fade_out->fast_simple_add (0, 1);
1092                 _fade_out->fast_simple_add (0.5*len, 0.6);
1093
1094                 //now generate a fade-out curve by successively applying a gain drop
1095                 const float breakpoint = 0.7;  //linear for first 70%
1096                 const int num_steps = 9;
1097                 for (int i = 2; i < num_steps; i++) {
1098                         float coeff = (1.0-breakpoint);
1099                         for (int j = 0; j < i; j++) {
1100                                 coeff *= 0.5;  //6dB drop per step
1101                         }
1102                         _fade_out->fast_simple_add (len* (breakpoint+((1.0-breakpoint)*(double)i/(double)num_steps)), coeff);
1103                 }
1104                 _fade_out->fast_simple_add (len, VERY_SMALL_SIGNAL);
1105                 reverse_curve (_inverse_fade_out.val(), _fade_out.val());
1106                 break;
1107         }
1108
1109         _default_fade_out = false;
1110         _fade_out->thaw ();
1111         send_change (PropertyChange (Properties::fade_out));
1112 }
1113
1114 void
1115 AudioRegion::set_fade_in_length (framecnt_t len)
1116 {
1117         if (len > _length) {
1118                 len = _length - 1;
1119         }
1120
1121         if (len < 64) {
1122                 len = 64;
1123         }
1124
1125         bool changed = _fade_in->extend_to (len);
1126
1127         if (changed) {
1128                 if (_inverse_fade_in) {
1129                         _inverse_fade_in->extend_to (len);
1130                 }
1131
1132                 _default_fade_in = false;
1133                 send_change (PropertyChange (Properties::fade_in));
1134         }
1135 }
1136
1137 void
1138 AudioRegion::set_fade_out_length (framecnt_t len)
1139 {
1140         if (len > _length) {
1141                 len = _length - 1;
1142         }
1143
1144         if (len < 64) {
1145                 len = 64;
1146         }
1147
1148         bool changed =  _fade_out->extend_to (len);
1149
1150         if (changed) {
1151
1152                 if (_inverse_fade_out) {
1153                         _inverse_fade_out->extend_to (len);
1154                 }
1155                 _default_fade_out = false;
1156
1157                 send_change (PropertyChange (Properties::fade_out));
1158         }
1159 }
1160
1161 void
1162 AudioRegion::set_fade_in_active (bool yn)
1163 {
1164         if (yn == _fade_in_active) {
1165                 return;
1166         }
1167
1168         _fade_in_active = yn;
1169         send_change (PropertyChange (Properties::fade_in_active));
1170 }
1171
1172 void
1173 AudioRegion::set_fade_out_active (bool yn)
1174 {
1175         if (yn == _fade_out_active) {
1176                 return;
1177         }
1178         _fade_out_active = yn;
1179         send_change (PropertyChange (Properties::fade_out_active));
1180 }
1181
1182 bool
1183 AudioRegion::fade_in_is_default () const
1184 {
1185         return _fade_in->size() == 2 && _fade_in->front()->when == 0 && _fade_in->back()->when == 64;
1186 }
1187
1188 bool
1189 AudioRegion::fade_out_is_default () const
1190 {
1191         return _fade_out->size() == 2 && _fade_out->front()->when == 0 && _fade_out->back()->when == 64;
1192 }
1193
1194 void
1195 AudioRegion::set_default_fade_in ()
1196 {
1197         _fade_in_suspended = 0;
1198         set_fade_in (FadeLinear, 64);
1199 }
1200
1201 void
1202 AudioRegion::set_default_fade_out ()
1203 {
1204         _fade_out_suspended = 0;
1205         set_fade_out (FadeLinear, 64);
1206 }
1207
1208 void
1209 AudioRegion::set_default_fades ()
1210 {
1211         set_default_fade_in ();
1212         set_default_fade_out ();
1213 }
1214
1215 void
1216 AudioRegion::set_default_envelope ()
1217 {
1218         _envelope->freeze ();
1219         _envelope->clear ();
1220         _envelope->fast_simple_add (0, 1.0f);
1221         _envelope->fast_simple_add (_length, 1.0f);
1222         _envelope->thaw ();
1223 }
1224
1225 void
1226 AudioRegion::recompute_at_end ()
1227 {
1228         /* our length has changed. recompute a new final point by interpolating
1229            based on the the existing curve.
1230         */
1231
1232         _envelope->freeze ();
1233         _envelope->truncate_end (_length);
1234         _envelope->thaw ();
1235
1236         suspend_property_changes();
1237
1238         if (_left_of_split) {
1239                 set_default_fade_out ();
1240                 _left_of_split = false;
1241         } else if (_fade_out->back()->when > _length) {
1242                 _fade_out->extend_to (_length);
1243                 send_change (PropertyChange (Properties::fade_out));
1244         }
1245
1246         if (_fade_in->back()->when > _length) {
1247                 _fade_in->extend_to (_length);
1248                 send_change (PropertyChange (Properties::fade_in));
1249         }
1250
1251         resume_property_changes();
1252 }
1253
1254 void
1255 AudioRegion::recompute_at_start ()
1256 {
1257         /* as above, but the shift was from the front */
1258
1259         _envelope->truncate_start (_length);
1260
1261         suspend_property_changes();
1262
1263         if (_right_of_split) {
1264                 set_default_fade_in ();
1265                 _right_of_split = false;
1266         } else if (_fade_in->back()->when > _length) {
1267                 _fade_in->extend_to (_length);
1268                 send_change (PropertyChange (Properties::fade_in));
1269         }
1270
1271         if (_fade_out->back()->when > _length) {
1272                 _fade_out->extend_to (_length);
1273                 send_change (PropertyChange (Properties::fade_out));
1274         }
1275
1276         resume_property_changes();
1277 }
1278
1279 int
1280 AudioRegion::separate_by_channel (Session& /*session*/, vector<boost::shared_ptr<Region> >& v) const
1281 {
1282         SourceList srcs;
1283         string new_name;
1284         int n = 0;
1285
1286         if (_sources.size() < 2) {
1287                 return 0;
1288         }
1289
1290         for (SourceList::const_iterator i = _sources.begin(); i != _sources.end(); ++i) {
1291                 srcs.clear ();
1292                 srcs.push_back (*i);
1293
1294                 new_name = _name;
1295
1296                 if (_sources.size() == 2) {
1297                         if (n == 0) {
1298                                 new_name += "-L";
1299                         } else {
1300                                 new_name += "-R";
1301                         }
1302                 } else {
1303                         new_name += '-';
1304                         new_name += ('0' + n + 1);
1305                 }
1306
1307                 /* create a copy with just one source. prevent if from being thought of as
1308                    "whole file" even if it covers the entire source file(s).
1309                  */
1310
1311                 PropertyList plist;
1312
1313                 plist.add (Properties::start, _start.val());
1314                 plist.add (Properties::length, _length.val());
1315                 plist.add (Properties::name, new_name);
1316                 plist.add (Properties::layer, layer ());
1317
1318                 v.push_back(RegionFactory::create (srcs, plist));
1319                 v.back()->set_whole_file (false);
1320
1321                 ++n;
1322         }
1323
1324         return 0;
1325 }
1326
1327 framecnt_t
1328 AudioRegion::read_raw_internal (Sample* buf, framepos_t pos, framecnt_t cnt, int channel) const
1329 {
1330         return audio_source(channel)->read (buf, pos, cnt);
1331 }
1332
1333 void
1334 AudioRegion::set_scale_amplitude (gain_t g)
1335 {
1336         boost::shared_ptr<Playlist> pl (playlist());
1337
1338         _scale_amplitude = g;
1339
1340         /* tell the diskstream we're in */
1341
1342         if (pl) {
1343                 pl->ContentsChanged();
1344         }
1345
1346         /* tell everybody else */
1347
1348         send_change (PropertyChange (Properties::scale_amplitude));
1349 }
1350
1351 /** @return the maximum (linear) amplitude of the region, or a -ve
1352  *  number if the Progress object reports that the process was cancelled.
1353  */
1354 double
1355 AudioRegion::maximum_amplitude (Progress* p) const
1356 {
1357         framepos_t fpos = _start;
1358         framepos_t const fend = _start + _length;
1359         double maxamp = 0;
1360
1361         framecnt_t const blocksize = 64 * 1024;
1362         Sample buf[blocksize];
1363
1364         while (fpos < fend) {
1365
1366                 uint32_t n;
1367
1368                 framecnt_t const to_read = min (fend - fpos, blocksize);
1369
1370                 for (n = 0; n < n_channels(); ++n) {
1371
1372                         /* read it in */
1373
1374                         if (read_raw_internal (buf, fpos, to_read, n) != to_read) {
1375                                 return 0;
1376                         }
1377
1378                         maxamp = compute_peak (buf, to_read, maxamp);
1379                 }
1380
1381                 fpos += to_read;
1382                 if (p) {
1383                         p->set_progress (float (fpos - _start) / _length);
1384                         if (p->cancelled ()) {
1385                                 return -1;
1386                         }
1387                 }
1388         }
1389
1390         return maxamp;
1391 }
1392
1393 /** Normalize using a given maximum amplitude and target, so that region
1394  *  _scale_amplitude becomes target / max_amplitude.
1395  */
1396 void
1397 AudioRegion::normalize (float max_amplitude, float target_dB)
1398 {
1399         gain_t target = dB_to_coefficient (target_dB);
1400
1401         if (target == 1.0f) {
1402                 /* do not normalize to precisely 1.0 (0 dBFS), to avoid making it appear
1403                    that we may have clipped.
1404                 */
1405                 target -= FLT_EPSILON;
1406         }
1407
1408         if (max_amplitude == 0.0f) {
1409                 /* don't even try */
1410                 return;
1411         }
1412
1413         if (max_amplitude == target) {
1414                 /* we can't do anything useful */
1415                 return;
1416         }
1417
1418         set_scale_amplitude (target / max_amplitude);
1419 }
1420
1421 void
1422 AudioRegion::fade_in_changed ()
1423 {
1424         send_change (PropertyChange (Properties::fade_in));
1425 }
1426
1427 void
1428 AudioRegion::fade_out_changed ()
1429 {
1430         send_change (PropertyChange (Properties::fade_out));
1431 }
1432
1433 void
1434 AudioRegion::envelope_changed ()
1435 {
1436         send_change (PropertyChange (Properties::envelope));
1437 }
1438
1439 void
1440 AudioRegion::suspend_fade_in ()
1441 {
1442         if (++_fade_in_suspended == 1) {
1443                 if (fade_in_is_default()) {
1444                         set_fade_in_active (false);
1445                 }
1446         }
1447 }
1448
1449 void
1450 AudioRegion::resume_fade_in ()
1451 {
1452         if (--_fade_in_suspended == 0 && _fade_in_suspended) {
1453                 set_fade_in_active (true);
1454         }
1455 }
1456
1457 void
1458 AudioRegion::suspend_fade_out ()
1459 {
1460         if (++_fade_out_suspended == 1) {
1461                 if (fade_out_is_default()) {
1462                         set_fade_out_active (false);
1463                 }
1464         }
1465 }
1466
1467 void
1468 AudioRegion::resume_fade_out ()
1469 {
1470         if (--_fade_out_suspended == 0 &&_fade_out_suspended) {
1471                 set_fade_out_active (true);
1472         }
1473 }
1474
1475 bool
1476 AudioRegion::speed_mismatch (float sr) const
1477 {
1478         if (_sources.empty()) {
1479                 /* impossible, but ... */
1480                 return false;
1481         }
1482
1483         float fsr = audio_source()->sample_rate();
1484
1485         return fsr != sr;
1486 }
1487
1488 void
1489 AudioRegion::source_offset_changed ()
1490 {
1491         /* XXX this fixes a crash that should not occur. It does occur
1492            becauses regions are not being deleted when a session
1493            is unloaded. That bug must be fixed.
1494         */
1495
1496         if (_sources.empty()) {
1497                 return;
1498         }
1499
1500         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(_sources.front());
1501
1502         if (afs && afs->destructive()) {
1503                 // set_start (source()->natural_position(), this);
1504                 set_position (source()->natural_position());
1505         }
1506 }
1507
1508 boost::shared_ptr<AudioSource>
1509 AudioRegion::audio_source (uint32_t n) const
1510 {
1511         // Guaranteed to succeed (use a static cast for speed?)
1512         return boost::dynamic_pointer_cast<AudioSource>(source(n));
1513 }
1514
1515 int
1516 AudioRegion::adjust_transients (frameoffset_t delta)
1517 {
1518         for (AnalysisFeatureList::iterator x = _transients.begin(); x != _transients.end(); ++x) {
1519                 (*x) = (*x) + delta;
1520         }
1521
1522         send_change (PropertyChange (Properties::valid_transients));
1523
1524         return 0;
1525 }
1526
1527 int
1528 AudioRegion::update_transient (framepos_t old_position, framepos_t new_position)
1529 {
1530         for (AnalysisFeatureList::iterator x = _transients.begin(); x != _transients.end(); ++x) {
1531                 if ((*x) == old_position) {
1532                         (*x) = new_position;
1533                         send_change (PropertyChange (Properties::valid_transients));
1534
1535                         break;
1536                 }
1537         }
1538
1539         return 0;
1540 }
1541
1542 void
1543 AudioRegion::add_transient (framepos_t where)
1544 {
1545         _transients.push_back(where);
1546         _valid_transients = true;
1547
1548         send_change (PropertyChange (Properties::valid_transients));
1549 }
1550
1551 void
1552 AudioRegion::remove_transient (framepos_t where)
1553 {
1554         _transients.remove(where);
1555         _valid_transients = true;
1556
1557         send_change (PropertyChange (Properties::valid_transients));
1558 }
1559
1560 int
1561 AudioRegion::set_transients (AnalysisFeatureList& results)
1562 {
1563         _transients.clear();
1564         _transients = results;
1565         _valid_transients = true;
1566
1567         send_change (PropertyChange (Properties::valid_transients));
1568
1569         return 0;
1570 }
1571
1572 int
1573 AudioRegion::get_transients (AnalysisFeatureList& results, bool force_new)
1574 {
1575         boost::shared_ptr<Playlist> pl = playlist();
1576
1577         if (!pl) {
1578                 return -1;
1579         }
1580
1581         if (_valid_transients && !force_new) {
1582                 results = _transients;
1583                 return 0;
1584         }
1585
1586         SourceList::iterator s;
1587
1588         for (s = _sources.begin() ; s != _sources.end(); ++s) {
1589                 if (!(*s)->has_been_analysed()) {
1590                         cerr << "For " << name() << " source " << (*s)->name() << " has not been analyzed\n";
1591                         break;
1592                 }
1593         }
1594
1595         if (s == _sources.end()) {
1596                 /* all sources are analyzed, merge data from each one */
1597
1598                 for (s = _sources.begin() ; s != _sources.end(); ++s) {
1599
1600                         /* find the set of transients within the bounds of this region */
1601
1602                         AnalysisFeatureList::iterator low = lower_bound ((*s)->transients.begin(),
1603                                                                          (*s)->transients.end(),
1604                                                                          _start);
1605
1606                         AnalysisFeatureList::iterator high = upper_bound ((*s)->transients.begin(),
1607                                                                           (*s)->transients.end(),
1608                                                                           _start + _length);
1609
1610                         /* and add them */
1611
1612                         results.insert (results.end(), low, high);
1613                 }
1614
1615                 TransientDetector::cleanup_transients (results, pl->session().frame_rate(), 3.0);
1616
1617                 /* translate all transients to current position */
1618
1619                 for (AnalysisFeatureList::iterator x = results.begin(); x != results.end(); ++x) {
1620                         (*x) -= _start;
1621                         (*x) += _position;
1622                 }
1623
1624                 _transients = results;
1625                 _valid_transients = true;
1626
1627                 return 0;
1628         }
1629
1630         /* no existing/complete transient info */
1631
1632         static bool analyse_dialog_shown = false; /* global per instance of Ardour */
1633
1634         if (!Config->get_auto_analyse_audio()) {
1635                 if (!analyse_dialog_shown) {
1636                         pl->session().Dialog (_("\
1637 You have requested an operation that requires audio analysis.\n\n\
1638 You currently have \"auto-analyse-audio\" disabled, which means \
1639 that transient data must be generated every time it is required.\n\n\
1640 If you are doing work that will require transient data on a \
1641 regular basis, you should probably enable \"auto-analyse-audio\" \
1642 then quit ardour and restart.\n\n\
1643 This dialog will not display again.  But you may notice a slight delay \
1644 in this and future transient-detection operations.\n\
1645 "));
1646                         analyse_dialog_shown = true;
1647                 }
1648         }
1649
1650         TransientDetector t (pl->session().frame_rate());
1651         bool existing_results = !results.empty();
1652
1653         _transients.clear ();
1654         _valid_transients = false;
1655
1656         for (uint32_t i = 0; i < n_channels(); ++i) {
1657
1658                 AnalysisFeatureList these_results;
1659
1660                 t.reset ();
1661
1662                 if (t.run ("", this, i, these_results)) {
1663                         return -1;
1664                 }
1665
1666                 /* translate all transients to give absolute position */
1667
1668                 for (AnalysisFeatureList::iterator i = these_results.begin(); i != these_results.end(); ++i) {
1669                         (*i) += _position;
1670                 }
1671
1672                 /* merge */
1673
1674                 _transients.insert (_transients.end(), these_results.begin(), these_results.end());
1675         }
1676
1677         if (!results.empty()) {
1678                 if (existing_results) {
1679
1680                         /* merge our transients into the existing ones, then clean up
1681                            those.
1682                         */
1683
1684                         results.insert (results.end(), _transients.begin(), _transients.end());
1685                         TransientDetector::cleanup_transients (results, pl->session().frame_rate(), 3.0);
1686                 }
1687
1688                 /* make sure ours are clean too */
1689
1690                 TransientDetector::cleanup_transients (_transients, pl->session().frame_rate(), 3.0);
1691
1692         } else {
1693
1694                 TransientDetector::cleanup_transients (_transients, pl->session().frame_rate(), 3.0);
1695                 results = _transients;
1696         }
1697
1698         _valid_transients = true;
1699
1700         return 0;
1701 }
1702
1703 /** Find areas of `silence' within a region.
1704  *
1705  *  @param threshold Threshold below which signal is considered silence (as a sample value)
1706  *  @param min_length Minimum length of silent period to be reported.
1707  *  @return Silent intervals, measured relative to the region start in the source
1708  */
1709
1710 AudioIntervalResult
1711 AudioRegion::find_silence (Sample threshold, framecnt_t min_length, InterThreadInfo& itt) const
1712 {
1713         framecnt_t const block_size = 64 * 1024;
1714         boost::scoped_array<Sample> loudest (new Sample[block_size]);
1715         boost::scoped_array<Sample> buf (new Sample[block_size]);
1716
1717         framepos_t pos = _start;
1718         framepos_t const end = _start + _length - 1;
1719
1720         AudioIntervalResult silent_periods;
1721
1722         bool in_silence = false;
1723         frameoffset_t silence_start = 0;
1724
1725         while (pos < end && !itt.cancel) {
1726
1727                 /* fill `loudest' with the loudest absolute sample at each instant, across all channels */
1728                 memset (loudest.get(), 0, sizeof (Sample) * block_size);
1729                 for (uint32_t n = 0; n < n_channels(); ++n) {
1730
1731                         read_raw_internal (buf.get(), pos, block_size, n);
1732                         for (framecnt_t i = 0; i < block_size; ++i) {
1733                                 loudest[i] = max (loudest[i], abs (buf[i]));
1734                         }
1735                 }
1736
1737                 /* now look for silence */
1738                 for (framecnt_t i = 0; i < block_size; ++i) {
1739                         bool const silence = abs (loudest[i]) < threshold;
1740                         if (silence && !in_silence) {
1741                                 /* non-silence to silence */
1742                                 in_silence = true;
1743                                 silence_start = pos + i;
1744                         } else if (!silence && in_silence) {
1745                                 /* silence to non-silence */
1746                                 in_silence = false;
1747                                 if (pos + i - 1 - silence_start >= min_length) {
1748                                         silent_periods.push_back (std::make_pair (silence_start, pos + i - 1));
1749                                 }
1750                         }
1751                 }
1752
1753                 pos += block_size;
1754                 itt.progress = (end-pos)/(double)_length;
1755         }
1756
1757         if (in_silence && end - 1 - silence_start >= min_length) {
1758                 /* last block was silent, so finish off the last period */
1759                 silent_periods.push_back (std::make_pair (silence_start, end));
1760         }
1761
1762         itt.done = true;
1763
1764         return silent_periods;
1765 }
1766
1767 Evoral::Range<framepos_t>
1768 AudioRegion::body_range () const
1769 {
1770         return Evoral::Range<framepos_t> (first_frame() + _fade_in->back()->when + 1, last_frame() - _fade_out->back()->when);
1771 }
1772
1773 boost::shared_ptr<Region>
1774 AudioRegion::get_single_other_xfade_region (bool start) const
1775 {
1776         boost::shared_ptr<Playlist> pl (playlist());
1777
1778         if (!pl) {
1779                 /* not currently in a playlist - xfade length is unbounded
1780                    (and irrelevant)
1781                 */
1782                 return boost::shared_ptr<AudioRegion> ();
1783         }
1784
1785         boost::shared_ptr<RegionList> rl;
1786
1787         if (start) {
1788                 rl = pl->regions_at (position());
1789         } else {
1790                 rl = pl->regions_at (last_frame());
1791         }
1792
1793         RegionList::iterator i;
1794         boost::shared_ptr<Region> other;
1795         uint32_t n = 0;
1796
1797         /* count and find the other region in a single pass through the list */
1798
1799         for (i = rl->begin(); i != rl->end(); ++i) {
1800                 if ((*i).get() != this) {
1801                         other = *i;
1802                 }
1803                 ++n;
1804         }
1805
1806         if (n != 2) {
1807                 /* zero or multiple regions stacked here - don't care about xfades */
1808                 return boost::shared_ptr<AudioRegion> ();
1809         }
1810
1811         return other;
1812 }
1813
1814 framecnt_t
1815 AudioRegion::verify_xfade_bounds (framecnt_t len, bool start)
1816 {
1817         /* this is called from a UI to check on whether a new proposed
1818            length for an xfade is legal or not. it returns the legal
1819            length corresponding to @a len which may be shorter than or
1820            equal to @a len itself.
1821         */
1822
1823         boost::shared_ptr<Region> other = get_single_other_xfade_region (start);
1824         framecnt_t maxlen;
1825
1826         if (!other) {
1827                 /* zero or > 2 regions here, don't care about len, but
1828                    it can't be longer than the region itself.
1829                  */
1830                 return min (length(), len);
1831         }
1832
1833         /* we overlap a single region. clamp the length of an xfade to
1834            the maximum possible duration of the overlap (if the other
1835            region were trimmed appropriately).
1836         */
1837
1838         if (start) {
1839                 maxlen = other->latest_possible_frame() - position();
1840         } else {
1841                 maxlen = last_frame() - other->earliest_possible_position();
1842         }
1843
1844         return min (length(), min (maxlen, len));
1845
1846 }
1847
1848 extern "C" {
1849
1850         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)
1851 {
1852         return ((AudioRegion *) arg)->read_peaks ((PeakData *) data, (framecnt_t) npeaks, (framepos_t) start, (framecnt_t) cnt, n_chan,samples_per_unit);
1853 }
1854
1855 uint32_t region_length_from_c (void *arg)
1856 {
1857
1858         return ((AudioRegion *) arg)->length();
1859 }
1860
1861 uint32_t sourcefile_length_from_c (void *arg, double zoom_factor)
1862 {
1863         return ( (AudioRegion *) arg)->audio_source()->available_peaks (zoom_factor) ;
1864 }
1865
1866 } /* extern "C" */