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;
36 class AudioFileSource : public AudioSource {
43 RemovableIfEmpty = 0x10,
44 RemoveAtDestroy = 0x20,
49 virtual ~AudioFileSource ();
51 int set_name (string newname, bool destructive);
53 string path() const { return _path; }
54 string peak_path (string audio_path);
55 string old_peak_path (string audio_path);
57 static void set_peak_dir (string dir) { peak_dir = dir; }
59 static bool get_soundfile_info (string path, SoundFileInfo& _info, string& error);
61 void set_allow_remove_if_empty (bool yn);
62 void mark_for_remove();
64 /* this block of methods do nothing for regular file sources, but are significant
65 for files used in destructive recording.
68 virtual nframes_t last_capture_start_frame() const { return 0; }
69 virtual void mark_capture_start (nframes_t) {}
70 virtual void mark_capture_end () {}
71 virtual void clear_capture_marks() {}
73 virtual int update_header (nframes_t when, struct tm&, time_t) = 0;
74 virtual int flush_header () = 0;
76 int move_to_trash (const string trash_dir_name);
78 static bool is_empty (Session&, string path);
79 void mark_streaming_write_completed ();
81 void mark_take (string);
82 string take_id() const { return _take_id; }
84 bool is_embedded() const { return _is_embedded; }
86 static void set_bwf_serial_number (int);
88 static void set_search_path (string);
89 static void set_header_position_offset (nframes_t offset );
91 int setup_peakfile ();
93 static sigc::signal<void> HeaderPositionOffsetChanged;
95 XMLNode& get_state ();
96 int set_state (const XMLNode&);
98 bool destructive() const { return (_flags & Destructive); }
99 virtual bool set_destructive (bool yn) { return false; }
101 /* this should really be protected, but C++ is getting stricter
102 and creating slots from protected member functions is starting
106 virtual void handle_header_position_change () {}
110 /* constructor to be called for existing external-to-session files */
112 AudioFileSource (Session&, std::string path, Flag flags);
114 /* constructor to be called for new in-session files */
116 AudioFileSource (Session&, std::string path, Flag flags,
117 SampleFormat samp_format, HeaderFormat hdr_format);
119 /* constructor to be called for existing in-session files */
121 AudioFileSource (Session&, const XMLNode&);
123 int init (string idstr, bool must_exist);
129 uint64_t timeline_position;
133 static bool determine_embeddedness(string path);
135 static string peak_dir;
136 static string search_path;
138 static char bwf_country_code[3];
139 static char bwf_organization_code[4];
140 static char bwf_serial_number[13];
142 static uint64_t header_position_offset;
144 virtual void set_timeline_position (nframes_t pos);
145 virtual void set_header_timeline_position () = 0;
147 bool find (std::string path, bool must_exist, bool& is_new);
148 bool removable() const;
149 bool writable() const { return _flags & Writable; }
152 } // namespace ARDOUR
154 #endif /* __ardour_audiofilesource_h__ */