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