change name of a Session method to makes its intended function clear
[ardour.git] / libs / ardour / ardour / playlist.h
index 022fdb3ccbf5438a7949e0196a3179e60313082f..5eec755a381f1f4d7db74bfa7b5eda38a82e82c4 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"
+#include "evoral/Range.hpp"
 
 #include "ardour/ardour.h"
+#include "ardour/region.h"
 #include "ardour/session_object.h"
 #include "ardour/data_type.h"
 
 namespace ARDOUR  {
 
 class Session;
-class Region;
 class Playlist;
 class Crossfade;
 
@@ -55,10 +55,10 @@ namespace Properties {
        /* fake the type, since regions are handled by SequenceProperty which doesn't
           care about such things.
        */
-       extern PBD::PropertyDescriptor<bool> regions;
+       LIBARDOUR_API extern PBD::PropertyDescriptor<bool> regions;
 }
 
-class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
+class LIBARDOUR_API RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
 {
   public:
        RegionListProperty (Playlist&);
@@ -78,10 +78,9 @@ class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_
        Playlist& _playlist;
 };
 
-class Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
+class LIBARDOUR_API 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);
@@ -119,7 +118,9 @@ 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;
+       std::pair<framepos_t, framepos_t> get_extent_with_endspace() const;
        layer_t top_layer() const;
 
        EditMode get_edit_mode() const { return _edit_mode; }
@@ -132,17 +133,31 @@ 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);
        void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
        void partition (framepos_t start, framepos_t end, bool cut = false);
        void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
+       void duplicate (boost::shared_ptr<Region>, framepos_t position, framecnt_t gap, float times);
+       void duplicate_until (boost::shared_ptr<Region>, framepos_t position, framecnt_t gap, framepos_t end);
+       void duplicate_range (AudioRange&, float times);
+       void duplicate_ranges (std::list<AudioRange>&, 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 fade_range (std::list<AudioRange>&);
 
        void shuffle (boost::shared_ptr<Region>, int dir);
+       void ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
+       void ripple (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude) {
+                RegionList el;
+                if (exclude)
+                        el.push_back (exclude);
+                ripple (at, distance, &el);
+       }
+
        void update_after_tempo_map_change ();
 
        boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
@@ -153,9 +168,9 @@ public:
 
        boost::shared_ptr<RegionList> regions_at (framepos_t frame);
        uint32_t                   count_regions_at (framepos_t) const;
-       uint32_t                   count_joined_regions () const;
        boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
-       boost::shared_ptr<RegionList> regions_to_read (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);
@@ -172,7 +187,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;
@@ -222,32 +237,40 @@ public:
        framepos_t find_next_top_layer_position (framepos_t) const;
        uint32_t combine_ops() const { return _combine_ops; }
 
-       uint64_t highest_layering_index () const;
-
        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 */
@@ -256,7 +279,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;
@@ -270,13 +292,12 @@ 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_undo;
        bool             first_set_state;
        bool            _hidden;
        bool            _splicing;
+       bool            _rippling;
        bool            _shuffling;
        bool            _nudging;
        uint32_t        _refcnt;
@@ -284,9 +305,9 @@ public:
        bool             in_flush;
        bool             in_partition;
        bool            _frozen;
+       bool            _capture_insertion_underway;
        uint32_t         subcnt;
        PBD::ID         _orig_track_id;
-       bool             auto_partition;
        uint32_t        _combine_ops;
 
        void init (bool hide);
@@ -303,6 +324,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 ();
@@ -329,10 +352,11 @@ 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*/) {}
+       void core_ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
+       void ripple_locked (framepos_t at, framecnt_t distance, RegionList *exclude);
+       void ripple_unlocked (framepos_t at, framecnt_t distance, RegionList *exclude);
+
 
-       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);
@@ -354,20 +378,10 @@ public:
 
        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> >&) {}
@@ -378,10 +392,17 @@ public:
        */
        virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 
-private:
+  private:
+       friend class RegionReadLock;
+       friend class RegionWriteLock;
+       mutable Glib::Threads::RWLock region_lock;
 
-       void setup_layering_indices (RegionList const &) const;
+  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);
+
+       framepos_t _end_space;  //this is used when we are pasting a range with extra space at the end
 };
 
 } /* namespace ARDOUR */