libs/ardour/ardour/region.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 */
  19
  20 #ifndef __ardour_region_h__
  21 #define __ardour_region_h__
  22
  23 #include <boost/shared_ptr.hpp>
  24 #include <boost/enable_shared_from_this.hpp>
  25
  26 #include <pbd/undo.h>
  27 #include <pbd/statefuldestructible.h>
  28
  29 #include <ardour/ardour.h>
  30 #include <ardour/readable.h>
  31
  32 class XMLNode;
  33
  34 namespace ARDOUR {
  35
  36 class Playlist;
  37
  38 enum RegionEditState {
  39         EditChangesNothing = 0,
  40         EditChangesName    = 1,
  41         EditChangesID      = 2
  42 };
  43
  44 class Region : public PBD::StatefulDestructible, public Readable, public boost::enable_shared_from_this<Region>
  45 {
  46   public:
  47         enum Flag {
  48                 Muted = 0x1,
  49                 Opaque = 0x2,
  50                 EnvelopeActive = 0x4,
  51                 DefaultFadeIn = 0x8,
  52                 DefaultFadeOut = 0x10,
  53                 Locked = 0x20,
  54                 Automatic = 0x40,
  55                 WholeFile = 0x80,
  56                 FadeIn = 0x100,
  57                 FadeOut = 0x200,
  58                 Copied = 0x400,
  59                 Import = 0x800,
  60                 External = 0x1000,
  61                 SyncMarked = 0x2000,
  62                 LeftOfSplit = 0x4000,
  63                 RightOfSplit = 0x8000,
  64                 Hidden = 0x10000,
  65                 DoNotSaveState = 0x20000,
  66                 //
  67                 range_guarantoor = USHRT_MAX
  68         };
  69
  70         static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
  71
  72         static Change FadeChanged;
  73         static Change SyncOffsetChanged;
  74         static Change MuteChanged;
  75         static Change OpacityChanged;
  76         static Change LockChanged;
  77         static Change LayerChanged;
  78         static Change HiddenChanged;
  79
  80         sigc::signal<void,Change> StateChanged;
  81
  82         virtual ~Region();
  83
  84         /* Note: changing the name of a Region does not constitute an edit */
  85
  86         string name() const { return _name; }
  87         void set_name (string str);
  88
  89         nframes_t position () const { return _position; }
  90         nframes_t start ()    const { return _start; }
  91         nframes_t length()    const { return _length; }
  92         layer_t   layer ()    const { return _layer; }
  93
  94         /* these two are valid ONLY during a StateChanged signal handler */
  95
  96         nframes_t last_position() const { return _last_position; }
  97         nframes_t last_length() const { return _last_length; }
  98
  99         nframes64_t ancestral_start () const { return _ancestral_start; }
 100         nframes64_t ancestral_length () const { return _ancestral_length; }
 101         float stretch() const { return _stretch; }
 102         float shift() const { return _shift; }
 103
 104         void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
 105
 106         nframes_t sync_offset(int& dir) const;
 107         nframes_t sync_position() const;
 108
 109         nframes_t adjust_to_sync (nframes_t);
 110
 111         /* first_frame() is an alias; last_frame() just hides some math */
 112
 113         nframes_t first_frame() const { return _position; }
 114         nframes_t last_frame() const { return _position + _length - 1; }
 115
 116         bool hidden()     const { return _flags & Hidden; }
 117         bool muted()      const { return _flags & Muted; }
 118         bool opaque ()    const { return _flags & Opaque; }
 119         bool locked()     const { return _flags & Locked; }
 120         bool automatic()  const { return _flags & Automatic; }
 121         bool whole_file() const { return _flags & WholeFile ; }
 122         Flag flags()      const { return _flags; }
 123
 124         virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 125
 126         void freeze ();
 127         void thaw (const string& why);
 128
 129         bool covers (nframes_t frame) const {
 130                 return first_frame() <= frame && frame <= last_frame();
 131         }
 132
 133         OverlapType coverage (nframes_t start, nframes_t end) const {
 134                 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
 135         }
 136
 137         bool equivalent (boost::shared_ptr<const Region>) const;
 138         bool size_equivalent (boost::shared_ptr<const Region>) const;
 139         bool overlap_equivalent (boost::shared_ptr<const Region>) const;
 140         bool region_list_equivalent (boost::shared_ptr<const Region>) const;
 141         virtual bool source_equivalent (boost::shared_ptr<const Region>) const = 0;
 142
 143         virtual bool speed_mismatch (float) const = 0;
 144
 145         /* EDITING OPERATIONS */
 146
 147         void set_length (nframes_t, void *src);
 148         void set_start (nframes_t, void *src);
 149         void set_position (nframes_t, void *src);
 150         void set_position_on_top (nframes_t, void *src);
 151         void special_set_position (nframes_t);
 152         void nudge_position (nframes64_t, void *src);
 153
 154         bool at_natural_position () const;
 155         void move_to_natural_position (void *src);
 156
 157         void trim_start (nframes_t new_position, void *src);
 158         void trim_front (nframes_t new_position, void *src);
 159         void trim_end (nframes_t new_position, void *src);
 160         void trim_to (nframes_t position, nframes_t length, void *src);
 161
 162         void set_layer (layer_t l); /* ONLY Playlist can call this */
 163         void raise ();
 164         void lower ();
 165         void raise_to_top ();
 166         void lower_to_bottom ();
 167
 168         void set_sync_position (nframes_t n);
 169         void clear_sync_position ();
 170         void set_hidden (bool yn);
 171         void set_muted (bool yn);
 172          void set_opaque (bool yn);
 173         void set_locked (bool yn);
 174
 175         virtual uint32_t read_data_count() const { return _read_data_count; }
 176
 177         boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
 178         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 179
 180         /* serialization */
 181
 182         XMLNode&         get_state ();
 183         virtual XMLNode& state (bool);
 184         virtual int      set_state (const XMLNode&);
 185         virtual int      set_live_state (const XMLNode&, Change&, bool send);
 186
 187         virtual boost::shared_ptr<Region> get_parent() const = 0;
 188
 189         uint64_t last_layer_op() const { return _last_layer_op; }
 190         void set_last_layer_op (uint64_t when);
 191
 192   protected:
 193         friend class RegionFactory;
 194
 195         Region (nframes_t start, nframes_t length,
 196                 const string& name, layer_t = 0, Flag flags = DefaultFlags);
 197         Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
 198         Region (boost::shared_ptr<const Region>);
 199         Region (const XMLNode&);
 200
 201
 202   protected:
 203         XMLNode& get_short_state (); /* used only by Session */
 204
 205         void send_change (Change);
 206
 207         void trim_to_internal (nframes_t position, nframes_t length, void *src);
 208
 209         bool copied() const { return _flags & Copied; }
 210         void maybe_uncopy ();
 211         void first_edit ();
 212
 213         virtual bool verify_start (nframes_t) = 0;
 214         virtual bool verify_start_and_length (nframes_t, nframes_t&) = 0;
 215         virtual bool verify_start_mutable (nframes_t&_start) = 0;
 216         virtual bool verify_length (nframes_t&) = 0;
 217         virtual void recompute_at_start () = 0;
 218         virtual void recompute_at_end () = 0;
 219
 220
 221         nframes_t               _start;
 222         nframes_t               _length;
 223         nframes_t               _last_length;
 224         nframes_t               _position;
 225         nframes_t               _last_position;
 226         Flag                    _flags;
 227         nframes_t               _sync_position;
 228         layer_t                 _layer;
 229         string                  _name;
 230         mutable RegionEditState _first_edit;
 231         int                     _frozen;
 232         Glib::Mutex             lock;
 233         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 234         mutable uint32_t        _read_data_count; // modified in read()
 235         Change                   pending_changed;
 236         uint64_t                _last_layer_op; // timestamp
 237         nframes64_t             _ancestral_start;
 238         nframes64_t             _ancestral_length;
 239         float                   _stretch;
 240         float                   _shift;
 241 };
 242
 243 } /* namespace ARDOUR */
 244
 245 #endif /* __ardour_region_h__ */