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