SndFunctions.h

//
// $Id: SndFunctions.h 3635 2009-10-20 11:20:56Z leighsmith $
//
//  Description:
//    A library of functions intended to be compatible with NeXTs now defunct SoundKit.
//
//  Original Author: Stephen Brandon <stephen@brandonitconsulting.co.uk>
//
//  This framework and all source code supplied with it, except where specified,
//  are Copyright Stephen Brandon and the University of Glasgow, 1999. You are
//  free to use the source code for any purpose, including commercial applications,
//  as long as you reproduce this notice on all such software.
//
//  Software production is complex and we cannot warrant that the Software will be
//  error free.  Further, we will not be liable to you if the Software is not fit
//  for the purpose for which you acquired it, or of satisfactory quality. 
//
//  WE SPECIFICALLY EXCLUDE TO THE FULLEST EXTENT PERMITTED BY THE COURTS ALL
//  WARRANTIES IMPLIED BY LAW INCLUDING (BUT NOT LIMITED TO) IMPLIED WARRANTIES
//  OF QUALITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT OF THIRD
//  PARTIES RIGHTS.
//
//  If a court finds that we are liable for death or personal injury caused by our
//  negligence our liability shall be unlimited.  
//
//  WE SHALL HAVE NO LIABILITY TO YOU FOR LOSS OF PROFITS, LOSS OF CONTRACTS, LOSS
//  OF DATA, LOSS OF GOODWILL, OR WORK STOPPAGE, WHICH MAY ARISE FROM YOUR
//  POSSESSION OR USE OF THE SOFTWARE OR ASSOCIATED DOCUMENTATION.  WE SHALL HAVE
//  NO LIABILITY IN RESPECT OF ANY USE OF THE SOFTWARE OR THE ASSOCIATED
//  DOCUMENTATION WHERE SUCH USE IS NOT IN COMPLIANCE WITH THE TERMS AND
//  CONDITIONS OF THIS AGREEMENT.
//
//  Portions Copyright (c) 1999, The MusicKit Project.  All rights reserved.
//
//  Permission is granted to use and modify this code for commercial and
//  non-commercial purposes so long as the author attribution and copyright
//  messages remain intact and accompany all relevant code.
//

/* We #import this file regardless of the setting of
   HAVE_CONFIG_H so that other applications compiling against this
   header don't have to define it. If you are seeing errors for
   SndKitConfig.h not found when compiling the MusicKit, you haven't
   run ./configure 
*/
#import "SndKitConfig.h"
#import "SndFormat.h"

#import <Foundation/Foundation.h>

#import "SndError.h"
#import "SndEndianFunctions.h"

#if HAVE_LIBSNDFILE
# import <sndfile.h> /* for libsndfile SNDFILE declaration */
#else
#define SNDFILE void
#endif

SNDKIT_API NSString *SndFormatDescription(SndFormat format);

SNDKIT_API NSString *SndFormatName(SndSampleFormat dataFormat, BOOL verbose);

SNDKIT_API int SndFrameSize(SndFormat sound);

SNDKIT_API double SndMaximumAmplitude(SndSampleFormat dataFormat);

SNDKIT_API int SndSampleWidth(SndSampleFormat dataFormat);

SNDKIT_API int SndBytesToFrames(int byteCount,
                                int channelCount,
                                SndSampleFormat dataFormat);

SNDKIT_API long SndFramesToBytes(long sampleCount, int channelCount, SndSampleFormat dataFormat);

SNDKIT_API SndFormat SndFormatOfSNDStreamBuffer(SNDStreamBuffer *streamBuffer);

SNDKIT_API long SndDataSize(SndFormat format);

SNDKIT_API float SndConvertDecibelsToLinear(float db);

SNDKIT_API float SndConvertLinearToDecibels(float linearAmplitude);

SNDKIT_API int SndWriteSampleData(SNDFILE *sfp, void *soundData, SndFormat soundDataFormat);

SNDKIT_API int SndSwapBigEndianSoundToHost(void *dest,
                                           void *src,
                                           int sampleCount,
                                           int channelCount,
                                           SndSampleFormat dataFormat);

SNDKIT_API int SndSwapHostToBigEndianSound(void *dest,
                                  void *src,
                                   int sampleCount,
                                   int channelCount,
                                   SndSampleFormat dataFormat);

---