Merge with 2.0-ongoing R3082.
[ardour.git] / libs / ardour / ardour / region.h
index cc1390876769811d0ddc51f290d1e00206c8e00a..4196aac886bea1799af86bf39ae4146589c44bfe 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_region_h__
 #define __ardour_region_h__
 
+#include <vector>
 #include <boost/shared_ptr.hpp>
 #include <boost/enable_shared_from_this.hpp>
 
 #include <pbd/undo.h>
-#include <pbd/statefuldestructible.h> 
 
 #include <ardour/ardour.h>
+#include <ardour/data_type.h>
+#include <ardour/automatable.h>
+#include <ardour/readable.h>
 
 class XMLNode;
 
 namespace ARDOUR {
 
 class Playlist;
+class Filter;
+class ExportSpecification;
 
 enum RegionEditState {
        EditChangesNothing = 0,
@@ -41,9 +45,11 @@ enum RegionEditState {
        EditChangesID      = 2
 };
 
-class Region : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Region>
+class Region : public Automatable, public boost::enable_shared_from_this<Region>, public Readable
 {
   public:
+       typedef std::vector<boost::shared_ptr<Source> > SourceList;
+
        enum Flag {
                Muted = 0x1,
                Opaque = 0x2,
@@ -63,10 +69,16 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
                RightOfSplit = 0x8000,
                Hidden = 0x10000,
                DoNotSaveState = 0x20000,
+               PositionLocked = 0x40000,
                //
                range_guarantoor = USHRT_MAX
        };
 
+       enum PositionLockStyle {
+               AudioTime,
+               MusicTime
+       };
+
        static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
 
        static Change FadeChanged;
@@ -81,16 +93,28 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
 
        virtual ~Region();
 
-       /* Note: changing the name of a Region does not constitute an edit */
+       /** Note: changing the name of a Region does not constitute an edit */
+       bool set_name (const std::string& str);
 
-       string name() const { return _name; }
-       void set_name (string str);
+       const DataType& data_type() const { return _type; }
 
        nframes_t position () const { return _position; }
        nframes_t start ()    const { return _start; }
        nframes_t length()    const { return _length; }
-       layer_t        layer ()    const { return _layer; }
-       
+       layer_t   layer ()    const { return _layer; }
+
+       /* these two are valid ONLY during a StateChanged signal handler */
+
+       nframes_t last_position() const { return _last_position; }
+       nframes_t last_length() const { return _last_length; }
+
+       nframes64_t ancestral_start () const { return _ancestral_start; }
+       nframes64_t ancestral_length () const { return _ancestral_length; }
+       float stretch() const { return _stretch; }
+       float shift() const { return _shift; }
+
+       void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
+
        nframes_t sync_offset(int& dir) const;
        nframes_t sync_position() const;
 
@@ -101,13 +125,19 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        nframes_t first_frame() const { return _position; }
        nframes_t last_frame() const { return _position + _length - 1; }
 
+       Flag flags()      const { return _flags; }
        bool hidden()     const { return _flags & Hidden; }
        bool muted()      const { return _flags & Muted; }
        bool opaque ()    const { return _flags & Opaque; }
        bool locked()     const { return _flags & Locked; }
+       bool position_locked() const { return _flags & PositionLocked; }
        bool automatic()  const { return _flags & Automatic; }
        bool whole_file() const { return _flags & WholeFile ; }
-       Flag flags()      const { return _flags; }
+       bool captured()   const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
+       bool can_move()   const { return !(_flags & (Locked|PositionLocked)); }
+
+       PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
+       void set_position_lock_style (PositionLockStyle ps);
 
        virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 
@@ -115,7 +145,7 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        void thaw (const string& why);
 
        bool covers (nframes_t frame) const {
-               return first_frame() <= frame && frame < last_frame();
+               return first_frame() <= frame && frame <= last_frame();
        }
 
        OverlapType coverage (nframes_t start, nframes_t end) const {
@@ -126,10 +156,8 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        bool size_equivalent (boost::shared_ptr<const Region>) const;
        bool overlap_equivalent (boost::shared_ptr<const Region>) const;
        bool region_list_equivalent (boost::shared_ptr<const Region>) const;
-       virtual bool source_equivalent (boost::shared_ptr<const Region>) const = 0;
+       bool source_equivalent (boost::shared_ptr<const Region>) const;
        
-       virtual bool speed_mismatch (float) const = 0;
-
        /* EDITING OPERATIONS */
 
        void set_length (nframes_t, void *src);
@@ -137,7 +165,8 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        void set_position (nframes_t, void *src);
        void set_position_on_top (nframes_t, void *src);
        void special_set_position (nframes_t);
-       void nudge_position (long, void *src);
+       void update_position_after_tempo_map_change ();
+       void nudge_position (nframes64_t, void *src);
 
        bool at_natural_position () const;
        void move_to_natural_position (void *src);
@@ -159,12 +188,26 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        void set_muted (bool yn);
        void set_opaque (bool yn);
        void set_locked (bool yn);
+       void set_position_locked (bool yn);
+       
+       int apply (Filter&);
 
        virtual uint32_t read_data_count() const { return _read_data_count; }
 
        boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
        virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 
+       void source_deleted (boost::shared_ptr<Source>);
+       
+       boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
+       uint32_t                  n_channels()          const { return _sources.size(); }
+
+       const SourceList& sources() const { return _sources; }
+       const SourceList& master_sources() const { return _master_sources; }
+
+       std::vector<string> master_source_names();
+       void set_master_sources (SourceList&);
+       
        /* serialization */
        
        XMLNode&         get_state ();
@@ -172,20 +215,37 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        virtual int      set_state (const XMLNode&);
        virtual int      set_live_state (const XMLNode&, Change&, bool send);
 
-       virtual boost::shared_ptr<Region> get_parent() const = 0;
+       virtual boost::shared_ptr<Region> get_parent() const;
        
        uint64_t last_layer_op() const { return _last_layer_op; }
        void set_last_layer_op (uint64_t when);
 
+       virtual bool is_dependent() const { return false; }
+       virtual bool depends_on (boost::shared_ptr<Region> other) const { return false; }
+
+       virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
+
+       virtual int get_transients (AnalysisFeatureList&, bool force_new = false) { 
+               // no transients, but its OK
+               return 0;
+       }
+
+       void invalidate_transients ();  
+
   protected:
        friend class RegionFactory;
 
-       Region (nframes_t start, nframes_t length, 
-               const string& name, layer_t = 0, Flag flags = DefaultFlags);
+       Region (boost::shared_ptr<Source> src, nframes_t start, nframes_t length, 
+               const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
+       Region (const SourceList& srcs, nframes_t start, nframes_t length, 
+               const string& name, DataType type, layer_t = 0, Flag flags = DefaultFlags);
+       
        Region (boost::shared_ptr<const Region>, nframes_t start, nframes_t length, const string& name, layer_t = 0, Flag flags = DefaultFlags);
        Region (boost::shared_ptr<const Region>);
-       Region (const XMLNode&);
+       Region (boost::shared_ptr<Source> src, const XMLNode&);
+       Region (const SourceList& srcs, const XMLNode&);
 
+       Region (Session& s, nframes_t start, nframes_t length, const string& name, DataType, layer_t = 0, Flag flags = DefaultFlags);
 
   protected:
        XMLNode& get_short_state (); /* used only by Session */
@@ -193,35 +253,48 @@ class Region : public PBD::StatefulDestructible, public boost::enable_shared_fro
        void send_change (Change);
 
        void trim_to_internal (nframes_t position, nframes_t length, void *src);
+       void set_position_internal (nframes_t pos, bool allow_bbt_recompute);
 
        bool copied() const { return _flags & Copied; }
        void maybe_uncopy ();
        void first_edit ();
        
-       virtual bool verify_start (nframes_t) = 0;
-       virtual bool verify_start_and_length (nframes_t, nframes_t) = 0;
-       virtual bool verify_start_mutable (nframes_t&_start) = 0;
-       virtual bool verify_length (nframes_t) = 0;
+       bool verify_start (nframes_t);
+       bool verify_start_and_length (nframes_t, nframes_t&);
+       bool verify_start_mutable (nframes_t&_start);
+       bool verify_length (nframes_t);
+       
        virtual void recompute_at_start () = 0;
        virtual void recompute_at_end () = 0;
-       
-       
-       nframes_t          _start;
-       nframes_t          _length;
-       nframes_t          _position;
-       Flag                     _flags;
-       nframes_t          _sync_position;
+
+       DataType                _type;
+       Flag                    _flags;
+       nframes_t               _start;
+       nframes_t               _length;
+       nframes_t               _last_length;
+       nframes_t               _position;
+       nframes_t               _last_position;
+       PositionLockStyle       _positional_lock_style;
+       nframes_t               _sync_position;
        layer_t                 _layer;
-       string                  _name;        
        mutable RegionEditState _first_edit;
        int                     _frozen;
-       Glib::Mutex             lock;
+       nframes64_t             _ancestral_start;
+       nframes64_t             _ancestral_length;
+       float                   _stretch;
+       float                   _shift;
+       BBT_Time                _bbt_time;
+       AnalysisFeatureList     _transients;
+       bool                    _valid_transients;
+       mutable uint32_t        _read_data_count;  ///< modified in read()
+       Change                  _pending_changed;
+       uint64_t                _last_layer_op;  ///< timestamp
+       Glib::Mutex             _lock;
+       SourceList              _sources;
+       /** Used when timefx are applied, so we can always use the original source */
+       SourceList              _master_sources;
+       
        boost::weak_ptr<ARDOUR::Playlist> _playlist;
-       mutable uint32_t        _read_data_count; // modified in read()
-       Change                   pending_changed;
-       uint64_t                _last_layer_op; // timestamp
-
-       int compile_farmtest;
 };
 
 } /* namespace ARDOUR */