libs/ardour/ardour/audioregion.h

   1 /*
   2     Copyright (C) 2000-2001 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     $Id$
  19 */
  20
  21 #ifndef __ardour_audio_region_h__
  22 #define __ardour_audio_region_h__
  23
  24 #include <vector>
  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 AudioFilter;
  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 source_equivalent (boost::shared_ptr<const Region>) const;
  59
  60         bool speed_mismatch (float) const;
  61
  62         boost::shared_ptr<AudioSource> source (uint32_t n=0) const { if (n < sources.size()) return sources[n]; else return sources[0]; }
  63
  64         void set_scale_amplitude (gain_t);
  65         gain_t scale_amplitude() const { return _scale_amplitude; }
  66
  67         void normalize_to (float target_in_dB = 0.0f);
  68
  69         uint32_t n_channels() { return sources.size(); }
  70         vector<string> master_source_names();
  71
  72         bool envelope_active () const { return _flags & Region::EnvelopeActive; }
  73         bool fade_in_active ()  const { return _flags & Region::FadeIn; }
  74         bool fade_out_active () const { return _flags & Region::FadeOut; }
  75         bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
  76
  77         Curve& fade_in()  { return _fade_in; }
  78         Curve& fade_out() { return _fade_out; }
  79         Curve& envelope() { return _envelope; }
  80
  81         nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
  82                         nframes_t offset, nframes_t cnt,
  83                         uint32_t chan_n=0, double samples_per_unit= 1.0) const;
  84
  85         virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf,
  86                         float *gain_buf, nframes_t position, nframes_t cnt,
  87                         uint32_t       chan_n      = 0,
  88                         nframes_t read_frames = 0,
  89                         nframes_t skip_frames = 0) const;
  90
  91         nframes_t master_read_at (Sample *buf, Sample *mixdown_buf,
  92                         float *gain_buf,
  93                         nframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
  94
  95         XMLNode& state (bool);
  96         int      set_state (const XMLNode&);
  97
  98         static void set_default_fade (float steepness, nframes_t len);
  99
 100         enum FadeShape {
 101                 Linear,
 102                 Fast,
 103                 Slow,
 104                 LogA,
 105                 LogB
 106         };
 107
 108         void set_fade_in_active (bool yn);
 109         void set_fade_in_shape (FadeShape);
 110         void set_fade_in_length (nframes_t);
 111         void set_fade_in (FadeShape, nframes_t);
 112
 113         void set_fade_out_active (bool yn);
 114         void set_fade_out_shape (FadeShape);
 115         void set_fade_out_length (nframes_t);
 116         void set_fade_out (FadeShape, nframes_t);
 117
 118         void set_envelope_active (bool yn);
 119
 120         int separate_by_channel (ARDOUR::Session&, vector<AudioRegion*>&) const;
 121
 122         /* filter */
 123
 124         int apply (AudioFilter&);
 125
 126         /* export */
 127
 128         int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
 129
 130         boost::shared_ptr<Region> get_parent();
 131
 132         /* xfade/fade interactions */
 133
 134         void suspend_fade_in ();
 135         void suspend_fade_out ();
 136         void resume_fade_in ();
 137         void resume_fade_out ();
 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 (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<const AudioRegion>);
 147         AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
 148         AudioRegion (SourceList &, const XMLNode&);
 149
 150   private:
 151         void set_default_fades ();
 152         void set_default_fade_in ();
 153         void set_default_fade_out ();
 154         void set_default_envelope ();
 155
 156         void recompute_gain_at_end ();
 157         void recompute_gain_at_start ();
 158
 159         nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer,
 160                                  float *gain_buffer, nframes_t position, nframes_t cnt,
 161                                  uint32_t chan_n = 0,
 162                                  nframes_t read_frames = 0,
 163                                  nframes_t skip_frames = 0) const;
 164
 165         bool verify_start (nframes_t position);
 166         bool verify_length (nframes_t position);
 167         bool verify_start_mutable (nframes_t& start);
 168         bool verify_start_and_length (nframes_t start, nframes_t length);
 169         void recompute_at_start ();
 170         void recompute_at_end ();
 171
 172         void envelope_changed (Change);
 173         void source_offset_changed ();
 174
 175         void source_deleted ();
 176
 177         SourceList        sources;
 178
 179         /** Used when timefx are applied, so we can always use the original source. */
 180         SourceList        master_sources;
 181
 182         mutable Curve     _fade_in;
 183         FadeShape         _fade_in_shape;
 184         mutable Curve     _fade_out;
 185         FadeShape         _fade_out_shape;
 186         mutable Curve     _envelope;
 187         gain_t            _scale_amplitude;
 188         uint32_t          _fade_in_disabled;
 189         uint32_t          _fade_out_disabled;
 190
 191   protected:
 192         int set_live_state (const XMLNode&, Change&, bool send);
 193 };
 194
 195 } /* namespace ARDOUR */
 196
 197 /* access from C objects */
 198
 199 extern "C" {
 200         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);
 201         uint32_t region_length_from_c (void *arg);
 202         uint32_t sourcefile_length_from_c (void *arg, double);
 203 }
 204
 205 #endif /* __ardour_audio_region_h__ */