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 AudioRegionReadTest;
  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         extern PBD::PropertyDescriptor<bool> fade_out_is_xfade;
  50         extern PBD::PropertyDescriptor<bool> fade_out_is_short;
  51         extern PBD::PropertyDescriptor<bool> fade_in_is_xfade;
  52         extern PBD::PropertyDescriptor<bool> fade_in_is_short;
  53         extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_in;
  54         extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_in;
  55         extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > fade_out;
  56         extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > inverse_fade_out;
  57         extern PBD::PropertyDescriptor<boost::shared_ptr<AutomationList> > envelope;
  58 }
  59
  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         bool fade_in_is_xfade() const { return _fade_in_is_xfade; }
  92         void set_fade_in_is_xfade (bool yn);
  93         bool fade_out_is_xfade() const { return _fade_out_is_xfade; }
  94         void set_fade_out_is_xfade (bool yn);
  95
  96         bool fade_in_is_short() const { return _fade_in_is_short; }
  97         void set_fade_in_is_short (bool yn);
  98         bool fade_out_is_short() const { return _fade_out_is_short; }
  99         void set_fade_out_is_short (bool yn);
 100
 101         boost::shared_ptr<AutomationList> fade_in()  { return _fade_in.val (); }
 102         boost::shared_ptr<AutomationList> inverse_fade_in()  { return _inverse_fade_in.val (); }
 103         boost::shared_ptr<AutomationList> fade_out() { return _fade_out.val (); }
 104         boost::shared_ptr<AutomationList> inverse_fade_out()  { return _inverse_fade_out.val (); }
 105         boost::shared_ptr<AutomationList> envelope() { return _envelope.val (); }
 106
 107         Evoral::Range<framepos_t> body_range () const;
 108
 109         virtual framecnt_t read_peaks (PeakData *buf, framecnt_t npeaks,
 110                         framecnt_t offset, framecnt_t cnt,
 111                         uint32_t chan_n=0, double samples_per_unit= 1.0) const;
 112
 113         /* Readable interface */
 114
 115         virtual framecnt_t read (Sample*, framepos_t pos, framecnt_t cnt, int channel) const;
 116         virtual framecnt_t readable_length() const { return length(); }
 117
 118         virtual framecnt_t read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
 119                                     framepos_t position,
 120                                     framecnt_t cnt,
 121                                     uint32_t   chan_n = 0) const;
 122
 123         virtual framecnt_t master_read_at (Sample *buf, Sample *mixdown_buf, float *gain_buf,
 124                                            framepos_t position, framecnt_t cnt, uint32_t chan_n=0) const;
 125
 126         virtual framecnt_t read_raw_internal (Sample*, framepos_t, framecnt_t, int channel) const;
 127
 128         XMLNode& state ();
 129         int set_state (const XMLNode&, int version);
 130
 131         static void set_default_fade (float steepness, framecnt_t len);
 132         bool fade_in_is_default () const;
 133         bool fade_out_is_default () const;
 134
 135         void set_fade_in_active (bool yn);
 136         void set_fade_in_shape (FadeShape);
 137         void set_fade_in_length (framecnt_t);
 138         void set_fade_in (FadeShape, framecnt_t);
 139         void set_fade_in (boost::shared_ptr<AutomationList>);
 140
 141         void set_fade_out_active (bool yn);
 142         void set_fade_out_shape (FadeShape);
 143         void set_fade_out_length (framecnt_t);
 144         void set_fade_out (FadeShape, framecnt_t);
 145         void set_fade_out (boost::shared_ptr<AutomationList>);
 146
 147         void set_default_fade_in ();
 148         void set_default_fade_out ();
 149
 150         framecnt_t verify_xfade_bounds (framecnt_t, bool start);
 151
 152         void set_envelope_active (bool yn);
 153         void set_default_envelope ();
 154
 155         int separate_by_channel (ARDOUR::Session&, std::vector<boost::shared_ptr<Region> >&) const;
 156
 157         /* automation */
 158
 159         boost::shared_ptr<Evoral::Control>
 160         control(const Evoral::Parameter& id, bool create=false) {
 161                 return _automatable.control(id, create);
 162         }
 163
 164         virtual boost::shared_ptr<const Evoral::Control>
 165         control(const Evoral::Parameter& id) const {
 166                 return _automatable.control(id);
 167         }
 168
 169         /* xfade/fade interactions */
 170
 171         void suspend_fade_in ();
 172         void suspend_fade_out ();
 173         void resume_fade_in ();
 174         void resume_fade_out ();
 175
 176         void add_transient (framepos_t where);
 177         void remove_transient (framepos_t where);
 178         int set_transients (AnalysisFeatureList&);
 179         int get_transients (AnalysisFeatureList&, bool force_new = false);
 180         int update_transient (framepos_t old_position, framepos_t new_position);
 181         int adjust_transients (frameoffset_t delta);
 182
 183         AudioIntervalResult find_silence (Sample, framecnt_t, InterThreadInfo&) const;
 184
 185   private:
 186         friend class RegionFactory;
 187
 188         AudioRegion (boost::shared_ptr<AudioSource>);
 189         AudioRegion (const SourceList &);
 190         AudioRegion (boost::shared_ptr<const AudioRegion>);
 191         AudioRegion (boost::shared_ptr<const AudioRegion>, frameoffset_t offset);
 192         AudioRegion (boost::shared_ptr<const AudioRegion>, const SourceList&);
 193         AudioRegion (SourceList &);
 194
 195   private:
 196         friend class ::AudioRegionReadTest;
 197         friend class ::PlaylistReadTest;
 198
 199         PBD::Property<bool>     _envelope_active;
 200         PBD::Property<bool>     _default_fade_in;
 201         PBD::Property<bool>     _default_fade_out;
 202         PBD::Property<bool>     _fade_in_active;
 203         PBD::Property<bool>     _fade_out_active;
 204         /** linear gain to apply to the whole region */
 205         PBD::Property<gain_t>   _scale_amplitude;
 206         PBD::Property<bool>     _fade_in_is_xfade;
 207         PBD::Property<bool>     _fade_out_is_xfade;
 208         PBD::Property<bool>     _fade_in_is_short;
 209         PBD::Property<bool>     _fade_out_is_short;
 210
 211         void register_properties ();
 212         void post_set (const PBD::PropertyChange&);
 213
 214         void init ();
 215         void set_default_fades ();
 216
 217         void recompute_gain_at_end ();
 218         void recompute_gain_at_start ();
 219
 220         framecnt_t read_from_sources (SourceList const &, framecnt_t, Sample *, framepos_t, framecnt_t, uint32_t) const;
 221
 222         void recompute_at_start ();
 223         void recompute_at_end ();
 224
 225         void envelope_changed ();
 226         void fade_in_changed ();
 227         void fade_out_changed ();
 228         void source_offset_changed ();
 229         void listen_to_my_curves ();
 230         void connect_to_analysis_changed ();
 231         void connect_to_header_position_offset_changed ();
 232
 233
 234         AutomationListProperty _fade_in;
 235         AutomationListProperty _inverse_fade_in;
 236         AutomationListProperty _fade_out;
 237         AutomationListProperty _inverse_fade_out;
 238         AutomationListProperty _envelope;
 239         Automatable            _automatable;
 240         uint32_t               _fade_in_suspended;
 241         uint32_t               _fade_out_suspended;
 242
 243         boost::shared_ptr<ARDOUR::Region> get_single_other_xfade_region (bool start) const;
 244
 245   protected:
 246         /* default constructor for derived (compound) types */
 247
 248         AudioRegion (Session& s, framepos_t, framecnt_t, std::string name);
 249
 250         int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 251 };
 252
 253 } /* namespace ARDOUR */
 254
 255 /* access from C objects */
 256
 257 extern "C" {
 258         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);
 259         uint32_t region_length_from_c (void *arg);
 260         uint32_t sourcefile_length_from_c (void *arg, double);
 261 }
 262
 263 #endif /* __ardour_audio_region_h__ */