libs/ardour/ardour/source.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_source_h__
  21 #define __ardour_source_h__
  22
  23 #include <string>
  24 #include <set>
  25
  26 #include <sigc++/signal.h>
  27
  28 #include <pbd/statefuldestructible.h>
  29
  30 #include <ardour/ardour.h>
  31 #include <ardour/session_object.h>
  32 #include <ardour/data_type.h>
  33 #include <ardour/readable.h>
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class Playlist;
  39
  40 class Source : public SessionObject, public ARDOUR::Readable
  41 {
  42   public:
  43         Source (Session&, const std::string& name, DataType type);
  44         Source (Session&, const XMLNode&);
  45
  46         virtual ~Source ();
  47
  48         DataType type() { return _type; }
  49
  50         time_t timestamp() const { return _timestamp; }
  51         void stamp (time_t when) { _timestamp = when; }
  52
  53         /** @return the number of items in this source */
  54         nframes_t length() const { return _length; }
  55
  56         virtual nframes_t natural_position() const { return 0; }
  57
  58         virtual void mark_for_remove() = 0;
  59         virtual void mark_streaming_write_started () {}
  60         virtual void mark_streaming_write_completed () = 0;
  61
  62         virtual void session_saved() {}
  63
  64         XMLNode& get_state ();
  65         int set_state (const XMLNode&);
  66
  67         virtual bool destructive()    const { return false; }
  68         virtual bool length_mutable() const { return false; }
  69
  70         void use () { _in_use++; }
  71         void disuse () { if (_in_use) { _in_use--; } }
  72
  73         void add_playlist (boost::shared_ptr<ARDOUR::Playlist>);
  74         void remove_playlist (boost::weak_ptr<ARDOUR::Playlist>);
  75
  76         uint32_t used() const;
  77
  78         static sigc::signal<void,Source*>             SourceCreated;
  79         sigc::signal<void,boost::shared_ptr<Source> > Switched;
  80
  81         bool has_been_analysed() const;
  82         virtual bool can_be_analysed() const { return false; }
  83         virtual void set_been_analysed (bool yn);
  84         virtual bool check_for_analysis_data_on_disk();
  85
  86         sigc::signal<void> AnalysisChanged;
  87
  88         AnalysisFeatureList transients;
  89         std::string get_transients_path() const;
  90         int load_transients (const std::string&);
  91
  92   protected:
  93         void update_length (nframes_t pos, nframes_t cnt);
  94
  95         DataType            _type;
  96         time_t              _timestamp;
  97         nframes_t           _length;
  98         bool                _analysed;
  99         mutable Glib::Mutex _analysis_lock;
 100         Glib::Mutex         _playlist_lock;
 101
 102         typedef std::map<boost::shared_ptr<ARDOUR::Playlist>, uint32_t > PlaylistMap;
 103         PlaylistMap _playlists;
 104
 105   private:
 106         uint32_t _in_use;
 107 };
 108
 109 }
 110
 111 #endif /* __ardour_source_h__ */