2 Copyright (C) 2000-2001 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_audio_region_h__
22 #define __ardour_audio_region_h__
26 #include <pbd/fastlog.h>
29 #include <ardour/ardour.h>
30 #include <ardour/region.h>
31 #include <ardour/gain.h>
32 #include <ardour/logcurve.h>
33 #include <ardour/export.h>
45 struct AudioRegionState : public RegionState
47 AudioRegionState (std::string why);
52 gain_t _scale_amplitude;
53 uint32_t _fade_in_disabled;
54 uint32_t _fade_out_disabled;
57 class AudioRegion : public Region
60 static Change FadeInChanged;
61 static Change FadeOutChanged;
62 static Change FadeInActiveChanged;
63 static Change FadeOutActiveChanged;
64 static Change EnvelopeActiveChanged;
65 static Change ScaleAmplitudeChanged;
66 static Change EnvelopeChanged;
70 bool source_equivalent (boost::shared_ptr<const Region>) const;
72 bool speed_mismatch (float) const;
74 boost::shared_ptr<AudioSource> source (uint32_t n=0) const { if (n < sources.size()) return sources[n]; else return sources[0]; }
76 void set_scale_amplitude (gain_t);
77 gain_t scale_amplitude() const { return _scale_amplitude; }
79 void normalize_to (float target_in_dB = 0.0f);
81 uint32_t n_channels() { return sources.size(); }
82 vector<string> master_source_names();
84 bool envelope_active () const { return _flags & Region::EnvelopeActive; }
85 bool fade_in_active () const { return _flags & Region::FadeIn; }
86 bool fade_out_active () const { return _flags & Region::FadeOut; }
87 bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
89 Curve& fade_in() { return _fade_in; }
90 Curve& fade_out() { return _fade_out; }
91 Curve& envelope() { return _envelope; }
93 nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
94 nframes_t offset, nframes_t cnt,
95 uint32_t chan_n=0, double samples_per_unit= 1.0) const;
97 virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf,
98 float *gain_buf, nframes_t position, nframes_t cnt,
100 nframes_t read_frames = 0,
101 nframes_t skip_frames = 0) const;
103 nframes_t master_read_at (Sample *buf, Sample *mixdown_buf,
105 nframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
107 XMLNode& state (bool);
108 int set_state (const XMLNode&);
110 static void set_default_fade (float steepness, nframes_t len);
120 void set_fade_in_active (bool yn);
121 void set_fade_in_shape (FadeShape);
122 void set_fade_in_length (nframes_t);
123 void set_fade_in (FadeShape, nframes_t);
125 void set_fade_out_active (bool yn);
126 void set_fade_out_shape (FadeShape);
127 void set_fade_out_length (nframes_t);
128 void set_fade_out (FadeShape, nframes_t);
130 void set_envelope_active (bool yn);
132 int separate_by_channel (ARDOUR::Session&, vector<AudioRegion*>&) const;
134 UndoAction get_memento() const;
138 int apply (AudioFilter&);
142 int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
144 boost::shared_ptr<Region> get_parent();
146 /* xfade/fade interactions */
148 void suspend_fade_in ();
149 void suspend_fade_out ();
150 void resume_fade_in ();
151 void resume_fade_out ();
154 friend class RegionFactory;
156 AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length);
157 AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
158 AudioRegion (SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
159 AudioRegion (boost::shared_ptr<const AudioRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
160 AudioRegion (boost::shared_ptr<const AudioRegion>);
161 AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
162 AudioRegion (SourceList &, const XMLNode&);
165 void set_default_fades ();
166 void set_default_fade_in ();
167 void set_default_fade_out ();
168 void set_default_envelope ();
170 StateManager::State* state_factory (std::string why) const;
171 Change restore_state (StateManager::State&);
173 void recompute_gain_at_end ();
174 void recompute_gain_at_start ();
176 nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer,
177 float *gain_buffer, nframes_t position, nframes_t cnt,
179 nframes_t read_frames = 0,
180 nframes_t skip_frames = 0) const;
182 bool verify_start (nframes_t position);
183 bool verify_length (nframes_t position);
184 bool verify_start_mutable (nframes_t& start);
185 bool verify_start_and_length (nframes_t start, nframes_t length);
186 void recompute_at_start ();
187 void recompute_at_end ();
189 void envelope_changed (Change);
190 void source_offset_changed ();
192 void source_deleted ();
196 /** Used when timefx are applied, so we can always use the original source. */
197 SourceList master_sources;
199 mutable Curve _fade_in;
200 FadeShape _fade_in_shape;
201 mutable Curve _fade_out;
202 FadeShape _fade_out_shape;
203 mutable Curve _envelope;
204 gain_t _scale_amplitude;
205 uint32_t _fade_in_disabled;
206 uint32_t _fade_out_disabled;
209 } /* namespace ARDOUR */
211 /* access from C objects */
214 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);
215 uint32_t region_length_from_c (void *arg);
216 uint32_t sourcefile_length_from_c (void *arg, double);
219 #endif /* __ardour_audio_region_h__ */