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