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