Merge branch 'master' into cairocanvas
[ardour.git] / libs / ardour / ardour / sndfilesource.h
1 /*
2     Copyright (C) 2006 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #ifndef __sndfile_source_h__
21 #define __sndfile_source_h__
22
23 #include <sndfile.h>
24
25 #include "ardour/audiofilesource.h"
26 #include "ardour/broadcast_info.h"
27 #include "pbd/sndfile_manager.h"
28
29 namespace ARDOUR {
30
31 class LIBARDOUR_API SndFileSource : public AudioFileSource {
32   public:
33         /** Constructor to be called for existing external-to-session files */
34         SndFileSource (Session&, const std::string& path, int chn, Flag flags);
35
36         /* Constructor to be called for new in-session files */
37         SndFileSource (Session&, const std::string& path, const std::string& origin,
38                        SampleFormat samp_format, HeaderFormat hdr_format, framecnt_t rate,
39                        Flag flags = SndFileSource::default_writable_flags);
40
41         /** Constructor to be called for existing in-session files */
42         SndFileSource (Session&, const XMLNode&);
43
44         ~SndFileSource ();
45
46         float sample_rate () const;
47         int update_header (framepos_t when, struct tm&, time_t);
48         int flush_header ();
49         void flush ();
50
51         framepos_t natural_position () const;
52
53         framepos_t last_capture_start_frame() const;
54         void mark_capture_start (framepos_t);
55         void mark_capture_end ();
56         void clear_capture_marks();
57
58         bool set_destructive (bool yn);
59
60         bool one_of_several_channels () const;
61
62         bool clamped_at_unity () const;
63
64         static void setup_standard_crossfades (Session const &, framecnt_t sample_rate);
65         static const Source::Flag default_writable_flags;
66
67         static int get_soundfile_info (const std::string& path, SoundFileInfo& _info, std::string& error_msg);
68
69   protected:
70         void set_path (const std::string& p);
71         void set_header_timeline_position ();
72
73         framecnt_t read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const;
74         framecnt_t write_unlocked (Sample *dst, framecnt_t cnt);
75         framecnt_t write_float (Sample* data, framepos_t pos, framecnt_t cnt);
76
77   private:
78         PBD::SndFileDescriptor* _descriptor;
79         SF_INFO _info;
80         BroadcastInfo *_broadcast_info;
81
82         void init_sndfile ();
83         int open();
84         int setup_broadcast_info (framepos_t when, struct tm&, time_t);
85         void file_closed ();
86
87         /* destructive */
88
89         static framecnt_t xfade_frames;
90         static gain_t* out_coefficient;
91         static gain_t* in_coefficient;
92
93         bool          _capture_start;
94         bool          _capture_end;
95         framepos_t     capture_start_frame;
96         framepos_t     file_pos; // unit is frames
97         framecnt_t     xfade_out_count;
98         framecnt_t     xfade_in_count;
99         Sample*        xfade_buf;
100
101         framecnt_t crossfade (Sample* data, framecnt_t cnt, int dir);
102         void set_timeline_position (framepos_t);
103         framecnt_t destructive_write_unlocked (Sample *dst, framecnt_t cnt);
104         framecnt_t nondestructive_write_unlocked (Sample *dst, framecnt_t cnt);
105         void handle_header_position_change ();
106         PBD::ScopedConnection header_position_connection;
107         PBD::ScopedConnection file_manager_connection;
108 };
109
110 } // namespace ARDOUR
111
112 #endif /* __sndfile_source_h__ */
113