2 Copyright (C) 2003 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;
36 //using namespace sigc;
38 jack_nframes_t Crossfade::_short_xfade_length = 0;
39 Change Crossfade::ActiveChanged = ARDOUR::new_change();
41 /* XXX if and when we ever implement parallel processing of the process()
42 callback, these will need to be handled on a per-thread basis.
45 Sample* Crossfade::crossfade_buffer_out = 0;
46 Sample* Crossfade::crossfade_buffer_in = 0;
49 Crossfade::set_buffer_size (jack_nframes_t sz)
51 if (crossfade_buffer_out) {
52 delete [] crossfade_buffer_out;
53 crossfade_buffer_out = 0;
56 if (crossfade_buffer_in) {
57 delete [] crossfade_buffer_in;
58 crossfade_buffer_in = 0;
62 crossfade_buffer_out = new Sample[sz];
63 crossfade_buffer_in = new Sample[sz];
68 Crossfade::operator== (const Crossfade& other)
70 return (_in == other._in) && (_out == other._out);
73 Crossfade::Crossfade (ARDOUR::AudioRegion& in, ARDOUR::AudioRegion& out,
74 jack_nframes_t length,
75 jack_nframes_t position,
77 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
78 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
85 _follow_overlap = false;
92 Crossfade::Crossfade (ARDOUR::AudioRegion& a, ARDOUR::AudioRegion& b, CrossfadeModel model, bool act)
93 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
94 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
99 if (compute (a, b, model)) {
100 throw failed_constructor();
109 Crossfade::Crossfade (const Playlist& playlist, XMLNode& node)
110 : _fade_in (0.0, 2.0, 1.0), // linear (gain coefficient) => -inf..+6dB
111 _fade_out (0.0, 2.0, 1.0) // linear (gain coefficient) => -inf..+6dB
116 LocaleGuard lg (X_("POSIX"));
118 /* we have to find the in/out regions before we can do anything else */
120 if ((prop = node.property ("in")) == 0) {
121 error << _("Crossfade: no \"in\" region in state") << endmsg;
122 throw failed_constructor();
125 sscanf (prop->value().c_str(), "%llu", &id);
127 if ((r = playlist.find_region (id)) == 0) {
128 error << compose (_("Crossfade: no \"in\" region %1 found in playlist %2"), id, playlist.name())
130 throw failed_constructor();
133 if ((_in = dynamic_cast<AudioRegion*> (r)) == 0) {
134 throw failed_constructor();
137 if ((prop = node.property ("out")) == 0) {
138 error << _("Crossfade: no \"out\" region in state") << endmsg;
139 throw failed_constructor();
142 sscanf (prop->value().c_str(), "%llu", &id);
144 if ((r = playlist.find_region (id)) == 0) {
145 error << compose (_("Crossfade: no \"out\" region %1 found in playlist %2"), id, playlist.name())
147 throw failed_constructor();
150 if ((_out = dynamic_cast<AudioRegion*> (r)) == 0) {
151 throw failed_constructor();
157 if (set_state (node)) {
158 throw failed_constructor();
162 Crossfade::~Crossfade ()
164 for (StateMap::iterator i = states.begin(); i != states.end(); ++i) {
170 Crossfade::initialize ()
174 _out->suspend_fade_out ();
175 _in->suspend_fade_in ();
179 _fade_out.add (0.0, 1.0);
180 _fade_out.add ((_length * 0.1), 0.99);
181 _fade_out.add ((_length * 0.2), 0.97);
182 _fade_out.add ((_length * 0.8), 0.03);
183 _fade_out.add ((_length * 0.9), 0.01);
184 _fade_out.add (_length, 0.0);
189 _fade_in.add (0.0, 0.0);
190 _fade_in.add ((_length * 0.1), 0.01);
191 _fade_in.add ((_length * 0.2), 0.03);
192 _fade_in.add ((_length * 0.8), 0.97);
193 _fade_in.add ((_length * 0.9), 0.99);
194 _fade_in.add (_length, 1.0);
197 // _in->StateChanged.connect (slot (*this, &Crossfade::member_changed));
198 // _out->StateChanged.connect (slot (*this, &Crossfade::member_changed));
200 overlap_type = _in->coverage (_out->position(), _out->last_frame());
202 save_state ("initial");
206 Crossfade::compute (AudioRegion& a, AudioRegion& b, CrossfadeModel model)
210 jack_nframes_t short_xfade_length;
212 short_xfade_length = _short_xfade_length;
214 if (a.layer() < b.layer()) {
222 /* first check for matching ends */
224 if (top->first_frame() == bottom->first_frame()) {
226 /* Both regions start at the same point */
228 if (top->last_frame() < bottom->last_frame()) {
230 /* top ends before bottom, so put an xfade
231 in at the end of top.
234 /* [-------- top ---------- ]
235 * {====== bottom =====================}
241 if (top->last_frame() < short_xfade_length) {
244 _position = top->last_frame() - short_xfade_length;
247 _length = min (short_xfade_length, top->length());
248 _follow_overlap = false;
249 _anchor_point = EndOfIn;
254 /* top ends after (or same time) as bottom - no xfade
257 /* [-------- top ------------------------ ]
258 * {====== bottom =====================}
261 throw NoCrossfadeHere();
264 } else if (top->last_frame() == bottom->last_frame()) {
266 /* Both regions end at the same point */
268 if (top->first_frame() > bottom->first_frame()) {
270 /* top starts after bottom, put an xfade in at the
274 /* [-------- top ---------- ]
275 * {====== bottom =====================}
280 _position = top->first_frame();
281 _length = min (short_xfade_length, top->length());
282 _follow_overlap = false;
283 _anchor_point = StartOfIn;
288 /* top starts before bottom - no xfade
291 /* [-------- top ------------------------ ]
292 * {====== bottom =====================}
295 throw NoCrossfadeHere();
300 /* OK, time to do more regular overlapping */
302 OverlapType ot = top->coverage (bottom->first_frame(), bottom->last_frame());
306 /* should be NOTREACHED as a precondition of creating
307 a new crossfade, but we need to handle it here.
309 throw NoCrossfadeHere();
312 case OverlapInternal:
313 case OverlapExternal:
314 /* should be NOTREACHED because of tests above */
315 throw NoCrossfadeHere();
318 case OverlapEnd: /* top covers start of bottom but ends within it */
320 /* [---- top ------------------------]
321 * { ==== bottom ============ }
326 _position = bottom->first_frame();
327 _anchor_point = StartOfIn;
329 if (model == FullCrossfade) {
330 _length = _out->first_frame() + _out->length() - _in->first_frame();
331 /* leave active alone */
332 _follow_overlap = true;
334 _length = min (short_xfade_length, top->length());
336 _follow_overlap = false;
341 case OverlapStart: /* top starts within bottom but covers bottom's end */
343 /* { ==== top ============ }
344 * [---- bottom -------------------]
349 _position = top->first_frame();
350 _anchor_point = StartOfIn;
352 if (model == FullCrossfade) {
353 _length = _out->first_frame() + _out->length() - _in->first_frame();
354 /* leave active alone */
355 _follow_overlap = true;
357 _length = min (short_xfade_length, top->length());
359 _follow_overlap = false;
371 Crossfade::read_at (Sample *buf, Sample *mixdown_buffer,
372 float *gain_buffer, jack_nframes_t start, jack_nframes_t cnt, uint32_t chan_n,
373 jack_nframes_t read_frames, jack_nframes_t skip_frames)
375 jack_nframes_t offset;
376 jack_nframes_t to_write;
382 if (start < _position) {
384 /* handle an initial section of the read area that we do not
388 offset = _position - start;
398 to_write = min (_length, cnt);
402 to_write = min (_length - (start - _position), cnt);
406 offset = start - _position;
408 _out->read_at (crossfade_buffer_out, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
409 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, start, to_write, chan_n, read_frames, skip_frames);
411 float* fiv = new float[to_write];
412 float* fov = new float[to_write];
414 _fade_in.get_vector (offset, offset+to_write, fiv, to_write);
415 _fade_out.get_vector (offset, offset+to_write, fov, to_write);
417 /* note: although we have not explicitly taken into account the return values
418 from _out->read_at() or _in->read_at(), the length() function does this
419 implicitly. why? because it computes a value based on the in+out regions'
420 position and length, and so we know precisely how much data they could return.
423 for (jack_nframes_t n = 0; n < to_write; ++n) {
424 buf[n] = (crossfade_buffer_out[n] * fov[n]) + (crossfade_buffer_in[n] * fiv[n]);
434 Crossfade::coverage (jack_nframes_t start, jack_nframes_t end) const
436 jack_nframes_t my_end = _position + _length;
438 if ((start >= _position) && (end <= my_end)) {
439 return OverlapInternal;
441 if ((end >= _position) && (end <= my_end)) {
444 if ((start >= _position) && (start <= my_end)) {
447 if ((_position >= start) && (_position <= end) && (my_end <= end)) {
448 return OverlapExternal;
454 Crossfade::set_active (bool yn)
458 save_state (_("active changed"));
459 send_state_changed (ActiveChanged);
464 Crossfade::refresh ()
466 /* crossfades must be between non-muted regions */
468 if (_out->muted() || _in->muted()) {
473 /* overlap type must be Start, End or External */
477 ot = _in->coverage (_out->first_frame(), _out->last_frame());
481 case OverlapInternal:
489 /* overlap type must not have altered */
491 if (ot != overlap_type) {
498 return update (false);
502 Crossfade::update (bool force)
504 jack_nframes_t newlen;
507 if (_follow_overlap) {
508 newlen = _out->first_frame() + _out->length() - _in->first_frame();
520 if (force || (_follow_overlap && newlen != _length) || (_length > newlen)) {
522 double factor = newlen / (double) _length;
524 _fade_out.x_scale (factor);
525 _fade_in.x_scale (factor);
533 switch (_anchor_point) {
535 if (_position != _in->first_frame()) {
536 _position = _in->first_frame();
542 if (_position != _in->last_frame() - _length) {
543 _position = _in->last_frame() - _length;
549 if (_position != _out->last_frame() - _length) {
550 _position = _out->last_frame() - _length;
556 save_state ("updated");
559 /* UI's may need to know that the overlap changed even
560 though the xfade length did not.
563 send_state_changed (BoundsChanged); /* EMIT SIGNAL */
571 Crossfade::member_changed (Change what_changed)
573 Change what_we_care_about = Change (Region::MuteChanged|
574 Region::LayerChanged|
575 ARDOUR::BoundsChanged);
577 if (what_changed & what_we_care_about) {
583 Crossfade::restore_state (StateManager::State& state)
585 CrossfadeState* xfstate = dynamic_cast<CrossfadeState*> (&state);
586 Change what_changed = Change (0);
590 xfstate->fade_in_memento ();
591 xfstate->fade_out_memento ();
593 if (_length != xfstate->length) {
594 what_changed = Change (what_changed|LengthChanged);
595 _length = xfstate->length;
597 if (_active != xfstate->active) {
598 what_changed = Change (what_changed|ActiveChanged);
599 _active = xfstate->active;
601 if (_position != xfstate->position) {
602 what_changed = Change (what_changed|PositionChanged);
603 _position = xfstate->position;
606 /* XXX what to do about notifications for these? I don't
607 think (G)UI cares about them because they are
608 implicit in the bounds.
611 _follow_overlap = xfstate->follow_overlap;
612 _anchor_point = xfstate->anchor_point;
616 return Change (what_changed);
620 Crossfade::state_factory (std::string why) const
622 CrossfadeState* state = new CrossfadeState (why);
624 state->fade_in_memento = _fade_in.get_memento ();
625 state->fade_out_memento = _fade_out.get_memento ();
626 state->active = _active;
627 state->length = _length;
628 state->position = _position;
629 state->follow_overlap = _follow_overlap;
630 state->anchor_point = _anchor_point;
636 Crossfade::get_memento() const
638 return sigc::bind (mem_fun (*(const_cast<Crossfade *> (this)), &StateManager::use_state), _current_state_id);
642 Crossfade::get_state ()
644 XMLNode* node = new XMLNode (X_("Crossfade"));
647 LocaleGuard lg (X_("POSIX"));
649 snprintf (buf, sizeof(buf), "%" PRIu64, _out->id());
650 node->add_property ("out", buf);
651 snprintf (buf, sizeof(buf), "%" PRIu64, _in->id());
652 node->add_property ("in", buf);
653 node->add_property ("active", (_active ? "yes" : "no"));
654 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
655 node->add_property ("fixed", (_fixed ? "yes" : "no"));
656 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
657 node->add_property ("length", buf);
658 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
659 node->add_property ("anchor-point", buf);
660 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
661 node->add_property ("position", buf);
663 child = node->add_child ("FadeIn");
665 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
668 pnode = new XMLNode ("point");
670 snprintf (buf, sizeof (buf), "%" PRIu32, (jack_nframes_t) floor ((*ii)->when));
671 pnode->add_property ("x", buf);
672 snprintf (buf, sizeof (buf), "%f", (*ii)->value);
673 pnode->add_property ("y", buf);
674 child->add_child_nocopy (*pnode);
677 child = node->add_child ("FadeOut");
679 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
682 pnode = new XMLNode ("point");
684 snprintf (buf, sizeof (buf), "%" PRIu32, (jack_nframes_t) floor ((*ii)->when));
685 pnode->add_property ("x", buf);
686 snprintf (buf, sizeof (buf), "%f", (*ii)->value);
687 pnode->add_property ("y", buf);
688 child->add_child_nocopy (*pnode);
695 Crossfade::set_state (const XMLNode& node)
697 XMLNodeConstIterator i;
698 XMLNodeList children;
701 const XMLProperty* prop;
702 LocaleGuard lg (X_("POSIX"));
704 if ((prop = node.property ("position")) != 0) {
705 _position = atoi (prop->value().c_str());
707 warning << _("old-style crossfade information - no position information") << endmsg;
708 _position = _in->first_frame();
711 if ((prop = node.property ("active")) != 0) {
712 _active = (prop->value() == "yes");
717 if ((prop = node.property ("follow-overlap")) != 0) {
718 _follow_overlap = (prop->value() == "yes");
720 _follow_overlap = false;
723 if ((prop = node.property ("fixed")) != 0) {
724 _fixed = (prop->value() == "yes");
729 if ((prop = node.property ("anchor-point")) != 0) {
730 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
732 _anchor_point = StartOfIn;
735 if ((prop = node.property ("length")) != 0) {
737 _length = atol (prop->value().c_str());
741 /* XXX this branch is legacy code from before
742 the point where we stored xfade lengths.
745 if ((_length = overlap_length()) == 0) {
746 throw failed_constructor();
750 if ((fi = find_named_node (node, "FadeIn")) == 0) {
754 if ((fo = find_named_node (node, "FadeOut")) == 0) {
762 children = fi->children();
764 for (i = children.begin(); i != children.end(); ++i) {
765 if ((*i)->name() == "point") {
769 prop = (*i)->property ("x");
770 sscanf (prop->value().c_str(), "%" PRIu32, &x);
772 prop = (*i)->property ("y");
773 sscanf (prop->value().c_str(), "%f", &y);
783 children = fo->children();
785 for (i = children.begin(); i != children.end(); ++i) {
786 if ((*i)->name() == "point") {
791 prop = (*i)->property ("x");
792 sscanf (prop->value().c_str(), "%" PRIu32, &x);
794 prop = (*i)->property ("y");
795 sscanf (prop->value().c_str(), "%f", &y);
797 _fade_out.add (x, y);
805 Crossfade::can_follow_overlap () const
811 Crossfade::set_follow_overlap (bool yn)
813 if (yn == _follow_overlap || _fixed) {
817 _follow_overlap = yn;
820 set_length (_short_xfade_length);
822 set_length (_out->first_frame() + _out->length() - _in->first_frame());
827 Crossfade::set_length (jack_nframes_t len)
829 jack_nframes_t limit;
831 switch (_anchor_point) {
833 limit = _in->length();
837 limit = _in->length();
841 limit = _out->length();
846 len = min (limit, len);
848 double factor = len / (double) _length;
851 _fade_out.x_scale (factor);
852 _fade_in.x_scale (factor);
857 save_state ("length changed");
859 send_state_changed (LengthChanged);
865 Crossfade::overlap_length () const
870 return _out->first_frame() + _out->length() - _in->first_frame();
874 Crossfade::set_short_xfade_length (jack_nframes_t n)
876 _short_xfade_length = n;