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 #include <boost/enable_shared_from_this.hpp>
  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 Source : public PBD::StatefulDestructible, public sigc::trackable, public boost::enable_shared_from_this<Source>
  37 {
  38   public:
  39         Source (std::string name, DataType type);
  40         Source (const XMLNode&);
  41         virtual ~Source ();
  42
  43         std::string name() const { return _name; }
  44         int set_name (std::string str, bool destructive);
  45
  46         DataType type() { return _type; }
  47
  48         const PBD::ID&  id() const   { return _id; }
  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         jack_nframes_t length() const { return _length; }
  55
  56         virtual jack_nframes_t natural_position() const { return 0; }
  57
  58         virtual void mark_for_remove() = 0;
  59         virtual void mark_streaming_write_completed () = 0;
  60
  61         XMLNode& get_state ();
  62         int set_state (const XMLNode&);
  63
  64         static sigc::signal<void,Source*> SourceCreated;
  65
  66   protected:
  67         void update_length (jack_nframes_t pos, jack_nframes_t cnt);
  68
  69         string            _name;
  70         DataType          _type;
  71         time_t            _timestamp;
  72         jack_nframes_t    _length;
  73
  74   private:
  75         PBD::ID _id;
  76 };
  77
  78 }
  79
  80 #endif /* __ardour_source_h__ */