summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/crossfade.h
blob: 1c7075eb7dfc690d765ae82a9e42c5197944824d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/*
    Copyright (C) 2000 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_overlap_h__
#define __ardour_overlap_h__

#include <vector>
#include <algorithm>
#include <boost/shared_ptr.hpp>


#include "pbd/undo.h"
#include "pbd/statefuldestructible.h"

#include "ardour/ardour.h"
#include "ardour/audioregion.h"
#include "evoral/Curve.hpp"

namespace ARDOUR {
	namespace Properties {
		/* "active" is defined elsewhere but we use it with crossfade also */
		extern PBD::PropertyDescriptor<bool> active;
		extern PBD::PropertyDescriptor<bool> follow_overlap;
	}

enum AnchorPoint {
	StartOfIn,
	EndOfIn,
	EndOfOut
};

class Playlist;

class Crossfade : public ARDOUR::AudioRegion
{
  public:

	class NoCrossfadeHere: std::exception {
	public:
		virtual const char *what() const throw() { return "no crossfade should be constructed here"; }
	};

	/* constructor for "fixed" xfades at each end of an internal overlap */

	Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out,
		   framecnt_t initial_length,
		   AnchorPoint);

	/* constructor for xfade between two regions that are overlapped in any way
	   except the "internal" case.
	*/

	Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out, CrossfadeModel, bool active);


	/* copy constructor to copy a crossfade with new regions. used (for example)
	   when a playlist copy is made
	*/
	Crossfade (boost::shared_ptr<Crossfade>, boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>);

	/* the usual XML constructor */

	Crossfade (const Playlist&, XMLNode const &);
	virtual ~Crossfade();

	static void make_property_quarks ();

	XMLNode& get_state (void);
	int set_state (const XMLNode&, int version);

	boost::shared_ptr<ARDOUR::AudioRegion> in() const { return _in; }
	boost::shared_ptr<ARDOUR::AudioRegion> out() const { return _out; }

	framecnt_t read_at (Sample *buf, Sample *mixdown_buffer,
			    float *gain_buffer, framepos_t position, framecnt_t cnt,
			    uint32_t chan_n) const;

	bool refresh ();

	uint32_t upper_layer () const {
		return std::max (_in->layer(), _out->layer());
	}

	uint32_t lower_layer () const {
		return std::min (_in->layer(), _out->layer());
	}

	bool involves (boost::shared_ptr<ARDOUR::AudioRegion> region) const {
		return _in == region || _out == region;
	}

	bool involves (boost::shared_ptr<ARDOUR::AudioRegion> a, boost::shared_ptr<ARDOUR::AudioRegion> b) const {
		return (_in == a && _out == b) || (_in == b && _out == a);
	}

	framecnt_t overlap_length() const;

	PBD::Signal1<void,boost::shared_ptr<Region> > Invalidated;

	OverlapType coverage (framepos_t start, framepos_t end) const;

	static void set_buffer_size (framecnt_t);

	bool active () const { return _active; }
	void set_active (bool yn);

	bool following_overlap() const { return _follow_overlap; }
	bool can_follow_overlap() const;
	void set_follow_overlap (bool yn);

	AutomationList& fade_in() { return _fade_in; }
	AutomationList& fade_out() { return _fade_out; }

	framecnt_t set_xfade_length (framecnt_t);

	bool is_dependent() const { return true; }
	bool depends_on (boost::shared_ptr<Region> other) const {
		return other == _in || other == _out;
	}

	static framecnt_t short_xfade_length() { return _short_xfade_length; }
	static void set_short_xfade_length (framecnt_t n);

	/** emitted when the actual fade curves change, as opposed to one of the Stateful properties */
	PBD::Signal0<void> FadesChanged;

  private:
	friend struct CrossfadeComparePtr;
	friend class AudioPlaylist;

	static framecnt_t _short_xfade_length;

	boost::shared_ptr<ARDOUR::AudioRegion> _in;
	boost::shared_ptr<ARDOUR::AudioRegion> _out;
	PBD::Property<bool>  _active;
	PBD::Property<bool>  _follow_overlap;
	bool                 _in_update;
	OverlapType           overlap_type;
	AnchorPoint          _anchor_point;
	bool                 _fixed;
	int32_t               layer_relation;


	mutable AutomationList _fade_in;
	mutable AutomationList _fade_out;

	static Sample* crossfade_buffer_out;
	static Sample* crossfade_buffer_in;

	void initialize ();
	void register_properties ();
	int  compute (boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>, CrossfadeModel);
	bool update ();

	bool operator== (const ARDOUR::Crossfade&);

  protected:
	framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int) const;
};


} // namespace ARDOUR

#endif /* __ardour_overlap_h__ */