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