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 <boost/utility.hpp>
  27 #include <sigc++/signal.h>
  28 #include <pbd/statefuldestructible.h>
  29 #include <evoral/TimeConverter.hpp>
  30
  31 #include <ardour/ardour.h>
  32 #include <ardour/session_object.h>
  33 #include <ardour/data_type.h>
  34 #include <ardour/readable.h>
  35
  36 namespace ARDOUR {
  37
  38 class Session;
  39 class Playlist;
  40
  41 class Source : public SessionObject, public boost::noncopyable
  42 {
  43   public:
  44         enum Flag {
  45                 Writable = 0x1,
  46                 CanRename = 0x2,
  47                 Broadcast = 0x4,
  48                 Removable = 0x8,
  49                 RemovableIfEmpty = 0x10,
  50                 RemoveAtDestroy = 0x20,
  51                 NoPeakFile = 0x40,
  52                 Destructive = 0x80
  53         };
  54
  55         Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
  56         Source (Session&, const XMLNode&);
  57
  58         virtual ~Source ();
  59
  60         DataType type() { return _type; }
  61
  62         time_t timestamp() const { return _timestamp; }
  63         void stamp (time_t when) { _timestamp = when; }
  64
  65         nframes_t length() const { return _length; }
  66
  67         virtual const Glib::ustring& path() const = 0;
  68
  69         virtual nframes_t natural_position() const { return 0; }
  70
  71         void mark_for_remove();
  72
  73         virtual void mark_streaming_write_started () {}
  74         virtual void mark_streaming_write_completed () = 0;
  75
  76         virtual void session_saved() {}
  77
  78         XMLNode& get_state ();
  79         int set_state (const XMLNode&);
  80
  81         bool         destructive() const       { return (_flags & Destructive); }
  82         bool         writable () const         { return _flags & Writable; }
  83         virtual bool set_destructive (bool yn) { return false; }
  84         virtual bool length_mutable() const    { return false; }
  85
  86         void use ()    { _in_use++; }
  87         void disuse () { if (_in_use) { _in_use--; } }
  88
  89         void add_playlist (boost::shared_ptr<ARDOUR::Playlist>);
  90         void remove_playlist (boost::weak_ptr<ARDOUR::Playlist>);
  91
  92         uint32_t used() const;
  93
  94         static sigc::signal<void,Source*>             SourceCreated;
  95         sigc::signal<void,boost::shared_ptr<Source> > Switched;
  96
  97         bool has_been_analysed() const;
  98         virtual bool can_be_analysed() const { return false; }
  99         virtual void set_been_analysed (bool yn);
 100         virtual bool check_for_analysis_data_on_disk();
 101
 102         sigc::signal<void> AnalysisChanged;
 103
 104         AnalysisFeatureList transients;
 105         std::string get_transients_path() const;
 106         int load_transients (const std::string&);
 107
 108         void update_length (nframes_t pos, nframes_t cnt);
 109
 110         int64_t timeline_position() const { return _timeline_position; }
 111         virtual void set_timeline_position (int64_t pos);
 112
 113         void set_allow_remove_if_empty (bool yn);
 114
 115         virtual const Evoral::TimeConverter<double, nframes_t>& time_converter() const {
 116                 return Evoral::IdentityConverter<double, nframes_t>();
 117         }
 118
 119         Glib::Mutex& mutex()       { return _lock; }
 120         Flag         flags() const { return _flags; }
 121
 122   protected:
 123         DataType            _type;
 124         Flag                _flags;
 125         time_t              _timestamp;
 126         nframes_t           _length;
 127         int64_t             _timeline_position;
 128         bool                _analysed;
 129         mutable Glib::Mutex _lock;
 130         mutable Glib::Mutex _analysis_lock;
 131         Glib::Mutex         _playlist_lock;
 132
 133         typedef std::map<boost::shared_ptr<ARDOUR::Playlist>, uint32_t > PlaylistMap;
 134         PlaylistMap _playlists;
 135
 136   private:
 137         uint32_t _in_use;
 138 };
 139
 140 }
 141
 142 #endif /* __ardour_source_h__ */