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/data_type.h>
  32
  33 namespace ARDOUR {
  34
  35 class Session;
  36 class Playlist;
  37
  38 class Source : public PBD::StatefulDestructible
  39 {
  40   public:
  41         Source (Session&, std::string name, DataType type);
  42         Source (Session&, const XMLNode&);
  43
  44         virtual ~Source ();
  45
  46         std::string name() const { return _name; }
  47         int set_name (std::string str, bool destructive);
  48
  49         DataType type() { return _type; }
  50
  51         time_t timestamp() const { return _timestamp; }
  52         void stamp (time_t when) { _timestamp = when; }
  53
  54         /** @return the number of items in this source */
  55         nframes_t length() const { return _length; }
  56
  57         virtual nframes_t natural_position() const { return 0; }
  58
  59         virtual void mark_for_remove() = 0;
  60         virtual void mark_streaming_write_completed () = 0;
  61
  62         XMLNode& get_state ();
  63         int set_state (const XMLNode&);
  64
  65         void use () { _in_use++; }
  66         void disuse () { if (_in_use) { _in_use--; } }
  67
  68         void add_playlist (boost::shared_ptr<ARDOUR::Playlist>);
  69         void remove_playlist (boost::weak_ptr<ARDOUR::Playlist>);
  70
  71         uint32_t used() const;
  72
  73
  74         static sigc::signal<void,Source*> SourceCreated;
  75
  76   protected:
  77         void update_length (nframes_t pos, nframes_t cnt);
  78
  79         Session&  _session;
  80         string    _name;
  81         DataType  _type;
  82         time_t    _timestamp;
  83         nframes_t _length;
  84
  85         Glib::Mutex playlist_lock;
  86         typedef std::map<boost::shared_ptr<ARDOUR::Playlist>, uint32_t > PlaylistMap;
  87         PlaylistMap _playlists;
  88
  89   private:
  90         uint32_t _in_use;
  91 };
  92
  93 }
  94
  95 #endif /* __ardour_source_h__ */