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 <sigc++/bind.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>
35 using namespace ARDOUR;
38 nframes_t Crossfade::_short_xfade_length = 0;
39 Change Crossfade::ActiveChanged = new_change();
40 Change Crossfade::FollowOverlapChanged = new_change();
42 /* XXX if and when we ever implement parallel processing of the process()
43 callback, these will need to be handled on a per-thread basis.
46 Sample* Crossfade::crossfade_buffer_out = 0;
47 Sample* Crossfade::crossfade_buffer_in = 0;
50 Crossfade::set_buffer_size (nframes_t sz)
52 if (crossfade_buffer_out) {
53 delete [] crossfade_buffer_out;
54 crossfade_buffer_out = 0;
57 if (crossfade_buffer_in) {
58 delete [] crossfade_buffer_in;
59 crossfade_buffer_in = 0;
63 crossfade_buffer_out = new Sample[sz];
64 crossfade_buffer_in = new Sample[sz];
69 Crossfade::operator== (const Crossfade& other)
71 return (_in == other._in) && (_out == other._out);
74 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> in, boost::shared_ptr<AudioRegion> out,
78 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
79 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
87 switch (Config->get_xfade_model()) {
89 _follow_overlap = false;
92 _follow_overlap = true;
95 _active = Config->get_xfades_active ();
101 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model, bool act)
102 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
103 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
108 if (compute (a, b, model)) {
109 throw failed_constructor();
118 Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
119 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
120 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
122 boost::shared_ptr<Region> r;
124 LocaleGuard lg (X_("POSIX"));
126 /* we have to find the in/out regions before we can do anything else */
128 if ((prop = node.property ("in")) == 0) {
129 error << _("Crossfade: no \"in\" region in state") << endmsg;
130 throw failed_constructor();
133 PBD::ID id (prop->value());
135 if ((r = playlist.find_region (id)) == 0) {
136 error << string_compose (_("Crossfade: no \"in\" region %1 found in playlist %2"), id, playlist.name())
138 throw failed_constructor();
141 if ((_in = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
142 throw failed_constructor();
145 if ((prop = node.property ("out")) == 0) {
146 error << _("Crossfade: no \"out\" region in state") << endmsg;
147 throw failed_constructor();
150 PBD::ID id2 (prop->value());
152 if ((r = playlist.find_region (id2)) == 0) {
153 error << string_compose (_("Crossfade: no \"out\" region %1 found in playlist %2"), id2, playlist.name())
155 throw failed_constructor();
158 if ((_out = boost::dynamic_pointer_cast<AudioRegion> (r)) == 0) {
159 throw failed_constructor();
163 _active = Config->get_xfades_active();
167 if (set_state (node)) {
168 throw failed_constructor();
172 Crossfade::Crossfade (const Crossfade &orig, boost::shared_ptr<AudioRegion> newin, boost::shared_ptr<AudioRegion> newout)
173 : _fade_in(orig._fade_in),
174 _fade_out(orig._fade_out)
176 _active = orig._active;
177 _in_update = orig._in_update;
178 _length = orig._length;
179 _position = orig._position;
180 _anchor_point = orig._anchor_point;
181 _follow_overlap = orig._follow_overlap;
182 _fixed = orig._fixed;
187 // copied from Crossfade::initialize()
190 _out->suspend_fade_out ();
191 _in->suspend_fade_in ();
193 overlap_type = _in->coverage (_out->position(), _out->last_frame());
195 // Let's make sure the fade isn't too long
200 Crossfade::~Crossfade ()
206 Crossfade::initialize ()
210 _out->suspend_fade_out ();
211 _in->suspend_fade_in ();
215 _fade_out.add (0.0, 1.0);
216 _fade_out.add ((_length * 0.1), 0.99);
217 _fade_out.add ((_length * 0.2), 0.97);
218 _fade_out.add ((_length * 0.8), 0.03);
219 _fade_out.add ((_length * 0.9), 0.01);
220 _fade_out.add (_length, 0.0);
225 _fade_in.add (0.0, 0.0);
226 _fade_in.add ((_length * 0.1), 0.01);
227 _fade_in.add ((_length * 0.2), 0.03);
228 _fade_in.add ((_length * 0.8), 0.97);
229 _fade_in.add ((_length * 0.9), 0.99);
230 _fade_in.add (_length, 1.0);
233 _in->StateChanged.connect (sigc::mem_fun (*this, &Crossfade::member_changed));
234 _out->StateChanged.connect (sigc::mem_fun (*this, &Crossfade::member_changed));
236 overlap_type = _in->coverage (_out->position(), _out->last_frame());
240 Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model)
242 boost::shared_ptr<AudioRegion> top;
243 boost::shared_ptr<AudioRegion> bottom;
244 nframes_t short_xfade_length;
246 short_xfade_length = _short_xfade_length;
248 if (a->layer() < b->layer()) {
256 /* first check for matching ends */
258 if (top->first_frame() == bottom->first_frame()) {
260 /* Both regions start at the same point */
262 if (top->last_frame() < bottom->last_frame()) {
264 /* top ends before bottom, so put an xfade
265 in at the end of top.
268 /* [-------- top ---------- ]
269 * {====== bottom =====================}
275 if (top->last_frame() < short_xfade_length) {
278 _position = top->last_frame() - short_xfade_length;
281 _length = min (short_xfade_length, top->length());
282 _follow_overlap = false;
283 _anchor_point = EndOfIn;
288 /* top ends after (or same time) as bottom - no xfade
291 /* [-------- top ------------------------ ]
292 * {====== bottom =====================}
295 throw NoCrossfadeHere();
298 } else if (top->last_frame() == bottom->last_frame()) {
300 /* Both regions end at the same point */
302 if (top->first_frame() > bottom->first_frame()) {
304 /* top starts after bottom, put an xfade in at the
308 /* [-------- top ---------- ]
309 * {====== bottom =====================}
314 _position = top->first_frame();
315 _length = min (short_xfade_length, top->length());
316 _follow_overlap = false;
317 _anchor_point = StartOfIn;
322 /* top starts before bottom - no xfade
325 /* [-------- top ------------------------ ]
326 * {====== bottom =====================}
329 throw NoCrossfadeHere();
334 /* OK, time to do more regular overlapping */
336 OverlapType ot = top->coverage (bottom->first_frame(), bottom->last_frame());
340 /* should be NOTREACHED as a precondition of creating
341 a new crossfade, but we need to handle it here.
343 throw NoCrossfadeHere();
346 case OverlapInternal:
347 case OverlapExternal:
348 /* should be NOTREACHED because of tests above */
349 throw NoCrossfadeHere();
352 case OverlapEnd: /* top covers start of bottom but ends within it */
354 /* [---- top ------------------------]
355 * { ==== bottom ============ }
360 _position = bottom->first_frame();
361 _anchor_point = StartOfIn;
363 if (model == FullCrossfade) {
364 _length = _out->first_frame() + _out->length() - _in->first_frame();
365 /* leave active alone */
366 _follow_overlap = true;
368 _length = min (short_xfade_length, top->length());
370 _follow_overlap = false;
375 case OverlapStart: /* top starts within bottom but covers bottom's end */
377 /* { ==== top ============ }
378 * [---- bottom -------------------]
383 _position = top->first_frame();
384 _anchor_point = StartOfIn;
386 if (model == FullCrossfade) {
387 _length = _out->first_frame() + _out->length() - _in->first_frame();
388 /* leave active alone */
389 _follow_overlap = true;
391 _length = min (short_xfade_length, top->length());
393 _follow_overlap = false;
405 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
406 float *gain_buffer, nframes_t start, nframes_t cnt, uint32_t chan_n,
407 nframes_t read_frames, nframes_t skip_frames)
416 if (start < _position) {
418 /* handle an initial section of the read area that we do not
422 offset = _position - start;
432 to_write = min (_length, cnt);
436 to_write = min (_length - (start - _position), cnt);
440 offset = start - _position;
442 _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
443 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
445 float* fiv = new float[to_write];
446 float* fov = new float[to_write];
448 _fade_in.get_vector (offset, offset+to_write, fiv, to_write);
449 _fade_out.get_vector (offset, offset+to_write, fov, to_write);
451 /* note: although we have not explicitly taken into account the return values
452 from _out->read_at() or _in->read_at(), the length() function does this
453 implicitly. why? because it computes a value based on the in+out regions'
454 position and length, and so we know precisely how much data they could return.
457 for (nframes_t n = 0; n < to_write; ++n) {
458 buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
468 Crossfade::coverage (nframes_t start, nframes_t end) const
470 nframes_t my_end = _position + _length;
472 if ((start >= _position) && (end <= my_end)) {
473 return OverlapInternal;
475 if ((end >= _position) && (end <= my_end)) {
478 if ((start >= _position) && (start <= my_end)) {
481 if ((_position >= start) && (_position <= end) && (my_end <= end)) {
482 return OverlapExternal;
488 Crossfade::set_active (bool yn)
492 StateChanged (ActiveChanged);
497 Crossfade::refresh ()
499 /* crossfades must be between non-muted regions */
501 if (_out->muted() || _in->muted()) {
506 /* overlap type must be Start, End or External */
510 ot = _in->coverage (_out->first_frame(), _out->last_frame());
514 case OverlapInternal:
522 /* overlap type must not have altered */
524 if (ot != overlap_type) {
531 return update (false);
535 Crossfade::update (bool force)
539 if (_follow_overlap) {
540 newlen = _out->first_frame() + _out->length() - _in->first_frame();
552 if (force || (_follow_overlap && newlen != _length) || (_length > newlen)) {
554 double factor = newlen / (double) _length;
556 _fade_out.x_scale (factor);
557 _fade_in.x_scale (factor);
563 switch (_anchor_point) {
565 if (_position != _in->first_frame()) {
566 _position = _in->first_frame();
571 if (_position != _in->last_frame() - _length) {
572 _position = _in->last_frame() - _length;
577 if (_position != _out->last_frame() - _length) {
578 _position = _out->last_frame() - _length;
582 /* UI's may need to know that the overlap changed even
583 though the xfade length did not.
586 StateChanged (BoundsChanged); /* EMIT SIGNAL */
594 Crossfade::member_changed (Change what_changed)
596 Change what_we_care_about = Change (Region::MuteChanged|
597 Region::LayerChanged|
600 if (what_changed & what_we_care_about) {
606 Crossfade::get_state ()
608 XMLNode* node = new XMLNode (X_("Crossfade"));
611 LocaleGuard lg (X_("POSIX"));
613 _out->id().print (buf, sizeof (buf));
614 node->add_property ("out", buf);
615 _in->id().print (buf, sizeof (buf));
616 node->add_property ("in", buf);
617 node->add_property ("active", (_active ? "yes" : "no"));
618 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
619 node->add_property ("fixed", (_fixed ? "yes" : "no"));
620 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
621 node->add_property ("length", buf);
622 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
623 node->add_property ("anchor-point", buf);
624 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
625 node->add_property ("position", buf);
627 child = node->add_child ("FadeIn");
629 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
632 pnode = new XMLNode ("point");
634 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
635 pnode->add_property ("x", buf);
636 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
637 pnode->add_property ("y", buf);
638 child->add_child_nocopy (*pnode);
641 child = node->add_child ("FadeOut");
643 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
646 pnode = new XMLNode ("point");
648 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
649 pnode->add_property ("x", buf);
650 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
651 pnode->add_property ("y", buf);
652 child->add_child_nocopy (*pnode);
659 Crossfade::set_state (const XMLNode& node)
661 XMLNodeConstIterator i;
662 XMLNodeList children;
665 const XMLProperty* prop;
666 LocaleGuard lg (X_("POSIX"));
667 Change what_changed = Change (0);
670 if ((prop = node.property ("position")) != 0) {
671 sscanf (prop->value().c_str(), "%" PRIu32, &val);
672 if (val != _position) {
674 what_changed = Change (what_changed | PositionChanged);
677 warning << _("old-style crossfade information - no position information") << endmsg;
678 _position = _in->first_frame();
681 if ((prop = node.property ("active")) != 0) {
682 bool x = (prop->value() == "yes");
685 what_changed = Change (what_changed | ActiveChanged);
691 if ((prop = node.property ("follow-overlap")) != 0) {
692 _follow_overlap = (prop->value() == "yes");
694 _follow_overlap = false;
697 if ((prop = node.property ("fixed")) != 0) {
698 _fixed = (prop->value() == "yes");
703 if ((prop = node.property ("anchor-point")) != 0) {
704 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
706 _anchor_point = StartOfIn;
709 if ((prop = node.property ("length")) != 0) {
711 sscanf (prop->value().c_str(), "%" PRIu32, &val);
712 if (val != _length) {
713 _length = atol (prop->value().c_str());
714 what_changed = Change (what_changed | LengthChanged);
719 /* XXX this branch is legacy code from before
720 the point where we stored xfade lengths.
723 if ((_length = overlap_length()) == 0) {
724 throw failed_constructor();
728 if ((fi = find_named_node (node, "FadeIn")) == 0) {
732 if ((fo = find_named_node (node, "FadeOut")) == 0) {
741 children = fi->children();
743 for (i = children.begin(); i != children.end(); ++i) {
744 if ((*i)->name() == "point") {
748 prop = (*i)->property ("x");
749 sscanf (prop->value().c_str(), "%" PRIu32, &x);
751 prop = (*i)->property ("y");
752 sscanf (prop->value().c_str(), "%f", &y);
765 children = fo->children();
767 for (i = children.begin(); i != children.end(); ++i) {
768 if ((*i)->name() == "point") {
773 prop = (*i)->property ("x");
774 sscanf (prop->value().c_str(), "%" PRIu32, &x);
776 prop = (*i)->property ("y");
777 sscanf (prop->value().c_str(), "%f", &y);
779 _fade_out.add (x, y);
785 StateChanged (what_changed); /* EMIT SIGNAL */
791 Crossfade::can_follow_overlap () const
797 Crossfade::set_follow_overlap (bool yn)
799 if (yn == _follow_overlap || _fixed) {
803 _follow_overlap = yn;
806 set_length (_short_xfade_length);
808 set_length (_out->first_frame() + _out->length() - _in->first_frame());
811 StateChanged (FollowOverlapChanged);
815 Crossfade::set_length (nframes_t len)
819 switch (_anchor_point) {
821 limit = _in->length();
825 limit = _in->length();
829 limit = _out->length();
834 len = min (limit, len);
836 double factor = len / (double) _length;
839 _fade_out.x_scale (factor);
840 _fade_in.x_scale (factor);
845 StateChanged (LengthChanged);
851 Crossfade::overlap_length () const
856 return _out->first_frame() + _out->length() - _in->first_frame();
860 Crossfade::set_short_xfade_length (nframes_t n)
862 _short_xfade_length = n;
866 Crossfade::invalidate ()
868 Invalidated (this); /* EMIT SIGNAL */