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
  30 #include "ardour/ardour.h"
  31 #include "ardour/data_type.h"
  32 #include "ardour/automatable.h"
  33 #include "ardour/readable.h"
  34 #include "ardour/session_object.h"
  35
  36 class XMLNode;
  37
  38 namespace ARDOUR {
  39
  40 class Playlist;
  41 class Filter;
  42 class ExportSpecification;
  43
  44 enum RegionEditState {
  45         EditChangesNothing = 0,
  46         EditChangesName    = 1,
  47         EditChangesID      = 2
  48 };
  49
  50 class Region
  51                 : public SessionObject
  52                 , public boost::noncopyable
  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 Change FadeChanged;
  91         static Change SyncOffsetChanged;
  92         static Change MuteChanged;
  93         static Change OpacityChanged;
  94         static Change LockChanged;
  95         static Change LayerChanged;
  96         static Change HiddenChanged;
  97
  98         sigc::signal<void,Change> StateChanged;
  99         static sigc::signal<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 (const std::string& why);
 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
 181         /* EDITING OPERATIONS */
 182
 183         void set_length (nframes_t, void *src);
 184         void set_start (nframes_t, void *src);
 185         void set_position (nframes_t, void *src);
 186         void set_position_on_top (nframes_t, void *src);
 187         void special_set_position (nframes_t);
 188         void update_position_after_tempo_map_change ();
 189         void nudge_position (nframes64_t, void *src);
 190
 191         bool at_natural_position () const;
 192         void move_to_natural_position (void *src);
 193
 194         void trim_start (nframes_t new_position, void *src);
 195         void trim_front (nframes_t new_position, void *src);
 196         void trim_end (nframes_t new_position, void *src);
 197         void trim_to (nframes_t position, nframes_t length, void *src);
 198
 199         void set_layer (layer_t l); /* ONLY Playlist can call this */
 200         void raise ();
 201         void lower ();
 202         void raise_to_top ();
 203         void lower_to_bottom ();
 204
 205         void set_sync_position (nframes_t n);
 206         void clear_sync_position ();
 207         void set_hidden (bool yn);
 208         void set_muted (bool yn);
 209         void set_opaque (bool yn);
 210         void set_locked (bool yn);
 211         void set_position_locked (bool yn);
 212
 213         int apply (Filter&);
 214
 215         virtual uint32_t read_data_count() const { return _read_data_count; }
 216
 217         boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
 218         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 219
 220         void source_deleted (boost::shared_ptr<Source>);
 221
 222         boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
 223         uint32_t                  n_channels()          const { return _sources.size(); }
 224
 225         const SourceList& sources() const { return _sources; }
 226         const SourceList& master_sources() const { return _master_sources; }
 227
 228         std::vector<std::string> master_source_names();
 229         void set_master_sources (const SourceList&);
 230
 231         /* automation */
 232
 233         virtual boost::shared_ptr<Evoral::Control>
 234         control(const Evoral::Parameter& id, bool create=false) = 0;
 235
 236         virtual boost::shared_ptr<const Evoral::Control>
 237         control(const Evoral::Parameter& id) const = 0;
 238
 239         /* serialization */
 240
 241         XMLNode&         get_state ();
 242         virtual XMLNode& state (bool);
 243         virtual int      set_state (const XMLNode&, int version);
 244         virtual int      set_live_state (const XMLNode&, int version, Change&, bool send);
 245
 246         virtual boost::shared_ptr<Region> get_parent() const;
 247
 248         uint64_t last_layer_op() const { return _last_layer_op; }
 249         void set_last_layer_op (uint64_t when);
 250
 251         virtual bool is_dependent() const { return false; }
 252         virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
 253
 254         virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
 255
 256         virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
 257                 (void) force_new;
 258                 // no transients, but its OK
 259                 return 0;
 260         }
 261
 262         virtual int separate_by_channel (ARDOUR::Session&,
 263                         std::vector< boost::shared_ptr<Region> >&) const {
 264                 return 0;
 265         }
 266
 267         void invalidate_transients ();
 268
 269         void set_pending_explicit_relayer (bool p) {
 270                 _pending_explicit_relayer = p;
 271         }
 272
 273         bool pending_explicit_relayer () const {
 274                 return _pending_explicit_relayer;
 275         }
 276
 277   protected:
 278         friend class RegionFactory;
 279
 280         Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length,
 281                 const std::string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
 282         Region (const SourceList& srcs, nframes_t start, nframes_t length,
 283                 const std::string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
 284
 285         Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const std::string& name, layer_t = 0, Flag flags = DefaultFlags);
 286         Region (boost::shared_ptr<const Region>, nframes_t length, const std::string& name, layer_t = 0, Flag flags = DefaultFlags);
 287         Region (boost::shared_ptr<const Region>);
 288         Region (boost::shared_ptr<Source> src, const XMLNode&);
 289         Region (const SourceList& srcs, const XMLNode&);
 290
 291         Region (Session& s, nframes_t start, nframes_t length, const std::string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
 292
 293   protected:
 294         void copy_stuff (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const std::string& name, layer_t, Flag flags);
 295
 296         XMLNode& get_short_state (); /* used only by Session */
 297
 298         void send_change (Change);
 299
 300         void trim_to_internal (nframes_t position, nframes_t length, void *src);
 301         virtual void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
 302
 303         bool copied() const { return _flags & Copied; }
 304         void maybe_uncopy ();
 305         void first_edit ();
 306
 307         bool verify_start (nframes_t);
 308         bool verify_start_and_length (nframes_t, nframes_t&);
 309         bool verify_start_mutable (nframes_t&_start);
 310         bool verify_length (nframes_t);
 311
 312         virtual void recompute_at_start () = 0;
 313         virtual void recompute_at_end () = 0;
 314
 315         DataType                _type;
 316         Flag                    _flags;
 317         nframes_t               _start;
 318         nframes_t               _length;
 319         nframes_t               _last_length;
 320         nframes_t               _position;
 321         nframes_t               _last_position;
 322         PositionLockStyle       _positional_lock_style;
 323         nframes_t               _sync_position;
 324         layer_t                 _layer;
 325         mutable RegionEditState _first_edit;
 326         int                     _frozen;
 327         nframes64_t             _ancestral_start;
 328         nframes64_t             _ancestral_length;
 329         float                   _stretch;
 330         float                   _shift;
 331         BBT_Time                _bbt_time;
 332         AnalysisFeatureList     _transients;
 333         bool                    _valid_transients;
 334         mutable uint32_t        _read_data_count;  ///< modified in read()
 335         Change                  _pending_changed;
 336         uint64_t                _last_layer_op;  ///< timestamp
 337         Glib::Mutex             _lock;
 338         SourceList              _sources;
 339         /** Used when timefx are applied, so we can always use the original source */
 340         SourceList              _master_sources;
 341
 342         /** true if this region has had its layer explicitly set since the playlist last relayered */
 343         bool                    _pending_explicit_relayer;
 344
 345         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 346
 347 private:
 348
 349         void use_sources (SourceList const &);
 350 };
 351
 352 } /* namespace ARDOUR */
 353
 354 #endif /* __ardour_region_h__ */