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