Remove stub class.
[ardour.git] / libs / ardour / ardour / audioregion.h
index d7bb0c916b3734bf0ebac9005fa22bc1c487c110..6a91790e9752d82c3c1bbee8c9fe90cf55ab73f6 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/gain.h>
-#include <ardour/region.h>
-#include <ardour/export.h>
+#include "ardour/ardour.h"
+#include "ardour/automatable.h"
+#include "ardour/gain.h"
+#include "ardour/logcurve.h"
+#include "ardour/region.h"
 
 class XMLNode;
 
+
 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;
+       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;
+}
+
 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;
-       static Change FadeOutActiveChanged;
-       static Change EnvelopeActiveChanged;
-       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&);
+       static void make_property_quarks ();
+
        ~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;
+       void copy_settings (boost::shared_ptr<const AudioRegion>);
+
+       bool source_equivalent (boost::shared_ptr<const Region>) 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_out_active () const { return _flags & Region::FadeOut; }
-       bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
+       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; }
 
-       Curve& fade_in()  { return _fade_in; }
-       Curve& fade_out() { return _fade_out; }
-       Curve& envelope() { return _envelope; }
+       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; }
 
-       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 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 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;
+       /* Readable interface */
 
-       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;
+       enum ReadOps {
+               ReadOpsNone = 0x0,
+               ReadOpsOwnAutomation = 0x1,
+               ReadOpsOwnScaling = 0x2,
+               ReadOpsCount = 0x4,
+               ReadOpsFades = 0x8
+       };
 
+       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,
+                                    framecnt_t read_frames = 0,
+                                    framecnt_t skip_frames = 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 (bool);
-       XMLNode& get_state ();
-       int      set_state (const XMLNode&);
+       int set_state (const XMLNode&, int version);
 
-       static void set_default_fade (float steepness, jack_nframes_t len);
+       static void set_default_fade (float steepness, framecnt_t len);
+       bool fade_in_is_default () const;
+       bool fade_out_is_default () const;
 
        enum FadeShape {
                Linear,
@@ -132,33 +138,36 @@ class AudioRegion : public Region
 
        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 (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 (jack_nframes_t);
-       void set_fade_out (FadeShape, jack_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 ();
 
-       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; }
+       int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
 
-       UndoAction get_memento() const;
+       /* automation */
 
-       /* filter */
+       boost::shared_ptr<Evoral::Control>
+       control(const Evoral::Parameter& id, bool create=false) {
+               return _automatable.control(id, create);
+       }
 
-       int apply (AudioFilter&);
+       virtual boost::shared_ptr<const Evoral::Control>
+       control(const Evoral::Parameter& id) const {
+               return _automatable.control(id);
+       }
 
        /* export */
 
-       int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
-
-       Region* get_parent();
+       int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
 
        /* xfade/fade interactions */
 
@@ -167,55 +176,77 @@ class AudioRegion : public Region
        void resume_fade_in ();
        void resume_fade_out ();
 
+       void add_transient (nframes64_t where);
+       void remove_transient (nframes64_t where);
+       int set_transients (AnalysisFeatureList&);
+       int get_transients (AnalysisFeatureList&, bool force_new = false);
+       int update_transient (nframes64_t old_position, nframes64_t new_position);
+       int adjust_transients (nframes64_t delta);
+
+       std::list<std::pair<frameoffset_t, framecnt_t> > find_silence (Sample, framecnt_t, InterThreadInfo&) const;
+
   private:
-       friend class Playlist;
+       friend class RegionFactory;
+       friend class Crossfade;
+
+       AudioRegion (boost::shared_ptr<AudioSource>);
+       AudioRegion (const SourceList &);
+       AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset = 0, bool offset_relative = true);
+       AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
+       AudioRegion (SourceList &);
 
   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;
+       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;
+       PBD::Property<gain_t>   _scale_amplitude;
+       
+       void register_properties ();
+       void post_set ();
 
+       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 ();
+       framecnt_t _read_at (const SourceList&, framecnt_t limit,
+                            Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
+                            framepos_t position, framecnt_t cnt,
+                            uint32_t chan_n = 0,
+                            framecnt_t read_frames = 0,
+                            framecnt_t skip_frames = 0,
+                            ReadOps readops = ReadOps (~0)) 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 envelope_changed ();
+       void fade_in_changed ();
+       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 ();
+
+       Automatable _automatable;
+
+       boost::shared_ptr<AutomationList> _fade_in;
+       boost::shared_ptr<AutomationList> _fade_out;
+       boost::shared_ptr<AutomationList> _envelope;
+       uint32_t                          _fade_in_suspended;
+       uint32_t                          _fade_out_suspended;
+
+  protected:
+       /* default constructor for derived (compound) types */
+
+       AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
 
-       void source_deleted (Source*);
+       int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 };
 
 } /* namespace ARDOUR */