2 Copyright (C) 2000-2006 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_audio_region_h__
21 #define __ardour_audio_region_h__
25 #include <pbd/fastlog.h>
28 #include <ardour/ardour.h>
29 #include <ardour/region.h>
30 #include <ardour/gain.h>
31 #include <ardour/logcurve.h>
32 #include <ardour/export.h>
44 class AudioRegion : public Region
47 static Change FadeInChanged;
48 static Change FadeOutChanged;
49 static Change FadeInActiveChanged;
50 static Change FadeOutActiveChanged;
51 static Change EnvelopeActiveChanged;
52 static Change ScaleAmplitudeChanged;
53 static Change EnvelopeChanged;
57 bool speed_mismatch (float) const;
59 boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
61 void set_scale_amplitude (gain_t);
62 gain_t scale_amplitude() const { return _scale_amplitude; }
64 void normalize_to (float target_in_dB = 0.0f);
66 bool envelope_active () const { return _flags & Region::EnvelopeActive; }
67 bool fade_in_active () const { return _flags & Region::FadeIn; }
68 bool fade_out_active () const { return _flags & Region::FadeOut; }
70 Curve& fade_in() { return _fade_in; }
71 Curve& fade_out() { return _fade_out; }
72 Curve& envelope() { return _envelope; }
74 virtual nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
75 nframes_t offset, nframes_t cnt,
76 uint32_t chan_n=0, double samples_per_unit= 1.0) const;
78 virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf,
79 float *gain_buf, nframes_t position, nframes_t cnt,
80 uint32_t chan_n = 0) const;
82 virtual nframes_t master_read_at (Sample *buf, Sample *mixdown_buf,
84 nframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
86 virtual nframes_t read_raw_internal (Sample*, nframes_t, nframes_t) const;
88 XMLNode& state (bool);
89 int set_state (const XMLNode&);
91 static void set_default_fade (float steepness, nframes_t len);
92 bool fade_in_is_default () const;
93 bool fade_out_is_default () const;
103 void set_fade_in_active (bool yn);
104 void set_fade_in_shape (FadeShape);
105 void set_fade_in_length (nframes_t);
106 void set_fade_in (FadeShape, nframes_t);
108 void set_fade_out_active (bool yn);
109 void set_fade_out_shape (FadeShape);
110 void set_fade_out_length (nframes_t);
111 void set_fade_out (FadeShape, nframes_t);
113 void set_envelope_active (bool yn);
114 void set_default_envelope ();
116 int separate_by_channel (ARDOUR::Session&, vector<boost::shared_ptr<AudioRegion> >&) const;
120 int apply (AudioFilter&);
124 int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
126 /* xfade/fade interactions */
128 void suspend_fade_in ();
129 void suspend_fade_out ();
130 void resume_fade_in ();
131 void resume_fade_out ();
134 friend class RegionFactory;
136 AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length);
137 AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
138 AudioRegion (SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
139 AudioRegion (boost::shared_ptr<const AudioRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
140 AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
141 AudioRegion (SourceList &, const XMLNode&);
145 void set_default_fades ();
146 void set_default_fade_in ();
147 void set_default_fade_out ();
149 void recompute_gain_at_end ();
150 void recompute_gain_at_start ();
152 nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer,
153 float *gain_buffer, nframes_t position, nframes_t cnt,
154 uint32_t chan_n = 0) const;
156 void recompute_at_start ();
157 void recompute_at_end ();
159 void envelope_changed ();
160 void fade_in_changed ();
161 void fade_out_changed ();
162 void source_offset_changed ();
163 void listen_to_my_curves ();
165 mutable Curve _fade_in;
166 FadeShape _fade_in_shape;
167 mutable Curve _fade_out;
168 FadeShape _fade_out_shape;
169 mutable Curve _envelope;
170 gain_t _scale_amplitude;
171 uint32_t _fade_in_disabled;
172 uint32_t _fade_out_disabled;
175 /* default constructor for derived (compound) types */
177 AudioRegion (nframes_t, nframes_t, std::string name);
178 AudioRegion (boost::shared_ptr<const AudioRegion>);
180 int set_live_state (const XMLNode&, Change&, bool send);
182 virtual bool verify_start (nframes_t);
183 virtual bool verify_start_and_length (nframes_t, nframes_t);
184 virtual bool verify_start_mutable (nframes_t&_start);
185 virtual bool verify_length (nframes_t);
186 /*virtual void recompute_at_start () = 0;
187 virtual void recompute_at_end () = 0;*/
190 } /* namespace ARDOUR */
192 /* access from C objects */
195 int region_read_peaks_from_c (void *arg, uint32_t npeaks, uint32_t start, uint32_t length, intptr_t data, uint32_t n_chan, double samples_per_unit);
196 uint32_t region_length_from_c (void *arg);
197 uint32_t sourcefile_length_from_c (void *arg, double);
200 #endif /* __ardour_audio_region_h__ */