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/movable.h"
  35 #include "ardour/readable.h"
  36 #include "ardour/session_object.h"
  37 #include "ardour/trimmable.h"
  38
  39 class XMLNode;
  40
  41 namespace ARDOUR {
  42
  43 namespace Properties {
  44         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              muted;
  45         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              opaque;
  46         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              locked;
  47         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              video_locked;
  48         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              automatic;
  49         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              whole_file;
  50         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              import;
  51         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              external;
  52         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              sync_marked;
  53         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              left_of_split;
  54         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              right_of_split;
  55         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              hidden;
  56         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              position_locked;
  57         LIBARDOUR_API extern PBD::PropertyDescriptor<bool>              valid_transients;
  58         LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t>        start;
  59         LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t>        length;
  60         LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t>        position;
  61         LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t>        sync_position;
  62         LIBARDOUR_API extern PBD::PropertyDescriptor<layer_t>           layer;
  63         LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t>        ancestral_start;
  64         LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t>        ancestral_length;
  65         LIBARDOUR_API extern PBD::PropertyDescriptor<float>             stretch;
  66         LIBARDOUR_API extern PBD::PropertyDescriptor<float>             shift;
  67         LIBARDOUR_API extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
  68         LIBARDOUR_API extern PBD::PropertyDescriptor<uint64_t>          layering_index;
  69 };
  70
  71 class Playlist;
  72 class Filter;
  73 class ExportSpecification;
  74 class Progress;
  75
  76 enum LIBARDOUR_API RegionEditState {
  77         EditChangesNothing = 0,
  78         EditChangesName    = 1,
  79         EditChangesID      = 2
  80 };
  81
  82
  83 class LIBARDOUR_API Region
  84         : public SessionObject
  85         , public boost::enable_shared_from_this<Region>
  86         , public Readable
  87         , public Trimmable
  88         , public Movable
  89 {
  90   public:
  91         typedef std::vector<boost::shared_ptr<Source> > SourceList;
  92
  93         static void make_property_quarks ();
  94
  95         static PBD::Signal2<void,boost::shared_ptr<ARDOUR::Region>, const PBD::PropertyChange&> RegionPropertyChanged;
  96
  97         virtual ~Region();
  98
  99         /** Note: changing the name of a Region does not constitute an edit */
 100         bool set_name (const std::string& str);
 101
 102         const DataType& data_type () const { return _type; }
 103
 104         AnalysisFeatureList transients () { return _transients; };
 105
 106         /** How the region parameters play together:
 107          *
 108          * POSITION: first frame of the region along the timeline
 109          * START:    first frame of the region within its source(s)
 110          * LENGTH:   number of frames the region represents
 111          */
 112         framepos_t position ()  const { return _position; }
 113         framepos_t start ()     const { return _start; }
 114         framecnt_t length ()    const { return _length; }
 115         layer_t    layer ()     const { return _layer; }
 116
 117         framecnt_t source_length(uint32_t n) const;
 118         uint32_t   max_source_level () const;
 119
 120         /* these two are valid ONLY during a StateChanged signal handler */
 121
 122         framepos_t last_position () const { return _last_position; }
 123         framecnt_t last_length ()   const { return _last_length; }
 124
 125         framepos_t ancestral_start ()  const { return _ancestral_start; }
 126         framecnt_t ancestral_length () const { return _ancestral_length; }
 127
 128         float stretch () const { return _stretch; }
 129         float shift ()   const { return _shift; }
 130
 131         void set_ancestral_data (framepos_t start, framecnt_t length, float stretch, float shift);
 132
 133         frameoffset_t sync_offset (int& dir) const;
 134         framepos_t sync_position () const;
 135         framepos_t sync_point () const;
 136
 137         framepos_t adjust_to_sync (framepos_t) const;
 138
 139         /* first_frame() is an alias; last_frame() just hides some math */
 140
 141         framepos_t first_frame () const { return _position; }
 142         framepos_t last_frame ()  const { return _position + _length - 1; }
 143
 144         /** Return the earliest possible value of _position given the
 145          *  value of _start within the region's sources
 146          */
 147         framepos_t earliest_possible_position () const;
 148         /** Return the last possible value of _last_frame given the
 149          *  value of _startin the regions's sources
 150          */
 151         framepos_t latest_possible_frame () const;
 152
 153         Evoral::Range<framepos_t> last_range () const {
 154                 return Evoral::Range<framepos_t> (_last_position, _last_position + _last_length - 1);
 155         }
 156
 157         Evoral::Range<framepos_t> range () const {
 158                 return Evoral::Range<framepos_t> (first_frame(), last_frame());
 159         }
 160
 161         bool hidden ()           const { return _hidden; }
 162         bool muted ()            const { return _muted; }
 163         bool opaque ()           const { return _opaque; }
 164         bool locked ()           const { return _locked; }
 165         bool position_locked ()  const { return _position_locked; }
 166         bool video_locked ()     const { return _video_locked; }
 167         bool valid_transients () const { return _valid_transients; }
 168         bool automatic ()        const { return _automatic; }
 169         bool whole_file ()       const { return _whole_file; }
 170         bool captured ()         const { return !(_import || _external); }
 171         bool can_move ()         const { return !_position_locked && !_locked; }
 172         bool sync_marked ()      const { return _sync_marked; }
 173         bool external ()         const { return _external; }
 174         bool import ()           const { return _import; }
 175
 176         Trimmable::CanTrim can_trim () const;
 177
 178         PositionLockStyle position_lock_style () const { return _position_lock_style; }
 179
 180         void set_position_lock_style (PositionLockStyle ps);
 181         void recompute_position_from_lock_style ();
 182
 183         void suspend_property_changes ();
 184
 185         bool covers (framepos_t frame) const {
 186                 return first_frame() <= frame && frame <= last_frame();
 187         }
 188
 189         /** @return coverage of this region with the given range;
 190          *  OverlapInternal: the range is internal to this region.
 191          *  OverlapStart:    the range overlaps the start of this region.
 192          *  OverlapEnd:      the range overlaps the end of this region.
 193          *  OverlapExternal: the range overlaps all of this region.
 194          */
 195         Evoral::OverlapType coverage (framepos_t start, framepos_t end) const {
 196                 return Evoral::coverage (first_frame(), last_frame(), start, end);
 197         }
 198
 199         bool equivalent (boost::shared_ptr<const Region>) const;
 200         bool size_equivalent (boost::shared_ptr<const Region>) const;
 201         bool overlap_equivalent (boost::shared_ptr<const Region>) const;
 202         bool region_list_equivalent (boost::shared_ptr<const Region>) const;
 203         bool source_equivalent (boost::shared_ptr<const Region>) const;
 204         bool any_source_equivalent (boost::shared_ptr<const Region>) const;
 205         bool uses_source (boost::shared_ptr<const Source>) const;
 206
 207         std::string source_string () const;
 208
 209
 210         /* EDITING OPERATIONS */
 211
 212         void set_length (framecnt_t);
 213         void set_start (framepos_t);
 214         void set_position (framepos_t);
 215         void set_initial_position (framepos_t);
 216         void special_set_position (framepos_t);
 217         virtual void update_after_tempo_map_change ();
 218         void nudge_position (frameoffset_t);
 219
 220         bool at_natural_position () const;
 221         void move_to_natural_position ();
 222
 223         void move_start (frameoffset_t distance);
 224         void trim_front (framepos_t new_position);
 225         void trim_end (framepos_t new_position);
 226         void trim_to (framepos_t position, framecnt_t length);
 227
 228         virtual void fade_range (framepos_t, framepos_t) {}
 229
 230         void cut_front (framepos_t new_position);
 231         void cut_end (framepos_t new_position);
 232
 233         void set_layer (layer_t l); /* ONLY Playlist can call this */
 234         void raise ();
 235         void lower ();
 236         void raise_to_top ();
 237         void lower_to_bottom ();
 238
 239         void set_sync_position (framepos_t n);
 240         void clear_sync_position ();
 241         void set_hidden (bool yn);
 242         void set_muted (bool yn);
 243         void set_whole_file (bool yn);
 244         void set_automatic (bool yn);
 245         void set_opaque (bool yn);
 246         void set_locked (bool yn);
 247         void set_video_locked (bool yn);
 248         void set_position_locked (bool yn);
 249
 250         int apply (Filter &, Progress* progress = 0);
 251
 252         boost::shared_ptr<ARDOUR::Playlist> playlist () const { return _playlist.lock(); }
 253         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 254
 255         void source_deleted (boost::weak_ptr<Source>);
 256
 257         bool is_compound () const;
 258
 259         boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
 260         uint32_t n_channels() const { return _sources.size(); }
 261
 262         const SourceList& sources ()        const { return _sources; }
 263         const SourceList& master_sources () const { return _master_sources; }
 264
 265         std::vector<std::string> master_source_names();
 266         void set_master_sources (const SourceList&);
 267
 268         /* automation */
 269
 270         virtual boost::shared_ptr<Evoral::Control>
 271         control (const Evoral::Parameter& id, bool create=false) = 0;
 272
 273         virtual boost::shared_ptr<const Evoral::Control>
 274         control (const Evoral::Parameter& id) const = 0;
 275
 276         /* serialization */
 277
 278         XMLNode&         get_state ();
 279         virtual XMLNode& state ();
 280         virtual int      set_state (const XMLNode&, int version);
 281
 282         virtual boost::shared_ptr<Region> get_parent() const;
 283
 284         uint64_t layering_index () const { return _layering_index; }
 285         void set_layering_index (uint64_t when) { _layering_index = when; }
 286
 287         virtual bool is_dependent() const { return false; }
 288         virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
 289
 290         virtual void add_transient (framepos_t) {
 291                 // no transients, but its OK
 292         }
 293
 294         virtual int update_transient (framepos_t /* old_position */, framepos_t /* new_position */) {
 295                 // no transients, but its OK
 296                 return 0;
 297         }
 298
 299         virtual void remove_transient (framepos_t /* where */) {
 300                 // no transients, but its OK
 301         }
 302
 303         virtual int set_transients (AnalysisFeatureList&) {
 304                 // no transients, but its OK
 305                 return 0;
 306         }
 307
 308         virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
 309                 (void) force_new;
 310                 // no transients, but its OK
 311                 return 0;
 312         }
 313
 314         virtual int adjust_transients (frameoffset_t /*delta*/) {
 315                 // no transients, but its OK
 316                 return 0;
 317         }
 318
 319         virtual int separate_by_channel (ARDOUR::Session&,
 320                         std::vector< boost::shared_ptr<Region> >&) const {
 321                 return 0;
 322         }
 323
 324         void invalidate_transients ();
 325
 326         void drop_sources ();
 327
 328   protected:
 329         friend class RegionFactory;
 330
 331         /** Construct a region from multiple sources*/
 332         Region (const SourceList& srcs);
 333
 334         /** Construct a region from another region */
 335         Region (boost::shared_ptr<const Region>);
 336
 337         /** Construct a region from another region, at an offset within that region */
 338         Region (boost::shared_ptr<const Region>, frameoffset_t start_offset);
 339
 340         /** Construct a region as a copy of another region, but with different sources */
 341         Region (boost::shared_ptr<const Region>, const SourceList&);
 342
 343         /** Constructor for derived types only */
 344         Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType);
 345
 346         virtual bool can_trim_start_before_source_start () const {
 347                 return false;
 348         }
 349
 350   protected:
 351
 352         void send_change (const PBD::PropertyChange&);
 353         virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 354         void post_set (const PBD::PropertyChange&);
 355         virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
 356         virtual void set_length_internal (framecnt_t);
 357         virtual void set_start_internal (framecnt_t);
 358
 359         DataType _type;
 360
 361         PBD::Property<bool>        _sync_marked;
 362         PBD::Property<bool>        _left_of_split;
 363         PBD::Property<bool>        _right_of_split;
 364         PBD::Property<bool>        _valid_transients;
 365         PBD::Property<framepos_t>  _start;
 366         PBD::Property<framecnt_t>  _length;
 367         PBD::Property<framepos_t>  _position;
 368         /** Sync position relative to the start of our file */
 369         PBD::Property<framepos_t>  _sync_position;
 370
 371         SourceList              _sources;
 372         /** Used when timefx are applied, so we can always use the original source */
 373         SourceList              _master_sources;
 374
 375         AnalysisFeatureList     _transients;
 376
 377         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 378
 379   private:
 380         void mid_thaw (const PBD::PropertyChange&);
 381
 382         void trim_to_internal (framepos_t position, framecnt_t length);
 383         void modify_front (framepos_t new_position, bool reset_fade);
 384         void modify_end (framepos_t new_position, bool reset_fade);
 385
 386         void maybe_uncopy ();
 387         void first_edit ();
 388
 389         bool verify_start (framepos_t);
 390         bool verify_start_and_length (framepos_t, framecnt_t&);
 391         bool verify_start_mutable (framepos_t&_start);
 392         bool verify_length (framecnt_t&);
 393
 394         virtual void recompute_at_start () = 0;
 395         virtual void recompute_at_end () = 0;
 396
 397         PBD::Property<bool>        _muted;
 398         PBD::Property<bool>        _opaque;
 399         PBD::Property<bool>        _locked;
 400         PBD::Property<bool>        _video_locked;
 401         PBD::Property<bool>        _automatic;
 402         PBD::Property<bool>        _whole_file;
 403         PBD::Property<bool>        _import;
 404         PBD::Property<bool>        _external;
 405         PBD::Property<bool>        _hidden;
 406         PBD::Property<bool>        _position_locked;
 407         PBD::Property<framepos_t>  _ancestral_start;
 408         PBD::Property<framecnt_t>  _ancestral_length;
 409         PBD::Property<float>       _stretch;
 410         PBD::Property<float>       _shift;
 411         PBD::EnumProperty<PositionLockStyle> _position_lock_style;
 412         PBD::Property<uint64_t>    _layering_index;
 413
 414         framecnt_t              _last_length;
 415         framepos_t              _last_position;
 416         mutable RegionEditState _first_edit;
 417         Timecode::BBT_Time      _bbt_time;
 418         layer_t                 _layer;
 419
 420         void register_properties ();
 421
 422         void use_sources (SourceList const &);
 423 };
 424
 425 } /* namespace ARDOUR */
 426
 427 #endif /* __ardour_region_h__ */