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 */
111 ReadOpsOwnAutomation = 0x1,
112 ReadOpsOwnScaling = 0x2,
116 virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
117 virtual framecnt_t readable_length() const { return length(); }
119 virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
122 uint32_t chan_n = 0) const;
124 virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
125 framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
127 virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
130 int set_state (const XMLNode&, int version);
132 static void set_default_fade (float steepness, framecnt_t len);
133 bool fade_in_is_default () const;
134 bool fade_out_is_default () const;
136 void set_fade_in_active (bool yn);
137 void set_fade_in_shape (FadeShape);
138 void set_fade_in_length (framecnt_t);
139 void set_fade_in (FadeShape, framecnt_t);
140 void set_fade_in (boost::shared_ptr<AutomationList>);
142 void set_fade_out_active (bool yn);
143 void set_fade_out_shape (FadeShape);
144 void set_fade_out_length (framecnt_t);
145 void set_fade_out (FadeShape, framecnt_t);
146 void set_fade_out (boost::shared_ptr<AutomationList>);
148 void set_default_fade_in ();
149 void set_default_fade_out ();
151 void set_envelope_active (bool yn);
152 void set_default_envelope ();
154 int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
158 boost::shared_ptr<Evoral::Control>
159 control(const Evoral::Parameter& id, bool create=false) {
160 return _automatable.control(id, create);
163 virtual boost::shared_ptr<const Evoral::Control>
164 control(const Evoral::Parameter& id) const {
165 return _automatable.control(id);
168 /* xfade/fade interactions */
170 void suspend_fade_in ();
171 void suspend_fade_out ();
172 void resume_fade_in ();
173 void resume_fade_out ();
175 void add_transient (framepos_t where);
176 void remove_transient (framepos_t where);
177 int set_transients (AnalysisFeatureList&);
178 int get_transients (AnalysisFeatureList&, bool force_new = false);
179 int update_transient (framepos_t old_position, framepos_t new_position);
180 int adjust_transients (frameoffset_t delta);
182 AudioIntervalResult find_silence (Sample, framecnt_t, InterThreadInfo&) const;
185 friend class RegionFactory;
186 friend class Crossfade;
188 AudioRegion (boost::shared_ptr<AudioSource>);
189 AudioRegion (const SourceList &);
190 AudioRegion (boost::shared_ptr<const AudioRegion>);
191 AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset);
192 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
193 AudioRegion (SourceList &);
196 friend class ::AudioRegionTest;
197 friend class ::PlaylistReadTest;
199 PBD::Property<bool> _envelope_active;
200 PBD::Property<bool> _default_fade_in;
201 PBD::Property<bool> _default_fade_out;
202 PBD::Property<bool> _fade_in_active;
203 PBD::Property<bool> _fade_out_active;
204 /** linear gain to apply to the whole region */
205 PBD::Property<gain_t> _scale_amplitude;
207 void register_properties ();
208 void post_set (const PBD::PropertyChange&);
211 void set_default_fades ();
213 void recompute_gain_at_end ();
214 void recompute_gain_at_start ();
216 framecnt_t _read_at (const SourceList&, framecnt_t limit,
217 Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
218 framepos_t position, framecnt_t cnt,
220 ReadOps readops = ReadOps (~0)) const;
222 void recompute_at_start ();
223 void recompute_at_end ();
225 void envelope_changed ();
226 void fade_in_changed ();
227 void fade_out_changed ();
228 void source_offset_changed ();
229 void listen_to_my_curves ();
230 void connect_to_analysis_changed ();
231 void connect_to_header_position_offset_changed ();
233 Automatable _automatable;
235 boost::shared_ptr<AutomationList> _fade_in;
236 boost::shared_ptr<AutomationList> _fade_out;
237 boost::shared_ptr<AutomationList> _envelope;
238 uint32_t _fade_in_suspended;
239 uint32_t _fade_out_suspended;
240 /* This is not a Property because its not subject to user control,
241 or undo/redo. XXX this may prove to be a mistake.
243 bool _fade_in_is_xfade;
244 bool _fade_out_is_xfade;
247 /* default constructor for derived (compound) types */
249 AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
251 int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
254 } /* namespace ARDOUR */
256 /* access from C objects */
259 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);
260 uint32_t region_length_from_c (void *arg);
261 uint32_t sourcefile_length_from_c (void *arg, double);
264 #endif /* __ardour_audio_region_h__ */