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