2 Copyright (C) 2003-2006 Paul Davis
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.
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.
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.
20 #include <sigc++/bind.h>
22 #include "pbd/stacktrace.h"
24 #include "ardour/types.h"
25 #include "ardour/crossfade.h"
26 #include "ardour/crossfade_compare.h"
27 #include "ardour/audioregion.h"
28 #include "ardour/playlist.h"
29 #include "ardour/utils.h"
30 #include "ardour/session.h"
31 #include "ardour/source.h"
37 using namespace ARDOUR;
40 nframes_t Crossfade::_short_xfade_length = 0;
41 Change Crossfade::ActiveChanged = new_change();
42 Change Crossfade::FollowOverlapChanged = new_change();
44 /* XXX if and when we ever implement parallel processing of the process()
45 callback, these will need to be handled on a per-thread basis.
48 Sample* Crossfade::crossfade_buffer_out = 0;
49 Sample* Crossfade::crossfade_buffer_in = 0;
52 Crossfade::set_buffer_size (nframes_t sz)
54 delete [] crossfade_buffer_out;
55 crossfade_buffer_out = 0;
57 delete [] crossfade_buffer_in;
58 crossfade_buffer_in = 0;
61 crossfade_buffer_out = new Sample[sz];
62 crossfade_buffer_in = new Sample[sz];
67 Crossfade::operator== (const Crossfade& other)
69 return (_in == other._in) && (_out == other._out);
72 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> in, boost::shared_ptr<AudioRegion> out,
76 : AudioRegion (in->session(), position, length, "foobar"),
77 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
78 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
84 _follow_overlap = false;
86 _active = _session.config.get_xfades_active ();
92 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model, bool act)
93 : AudioRegion (a->session(), 0, 0, "foobar"),
94 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
95 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
100 if (compute (a, b, model)) {
101 throw failed_constructor();
111 Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
112 : AudioRegion (playlist.session(), 0, 0, "foobar"),
113 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
114 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
117 boost::shared_ptr<Region> r;
119 LocaleGuard lg (X_("POSIX"));
121 /* we have to find the in/out regions before we can do anything else */
123 if ((prop = node.property ("in")) == 0) {
124 error << _("Crossfade: no \"in\" region in state") << endmsg;
125 throw failed_constructor();
128 PBD::ID id (prop->value());
130 if ((r = playlist.find_region (id)) == 0) {
131 error << string_compose (_("Crossfade: no \"in\" region %1 found in playlist %2"), id, playlist.name())
133 throw failed_constructor();
136 if ((_in = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
137 throw failed_constructor();
140 if ((prop = node.property ("out")) == 0) {
141 error << _("Crossfade: no \"out\" region in state") << endmsg;
142 throw failed_constructor();
145 PBD::ID id2 (prop->value());
147 if ((r = playlist.find_region (id2)) == 0) {
148 error << string_compose (_("Crossfade: no \"out\" region %1 found in playlist %2"), id2, playlist.name())
150 throw failed_constructor();
153 if ((_out = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
154 throw failed_constructor();
161 if (set_state (node)) {
162 throw failed_constructor();
166 Crossfade::Crossfade (boost::shared_ptr<Crossfade> orig, boost::shared_ptr<AudioRegion> newin, boost::shared_ptr<AudioRegion> newout)
167 : AudioRegion (boost::dynamic_pointer_cast<const AudioRegion> (orig)),
168 _fade_in (orig->_fade_in),
169 _fade_out (orig->_fade_out)
171 _active = orig->_active;
172 _in_update = orig->_in_update;
173 _anchor_point = orig->_anchor_point;
174 _follow_overlap = orig->_follow_overlap;
175 _fixed = orig->_fixed;
180 // copied from Crossfade::initialize()
183 _out->suspend_fade_out ();
184 _in->suspend_fade_in ();
186 overlap_type = _in->coverage (_out->position(), _out->last_frame());
187 layer_relation = (int32_t) (_in->layer() - _out->layer());
189 // Let's make sure the fade isn't too long
190 set_xfade_length(_length);
194 Crossfade::~Crossfade ()
200 Crossfade::initialize ()
202 /* merge source lists from regions */
204 _sources = _in->sources();
205 _sources.insert (_sources.end(), _out->sources().begin(), _out->sources().end());
206 _master_sources = _in->master_sources();
207 _master_sources.insert(_master_sources.end(), _out->master_sources().begin(), _out->master_sources().end());
211 _out->suspend_fade_out ();
212 _in->suspend_fade_in ();
217 #define EQUAL_POWER_MINUS_3DB
218 #ifdef EQUAL_POWER_MINUS_3DB
220 _fade_out.add ((_length * 0.000000), 1.000000);
221 _fade_out.add ((_length * 0.166667), 0.948859);
222 _fade_out.add ((_length * 0.333333), 0.851507);
223 _fade_out.add ((_length * 0.500000), 0.707946);
224 _fade_out.add ((_length * 0.666667), 0.518174);
225 _fade_out.add ((_length * 0.833333), 0.282192);
226 _fade_out.add ((_length * 1.000000), 0.000000);
228 #else // EQUAL_POWER_MINUS_6DB
230 _fade_out.add ((_length * 0.000000), 1.000000);
231 _fade_out.add ((_length * 0.166667), 0.833033);
232 _fade_out.add ((_length * 0.333333), 0.666186);
233 _fade_out.add ((_length * 0.500000), 0.499459);
234 _fade_out.add ((_length * 0.666667), 0.332853);
235 _fade_out.add ((_length * 0.833333), 0.166366);
236 _fade_out.add ((_length * 1.000000), 0.000000);
244 #define EQUAL_POWER_MINUS_3DB
245 #ifdef EQUAL_POWER_MINUS_3DB
247 _fade_in.add ((_length * 0.000000), 0.000000);
248 _fade_in.add ((_length * 0.166667), 0.282192);
249 _fade_in.add ((_length * 0.333333), 0.518174);
250 _fade_in.add ((_length * 0.500000), 0.707946);
251 _fade_in.add ((_length * 0.666667), 0.851507);
252 _fade_in.add ((_length * 0.833333), 0.948859);
253 _fade_in.add ((_length * 1.000000), 1.000000);
255 #else // EQUAL_POWER_MINUS_SIX_DB
257 _fade_in.add ((_length * 0.000000), 0.000000);
258 _fade_in.add ((_length * 0.166667), 0.166366);
259 _fade_in.add ((_length * 0.333333), 0.332853);
260 _fade_in.add ((_length * 0.500000), 0.499459);
261 _fade_in.add ((_length * 0.666667), 0.666186);
262 _fade_in.add ((_length * 0.833333), 0.833033);
263 _fade_in.add ((_length * 1.000000), 1.000000);
269 overlap_type = _in->coverage (_out->position(), _out->last_frame());
270 layer_relation = (int32_t) (_in->layer() - _out->layer());
274 Crossfade::read_raw_internal (Sample* buf, sframes_t start, nframes_t cnt, int channel) const
276 // FIXME: Why is this disabled?
278 Sample* mixdown = new Sample[cnt];
279 float* gain = new float[cnt];
282 ret = read_at (buf, mixdown, gain, start, cnt, chan_n, cnt);
293 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
294 float *gain_buffer, sframes_t start, nframes_t cnt, uint32_t chan_n,
295 nframes_t read_frames, nframes_t skip_frames) const
304 if (start < _position) {
306 /* handle an initial section of the read area that we do not
310 offset = _position - start;
320 to_write = min (_length, cnt);
324 to_write = min (nframes_t(_length - (start - _position)), cnt);
328 offset = start - _position;
330 /* Prevent data from piling up inthe crossfade buffers when reading a transparent region */
331 if (!(_out->opaque())) {
332 memset (crossfade_buffer_out, 0, sizeof (Sample) * to_write);
333 } else if (!(_in->opaque())) {
334 memset (crossfade_buffer_in, 0, sizeof (Sample) * to_write);
337 _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
338 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
340 float* fiv = new float[to_write];
341 float* fov = new float[to_write];
343 _fade_in.curve().get_vector (offset, offset+to_write, fiv, to_write);
344 _fade_out.curve().get_vector (offset, offset+to_write, fov, to_write);
346 /* note: although we have not explicitly taken into account the return values
347 from _out->read_at() or _in->read_at(), the length() function does this
348 implicitly. why? because it computes a value based on the in+out regions'
349 position and length, and so we know precisely how much data they could return.
352 for (nframes_t n = 0; n < to_write; ++n) {
353 buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
363 Crossfade::coverage (nframes_t start, nframes_t end) const
365 nframes_t my_end = _position + _length;
367 if ((start >= _position) && (end <= my_end)) {
368 return OverlapInternal;
370 if ((end >= _position) && (end <= my_end)) {
373 if ((start >= _position) && (start <= my_end)) {
376 if ((_position >= start) && (_position <= end) && (my_end <= end)) {
377 return OverlapExternal;
383 Crossfade::set_active (bool yn)
387 StateChanged (ActiveChanged);
392 Crossfade::refresh ()
394 /* crossfades must be between non-muted regions */
396 if (_out->muted() || _in->muted()) {
397 Invalidated (shared_from_this ());
401 /* Top layer shouldn't be transparent */
403 if (!((layer_relation > 0 ? _in : _out)->opaque())) {
404 Invalidated (shared_from_this());
408 /* layer ordering cannot change */
410 int32_t new_layer_relation = (int32_t) (_in->layer() - _out->layer());
412 if (new_layer_relation * layer_relation < 0) { // different sign, layers rotated
413 Invalidated (shared_from_this ());
417 OverlapType ot = _in->coverage (_out->first_frame(), _out->last_frame());
419 if (ot == OverlapNone) {
420 Invalidated (shared_from_this ());
426 if (ot != overlap_type) {
428 if (_follow_overlap) {
431 compute (_in, _out, _session.config.get_xfade_model());
434 catch (NoCrossfadeHere& err) {
435 Invalidated (shared_from_this ());
443 Invalidated (shared_from_this ());
449 send_signal = update ();
453 StateChanged (BoundsChanged); /* EMIT SIGNAL */
466 if (_follow_overlap) {
467 newlen = _out->first_frame() + _out->length() - _in->first_frame();
473 Invalidated (shared_from_this ());
479 if ((_follow_overlap && newlen != _length) || (_length > newlen)) {
481 double factor = newlen / (double) _length;
483 _fade_out.x_scale (factor);
484 _fade_in.x_scale (factor);
489 switch (_anchor_point) {
491 _position = _in->first_frame();
495 _position = _in->last_frame() - _length;
499 _position = _out->last_frame() - _length;
506 Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model)
508 boost::shared_ptr<AudioRegion> top;
509 boost::shared_ptr<AudioRegion> bottom;
510 nframes_t short_xfade_length;
512 short_xfade_length = _short_xfade_length;
514 if (a->layer() < b->layer()) {
522 /* first check for matching ends */
524 if (top->first_frame() == bottom->first_frame()) {
526 /* Both regions start at the same point */
528 if (top->last_frame() < bottom->last_frame()) {
530 /* top ends before bottom, so put an xfade
531 in at the end of top.
534 /* [-------- top ---------- ]
535 * {====== bottom =====================}
541 if (top->last_frame() < short_xfade_length) {
544 _position = top->last_frame() - short_xfade_length;
547 _length = min (short_xfade_length, top->length());
548 _follow_overlap = false;
549 _anchor_point = EndOfIn;
554 /* top ends after (or same time) as bottom - no xfade
557 /* [-------- top ------------------------ ]
558 * {====== bottom =====================}
561 throw NoCrossfadeHere();
564 } else if (top->last_frame() == bottom->last_frame()) {
566 /* Both regions end at the same point */
568 if (top->first_frame() > bottom->first_frame()) {
570 /* top starts after bottom, put an xfade in at the
574 /* [-------- top ---------- ]
575 * {====== bottom =====================}
580 _position = top->first_frame();
581 _length = min (short_xfade_length, top->length());
582 _follow_overlap = false;
583 _anchor_point = StartOfIn;
588 /* top starts before bottom - no xfade
591 /* [-------- top ------------------------ ]
592 * {====== bottom =====================}
595 throw NoCrossfadeHere();
600 /* OK, time to do more regular overlapping */
602 OverlapType ot = top->coverage (bottom->first_frame(), bottom->last_frame());
606 /* should be NOTREACHED as a precondition of creating
607 a new crossfade, but we need to handle it here.
609 throw NoCrossfadeHere();
612 case OverlapInternal:
613 case OverlapExternal:
614 /* should be NOTREACHED because of tests above */
615 throw NoCrossfadeHere();
618 case OverlapEnd: /* top covers start of bottom but ends within it */
620 /* [---- top ------------------------]
621 * { ==== bottom ============ }
626 _anchor_point = EndOfOut;
628 if (model == FullCrossfade) {
629 _position = bottom->first_frame(); // "{"
630 _length = _out->first_frame() + _out->length() - _in->first_frame();
631 /* leave active alone */
632 _follow_overlap = true;
634 _length = min (short_xfade_length, top->length());
635 _position = top->last_frame() - _length; // "]" - length
637 _follow_overlap = false;
642 case OverlapStart: /* top starts within bottom but covers bottom's end */
644 /* { ==== top ============ }
645 * [---- bottom -------------------]
650 _position = top->first_frame();
651 _anchor_point = StartOfIn;
653 if (model == FullCrossfade) {
654 _length = _out->first_frame() + _out->length() - _in->first_frame();
655 /* leave active alone */
656 _follow_overlap = true;
658 _length = min (short_xfade_length, top->length());
660 _follow_overlap = false;
672 Crossfade::get_state ()
674 XMLNode* node = new XMLNode (X_("Crossfade"));
677 LocaleGuard lg (X_("POSIX"));
679 _out->id().print (buf, sizeof (buf));
680 node->add_property ("out", buf);
681 _in->id().print (buf, sizeof (buf));
682 node->add_property ("in", buf);
683 node->add_property ("active", (_active ? "yes" : "no"));
684 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
685 node->add_property ("fixed", (_fixed ? "yes" : "no"));
686 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
687 node->add_property ("length", buf);
688 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
689 node->add_property ("anchor-point", buf);
690 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
691 node->add_property ("position", buf);
693 child = node->add_child ("FadeIn");
695 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
698 pnode = new XMLNode ("point");
700 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
701 pnode->add_property ("x", buf);
702 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
703 pnode->add_property ("y", buf);
704 child->add_child_nocopy (*pnode);
707 child = node->add_child ("FadeOut");
709 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
712 pnode = new XMLNode ("point");
714 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
715 pnode->add_property ("x", buf);
716 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
717 pnode->add_property ("y", buf);
718 child->add_child_nocopy (*pnode);
725 Crossfade::set_state (const XMLNode& node)
727 XMLNodeConstIterator i;
728 XMLNodeList children;
731 const XMLProperty* prop;
732 LocaleGuard lg (X_("POSIX"));
733 Change what_changed = Change (0);
736 if ((prop = node.property ("position")) != 0) {
737 sscanf (prop->value().c_str(), "%" PRIu32, &val);
738 if (val != _position) {
740 what_changed = Change (what_changed | PositionChanged);
743 warning << _("old-style crossfade information - no position information") << endmsg;
744 _position = _in->first_frame();
747 if ((prop = node.property ("active")) != 0) {
748 bool x = (prop->value() == "yes");
751 what_changed = Change (what_changed | ActiveChanged);
757 if ((prop = node.property ("follow-overlap")) != 0) {
758 _follow_overlap = (prop->value() == "yes");
760 _follow_overlap = false;
763 if ((prop = node.property ("fixed")) != 0) {
764 _fixed = (prop->value() == "yes");
769 if ((prop = node.property ("anchor-point")) != 0) {
770 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
772 _anchor_point = StartOfIn;
775 if ((prop = node.property ("length")) != 0) {
777 sscanf (prop->value().c_str(), "%" PRIu32, &val);
778 if (val != _length) {
779 _length = atol (prop->value().c_str());
780 what_changed = Change (what_changed | LengthChanged);
785 /* XXX this branch is legacy code from before
786 the point where we stored xfade lengths.
789 if ((_length = overlap_length()) == 0) {
790 throw failed_constructor();
794 if ((fi = find_named_node (node, "FadeIn")) == 0) {
798 if ((fo = find_named_node (node, "FadeOut")) == 0) {
807 children = fi->children();
809 for (i = children.begin(); i != children.end(); ++i) {
810 if ((*i)->name() == "point") {
814 prop = (*i)->property ("x");
815 sscanf (prop->value().c_str(), "%" PRIu32, &x);
817 prop = (*i)->property ("y");
818 sscanf (prop->value().c_str(), "%f", &y);
831 children = fo->children();
833 for (i = children.begin(); i != children.end(); ++i) {
834 if ((*i)->name() == "point") {
839 prop = (*i)->property ("x");
840 sscanf (prop->value().c_str(), "%" PRIu32, &x);
842 prop = (*i)->property ("y");
843 sscanf (prop->value().c_str(), "%f", &y);
845 _fade_out.add (x, y);
851 StateChanged (what_changed); /* EMIT SIGNAL */
857 Crossfade::can_follow_overlap () const
863 Crossfade::set_follow_overlap (bool yn)
865 if (yn == _follow_overlap || _fixed) {
869 _follow_overlap = yn;
872 set_xfade_length (_short_xfade_length);
874 set_xfade_length (_out->first_frame() + _out->length() - _in->first_frame());
877 StateChanged (FollowOverlapChanged);
881 Crossfade::set_xfade_length (nframes_t len)
885 switch (_anchor_point) {
887 limit = _in->length();
891 limit = _in->length();
895 limit = _out->length();
900 len = min (limit, len);
902 double factor = len / (double) _length;
905 _fade_out.x_scale (factor);
906 _fade_in.x_scale (factor);
911 StateChanged (LengthChanged);
917 Crossfade::overlap_length () const
922 return _out->first_frame() + _out->length() - _in->first_frame();
926 Crossfade::set_short_xfade_length (nframes_t n)
928 _short_xfade_length = n;
932 Crossfade::invalidate ()
934 Invalidated (shared_from_this ()); /* EMIT SIGNAL */