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"
40 namespace Properties {
41 extern PBD::PropertyDescriptor<bool> envelope_active;
42 extern PBD::PropertyDescriptor<bool> default_fade_in;
43 extern PBD::PropertyDescriptor<bool> default_fade_out;
44 extern PBD::PropertyDescriptor<bool> fade_in_active;
45 extern PBD::PropertyDescriptor<bool> fade_out_active;
46 extern PBD::PropertyDescriptor<float> scale_amplitude;
47 extern PBD::PropertyDescriptor<float> scale_amplitude;
49 /* the envelope and fades are not scalar items and so
50 currently (2010/02) are not stored using Property.
51 However, these descriptors enable us to notify
52 about changes to them via PropertyChange.
55 extern PBD::PropertyDescriptor<bool> envelope;
56 extern PBD::PropertyDescriptor<bool> fade_in;
57 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_to (float target_in_dB = 0.0f);
87 bool envelope_active () const { return _envelope_active; }
88 bool fade_in_active () const { return _fade_in_active; }
89 bool fade_out_active () const { return _fade_out_active; }
91 boost::shared_ptr<AutomationList> fade_in() { return _fade_in; }
92 boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
93 boost::shared_ptr<AutomationList> envelope() { return _envelope; }
95 virtual nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
96 nframes_t offset, nframes_t cnt,
97 uint32_t chan_n=0, double samples_per_unit= 1.0) const;
99 /* Readable interface */
103 ReadOpsOwnAutomation = 0x1,
104 ReadOpsOwnScaling = 0x2,
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,
116 framecnt_t read_frames = 0,
117 framecnt_t skip_frames = 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;
124 XMLNode& state (bool);
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;
139 void set_fade_in_active (bool yn);
140 void set_fade_in_shape (FadeShape);
141 void set_fade_in_length (framecnt_t);
142 void set_fade_in (FadeShape, framecnt_t);
143 void set_fade_in (boost::shared_ptr<AutomationList>);
145 void set_fade_out_active (bool yn);
146 void set_fade_out_shape (FadeShape);
147 void set_fade_out_length (framecnt_t);
148 void set_fade_out (FadeShape, framecnt_t);
149 void set_fade_out (boost::shared_ptr<AutomationList>);
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);
170 int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
172 /* xfade/fade interactions */
174 void suspend_fade_in ();
175 void suspend_fade_out ();
176 void resume_fade_in ();
177 void resume_fade_out ();
179 int get_transients (AnalysisFeatureList&, bool force_new = false);
180 std::list<std::pair<frameoffset_t, framecnt_t> > find_silence (Sample, framecnt_t, InterThreadInfo&) const;
183 friend class RegionFactory;
184 friend class Crossfade;
186 AudioRegion (boost::shared_ptr<AudioSource>);
187 AudioRegion (const SourceList &);
188 AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset = 0, bool offset_relative = true);
189 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
190 AudioRegion (SourceList &);
193 PBD::Property<bool> _envelope_active;
194 PBD::Property<bool> _default_fade_in;
195 PBD::Property<bool> _default_fade_out;
196 PBD::Property<bool> _fade_in_active;
197 PBD::Property<bool> _fade_out_active;
198 PBD::Property<gain_t> _scale_amplitude;
200 void register_properties ();
204 void set_default_fades ();
205 void set_default_fade_in ();
206 void set_default_fade_out ();
208 void recompute_gain_at_end ();
209 void recompute_gain_at_start ();
211 framecnt_t _read_at (const SourceList&, framecnt_t limit,
212 Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
213 framepos_t position, framecnt_t cnt,
215 framecnt_t read_frames = 0,
216 framecnt_t skip_frames = 0,
217 ReadOps readops = ReadOps (~0)) const;
219 void recompute_at_start ();
220 void recompute_at_end ();
222 void envelope_changed ();
223 void fade_in_changed ();
224 void fade_out_changed ();
225 void source_offset_changed ();
226 void listen_to_my_curves ();
227 void connect_to_analysis_changed ();
228 void connect_to_header_position_offset_changed ();
230 AutomatableControls _automatable;
232 boost::shared_ptr<AutomationList> _fade_in;
233 boost::shared_ptr<AutomationList> _fade_out;
234 boost::shared_ptr<AutomationList> _envelope;
235 uint32_t _fade_in_suspended;
236 uint32_t _fade_out_suspended;
239 /* default constructor for derived (compound) types */
241 AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
243 int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
246 } /* namespace ARDOUR */
248 /* access from C objects */
251 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);
252 uint32_t region_length_from_c (void *arg);
253 uint32_t sourcefile_length_from_c (void *arg, double);
256 #endif /* __ardour_audio_region_h__ */