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>
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 if (crossfade_buffer_out) {
54 delete [] crossfade_buffer_out;
55 crossfade_buffer_out = 0;
58 if (crossfade_buffer_in) {
59 delete [] crossfade_buffer_in;
60 crossfade_buffer_in = 0;
64 crossfade_buffer_out = new Sample[sz];
65 crossfade_buffer_in = new Sample[sz];
70 Crossfade::operator== (const Crossfade& other)
72 return (_in == other._in) && (_out == other._out);
75 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> in, boost::shared_ptr<AudioRegion> out,
79 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
80 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
89 _follow_overlap = false;
91 _active = Config->get_xfades_active ();
97 Crossfade::Crossfade (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model, bool act)
98 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
99 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
104 if (compute (a, b, model)) {
105 throw failed_constructor();
113 Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
114 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
115 _fade_out (0.0, 2.0, 1.0) // 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();
160 if (set_state (node)) {
161 throw failed_constructor();
165 Crossfade::Crossfade (const Crossfade &orig, boost::shared_ptr<AudioRegion> newin, boost::shared_ptr<AudioRegion> newout)
166 : _fade_in(orig._fade_in),
167 _fade_out(orig._fade_out)
169 _active = orig._active;
170 _in_update = orig._in_update;
171 _length = orig._length;
172 _position = orig._position;
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
194 Crossfade::~Crossfade ()
200 Crossfade::initialize ()
204 _out->suspend_fade_out ();
205 _in->suspend_fade_in ();
209 _fade_out.add (0.0, 1.0);
210 _fade_out.add ((_length * 0.1), 0.99);
211 _fade_out.add ((_length * 0.2), 0.97);
212 _fade_out.add ((_length * 0.8), 0.03);
213 _fade_out.add ((_length * 0.9), 0.01);
214 _fade_out.add (_length, 0.0);
219 _fade_in.add (0.0, 0.0);
220 _fade_in.add ((_length * 0.1), 0.01);
221 _fade_in.add ((_length * 0.2), 0.03);
222 _fade_in.add ((_length * 0.8), 0.97);
223 _fade_in.add ((_length * 0.9), 0.99);
224 _fade_in.add (_length, 1.0);
227 overlap_type = _in->coverage (_out->position(), _out->last_frame());
228 layer_relation = (int32_t) (_in->layer() - _out->layer());
232 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
233 float *gain_buffer, nframes_t start, nframes_t cnt, uint32_t chan_n,
234 nframes_t read_frames, nframes_t skip_frames)
243 if (start < _position) {
245 /* handle an initial section of the read area that we do not
249 offset = _position - start;
259 to_write = min (_length, cnt);
263 to_write = min (_length - (start - _position), cnt);
267 offset = start - _position;
269 _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
270 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
272 float* fiv = new float[to_write];
273 float* fov = new float[to_write];
275 _fade_in.get_vector (offset, offset+to_write, fiv, to_write);
276 _fade_out.get_vector (offset, offset+to_write, fov, to_write);
278 /* note: although we have not explicitly taken into account the return values
279 from _out->read_at() or _in->read_at(), the length() function does this
280 implicitly. why? because it computes a value based on the in+out regions'
281 position and length, and so we know precisely how much data they could return.
284 for (nframes_t n = 0; n < to_write; ++n) {
285 buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
295 Crossfade::coverage (nframes_t start, nframes_t end) const
297 nframes_t my_end = _position + _length;
299 if ((start >= _position) && (end <= my_end)) {
300 return OverlapInternal;
302 if ((end >= _position) && (end <= my_end)) {
305 if ((start >= _position) && (start <= my_end)) {
308 if ((_position >= start) && (_position <= end) && (my_end <= end)) {
309 return OverlapExternal;
315 Crossfade::set_active (bool yn)
319 StateChanged (ActiveChanged);
324 Crossfade::refresh ()
326 /* crossfades must be between non-muted regions */
328 if (_out->muted() || _in->muted()) {
329 Invalidated (shared_from_this());
333 /* layer ordering cannot change */
335 int32_t new_layer_relation = (int32_t) (_in->layer() - _out->layer());
337 if (new_layer_relation * layer_relation < 0) { // different sign, layers rotated
338 Invalidated (shared_from_this());
342 OverlapType ot = _in->coverage (_out->first_frame(), _out->last_frame());
344 if (ot == OverlapNone) {
345 Invalidated (shared_from_this());
351 if (ot != overlap_type) {
353 if (_follow_overlap) {
356 compute (_in, _out, Config->get_xfade_model());
359 catch (NoCrossfadeHere& err) {
360 Invalidated (shared_from_this());
368 Invalidated (shared_from_this());
374 send_signal = update ();
378 StateChanged (BoundsChanged); /* EMIT SIGNAL */
391 if (_follow_overlap) {
392 newlen = _out->first_frame() + _out->length() - _in->first_frame();
398 Invalidated (shared_from_this());
404 if ((_follow_overlap && newlen != _length) || (_length > newlen)) {
406 double factor = newlen / (double) _length;
408 _fade_out.x_scale (factor);
409 _fade_in.x_scale (factor);
414 switch (_anchor_point) {
416 _position = _in->first_frame();
420 _position = _in->last_frame() - _length;
424 _position = _out->last_frame() - _length;
431 Crossfade::compute (boost::shared_ptr<AudioRegion> a, boost::shared_ptr<AudioRegion> b, CrossfadeModel model)
433 boost::shared_ptr<AudioRegion> top;
434 boost::shared_ptr<AudioRegion> bottom;
435 nframes_t short_xfade_length;
437 short_xfade_length = _short_xfade_length;
439 if (a->layer() < b->layer()) {
447 /* first check for matching ends */
449 if (top->first_frame() == bottom->first_frame()) {
451 /* Both regions start at the same point */
453 if (top->last_frame() < bottom->last_frame()) {
455 /* top ends before bottom, so put an xfade
456 in at the end of top.
459 /* [-------- top ---------- ]
460 * {====== bottom =====================}
466 if (top->last_frame() < short_xfade_length) {
469 _position = top->last_frame() - short_xfade_length;
472 _length = min (short_xfade_length, top->length());
473 _follow_overlap = false;
474 _anchor_point = EndOfIn;
479 /* top ends after (or same time) as bottom - no xfade
482 /* [-------- top ------------------------ ]
483 * {====== bottom =====================}
486 throw NoCrossfadeHere();
489 } else if (top->last_frame() == bottom->last_frame()) {
491 /* Both regions end at the same point */
493 if (top->first_frame() > bottom->first_frame()) {
495 /* top starts after bottom, put an xfade in at the
499 /* [-------- top ---------- ]
500 * {====== bottom =====================}
505 _position = top->first_frame();
506 _length = min (short_xfade_length, top->length());
507 _follow_overlap = false;
508 _anchor_point = StartOfIn;
513 /* top starts before bottom - no xfade
516 /* [-------- top ------------------------ ]
517 * {====== bottom =====================}
520 throw NoCrossfadeHere();
525 /* OK, time to do more regular overlapping */
527 OverlapType ot = top->coverage (bottom->first_frame(), bottom->last_frame());
531 /* should be NOTREACHED as a precondition of creating
532 a new crossfade, but we need to handle it here.
534 throw NoCrossfadeHere();
537 case OverlapInternal:
538 case OverlapExternal:
539 /* should be NOTREACHED because of tests above */
540 throw NoCrossfadeHere();
543 case OverlapEnd: /* top covers start of bottom but ends within it */
545 /* [---- top ------------------------]
546 * { ==== bottom ============ }
551 _anchor_point = StartOfIn;
553 if (model == FullCrossfade) {
554 _position = bottom->first_frame(); // "{"
555 _length = _out->first_frame() + _out->length() - _in->first_frame();
556 /* leave active alone */
557 _follow_overlap = true;
559 _length = min (short_xfade_length, top->length());
560 _position = top->last_frame() - _length; // "]" - length
562 _follow_overlap = false;
567 case OverlapStart: /* top starts within bottom but covers bottom's end */
569 /* { ==== top ============ }
570 * [---- bottom -------------------]
575 _position = top->first_frame();
576 _anchor_point = StartOfIn;
578 if (model == FullCrossfade) {
579 _length = _out->first_frame() + _out->length() - _in->first_frame();
580 /* leave active alone */
581 _follow_overlap = true;
583 _length = min (short_xfade_length, top->length());
585 _follow_overlap = false;
597 Crossfade::get_state ()
599 XMLNode* node = new XMLNode (X_("Crossfade"));
602 LocaleGuard lg (X_("POSIX"));
604 _out->id().print (buf, sizeof (buf));
605 node->add_property ("out", buf);
606 _in->id().print (buf, sizeof (buf));
607 node->add_property ("in", buf);
608 node->add_property ("active", (_active ? "yes" : "no"));
609 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
610 node->add_property ("fixed", (_fixed ? "yes" : "no"));
611 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
612 node->add_property ("length", buf);
613 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
614 node->add_property ("anchor-point", buf);
615 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
616 node->add_property ("position", buf);
618 child = node->add_child ("FadeIn");
620 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
623 pnode = new XMLNode ("point");
625 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
626 pnode->add_property ("x", buf);
627 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
628 pnode->add_property ("y", buf);
629 child->add_child_nocopy (*pnode);
632 child = node->add_child ("FadeOut");
634 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
637 pnode = new XMLNode ("point");
639 snprintf (buf, sizeof (buf), "%" PRIu32, (nframes_t) floor ((*ii)->when));
640 pnode->add_property ("x", buf);
641 snprintf (buf, sizeof (buf), "%.12g", (*ii)->value);
642 pnode->add_property ("y", buf);
643 child->add_child_nocopy (*pnode);
650 Crossfade::set_state (const XMLNode& node)
652 XMLNodeConstIterator i;
653 XMLNodeList children;
656 const XMLProperty* prop;
657 LocaleGuard lg (X_("POSIX"));
658 Change what_changed = Change (0);
661 if ((prop = node.property ("position")) != 0) {
662 sscanf (prop->value().c_str(), "%" PRIu32, &val);
663 if (val != _position) {
665 what_changed = Change (what_changed | PositionChanged);
668 warning << _("old-style crossfade information - no position information") << endmsg;
669 _position = _in->first_frame();
672 if ((prop = node.property ("active")) != 0) {
673 bool x = (prop->value() == "yes");
676 what_changed = Change (what_changed | ActiveChanged);
682 if ((prop = node.property ("follow-overlap")) != 0) {
683 _follow_overlap = (prop->value() == "yes");
685 _follow_overlap = false;
688 if ((prop = node.property ("fixed")) != 0) {
689 _fixed = (prop->value() == "yes");
694 if ((prop = node.property ("anchor-point")) != 0) {
695 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
697 _anchor_point = StartOfIn;
700 if ((prop = node.property ("length")) != 0) {
702 sscanf (prop->value().c_str(), "%" PRIu32, &val);
703 if (val != _length) {
704 _length = atol (prop->value().c_str());
705 what_changed = Change (what_changed | LengthChanged);
710 /* XXX this branch is legacy code from before
711 the point where we stored xfade lengths.
714 if ((_length = overlap_length()) == 0) {
715 throw failed_constructor();
719 if ((fi = find_named_node (node, "FadeIn")) == 0) {
723 if ((fo = find_named_node (node, "FadeOut")) == 0) {
732 children = fi->children();
734 for (i = children.begin(); i != children.end(); ++i) {
735 if ((*i)->name() == "point") {
739 prop = (*i)->property ("x");
740 sscanf (prop->value().c_str(), "%" PRIu32, &x);
742 prop = (*i)->property ("y");
743 sscanf (prop->value().c_str(), "%f", &y);
756 children = fo->children();
758 for (i = children.begin(); i != children.end(); ++i) {
759 if ((*i)->name() == "point") {
764 prop = (*i)->property ("x");
765 sscanf (prop->value().c_str(), "%" PRIu32, &x);
767 prop = (*i)->property ("y");
768 sscanf (prop->value().c_str(), "%f", &y);
770 _fade_out.add (x, y);
776 StateChanged (what_changed); /* EMIT SIGNAL */
782 Crossfade::can_follow_overlap () const
788 Crossfade::set_follow_overlap (bool yn)
790 if (yn == _follow_overlap || _fixed) {
794 _follow_overlap = yn;
797 set_length (_short_xfade_length);
799 set_length (_out->first_frame() + _out->length() - _in->first_frame());
802 StateChanged (FollowOverlapChanged);
806 Crossfade::set_length (nframes_t len)
810 switch (_anchor_point) {
812 limit = _in->length();
816 limit = _in->length();
820 limit = _out->length();
825 len = min (limit, len);
827 double factor = len / (double) _length;
830 _fade_out.x_scale (factor);
831 _fade_in.x_scale (factor);
836 StateChanged (LengthChanged);
842 Crossfade::overlap_length () const
847 return _out->first_frame() + _out->length() - _in->first_frame();
851 Crossfade::set_short_xfade_length (nframes_t n)
853 _short_xfade_length = n;
857 Crossfade::invalidate ()
859 Invalidated (shared_from_this()); /* EMIT SIGNAL */