libs/ardour/ardour/crossfade.h

   1 /*
   2     Copyright (C) 2000 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_overlap_h__
  22 #define __ardour_overlap_h__
  23
  24 #include <vector>
  25 #include <algorithm>
  26 #include <boost/shared_ptr.hpp>
  27
  28 #include <sigc++/signal.h>
  29
  30 #include <pbd/undo.h>
  31 #include <pbd/statefuldestructible.h>
  32
  33 #include <ardour/ardour.h>
  34 #include <ardour/curve.h>
  35 #include <ardour/audioregion.h>
  36 #include <ardour/crossfade_compare.h>
  37
  38 namespace ARDOUR {
  39
  40 class AudioRegion;
  41 class Playlist;
  42
  43 class Crossfade : public PBD::StatefulDestructible
  44 {
  45   public:
  46
  47         class NoCrossfadeHere: std::exception {
  48           public:
  49                 virtual const char *what() const throw() { return "no crossfade should be constructed here"; }
  50         };
  51
  52         /* constructor for "fixed" xfades at each end of an internal overlap */
  53
  54         Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out,
  55                    nframes_t position,
  56                    nframes_t initial_length,
  57                    AnchorPoint);
  58
  59         /* constructor for xfade between two regions that are overlapped in any way
  60            except the "internal" case.
  61         */
  62
  63         Crossfade (boost::shared_ptr<ARDOUR::AudioRegion> in, boost::shared_ptr<ARDOUR::AudioRegion> out, CrossfadeModel, bool active);
  64
  65
  66         /* copy constructor to copy a crossfade with new regions. used (for example)
  67            when a playlist copy is made */
  68         Crossfade (const Crossfade &, boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>);
  69
  70         /* the usual XML constructor */
  71
  72         Crossfade (const ARDOUR::Playlist&, XMLNode&);
  73         virtual ~Crossfade();
  74
  75         bool operator== (const ARDOUR::Crossfade&);
  76
  77         XMLNode& get_state (void);
  78         int set_state (const XMLNode&);
  79
  80         boost::shared_ptr<ARDOUR::AudioRegion> in() const { return _in; }
  81         boost::shared_ptr<ARDOUR::AudioRegion> out() const { return _out; }
  82
  83         nframes_t read_at (Sample *buf, Sample *mixdown_buffer,
  84                                 float *gain_buffer, nframes_t position, nframes_t cnt,
  85                                 uint32_t chan_n,
  86                                 nframes_t read_frames = 0,
  87                                 nframes_t skip_frames = 0);
  88
  89         bool refresh ();
  90
  91         uint32_t upper_layer () const {
  92                 return std::max (_in->layer(), _out->layer());
  93         }
  94
  95         uint32_t lower_layer () const {
  96                 return std::min (_in->layer(), _out->layer());
  97         }
  98
  99         bool involves (boost::shared_ptr<ARDOUR::AudioRegion> region) const {
 100                 return _in == region || _out == region;
 101         }
 102
 103         bool involves (boost::shared_ptr<ARDOUR::AudioRegion> a, boost::shared_ptr<ARDOUR::AudioRegion> b) const {
 104                 return (_in == a && _out == b) || (_in == b && _out == a);
 105         }
 106
 107         nframes_t length() const { return _length; }
 108         nframes_t overlap_length() const;
 109         nframes_t position() const { return _position; }
 110
 111         void invalidate();
 112
 113         sigc::signal<void,Crossfade*> Invalidated;
 114         sigc::signal<void,Change>     StateChanged;
 115
 116         bool covers (nframes_t frame) const {
 117                 return _position <= frame && frame < _position + _length;
 118         }
 119
 120         OverlapType coverage (nframes_t start, nframes_t end) const;
 121
 122         static void set_buffer_size (nframes_t);
 123
 124         bool active () const { return _active; }
 125         void set_active (bool yn);
 126
 127         bool following_overlap() const { return _follow_overlap; }
 128         bool can_follow_overlap() const;
 129         void set_follow_overlap (bool yn);
 130
 131         Curve& fade_in() { return _fade_in; }
 132         Curve& fade_out() { return _fade_out; }
 133
 134         nframes_t set_length (nframes_t);
 135
 136         static nframes_t short_xfade_length() { return _short_xfade_length; }
 137         static void set_short_xfade_length (nframes_t n);
 138
 139         static Change ActiveChanged;
 140         static Change FollowOverlapChanged;
 141
 142   private:
 143         friend struct CrossfadeComparePtr;
 144         friend class AudioPlaylist;
 145
 146         static nframes_t _short_xfade_length;
 147
 148         boost::shared_ptr<ARDOUR::AudioRegion> _in;
 149         boost::shared_ptr<ARDOUR::AudioRegion> _out;
 150         bool                 _active;
 151         bool                 _in_update;
 152         OverlapType           overlap_type;
 153         nframes_t       _length;
 154         nframes_t       _position;
 155         AnchorPoint          _anchor_point;
 156         bool                 _follow_overlap;
 157         bool                 _fixed;
 158         Curve _fade_in;
 159         Curve _fade_out;
 160
 161         static Sample* crossfade_buffer_out;
 162         static Sample* crossfade_buffer_in;
 163
 164         void initialize ();
 165         int  compute (boost::shared_ptr<ARDOUR::AudioRegion>, boost::shared_ptr<ARDOUR::AudioRegion>, CrossfadeModel);
 166         bool update (bool force);
 167
 168         void member_changed (ARDOUR::Change);
 169 };
 170
 171
 172 } // namespace ARDOUR
 173
 174 #endif /* __ardour_overlap_h__ */