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.h"
  31 #include "ardour/gain.h"
  32 #include "ardour/logcurve.h"
  33 #include "ardour/region.h"
  34
  35 class XMLNode;
  36
  37
  38 namespace ARDOUR {
  39
  40 namespace Properties {
  41         extern PBD::PropertyDescriptor<bool> envelope_active;
  42         extern PBD::PropertyDescriptor<bool> default_fade_in;
  43         extern PBD::PropertyDescriptor<bool> default_fade_out;
  44         extern PBD::PropertyDescriptor<bool> fade_in_active;
  45         extern PBD::PropertyDescriptor<bool> fade_out_active;
  46         extern PBD::PropertyDescriptor<float> scale_amplitude;
  47
  48         /* the envelope and fades are not scalar items and so
  49            currently (2010/02) are not stored using Property.
  50            However, these descriptors enable us to notify
  51            about changes to them via PropertyChange.
  52         */
  53
  54         extern PBD::PropertyDescriptor<bool> envelope;
  55         extern PBD::PropertyDescriptor<bool> fade_in;
  56         extern PBD::PropertyDescriptor<bool> fade_out;
  57 }
  58
  59 class Route;
  60 class Playlist;
  61 class Session;
  62 class Filter;
  63 class AudioSource;
  64
  65
  66 class AudioRegion : public Region
  67 {
  68   public:
  69         static void make_property_quarks ();
  70
  71         ~AudioRegion();
  72
  73         void copy_settings (boost::shared_ptr<const AudioRegion>);
  74
  75         bool source_equivalent (boost::shared_ptr<const Region>) const;
  76
  77         bool speed_mismatch (float) const;
  78
  79         boost::shared_ptr<AudioSource> audio_source (uint32_t n=0) const;
  80
  81         void   set_scale_amplitude (gain_t);
  82         gain_t scale_amplitude() const { return _scale_amplitude; }
  83
  84         void normalize (float, float target_in_dB = 0.0f);
  85         double maximum_amplitude (Progress* p = 0) const;
  86
  87         bool envelope_active () const { return _envelope_active; }
  88         bool fade_in_active ()  const { return _fade_in_active; }
  89         bool fade_out_active () const { return _fade_out_active; }
  90
  91         boost::shared_ptr<AutomationList> fade_in()  { return _fade_in; }
  92         boost::shared_ptr<AutomationList> fade_out() { return _fade_out; }
  93         boost::shared_ptr<AutomationList> envelope() { return _envelope; }
  94
  95         virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
  96                         framecnt_t offset, framecnt_t cnt,
  97                         uint32_t chan_n=0, double samples_per_unit= 1.0) const;
  98
  99         /* Readable interface */
 100
 101         enum ReadOps {
 102                 ReadOpsNone = 0x0,
 103                 ReadOpsOwnAutomation = 0x1,
 104                 ReadOpsOwnScaling = 0x2,
 105                 ReadOpsCount = 0x4,
 106                 ReadOpsFades = 0x8
 107         };
 108
 109         virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
 110         virtual framecnt_t readable_length() const { return length(); }
 111
 112         virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
 113                                     framepos_t position,
 114                                     framecnt_t cnt,
 115                                     uint32_t   chan_n = 0) const;
 116
 117         virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
 118                                            framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
 119
 120         virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
 121
 122         XMLNode& state ();
 123         int set_state (const XMLNode&, int version);
 124
 125         static void set_default_fade (float steepness, framecnt_t len);
 126         bool fade_in_is_default () const;
 127         bool fade_out_is_default () const;
 128
 129         void set_fade_in_active (bool yn);
 130         void set_fade_in_shape (FadeShape);
 131         void set_fade_in_length (framecnt_t);
 132         void set_fade_in (FadeShape, framecnt_t);
 133         void set_fade_in (boost::shared_ptr<AutomationList>);
 134
 135         void set_fade_out_active (bool yn);
 136         void set_fade_out_shape (FadeShape);
 137         void set_fade_out_length (framecnt_t);
 138         void set_fade_out (FadeShape, framecnt_t);
 139         void set_fade_out (boost::shared_ptr<AutomationList>);
 140
 141         void set_envelope_active (bool yn);
 142         void set_default_envelope ();
 143
 144         int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
 145
 146         /* automation */
 147
 148         boost::shared_ptr<Evoral::Control>
 149         control(const Evoral::Parameter& id, bool create=false) {
 150                 return _automatable.control(id, create);
 151         }
 152
 153         virtual boost::shared_ptr<const Evoral::Control>
 154         control(const Evoral::Parameter& id) const {
 155                 return _automatable.control(id);
 156         }
 157
 158         /* export */
 159
 160         int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&);
 161
 162         /* xfade/fade interactions */
 163
 164         void suspend_fade_in ();
 165         void suspend_fade_out ();
 166         void resume_fade_in ();
 167         void resume_fade_out ();
 168
 169         void add_transient (framepos_t where);
 170         void remove_transient (framepos_t where);
 171         int set_transients (AnalysisFeatureList&);
 172         int get_transients (AnalysisFeatureList&, bool force_new = false);
 173         int update_transient (framepos_t old_position, framepos_t new_position);
 174         int adjust_transients (framepos_t delta);
 175
 176         AudioIntervalResult find_silence (Sample, framecnt_t, InterThreadInfo&) const;
 177
 178   private:
 179         friend class RegionFactory;
 180         friend class Crossfade;
 181
 182         AudioRegion (boost::shared_ptr<AudioSource>);
 183         AudioRegion (const SourceList &);
 184         AudioRegion (boost::shared_ptr<const AudioRegion>);
 185         AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset);
 186         AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
 187         AudioRegion (SourceList &);
 188
 189   private:
 190         PBD::Property<bool>     _envelope_active;
 191         PBD::Property<bool>     _default_fade_in;
 192         PBD::Property<bool>     _default_fade_out;
 193         PBD::Property<bool>     _fade_in_active;
 194         PBD::Property<bool>     _fade_out_active;
 195         /** linear gain to apply to the whole region */
 196         PBD::Property<gain_t>   _scale_amplitude;
 197
 198         void register_properties ();
 199         void post_set (const PBD::PropertyChange&);
 200
 201         void init ();
 202         void set_default_fades ();
 203         void set_default_fade_in ();
 204         void set_default_fade_out ();
 205
 206         void recompute_gain_at_end ();
 207         void recompute_gain_at_start ();
 208
 209         framecnt_t _read_at (const SourceList&, framecnt_t limit,
 210                              Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
 211                              framepos_t position, framecnt_t cnt,
 212                              uint32_t chan_n = 0,
 213                              ReadOps readops = ReadOps (~0)) const;
 214
 215         void recompute_at_start ();
 216         void recompute_at_end ();
 217
 218         void envelope_changed ();
 219         void fade_in_changed ();
 220         void fade_out_changed ();
 221         void source_offset_changed ();
 222         void listen_to_my_curves ();
 223         void connect_to_analysis_changed ();
 224         void connect_to_header_position_offset_changed ();
 225
 226         Automatable _automatable;
 227
 228         boost::shared_ptr<AutomationList> _fade_in;
 229         boost::shared_ptr<AutomationList> _fade_out;
 230         boost::shared_ptr<AutomationList> _envelope;
 231         uint32_t                          _fade_in_suspended;
 232         uint32_t                          _fade_out_suspended;
 233
 234   protected:
 235         /* default constructor for derived (compound) types */
 236
 237         AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
 238
 239         int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 240 };
 241
 242 } /* namespace ARDOUR */
 243
 244 /* access from C objects */
 245
 246 extern "C" {
 247         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);
 248         uint32_t region_length_from_c (void *arg);
 249         uint32_t sourcefile_length_from_c (void *arg, double);
 250 }
 251
 252 #endif /* __ardour_audio_region_h__ */