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
  26 #include <sigc++/signal.h>
  27
  28 #include <pbd/stateful.h>
  29
  30 #include <ardour/ardour.h>
  31
  32 namespace ARDOUR {
  33
  34 class Source : public Stateful, public sigc::trackable
  35 {
  36   public:
  37         Source (std::string name);
  38         Source (const XMLNode&);
  39         virtual ~Source ();
  40
  41         std::string name() const { return _name; }
  42         int set_name (std::string str, bool destructive);
  43
  44         const PBD::ID&  id() const   { return _id; }
  45
  46         uint32_t use_cnt() const { return _use_cnt; }
  47         void use ();
  48         void release ();
  49
  50         virtual void mark_for_remove() = 0;
  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         XMLNode& get_state ();
  61         int set_state (const XMLNode&);
  62
  63         sigc::signal<void,Source *> GoingAway;
  64
  65   protected:
  66         void update_length (jack_nframes_t pos, jack_nframes_t cnt);
  67
  68         string            _name;
  69         uint32_t          _use_cnt;
  70         time_t            _timestamp;
  71         jack_nframes_t    _length;
  72
  73   private:
  74         PBD::ID _id;
  75 };
  76
  77 }
  78
  79 #endif /* __ardour_source_h__ */