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