2 Copyright (C) 2006 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_audiofilesource_h__
21 #define __ardour_audiofilesource_h__
25 #include <ardour/audiosource.h>
29 struct SoundFileInfo {
33 std::string format_name;
37 class AudioFileSource : public AudioSource {
44 RemovableIfEmpty = 0x10,
45 RemoveAtDestroy = 0x20,
50 virtual ~AudioFileSource ();
52 int set_name (string newname, bool destructive);
54 string path() const { return _path; }
55 string peak_path (string audio_path);
56 string old_peak_path (string audio_path);
58 static void set_peak_dir (string dir) { peak_dir = dir; }
60 static bool get_soundfile_info (string path, SoundFileInfo& _info, string& error);
62 static bool safe_file_extension (string path);
64 void set_allow_remove_if_empty (bool yn);
65 void mark_for_remove();
67 /* this block of methods do nothing for regular file sources, but are significant
68 for files used in destructive recording.
71 virtual nframes_t last_capture_start_frame() const { return 0; }
72 virtual void mark_capture_start (nframes_t) {}
73 virtual void mark_capture_end () {}
74 virtual void clear_capture_marks() {}
76 virtual int update_header (nframes_t when, struct tm&, time_t) = 0;
77 virtual int flush_header () = 0;
79 int move_to_trash (const string trash_dir_name);
81 static bool is_empty (Session&, string path);
82 void mark_streaming_write_completed ();
84 void mark_take (string);
85 string take_id() const { return _take_id; }
87 bool is_embedded() const { return _is_embedded; }
89 static void set_bwf_serial_number (int);
91 static void set_search_path (string);
92 static void set_header_position_offset (nframes_t offset );
94 int setup_peakfile ();
96 static sigc::signal<void> HeaderPositionOffsetChanged;
98 XMLNode& get_state ();
99 int set_state (const XMLNode&);
101 bool destructive() const { return (_flags & Destructive); }
102 virtual bool set_destructive (bool yn) { return false; }
104 Flag flags() const { return _flags; }
106 void mark_immutable ();
108 /* this should really be protected, but C++ is getting stricter
109 and creating slots from protected member functions is starting
113 virtual void handle_header_position_change () {}
117 /* constructor to be called for existing external-to-session files */
119 AudioFileSource (Session&, std::string path, Flag flags);
121 /* constructor to be called for new in-session files */
123 AudioFileSource (Session&, std::string path, Flag flags,
124 SampleFormat samp_format, HeaderFormat hdr_format);
126 /* constructor to be called for existing in-session files */
128 AudioFileSource (Session&, const XMLNode&);
130 int init (string idstr, bool must_exist);
135 int64_t timeline_position;
140 static bool determine_embeddedness(string path);
142 static string peak_dir;
143 static string search_path;
145 static char bwf_country_code[3];
146 static char bwf_organization_code[4];
147 static char bwf_serial_number[13];
149 static uint64_t header_position_offset;
151 virtual void set_timeline_position (int64_t pos);
152 virtual void set_header_timeline_position () = 0;
154 bool find (std::string path, bool must_exist, bool& is_new);
155 bool removable() const;
156 bool writable() const { return _flags & Writable; }
159 } // namespace ARDOUR
161 #endif /* __ardour_audiofilesource_h__ */