refine self-automating plugin interface
[ardour.git] / libs / ardour / ardour / source.h
index c34c5a91582ac161ba6d8be6b7c386d1359f681f..eb204715a1fefb7a349a4bd1e3a11cbd082fadc6 100644 (file)
 #include <string>
 #include <set>
 
+#include <glibmm/threads.h>
+
 #include <boost/utility.hpp>
-#include <sigc++/signal.h>
 #include "pbd/statefuldestructible.h"
 
 #include "ardour/ardour.h"
 #include "ardour/session_object.h"
 #include "ardour/data_type.h"
-#include "ardour/readable.h"
 
 namespace ARDOUR {
 
 class Session;
-class Playlist;
 
-class Source : public SessionObject, public boost::noncopyable
+class LIBARDOUR_API Source : public SessionObject
 {
   public:
        enum Flag {
@@ -48,9 +47,13 @@ class Source : public SessionObject, public boost::noncopyable
                RemovableIfEmpty = 0x10,
                RemoveAtDestroy = 0x20,
                NoPeakFile = 0x40,
-               Destructive = 0x80
+               Destructive = 0x80,
+               Empty = 0x100, /* used for MIDI only */
+               RF64_RIFF = 0x200,
        };
 
+       typedef Glib::Threads::Mutex::Lock Lock;
+
        Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
        Source (Session&, const XMLNode&);
 
@@ -61,73 +64,70 @@ class Source : public SessionObject, public boost::noncopyable
        time_t timestamp() const { return _timestamp; }
        void stamp (time_t when) { _timestamp = when; }
 
-       virtual sframes_t length (sframes_t pos) const = 0;
-       virtual void      update_length (sframes_t pos, sframes_t cnt) = 0;
-
-       virtual const Glib::ustring& path() const = 0;
+       virtual bool       empty () const = 0;
+       virtual framecnt_t length (framepos_t pos) const = 0;
+       virtual void       update_length (framecnt_t cnt) = 0;
 
-       virtual nframes64_t natural_position() const { return 0; }
+       virtual framepos_t natural_position() const { return 0; }
 
        void mark_for_remove();
 
-       virtual void mark_streaming_write_started () {}
-       virtual void mark_streaming_write_completed () = 0;
+       virtual void mark_streaming_write_started (const Lock& lock) {}
+       virtual void mark_streaming_write_completed (const Lock& lock) = 0;
 
        virtual void session_saved() {}
 
        XMLNode& get_state ();
-       int set_state (const XMLNode&, int version = 3000);
-       
+       int set_state (const XMLNode&, int version);
+
        bool         destructive() const       { return (_flags & Destructive); }
-       bool         writable () const         { return (_flags & Writable); }
+       bool         writable () const;
        virtual bool set_destructive (bool /*yn*/) { return false; }
        virtual bool length_mutable() const    { return false; }
 
-       void use ()    { _in_use++; }
-       void disuse () { if (_in_use) { _in_use--; } }
-
-       void add_playlist (boost::shared_ptr<ARDOUR::Playlist>);
-       void remove_playlist (boost::weak_ptr<ARDOUR::Playlist>);
-
-       uint32_t used() const;
-
-       static sigc::signal<void,Source*>             SourceCreated;
-       sigc::signal<void,boost::shared_ptr<Source> > Switched;
+       static PBD::Signal1<void,Source*>             SourceCreated;
 
        bool has_been_analysed() const;
        virtual bool can_be_analysed() const { return false; }
        virtual void set_been_analysed (bool yn);
        virtual bool check_for_analysis_data_on_disk();
 
-       sigc::signal<void> AnalysisChanged;
+       PBD::Signal0<void> AnalysisChanged;
 
        AnalysisFeatureList transients;
        std::string get_transients_path() const;
        int load_transients (const std::string&);
 
-       sframes_t    timeline_position() const { return _timeline_position; }
-       virtual void set_timeline_position (sframes_t pos);
+       framepos_t    timeline_position() const { return _timeline_position; }
+       virtual void set_timeline_position (framepos_t pos);
 
        void set_allow_remove_if_empty (bool yn);
 
-       Glib::Mutex& mutex()       { return _lock; }
+        Glib::Threads::Mutex& mutex() { return _lock; }
        Flag         flags() const { return _flags; }
 
+       virtual void inc_use_count ();
+       virtual void dec_use_count ();
+        int  use_count() const { return g_atomic_int_get (const_cast<gint*>(&_use_count)); }
+       bool used() const { return use_count() > 0; }
+       uint32_t level() const { return _level; }
+
+       std::string ancestor_name() { return _ancestor_name.empty() ? name() : _ancestor_name; }
+       void set_ancestor_name(const std::string& name) { _ancestor_name = name; }
+
   protected:
        DataType            _type;
        Flag                _flags;
        time_t              _timestamp;
-       sframes_t           _timeline_position;
+       framepos_t          _timeline_position;
        bool                _analysed;
-       mutable Glib::Mutex _lock;
-       mutable Glib::Mutex _analysis_lock;
-       Glib::Mutex         _playlist_lock;
-
-       typedef std::map<boost::shared_ptr<ARDOUR::Playlist>, uint32_t > PlaylistMap;
-       PlaylistMap _playlists;
+        mutable Glib::Threads::Mutex _lock;
+        mutable Glib::Threads::Mutex _analysis_lock;
+       gint                _use_count; /* atomic */
+       uint32_t            _level; /* how deeply nested is this source w.r.t a disk file */
+       std::string         _ancestor_name;
 
   private:
-       uint32_t _in_use;
        void fix_writable_flags ();
 };