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