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