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__
26 #include <pbd/fastlog.h>
29 #include <ardour/ardour.h>
30 #include <ardour/automatable_controls.h>
31 #include <ardour/gain.h>
32 #include <ardour/logcurve.h>
33 #include <ardour/region.h>
47 class AudioRegion : public Region
50 static Change FadeInChanged;
51 static Change FadeOutChanged;
52 static Change FadeInActiveChanged;
53 static Change FadeOutActiveChanged;
54 static Change EnvelopeActiveChanged;
55 static Change ScaleAmplitudeChanged;
56 static Change EnvelopeChanged;
60 void copy_settings (boost::shared_ptr<const AudioRegion>);
62 bool source_equivalent (boost::shared_ptr<const Region>) const;
64 bool speed_mismatch (float) const;
66 boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
68 void set_scale_amplitude (gain_t);
69 gain_t scale_amplitude() const { return _scale_amplitude; }
71 void normalize_to (float target_in_dB = 0.0f);
73 bool envelope_active () const { return _flags & Region::EnvelopeActive; }
74 bool fade_in_active () const { return _flags & Region::FadeIn; }
75 bool fade_out_active () const { return _flags & Region::FadeOut; }
77 boost::shared_ptr<AutomationList> fade_in() { return _fade_in; }
78 boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
79 boost::shared_ptr<AutomationList> envelope() { return _envelope; }
81 virtual nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
82 nframes_t offset, nframes_t cnt,
83 uint32_t chan_n=0, double samples_per_unit= 1.0) const;
85 /* Readable interface */
89 ReadOpsOwnAutomation = 0x1,
90 ReadOpsOwnScaling = 0x2,
95 virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const;
96 virtual nframes64_t read_with_ops (Sample*, nframes64_t pos, nframes64_t cnt, int channel, ReadOps rops) const;
97 virtual nframes64_t readable_length() const { return length(); }
99 virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf,
100 float *gain_buf, nframes_t position, nframes_t cnt,
102 nframes_t read_frames = 0,
103 nframes_t skip_frames = 0) const;
105 virtual nframes_t master_read_at (Sample *buf, Sample *mixdown_buf,
107 nframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
109 virtual nframes_t read_raw_internal (Sample*, nframes_t, nframes_t) const;
111 XMLNode& state (bool);
112 int set_state (const XMLNode&);
114 static void set_default_fade (float steepness, nframes_t len);
115 bool fade_in_is_default () const;
116 bool fade_out_is_default () const;
126 void set_fade_in_active (bool yn);
127 void set_fade_in_shape (FadeShape);
128 void set_fade_in_length (nframes_t);
129 void set_fade_in (FadeShape, nframes_t);
131 void set_fade_out_active (bool yn);
132 void set_fade_out_shape (FadeShape);
133 void set_fade_out_length (nframes_t);
134 void set_fade_out (FadeShape, nframes_t);
136 void set_envelope_active (bool yn);
137 void set_default_envelope ();
139 int separate_by_channel (ARDOUR::Session&, vector<boost::shared_ptr<AudioRegion> >&) const;
143 boost::shared_ptr<Evoral::Control>
144 control(const Evoral::Parameter& id, bool create=false) {
145 return _automatable.data().control(id, create);
148 virtual boost::shared_ptr<const Evoral::Control>
149 control(const Evoral::Parameter& id) const {
150 return _automatable.data().control(id);
155 int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
157 /* xfade/fade interactions */
159 void suspend_fade_in ();
160 void suspend_fade_out ();
161 void resume_fade_in ();
162 void resume_fade_out ();
164 int get_transients (AnalysisFeatureList&, bool force_new = false);
167 friend class RegionFactory;
168 friend class Crossfade;
170 AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length);
171 AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
172 AudioRegion (const SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
173 AudioRegion (boost::shared_ptr<const AudioRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
174 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
175 AudioRegion (boost::shared_ptr<const AudioRegion>);
176 AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
177 AudioRegion (SourceList &, const XMLNode&);
181 void set_default_fades ();
182 void set_default_fade_in ();
183 void set_default_fade_out ();
185 void recompute_gain_at_end ();
186 void recompute_gain_at_start ();
188 nframes_t _read_at (const SourceList&, nframes_t limit,
189 Sample *buf, Sample *mixdown_buffer,
190 float *gain_buffer, nframes_t position, nframes_t cnt,
192 nframes_t read_frames = 0,
193 nframes_t skip_frames = 0,
194 ReadOps readops = ReadOps (~0)) const;
196 void recompute_at_start ();
197 void recompute_at_end ();
199 void envelope_changed ();
200 void fade_in_changed ();
201 void fade_out_changed ();
202 void source_offset_changed ();
203 void listen_to_my_curves ();
204 void listen_to_my_sources ();
206 AutomatableControls _automatable;
208 boost::shared_ptr<AutomationList> _fade_in;
209 FadeShape _fade_in_shape;
210 boost::shared_ptr<AutomationList> _fade_out;
211 FadeShape _fade_out_shape;
212 boost::shared_ptr<AutomationList> _envelope;
213 gain_t _scale_amplitude;
214 uint32_t _fade_in_disabled;
215 uint32_t _fade_out_disabled;
218 /* default constructor for derived (compound) types */
220 AudioRegion (Session& s, nframes_t, nframes_t, std::string name);
222 int set_live_state (const XMLNode&, Change&, bool send);
225 } /* namespace ARDOUR */
227 /* access from C objects */
230 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);
231 uint32_t region_length_from_c (void *arg);
232 uint32_t sourcefile_length_from_c (void *arg, double);
235 #endif /* __ardour_audio_region_h__ */