prepare region RMS (loudness) normalization
[ardour.git] / libs / ardour / ardour / audioregion.h
index fd6c3a85288565f56a45758a6507f8c5004c32c4..d25cf0e421112b48bd1f6bdf1a5709534af2237a 100644 (file)
 #include "ardour/region.h"
 
 class XMLNode;
-class AudioRegionTest;
+class AudioRegionReadTest;
 class PlaylistReadTest;
 
 namespace ARDOUR {
 
 namespace Properties {
-       extern PBD::PropertyDescriptor<bool> envelope_active;
-       extern PBD::PropertyDescriptor<bool> default_fade_in;
-       extern PBD::PropertyDescriptor<bool> default_fade_out;
-       extern PBD::PropertyDescriptor<bool> fade_in_active;
-       extern PBD::PropertyDescriptor<bool> fade_out_active;
-       extern PBD::PropertyDescriptor<float> scale_amplitude;
-
-       /* the envelope and fades are not scalar items and so
-          currently (2010/02) are not stored using Property.
-          However, these descriptors enable us to notify
-          about changes to them via PropertyChange.
-       */
-
-       extern PBD::PropertyDescriptor<bool> envelope;
-       extern PBD::PropertyDescriptor<bool> fade_in;
-       extern PBD::PropertyDescriptor<bool> fade_out;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> envelope_active;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> default_fade_in;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> default_fade_out;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> fade_in_active;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> fade_out_active;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<float> scale_amplitude;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_in;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_in;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_out;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_out;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > envelope;
 }
 
 class Playlist;
@@ -64,7 +59,7 @@ class Filter;
 class AudioSource;
 
 
-class AudioRegion : public Region
+class LIBARDOUR_API AudioRegion : public Region
 {
   public:
        static void make_property_quarks ();
@@ -79,32 +74,40 @@ class AudioRegion : public Region
 
        boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
 
+    // if several audio files associated with a region,
+    // information about file with MAX channel count will be provided
+    uint32_t get_related_audio_file_channel_count () const;
+
        void   set_scale_amplitude (gain_t);
        gain_t scale_amplitude() const { return _scale_amplitude; }
 
        void normalize (float, float target_in_dB = 0.0f);
+
+       /** @return the maximum (linear) amplitude of the region, or a -ve
+        *  number if the Progress object reports that the process was cancelled.
+        */
        double maximum_amplitude (Progress* p = 0) const;
 
+       /** @return the maximum (rms) signal power of the region, or a -1
+        *  if the Progress object reports that the process was cancelled.
+        */
+       double rms (Progress* p = 0) const;
+
        bool envelope_active () const { return _envelope_active; }
        bool fade_in_active ()  const { return _fade_in_active; }
        bool fade_out_active () const { return _fade_out_active; }
 
-       bool fade_in_is_xfade() const { return _fade_in_is_xfade; }
-       void set_fade_in_is_xfade (bool yn);
-       bool fade_out_is_xfade() const { return _fade_out_is_xfade; }
-       void set_fade_out_is_xfade (bool yn);
-
-       boost::shared_ptr<AutomationList> fade_in()  { return _fade_in; }
-       boost::shared_ptr<AutomationList> inverse_fade_in()  { return _inverse_fade_in; }
-       boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
-       boost::shared_ptr<AutomationList> inverse_fade_out()  { return _inverse_fade_out; }
-       boost::shared_ptr<AutomationList> envelope() { return _envelope; }
+       boost::shared_ptr<AutomationList> fade_in()  { return _fade_in.val (); }
+       boost::shared_ptr<AutomationList> inverse_fade_in()  { return _inverse_fade_in.val (); }
+       boost::shared_ptr<AutomationList> fade_out() { return _fade_out.val (); }
+       boost::shared_ptr<AutomationList> inverse_fade_out()  { return _inverse_fade_out.val (); }
+       boost::shared_ptr<AutomationList> envelope() { return _envelope.val (); }
 
        Evoral::Range<framepos_t> body_range () const;
 
        virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
                        framecnt_t offset, framecnt_t cnt,
-                       uint32_t chan_n=0, double samples_per_unit= 1.0) const;
+                       uint32_t chan_n=0, double frames_per_pixel = 1.0) const;
 
        /* Readable interface */
 
@@ -122,9 +125,11 @@ class AudioRegion : public Region
        virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
 
        XMLNode& state ();
+       XMLNode& get_basic_state ();
        int set_state (const XMLNode&, int version);
 
-       static void set_default_fade (float steepness, framecnt_t len);
+       void fade_range (framepos_t, framepos_t);
+
        bool fade_in_is_default () const;
        bool fade_out_is_default () const;
 
@@ -144,7 +149,7 @@ class AudioRegion : public Region
        void set_default_fade_out ();
 
        framecnt_t verify_xfade_bounds (framecnt_t, bool start);
-       
+
        void set_envelope_active (bool yn);
        void set_default_envelope ();
 
@@ -171,28 +176,29 @@ class AudioRegion : public Region
 
        void add_transient (framepos_t where);
        void remove_transient (framepos_t where);
-       int set_transients (AnalysisFeatureList&);
-       int get_transients (AnalysisFeatureList&, bool force_new = false);
-       int update_transient (framepos_t old_position, framepos_t new_position);
-       int adjust_transients (frameoffset_t delta);
+       void clear_transients ();
+       void set_onsets (AnalysisFeatureList&);
+       void get_transients (AnalysisFeatureList&);
+       void update_transient (framepos_t old_position, framepos_t new_position);
 
-       AudioIntervalResult find_silence (Sample, framecnt_t, InterThreadInfo&) const;
+       AudioIntervalResult find_silence (Sample, framecnt_t, framecnt_t, InterThreadInfo&) const;
 
   private:
        friend class RegionFactory;
-       friend class Crossfade;
 
        AudioRegion (boost::shared_ptr<AudioSource>);
        AudioRegion (const SourceList &);
        AudioRegion (boost::shared_ptr<const AudioRegion>);
-       AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset);
+       AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset, const int32_t sub_num);
        AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
        AudioRegion (SourceList &);
 
   private:
-       friend class ::AudioRegionTest;
+       friend class ::AudioRegionReadTest;
        friend class ::PlaylistReadTest;
-       
+
+       void build_transients ();
+
        PBD::Property<bool>     _envelope_active;
        PBD::Property<bool>     _default_fade_in;
        PBD::Property<bool>     _default_fade_out;
@@ -223,20 +229,17 @@ class AudioRegion : public Region
        void connect_to_analysis_changed ();
        void connect_to_header_position_offset_changed ();
 
-       Automatable _automatable;
-
-       boost::shared_ptr<AutomationList> _fade_in;
-       boost::shared_ptr<AutomationList> _inverse_fade_in;
-       boost::shared_ptr<AutomationList> _fade_out;
-       boost::shared_ptr<AutomationList> _inverse_fade_out;
-       boost::shared_ptr<AutomationList> _envelope;
-       uint32_t                          _fade_in_suspended;
-       uint32_t                          _fade_out_suspended;
-       /* This is not a Property because its not subject to user control,
-          or undo/redo. XXX this may prove to be a mistake.
-       */
-       bool                              _fade_in_is_xfade;
-       bool                              _fade_out_is_xfade;
+
+       AutomationListProperty _fade_in;
+       AutomationListProperty _inverse_fade_in;
+       AutomationListProperty _fade_out;
+       AutomationListProperty _inverse_fade_out;
+       AutomationListProperty _envelope;
+       Automatable            _automatable;
+       uint32_t               _fade_in_suspended;
+       uint32_t               _fade_out_suspended;
+
+       boost::shared_ptr<ARDOUR::Region> get_single_other_xfade_region (bool start) const;
 
   protected:
        /* default constructor for derived (compound) types */
@@ -251,9 +254,9 @@ class AudioRegion : public Region
 /* access from C objects */
 
 extern "C" {
-       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);
-       uint32_t region_length_from_c (void *arg);
-       uint32_t sourcefile_length_from_c (void *arg, double);
+       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);
+       LIBARDOUR_API uint32_t region_length_from_c (void *arg);
+       LIBARDOUR_API uint32_t sourcefile_length_from_c (void *arg, double);
 }
 
 #endif /* __ardour_audio_region_h__ */