2 Copyright (C) 2000 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 #ifndef __ardour_overlap_h__
21 #define __ardour_overlap_h__
25 #include <boost/shared_ptr.hpp>
26 #include <boost/enable_shared_from_this.hpp>
28 #include <sigc++/signal.h>
31 #include <pbd/statefuldestructible.h>
33 #include <ardour/ardour.h>
34 #include <ardour/curve.h>
35 #include <ardour/audioregion.h>
36 #include <ardour/crossfade_compare.h>
43 class Crossfade : public PBD::StatefulDestructible, public boost::enable_shared_from_this<ARDOUR::Crossfade>
47 class NoCrossfadeHere: std::exception {
49 virtual const char *what() const throw() { return "no crossfade should be constructed here"; }
52 /* constructor for "fixed" xfades at each end of an internal overlap */
54 Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out,
56 nframes_t initial_length,
59 /* constructor for xfade between two regions that are overlapped in any way
60 except the "internal" case.
63 Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out, CrossfadeModel, bool active);
66 /* copy constructor to copy a crossfade with new regions. used (for example)
67 when a playlist copy is made
69 Crossfade (const Crossfade &, boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>);
71 /* the usual XML constructor */
73 Crossfade (const Playlist&, XMLNode&);
76 bool operator== (const ARDOUR::Crossfade&);
78 XMLNode& get_state (void);
79 int set_state (const XMLNode&);
81 boost::shared_ptr<ARDOUR::AudioRegion> in() const { return _in; }
82 boost::shared_ptr<ARDOUR::AudioRegion> out() const { return _out; }
84 nframes_t read_at (Sample *buf, Sample *mixdown_buffer,
85 float *gain_buffer, nframes_t position, nframes_t cnt,
87 nframes_t read_frames = 0,
88 nframes_t skip_frames = 0);
92 uint32_t upper_layer () const {
93 return std::max (_in->layer(), _out->layer());
96 uint32_t lower_layer () const {
97 return std::min (_in->layer(), _out->layer());
100 bool involves (boost::shared_ptr<ARDOUR::AudioRegion> region) const {
101 return _in == region || _out == region;
104 bool involves (boost::shared_ptr<ARDOUR::AudioRegion> a, boost::shared_ptr<ARDOUR::AudioRegion> b) const {
105 return (_in == a && _out == b) || (_in == b && _out == a);
108 nframes_t length() const { return _length; }
109 nframes_t overlap_length() const;
110 nframes_t position() const { return _position; }
114 sigc::signal<void,boost::shared_ptr<Crossfade> > Invalidated;
115 sigc::signal<void,Change> StateChanged;
117 bool covers (nframes_t frame) const {
118 return _position <= frame && frame < _position + _length;
121 OverlapType coverage (nframes_t start, nframes_t end) const;
123 static void set_buffer_size (nframes_t);
125 bool active () const { return _active; }
126 void set_active (bool yn);
128 bool following_overlap() const { return _follow_overlap; }
129 bool can_follow_overlap() const;
130 void set_follow_overlap (bool yn);
132 Curve& fade_in() { return _fade_in; }
133 Curve& fade_out() { return _fade_out; }
135 nframes_t set_length (nframes_t);
137 static nframes_t short_xfade_length() { return _short_xfade_length; }
138 static void set_short_xfade_length (nframes_t n);
140 static Change ActiveChanged;
141 static Change FollowOverlapChanged;
144 friend struct CrossfadeComparePtr;
145 friend class AudioPlaylist;
147 static nframes_t _short_xfade_length;
149 boost::shared_ptr<ARDOUR::AudioRegion> _in;
150 boost::shared_ptr<ARDOUR::AudioRegion> _out;
153 OverlapType overlap_type;
156 AnchorPoint _anchor_point;
157 bool _follow_overlap;
159 int32_t layer_relation;
163 static Sample* crossfade_buffer_out;
164 static Sample* crossfade_buffer_in;
167 int compute (boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>, CrossfadeModel);
172 } // namespace ARDOUR
174 #endif /* __ardour_overlap_h__ */