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 <boost/shared_ptr.hpp>
  24 #include <boost/enable_shared_from_this.hpp>
  25
  26 #include <pbd/undo.h>
  27 #include <pbd/statefuldestructible.h>
  28
  29 #include <ardour/ardour.h>
  30
  31 class XMLNode;
  32
  33 namespace ARDOUR {
  34
  35 class Playlist;
  36
  37 enum RegionEditState {
  38         EditChangesNothing = 0,
  39         EditChangesName    = 1,
  40         EditChangesID      = 2
  41 };
  42
  43 class Region : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Region>
  44 {
  45   public:
  46         enum Flag {
  47                 Muted = 0x1,
  48                 Opaque = 0x2,
  49                 EnvelopeActive = 0x4,
  50                 DefaultFadeIn = 0x8,
  51                 DefaultFadeOut = 0x10,
  52                 Locked = 0x20,
  53                 Automatic = 0x40,
  54                 WholeFile = 0x80,
  55                 FadeIn = 0x100,
  56                 FadeOut = 0x200,
  57                 Copied = 0x400,
  58                 Import = 0x800,
  59                 External = 0x1000,
  60                 SyncMarked = 0x2000,
  61                 LeftOfSplit = 0x4000,
  62                 RightOfSplit = 0x8000,
  63                 Hidden = 0x10000,
  64                 DoNotSaveState = 0x20000,
  65                 //
  66                 range_guarantoor = USHRT_MAX
  67         };
  68
  69         static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
  70
  71         static Change FadeChanged;
  72         static Change SyncOffsetChanged;
  73         static Change MuteChanged;
  74         static Change OpacityChanged;
  75         static Change LockChanged;
  76         static Change LayerChanged;
  77         static Change HiddenChanged;
  78
  79         sigc::signal<void,Change> StateChanged;
  80
  81         virtual ~Region();
  82
  83         /* Note: changing the name of a Region does not constitute an edit */
  84
  85         string name() const { return _name; }
  86         void set_name (string str);
  87
  88         nframes_t position () const { return _position; }
  89         nframes_t start ()    const { return _start; }
  90         nframes_t length()    const { return _length; }
  91         layer_t        layer ()    const { return _layer; }
  92
  93         nframes_t sync_offset(int& dir) const;
  94         nframes_t sync_position() const;
  95
  96         nframes_t adjust_to_sync (nframes_t);
  97
  98         /* first_frame() is an alias; last_frame() just hides some math */
  99
 100         nframes_t first_frame() const { return _position; }
 101         nframes_t last_frame() const { return _position + _length - 1; }
 102
 103         bool hidden()     const { return _flags & Hidden; }
 104         bool muted()      const { return _flags & Muted; }
 105         bool opaque ()    const { return _flags & Opaque; }
 106         bool locked()     const { return _flags & Locked; }
 107         bool automatic()  const { return _flags & Automatic; }
 108         bool whole_file() const { return _flags & WholeFile ; }
 109         Flag flags()      const { return _flags; }
 110
 111         virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 112
 113         void freeze ();
 114         void thaw (const string& why);
 115
 116         bool covers (nframes_t frame) const {
 117                 return first_frame() <= frame && frame < last_frame();
 118         }
 119
 120         OverlapType coverage (nframes_t start, nframes_t end) const {
 121                 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
 122         }
 123
 124         bool equivalent (boost::shared_ptr<const Region>) const;
 125         bool size_equivalent (boost::shared_ptr<const Region>) const;
 126         bool overlap_equivalent (boost::shared_ptr<const Region>) const;
 127         bool region_list_equivalent (boost::shared_ptr<const Region>) const;
 128         virtual bool source_equivalent (boost::shared_ptr<const Region>) const = 0;
 129
 130         virtual bool speed_mismatch (float) const = 0;
 131
 132         /* EDITING OPERATIONS */
 133
 134         void set_length (nframes_t, void *src);
 135         void set_start (nframes_t, void *src);
 136         void set_position (nframes_t, void *src);
 137         void set_position_on_top (nframes_t, void *src);
 138         void special_set_position (nframes_t);
 139         void nudge_position (long, void *src);
 140
 141         bool at_natural_position () const;
 142         void move_to_natural_position (void *src);
 143
 144         void trim_start (nframes_t new_position, void *src);
 145         void trim_front (nframes_t new_position, void *src);
 146         void trim_end (nframes_t new_position, void *src);
 147         void trim_to (nframes_t position, nframes_t length, void *src);
 148
 149         void set_layer (layer_t l); /* ONLY Playlist can call this */
 150         void raise ();
 151         void lower ();
 152         void raise_to_top ();
 153         void lower_to_bottom ();
 154
 155         void set_sync_position (nframes_t n);
 156         void clear_sync_position ();
 157         void set_hidden (bool yn);
 158         void set_muted (bool yn);
 159         void set_opaque (bool yn);
 160         void set_locked (bool yn);
 161
 162         virtual uint32_t read_data_count() const { return _read_data_count; }
 163
 164         boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
 165         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 166
 167         /* serialization */
 168
 169         XMLNode&         get_state ();
 170         virtual XMLNode& state (bool);
 171         virtual int      set_state (const XMLNode&);
 172         virtual int      set_live_state (const XMLNode&, Change&, bool send);
 173
 174         virtual boost::shared_ptr<Region> get_parent() const = 0;
 175
 176         uint64_t last_layer_op() const { return _last_layer_op; }
 177         void set_last_layer_op (uint64_t when);
 178
 179   protected:
 180         friend class RegionFactory;
 181
 182         Region (nframes_t start, nframes_t length,
 183                 const string& name, layer_t = 0, Flag flags = DefaultFlags);
 184         Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
 185         Region (boost::shared_ptr<const Region>);
 186         Region (const XMLNode&);
 187
 188
 189   protected:
 190         XMLNode& get_short_state (); /* used only by Session */
 191
 192         void send_change (Change);
 193
 194         void trim_to_internal (nframes_t position, nframes_t length, void *src);
 195
 196         bool copied() const { return _flags & Copied; }
 197         void maybe_uncopy ();
 198         void first_edit ();
 199
 200         virtual bool verify_start (nframes_t) = 0;
 201         virtual bool verify_start_and_length (nframes_t, nframes_t) = 0;
 202         virtual bool verify_start_mutable (nframes_t&_start) = 0;
 203         virtual bool verify_length (nframes_t) = 0;
 204         virtual void recompute_at_start () = 0;
 205         virtual void recompute_at_end () = 0;
 206
 207
 208         nframes_t          _start;
 209         nframes_t          _length;
 210         nframes_t          _position;
 211         Flag                     _flags;
 212         nframes_t          _sync_position;
 213         layer_t                 _layer;
 214         string                  _name;
 215         mutable RegionEditState _first_edit;
 216         int                     _frozen;
 217         Glib::Mutex             lock;
 218         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 219         mutable uint32_t        _read_data_count; // modified in read()
 220         Change                   pending_changed;
 221         uint64_t                _last_layer_op; // timestamp
 222 };
 223
 224 } /* namespace ARDOUR */
 225
 226 #endif /* __ardour_region_h__ */