Fix the horrible mess that was anything related to sources and paths.
[ardour.git] / libs / ardour / ardour / source.h
index a18250fff25b927ebeef8acd33cba84e703b37eb..7b5fc43659f45d6ec3856b44097da7be398adc34 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_source_h__
 #define __ardour_source_h__
 
 #include <string>
+#include <set>
 
 #include <sigc++/signal.h>
-
 #include <pbd/statefuldestructible.h> 
+#include <evoral/TimeConverter.hpp>
 
 #include <ardour/ardour.h>
+#include <ardour/session_object.h>
 #include <ardour/data_type.h>
+#include <ardour/readable.h>
 
 namespace ARDOUR {
 
-class Source : public PBD::StatefulDestructible, public sigc::trackable
+class Session;
+class Playlist;
+
+class Source : public SessionObject, public ARDOUR::Readable
 {
   public:
-       Source (std::string name, DataType type);
-       Source (const XMLNode&);
+       enum Flag {
+               Writable = 0x1,
+               CanRename = 0x2,
+               Broadcast = 0x4,
+               Removable = 0x8,
+               RemovableIfEmpty = 0x10,
+               RemoveAtDestroy = 0x20,
+               NoPeakFile = 0x40,
+               Destructive = 0x80
+       };
+
+       Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
+       Source (Session&, const XMLNode&);
+       
        virtual ~Source ();
-
-       std::string name() const { return _name; }
-       int set_name (std::string str, bool destructive);
-
+       
        DataType type() { return _type; }
 
-       const PBD::ID&  id() const   { return _id; }
-
        time_t timestamp() const { return _timestamp; }
        void stamp (time_t when) { _timestamp = when; }
        
-       /** @return the number of items in this source */
-       jack_nframes_t length() const { return _length; }
+       nframes_t length() const { return _length; }
+       
+       virtual const Glib::ustring& path() const = 0;
 
-       virtual jack_nframes_t natural_position() const { return 0; }
+       virtual nframes_t natural_position() const { return 0; }
 
-       virtual void mark_for_remove() = 0;
+       void mark_for_remove();
+       
+       virtual void mark_streaming_write_started () {}
        virtual void mark_streaming_write_completed () = 0;
 
+       virtual void session_saved() {}
+       
        XMLNode& get_state ();
        int set_state (const XMLNode&);
        
-       static sigc::signal<void,Source*> SourceCreated;
+       bool         destructive() const       { return (_flags & Destructive); }
+       bool         writable () const         { return _flags & Writable; }
+       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>);
 
-  protected:
-       void update_length (jack_nframes_t pos, jack_nframes_t cnt);
+       uint32_t used() const;
+
+       static sigc::signal<void,Source*>             SourceCreated;
+       sigc::signal<void,boost::shared_ptr<Source> > Switched;
+
+       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;
+       
+       AnalysisFeatureList transients;
+       std::string get_transients_path() const;
+       int load_transients (const std::string&);
+       
+       void update_length (nframes_t pos, nframes_t cnt);
+       
+       int64_t timeline_position() const { return _timeline_position; }
+       virtual void set_timeline_position (int64_t pos);
+       
+       void set_allow_remove_if_empty (bool yn);
+       
+       virtual const Evoral::TimeConverter<double, nframes_t>& time_converter() const {
+               return Evoral::IdentityConverter<double, nframes_t>();
+       }
+       
+       Flag flags() const { return _flags; }
 
-       string            _name;
-       DataType          _type;
-       time_t            _timestamp;
-       jack_nframes_t    _length;
+  protected:
+       DataType            _type;
+       Flag                _flags;
+       time_t              _timestamp;
+       nframes_t           _length;
+       int64_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;
 
   private:
-       PBD::ID _id;
+       uint32_t _in_use;
 };
 
 }