Revert internals of the last layering-related commit, and go back a slightly-cleaned...
[ardour.git] / libs / ardour / ardour / playlist.h
index 38469f4723fe1265986bc7ebe8fa38c047c26cf3..a7ead83eef8a6bc60b7c7ff3a582d735afcb46cc 100644 (file)
 #include "pbd/undo.h"
 #include "pbd/stateful.h"
 #include "pbd/statefuldestructible.h"
+#include "pbd/sequence_property.h"
 
 #include "evoral/types.hpp"
 
 #include "ardour/ardour.h"
 #include "ardour/session_object.h"
-#include "ardour/crossfade_compare.h"
-#include "ardour/location.h"
 #include "ardour/data_type.h"
 
 namespace ARDOUR  {
 
 class Session;
 class Region;
+class Playlist;
+class Crossfade;
 
-class Playlist : public SessionObject
-              , public boost::enable_shared_from_this<Playlist> {
+namespace Properties {
+       /* fake the type, since regions are handled by SequenceProperty which doesn't
+          care about such things.
+       */
+       extern PBD::PropertyDescriptor<bool> regions;
+}
+
+class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
+{
   public:
-       typedef std::list<boost::shared_ptr<Region> >    RegionList;
+       RegionListProperty (Playlist&);
+
+       RegionListProperty* clone () const;
+       void get_content_as_xml (boost::shared_ptr<Region>, XMLNode &) const;
+       boost::shared_ptr<Region> get_content_from_xml (XMLNode const &) const;
+
+  private:
+       RegionListProperty* create () const;
+
+       /* copy construction only by ourselves */
+       RegionListProperty (RegionListProperty const & p);
+
+       friend class Playlist;
+       /* we live and die with our playlist, no lifetime management needed */
+       Playlist& _playlist;
+};
+
+class Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
+{
+public:
+       typedef std::list<boost::shared_ptr<Region> > RegionList;
+       static void make_property_quarks ();
 
        Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
        Playlist (Session&, std::string name, DataType type, bool hidden = false);
@@ -62,6 +91,14 @@ class Playlist : public SessionObject
 
        virtual ~Playlist ();
 
+       void update (const RegionListProperty::ChangeRecord&);
+       void clear_owned_changes ();
+       void rdiff (std::vector<Command*>&) const;
+
+       boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
+
+       uint32_t max_source_level () const;
+
        void set_region_ownership ();
 
        virtual void clear (bool with_signals=true);
@@ -72,6 +109,7 @@ class Playlist : public SessionObject
        bool used () const { return _refcnt != 0; }
 
        bool set_name (const std::string& str);
+       int sort_id() { return _sort_id; }
 
        const DataType& data_type() const { return _type; }
 
@@ -81,7 +119,7 @@ class Playlist : public SessionObject
        bool hidden() const { return _hidden; }
        bool empty() const;
        uint32_t n_regions() const;
-       framecnt_t get_maximum_extent () const;
+       std::pair<framepos_t, framepos_t> get_extent () const;
        layer_t top_layer() const;
 
        EditMode get_edit_mode() const { return _edit_mode; }
@@ -91,6 +129,7 @@ class Playlist : public SessionObject
 
        void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
        void remove_region (boost::shared_ptr<Region>);
+       void remove_region_by_source (boost::shared_ptr<Source>);
        void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
        void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
        void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
@@ -100,6 +139,9 @@ class Playlist : public SessionObject
        void partition (framepos_t start, framepos_t end, bool cut = false);
        void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
        void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
+       boost::shared_ptr<Region> combine (const RegionList&);
+       void uncombine (boost::shared_ptr<Region>);
+
        void shuffle (boost::shared_ptr<Region>, int dir);
        void update_after_tempo_map_change ();
 
@@ -107,11 +149,14 @@ class Playlist : public SessionObject
        boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
        int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 
-       const RegionList& region_list () const { return regions; }
+       const RegionListProperty& region_list () const { return regions; }
 
        RegionList*                regions_at (framepos_t frame);
+       uint32_t                   count_regions_at (framepos_t) const;
+       uint32_t                   count_joined_regions () const;
        RegionList*                regions_touched (framepos_t start, framepos_t end);
        RegionList*                regions_to_read (framepos_t start, framepos_t end);
+       uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
        boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
        boost::shared_ptr<Region>  top_region_at (framepos_t frame);
        boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
@@ -120,6 +165,7 @@ class Playlist : public SessionObject
        bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
        bool                       has_region_at (framepos_t const) const;
 
+       bool uses_source (boost::shared_ptr<const Source> src) const;
 
        framepos_t find_next_transient (framepos_t position, int dir);
 
@@ -134,41 +180,50 @@ class Playlist : public SessionObject
        PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
        PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
        PBD::Signal0<void>      NameChanged;
-       PBD::Signal0<void>      LengthChanged;
        PBD::Signal0<void>      LayeringChanged;
-       PBD::Signal1<void,std::list< Evoral::RangeMove<framepos_t> > const &> RangesMoved;
+
+       /** Emitted when regions have moved (not when regions have only been trimmed) */
+       PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
+
+       /** Emitted when regions are extended; the ranges passed are the new extra time ranges
+           that these regions now occupy.
+       */
+       PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 
        static std::string bump_name (std::string old_name, Session&);
 
        void freeze ();
-       void thaw ();
+       void thaw (bool from_undo = false);
 
        void raise_region (boost::shared_ptr<Region>);
        void lower_region (boost::shared_ptr<Region>);
        void raise_region_to_top (boost::shared_ptr<Region>);
        void lower_region_to_bottom (boost::shared_ptr<Region>);
 
-       uint32_t read_data_count() const { return _read_data_count; }
-
-       const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
-       void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
+       const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
+       void set_orig_track_id (const PBD::ID& did);
 
        /* destructive editing */
 
        virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 
+       void sync_all_regions_with_regions ();
+
        /* special case function used by UI selection objects, which have playlists that actually own the regions
           within them.
        */
 
        void drop_regions ();
 
-       bool explicit_relayering () const {
-               return _explicit_relayering;
+       virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
+               return boost::shared_ptr<Crossfade> ();
        }
 
-       void set_explicit_relayering (bool e);
+       framepos_t find_next_top_layer_position (framepos_t) const;
+       uint32_t combine_ops() const { return _combine_ops; }
 
+       uint64_t highest_layering_index () const;
+       
   protected:
        friend class Session;
 
@@ -192,10 +247,11 @@ class Playlist : public SessionObject
 
        friend class RegionLock;
 
-       RegionList       regions;  /* the current list of regions in the playlist */
+       RegionListProperty   regions;  /* the current list of regions in the playlist */
        std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
        PBD::ScopedConnectionList region_state_changed_connections;
        DataType        _type;
+       int             _sort_id;
        mutable gint    block_notifications;
        mutable gint    ignore_state_changes;
        mutable Glib::RecMutex region_lock;
@@ -204,11 +260,18 @@ class Playlist : public SessionObject
        RegionList       pending_bounds;
        bool             pending_contents_change;
        bool             pending_layering;
-       bool             pending_length;
+
+       /** Movements of time ranges caused by region moves; note that
+        *  region trims are not included in this list; it is used to
+        *  do automation-follows-regions.
+        */
        std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
+       /** Extra sections added to regions during trims */
+       std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
        bool             save_on_thaw;
        std::string      last_save_reason;
        uint32_t         in_set_state;
+       bool             in_update;
        bool             first_set_state;
        bool            _hidden;
        bool            _splicing;
@@ -220,17 +283,9 @@ class Playlist : public SessionObject
        bool             in_partition;
        bool            _frozen;
        uint32_t         subcnt;
-       uint32_t        _read_data_count;
-       PBD::ID         _orig_diskstream_id;
-       uint64_t         layer_op_counter;
-       framecnt_t       freeze_length;
+       PBD::ID         _orig_track_id;
        bool             auto_partition;
-
-       /** true if relayering should be done using region's current layers and their `pending explicit relayer'
-        *  flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
-        *  Explicit relayering is used by tracks in stacked regionview mode.
-        */
-       bool            _explicit_relayering;
+       uint32_t        _combine_ops;
 
        void init (bool hide);
 
@@ -240,17 +295,20 @@ class Playlist : public SessionObject
        }
 
        void delay_notifications ();
-       void release_notifications ();
-       virtual void flush_notifications ();
+       void release_notifications (bool from_undo = false);
+       virtual void flush_notifications (bool from_undo = false);
        void clear_pending ();
 
+       void _set_sort_id ();
+
        void notify_region_removed (boost::shared_ptr<Region>);
        void notify_region_added (boost::shared_ptr<Region>);
-       void notify_length_changed ();
        void notify_layering_changed ();
        void notify_contents_changed ();
        void notify_state_changed (const PBD::PropertyChange&);
        void notify_region_moved (boost::shared_ptr<Region>);
+       void notify_region_start_trimmed (boost::shared_ptr<Region>);
+       void notify_region_end_trimmed (boost::shared_ptr<Region>);
 
        void mark_session_dirty();
 
@@ -277,23 +335,20 @@ class Playlist : public SessionObject
 
        virtual XMLNode& state (bool);
 
-       boost::shared_ptr<Region> region_by_id (PBD::ID);
-
        bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 
        int remove_region_internal (boost::shared_ptr<Region>);
-       RegionList *find_regions_at (framepos_t frame);
+       RegionList *find_regions_at (framepos_t);
        void copy_regions (RegionList&) const;
        void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 
-       framecnt_t _get_maximum_extent() const;
+       std::pair<framepos_t, framepos_t> _get_extent() const;
 
        boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
                                              std::list<AudioRange>& ranges, bool result_is_hidden);
        boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
        boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 
-       int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
        void relayer ();
 
        void begin_undo ();
@@ -301,9 +356,26 @@ class Playlist : public SessionObject
        void unset_freeze_parent (Playlist*);
        void unset_freeze_child (Playlist*);
 
-       void timestamp_layer_op (boost::shared_ptr<Region>);
-
        void _split_region (boost::shared_ptr<Region>, framepos_t position);
+
+       typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
+       virtual void copy_dependents (const std::vector<TwoRegions>&, Playlist*) const { }
+
+       struct RegionInfo {
+           boost::shared_ptr<Region> region;
+           framepos_t position;
+           framecnt_t length;
+           framepos_t start;
+       };
+
+       /* this is called before we create a new compound region */
+       virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
+       /* this is called before we create a new compound region */
+       virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
+       /* this is called before we remove a compound region and replace it
+          with its constituent regions
+       */
+       virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 };
 
 } /* namespace ARDOUR */