summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/audiofilesource.h
blob: de388a06fc348a9aded858f27d5145f4b747c2a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
    Copyright (C) 2006 Paul Davis 

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_audiofilesource_h__ 
#define __ardour_audiofilesource_h__

#include <exception>

#include <time.h>

#include <ardour/audiosource.h>

namespace ARDOUR {

class non_existent_source : public std::exception {
  public:
	virtual const char *what() const throw() { return "audio file does not exist"; }
};

struct SoundFileInfo {
    float       samplerate;
    uint16_t    channels;
    int64_t     length;
    std::string format_name;
    int64_t     timecode;
};

class AudioFileSource : public AudioSource {
  public:
	enum Flag {
		Writable = 0x1,
		CanRename = 0x2,
		Broadcast = 0x4,
		Removable = 0x8,
		RemovableIfEmpty = 0x10,
		RemoveAtDestroy = 0x20,
		NoPeakFile = 0x40,
		Destructive = 0x80
	};

	virtual ~AudioFileSource ();

	bool set_name (const std::string& newname) { return (set_source_name(newname, destructive()) == 0); }
	int set_source_name (Glib::ustring newname, bool destructive);
	
	Glib::ustring path() const { return _path; }
	Glib::ustring peak_path (Glib::ustring audio_path);
	Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
					     Glib::ustring audio_path);

	uint16_t channel() const { return _channel; }

	static void set_peak_dir (Glib::ustring dir) { peak_dir = dir; }

	static bool get_soundfile_info (Glib::ustring path, SoundFileInfo& _info, std::string& error);

	static bool safe_file_extension (Glib::ustring path);

	void set_allow_remove_if_empty (bool yn);
	void mark_for_remove();

	/* this block of methods do nothing for regular file sources, but are significant
	   for files used in destructive recording.
	*/

	virtual nframes_t last_capture_start_frame() const { return 0; }
	virtual void           mark_capture_start (nframes_t) {}
	virtual void           mark_capture_end () {}
	virtual void           clear_capture_marks() {}
	virtual bool           one_of_several_channels () const { return false; }

	virtual int update_header (nframes_t when, struct tm&, time_t) = 0;
	virtual int flush_header () = 0;

	int move_to_trash (const Glib::ustring& trash_dir_name);

	static bool is_empty (Session&, Glib::ustring path);
	void mark_streaming_write_completed ();

	void   mark_take (Glib::ustring);
	Glib::ustring take_id() const { return _take_id; }

	bool is_embedded() const { return _is_embedded; }

	static void set_bwf_serial_number (int);
	
	static void set_search_path (Glib::ustring string);
	static void set_header_position_offset (nframes_t offset );

	int setup_peakfile ();

	static sigc::signal<void> HeaderPositionOffsetChanged;

	XMLNode& get_state ();
	int set_state (const XMLNode&);

	bool destructive() const { return (_flags & Destructive); }
	virtual bool set_destructive (bool yn) { return false; }
	bool can_truncate_peaks() const { return !destructive(); }

	Flag flags() const { return _flags; }

	void mark_immutable ();

	/* this should really be protected, but C++ is getting stricter
	   and creating slots from protected member functions is starting
	   to cause issues.
	*/

	virtual void handle_header_position_change () {}

	bool can_be_analysed() const { return _length > 0; } 

  protected:
	
	/* constructor to be called for existing external-to-session files */

	AudioFileSource (Session&, Glib::ustring path, Flag flags);

	/* constructor to be called for new in-session files */

	AudioFileSource (Session&, Glib::ustring path, Flag flags,
			 SampleFormat samp_format, HeaderFormat hdr_format);

	/* constructor to be called for existing in-session files */

	AudioFileSource (Session&, const XMLNode&, bool must_exit = true);

	int init (Glib::ustring idstr, bool must_exist);

	Glib::ustring _path;
	Flag          _flags;
	Glib::ustring _take_id;
	int64_t       timeline_position;
	bool           file_is_new;
	uint16_t      _channel;

	bool          _is_embedded;
	static bool determine_embeddedness(Glib::ustring path);

	static Glib::ustring peak_dir;
	static Glib::ustring search_path;

	static char bwf_country_code[3];
	static char bwf_organization_code[4];
	static char bwf_serial_number[13];

	static uint64_t header_position_offset;

	virtual void set_timeline_position (int64_t pos);
	virtual void set_header_timeline_position () = 0;

	bool find (Glib::ustring& path, bool must_exist, bool& is_new, uint16_t& chan);
	bool removable() const;
	bool writable() const { return _flags & Writable; }

	static Sample* get_interleave_buffer (nframes_t size);

  private:
	Glib::ustring old_peak_path (Glib::ustring audio_path);
	Glib::ustring broken_peak_path (Glib::ustring audio_path);
};

} // namespace ARDOUR

#endif /* __ardour_audiofilesource_h__ */