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 <sigc++/signal.h>
  27 #include <pbd/statefuldestructible.h>
  28 #include <evoral/TimeConverter.hpp>
  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 ARDOUR::Readable
  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&, const std::string& name, DataType type, 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         nframes_t length() const { return _length; }
  65
  66         virtual Glib::ustring path() const = 0;
  67
  68         virtual nframes_t natural_position() const { return 0; }
  69
  70         virtual void mark_for_remove() = 0;
  71         virtual void mark_streaming_write_started () {}
  72         virtual void mark_streaming_write_completed () = 0;
  73
  74         virtual void session_saved() {}
  75
  76         XMLNode& get_state ();
  77         int set_state (const XMLNode&);
  78
  79         virtual bool destructive()    const { return false; }
  80         virtual bool length_mutable() const { return false; }
  81
  82         void use ()    { _in_use++; }
  83         void disuse () { if (_in_use) { _in_use--; } }
  84
  85         void add_playlist (boost::shared_ptr<ARDOUR::Playlist>);
  86         void remove_playlist (boost::weak_ptr<ARDOUR::Playlist>);
  87
  88         uint32_t used() const;
  89
  90         static sigc::signal<void,Source*>             SourceCreated;
  91         sigc::signal<void,boost::shared_ptr<Source> > Switched;
  92
  93         bool has_been_analysed() const;
  94         virtual bool can_be_analysed() const { return false; }
  95         virtual void set_been_analysed (bool yn);
  96         virtual bool check_for_analysis_data_on_disk();
  97
  98         sigc::signal<void> AnalysisChanged;
  99
 100         AnalysisFeatureList transients;
 101         std::string get_transients_path() const;
 102         int load_transients (const std::string&);
 103
 104         void update_length (nframes_t pos, nframes_t cnt);
 105
 106         virtual const Evoral::TimeConverter<double, nframes_t>& time_converter() const {
 107                 return Evoral::IdentityConverter<double, nframes_t>();
 108         }
 109
 110         Flag flags() const { return _flags; }
 111
 112   protected:
 113         DataType            _type;
 114         Flag                _flags;
 115         time_t              _timestamp;
 116         nframes_t           _length;
 117         bool                _analysed;
 118         mutable Glib::Mutex _analysis_lock;
 119         Glib::Mutex         _playlist_lock;
 120
 121         typedef std::map<boost::shared_ptr<ARDOUR::Playlist>, uint32_t > PlaylistMap;
 122         PlaylistMap _playlists;
 123
 124   private:
 125         uint32_t _in_use;
 126 };
 127
 128 }
 129
 130 #endif /* __ardour_source_h__ */