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/automatable_controls.h"
  31 #include "ardour/gain.h"
  32 #include "ardour/logcurve.h"
  33 #include "ardour/region.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         void copy_settings (boost::shared_ptr<const AudioRegion>);
  59
  60         bool source_equivalent (boost::shared_ptr<const Region>) const;
  61
  62         bool speed_mismatch (float) const;
  63
  64         boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
  65
  66         void   set_scale_amplitude (gain_t);
  67         gain_t scale_amplitude() const { return _scale_amplitude; }
  68
  69         void normalize_to (float target_in_dB = 0.0f);
  70
  71         bool envelope_active () const { return _flags & Region::EnvelopeActive; }
  72         bool fade_in_active ()  const { return _flags & Region::FadeIn; }
  73         bool fade_out_active () const { return _flags & Region::FadeOut; }
  74
  75         boost::shared_ptr<AutomationList> fade_in()  { return _fade_in; }
  76         boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
  77         boost::shared_ptr<AutomationList> envelope() { return _envelope; }
  78
  79         virtual nframes_t read_peaks (PeakData *buf, nframes_t npeaks,
  80                         nframes_t offset, nframes_t cnt,
  81                         uint32_t chan_n=0, double samples_per_unit= 1.0) const;
  82
  83         /* Readable interface */
  84
  85         enum ReadOps {
  86                 ReadOpsNone = 0x0,
  87                 ReadOpsOwnAutomation = 0x1,
  88                 ReadOpsOwnScaling = 0x2,
  89                 ReadOpsCount = 0x4,
  90                 ReadOpsFades = 0x8
  91         };
  92
  93         virtual nframes_t read (Sample*, sframes_t pos, nframes_t cnt, int channel) const;
  94         virtual nframes_t read_with_ops (Sample*, sframes_t pos, nframes_t cnt, int channel, ReadOps rops) const;
  95         virtual nframes64_t readable_length() const { return length(); }
  96
  97         virtual nframes_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
  98                         sframes_t position,
  99                         nframes_t cnt,
 100                         uint32_t  chan_n      = 0,
 101                         nframes_t read_frames = 0,
 102                         nframes_t skip_frames = 0) const;
 103
 104         virtual nframes_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
 105                         sframes_t position, nframes_t cnt, uint32_t chan_n=0) const;
 106
 107         virtual nframes_t read_raw_internal (Sample*, sframes_t, nframes_t, int channel) const;
 108
 109         XMLNode& state (bool);
 110         int      set_state (const XMLNode&, int version);
 111
 112         static void set_default_fade (float steepness, nframes_t len);
 113         bool fade_in_is_default () const;
 114         bool fade_out_is_default () const;
 115
 116         enum FadeShape {
 117                 Linear,
 118                 Fast,
 119                 Slow,
 120                 LogA,
 121                 LogB
 122         };
 123
 124         void set_fade_in_active (bool yn);
 125         void set_fade_in_shape (FadeShape);
 126         void set_fade_in_length (nframes_t);
 127         void set_fade_in (FadeShape, nframes_t);
 128
 129         void set_fade_out_active (bool yn);
 130         void set_fade_out_shape (FadeShape);
 131         void set_fade_out_length (nframes_t);
 132         void set_fade_out (FadeShape, nframes_t);
 133
 134         void set_envelope_active (bool yn);
 135         void set_default_envelope ();
 136
 137         int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
 138
 139         /* automation */
 140
 141         boost::shared_ptr<Evoral::Control>
 142         control(const Evoral::Parameter& id, bool create=false) {
 143                 return _automatable.data().control(id, create);
 144         }
 145
 146         virtual boost::shared_ptr<const Evoral::Control>
 147         control(const Evoral::Parameter& id) const {
 148                 return _automatable.data().control(id);
 149         }
 150
 151         /* export */
 152
 153         int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
 154
 155         /* xfade/fade interactions */
 156
 157         void suspend_fade_in ();
 158         void suspend_fade_out ();
 159         void resume_fade_in ();
 160         void resume_fade_out ();
 161
 162         int get_transients (AnalysisFeatureList&, bool force_new = false);
 163         std::list<std::pair<nframes_t, nframes_t> > find_silence (Sample, nframes_t) const;
 164
 165   private:
 166         friend class RegionFactory;
 167         friend class Crossfade;
 168
 169         AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length);
 170         AudioRegion (boost::shared_ptr<AudioSource>, nframes_t start, nframes_t length, const std::string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 171         AudioRegion (const SourceList &, nframes_t start, nframes_t length, const std::string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 172         AudioRegion (boost::shared_ptr<const AudioRegion>, nframes_t start, nframes_t length, const std::string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 173         AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&, nframes_t length, const std::string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags);
 174         AudioRegion (boost::shared_ptr<const AudioRegion>);
 175         AudioRegion (boost::shared_ptr<AudioSource>, const XMLNode&);
 176         AudioRegion (SourceList &, const XMLNode&);
 177
 178   private:
 179         void init ();
 180         void set_default_fades ();
 181         void set_default_fade_in ();
 182         void set_default_fade_out ();
 183
 184         void recompute_gain_at_end ();
 185         void recompute_gain_at_start ();
 186
 187         nframes_t _read_at (const SourceList&, nframes_t limit,
 188                         Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
 189                         sframes_t position, nframes_t cnt,
 190                         uint32_t chan_n = 0,
 191                         nframes_t read_frames = 0,
 192                         nframes_t skip_frames = 0,
 193                         ReadOps readops = ReadOps (~0)) const;
 194
 195         void recompute_at_start ();
 196         void recompute_at_end ();
 197
 198         void envelope_changed ();
 199         void fade_in_changed ();
 200         void fade_out_changed ();
 201         void source_offset_changed ();
 202         void listen_to_my_curves ();
 203         void connect_to_analysis_changed ();
 204         void connect_to_header_position_offset_changed ();
 205
 206         AutomatableControls _automatable;
 207
 208         boost::shared_ptr<AutomationList> _fade_in;
 209         FadeShape                         _fade_in_shape;
 210         boost::shared_ptr<AutomationList> _fade_out;
 211         FadeShape                         _fade_out_shape;
 212         boost::shared_ptr<AutomationList> _envelope;
 213         gain_t                            _scale_amplitude;
 214         uint32_t                          _fade_in_disabled;
 215         uint32_t                          _fade_out_disabled;
 216
 217   protected:
 218         /* default constructor for derived (compound) types */
 219
 220         AudioRegion (Session& s, nframes_t, nframes_t, std::string name);
 221
 222         int set_live_state (const XMLNode&, int version, Change&, bool send);
 223 };
 224
 225 } /* namespace ARDOUR */
 226
 227 /* access from C objects */
 228
 229 extern "C" {
 230         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);
 231         uint32_t region_length_from_c (void *arg);
 232         uint32_t sourcefile_length_from_c (void *arg, double);
 233 }
 234
 235 #endif /* __ardour_audio_region_h__ */