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