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