2 ** Copyright (C) 2005-2007 Erik de Castro Lopo <erikd@mega-nerd.com>
4 ** All rights reserved.
6 ** Redistribution and use in source and binary forms, with or without
7 ** modification, are permitted provided that the following conditions are
10 ** * Redistributions of source code must retain the above copyright
11 ** notice, this list of conditions and the following disclaimer.
12 ** * Redistributions in binary form must reproduce the above copyright
13 ** notice, this list of conditions and the following disclaimer in
14 ** the documentation and/or other materials provided with the
16 ** * Neither the author nor the names of any contributors may be used
17 ** to endorse or promote products derived from this software without
18 ** specific prior written permission.
20 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 ** TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 ** PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24 ** CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 ** EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 ** PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27 ** OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28 ** WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 ** OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
30 ** ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 ** The above modified BSD style license (GPL and LGPL compatible) applies to
35 ** this file. It does not apply to libsndfile itself which is released under
36 ** the GNU LGPL or the libsndfile test suite which is released under the GNU
38 ** This means that this header file can be used under this modified BSD style
39 ** license, but the LGPL still holds for the libsndfile library itself.
43 ** sndfile.hh -- A lightweight C++ wrapper for the libsndfile API.
45 ** All the methods are inlines and all functionality is contained in this
46 ** file. There is no separate implementation file.
48 ** API documentation is in the doc/ directory of the source code tarball
49 ** and at http://www.mega-nerd.com/libsndfile/api.html.
55 #include <sys/types.h>
60 #include "pbd/gstdio_compat.h"
65 #include <new> // for std::nothrow
68 namespace AudioGrapher {
73 { SNDFILE_ref (void) ;
84 /* Default constructor */
85 SndfileHandle (void) : p (NULL) {} ;
86 SndfileHandle (const char *path, int mode = SFM_READ,
87 int format = 0, int channels = 0, int samplerate = 0) ;
88 SndfileHandle (std::string const & path, int mode = SFM_READ,
89 int format = 0, int channels = 0, int samplerate = 0) ;
90 SndfileHandle (int fd, bool close_desc, int mode = SFM_READ,
91 int format = 0, int channels = 0, int samplerate = 0) ;
92 ~SndfileHandle (void) ;
94 SndfileHandle (const SndfileHandle &orig) ;
95 SndfileHandle & operator = (const SndfileHandle &rhs) ;
99 /* Mainly for debugging/testing. */
100 int refCount (void) const { return (p == NULL) ? 0 : p->ref ; }
102 operator bool () const { return (p != NULL) ; }
104 bool operator == (const SndfileHandle &rhs) const { return (p == rhs.p) ; }
106 sf_count_t frames (void) const { return p ? p->sfinfo.frames : 0 ; }
107 int format (void) const { return p ? p->sfinfo.format : 0 ; }
108 int channels (void) const { return p ? p->sfinfo.channels : 0 ; }
109 int samplerate (void) const { return p ? p->sfinfo.samplerate : 0 ; }
111 int error (void) const ;
112 const char * strError (void) const ;
114 int command (int cmd, void *data, int datasize) ;
116 sf_count_t seek (sf_count_t frames, int whence) ;
118 void writeSync (void) ;
120 int setString (int str_type, const char* str) ;
122 const char* getString (int str_type) const ;
124 static int formatCheck (int format, int channels, int samplerate) ;
126 sf_count_t read (short *ptr, sf_count_t items) ;
127 sf_count_t read (int *ptr, sf_count_t items) ;
128 sf_count_t read (float *ptr, sf_count_t items) ;
129 sf_count_t read (double *ptr, sf_count_t items) ;
131 sf_count_t write (const short *ptr, sf_count_t items) ;
132 sf_count_t write (const int *ptr, sf_count_t items) ;
133 sf_count_t write (const float *ptr, sf_count_t items) ;
134 sf_count_t write (const double *ptr, sf_count_t items) ;
136 sf_count_t readf (short *ptr, sf_count_t frames) ;
137 sf_count_t readf (int *ptr, sf_count_t frames) ;
138 sf_count_t readf (float *ptr, sf_count_t frames) ;
139 sf_count_t readf (double *ptr, sf_count_t frames) ;
141 sf_count_t writef (const short *ptr, sf_count_t frames) ;
142 sf_count_t writef (const int *ptr, sf_count_t frames) ;
143 sf_count_t writef (const float *ptr, sf_count_t frames) ;
144 sf_count_t writef (const double *ptr, sf_count_t frames) ;
146 sf_count_t readRaw (void *ptr, sf_count_t bytes) ;
147 sf_count_t writeRaw (const void *ptr, sf_count_t bytes) ;
151 /*==============================================================================
152 ** Nothing but implementation below.
156 SndfileHandle::SNDFILE_ref::SNDFILE_ref (void)
161 SndfileHandle::SNDFILE_ref::~SNDFILE_ref (void)
162 { if (sf != NULL) { sf_close (sf) ; } }
166 SndfileHandle::close (void)
168 if (p != NULL && --p->ref == 0)
177 SndfileHandle::SndfileHandle (const char *path, int mode, int fmt, int chans, int srate)
180 p = new (std::nothrow) SNDFILE_ref () ;
185 p->sfinfo.frames = 0 ;
186 p->sfinfo.channels = chans ;
187 p->sfinfo.format = fmt ;
188 p->sfinfo.samplerate = srate ;
189 p->sfinfo.sections = 0 ;
190 p->sfinfo.seekable = 0 ;
192 bool writable = false;
193 if (mode & SFM_WRITE) {
196 #ifdef PLATFORM_WINDOWS
197 int fd = g_open (path, writable ? O_CREAT | O_RDWR : O_RDONLY, writable ? 0644 : 0444);
199 int fd = ::open (path, writable ? O_CREAT | O_RDWR : O_RDONLY, writable ? 0644 : 0444);
202 p->sf = sf_open_fd (fd, mode, &p->sfinfo, true) ;
206 } /* SndfileHandle const char * constructor */
209 SndfileHandle::SndfileHandle (std::string const & path, int mode, int fmt, int chans, int srate)
212 p = new (std::nothrow) SNDFILE_ref () ;
217 p->sfinfo.frames = 0 ;
218 p->sfinfo.channels = chans ;
219 p->sfinfo.format = fmt ;
220 p->sfinfo.samplerate = srate ;
221 p->sfinfo.sections = 0 ;
222 p->sfinfo.seekable = 0 ;
224 bool writable = false;
225 if (mode & SFM_WRITE) {
228 #ifdef PLATFORM_WINDOWS
229 int fd = g_open (path.c_str(), writable ? O_CREAT | O_RDWR : O_RDONLY, writable ? 0644 : 0444);
231 int fd = ::open (path.c_str(), writable ? O_CREAT | O_RDWR : O_RDONLY, writable ? 0644 : 0444);
234 p->sf = sf_open_fd (fd, mode, &p->sfinfo, true) ;
238 } /* SndfileHandle std::string constructor */
241 SndfileHandle::SndfileHandle (int fd, bool close_desc, int mode, int fmt, int chans, int srate)
247 p = new (std::nothrow) SNDFILE_ref () ;
252 p->sfinfo.frames = 0 ;
253 p->sfinfo.channels = chans ;
254 p->sfinfo.format = fmt ;
255 p->sfinfo.samplerate = srate ;
256 p->sfinfo.sections = 0 ;
257 p->sfinfo.seekable = 0 ;
259 p->sf = sf_open_fd (fd, mode, &p->sfinfo, close_desc) ;
263 } /* SndfileHandle fd constructor */
266 SndfileHandle::~SndfileHandle (void)
267 { if (p != NULL && --p->ref == 0)
269 } /* SndfileHandle destructor */
273 SndfileHandle::SndfileHandle (const SndfileHandle &orig)
277 } /* SndfileHandle copy constructor */
279 inline SndfileHandle &
280 SndfileHandle::operator = (const SndfileHandle &rhs)
284 if (p != NULL && --p->ref == 0)
292 } /* SndfileHandle assignment operator */
295 SndfileHandle::error (void) const
296 { return sf_error (p->sf) ; }
299 SndfileHandle::strError (void) const
300 { return sf_strerror (p->sf) ; }
303 SndfileHandle::command (int cmd, void *data, int datasize)
304 { return sf_command (p->sf, cmd, data, datasize) ; }
307 SndfileHandle::seek (sf_count_t frame_count, int whence)
308 { return sf_seek (p->sf, frame_count, whence) ; }
311 SndfileHandle::writeSync (void)
312 { sf_write_sync (p->sf) ; }
315 SndfileHandle::setString (int str_type, const char* str)
316 { return sf_set_string (p->sf, str_type, str) ; }
319 SndfileHandle::getString (int str_type) const
320 { return sf_get_string (p->sf, str_type) ; }
323 SndfileHandle::formatCheck(int fmt, int chans, int srate)
328 sfinfo.channels = chans ;
329 sfinfo.format = fmt ;
330 sfinfo.samplerate = srate ;
331 sfinfo.sections = 0 ;
332 sfinfo.seekable = 0 ;
334 return sf_format_check (&sfinfo) ;
337 /*---------------------------------------------------------------------*/
340 SndfileHandle::read (short *ptr, sf_count_t items)
341 { return sf_read_short (p->sf, ptr, items) ; }
344 SndfileHandle::read (int *ptr, sf_count_t items)
345 { return sf_read_int (p->sf, ptr, items) ; }
348 SndfileHandle::read (float *ptr, sf_count_t items)
349 { return sf_read_float (p->sf, ptr, items) ; }
352 SndfileHandle::read (double *ptr, sf_count_t items)
353 { return sf_read_double (p->sf, ptr, items) ; }
356 SndfileHandle::write (const short *ptr, sf_count_t items)
357 { return sf_write_short (p->sf, ptr, items) ; }
360 SndfileHandle::write (const int *ptr, sf_count_t items)
361 { return sf_write_int (p->sf, ptr, items) ; }
364 SndfileHandle::write (const float *ptr, sf_count_t items)
365 { return sf_write_float (p->sf, ptr, items) ; }
368 SndfileHandle::write (const double *ptr, sf_count_t items)
369 { return sf_write_double (p->sf, ptr, items) ; }
372 SndfileHandle::readf (short *ptr, sf_count_t frame_count)
373 { return sf_readf_short (p->sf, ptr, frame_count) ; }
376 SndfileHandle::readf (int *ptr, sf_count_t frame_count)
377 { return sf_readf_int (p->sf, ptr, frame_count) ; }
380 SndfileHandle::readf (float *ptr, sf_count_t frame_count)
381 { return sf_readf_float (p->sf, ptr, frame_count) ; }
384 SndfileHandle::readf (double *ptr, sf_count_t frame_count)
385 { return sf_readf_double (p->sf, ptr, frame_count) ; }
388 SndfileHandle::writef (const short *ptr, sf_count_t frame_count)
389 { return sf_writef_short (p->sf, ptr, frame_count) ; }
392 SndfileHandle::writef (const int *ptr, sf_count_t frame_count)
393 { return sf_writef_int (p->sf, ptr, frame_count) ; }
396 SndfileHandle::writef (const float *ptr, sf_count_t frame_count)
397 { return sf_writef_float (p->sf, ptr, frame_count) ; }
400 SndfileHandle::writef (const double *ptr, sf_count_t frame_count)
401 { return sf_writef_double (p->sf, ptr, frame_count) ; }
404 SndfileHandle::readRaw (void *ptr, sf_count_t bytes)
405 { return sf_read_raw (p->sf, ptr, bytes) ; }
408 SndfileHandle::writeRaw (const void *ptr, sf_count_t bytes)
409 { return sf_write_raw (p->sf, ptr, bytes) ; }
412 #ifdef ENABLE_SNDFILE_WINDOWS_PROTOTYPES
415 SndfileHandle::SndfileHandle (LPCWSTR wpath, int mode, int fmt, int chans, int srate)
418 p = new (std::nothrow) SNDFILE_ref () ;
423 p->sfinfo.frames = 0 ;
424 p->sfinfo.channels = chans ;
425 p->sfinfo.format = fmt ;
426 p->sfinfo.samplerate = srate ;
427 p->sfinfo.sections = 0 ;
428 p->sfinfo.seekable = 0 ;
430 p->sf = sf_wchar_open (wpath, mode, &p->sfinfo) ;
434 } /* SndfileHandle const wchar_t * constructor */
438 } // namespace AudioGrapher
440 #endif /* SNDFILE_HH */