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;
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(), "%" PRIu64, &id);
127 if ((r = playlist.find_region (id)) == 0) {
128 error << string_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(), "%" PRIu64, &id);
144 if ((r = playlist.find_region (id)) == 0) {
145 error << string_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();
161 save_state ("initial");
164 Crossfade::Crossfade (const Crossfade &orig, ARDOUR::AudioRegion *newin, ARDOUR::AudioRegion *newout)
165 : _fade_in(orig._fade_in),
166 _fade_out(orig._fade_out)
168 _active = orig._active;
169 _in_update = orig._in_update;
170 _length = orig._length;
171 _position = orig._position;
172 _anchor_point = orig._anchor_point;
173 _follow_overlap = orig._follow_overlap;
174 _fixed = orig._fixed;
175 _follow_overlap = orig._follow_overlap;
176 _short_xfade_length = orig._short_xfade_length;
181 // copied from Crossfade::initialize()
184 _out->suspend_fade_out ();
185 _in->suspend_fade_in ();
187 overlap_type = _in->coverage (_out->position(), _out->last_frame());
189 // Let's make sure the fade isn't too long
194 Crossfade::~Crossfade ()
196 for (StateMap::iterator i = states.begin(); i != states.end(); ++i) {
202 Crossfade::initialize (bool savestate)
206 _out->suspend_fade_out ();
207 _in->suspend_fade_in ();
211 _fade_out.add (0.0, 1.0);
212 _fade_out.add ((_length * 0.1), 0.99);
213 _fade_out.add ((_length * 0.2), 0.97);
214 _fade_out.add ((_length * 0.8), 0.03);
215 _fade_out.add ((_length * 0.9), 0.01);
216 _fade_out.add (_length, 0.0);
221 _fade_in.add (0.0, 0.0);
222 _fade_in.add ((_length * 0.1), 0.01);
223 _fade_in.add ((_length * 0.2), 0.03);
224 _fade_in.add ((_length * 0.8), 0.97);
225 _fade_in.add ((_length * 0.9), 0.99);
226 _fade_in.add (_length, 1.0);
229 // _in->StateChanged.connect (slot (*this, &Crossfade::member_changed));
230 // _out->StateChanged.connect (slot (*this, &Crossfade::member_changed));
232 overlap_type = _in->coverage (_out->position(), _out->last_frame());
235 save_state ("initial");
240 Crossfade::compute (AudioRegion& a, AudioRegion& b, CrossfadeModel model)
244 jack_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, char * workbuf, jack_nframes_t start, jack_nframes_t cnt, uint32_t chan_n,
407 jack_nframes_t read_frames, jack_nframes_t skip_frames)
409 jack_nframes_t offset;
410 jack_nframes_t to_write;
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, workbuf, start, to_write, chan_n, read_frames, skip_frames);
443 _in->read_at (crossfade_buffer_in, mixdown_buffer, gain_buffer, workbuf, 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 (jack_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 (jack_nframes_t start, jack_nframes_t end) const
470 jack_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 save_state (_("active changed"));
493 send_state_changed (ActiveChanged);
498 Crossfade::refresh ()
500 /* crossfades must be between non-muted regions */
502 if (_out->muted() || _in->muted()) {
507 /* overlap type must be Start, End or External */
511 ot = _in->coverage (_out->first_frame(), _out->last_frame());
515 case OverlapInternal:
523 /* overlap type must not have altered */
525 if (ot != overlap_type) {
532 return update (false);
536 Crossfade::update (bool force)
538 jack_nframes_t newlen;
541 if (_follow_overlap) {
542 newlen = _out->first_frame() + _out->length() - _in->first_frame();
554 if (force || (_follow_overlap && newlen != _length) || (_length > newlen)) {
556 double factor = newlen / (double) _length;
558 _fade_out.x_scale (factor);
559 _fade_in.x_scale (factor);
567 switch (_anchor_point) {
569 if (_position != _in->first_frame()) {
570 _position = _in->first_frame();
576 if (_position != _in->last_frame() - _length) {
577 _position = _in->last_frame() - _length;
583 if (_position != _out->last_frame() - _length) {
584 _position = _out->last_frame() - _length;
590 save_state ("updated");
593 /* UI's may need to know that the overlap changed even
594 though the xfade length did not.
597 send_state_changed (BoundsChanged); /* EMIT SIGNAL */
605 Crossfade::member_changed (Change what_changed)
607 Change what_we_care_about = Change (Region::MuteChanged|
608 Region::LayerChanged|
609 ARDOUR::BoundsChanged);
611 if (what_changed & what_we_care_about) {
617 Crossfade::restore_state (StateManager::State& state)
619 CrossfadeState* xfstate = dynamic_cast<CrossfadeState*> (&state);
620 Change what_changed = Change (0);
624 xfstate->fade_in_memento ();
625 xfstate->fade_out_memento ();
627 if (_length != xfstate->length) {
628 what_changed = Change (what_changed|LengthChanged);
629 _length = xfstate->length;
631 if (_active != xfstate->active) {
632 what_changed = Change (what_changed|ActiveChanged);
633 _active = xfstate->active;
635 if (_position != xfstate->position) {
636 what_changed = Change (what_changed|PositionChanged);
637 _position = xfstate->position;
640 /* XXX what to do about notifications for these? I don't
641 think (G)UI cares about them because they are
642 implicit in the bounds.
645 _follow_overlap = xfstate->follow_overlap;
646 _anchor_point = xfstate->anchor_point;
650 return Change (what_changed);
654 Crossfade::state_factory (std::string why) const
656 CrossfadeState* state = new CrossfadeState (why);
658 state->fade_in_memento = _fade_in.get_memento ();
659 state->fade_out_memento = _fade_out.get_memento ();
660 state->active = _active;
661 state->length = _length;
662 state->position = _position;
663 state->follow_overlap = _follow_overlap;
664 state->anchor_point = _anchor_point;
670 Crossfade::get_memento() const
672 return sigc::bind (mem_fun (*(const_cast<Crossfade *> (this)), &StateManager::use_state), _current_state_id);
676 Crossfade::get_state ()
678 XMLNode* node = new XMLNode (X_("Crossfade"));
681 LocaleGuard lg (X_("POSIX"));
683 snprintf (buf, sizeof(buf), "%" PRIu64, _out->id());
684 node->add_property ("out", buf);
685 snprintf (buf, sizeof(buf), "%" PRIu64, _in->id());
686 node->add_property ("in", buf);
687 node->add_property ("active", (_active ? "yes" : "no"));
688 node->add_property ("follow-overlap", (_follow_overlap ? "yes" : "no"));
689 node->add_property ("fixed", (_fixed ? "yes" : "no"));
690 snprintf (buf, sizeof(buf), "%" PRIu32, _length);
691 node->add_property ("length", buf);
692 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _anchor_point);
693 node->add_property ("anchor-point", buf);
694 snprintf (buf, sizeof(buf), "%" PRIu32, (uint32_t) _position);
695 node->add_property ("position", buf);
697 child = node->add_child ("FadeIn");
699 for (AutomationList::iterator ii = _fade_in.begin(); ii != _fade_in.end(); ++ii) {
702 pnode = new XMLNode ("point");
704 snprintf (buf, sizeof (buf), "%" PRIu32, (jack_nframes_t) floor ((*ii)->when));
705 pnode->add_property ("x", buf);
706 snprintf (buf, sizeof (buf), "%f", (*ii)->value);
707 pnode->add_property ("y", buf);
708 child->add_child_nocopy (*pnode);
711 child = node->add_child ("FadeOut");
713 for (AutomationList::iterator ii = _fade_out.begin(); ii != _fade_out.end(); ++ii) {
716 pnode = new XMLNode ("point");
718 snprintf (buf, sizeof (buf), "%" PRIu32, (jack_nframes_t) floor ((*ii)->when));
719 pnode->add_property ("x", buf);
720 snprintf (buf, sizeof (buf), "%f", (*ii)->value);
721 pnode->add_property ("y", buf);
722 child->add_child_nocopy (*pnode);
729 Crossfade::set_state (const XMLNode& node)
731 XMLNodeConstIterator i;
732 XMLNodeList children;
735 const XMLProperty* prop;
736 LocaleGuard lg (X_("POSIX"));
738 if ((prop = node.property ("position")) != 0) {
739 _position = atoi (prop->value().c_str());
741 warning << _("old-style crossfade information - no position information") << endmsg;
742 _position = _in->first_frame();
745 if ((prop = node.property ("active")) != 0) {
746 _active = (prop->value() == "yes");
751 if ((prop = node.property ("follow-overlap")) != 0) {
752 _follow_overlap = (prop->value() == "yes");
754 _follow_overlap = false;
757 if ((prop = node.property ("fixed")) != 0) {
758 _fixed = (prop->value() == "yes");
763 if ((prop = node.property ("anchor-point")) != 0) {
764 _anchor_point = AnchorPoint (atoi ((prop->value().c_str())));
766 _anchor_point = StartOfIn;
769 if ((prop = node.property ("length")) != 0) {
771 _length = atol (prop->value().c_str());
775 /* XXX this branch is legacy code from before
776 the point where we stored xfade lengths.
779 if ((_length = overlap_length()) == 0) {
780 throw failed_constructor();
784 if ((fi = find_named_node (node, "FadeIn")) == 0) {
788 if ((fo = find_named_node (node, "FadeOut")) == 0) {
796 children = fi->children();
798 for (i = children.begin(); i != children.end(); ++i) {
799 if ((*i)->name() == "point") {
803 prop = (*i)->property ("x");
804 sscanf (prop->value().c_str(), "%" PRIu32, &x);
806 prop = (*i)->property ("y");
807 sscanf (prop->value().c_str(), "%f", &y);
817 children = fo->children();
819 for (i = children.begin(); i != children.end(); ++i) {
820 if ((*i)->name() == "point") {
825 prop = (*i)->property ("x");
826 sscanf (prop->value().c_str(), "%" PRIu32, &x);
828 prop = (*i)->property ("y");
829 sscanf (prop->value().c_str(), "%f", &y);
831 _fade_out.add (x, y);
839 Crossfade::can_follow_overlap () const
845 Crossfade::set_follow_overlap (bool yn)
847 if (yn == _follow_overlap || _fixed) {
851 _follow_overlap = yn;
854 set_length (_short_xfade_length);
856 set_length (_out->first_frame() + _out->length() - _in->first_frame());
861 Crossfade::set_length (jack_nframes_t len)
863 jack_nframes_t limit;
865 switch (_anchor_point) {
867 limit = _in->length();
871 limit = _in->length();
875 limit = _out->length();
880 len = min (limit, len);
882 double factor = len / (double) _length;
885 _fade_out.x_scale (factor);
886 _fade_in.x_scale (factor);
891 save_state ("length changed");
893 send_state_changed (LengthChanged);
899 Crossfade::overlap_length () const
904 return _out->first_frame() + _out->length() - _in->first_frame();
908 Crossfade::set_short_xfade_length (jack_nframes_t n)
910 _short_xfade_length = n;