libs/ardour/ardour/file_source.h

   1 /*
   2     Copyright (C) 2006-2009 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_filesource_h__
  21 #define __ardour_filesource_h__
  22
  23 #include <list>
  24 #include <string>
  25 #include <exception>
  26 #include <time.h>
  27 #include "ardour/source.h"
  28
  29 namespace ARDOUR {
  30
  31 class LIBARDOUR_API MissingSource : public std::exception
  32 {
  33   public:
  34         MissingSource (const std::string& p, DataType t) throw ()
  35                 : path (p), type (t) {}
  36         ~MissingSource() throw() {}
  37
  38         virtual const char *what() const throw() { return "source file does not exist"; }
  39
  40         std::string path;
  41         DataType type;
  42 };
  43
  44 /** A source associated with a file on disk somewhere */
  45 class LIBARDOUR_API FileSource : virtual public Source {
  46 public:
  47         virtual ~FileSource ();
  48
  49         const std::string& path() const { return _path; }
  50
  51         virtual bool safe_file_extension (const std::string& path) const = 0;
  52
  53         int  move_to_trash (const std::string& trash_dir_name);
  54         void mark_take (const std::string& id);
  55         void mark_immutable ();
  56         void mark_immutable_except_write();
  57         void mark_nonremovable ();
  58
  59         const std::string&   take_id ()        const { return _take_id; }
  60         bool                 within_session () const { return _within_session; }
  61         uint16_t             channel()         const { return _channel; }
  62         float                gain()            const { return _gain; }
  63
  64         virtual void set_gain (float g, bool temporarily = false) { _gain = g; }
  65
  66         int set_state (const XMLNode&, int version);
  67
  68         int set_source_name (const std::string& newname, bool destructive);
  69
  70         static bool find (Session&, DataType type, const std::string& path,
  71                           bool must_exist, bool& is_new, uint16_t& chan,
  72                           std::string& found_path);
  73
  74         static bool find_2X (Session&, DataType type, const std::string& path,
  75                              bool must_exist, bool& is_new, uint16_t& chan,
  76                              std::string& found_path);
  77
  78         void inc_use_count ();
  79         bool removable () const;
  80         bool is_stub () const;
  81
  82         const std::string& origin() const { return _origin; }
  83
  84         virtual void set_path (const std::string&);
  85         void replace_file (const std::string&);
  86
  87         static PBD::Signal2<int,std::string,std::vector<std::string> > AmbiguousFileName;
  88
  89         void existence_check ();
  90         virtual void prevent_deletion ();
  91
  92         /** Rename the file on disk referenced by this source to \param newname
  93          */
  94         int rename (const std::string& name);
  95
  96         virtual void close () = 0;
  97
  98   protected:
  99         FileSource (Session& session, DataType type,
 100                     const std::string& path,
 101                     const std::string& origin,
 102                     Source::Flag flags = Source::Flag(0));
 103
 104         FileSource (Session& session, const XMLNode& node, bool must_exist);
 105
 106         virtual int init (const std::string& idstr, bool must_exist);
 107
 108         virtual int move_dependents_to_trash() { return 0; }
 109         void set_within_session_from_path (const std::string&);
 110
 111         std::string _path;
 112         std::string _take_id;
 113         bool        _file_is_new;
 114         uint16_t    _channel;
 115         bool        _within_session;
 116         std::string _origin;
 117         float       _gain;
 118 };
 119
 120 } // namespace ARDOUR
 121
 122 #endif /* __ardour_filesource_h__ */
 123