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/source.h>
  31 #include <ardour/gain.h>
  32 #include <ardour/region.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
  44 struct AudioRegionState : public RegionState
  45 {
  46     AudioRegionState (std::string why);
  47
  48     Curve _fade_in;
  49     Curve _fade_out;
  50     Curve _envelope;
  51     gain_t _scale_amplitude;
  52     uint32_t _fade_in_disabled;
  53     uint32_t _fade_out_disabled;
  54 };
  55
  56 class AudioRegion : public Region
  57 {
  58   public:
  59         typedef vector<Source *> SourceList;
  60
  61         static Change FadeInChanged;
  62         static Change FadeOutChanged;
  63         static Change FadeInActiveChanged;
  64         static Change FadeOutActiveChanged;
  65         static Change EnvelopeActiveChanged;
  66         static Change ScaleAmplitudeChanged;
  67         static Change EnvelopeChanged;
  68
  69         AudioRegion (Source&, jack_nframes_t start, jack_nframes_t length, bool announce = true);
  70         AudioRegion (Source&, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
  71         AudioRegion (SourceList &, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Region::Flag flags = Region::DefaultFlags, bool announce = true);
  72         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);
  73         AudioRegion (const AudioRegion&);
  74         AudioRegion (Source&, const XMLNode&);
  75         AudioRegion (SourceList &, const XMLNode&);
  76         ~AudioRegion();
  77
  78         bool region_list_equivalent (const AudioRegion&);
  79         bool source_equivalent (const AudioRegion&);
  80         bool equivalent (const AudioRegion&);
  81         bool size_equivalent (const AudioRegion&);
  82
  83         void lock_sources ();
  84         void unlock_sources ();
  85         Source& source (uint32_t n=0) const { if (n < sources.size()) return *sources[n]; else return *sources[0]; }
  86
  87         void set_scale_amplitude (gain_t);
  88         gain_t scale_amplitude() const { return _scale_amplitude; }
  89
  90         void normalize_to (float target_in_dB = 0.0f);
  91
  92         uint32_t n_channels() { return sources.size(); }
  93         vector<string> master_source_names();
  94
  95         bool envelope_active () const { return _flags & Region::EnvelopeActive; }
  96         bool fade_in_active () const { return _flags & Region::FadeIn; }
  97         bool fade_out_active () const { return _flags & Region::FadeOut; }
  98         bool captured() const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
  99
 100         Curve& fade_in()  { return _fade_in; }
 101         Curve& fade_out() { return _fade_out; }
 102         Curve& envelope() { return _envelope; }
 103
 104         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;
 105
 106         virtual jack_nframes_t read_at (Sample *buf, Sample *mixdown_buffer,
 107                                         float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt,
 108                                         uint32_t chan_n = 0,
 109                                         jack_nframes_t read_frames = 0,
 110                                         jack_nframes_t skip_frames = 0) const;
 111
 112         jack_nframes_t master_read_at (Sample *buf, Sample *mixdown_buffer,
 113                                        float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt, uint32_t chan_n=0) const;
 114
 115
 116         XMLNode& state (bool);
 117         XMLNode& get_state ();
 118         int      set_state (const XMLNode&);
 119
 120         static void set_default_fade (float steepness, jack_nframes_t len);
 121
 122         enum FadeShape {
 123                 Linear,
 124                 Fast,
 125                 Slow,
 126                 LogA,
 127                 LogB,
 128
 129         };
 130
 131         void set_fade_in_active (bool yn);
 132         void set_fade_in_shape (FadeShape);
 133         void set_fade_in_length (jack_nframes_t);
 134         void set_fade_in (FadeShape, jack_nframes_t);
 135
 136         void set_fade_out_active (bool yn);
 137         void set_fade_out_shape (FadeShape);
 138         void set_fade_out_length (jack_nframes_t);
 139         void set_fade_out (FadeShape, jack_nframes_t);
 140
 141         void set_envelope_active (bool yn);
 142
 143         int separate_by_channel (ARDOUR::Session&, vector<AudioRegion*>&) const;
 144
 145         uint32_t read_data_count() const { return _read_data_count; }
 146
 147         ARDOUR::Playlist* playlist() const { return _playlist; }
 148
 149         UndoAction get_memento() const;
 150
 151         /* filter */
 152
 153         int apply (AudioFilter&);
 154
 155         /* export */
 156
 157         int exportme (ARDOUR::Session&, ARDOUR::AudioExportSpecification&);
 158
 159         Region* get_parent();
 160
 161         /* xfade/fade interactions */
 162
 163         void suspend_fade_in ();
 164         void suspend_fade_out ();
 165         void resume_fade_in ();
 166         void resume_fade_out ();
 167
 168   private:
 169         friend class Playlist;
 170
 171   private:
 172         SourceList        sources;
 173         SourceList        master_sources; /* used when timefx are applied, so
 174                                              we can always use the original
 175                                              source.
 176                                           */
 177         mutable Curve     _fade_in;
 178         FadeShape         _fade_in_shape;
 179         mutable Curve     _fade_out;
 180         FadeShape         _fade_out_shape;
 181         mutable Curve     _envelope;
 182         gain_t            _scale_amplitude;
 183         uint32_t          _fade_in_disabled;
 184         uint32_t          _fade_out_disabled;
 185
 186         void set_default_fades ();
 187         void set_default_fade_in ();
 188         void set_default_fade_out ();
 189         void set_default_envelope ();
 190
 191         StateManager::State* state_factory (std::string why) const;
 192         Change restore_state (StateManager::State&);
 193
 194         void recompute_gain_at_end ();
 195         void recompute_gain_at_start ();
 196
 197         bool copied() const { return _flags & Copied; }
 198         void maybe_uncopy ();
 199         void rename_after_first_edit ();
 200
 201         jack_nframes_t _read_at (const SourceList&, Sample *buf, Sample *mixdown_buffer,
 202                                  float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt,
 203                                  uint32_t chan_n = 0,
 204                                  jack_nframes_t read_frames = 0,
 205                                  jack_nframes_t skip_frames = 0) const;
 206
 207         bool verify_start (jack_nframes_t position);
 208         bool verify_length (jack_nframes_t position);
 209         bool verify_start_mutable (jack_nframes_t& start);
 210         bool verify_start_and_length (jack_nframes_t start, jack_nframes_t length);
 211         void recompute_at_start ();
 212         void recompute_at_end ();
 213
 214         void envelope_changed (Change);
 215
 216         void source_deleted (Source*);
 217 };
 218
 219 } /* namespace ARDOUR */
 220
 221 /* access from C objects */
 222
 223 extern "C" {
 224         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);
 225         uint32_t region_length_from_c (void *arg);
 226         uint32_t sourcefile_length_from_c (void *arg, double);
 227 }
 228
 229 #endif /* __ardour_audio_region_h__ */