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 LIBARDOUR_API SoundFileInfo {
34 std::string format_name;
38 class LIBARDOUR_API AudioFileSource : public AudioSource, public FileSource {
40 virtual ~AudioFileSource ();
42 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
44 static bool get_soundfile_info (const std::string& path, SoundFileInfo& _info, std::string& error);
46 bool safe_file_extension (const std::string& path) const {
47 return safe_audio_file_extension(path);
50 /* this block of methods do nothing for regular file sources, but are significant
51 for files used in destructive recording.
53 virtual framepos_t last_capture_start_frame() const { return 0; }
54 virtual void mark_capture_start (framepos_t) {}
55 virtual void mark_capture_end () {}
56 virtual void clear_capture_marks() {}
57 virtual bool one_of_several_channels () const { return false; }
59 virtual void flush () = 0;
60 virtual int update_header (framepos_t when, struct tm&, time_t) = 0;
61 virtual int flush_header () = 0;
63 void mark_streaming_write_completed (const Lock& lock);
65 int setup_peakfile ();
67 XMLNode& get_state ();
68 int set_state (const XMLNode&, int version);
70 bool can_truncate_peaks() const { return !destructive(); }
71 bool can_be_analysed() const { return _length > 0; }
73 static bool safe_audio_file_extension (const std::string& path);
75 static bool is_empty (Session&, std::string path);
77 static void set_bwf_serial_number (int);
78 static void set_header_position_offset (framecnt_t offset);
80 static PBD::Signal0<void> HeaderPositionOffsetChanged;
83 /** Constructor to be called for existing external-to-session files */
84 AudioFileSource (Session&, const std::string& path, Source::Flag flags);
86 /** Constructor to be called for new in-session files */
87 AudioFileSource (Session&, const std::string& path, const std::string& origin, Source::Flag flags,
88 SampleFormat samp_format, HeaderFormat hdr_format);
90 /** Constructor to be called for existing in-session files */
91 AudioFileSource (Session&, const XMLNode&, bool must_exist = true);
93 /** Constructor to be called for crash recovery. Final argument is not
94 * used but exists to differentiate from the external-to-session
97 AudioFileSource (Session&, const std::string& path, Source::Flag flags, bool);
99 int init (const std::string& idstr, bool must_exist);
101 virtual void set_header_timeline_position () = 0;
102 virtual void handle_header_position_change () {}
104 int move_dependents_to_trash();
106 static Sample* get_interleave_buffer (framecnt_t size);
108 static char bwf_country_code[3];
109 static char bwf_organization_code[4];
110 static char bwf_serial_number[13];
112 /** Kept up to date with the position of the session location start */
113 static framecnt_t header_position_offset;
116 } // namespace ARDOUR
118 #endif /* __ardour_audiofilesource_h__ */