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