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.
21 #ifndef __ardour_overlap_h__
22 #define __ardour_overlap_h__
26 #include <boost/shared_ptr.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/state_manager.h>
37 #include <ardour/crossfade_compare.h>
44 struct CrossfadeState : public StateManager::State {
45 CrossfadeState (std::string reason) : StateManager::State (reason) {}
47 UndoAction fade_in_memento;
48 UndoAction fade_out_memento;
49 jack_nframes_t position;
50 jack_nframes_t length;
51 AnchorPoint anchor_point;
56 class Crossfade : public PBD::StatefulDestructible, public StateManager
60 class NoCrossfadeHere: std::exception {
62 virtual const char *what() const throw() { return "no crossfade should be constructed here"; }
65 /* constructor for "fixed" xfades at each end of an internal overlap */
67 Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out,
68 jack_nframes_t position,
69 jack_nframes_t initial_length,
72 /* constructor for xfade between two regions that are overlapped in any way
73 except the "internal" case.
76 Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out, CrossfadeModel, bool active);
79 /* copy constructor to copy a crossfade with new regions. used (for example)
80 when a playlist copy is made */
81 Crossfade (const Crossfade &, boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>);
83 /* the usual XML constructor */
85 Crossfade (const ARDOUR::Playlist&, XMLNode&);
88 bool operator== (const ARDOUR::Crossfade&);
90 XMLNode& get_state (void);
91 int set_state (const XMLNode&);
93 boost::shared_ptr<ARDOUR::AudioRegion> in() const { return _in; }
94 boost::shared_ptr<ARDOUR::AudioRegion> out() const { return _out; }
96 jack_nframes_t read_at (Sample *buf, Sample *mixdown_buffer,
97 float *gain_buffer, jack_nframes_t position, jack_nframes_t cnt,
99 jack_nframes_t read_frames = 0,
100 jack_nframes_t skip_frames = 0);
104 uint32_t upper_layer () const {
105 return std::max (_in->layer(), _out->layer());
108 uint32_t lower_layer () const {
109 return std::min (_in->layer(), _out->layer());
112 bool involves (boost::shared_ptr<ARDOUR::AudioRegion> region) const {
113 return _in == region || _out == region;
116 bool involves (boost::shared_ptr<ARDOUR::AudioRegion> a, boost::shared_ptr<ARDOUR::AudioRegion> b) const {
117 return (_in == a && _out == b) || (_in == b && _out == a);
120 jack_nframes_t length() const { return _length; }
121 jack_nframes_t overlap_length() const;
122 jack_nframes_t position() const { return _position; }
124 sigc::signal<void,Crossfade*> Invalidated;
126 bool covers (jack_nframes_t frame) const {
127 return _position <= frame && frame < _position + _length;
130 OverlapType coverage (jack_nframes_t start, jack_nframes_t end) const;
132 UndoAction get_memento() const;
134 static void set_buffer_size (jack_nframes_t);
136 bool active () const { return _active; }
137 void set_active (bool yn);
139 bool following_overlap() const { return _follow_overlap; }
140 bool can_follow_overlap() const;
141 void set_follow_overlap (bool yn);
143 Curve& fade_in() { return _fade_in; }
144 Curve& fade_out() { return _fade_out; }
146 jack_nframes_t set_length (jack_nframes_t);
148 static jack_nframes_t short_xfade_length() { return _short_xfade_length; }
149 static void set_short_xfade_length (jack_nframes_t n);
151 static Change ActiveChanged;
154 friend struct CrossfadeComparePtr;
155 friend class AudioPlaylist;
157 static jack_nframes_t _short_xfade_length;
159 boost::shared_ptr<ARDOUR::AudioRegion> _in;
160 boost::shared_ptr<ARDOUR::AudioRegion> _out;
163 OverlapType overlap_type;
164 jack_nframes_t _length;
165 jack_nframes_t _position;
166 AnchorPoint _anchor_point;
167 bool _follow_overlap;
172 static Sample* crossfade_buffer_out;
173 static Sample* crossfade_buffer_in;
175 void initialize (bool savestate=true);
176 int compute (boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>, CrossfadeModel);
177 bool update (bool force);
179 StateManager::State* state_factory (std::string why) const;
180 Change restore_state (StateManager::State&);
182 void member_changed (ARDOUR::Change);
187 } // namespace ARDOUR
189 #endif /* __ardour_overlap_h__ */