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
  29 #include <ardour/ardour.h>
  30 #include <ardour/data_type.h>
  31 #include <ardour/automatable.h>
  32 #include <ardour/readable.h>
  33
  34 class XMLNode;
  35
  36 namespace ARDOUR {
  37
  38 class Playlist;
  39 class Filter;
  40 class ExportSpecification;
  41
  42 enum RegionEditState {
  43         EditChangesNothing = 0,
  44         EditChangesName    = 1,
  45         EditChangesID      = 2
  46 };
  47
  48 class Region
  49                 : public SessionObject
  50                 , public boost::enable_shared_from_this<Region>
  51                 , public Readable
  52 {
  53   public:
  54         typedef std::vector<boost::shared_ptr<Source> > SourceList;
  55
  56         enum Flag {
  57                 Muted = 0x1,
  58                 Opaque = 0x2,
  59                 EnvelopeActive = 0x4,
  60                 DefaultFadeIn = 0x8,
  61                 DefaultFadeOut = 0x10,
  62                 Locked = 0x20,
  63                 Automatic = 0x40,
  64                 WholeFile = 0x80,
  65                 FadeIn = 0x100,
  66                 FadeOut = 0x200,
  67                 Copied = 0x400,
  68                 Import = 0x800,
  69                 External = 0x1000,
  70                 SyncMarked = 0x2000,
  71                 LeftOfSplit = 0x4000,
  72                 RightOfSplit = 0x8000,
  73                 Hidden = 0x10000,
  74                 DoNotSaveState = 0x20000,
  75                 PositionLocked = 0x40000,
  76                 //
  77                 range_guarantoor = USHRT_MAX
  78         };
  79
  80         enum PositionLockStyle {
  81                 AudioTime,
  82                 MusicTime
  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         sigc::signal<void,Change> StateChanged;
  96         static sigc::signal<void,boost::shared_ptr<ARDOUR::Region> > RegionPropertyChanged;
  97
  98         virtual ~Region();
  99
 100         /** Note: changing the name of a Region does not constitute an edit */
 101         bool set_name (const std::string& str);
 102
 103         const DataType& data_type() const { return _type; }
 104
 105         /**
 106          * Thats how the region parameters play together:
 107          * <PRE>
 108          * |------------------------------------------------------------------- track
 109          *                    |..........[------------------].....| region
 110          * |-----------------------------| _position
 111          *                               |------------------| _length
 112          *                    |----------| _start
 113          * </PRE>
 114          */
 115         nframes_t position () const { return _position; }
 116         nframes_t start ()    const { return _start; }
 117         nframes_t length()    const { return _length; }
 118         layer_t   layer ()    const { return _layer; }
 119
 120         /* these two are valid ONLY during a StateChanged signal handler */
 121
 122         nframes_t last_position() const { return _last_position; }
 123         nframes_t last_length() const { return _last_length; }
 124
 125         nframes64_t ancestral_start () const { return _ancestral_start; }
 126         nframes64_t ancestral_length () const { return _ancestral_length; }
 127         float stretch() const { return _stretch; }
 128         float shift() const { return _shift; }
 129
 130         void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
 131
 132         nframes_t sync_offset(int& dir) const;
 133         nframes_t sync_position() const;
 134
 135         nframes_t adjust_to_sync (nframes_t);
 136
 137         /* first_frame() is an alias; last_frame() just hides some math */
 138
 139         nframes_t first_frame() const { return _position; }
 140         nframes_t last_frame() const { return _position + _length - 1; }
 141
 142         Flag flags()      const { return _flags; }
 143         bool hidden()     const { return _flags & Hidden; }
 144         bool muted()      const { return _flags & Muted; }
 145         bool opaque ()    const { return _flags & Opaque; }
 146         bool locked()     const { return _flags & Locked; }
 147         bool position_locked() const { return _flags & PositionLocked; }
 148         bool automatic()  const { return _flags & Automatic; }
 149         bool whole_file() const { return _flags & WholeFile ; }
 150         bool captured()   const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
 151         bool can_move()   const { return !(_flags & (Locked|PositionLocked)); }
 152
 153         PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
 154         void set_position_lock_style (PositionLockStyle ps);
 155         void recompute_position_from_lock_style ();
 156
 157         virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 158
 159         void freeze ();
 160         void thaw (const string& why);
 161
 162         bool covers (nframes_t frame) const {
 163                 return first_frame() <= frame && frame <= last_frame();
 164         }
 165
 166         OverlapType coverage (nframes_t start, nframes_t end) const {
 167                 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
 168         }
 169
 170         bool equivalent (boost::shared_ptr<const Region>) const;
 171         bool size_equivalent (boost::shared_ptr<const Region>) const;
 172         bool overlap_equivalent (boost::shared_ptr<const Region>) const;
 173         bool region_list_equivalent (boost::shared_ptr<const Region>) const;
 174         bool source_equivalent (boost::shared_ptr<const Region>) const;
 175
 176         /* EDITING OPERATIONS */
 177
 178         void set_length (nframes_t, void *src);
 179         void set_start (nframes_t, void *src);
 180         void set_position (nframes_t, void *src);
 181         void set_position_on_top (nframes_t, void *src);
 182         void special_set_position (nframes_t);
 183         void update_position_after_tempo_map_change ();
 184         void nudge_position (nframes64_t, void *src);
 185
 186         bool at_natural_position () const;
 187         void move_to_natural_position (void *src);
 188
 189         void trim_start (nframes_t new_position, void *src);
 190         void trim_front (nframes_t new_position, void *src);
 191         void trim_end (nframes_t new_position, void *src);
 192         void trim_to (nframes_t position, nframes_t length, void *src);
 193
 194         void set_layer (layer_t l); /* ONLY Playlist can call this */
 195         void raise ();
 196         void lower ();
 197         void raise_to_top ();
 198         void lower_to_bottom ();
 199
 200         void set_sync_position (nframes_t n);
 201         void clear_sync_position ();
 202         void set_hidden (bool yn);
 203         void set_muted (bool yn);
 204         void set_opaque (bool yn);
 205         void set_locked (bool yn);
 206         void set_position_locked (bool yn);
 207
 208         int apply (Filter&);
 209
 210         virtual uint32_t read_data_count() const { return _read_data_count; }
 211
 212         boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
 213         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 214
 215         void source_deleted (boost::shared_ptr<Source>);
 216
 217         boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
 218         uint32_t                  n_channels()          const { return _sources.size(); }
 219
 220         const SourceList& sources() const { return _sources; }
 221         const SourceList& master_sources() const { return _master_sources; }
 222
 223         std::vector<string> master_source_names();
 224         void set_master_sources (const SourceList&);
 225
 226         /* automation */
 227
 228         virtual boost::shared_ptr<Evoral::Control>
 229         control(const Evoral::Parameter& id, bool create=false) = 0;
 230
 231         virtual boost::shared_ptr<const Evoral::Control>
 232         control(const Evoral::Parameter& id) const = 0;
 233
 234         /* serialization */
 235
 236         XMLNode&         get_state ();
 237         virtual XMLNode& state (bool);
 238         virtual int      set_state (const XMLNode&);
 239         virtual int      set_live_state (const XMLNode&, Change&, bool send);
 240
 241         virtual boost::shared_ptr<Region> get_parent() const;
 242
 243         uint64_t last_layer_op() const { return _last_layer_op; }
 244         void set_last_layer_op (uint64_t when);
 245
 246         virtual bool is_dependent() const { return false; }
 247         virtual bool depends_on (boost::shared_ptr<Region> other) const { return false; }
 248
 249         virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
 250
 251         virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
 252                 // no transients, but its OK
 253                 return 0;
 254         }
 255
 256         void invalidate_transients ();
 257
 258   protected:
 259         friend class RegionFactory;
 260
 261         Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length,
 262                 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
 263         Region (const SourceList& srcs, nframes_t start, nframes_t length,
 264                 const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
 265
 266         Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
 267         Region (boost::shared_ptr<const Region>);
 268         Region (boost::shared_ptr<Source> src, const XMLNode&);
 269         Region (const SourceList& srcs, const XMLNode&);
 270
 271         Region (Session& s, nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
 272
 273   protected:
 274         XMLNode& get_short_state (); /* used only by Session */
 275
 276         void send_change (Change);
 277
 278         void trim_to_internal (nframes_t position, nframes_t length, void *src);
 279         void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
 280
 281         bool copied() const { return _flags & Copied; }
 282         void maybe_uncopy ();
 283         void first_edit ();
 284
 285         bool verify_start (nframes_t);
 286         bool verify_start_and_length (nframes_t, nframes_t&);
 287         bool verify_start_mutable (nframes_t&_start);
 288         bool verify_length (nframes_t);
 289
 290         virtual void recompute_at_start () = 0;
 291         virtual void recompute_at_end () = 0;
 292
 293         DataType                _type;
 294         Flag                    _flags;
 295         nframes_t               _start;
 296         nframes_t               _length;
 297         nframes_t               _last_length;
 298         nframes_t               _position;
 299         nframes_t               _last_position;
 300         PositionLockStyle       _positional_lock_style;
 301         nframes_t               _sync_position;
 302         layer_t                 _layer;
 303         mutable RegionEditState _first_edit;
 304         int                     _frozen;
 305         nframes64_t             _ancestral_start;
 306         nframes64_t             _ancestral_length;
 307         float                   _stretch;
 308         float                   _shift;
 309         BBT_Time                _bbt_time;
 310         AnalysisFeatureList     _transients;
 311         bool                    _valid_transients;
 312         mutable uint32_t        _read_data_count;  ///< modified in read()
 313         Change                  _pending_changed;
 314         uint64_t                _last_layer_op;  ///< timestamp
 315         Glib::Mutex             _lock;
 316         SourceList              _sources;
 317         /** Used when timefx are applied, so we can always use the original source */
 318         SourceList              _master_sources;
 319
 320         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 321 };
 322
 323 } /* namespace ARDOUR */
 324
 325 #endif /* __ardour_region_h__ */