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