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 AudioRegionReadTest;
38 class PlaylistReadTest;
42 namespace Properties {
43 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> envelope_active;
44 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> default_fade_in;
45 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> default_fade_out;
46 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> fade_in_active;
47 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> fade_out_active;
48 LIBARDOUR_API extern PBD::PropertyDescriptor<float> scale_amplitude;
49 LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_in;
50 LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_in;
51 LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_out;
52 LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_out;
53 LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > envelope;
62 class LIBARDOUR_API AudioRegion : public Region
65 static void make_property_quarks ();
69 void copy_settings (boost::shared_ptr<const AudioRegion>);
71 bool source_equivalent (boost::shared_ptr<const Region>) const;
73 bool speed_mismatch (float) const;
75 boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
77 // if several audio files associated with a region,
78 // information about file with MAX channel count will be provided
79 uint32_t get_related_audio_file_channel_count () const;
81 void set_scale_amplitude (gain_t);
82 gain_t scale_amplitude() const { return _scale_amplitude; }
84 void normalize (float, float target_in_dB = 0.0f);
86 /** @return the maximum (linear) amplitude of the region, or a -ve
87 * number if the Progress object reports that the process was cancelled.
89 double maximum_amplitude (Progress* p = 0) const;
91 /** @return the maximum (rms) signal power of the region, or a -1
92 * if the Progress object reports that the process was cancelled.
94 double rms (Progress* p = 0) const;
96 bool envelope_active () const { return _envelope_active; }
97 bool fade_in_active () const { return _fade_in_active; }
98 bool fade_out_active () const { return _fade_out_active; }
100 boost::shared_ptr<AutomationList> fade_in() { return _fade_in.val (); }
101 boost::shared_ptr<AutomationList> inverse_fade_in() { return _inverse_fade_in.val (); }
102 boost::shared_ptr<AutomationList> fade_out() { return _fade_out.val (); }
103 boost::shared_ptr<AutomationList> inverse_fade_out() { return _inverse_fade_out.val (); }
104 boost::shared_ptr<AutomationList> envelope() { return _envelope.val (); }
106 Evoral::Range<framepos_t> body_range () const;
108 virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
109 framecnt_t offset, framecnt_t cnt,
110 uint32_t chan_n=0, double frames_per_pixel = 1.0) const;
112 /* Readable interface */
114 virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
115 virtual framecnt_t readable_length() const { return length(); }
117 virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
120 uint32_t chan_n = 0) const;
122 virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
123 framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
125 virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
128 XMLNode& get_basic_state ();
129 int set_state (const XMLNode&, int version);
131 void fade_range (framepos_t, framepos_t);
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 framecnt_t verify_xfade_bounds (framecnt_t, bool start);
153 void set_envelope_active (bool yn);
154 void set_default_envelope ();
156 int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
160 boost::shared_ptr<Evoral::Control>
161 control(const Evoral::Parameter& id, bool create=false) {
162 return _automatable.control(id, create);
165 virtual boost::shared_ptr<const Evoral::Control>
166 control(const Evoral::Parameter& id) const {
167 return _automatable.control(id);
170 /* xfade/fade interactions */
172 void suspend_fade_in ();
173 void suspend_fade_out ();
174 void resume_fade_in ();
175 void resume_fade_out ();
177 void add_transient (framepos_t where);
178 void remove_transient (framepos_t where);
179 void clear_transients ();
180 void set_onsets (AnalysisFeatureList&);
181 void get_transients (AnalysisFeatureList&);
182 void update_transient (framepos_t old_position, framepos_t new_position);
184 AudioIntervalResult find_silence (Sample, framecnt_t, framecnt_t, InterThreadInfo&) const;
187 friend class RegionFactory;
189 AudioRegion (boost::shared_ptr<AudioSource>);
190 AudioRegion (const SourceList &);
191 AudioRegion (boost::shared_ptr<const AudioRegion>);
192 AudioRegion (boost::shared_ptr<const AudioRegion>, ARDOUR::MusicFrame offset);
193 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
194 AudioRegion (SourceList &);
197 friend class ::AudioRegionReadTest;
198 friend class ::PlaylistReadTest;
200 void build_transients ();
202 PBD::Property<bool> _envelope_active;
203 PBD::Property<bool> _default_fade_in;
204 PBD::Property<bool> _default_fade_out;
205 PBD::Property<bool> _fade_in_active;
206 PBD::Property<bool> _fade_out_active;
207 /** linear gain to apply to the whole region */
208 PBD::Property<gain_t> _scale_amplitude;
210 void register_properties ();
211 void post_set (const PBD::PropertyChange&);
214 void set_default_fades ();
216 void recompute_gain_at_end ();
217 void recompute_gain_at_start ();
219 framecnt_t read_from_sources (SourceList const &, framecnt_t, Sample *, framepos_t, framecnt_t, uint32_t) const;
221 void recompute_at_start ();
222 void recompute_at_end ();
224 void envelope_changed ();
225 void fade_in_changed ();
226 void fade_out_changed ();
227 void source_offset_changed ();
228 void listen_to_my_curves ();
229 void connect_to_analysis_changed ();
230 void connect_to_header_position_offset_changed ();
233 AutomationListProperty _fade_in;
234 AutomationListProperty _inverse_fade_in;
235 AutomationListProperty _fade_out;
236 AutomationListProperty _inverse_fade_out;
237 AutomationListProperty _envelope;
238 Automatable _automatable;
239 uint32_t _fade_in_suspended;
240 uint32_t _fade_out_suspended;
242 boost::shared_ptr<ARDOUR::Region> get_single_other_xfade_region (bool start) const;
245 /* default constructor for derived (compound) types */
247 AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
249 int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
252 } /* namespace ARDOUR */
254 /* access from C objects */
257 LIBARDOUR_API 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);
258 LIBARDOUR_API uint32_t region_length_from_c (void *arg);
259 LIBARDOUR_API uint32_t sourcefile_length_from_c (void *arg, double);
262 #endif /* __ardour_audio_region_h__ */