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