libs/ardour/ardour/audioregion.h

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_audio_region_h__
  21 #define __ardour_audio_region_h__
  22
  23 #include <vector>
  24 #include <list>
  25
  26 #include <pbd/fastlog.h>
  27 #include <pbd/undo.h>
  28
  29 #include <ardour/ardour.h>
  30 #include <ardour/region.h>
  31 #include <ardour/gain.h>
  32 #include <ardour/logcurve.h>
  33 #include <ardour/export.h>
  34
  35 class XMLNode;
  36
  37 namespace ARDOUR {
  38
  39 class Route;
  40 class Playlist;
  41 class Session;
  42 class Filter;
  43 class AudioSource;
  44
  45 class AudioRegion : public Region
  46 {
  47   public:
  48         static Change FadeInChanged;
  49         static Change FadeOutChanged;
  50         static Change FadeInActiveChanged;
  51         static Change FadeOutActiveChanged;
  52         static Change EnvelopeActiveChanged;
  53         static Change ScaleAmplitudeChanged;
  54         static Change EnvelopeChanged;
  55
  56         ~AudioRegion();
  57
  58         bool speed_mismatch (float) const;
  59
  60         boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
  61
  62         void   set_scale_amplitude (gain_t);
  63         gain_t scale_amplitude() const { return _scale_amplitude; }
  64
  65         void normalize_to (float target_in_dB = 0.0f);
  66
  67         bool envelope_active () const { return _flags & Region::EnvelopeActive; }
  68         bool fade_in_active ()  const { return _flags & Region::FadeIn; }
  69         bool fade_out_active () const { return _flags & Region::FadeOut; }
  70
  71         boost::shared_ptr<AutomationList> fade_in()  { return _fade_in; }
  72         boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
  73         boost::shared_ptr<AutomationList> envelope() { return _envelope; }
  74
  75         virtual nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
  76                                       nframes_t offset, nframes_t cnt,
  77                                       uint32_t chan_n=0, double samples_per_unit= 1.0) const;
  78
  79         /* Readable interface */
  80
  81         virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const;
  82         virtual nframes64_t readable_length() const { return length(); }
  83
  84         virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf,
  85                         float *gain_buf, nframes_t position, nframes_t cnt,
  86                         uint32_t  chan_n      = 0,
  87                         nframes_t read_frames = 0,
  88                         nframes_t skip_frames = 0) const;
  89
  90         virtual nframes_t master_read_at (Sample *buf, Sample *mixdown_buf,
  91                                           float *gain_buf,
  92                                           nframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
  93
  94         virtual nframes_t read_raw_internal (Sample*, nframes_t, nframes_t) const;
  95
  96         XMLNode& state (bool);
  97         int      set_state (const XMLNode&);
  98
  99         static void set_default_fade (float steepness, nframes_t len);
 100         bool fade_in_is_default () const;
 101         bool fade_out_is_default () const;
 102
 103         enum FadeShape {
 104                 Linear,
 105                 Fast,
 106                 Slow,
 107                 LogA,
 108                 LogB
 109         };
 110
 111         void set_fade_in_active (bool yn);
 112         void set_fade_in_shape (FadeShape);
 113         void set_fade_in_length (nframes_t);
 114         void set_fade_in (FadeShape, nframes_t);
 115
 116         void set_fade_out_active (bool yn);
 117         void set_fade_out_shape (FadeShape);
 118         void set_fade_out_length (nframes_t);
 119         void set_fade_out (FadeShape, nframes_t);
 120
 121         void set_envelope_active (bool yn);
 122         void set_default_envelope ();
 123
 124         int separate_by_channel (ARDOUR::Session&, vector<boost::shared_ptr<AudioRegion> >&) const;
 125
 126         /* export */
 127
 128         int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
 129
 130         /* xfade/fade interactions */
 131
 132         void suspend_fade_in ();
 133         void suspend_fade_out ();
 134         void resume_fade_in ();
 135         void resume_fade_out ();
 136
 137         int get_transients (AnalysisFeatureList&, bool force_new = false);
 138
 139   private:
 140         friend class RegionFactory;
 141
 142         AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length);
 143         AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 144         AudioRegion (const SourceList &, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 145         AudioRegion (boost::shared_ptr<const AudioRegion>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 146         AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
 147         AudioRegion (SourceList &, const XMLNode&);
 148
 149   private:
 150         void init ();
 151         void set_default_fades ();
 152         void set_default_fade_in ();
 153         void set_default_fade_out ();
 154
 155         void recompute_gain_at_end ();
 156         void recompute_gain_at_start ();
 157
 158         nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer,
 159                             float *gain_buffer, nframes_t position, nframes_t cnt,
 160                             uint32_t chan_n = 0,
 161                             nframes_t read_frames = 0,
 162                             nframes_t skip_frames = 0,
 163                             bool raw = false) const;
 164
 165         void recompute_at_start ();
 166         void recompute_at_end ();
 167
 168         void envelope_changed ();
 169         void fade_in_changed ();
 170         void fade_out_changed ();
 171         void source_offset_changed ();
 172         void listen_to_my_curves ();
 173         void listen_to_my_sources ();
 174
 175         boost::shared_ptr<AutomationList> _fade_in;
 176         FadeShape                         _fade_in_shape;
 177         boost::shared_ptr<AutomationList> _fade_out;
 178         FadeShape                         _fade_out_shape;
 179         boost::shared_ptr<AutomationList> _envelope;
 180         gain_t                            _scale_amplitude;
 181         uint32_t                          _fade_in_disabled;
 182         uint32_t                          _fade_out_disabled;
 183
 184   protected:
 185         /* default constructor for derived (compound) types */
 186
 187         AudioRegion (Session& s, nframes_t, nframes_t, std::string name);
 188         AudioRegion (boost::shared_ptr<const AudioRegion>);
 189
 190         int set_live_state (const XMLNode&, Change&, bool send);
 191 };
 192
 193 } /* namespace ARDOUR */
 194
 195 /* access from C objects */
 196
 197 extern "C" {
 198         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);
 199         uint32_t region_length_from_c (void *arg);
 200         uint32_t sourcefile_length_from_c (void *arg, double);
 201 }
 202
 203 #endif /* __ardour_audio_region_h__ */