libs/audiographer/private/sndfile.hh

   1 /*
   2 ** Copyright (C) 2005-2007 Erik de Castro Lopo <erikd@mega-nerd.com>
   3 **
   4 ** All rights reserved.
   5 **
   6 ** Redistribution and use in source and binary forms, with or without
   7 ** modification, are permitted provided that the following conditions are
   8 ** met:
   9 **
  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
  15 **       distribution.
  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.
  19 **
  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.
  31 */
  32
  33 /*
  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
  37 ** GPL.
  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.
  40 */
  41
  42 /*
  43 ** sndfile.hh -- A lightweight C++ wrapper for the libsndfile API.
  44 **
  45 ** All the methods are inlines and all functionality is contained in this
  46 ** file. There is no separate implementation file.
  47 **
  48 ** API documentation is in the doc/ directory of the source code tarball
  49 ** and at http://www.mega-nerd.com/libsndfile/api.html.
  50 */
  51
  52 #ifndef SNDFILE_HH
  53 #define SNDFILE_HH
  54
  55 #include <sndfile.h>
  56
  57 #include <string>
  58 #include <new> // for std::nothrow
  59
  60 // Prevent conflicts
  61 namespace AudioGrapher {
  62
  63 class SndfileHandle
  64 {       private :
  65                 struct SNDFILE_ref
  66                 {       SNDFILE_ref (void) ;
  67                         ~SNDFILE_ref (void) ;
  68
  69                         SNDFILE *sf ;
  70                         SF_INFO sfinfo ;
  71                         int ref ;
  72                         } ;
  73
  74                 SNDFILE_ref *p ;
  75
  76         public :
  77                         /* Default constructor */
  78                         SndfileHandle (void) : p (NULL) {} ;
  79                         SndfileHandle (const char *path, int mode = SFM_READ,
  80                                                         int format = 0, int channels = 0, int samplerate = 0) ;
  81                         SndfileHandle (std::string const & path, int mode = SFM_READ,
  82                                                         int format = 0, int channels = 0, int samplerate = 0) ;
  83                         SndfileHandle (int fd, bool close_desc, int mode = SFM_READ,
  84                                                         int format = 0, int channels = 0, int samplerate = 0) ;
  85                         ~SndfileHandle (void) ;
  86
  87                         SndfileHandle (const SndfileHandle &orig) ;
  88                         SndfileHandle & operator = (const SndfileHandle &rhs) ;
  89
  90                 /* Mainly for debugging/testing. */
  91                 int refCount (void) const { return (p == NULL) ? 0 : p->ref ; }
  92
  93                 operator bool () const { return (p != NULL) ; }
  94
  95                 bool operator == (const SndfileHandle &rhs) const { return (p == rhs.p) ; }
  96
  97                 sf_count_t      frames (void) const             { return p ? p->sfinfo.frames : 0 ; }
  98                 int                     format (void) const             { return p ? p->sfinfo.format : 0 ; }
  99                 int                     channels (void) const   { return p ? p->sfinfo.channels : 0 ; }
 100                 int                     samplerate (void) const { return p ? p->sfinfo.samplerate : 0 ; }
 101
 102                 int error (void) const ;
 103                 const char * strError (void) const ;
 104
 105                 int command (int cmd, void *data, int datasize) ;
 106
 107                 sf_count_t      seek (sf_count_t frames, int whence) ;
 108
 109                 void writeSync (void) ;
 110
 111                 int setString (int str_type, const char* str) ;
 112
 113                 const char* getString (int str_type) const ;
 114
 115                 static int formatCheck (int format, int channels, int samplerate) ;
 116
 117                 sf_count_t read (short *ptr, sf_count_t items) ;
 118                 sf_count_t read (int *ptr, sf_count_t items) ;
 119                 sf_count_t read (float *ptr, sf_count_t items) ;
 120                 sf_count_t read (double *ptr, sf_count_t items) ;
 121
 122                 sf_count_t write (const short *ptr, sf_count_t items) ;
 123                 sf_count_t write (const int *ptr, sf_count_t items) ;
 124                 sf_count_t write (const float *ptr, sf_count_t items) ;
 125                 sf_count_t write (const double *ptr, sf_count_t items) ;
 126
 127                 sf_count_t readf (short *ptr, sf_count_t frames) ;
 128                 sf_count_t readf (int *ptr, sf_count_t frames) ;
 129                 sf_count_t readf (float *ptr, sf_count_t frames) ;
 130                 sf_count_t readf (double *ptr, sf_count_t frames) ;
 131
 132                 sf_count_t writef (const short *ptr, sf_count_t frames) ;
 133                 sf_count_t writef (const int *ptr, sf_count_t frames) ;
 134                 sf_count_t writef (const float *ptr, sf_count_t frames) ;
 135                 sf_count_t writef (const double *ptr, sf_count_t frames) ;
 136
 137                 sf_count_t      readRaw         (void *ptr, sf_count_t bytes) ;
 138                 sf_count_t      writeRaw        (const void *ptr, sf_count_t bytes) ;
 139
 140 } ;
 141
 142 /*==============================================================================
 143 **      Nothing but implementation below.
 144 */
 145
 146 inline
 147 SndfileHandle::SNDFILE_ref::SNDFILE_ref (void)
 148 : ref (1)
 149 {}
 150
 151 inline
 152 SndfileHandle::SNDFILE_ref::~SNDFILE_ref (void)
 153 {       if (sf != NULL) { sf_close (sf) ; } }
 154
 155 inline
 156 SndfileHandle::SndfileHandle (const char *path, int mode, int fmt, int chans, int srate)
 157 : p (NULL)
 158 {
 159         p = new (std::nothrow) SNDFILE_ref () ;
 160
 161         if (p != NULL)
 162         {       p->ref = 1 ;
 163
 164                 p->sfinfo.frames = 0 ;
 165                 p->sfinfo.channels = chans ;
 166                 p->sfinfo.format = fmt ;
 167                 p->sfinfo.samplerate = srate ;
 168                 p->sfinfo.sections = 0 ;
 169                 p->sfinfo.seekable = 0 ;
 170
 171                 p->sf = sf_open (path, mode, &p->sfinfo) ;
 172                 } ;
 173
 174         return ;
 175 } /* SndfileHandle const char * constructor */
 176
 177 inline
 178 SndfileHandle::SndfileHandle (std::string const & path, int mode, int fmt, int chans, int srate)
 179 : p (NULL)
 180 {
 181         p = new (std::nothrow) SNDFILE_ref () ;
 182
 183         if (p != NULL)
 184         {       p->ref = 1 ;
 185
 186                 p->sfinfo.frames = 0 ;
 187                 p->sfinfo.channels = chans ;
 188                 p->sfinfo.format = fmt ;
 189                 p->sfinfo.samplerate = srate ;
 190                 p->sfinfo.sections = 0 ;
 191                 p->sfinfo.seekable = 0 ;
 192
 193                 p->sf = sf_open (path.c_str (), mode, &p->sfinfo) ;
 194                 } ;
 195
 196         return ;
 197 } /* SndfileHandle std::string constructor */
 198
 199 inline
 200 SndfileHandle::SndfileHandle (int fd, bool close_desc, int mode, int fmt, int chans, int srate)
 201 : p (NULL)
 202 {
 203         if (fd < 0)
 204                 return;
 205
 206         p = new (std::nothrow) SNDFILE_ref () ;
 207
 208         if (p != NULL)
 209         {       p->ref = 1 ;
 210
 211                 p->sfinfo.frames = 0 ;
 212                 p->sfinfo.channels = chans ;
 213                 p->sfinfo.format = fmt ;
 214                 p->sfinfo.samplerate = srate ;
 215                 p->sfinfo.sections = 0 ;
 216                 p->sfinfo.seekable = 0 ;
 217
 218                 p->sf = sf_open_fd (fd, mode, &p->sfinfo, close_desc) ;
 219                 } ;
 220
 221         return ;
 222 } /* SndfileHandle fd constructor */
 223
 224 inline
 225 SndfileHandle::~SndfileHandle (void)
 226 {       if (p != NULL && --p->ref == 0)
 227                 delete p ;
 228 } /* SndfileHandle destructor */
 229
 230
 231 inline
 232 SndfileHandle::SndfileHandle (const SndfileHandle &orig)
 233 : p (orig.p)
 234 {       if (p != NULL)
 235                 ++p->ref ;
 236 } /* SndfileHandle copy constructor */
 237
 238 inline SndfileHandle &
 239 SndfileHandle::operator = (const SndfileHandle &rhs)
 240 {
 241         if (&rhs == this)
 242                 return *this ;
 243         if (p != NULL && --p->ref == 0)
 244                 delete p ;
 245
 246         p = rhs.p ;
 247         if (p != NULL)
 248                 ++p->ref ;
 249
 250         return *this ;
 251 } /* SndfileHandle assignment operator */
 252
 253 inline int
 254 SndfileHandle::error (void) const
 255 {       return sf_error (p->sf) ; }
 256
 257 inline const char *
 258 SndfileHandle::strError (void) const
 259 {       return sf_strerror (p->sf) ; }
 260
 261 inline int
 262 SndfileHandle::command (int cmd, void *data, int datasize)
 263 {       return sf_command (p->sf, cmd, data, datasize) ; }
 264
 265 inline sf_count_t
 266 SndfileHandle::seek (sf_count_t frame_count, int whence)
 267 {       return sf_seek (p->sf, frame_count, whence) ; }
 268
 269 inline void
 270 SndfileHandle::writeSync (void)
 271 {       sf_write_sync (p->sf) ; }
 272
 273 inline int
 274 SndfileHandle::setString (int str_type, const char* str)
 275 {       return sf_set_string (p->sf, str_type, str) ; }
 276
 277 inline const char*
 278 SndfileHandle::getString (int str_type) const
 279 {       return sf_get_string (p->sf, str_type) ; }
 280
 281 inline int
 282 SndfileHandle::formatCheck(int fmt, int chans, int srate)
 283 {
 284         SF_INFO sfinfo ;
 285
 286         sfinfo.frames = 0 ;
 287         sfinfo.channels = chans ;
 288         sfinfo.format = fmt ;
 289         sfinfo.samplerate = srate ;
 290         sfinfo.sections = 0 ;
 291         sfinfo.seekable = 0 ;
 292
 293         return sf_format_check (&sfinfo) ;
 294 }
 295
 296 /*---------------------------------------------------------------------*/
 297
 298 inline sf_count_t
 299 SndfileHandle::read (short *ptr, sf_count_t items)
 300 {       return sf_read_short (p->sf, ptr, items) ; }
 301
 302 inline sf_count_t
 303 SndfileHandle::read (int *ptr, sf_count_t items)
 304 {       return sf_read_int (p->sf, ptr, items) ; }
 305
 306 inline sf_count_t
 307 SndfileHandle::read (float *ptr, sf_count_t items)
 308 {       return sf_read_float (p->sf, ptr, items) ; }
 309
 310 inline sf_count_t
 311 SndfileHandle::read (double *ptr, sf_count_t items)
 312 {       return sf_read_double (p->sf, ptr, items) ; }
 313
 314 inline sf_count_t
 315 SndfileHandle::write (const short *ptr, sf_count_t items)
 316 {       return sf_write_short (p->sf, ptr, items) ; }
 317
 318 inline sf_count_t
 319 SndfileHandle::write (const int *ptr, sf_count_t items)
 320 {       return sf_write_int (p->sf, ptr, items) ; }
 321
 322 inline sf_count_t
 323 SndfileHandle::write (const float *ptr, sf_count_t items)
 324 {       return sf_write_float (p->sf, ptr, items) ; }
 325
 326 inline sf_count_t
 327 SndfileHandle::write (const double *ptr, sf_count_t items)
 328 {       return sf_write_double (p->sf, ptr, items) ; }
 329
 330 inline sf_count_t
 331 SndfileHandle::readf (short *ptr, sf_count_t frame_count)
 332 {       return sf_readf_short (p->sf, ptr, frame_count) ; }
 333
 334 inline sf_count_t
 335 SndfileHandle::readf (int *ptr, sf_count_t frame_count)
 336 {       return sf_readf_int (p->sf, ptr, frame_count) ; }
 337
 338 inline sf_count_t
 339 SndfileHandle::readf (float *ptr, sf_count_t frame_count)
 340 {       return sf_readf_float (p->sf, ptr, frame_count) ; }
 341
 342 inline sf_count_t
 343 SndfileHandle::readf (double *ptr, sf_count_t frame_count)
 344 {       return sf_readf_double (p->sf, ptr, frame_count) ; }
 345
 346 inline sf_count_t
 347 SndfileHandle::writef (const short *ptr, sf_count_t frame_count)
 348 {       return sf_writef_short (p->sf, ptr, frame_count) ; }
 349
 350 inline sf_count_t
 351 SndfileHandle::writef (const int *ptr, sf_count_t frame_count)
 352 {       return sf_writef_int (p->sf, ptr, frame_count) ; }
 353
 354 inline sf_count_t
 355 SndfileHandle::writef (const float *ptr, sf_count_t frame_count)
 356 {       return sf_writef_float (p->sf, ptr, frame_count) ; }
 357
 358 inline sf_count_t
 359 SndfileHandle::writef (const double *ptr, sf_count_t frame_count)
 360 {       return sf_writef_double (p->sf, ptr, frame_count) ; }
 361
 362 inline sf_count_t
 363 SndfileHandle::readRaw (void *ptr, sf_count_t bytes)
 364 {       return sf_read_raw (p->sf, ptr, bytes) ; }
 365
 366 inline sf_count_t
 367 SndfileHandle::writeRaw (const void *ptr, sf_count_t bytes)
 368 {       return sf_write_raw (p->sf, ptr, bytes) ; }
 369
 370
 371 #ifdef ENABLE_SNDFILE_WINDOWS_PROTOTYPES
 372
 373 inline
 374 SndfileHandle::SndfileHandle (LPCWSTR wpath, int mode, int fmt, int chans, int srate)
 375 : p (NULL)
 376 {
 377         p = new (std::nothrow) SNDFILE_ref () ;
 378
 379         if (p != NULL)
 380         {       p->ref = 1 ;
 381
 382                 p->sfinfo.frames = 0 ;
 383                 p->sfinfo.channels = chans ;
 384                 p->sfinfo.format = fmt ;
 385                 p->sfinfo.samplerate = srate ;
 386                 p->sfinfo.sections = 0 ;
 387                 p->sfinfo.seekable = 0 ;
 388
 389                 p->sf = sf_wchar_open (wpath, mode, &p->sfinfo) ;
 390                 } ;
 391
 392         return ;
 393 } /* SndfileHandle const wchar_t * constructor */
 394
 395 #endif
 396
 397 } // namespace AudioGrapher
 398
 399 #endif  /* SNDFILE_HH */
 400