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"
26 #include "ardour/file_source.h"
30 struct SoundFileInfo {
34 std::string format_name;
38 class AudioFileSource : public AudioSource, public FileSource {
40 virtual ~AudioFileSource ();
42 bool set_name (const std::string& newname) {
43 return (set_source_name(newname, destructive()) == 0);
46 Glib::ustring peak_path (Glib::ustring audio_path);
47 Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
48 Glib::ustring audio_path);
50 static void set_peak_dir (Glib::ustring dir) { peak_dir = dir; }
52 static bool get_soundfile_info (Glib::ustring path, SoundFileInfo& _info, std::string& error);
54 bool safe_file_extension (const Glib::ustring& path) const {
55 return safe_audio_file_extension(path);
58 /* this block of methods do nothing for regular file sources, but are significant
59 for files used in destructive recording.
61 virtual sframes_t last_capture_start_frame() const { return 0; }
62 virtual void mark_capture_start (sframes_t) {}
63 virtual void mark_capture_end () {}
64 virtual void clear_capture_marks() {}
65 virtual bool one_of_several_channels () const { return false; }
67 virtual int update_header (sframes_t when, struct tm&, time_t) = 0;
68 virtual int flush_header () = 0;
70 void mark_streaming_write_completed ();
72 int setup_peakfile ();
74 XMLNode& get_state ();
75 int set_state (const XMLNode&, int version);
77 bool can_truncate_peaks() const { return !destructive(); }
78 bool can_be_analysed() const { return _length > 0; }
80 static bool safe_audio_file_extension (const Glib::ustring& path);
82 static bool is_empty (Session&, Glib::ustring path);
84 static void set_bwf_serial_number (int);
85 static void set_header_position_offset (nframes_t offset );
87 static sigc::signal<void> HeaderPositionOffsetChanged;
90 /** Constructor to be called for existing external-to-session files */
91 AudioFileSource (Session&, const Glib::ustring& path, bool embedded, Source::Flag flags);
93 /** Constructor to be called for new in-session files */
94 AudioFileSource (Session&, const Glib::ustring& path, bool embedded, Source::Flag flags,
95 SampleFormat samp_format, HeaderFormat hdr_format);
97 /** Constructor to be called for existing in-session files */
98 AudioFileSource (Session&, const XMLNode&, bool must_exist = true);
100 int init (const Glib::ustring& idstr, bool must_exist);
102 virtual void set_header_timeline_position () = 0;
103 virtual void handle_header_position_change () {}
105 int move_dependents_to_trash();
107 static Sample* get_interleave_buffer (nframes_t size);
109 static Glib::ustring peak_dir;
111 static char bwf_country_code[3];
112 static char bwf_organization_code[4];
113 static char bwf_serial_number[13];
115 static uint64_t header_position_offset;
118 Glib::ustring old_peak_path (Glib::ustring audio_path);
119 Glib::ustring broken_peak_path (Glib::ustring audio_path);
122 } // namespace ARDOUR
124 #endif /* __ardour_audiofilesource_h__ */