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);
85 double maximum_amplitude (Progress* p = 0) const;
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.val (); }
92 boost::shared_ptr<AutomationList> inverse_fade_in() { return _inverse_fade_in.val (); }
93 boost::shared_ptr<AutomationList> fade_out() { return _fade_out.val (); }
94 boost::shared_ptr<AutomationList> inverse_fade_out() { return _inverse_fade_out.val (); }
95 boost::shared_ptr<AutomationList> envelope() { return _envelope.val (); }
97 Evoral::Range<framepos_t> body_range () const;
99 virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
100 framecnt_t offset, framecnt_t cnt,
101 uint32_t chan_n=0, double frames_per_pixel = 1.0) const;
103 /* Readable interface */
105 virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
106 virtual framecnt_t readable_length() const { return length(); }
108 virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
111 uint32_t chan_n = 0) const;
113 virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
114 framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
116 virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
119 XMLNode& get_basic_state ();
120 int set_state (const XMLNode&, int version);
122 void fade_range (framepos_t, framepos_t);
124 bool fade_in_is_default () const;
125 bool fade_out_is_default () const;
127 void set_fade_in_active (bool yn);
128 void set_fade_in_shape (FadeShape);
129 void set_fade_in_length (framecnt_t);
130 void set_fade_in (FadeShape, framecnt_t);
131 void set_fade_in (boost::shared_ptr<AutomationList>);
133 void set_fade_out_active (bool yn);
134 void set_fade_out_shape (FadeShape);
135 void set_fade_out_length (framecnt_t);
136 void set_fade_out (FadeShape, framecnt_t);
137 void set_fade_out (boost::shared_ptr<AutomationList>);
139 void set_default_fade_in ();
140 void set_default_fade_out ();
142 framecnt_t verify_xfade_bounds (framecnt_t, bool start);
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 void clear_transients ();
171 void set_onsets (AnalysisFeatureList&);
172 void get_transients (AnalysisFeatureList&);
173 void update_transient (framepos_t old_position, framepos_t new_position);
175 AudioIntervalResult find_silence (Sample, framecnt_t, framecnt_t, InterThreadInfo&) const;
178 friend class RegionFactory;
180 AudioRegion (boost::shared_ptr<AudioSource>);
181 AudioRegion (const SourceList &);
182 AudioRegion (boost::shared_ptr<const AudioRegion>);
183 AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset, const int32_t& sub_num);
184 AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
185 AudioRegion (SourceList &);
188 friend class ::AudioRegionReadTest;
189 friend class ::PlaylistReadTest;
191 void build_transients ();
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 /** linear gain to apply to the whole region */
199 PBD::Property<gain_t> _scale_amplitude;
201 void register_properties ();
202 void post_set (const PBD::PropertyChange&);
205 void set_default_fades ();
207 void recompute_gain_at_end ();
208 void recompute_gain_at_start ();
210 framecnt_t read_from_sources (SourceList const &, framecnt_t, Sample *, framepos_t, framecnt_t, uint32_t) const;
212 void recompute_at_start ();
213 void recompute_at_end ();
215 void envelope_changed ();
216 void fade_in_changed ();
217 void fade_out_changed ();
218 void source_offset_changed ();
219 void listen_to_my_curves ();
220 void connect_to_analysis_changed ();
221 void connect_to_header_position_offset_changed ();
224 AutomationListProperty _fade_in;
225 AutomationListProperty _inverse_fade_in;
226 AutomationListProperty _fade_out;
227 AutomationListProperty _inverse_fade_out;
228 AutomationListProperty _envelope;
229 Automatable _automatable;
230 uint32_t _fade_in_suspended;
231 uint32_t _fade_out_suspended;
233 boost::shared_ptr<ARDOUR::Region> get_single_other_xfade_region (bool start) const;
236 /* default constructor for derived (compound) types */
238 AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
240 int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
243 } /* namespace ARDOUR */
245 /* access from C objects */
248 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);
249 LIBARDOUR_API uint32_t region_length_from_c (void *arg);
250 LIBARDOUR_API uint32_t sourcefile_length_from_c (void *arg, double);
253 #endif /* __ardour_audio_region_h__ */