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> inverse_fade_in() { return _inverse_fade_in; }
99 boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
100 boost::shared_ptr<AutomationList> inverse_fade_out() { return _inverse_fade_out; }
101 boost::shared_ptr<AutomationList> envelope() { return _envelope; }
103 Evoral::Range<framepos_t> body_range () const;
105 virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
106 framecnt_t offset, framecnt_t cnt,
107 uint32_t chan_n=0, double samples_per_unit= 1.0) const;
109 /* Readable interface */
111 virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
112 virtual framecnt_t readable_length() const { return length(); }
114 virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
117 uint32_t chan_n = 0) const;
119 virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
120 framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
122 virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
125 int set_state (const XMLNode&, int version);
127 static void set_default_fade (float steepness, framecnt_t len);
128 bool fade_in_is_default () const;
129 bool fade_out_is_default () const;
131 void set_fade_in_active (bool yn);
132 void set_fade_in_shape (FadeShape);
133 void set_fade_in_length (framecnt_t);
134 void set_fade_in (FadeShape, framecnt_t);
135 void set_fade_in (boost::shared_ptr<AutomationList>);
137 void set_fade_out_active (bool yn);
138 void set_fade_out_shape (FadeShape);
139 void set_fade_out_length (framecnt_t);
140 void set_fade_out (FadeShape, framecnt_t);
141 void set_fade_out (boost::shared_ptr<AutomationList>);
143 void set_default_fade_in ();
144 void set_default_fade_out ();
146 framecnt_t verify_xfade_bounds (framecnt_t, bool start);
148 void set_envelope_active (bool yn);
149 void set_default_envelope ();
151 int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
155 boost::shared_ptr<Evoral::Control>
156 control(const Evoral::Parameter& id, bool create=false) {
157 return _automatable.control(id, create);
160 virtual boost::shared_ptr<const Evoral::Control>
161 control(const Evoral::Parameter& id) const {
162 return _automatable.control(id);
165 /* xfade/fade interactions */
167 void suspend_fade_in ();
168 void suspend_fade_out ();
169 void resume_fade_in ();
170 void resume_fade_out ();
172 void add_transient (framepos_t where);
173 void remove_transient (framepos_t where);
174 int set_transients (AnalysisFeatureList&);
175 int get_transients (AnalysisFeatureList&, bool force_new = false);
176 int update_transient (framepos_t old_position, framepos_t new_position);
177 int adjust_transients (frameoffset_t delta);
179 AudioIntervalResult find_silence (Sample, framecnt_t, InterThreadInfo&) const;
182 friend class RegionFactory;
183 friend class Crossfade;
185 AudioRegion (boost::shared_ptr<AudioSource>);
186 AudioRegion (const SourceList &);
187 AudioRegion (boost::shared_ptr<const AudioRegion>);
188 AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset);
189 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
190 AudioRegion (SourceList &);
193 friend class ::AudioRegionTest;
194 friend class ::PlaylistReadTest;
196 PBD::Property<bool> _envelope_active;
197 PBD::Property<bool> _default_fade_in;
198 PBD::Property<bool> _default_fade_out;
199 PBD::Property<bool> _fade_in_active;
200 PBD::Property<bool> _fade_out_active;
201 /** linear gain to apply to the whole region */
202 PBD::Property<gain_t> _scale_amplitude;
204 void register_properties ();
205 void post_set (const PBD::PropertyChange&);
208 void set_default_fades ();
210 void recompute_gain_at_end ();
211 void recompute_gain_at_start ();
213 framecnt_t read_from_sources (SourceList const &, framecnt_t, Sample *, framepos_t, framecnt_t, uint32_t) const;
215 void recompute_at_start ();
216 void recompute_at_end ();
218 void envelope_changed ();
219 void fade_in_changed ();
220 void fade_out_changed ();
221 void source_offset_changed ();
222 void listen_to_my_curves ();
223 void connect_to_analysis_changed ();
224 void connect_to_header_position_offset_changed ();
226 Automatable _automatable;
228 boost::shared_ptr<AutomationList> _fade_in;
229 boost::shared_ptr<AutomationList> _inverse_fade_in;
230 boost::shared_ptr<AutomationList> _fade_out;
231 boost::shared_ptr<AutomationList> _inverse_fade_out;
232 boost::shared_ptr<AutomationList> _envelope;
233 uint32_t _fade_in_suspended;
234 uint32_t _fade_out_suspended;
235 /* This is not a Property because its not subject to user control,
236 or undo/redo. XXX this may prove to be a mistake.
238 bool _fade_in_is_xfade;
239 bool _fade_out_is_xfade;
241 boost::shared_ptr<ARDOUR::Region> get_single_other_xfade_region (bool start) const;
244 /* default constructor for derived (compound) types */
246 AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
248 int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
251 } /* namespace ARDOUR */
253 /* access from C objects */
256 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);
257 uint32_t region_length_from_c (void *arg);
258 uint32_t sourcefile_length_from_c (void *arg, double);
261 #endif /* __ardour_audio_region_h__ */