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.
21 #include "pbd/stacktrace.h"
23 #include "ardour/types.h"
24 #include "ardour/crossfade.h"
25 #include "ardour/crossfade_compare.h"
26 #include "ardour/audioregion.h"
27 #include "ardour/playlist.h"
28 #include "ardour/utils.h"
29 #include "ardour/session.h"
30 #include "ardour/source.h"
36 using namespace ARDOUR;
39 nframes_t Crossfade::_short_xfade_length = 0;
40 Change Crossfade::ActiveChanged = new_change();
41 Change Crossfade::FollowOverlapChanged = new_change();
43 /* XXX if and when we ever implement parallel processing of the process()
44 callback, these will need to be handled on a per-thread basis.
47 Sample* Crossfade::crossfade_buffer_out = 0;
48 Sample* Crossfade::crossfade_buffer_in = 0;
51 Crossfade::set_buffer_size (nframes_t sz)
53 delete [] crossfade_buffer_out;
54 crossfade_buffer_out = 0;
56 delete [] crossfade_buffer_in;
57 crossfade_buffer_in = 0;
60 crossfade_buffer_out = new Sample[sz];
61 crossfade_buffer_in = new Sample[sz];
66 Crossfade::operator== (const Crossfade& other)
68 return (_in == other._in) && (_out == other._out);
71 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> in, boost::shared_ptr<AudioRegion> out,
75 : AudioRegion (in->session(), position, length, in->name() + string ("<>") + out->name()),
76 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
77 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
83 _follow_overlap = false;
85 _active = _session.config.get_xfades_active ();
91 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model, bool act)
92 : AudioRegion (a->session(), 0, 0, a->name() + string ("<>") + b->name()),
93 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
94 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
98 _follow_overlap = false;
100 if (compute (a, b, model)) {
101 throw failed_constructor();
109 Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
110 : AudioRegion (playlist.session(), 0, 0, "unnamed crossfade"),
111 _fade_in (Evoral::Parameter(FadeInAutomation)), // linear (gain coefficient) => -inf..+6dB
112 _fade_out (Evoral::Parameter(FadeOutAutomation)) // linear (gain coefficient) => -inf..+6dB
115 boost::shared_ptr<Region> r;
117 LocaleGuard lg (X_("POSIX"));
119 /* we have to find the in/out regions before we can do anything else */
121 if ((prop = node.property ("in")) == 0) {
122 error << _("Crossfade: no \"in\" region in state") << endmsg;
123 throw failed_constructor();
126 PBD::ID id (prop->value());
128 if ((r = playlist.find_region (id)) == 0) {
129 error << string_compose (_("Crossfade: no \"in\" region %1 found in playlist %2"), id, playlist.name())
131 throw failed_constructor();
134 if ((_in = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
135 throw failed_constructor();
138 if ((prop = node.property ("out")) == 0) {
139 error << _("Crossfade: no \"out\" region in state") << endmsg;
140 throw failed_constructor();
143 PBD::ID id2 (prop->value());
145 if ((r = playlist.find_region (id2)) == 0) {
146 error << string_compose (_("Crossfade: no \"out\" region %1 found in playlist %2"), id2, playlist.name())
148 throw failed_constructor();
151 if ((_out = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
152 throw failed_constructor();
159 if (set_state (node, Stateful::loading_state_version)) {
160 throw failed_constructor();
164 Crossfade::Crossfade (boost::shared_ptr<Crossfade> orig, boost::shared_ptr<AudioRegion> newin, boost::shared_ptr<AudioRegion> newout)
165 : AudioRegion (boost::dynamic_pointer_cast<const AudioRegion> (orig)),
166 _fade_in (orig->_fade_in),
167 _fade_out (orig->_fade_out)
169 _active = orig->_active;
170 _in_update = orig->_in_update;
171 _anchor_point = orig->_anchor_point;
172 _follow_overlap = orig->_follow_overlap;
173 _fixed = orig->_fixed;
178 // copied from Crossfade::initialize()
181 _out->suspend_fade_out ();
182 _in->suspend_fade_in ();
184 overlap_type = _in->coverage (_out->position(), _out->last_frame());
185 layer_relation = (int32_t) (_in->layer() - _out->layer());
187 // Let's make sure the fade isn't too long
188 set_xfade_length(_length);
192 Crossfade::~Crossfade ()
197 Crossfade::initialize ()
199 /* merge source lists from regions */
201 _sources = _in->sources();
202 _sources.insert (_sources.end(), _out->sources().begin(), _out->sources().end());
203 _master_sources = _in->master_sources();
204 _master_sources.insert(_master_sources.end(), _out->master_sources().begin(), _out->master_sources().end());
208 _out->suspend_fade_out ();
209 _in->suspend_fade_in ();
214 #define EQUAL_POWER_MINUS_3DB
215 #ifdef EQUAL_POWER_MINUS_3DB
217 _fade_out.add ((_length * 0.000000), 1.000000);
218 _fade_out.add ((_length * 0.166667), 0.948859);
219 _fade_out.add ((_length * 0.333333), 0.851507);
220 _fade_out.add ((_length * 0.500000), 0.707946);
221 _fade_out.add ((_length * 0.666667), 0.518174);
222 _fade_out.add ((_length * 0.833333), 0.282192);
223 _fade_out.add ((_length * 1.000000), 0.000000);
225 #else // EQUAL_POWER_MINUS_6DB
227 _fade_out.add ((_length * 0.000000), 1.000000);
228 _fade_out.add ((_length * 0.166667), 0.833033);
229 _fade_out.add ((_length * 0.333333), 0.666186);
230 _fade_out.add ((_length * 0.500000), 0.499459);
231 _fade_out.add ((_length * 0.666667), 0.332853);
232 _fade_out.add ((_length * 0.833333), 0.166366);
233 _fade_out.add ((_length * 1.000000), 0.000000);
241 #define EQUAL_POWER_MINUS_3DB
242 #ifdef EQUAL_POWER_MINUS_3DB
244 _fade_in.add ((_length * 0.000000), 0.000000);
245 _fade_in.add ((_length * 0.166667), 0.282192);
246 _fade_in.add ((_length * 0.333333), 0.518174);
247 _fade_in.add ((_length * 0.500000), 0.707946);
248 _fade_in.add ((_length * 0.666667), 0.851507);
249 _fade_in.add ((_length * 0.833333), 0.948859);
250 _fade_in.add ((_length * 1.000000), 1.000000);
252 #else // EQUAL_POWER_MINUS_SIX_DB
254 _fade_in.add ((_length * 0.000000), 0.000000);
255 _fade_in.add ((_length * 0.166667), 0.166366);
256 _fade_in.add ((_length * 0.333333), 0.332853);
257 _fade_in.add ((_length * 0.500000), 0.499459);
258 _fade_in.add ((_length * 0.666667), 0.666186);
259 _fade_in.add ((_length * 0.833333), 0.833033);
260 _fade_in.add ((_length * 1.000000), 1.000000);
266 overlap_type = _in->coverage (_out->position(), _out->last_frame());
267 layer_relation = (int32_t) (_in->layer() - _out->layer());
271 Crossfade::read_raw_internal (Sample* /*buf*/, sframes_t /*start*/, nframes_t cnt, int /*channel*/) const
273 // FIXME: Why is this disabled?
275 Sample* mixdown = new Sample[cnt];
276 float* gain = new float[cnt];
279 ret = read_at (buf, mixdown, gain, start, cnt, chan_n, cnt);
290 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
291 float *gain_buffer, sframes_t start, nframes_t cnt, uint32_t chan_n,
292 nframes_t read_frames, nframes_t skip_frames) const
301 if (start < _position) {
303 /* handle an initial section of the read area that we do not
307 offset = _position - start;
317 to_write = min (_length, cnt);
321 to_write = min (nframes_t(_length - (start - _position)), cnt);
325 offset = start - _position;
327 /* Prevent data from piling up inthe crossfade buffers when reading a transparent region */
328 if (!(_out->opaque())) {
329 memset (crossfade_buffer_out, 0, sizeof (Sample) * to_write);
330 } else if (!(_in->opaque())) {
331 memset (crossfade_buffer_in, 0, sizeof (Sample) * to_write);
334 _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
335 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
337 float* fiv = new float[to_write];
338 float* fov = new float[to_write];
340 _fade_in.curve().get_vector (offset, offset+to_write, fiv, to_write);
341 _fade_out.curve().get_vector (offset, offset+to_write, fov, to_write);
343 /* note: although we have not explicitly taken into account the return values
344 from _out->read_at() or _in->read_at(), the length() function does this
345 implicitly. why? because it computes a value based on the in+out regions'
346 position and length, and so we know precisely how much data they could return.
349 for (nframes_t n = 0; n < to_write; ++n) {
350 buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
360 Crossfade::coverage (nframes_t start, nframes_t end) const
362 nframes_t my_end = _position + _length;
364 if ((start >= _position) && (end <= my_end)) {
365 return OverlapInternal;
367 if ((end >= _position) && (end <= my_end)) {
370 if ((start >= _position) && (start <= my_end)) {
373 if ((_position >= start) && (_position <= end) && (my_end <= end)) {
374 return OverlapExternal;
380 Crossfade::set_active (bool yn)
384 StateChanged (ActiveChanged);
389 Crossfade::refresh ()
391 /* crossfades must be between non-muted regions */
393 if (_out->muted() || _in->muted()) {
394 Invalidated (shared_from_this ());
398 /* Top layer shouldn't be transparent */
400 if (!((layer_relation > 0 ? _in : _out)->opaque())) {
401 Invalidated (shared_from_this());
405 /* layer ordering cannot change */
407 int32_t new_layer_relation = (int32_t) (_in->layer() - _out->layer());
409 if (new_layer_relation * layer_relation < 0) { // different sign, layers rotated
410 Invalidated (shared_from_this ());
414 OverlapType ot = _in->coverage (_out->first_frame(), _out->last_frame());
416 if (ot == OverlapNone) {
417 Invalidated (shared_from_this ());
423 if (ot != overlap_type) {
425 if (_follow_overlap) {
428 compute (_in, _out, _session.config.get_xfade_model());
431 catch (NoCrossfadeHere& err) {
432 Invalidated (shared_from_this ());
439 Invalidated (shared_from_this ());
445 send_signal = update ();
449 StateChanged (BoundsChanged); /* EMIT SIGNAL */
462 if (_follow_overlap) {
463 newlen = _out->first_frame() + _out->length() - _in->first_frame();
469 Invalidated (shared_from_this ());
475 if ((_follow_overlap && newlen != _length) || (_length > newlen)) {
477 double factor = newlen / (double) _length;
479 _fade_out.x_scale (factor);
480 _fade_in.x_scale (factor);
485 switch (_anchor_point) {
487 _position = _in->first_frame();
491 _position = _in->last_frame() - _length;
495 _position = _out->last_frame() - _length;
502 Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model)
504 boost::shared_ptr<AudioRegion> top;
505 boost::shared_ptr<AudioRegion> bottom;
506 nframes_t short_xfade_length;
508 short_xfade_length = _short_xfade_length;
510 if (a->layer() < b->layer()) {
518 /* first check for matching ends */
520 if (top->first_frame() == bottom->first_frame()) {
522 /* Both regions start at the same point */
524 if (top->last_frame() < bottom->last_frame()) {
526 /* top ends before bottom, so put an xfade
527 in at the end of top.
530 /* [-------- top ---------- ]
531 * {====== bottom =====================}
537 if (top->last_frame() < short_xfade_length) {
540 _position = top->last_frame() - short_xfade_length;
543 _length = min (short_xfade_length, top->length());
544 _follow_overlap = false;
545 _anchor_point = EndOfIn;
550 /* top ends after (or same time) as bottom - no xfade
553 /* [-------- top ------------------------ ]
554 * {====== bottom =====================}
557 throw NoCrossfadeHere();
560 } else if (top->last_frame() == bottom->last_frame()) {
562 /* Both regions end at the same point */
564 if (top->first_frame() > bottom->first_frame()) {
566 /* top starts after bottom, put an xfade in at the
570 /* [-------- top ---------- ]
571 * {====== bottom =====================}
576 _position = top->first_frame();
577 _length = min (short_xfade_length, top->length());
578 _follow_overlap = false;
579 _anchor_point = StartOfIn;
584 /* top starts before bottom - no xfade
587 /* [-------- top ------------------------ ]
588 * {====== bottom =====================}
591 throw NoCrossfadeHere();
596 /* OK, time to do more regular overlapping */
598 OverlapType ot = top->coverage (bottom->first_frame(), bottom->last_frame());
602 /* should be NOTREACHED as a precondition of creating
603 a new crossfade, but we need to handle it here.
605 throw NoCrossfadeHere();
608 case OverlapInternal:
609 case OverlapExternal:
610 /* should be NOTREACHED because of tests above */
611 throw NoCrossfadeHere();
614 case OverlapEnd: /* top covers start of bottom but ends within it */
616 /* [---- top ------------------------]
617 * { ==== bottom ============ }
622 _anchor_point = EndOfOut;
624 if (model == FullCrossfade) {
625 _position = bottom->first_frame(); // "{"
626 _length = _out->first_frame() + _out->length() - _in->first_frame();
627 /* leave active alone */
628 _follow_overlap = true;
630 _length = min (short_xfade_length, top->length());
631 _position = top->last_frame() - _length; // "]" - length
633 _follow_overlap = false;
638 case OverlapStart: /* top starts within bottom but covers bottom's end */
640 /* { ==== top ============ }
641 * [---- bottom -------------------]
646 _position = top->first_frame();
647 _anchor_point = StartOfIn;
649 if (model == FullCrossfade) {
650 _length = _out->first_frame() + _out->length() - _in->first_frame();
651 /* leave active alone */
652 _follow_overlap = true;
654 _length = min (short_xfade_length, top->length());
656 _follow_overlap = false;
668 Crossfade::get_state ()
670 XMLNode* node = new XMLNode (X_("Crossfade"));
673 LocaleGuard lg (X_("POSIX"));
675 _out->id().print (buf, sizeof (buf));
676 node->add_property ("out", buf);
677 _in->id().print (buf, sizeof (buf));
678 node->add_property ("in", buf);
679 node->add_property ("active", (_active ? "yes" : "no"));
680 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
681 node->add_property ("fixed", (_fixed ? "yes" : "no"));
682 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
683 node->add_property ("length", buf);
684 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
685 node->add_property ("anchor-point", buf);
686 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
687 node->add_property ("position", buf);
689 child = node->add_child ("FadeIn");
691 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
694 pnode = new XMLNode ("point");
696 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
697 pnode->add_property ("x", buf);
698 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
699 pnode->add_property ("y", buf);
700 child->add_child_nocopy (*pnode);
703 child = node->add_child ("FadeOut");
705 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
708 pnode = new XMLNode ("point");
710 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
711 pnode->add_property ("x", buf);
712 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
713 pnode->add_property ("y", buf);
714 child->add_child_nocopy (*pnode);
721 Crossfade::set_state (const XMLNode& node, int /*version*/)
723 XMLNodeConstIterator i;
724 XMLNodeList children;
727 const XMLProperty* prop;
728 LocaleGuard lg (X_("POSIX"));
729 Change what_changed = Change (0);
732 if ((prop = node.property ("position")) != 0) {
733 sscanf (prop->value().c_str(), "%" PRIu32, &val);
734 if (val != _position) {
736 what_changed = Change (what_changed | PositionChanged);
739 warning << _("old-style crossfade information - no position information") << endmsg;
740 _position = _in->first_frame();
743 if ((prop = node.property ("active")) != 0) {
744 bool x = string_is_affirmative (prop->value());
747 what_changed = Change (what_changed | ActiveChanged);
753 if ((prop = node.property ("follow-overlap")) != 0) {
754 _follow_overlap = string_is_affirmative (prop->value());
756 _follow_overlap = false;
759 if ((prop = node.property ("fixed")) != 0) {
760 _fixed = string_is_affirmative (prop->value());
765 if ((prop = node.property ("anchor-point")) != 0) {
766 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
768 _anchor_point = StartOfIn;
771 if ((prop = node.property ("length")) != 0) {
773 sscanf (prop->value().c_str(), "%" PRIu32, &val);
774 if (val != _length) {
775 _length = atol (prop->value().c_str());
776 what_changed = Change (what_changed | LengthChanged);
781 /* XXX this branch is legacy code from before
782 the point where we stored xfade lengths.
785 if ((_length = overlap_length()) == 0) {
786 throw failed_constructor();
790 if ((fi = find_named_node (node, "FadeIn")) == 0) {
794 if ((fo = find_named_node (node, "FadeOut")) == 0) {
803 children = fi->children();
805 for (i = children.begin(); i != children.end(); ++i) {
806 if ((*i)->name() == "point") {
810 prop = (*i)->property ("x");
811 sscanf (prop->value().c_str(), "%" PRIu32, &x);
813 prop = (*i)->property ("y");
814 sscanf (prop->value().c_str(), "%f", &y);
827 children = fo->children();
829 for (i = children.begin(); i != children.end(); ++i) {
830 if ((*i)->name() == "point") {
835 prop = (*i)->property ("x");
836 sscanf (prop->value().c_str(), "%" PRIu32, &x);
838 prop = (*i)->property ("y");
839 sscanf (prop->value().c_str(), "%f", &y);
841 _fade_out.add (x, y);
847 StateChanged (what_changed); /* EMIT SIGNAL */
853 Crossfade::can_follow_overlap () const
859 Crossfade::set_follow_overlap (bool yn)
861 if (yn == _follow_overlap || _fixed) {
865 _follow_overlap = yn;
868 set_xfade_length (_short_xfade_length);
870 set_xfade_length (_out->first_frame() + _out->length() - _in->first_frame());
873 StateChanged (FollowOverlapChanged);
877 Crossfade::set_xfade_length (nframes_t len)
881 switch (_anchor_point) {
883 limit = _in->length();
887 limit = _in->length();
891 limit = _out->length();
896 len = min (limit, len);
898 double factor = len / (double) _length;
901 _fade_out.x_scale (factor);
902 _fade_in.x_scale (factor);
907 StateChanged (LengthChanged);
913 Crossfade::overlap_length () const
918 return _out->first_frame() + _out->length() - _in->first_frame();
922 Crossfade::set_short_xfade_length (nframes_t n)
924 _short_xfade_length = n;