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
  30 #include "ardour/ardour.h"
  31 #include "ardour/session_object.h"
  32 #include "ardour/data_type.h"
  33 #include "ardour/readable.h"
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class Playlist;
  39
  40 class Source : public SessionObject, public boost::noncopyable
  41 {
  42   public:
  43         enum Flag {
  44                 Writable = 0x1,
  45                 CanRename = 0x2,
  46                 Broadcast = 0x4,
  47                 Removable = 0x8,
  48                 RemovableIfEmpty = 0x10,
  49                 RemoveAtDestroy = 0x20,
  50                 NoPeakFile = 0x40,
  51                 Destructive = 0x80
  52         };
  53
  54         Source (Session&, DataType type, const std::string& name, Flag flags=Flag(0));
  55         Source (Session&, const XMLNode&);
  56
  57         virtual ~Source ();
  58
  59         DataType type() { return _type; }
  60
  61         time_t timestamp() const { return _timestamp; }
  62         void stamp (time_t when) { _timestamp = when; }
  63
  64         virtual sframes_t length (sframes_t pos) const = 0;
  65         virtual void      update_length (sframes_t pos, sframes_t cnt) = 0;
  66
  67         virtual const Glib::ustring& path() const = 0;
  68
  69         virtual sframes_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         sframes_t    timeline_position() const { return _timeline_position; }
 109         virtual void set_timeline_position (sframes_t pos);
 110
 111         void set_allow_remove_if_empty (bool yn);
 112
 113         Glib::Mutex& mutex()       { return _lock; }
 114         Flag         flags() const { return _flags; }
 115
 116   protected:
 117         DataType            _type;
 118         Flag                _flags;
 119         time_t              _timestamp;
 120         sframes_t           _timeline_position;
 121         bool                _analysed;
 122         mutable Glib::Mutex _lock;
 123         mutable Glib::Mutex _analysis_lock;
 124         Glib::Mutex         _playlist_lock;
 125
 126         typedef std::map<boost::shared_ptr<ARDOUR::Playlist>, uint32_t > PlaylistMap;
 127         PlaylistMap _playlists;
 128
 129   private:
 130         uint32_t _in_use;
 131 };
 132
 133 }
 134
 135 #endif /* __ardour_source_h__ */