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