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.h"
31 #include "ardour/automation_list.h"
32 #include "ardour/interthread_info.h"
33 #include "ardour/logcurve.h"
34 #include "ardour/region.h"
37 class AudioRegionTest;
38 class PlaylistReadTest;
42 namespace Properties {
43 extern PBD::PropertyDescriptor<bool> envelope_active;
44 extern PBD::PropertyDescriptor<bool> default_fade_in;
45 extern PBD::PropertyDescriptor<bool> default_fade_out;
46 extern PBD::PropertyDescriptor<bool> fade_in_active;
47 extern PBD::PropertyDescriptor<bool> fade_out_active;
48 extern PBD::PropertyDescriptor<float> scale_amplitude;
50 /* the envelope and fades are not scalar items and so
51 currently (2010/02) are not stored using Property.
52 However, these descriptors enable us to notify
53 about changes to them via PropertyChange.
56 extern PBD::PropertyDescriptor<bool> envelope;
57 extern PBD::PropertyDescriptor<bool> fade_in;
58 extern PBD::PropertyDescriptor<bool> fade_out;
67 class AudioRegion : public Region
70 static void make_property_quarks ();
74 void copy_settings (boost::shared_ptr<const AudioRegion>);
76 bool source_equivalent (boost::shared_ptr<const Region>) const;
78 bool speed_mismatch (float) const;
80 boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
82 void set_scale_amplitude (gain_t);
83 gain_t scale_amplitude() const { return _scale_amplitude; }
85 void normalize (float, float target_in_dB = 0.0f);
86 double maximum_amplitude (Progress* p = 0) const;
88 bool envelope_active () const { return _envelope_active; }
89 bool fade_in_active () const { return _fade_in_active; }
90 bool fade_out_active () const { return _fade_out_active; }
92 bool fade_in_is_xfade() const { return _fade_in_is_xfade; }
93 void set_fade_in_is_xfade (bool yn);
94 bool fade_out_is_xfade() const { return _fade_out_is_xfade; }
95 void set_fade_out_is_xfade (bool yn);
97 boost::shared_ptr<AutomationList> fade_in() { return _fade_in; }
98 boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
99 boost::shared_ptr<AutomationList> envelope() { return _envelope; }
101 Evoral::Range<framepos_t> body_range () const;
103 virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
104 framecnt_t offset, framecnt_t cnt,
105 uint32_t chan_n=0, double samples_per_unit= 1.0) const;
107 /* Readable interface */
109 virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
110 virtual framecnt_t readable_length() const { return length(); }
112 virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
115 uint32_t chan_n = 0) const;
117 virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
118 framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
120 virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
123 int set_state (const XMLNode&, int version);
125 static void set_default_fade (float steepness, framecnt_t len);
126 bool fade_in_is_default () const;
127 bool fade_out_is_default () const;
129 void set_fade_in_active (bool yn);
130 void set_fade_in_shape (FadeShape);
131 void set_fade_in_length (framecnt_t);
132 void set_fade_in (FadeShape, framecnt_t);
133 void set_fade_in (boost::shared_ptr<AutomationList>);
135 void set_fade_out_active (bool yn);
136 void set_fade_out_shape (FadeShape);
137 void set_fade_out_length (framecnt_t);
138 void set_fade_out (FadeShape, framecnt_t);
139 void set_fade_out (boost::shared_ptr<AutomationList>);
141 void set_default_fade_in ();
142 void set_default_fade_out ();
144 void set_envelope_active (bool yn);
145 void set_default_envelope ();
147 int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
151 boost::shared_ptr<Evoral::Control>
152 control(const Evoral::Parameter& id, bool create=false) {
153 return _automatable.control(id, create);
156 virtual boost::shared_ptr<const Evoral::Control>
157 control(const Evoral::Parameter& id) const {
158 return _automatable.control(id);
161 /* xfade/fade interactions */
163 void suspend_fade_in ();
164 void suspend_fade_out ();
165 void resume_fade_in ();
166 void resume_fade_out ();
168 void add_transient (framepos_t where);
169 void remove_transient (framepos_t where);
170 int set_transients (AnalysisFeatureList&);
171 int get_transients (AnalysisFeatureList&, bool force_new = false);
172 int update_transient (framepos_t old_position, framepos_t new_position);
173 int adjust_transients (frameoffset_t delta);
175 AudioIntervalResult find_silence (Sample, framecnt_t, InterThreadInfo&) const;
178 friend class RegionFactory;
179 friend class Crossfade;
181 AudioRegion (boost::shared_ptr<AudioSource>);
182 AudioRegion (const SourceList &);
183 AudioRegion (boost::shared_ptr<const AudioRegion>);
184 AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset);
185 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
186 AudioRegion (SourceList &);
189 friend class ::AudioRegionTest;
190 friend class ::PlaylistReadTest;
192 PBD::Property<bool> _envelope_active;
193 PBD::Property<bool> _default_fade_in;
194 PBD::Property<bool> _default_fade_out;
195 PBD::Property<bool> _fade_in_active;
196 PBD::Property<bool> _fade_out_active;
197 /** linear gain to apply to the whole region */
198 PBD::Property<gain_t> _scale_amplitude;
200 void register_properties ();
201 void post_set (const PBD::PropertyChange&);
204 void set_default_fades ();
206 void recompute_gain_at_end ();
207 void recompute_gain_at_start ();
209 framecnt_t read_from_sources (SourceList const &, framecnt_t, Sample *, framepos_t, framecnt_t, uint32_t) const;
211 void recompute_at_start ();
212 void recompute_at_end ();
214 void envelope_changed ();
215 void fade_in_changed ();
216 void fade_out_changed ();
217 void source_offset_changed ();
218 void listen_to_my_curves ();
219 void connect_to_analysis_changed ();
220 void connect_to_header_position_offset_changed ();
222 Automatable _automatable;
224 boost::shared_ptr<AutomationList> _fade_in;
225 boost::shared_ptr<AutomationList> _inverse_fade_in;
226 boost::shared_ptr<AutomationList> _fade_out;
227 boost::shared_ptr<AutomationList> _inverse_fade_out;
228 boost::shared_ptr<AutomationList> _envelope;
229 uint32_t _fade_in_suspended;
230 uint32_t _fade_out_suspended;
231 /* This is not a Property because its not subject to user control,
232 or undo/redo. XXX this may prove to be a mistake.
234 bool _fade_in_is_xfade;
235 bool _fade_out_is_xfade;
238 /* default constructor for derived (compound) types */
240 AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
242 int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
245 } /* namespace ARDOUR */
247 /* access from C objects */
250 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);
251 uint32_t region_length_from_c (void *arg);
252 uint32_t sourcefile_length_from_c (void *arg, double);
255 #endif /* __ardour_audio_region_h__ */