2 Copyright (C) 2006-2009 Paul Davis
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.
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.
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.
20 #ifndef __ardour_filesource_h__
21 #define __ardour_filesource_h__
27 #include "ardour/source.h"
31 class LIBARDOUR_API MissingSource : public std::exception
34 MissingSource (const std::string& p, DataType t) throw ()
35 : path (p), type (t) {}
36 ~MissingSource() throw() {}
38 virtual const char *what() const throw() { return "source file does not exist"; }
44 /** A source associated with a file on disk somewhere */
45 class LIBARDOUR_API FileSource : virtual public Source {
47 virtual ~FileSource ();
49 const std::string& path() const { return _path; }
51 virtual bool safe_file_extension (const std::string& path) const = 0;
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 ();
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; }
64 virtual void set_gain (float g, bool temporarily = false) { _gain = g; }
66 int set_state (const XMLNode&, int version);
68 int set_source_name (const std::string& newname, bool destructive);
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);
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);
78 void inc_use_count ();
79 bool removable () const;
80 bool is_stub () const;
82 const std::string& origin() const { return _origin; }
83 void set_origin (std::string const& o) { _origin = o; }
85 virtual void set_path (const std::string&);
86 void replace_file (const std::string&);
88 static PBD::Signal2<int,std::string,std::vector<std::string> > AmbiguousFileName;
90 void existence_check ();
91 virtual void prevent_deletion ();
93 /** Rename the file on disk referenced by this source to \param newname
95 int rename (const std::string& name);
97 virtual void close () = 0;
100 FileSource (Session& session, DataType type,
101 const std::string& path,
102 const std::string& origin,
103 Source::Flag flags = Source::Flag(0));
105 FileSource (Session& session, const XMLNode& node, bool must_exist);
107 virtual int init (const std::string& idstr, bool must_exist);
109 virtual int move_dependents_to_trash() { return 0; }
110 void set_within_session_from_path (const std::string&);
113 std::string _take_id;
116 bool _within_session;
121 } // namespace ARDOUR
123 #endif /* __ardour_filesource_h__ */