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
99 _follow_overlap = false;
101 if (compute (a, b, model)) {
102 throw failed_constructor();
110 Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
111 : AudioRegion (playlist.session(), 0, 0, "foobar"),
112 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
113 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
116 boost::shared_ptr<Region> r;
118 LocaleGuard lg (X_("POSIX"));
120 /* we have to find the in/out regions before we can do anything else */
122 if ((prop = node.property ("in")) == 0) {
123 error << _("Crossfade: no \"in\" region in state") << endmsg;
124 throw failed_constructor();
127 PBD::ID id (prop->value());
129 if ((r = playlist.find_region (id)) == 0) {
130 error << string_compose (_("Crossfade: no \"in\" region %1 found in playlist %2"), id, playlist.name())
132 throw failed_constructor();
135 if ((_in = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
136 throw failed_constructor();
139 if ((prop = node.property ("out")) == 0) {
140 error << _("Crossfade: no \"out\" region in state") << endmsg;
141 throw failed_constructor();
144 PBD::ID id2 (prop->value());
146 if ((r = playlist.find_region (id2)) == 0) {
147 error << string_compose (_("Crossfade: no \"out\" region %1 found in playlist %2"), id2, playlist.name())
149 throw failed_constructor();
152 if ((_out = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
153 throw failed_constructor();
160 if (set_state (node, Stateful::loading_state_version)) {
161 throw failed_constructor();
165 Crossfade::Crossfade (boost::shared_ptr<Crossfade> orig, boost::shared_ptr<AudioRegion> newin, boost::shared_ptr<AudioRegion> newout)
166 : AudioRegion (boost::dynamic_pointer_cast<const AudioRegion> (orig)),
167 _fade_in (orig->_fade_in),
168 _fade_out (orig->_fade_out)
170 _active = orig->_active;
171 _in_update = orig->_in_update;
172 _anchor_point = orig->_anchor_point;
173 _follow_overlap = orig->_follow_overlap;
174 _fixed = orig->_fixed;
179 // copied from Crossfade::initialize()
182 _out->suspend_fade_out ();
183 _in->suspend_fade_in ();
185 overlap_type = _in->coverage (_out->position(), _out->last_frame());
186 layer_relation = (int32_t) (_in->layer() - _out->layer());
188 // Let's make sure the fade isn't too long
189 set_xfade_length(_length);
193 Crossfade::~Crossfade ()
199 Crossfade::initialize ()
201 /* merge source lists from regions */
203 _sources = _in->sources();
204 _sources.insert (_sources.end(), _out->sources().begin(), _out->sources().end());
205 _master_sources = _in->master_sources();
206 _master_sources.insert(_master_sources.end(), _out->master_sources().begin(), _out->master_sources().end());
210 _out->suspend_fade_out ();
211 _in->suspend_fade_in ();
216 #define EQUAL_POWER_MINUS_3DB
217 #ifdef EQUAL_POWER_MINUS_3DB
219 _fade_out.add ((_length * 0.000000), 1.000000);
220 _fade_out.add ((_length * 0.166667), 0.948859);
221 _fade_out.add ((_length * 0.333333), 0.851507);
222 _fade_out.add ((_length * 0.500000), 0.707946);
223 _fade_out.add ((_length * 0.666667), 0.518174);
224 _fade_out.add ((_length * 0.833333), 0.282192);
225 _fade_out.add ((_length * 1.000000), 0.000000);
227 #else // EQUAL_POWER_MINUS_6DB
229 _fade_out.add ((_length * 0.000000), 1.000000);
230 _fade_out.add ((_length * 0.166667), 0.833033);
231 _fade_out.add ((_length * 0.333333), 0.666186);
232 _fade_out.add ((_length * 0.500000), 0.499459);
233 _fade_out.add ((_length * 0.666667), 0.332853);
234 _fade_out.add ((_length * 0.833333), 0.166366);
235 _fade_out.add ((_length * 1.000000), 0.000000);
243 #define EQUAL_POWER_MINUS_3DB
244 #ifdef EQUAL_POWER_MINUS_3DB
246 _fade_in.add ((_length * 0.000000), 0.000000);
247 _fade_in.add ((_length * 0.166667), 0.282192);
248 _fade_in.add ((_length * 0.333333), 0.518174);
249 _fade_in.add ((_length * 0.500000), 0.707946);
250 _fade_in.add ((_length * 0.666667), 0.851507);
251 _fade_in.add ((_length * 0.833333), 0.948859);
252 _fade_in.add ((_length * 1.000000), 1.000000);
254 #else // EQUAL_POWER_MINUS_SIX_DB
256 _fade_in.add ((_length * 0.000000), 0.000000);
257 _fade_in.add ((_length * 0.166667), 0.166366);
258 _fade_in.add ((_length * 0.333333), 0.332853);
259 _fade_in.add ((_length * 0.500000), 0.499459);
260 _fade_in.add ((_length * 0.666667), 0.666186);
261 _fade_in.add ((_length * 0.833333), 0.833033);
262 _fade_in.add ((_length * 1.000000), 1.000000);
268 overlap_type = _in->coverage (_out->position(), _out->last_frame());
269 layer_relation = (int32_t) (_in->layer() - _out->layer());
273 Crossfade::read_raw_internal (Sample* /*buf*/, sframes_t /*start*/, nframes_t cnt, int /*channel*/) const
275 // FIXME: Why is this disabled?
277 Sample* mixdown = new Sample[cnt];
278 float* gain = new float[cnt];
281 ret = read_at (buf, mixdown, gain, start, cnt, chan_n, cnt);
292 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
293 float *gain_buffer, sframes_t start, nframes_t cnt, uint32_t chan_n,
294 nframes_t read_frames, nframes_t skip_frames) const
303 if (start < _position) {
305 /* handle an initial section of the read area that we do not
309 offset = _position - start;
319 to_write = min (_length, cnt);
323 to_write = min (nframes_t(_length - (start - _position)), cnt);
327 offset = start - _position;
329 /* Prevent data from piling up inthe crossfade buffers when reading a transparent region */
330 if (!(_out->opaque())) {
331 memset (crossfade_buffer_out, 0, sizeof (Sample) * to_write);
332 } else if (!(_in->opaque())) {
333 memset (crossfade_buffer_in, 0, sizeof (Sample) * to_write);
336 _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
337 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
339 float* fiv = new float[to_write];
340 float* fov = new float[to_write];
342 _fade_in.curve().get_vector (offset, offset+to_write, fiv, to_write);
343 _fade_out.curve().get_vector (offset, offset+to_write, fov, to_write);
345 /* note: although we have not explicitly taken into account the return values
346 from _out->read_at() or _in->read_at(), the length() function does this
347 implicitly. why? because it computes a value based on the in+out regions'
348 position and length, and so we know precisely how much data they could return.
351 for (nframes_t n = 0; n < to_write; ++n) {
352 buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
362 Crossfade::coverage (nframes_t start, nframes_t end) const
364 nframes_t my_end = _position + _length;
366 if ((start >= _position) && (end <= my_end)) {
367 return OverlapInternal;
369 if ((end >= _position) && (end <= my_end)) {
372 if ((start >= _position) && (start <= my_end)) {
375 if ((_position >= start) && (_position <= end) && (my_end <= end)) {
376 return OverlapExternal;
382 Crossfade::set_active (bool yn)
386 StateChanged (ActiveChanged);
391 Crossfade::refresh ()
393 /* crossfades must be between non-muted regions */
395 if (_out->muted() || _in->muted()) {
396 Invalidated (shared_from_this ());
400 /* Top layer shouldn't be transparent */
402 if (!((layer_relation > 0 ? _in : _out)->opaque())) {
403 Invalidated (shared_from_this());
407 /* layer ordering cannot change */
409 int32_t new_layer_relation = (int32_t) (_in->layer() - _out->layer());
411 if (new_layer_relation * layer_relation < 0) { // different sign, layers rotated
412 Invalidated (shared_from_this ());
416 OverlapType ot = _in->coverage (_out->first_frame(), _out->last_frame());
418 if (ot == OverlapNone) {
419 Invalidated (shared_from_this ());
425 if (ot != overlap_type) {
427 if (_follow_overlap) {
430 compute (_in, _out, _session.config.get_xfade_model());
433 catch (NoCrossfadeHere& err) {
434 Invalidated (shared_from_this ());
441 Invalidated (shared_from_this ());
447 send_signal = update ();
451 StateChanged (BoundsChanged); /* EMIT SIGNAL */
464 if (_follow_overlap) {
465 newlen = _out->first_frame() + _out->length() - _in->first_frame();
471 Invalidated (shared_from_this ());
477 if ((_follow_overlap && newlen != _length) || (_length > newlen)) {
479 double factor = newlen / (double) _length;
481 _fade_out.x_scale (factor);
482 _fade_in.x_scale (factor);
487 switch (_anchor_point) {
489 _position = _in->first_frame();
493 _position = _in->last_frame() - _length;
497 _position = _out->last_frame() - _length;
504 Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model)
506 boost::shared_ptr<AudioRegion> top;
507 boost::shared_ptr<AudioRegion> bottom;
508 nframes_t short_xfade_length;
510 short_xfade_length = _short_xfade_length;
512 if (a->layer() < b->layer()) {
520 /* first check for matching ends */
522 if (top->first_frame() == bottom->first_frame()) {
524 /* Both regions start at the same point */
526 if (top->last_frame() < bottom->last_frame()) {
528 /* top ends before bottom, so put an xfade
529 in at the end of top.
532 /* [-------- top ---------- ]
533 * {====== bottom =====================}
539 if (top->last_frame() < short_xfade_length) {
542 _position = top->last_frame() - short_xfade_length;
545 _length = min (short_xfade_length, top->length());
546 _follow_overlap = false;
547 _anchor_point = EndOfIn;
552 /* top ends after (or same time) as bottom - no xfade
555 /* [-------- top ------------------------ ]
556 * {====== bottom =====================}
559 throw NoCrossfadeHere();
562 } else if (top->last_frame() == bottom->last_frame()) {
564 /* Both regions end at the same point */
566 if (top->first_frame() > bottom->first_frame()) {
568 /* top starts after bottom, put an xfade in at the
572 /* [-------- top ---------- ]
573 * {====== bottom =====================}
578 _position = top->first_frame();
579 _length = min (short_xfade_length, top->length());
580 _follow_overlap = false;
581 _anchor_point = StartOfIn;
586 /* top starts before bottom - no xfade
589 /* [-------- top ------------------------ ]
590 * {====== bottom =====================}
593 throw NoCrossfadeHere();
598 /* OK, time to do more regular overlapping */
600 OverlapType ot = top->coverage (bottom->first_frame(), bottom->last_frame());
604 /* should be NOTREACHED as a precondition of creating
605 a new crossfade, but we need to handle it here.
607 throw NoCrossfadeHere();
610 case OverlapInternal:
611 case OverlapExternal:
612 /* should be NOTREACHED because of tests above */
613 throw NoCrossfadeHere();
616 case OverlapEnd: /* top covers start of bottom but ends within it */
618 /* [---- top ------------------------]
619 * { ==== bottom ============ }
624 _anchor_point = EndOfOut;
626 if (model == FullCrossfade) {
627 _position = bottom->first_frame(); // "{"
628 _length = _out->first_frame() + _out->length() - _in->first_frame();
629 /* leave active alone */
630 _follow_overlap = true;
632 _length = min (short_xfade_length, top->length());
633 _position = top->last_frame() - _length; // "]" - length
635 _follow_overlap = false;
640 case OverlapStart: /* top starts within bottom but covers bottom's end */
642 /* { ==== top ============ }
643 * [---- bottom -------------------]
648 _position = top->first_frame();
649 _anchor_point = StartOfIn;
651 if (model == FullCrossfade) {
652 _length = _out->first_frame() + _out->length() - _in->first_frame();
653 /* leave active alone */
654 _follow_overlap = true;
656 _length = min (short_xfade_length, top->length());
658 _follow_overlap = false;
670 Crossfade::get_state ()
672 XMLNode* node = new XMLNode (X_("Crossfade"));
675 LocaleGuard lg (X_("POSIX"));
677 _out->id().print (buf, sizeof (buf));
678 node->add_property ("out", buf);
679 _in->id().print (buf, sizeof (buf));
680 node->add_property ("in", buf);
681 node->add_property ("active", (_active ? "yes" : "no"));
682 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
683 node->add_property ("fixed", (_fixed ? "yes" : "no"));
684 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
685 node->add_property ("length", buf);
686 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
687 node->add_property ("anchor-point", buf);
688 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
689 node->add_property ("position", buf);
691 child = node->add_child ("FadeIn");
693 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
696 pnode = new XMLNode ("point");
698 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
699 pnode->add_property ("x", buf);
700 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
701 pnode->add_property ("y", buf);
702 child->add_child_nocopy (*pnode);
705 child = node->add_child ("FadeOut");
707 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
710 pnode = new XMLNode ("point");
712 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
713 pnode->add_property ("x", buf);
714 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
715 pnode->add_property ("y", buf);
716 child->add_child_nocopy (*pnode);
723 Crossfade::set_state (const XMLNode& node, int /*version*/)
725 XMLNodeConstIterator i;
726 XMLNodeList children;
729 const XMLProperty* prop;
730 LocaleGuard lg (X_("POSIX"));
731 Change what_changed = Change (0);
734 if ((prop = node.property ("position")) != 0) {
735 sscanf (prop->value().c_str(), "%" PRIu32, &val);
736 if (val != _position) {
738 what_changed = Change (what_changed | PositionChanged);
741 warning << _("old-style crossfade information - no position information") << endmsg;
742 _position = _in->first_frame();
745 if ((prop = node.property ("active")) != 0) {
746 bool x = string_is_affirmative (prop->value());
749 what_changed = Change (what_changed | ActiveChanged);
755 if ((prop = node.property ("follow-overlap")) != 0) {
756 _follow_overlap = string_is_affirmative (prop->value());
758 _follow_overlap = false;
761 if ((prop = node.property ("fixed")) != 0) {
762 _fixed = string_is_affirmative (prop->value());
767 if ((prop = node.property ("anchor-point")) != 0) {
768 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
770 _anchor_point = StartOfIn;
773 if ((prop = node.property ("length")) != 0) {
775 sscanf (prop->value().c_str(), "%" PRIu32, &val);
776 if (val != _length) {
777 _length = atol (prop->value().c_str());
778 what_changed = Change (what_changed | LengthChanged);
783 /* XXX this branch is legacy code from before
784 the point where we stored xfade lengths.
787 if ((_length = overlap_length()) == 0) {
788 throw failed_constructor();
792 if ((fi = find_named_node (node, "FadeIn")) == 0) {
796 if ((fo = find_named_node (node, "FadeOut")) == 0) {
805 children = fi->children();
807 for (i = children.begin(); i != children.end(); ++i) {
808 if ((*i)->name() == "point") {
812 prop = (*i)->property ("x");
813 sscanf (prop->value().c_str(), "%" PRIu32, &x);
815 prop = (*i)->property ("y");
816 sscanf (prop->value().c_str(), "%f", &y);
829 children = fo->children();
831 for (i = children.begin(); i != children.end(); ++i) {
832 if ((*i)->name() == "point") {
837 prop = (*i)->property ("x");
838 sscanf (prop->value().c_str(), "%" PRIu32, &x);
840 prop = (*i)->property ("y");
841 sscanf (prop->value().c_str(), "%f", &y);
843 _fade_out.add (x, y);
849 StateChanged (what_changed); /* EMIT SIGNAL */
855 Crossfade::can_follow_overlap () const
861 Crossfade::set_follow_overlap (bool yn)
863 if (yn == _follow_overlap || _fixed) {
867 _follow_overlap = yn;
870 set_xfade_length (_short_xfade_length);
872 set_xfade_length (_out->first_frame() + _out->length() - _in->first_frame());
875 StateChanged (FollowOverlapChanged);
879 Crossfade::set_xfade_length (nframes_t len)
883 switch (_anchor_point) {
885 limit = _in->length();
889 limit = _in->length();
893 limit = _out->length();
898 len = min (limit, len);
900 double factor = len / (double) _length;
903 _fade_out.x_scale (factor);
904 _fade_in.x_scale (factor);
909 StateChanged (LengthChanged);
915 Crossfade::overlap_length () const
920 return _out->first_frame() + _out->length() - _in->first_frame();
924 Crossfade::set_short_xfade_length (nframes_t n)
926 _short_xfade_length = n;