Merge with 2.0-ongoing R3082.
[ardour.git] / libs / ardour / ardour / audioregion.h
index 009aa4b5b0da34b3f1acf55cba17dfa5025c3d1e..e88e10d521a8ae38b641ba2b461ca42f0f6d0ada 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 <ardour/ardour.h>
-#include <ardour/gain.h>
 #include <ardour/region.h>
+#include <ardour/gain.h>
+#include <ardour/logcurve.h>
 #include <ardour/export.h>
 
 class XMLNode;
@@ -38,26 +39,12 @@ namespace ARDOUR {
 class Route;
 class Playlist;
 class Session;
-class AudioFilter;
+class Filter;
 class AudioSource;
 
-struct AudioRegionState : public RegionState 
-{
-    AudioRegionState (std::string why);
-
-    Curve _fade_in;
-    Curve _fade_out;
-    Curve _envelope;
-    gain_t _scale_amplitude;
-    uint32_t _fade_in_disabled;
-    uint32_t _fade_out_disabled;
-};
-
 class AudioRegion : public Region
 {
   public:
-       typedef vector<AudioSource *> SourceList;
-
        static Change FadeInChanged;
        static Change FadeOutChanged;
        static Change FadeInActiveChanged;
@@ -66,100 +53,79 @@ class AudioRegion : public Region
        static Change ScaleAmplitudeChanged;
        static Change EnvelopeChanged;
 
-       AudioRegion (AudioSource&, jack_nframes_t start, jack_nframes_t length, bool announce = true);
-       AudioRegion (AudioSource&, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       AudioRegion (SourceList &, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       AudioRegion (const AudioRegion&, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
-       AudioRegion (const AudioRegion&);
-       AudioRegion (AudioSource&, const XMLNode&);
-       AudioRegion (SourceList &, const XMLNode&);
        ~AudioRegion();
 
-       bool region_list_equivalent (const AudioRegion&) const ;
-       bool source_equivalent (const AudioRegion&) const;
-       bool equivalent (const AudioRegion&) const;
-       bool size_equivalent (const AudioRegion&) const;
-       bool overlap_equivalent (const AudioRegion&) const;
-
        bool speed_mismatch (float) const;
 
-       void lock_sources ();
-       void unlock_sources ();
-       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;
 
-       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_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; }
-
-       jack_nframes_t read_peaks (PeakData *buf, jack_nframes_t npeaks, jack_nframes_t offset, jack_nframes_t cnt, uint32_t chan_n=0, double samples_per_unit= 1.0) const;
-
-       virtual jack_nframes_t read_at (Sample *buf, Sample *mixdown_buffer, 
-                                       float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt, 
-                                       uint32_t chan_n = 0,
-                                       jack_nframes_t read_frames = 0,
-                                       jack_nframes_t skip_frames = 0) const;
 
-       jack_nframes_t master_read_at (Sample *buf, Sample *mixdown_buffer, 
-                                      float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt, uint32_t chan_n=0) const;
+       boost::shared_ptr<AutomationList> fade_in()  { return _fade_in; }
+       boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
+       boost::shared_ptr<AutomationList> envelope() { return _envelope; }
 
+       virtual 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;
+       
+       /* Readable interface */
+       
+       virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const;
+       virtual nframes64_t readable_length() const { return length(); }
+
+       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;
+       
+       virtual 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;
+       
+       virtual nframes_t read_raw_internal (Sample*, nframes_t, nframes_t) const;
 
        XMLNode& state (bool);
-       XMLNode& get_state ();
        int      set_state (const XMLNode&);
 
-       static void set_default_fade (float steepness, jack_nframes_t len);
+       static void set_default_fade (float steepness, nframes_t len);
+       bool fade_in_is_default () const;
+       bool fade_out_is_default () const;
 
        enum FadeShape {
                Linear,
                Fast,
                Slow,
                LogA,
-               LogB,
-
+               LogB
        };
 
        void set_fade_in_active (bool yn);
        void set_fade_in_shape (FadeShape);
-       void set_fade_in_length (jack_nframes_t);
-       void set_fade_in (FadeShape, jack_nframes_t);
+       void set_fade_in_length (nframes_t);
+       void set_fade_in (FadeShape, nframes_t);
 
        void set_fade_out_active (bool yn);
        void set_fade_out_shape (FadeShape);
-       void set_fade_out_length (jack_nframes_t);
-       void set_fade_out (FadeShape, jack_nframes_t);
+       void set_fade_out_length (nframes_t);
+       void set_fade_out (FadeShape, nframes_t);
 
        void set_envelope_active (bool yn);
+       void set_default_envelope ();
 
-       int separate_by_channel (ARDOUR::Session&, vector<AudioRegion*>&) const;
-
-       uint32_t read_data_count() const { return _read_data_count; }
-
-       ARDOUR::Playlist* playlist() const { return _playlist; }
-
-       UndoAction get_memento() const;
-
-       /* filter */
-
-       int apply (AudioFilter&);
+       int separate_by_channel (ARDOUR::Session&, vector<boost::shared_ptr<AudioRegion> >&) const;
 
        /* export */
 
-       int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
-
-       Region* get_parent();
+       int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
 
        /* xfade/fade interactions */
 
@@ -168,55 +134,60 @@ class AudioRegion : public Region
        void resume_fade_in ();
        void resume_fade_out ();
 
-  private:
-       friend class Playlist;
+       int get_transients (AnalysisFeatureList&, bool force_new = false);
 
   private:
-       SourceList        sources;
-       SourceList        master_sources; /* used when timefx are applied, so 
-                                            we can always use the original
-                                            source.
-                                         */
-       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;
+       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 (const 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>, const XMLNode&);
+       AudioRegion (SourceList &, const XMLNode&);
 
+  private:
+       void init ();
        void set_default_fades ();
        void set_default_fade_in ();
        void set_default_fade_out ();
-       void set_default_envelope ();
-
-       StateManager::State* state_factory (std::string why) const;
-       Change restore_state (StateManager::State&);
 
        void recompute_gain_at_end ();
        void recompute_gain_at_start ();
 
-       bool copied() const { return _flags & Copied; }
-       void maybe_uncopy ();
-       void rename_after_first_edit ();
+       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,
+                           bool raw = false) const;
 
-       jack_nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer, 
-                                float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt, 
-                                uint32_t chan_n = 0,
-                                jack_nframes_t read_frames = 0,
-                                jack_nframes_t skip_frames = 0) const;
-
-       bool verify_start (jack_nframes_t position);
-       bool verify_length (jack_nframes_t position);
-       bool verify_start_mutable (jack_nframes_t& start);
-       bool verify_start_and_length (jack_nframes_t start, jack_nframes_t length);
        void recompute_at_start ();
        void recompute_at_end ();
 
-       void envelope_changed (Change);
-
-       void source_deleted (Source*);
+       void envelope_changed ();
+       void fade_in_changed ();
+       void fade_out_changed ();
+       void source_offset_changed ();
+       void listen_to_my_curves ();
+       void listen_to_my_sources ();
+
+       boost::shared_ptr<AutomationList> _fade_in;
+       FadeShape                         _fade_in_shape;
+       boost::shared_ptr<AutomationList> _fade_out;
+       FadeShape                         _fade_out_shape;
+       boost::shared_ptr<AutomationList> _envelope;
+       gain_t                            _scale_amplitude;
+       uint32_t                          _fade_in_disabled;
+       uint32_t                          _fade_out_disabled;
+
+  protected:
+       /* default constructor for derived (compound) types */
+
+       AudioRegion (Session& s, nframes_t, nframes_t, std::string name); 
+       AudioRegion (boost::shared_ptr<const AudioRegion>);
+
+       int set_live_state (const XMLNode&, Change&, bool send);
 };
 
 } /* namespace ARDOUR */