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 <pbd/undo.h>
  25
  26 #include <ardour/ardour.h>
  27 #include <ardour/logcurve.h>
  28 #include <ardour/state_manager.h>
  29
  30 class XMLNode;
  31
  32 namespace ARDOUR {
  33
  34 class Playlist;
  35 class Source;
  36
  37 enum RegionEditState {
  38         EditChangesNothing = 0,
  39         EditChangesName = 1,
  40         EditChangesID = 2
  41 };
  42
  43 struct RegionState : public StateManager::State {
  44
  45     RegionState (std::string why) : StateManager::State (why) {}
  46
  47     jack_nframes_t      _start;
  48     jack_nframes_t      _length;
  49     jack_nframes_t      _position;
  50     uint32_t        _flags;
  51     jack_nframes_t      _sync_position;
  52     layer_t             _layer;
  53     string              _name;
  54     mutable RegionEditState _first_edit;
  55 };
  56
  57 class Region : public Stateful, public StateManager
  58 {
  59   public:
  60         enum Flag {
  61                 Muted = 0x1,
  62                 Opaque = 0x2,
  63                 EnvelopeActive = 0x4,
  64                 DefaultFadeIn = 0x8,
  65                 DefaultFadeOut = 0x10,
  66                 Locked = 0x20,
  67                 Automatic = 0x40,
  68                 WholeFile = 0x80,
  69                 FadeIn = 0x100,
  70                 FadeOut = 0x200,
  71                 Copied = 0x400,
  72                 Import = 0x800,
  73                 External = 0x1000,
  74                 SyncMarked = 0x2000,
  75                 LeftOfSplit = 0x4000,
  76                 RightOfSplit = 0x8000,
  77                 Hidden = 0x10000,
  78                 DoNotSaveState = 0x20000,
  79                 //
  80                 range_guarantoor = USHRT_MAX
  81         };
  82
  83         static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
  84
  85         static Change FadeChanged;
  86         static Change SyncOffsetChanged;
  87         static Change MuteChanged;
  88         static Change OpacityChanged;
  89         static Change LockChanged;
  90         static Change LayerChanged;
  91         static Change HiddenChanged;
  92
  93         Region (jack_nframes_t start, jack_nframes_t length,
  94                 const string& name, layer_t = 0, Flag flags = DefaultFlags);
  95         Region (const Region&, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
  96         Region (const Region&);
  97         Region (const XMLNode&);
  98         ~Region();
  99
 100         ARDOUR::id_t id() const { return _id; }
 101
 102         /* Note: changing the name of a Region does not constitute an edit */
 103
 104         string name() const { return _name; }
 105         void set_name (string str);
 106
 107         jack_nframes_t position () const { return _position; }
 108         jack_nframes_t start () const { return _start; }
 109         jack_nframes_t length() const { return _length; }
 110         layer_t layer () const { return _layer; }
 111         jack_nframes_t sync_offset(int& dir) const;
 112         jack_nframes_t sync_position() const;
 113
 114         jack_nframes_t adjust_to_sync (jack_nframes_t);
 115
 116         /* first_frame() is an alias; last_frame() just hides some math */
 117
 118         jack_nframes_t first_frame() const { return _position; }
 119         jack_nframes_t last_frame() const { return _position + _length - 1; }
 120
 121         bool hidden() const { return _flags & Hidden; }
 122         bool muted() const { return _flags & Muted; }
 123         bool opaque () const { return _flags & Opaque; }
 124         bool envelope_active () const { return _flags & EnvelopeActive; }
 125         bool locked() const { return _flags & Locked; }
 126         bool automatic() const { return  _flags & Automatic; }
 127         bool whole_file() const { return _flags & WholeFile ; }
 128         Flag flags() const { return _flags; }
 129
 130         virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 131
 132         void freeze ();
 133         void thaw (const string& why);
 134
 135         bool covers (jack_nframes_t frame) const {
 136                 return _position <= frame && frame < _position + _length;
 137         }
 138
 139         OverlapType coverage (jack_nframes_t start, jack_nframes_t end) const {
 140                 return ARDOUR::coverage (_position, _position + _length - 1, start, end);
 141         }
 142
 143         virtual jack_nframes_t read_at (Sample *buf, Sample *mixdown_buffer,
 144                                         float *gain_buffer, char * workbuf, jack_nframes_t position, jack_nframes_t cnt,
 145                                         uint32_t chan_n = 0,
 146                                         jack_nframes_t read_frames = 0,
 147                                         jack_nframes_t skip_frames = 0) const = 0;
 148
 149         /* EDITING OPERATIONS */
 150
 151         void set_length (jack_nframes_t, void *src);
 152         void set_start (jack_nframes_t, void *src);
 153         void set_position (jack_nframes_t, void *src);
 154         void set_position_on_top (jack_nframes_t, void *src);
 155         void special_set_position (jack_nframes_t);
 156         void nudge_position (long, void *src);
 157
 158         void move_to_natural_position (void *src);
 159
 160         void trim_start (jack_nframes_t new_position, void *src);
 161         void trim_front (jack_nframes_t new_position, void *src);
 162         void trim_end (jack_nframes_t new_position, void *src);
 163         void trim_to (jack_nframes_t position, jack_nframes_t length, void *src);
 164
 165         void set_layer (layer_t l); /* ONLY Playlist can call this */
 166         void raise ();
 167         void lower ();
 168         void raise_to_top ();
 169         void lower_to_bottom ();
 170
 171         void set_sync_position (jack_nframes_t n);
 172         void clear_sync_position ();
 173         void set_hidden (bool yn);
 174         void set_muted (bool yn);
 175         void set_opaque (bool yn);
 176         void set_envelope_active (bool yn);
 177         void set_locked (bool yn);
 178
 179         virtual uint32_t read_data_count() const { return _read_data_count; }
 180
 181         ARDOUR::Playlist* playlist() const { return _playlist; }
 182
 183         virtual UndoAction get_memento() const = 0;
 184
 185         void set_playlist (ARDOUR::Playlist*);
 186
 187         virtual void lock_sources () {}
 188         virtual void unlock_sources () {}
 189
 190         /* serialization */
 191
 192         virtual XMLNode& state (bool);
 193         XMLNode& get_state ();
 194         int      set_state (const XMLNode&);
 195
 196         sigc::signal<void,Region*> GoingAway;
 197
 198         /* This is emitted only when a new id is assigned. Therefore,
 199            in a pure Region copy, it will not be emitted.
 200
 201            It must be emitted by derived classes, not Region
 202            itself, to permit dynamic_cast<> to be used to
 203            infer the type of Region.
 204         */
 205
 206         static sigc::signal<void,Region*> CheckNewRegion;
 207
 208         virtual Region* get_parent() = 0;
 209
 210         uint64_t last_layer_op() const { return _last_layer_op; }
 211         void set_last_layer_op (uint64_t when);
 212
 213   protected:
 214
 215         jack_nframes_t        _start;
 216         jack_nframes_t        _length;
 217         jack_nframes_t        _position;
 218         Flag                  _flags;
 219         jack_nframes_t        _sync_position;
 220         layer_t               _layer;
 221         string                _name;
 222         mutable RegionEditState _first_edit;
 223         int                   _frozen;
 224         Glib::Mutex              lock;
 225         ARDOUR::id_t          _id;
 226         ARDOUR::Playlist*     _playlist;
 227         mutable uint32_t      _read_data_count; // modified in read()
 228         Change                 pending_changed;
 229         uint64_t              _last_layer_op; // timestamp
 230
 231         XMLNode& get_short_state (); /* used only by Session */
 232
 233         /* state management */
 234
 235         void send_change (Change);
 236
 237         /* derived classes need these during their own state management calls */
 238
 239         void   store_state (RegionState&) const;
 240         Change restore_and_return_flags (RegionState&);
 241
 242         void trim_to_internal (jack_nframes_t position, jack_nframes_t length, void *src);
 243
 244         bool copied() const { return _flags & Copied; }
 245         void maybe_uncopy ();
 246         void first_edit ();
 247
 248         virtual bool verify_start (jack_nframes_t) = 0;
 249         virtual bool verify_start_and_length (jack_nframes_t, jack_nframes_t) = 0;
 250         virtual bool verify_start_mutable (jack_nframes_t&_start) = 0;
 251         virtual bool verify_length (jack_nframes_t) = 0;
 252         virtual void recompute_at_start () = 0;
 253         virtual void recompute_at_end () = 0;
 254 };
 255
 256 } /* namespace ARDOUR */
 257
 258 #endif /* __ardour_region_h__ */