Assorted doxygen fixes; no functional changes.
[ardour2.git] / libs / pbd / pbd / sndfile_manager.h
blob8fd155111bb4d77becf5ce1c8f7a106f4071cb77
1 /*
2 Copyright (C) 2010 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 __pbd_sndfile_manager_h__
21 #define __pbd_sndfile_manager_h__
23 #include <sys/types.h>
24 #include <string>
25 #include <map>
26 #include <sndfile.h>
27 #include <glibmm/thread.h>
28 #include "pbd/signals.h"
29 #include "pbd/file_manager.h"
31 namespace PBD {
33 /** FileDescriptor for a file to be opened using libsndfile */
34 class SndFileDescriptor : public FileDescriptor
36 public:
37 SndFileDescriptor (std::string const & file_name, bool writeable, SF_INFO* info);
38 ~SndFileDescriptor ();
40 SNDFILE* allocate ();
42 private:
44 friend class FileManager;
46 bool open ();
47 void close ();
48 bool is_open () const;
50 SNDFILE* _sndfile; ///< SNDFILE* pointer, or 0 if the file is closed
51 SF_INFO* _info; ///< libsndfile's info for this file
56 #endif /* __pbd_sndfile_manager_h__ */