improve AU Latency PropertyChange Events
[ardour.git] / libs / ardour / ardour / audioregion.h
index ef5f5dc6e7f9d4778dab3f9baf96e07bf641664b..c3003e587bba29b9dbaaaa7e0d5c843da0af12fe 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2001 Paul Davis 
+    Copyright (C) 2000-2006 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_audio_region_h__
 #define __ardour_audio_region_h__
 
 #include <vector>
+#include <list>
 
-#include <pbd/fastlog.h>
-#include <pbd/undo.h>
+#include "pbd/fastlog.h"
+#include "pbd/undo.h"
 
-#include <ardour/ardour.h>
-#include <ardour/region.h>
-#include <ardour/gain.h>
-#include <ardour/logcurve.h>
-#include <ardour/export.h>
+#include "ardour/ardour.h"
+#include "ardour/automatable.h"
+#include "ardour/automation_list.h"
+#include "ardour/interthread_info.h"
+#include "ardour/logcurve.h"
+#include "ardour/region.h"
 
 class XMLNode;
+class AudioRegionReadTest;
+class PlaylistReadTest;
 
 namespace ARDOUR {
 
-class Route;
+namespace Properties {
+       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;
 class Session;
-class AudioFilter;
+class Filter;
 class AudioSource;
 
-class AudioRegion : public Region
+
+class LIBARDOUR_API AudioRegion : public Region
 {
   public:
-       static Change FadeInChanged;
-       static Change FadeOutChanged;
-       static Change FadeInActiveChanged;
-       static Change FadeOutActiveChanged;
-       static Change EnvelopeActiveChanged;
-       static Change ScaleAmplitudeChanged;
-       static Change EnvelopeChanged;
+       static void make_property_quarks ();
 
        ~AudioRegion();
 
+       void copy_settings (boost::shared_ptr<const AudioRegion>);
+
        bool source_equivalent (boost::shared_ptr<const Region>) const;
 
        bool speed_mismatch (float) const;
 
-       boost::shared_ptr<AudioSource> source (uint32_t n=0) const { if (n < sources.size()) return sources[n]; else return sources[0]; } 
+       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);
+       void   set_scale_amplitude (gain_t);
        gain_t scale_amplitude() const { return _scale_amplitude; }
-       
-       void normalize_to (float target_in_dB = 0.0f);
-
-       uint32_t n_channels() { return sources.size(); }
-       vector<string> master_source_names();
-       
-       bool envelope_active () const { return _flags & Region::EnvelopeActive; }
-       bool fade_in_active ()  const { return _flags & Region::FadeIn; }
-       bool fade_out_active () const { return _flags & Region::FadeOut; }
-       bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
-
-       Curve& fade_in()  { return _fade_in; }
-       Curve& fade_out() { return _fade_out; }
-       Curve& envelope() { return _envelope; }
-
-       nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
-                       nframes_t offset, nframes_t cnt,
-                       uint32_t chan_n=0, double samples_per_unit= 1.0) const;
-
-       virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf,
-                       float *gain_buf, nframes_t position, nframes_t cnt, 
-                       uint32_t       chan_n      = 0,
-                       nframes_t read_frames = 0,
-                       nframes_t skip_frames = 0) const;
-
-       nframes_t master_read_at (Sample *buf, Sample *mixdown_buf, 
-                       float *gain_buf,
-                       nframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
-
-       XMLNode& state (bool);
-       int      set_state (const XMLNode&);
-
-       static void set_default_fade (float steepness, nframes_t len);
-
-       enum FadeShape {
-               Linear,
-               Fast,
-               Slow,
-               LogA,
-               LogB
-       };
+
+       void normalize (float, float target_in_dB = 0.0f);
+       double maximum_amplitude (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; }
+
+       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 frames_per_pixel = 1.0) const;
+
+       /* Readable interface */
+
+       virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
+       virtual framecnt_t readable_length() const { return length(); }
+
+       virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
+                                   framepos_t position,
+                                   framecnt_t cnt,
+                                   uint32_t   chan_n = 0) const;
+
+       virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
+                                          framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
+
+       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);
+
+       void fade_range (framepos_t, framepos_t);
+
+       bool fade_in_is_default () const;
+       bool fade_out_is_default () const;
 
        void set_fade_in_active (bool yn);
        void set_fade_in_shape (FadeShape);
-       void set_fade_in_length (nframes_t);
-       void set_fade_in (FadeShape, nframes_t);
+       void set_fade_in_length (framecnt_t);
+       void set_fade_in (FadeShape, framecnt_t);
+       void set_fade_in (boost::shared_ptr<AutomationList>);
 
        void set_fade_out_active (bool yn);
        void set_fade_out_shape (FadeShape);
-       void set_fade_out_length (nframes_t);
-       void set_fade_out (FadeShape, nframes_t);
+       void set_fade_out_length (framecnt_t);
+       void set_fade_out (FadeShape, framecnt_t);
+       void set_fade_out (boost::shared_ptr<AutomationList>);
 
-       void set_envelope_active (bool yn);
-       void set_default_envelope ();
+       void set_default_fade_in ();
+       void set_default_fade_out ();
 
-       int separate_by_channel (ARDOUR::Session&, vector<boost::shared_ptr<AudioRegion> >&) const;
+       framecnt_t verify_xfade_bounds (framecnt_t, bool start);
 
-       /* filter */
+       void set_envelope_active (bool yn);
+       void set_default_envelope ();
 
-       int apply (AudioFilter&);
+       int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
 
-       /* export */
+       /* automation */
 
-       int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
+       boost::shared_ptr<Evoral::Control>
+       control(const Evoral::Parameter& id, bool create=false) {
+               return _automatable.control(id, create);
+       }
 
-       boost::shared_ptr<Region> get_parent() const;
+       virtual boost::shared_ptr<const Evoral::Control>
+       control(const Evoral::Parameter& id) const {
+               return _automatable.control(id);
+       }
 
        /* xfade/fade interactions */
 
@@ -137,37 +165,50 @@ class AudioRegion : public Region
        void resume_fade_in ();
        void resume_fade_out ();
 
-       void set_playlist (boost::weak_ptr<Playlist>);
+       void add_transient (framepos_t where);
+       void remove_transient (framepos_t where);
+       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, framecnt_t, InterThreadInfo&) const;
 
   private:
        friend class RegionFactory;
 
-       AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length);
-       AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
-       AudioRegion (SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
-       AudioRegion (boost::shared_ptr<const AudioRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
+       AudioRegion (boost::shared_ptr<AudioSource>);
+       AudioRegion (const SourceList &);
        AudioRegion (boost::shared_ptr<const AudioRegion>);
-       AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
-       AudioRegion (SourceList &, const XMLNode&);
+       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 ::AudioRegionReadTest;
+       friend class ::PlaylistReadTest;
+
+       void build_transients ();
+
+       PBD::Property<bool>     _envelope_active;
+       PBD::Property<bool>     _default_fade_in;
+       PBD::Property<bool>     _default_fade_out;
+       PBD::Property<bool>     _fade_in_active;
+       PBD::Property<bool>     _fade_out_active;
+       /** linear gain to apply to the whole region */
+       PBD::Property<gain_t>   _scale_amplitude;
+
+       void register_properties ();
+       void post_set (const PBD::PropertyChange&);
+
+       void init ();
        void set_default_fades ();
-       void set_default_fade_in ();
-       void set_default_fade_out ();
 
        void recompute_gain_at_end ();
        void recompute_gain_at_start ();
 
-       nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer, 
-                                float *gain_buffer, nframes_t position, nframes_t cnt, 
-                                uint32_t chan_n = 0,
-                                nframes_t read_frames = 0,
-                                nframes_t skip_frames = 0) const;
+       framecnt_t read_from_sources (SourceList const &, framecnt_t, Sample *, framepos_t, framecnt_t, uint32_t) const;
 
-       bool verify_start (nframes_t position);
-       bool verify_length (nframes_t position);
-       bool verify_start_mutable (nframes_t& start);
-       bool verify_start_and_length (nframes_t start, nframes_t length);
        void recompute_at_start ();
        void recompute_at_end ();
 
@@ -176,25 +217,27 @@ class AudioRegion : public Region
        void fade_out_changed ();
        void source_offset_changed ();
        void listen_to_my_curves ();
+       void connect_to_analysis_changed ();
+       void connect_to_header_position_offset_changed ();
 
-       void source_deleted ();
-       
-       SourceList        sources;
-       
-       /** Used when timefx are applied, so we can always use the original source. */
-       SourceList        master_sources; 
-
-       mutable Curve     _fade_in;
-       FadeShape         _fade_in_shape;
-       mutable Curve     _fade_out;
-       FadeShape         _fade_out_shape;
-       mutable Curve     _envelope;
-       gain_t            _scale_amplitude;
-       uint32_t          _fade_in_disabled;
-       uint32_t          _fade_out_disabled;
+
+       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:
-       int set_live_state (const XMLNode&, Change&, bool send);
+       /* default constructor for derived (compound) types */
+
+       AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
+
+       int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 };
 
 } /* namespace ARDOUR */
@@ -202,9 +245,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__ */