on session-load: skip output-change-handler until IOs are restored
[ardour.git] / libs / ardour / ardour / playlist.h
index 9ad40e6eb91d35bdbc5c2f8b351d5e692784ec65..754e48cc25d1fbf71a2956c9e1250295b62bd71b 100644 (file)
 
 #include <glib.h>
 
-
 #include "pbd/undo.h"
 #include "pbd/stateful.h"
 #include "pbd/statefuldestructible.h"
 #include "pbd/sequence_property.h"
+#include "pbd/stacktrace.h"
 
 #include "evoral/types.hpp"
 
@@ -44,9 +44,6 @@
 #include "ardour/session_object.h"
 #include "ardour/data_type.h"
 
-class PlaylistOverlapCacheTest;
-class PlaylistLayeringTest;
-
 namespace ARDOUR  {
 
 class Session;
@@ -84,7 +81,6 @@ class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_
 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);
@@ -122,6 +118,7 @@ public:
        bool hidden() const { return _hidden; }
        bool empty() const;
        uint32_t n_regions() const;
+       bool all_regions_empty() const;
        std::pair<framepos_t, framepos_t> get_extent () const;
        layer_t top_layer() const;
 
@@ -135,6 +132,7 @@ public:
        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 get_source_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);
        void split_region (boost::shared_ptr<Region>, framepos_t position);
        void split (framepos_t at);
@@ -154,11 +152,11 @@ public:
 
        const RegionListProperty& region_list () const { return regions; }
 
-       RegionList*                regions_at (framepos_t frame);
+       boost::shared_ptr<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);
+       boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
+       boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<framepos_t>);
+       boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<framepos_t>);
        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);
@@ -175,7 +173,7 @@ public:
        void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 
        XMLNode& get_state ();
-       int set_state (const XMLNode&, int version);
+       virtual int set_state (const XMLNode&, int version);
        XMLNode& get_template ();
 
        PBD::Signal1<void,bool> InUse;
@@ -225,33 +223,40 @@ public:
        framepos_t find_next_top_layer_position (framepos_t) const;
        uint32_t combine_ops() const { return _combine_ops; }
 
-       void relayer (boost::shared_ptr<Region>);
-       void relayer (boost::shared_ptr<Region>, double);
-       void suspend_relayer ();
-       void resume_relayer ();
+       void set_layer (boost::shared_ptr<Region>, double);
+
+       void set_capture_insertion_in_progress (bool yn);
        
   protected:
        friend class Session;
 
   protected:
-       struct RegionLock {
-               RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
-                       playlist->region_lock.lock();
-                       if (block_notify) {
-                               playlist->delay_notifications();
-                       }
-               }
-               ~RegionLock() {
-                       playlist->region_lock.unlock();
-                       if (block_notify) {
-                               playlist->release_notifications ();
-                       }
-               }
-               Playlist *playlist;
-               bool block_notify;
-       };
-
-       friend class RegionLock;
+    class RegionReadLock : public Glib::Threads::RWLock::ReaderLock {
+    public:
+        RegionReadLock (Playlist *pl) : Glib::Threads::RWLock::ReaderLock (pl->region_lock) {}
+        ~RegionReadLock() {}
+    };
+
+    class RegionWriteLock : public Glib::Threads::RWLock::WriterLock {
+    public:
+           RegionWriteLock (Playlist *pl, bool do_block_notify = true) 
+                    : Glib::Threads::RWLock::WriterLock (pl->region_lock)
+                    , playlist (pl)
+                    , block_notify (do_block_notify) {
+                    if (block_notify) {
+                            playlist->delay_notifications();
+                    }
+            }
+
+        ~RegionWriteLock() {
+                Glib::Threads::RWLock::WriterLock::release ();
+                if (block_notify) {
+                        playlist->release_notifications ();
+                }
+        }
+        Playlist *playlist;
+        bool block_notify;
+    };
 
        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 */
@@ -260,7 +265,6 @@ public:
        int             _sort_id;
        mutable gint    block_notifications;
        mutable gint    ignore_state_changes;
-       mutable Glib::RecMutex region_lock;
        std::set<boost::shared_ptr<Region> > pending_adds;
        std::set<boost::shared_ptr<Region> > pending_removes;
        RegionList       pending_bounds;
@@ -274,10 +278,8 @@ public:
        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             in_undo;
        bool             first_set_state;
        bool            _hidden;
        bool            _splicing;
@@ -288,10 +290,9 @@ public:
        bool             in_flush;
        bool             in_partition;
        bool            _frozen;
+       bool            _capture_insertion_underway;
        uint32_t         subcnt;
        PBD::ID         _orig_track_id;
-       framecnt_t       freeze_length;
-       bool             auto_partition;
        uint32_t        _combine_ops;
 
        void init (bool hide);
@@ -308,6 +309,8 @@ public:
 
        void _set_sort_id ();
 
+       boost::shared_ptr<RegionList> regions_touched_locked (framepos_t start, framepos_t end);
+
        void notify_region_removed (boost::shared_ptr<Region>);
        void notify_region_added (boost::shared_ptr<Region>);
        void notify_layering_changed ();
@@ -334,10 +337,6 @@ public:
        void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
        void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 
-       virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
-
-       virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
-       virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
        virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 
        virtual XMLNode& state (bool);
@@ -345,7 +344,6 @@ public:
        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);
        void copy_regions (RegionList&) const;
        void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 
@@ -356,24 +354,14 @@ public:
        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);
 
-       void relayer (RegionList const &);
+       void relayer ();
 
        void begin_undo ();
        void end_undo ();
-       void unset_freeze_parent (Playlist*);
-       void unset_freeze_child (Playlist*);
 
        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> >&) {}
@@ -384,70 +372,15 @@ public:
        */
        virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 
-private:
-       friend class ::PlaylistOverlapCacheTest;
-       friend class ::PlaylistLayeringTest;
-       
-       /** A class which is used to store temporary (fractional)
-        *  layer assignments for some regions.
-        */
-       class TemporaryLayers
-       {
-       public:
-               void set (boost::shared_ptr<Region>, double);
-               double get (boost::shared_ptr<Region>) const;
-
-       private:                
-               typedef std::map<boost::shared_ptr<Region>, double> Map;
-               Map _map;
-       };
-
-       /** Class to sort by temporary layer, for use with std::list<>::sort() */
-       class SortByTemporaryLayer
-       {
-       public:
-               SortByTemporaryLayer (TemporaryLayers const & t)
-                       : _temporary_layers (t) {}
-               
-               bool operator() (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) const {
-                       return _temporary_layers.get (a) < _temporary_layers.get (b);
-               }
-
-       private:
-               Playlist::TemporaryLayers const & _temporary_layers;
-       };
-
-       /** A cache of what overlaps what, for a given playlist in a given state.
-        *  Divides a playlist up into time periods and notes which regions cover those
-        *  periods, so that get() is reasonably quick.
-        */
-       class OverlapCache
-       {
-       public:
-               OverlapCache (Playlist *);
-
-               RegionList get (Evoral::Range<framepos_t>) const;
-
-       private:
-               std::pair<int, int> cache_indices (Evoral::Range<framepos_t>) const;
-               
-               double _division_size;
-               std::vector<RegionList> _cache;
-               Evoral::Range<framepos_t> _range;
-
-               static int const _divisions;
-       };
-       
-       TemporaryLayers compute_temporary_layers (RegionList const &);
-       void commit_temporary_layers (TemporaryLayers const &);
-
-       RegionList recursive_regions_touched (boost::shared_ptr<Region>, OverlapCache const &, boost::shared_ptr<Region>) const;
-       void recursive_regions_touched_sub (boost::shared_ptr<Region>, OverlapCache const &, boost::shared_ptr<Region>, RegionList &) const;
-
-       void timestamp_layer_op (LayerOp, boost::shared_ptr<Region>);
-       uint64_t layer_op_counter;
+  private:
+       friend class RegionReadLock;
+       friend class RegionWriteLock;
+       mutable Glib::Threads::RWLock region_lock;
 
-       bool _relayer_suspended;
+  private:
+       void setup_layering_indices (RegionList const &);
+       void coalesce_and_check_crossfades (std::list<Evoral::Range<framepos_t> >);
+       boost::shared_ptr<RegionList> find_regions_at (framepos_t);
 };
 
 } /* namespace ARDOUR */