libSYS/include/wav_file.h

   1
   2 /* -----------------------------------------------------------------------------------------------------------
   3 Software License for The Fraunhofer FDK AAC Codec Library for Android
   4
   5 © Copyright  1995 - 2013 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
   6   All rights reserved.
   7
   8  1.    INTRODUCTION
   9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
  10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
  11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
  12
  13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
  14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
  15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
  16 of the MPEG specifications.
  17
  18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
  19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
  20 individually for the purpose of encoding or decoding bit streams in products that are compliant with
  21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
  22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
  23 software may already be covered under those patent licenses when it is used for those licensed purposes only.
  24
  25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
  26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
  27 applications information and documentation.
  28
  29 2.    COPYRIGHT LICENSE
  30
  31 Redistribution and use in source and binary forms, with or without modification, are permitted without
  32 payment of copyright license fees provided that you satisfy the following conditions:
  33
  34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
  35 your modifications thereto in source code form.
  36
  37 You must retain the complete text of this software license in the documentation and/or other materials
  38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
  39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
  40 modifications thereto to recipients of copies in binary form.
  41
  42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without
  43 prior written permission.
  44
  45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
  46 software or your modifications thereto.
  47
  48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
  49 and the date of any change. For modified versions of the FDK AAC Codec, the term
  50 "Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
  51 "Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
  52
  53 3.    NO PATENT LICENSE
  54
  55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
  56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
  57 respect to this software.
  58
  59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
  60 by appropriate patent licenses.
  61
  62 4.    DISCLAIMER
  63
  64 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
  65 "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
  66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
  68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
  69 or business interruption, however caused and on any theory of liability, whether in contract, strict
  70 liability, or tort (including negligence), arising in any way out of the use of this software, even if
  71 advised of the possibility of such damage.
  72
  73 5.    CONTACT INFORMATION
  74
  75 Fraunhofer Institute for Integrated Circuits IIS
  76 Attention: Audio and Multimedia Departments - FDK AAC LL
  77 Am Wolfsmantel 33
  78 91058 Erlangen, Germany
  79
  80 www.iis.fraunhofer.de/amm
  81 amm-info@iis.fraunhofer.de
  82 ----------------------------------------------------------------------------------------------------------- */
  83
  84 /**************************  Fraunhofer IIS FDK SysLib  **********************
  85
  86    Author(s):   Eric Allamanche
  87
  88 ******************************************************************************/
  89
  90 /** \file   wav_file.h
  91  *  \brief  Rudimentary WAVE file read/write support.
  92  *
  93  *  The WAVE file reader/writer is intented to be used in the codec's example
  94  *  framework for easily getting started with encoding/decoding. Therefore
  95  *  it serves mainly for helping quickly understand how a codec's API actually
  96  *  works.
  97  *  Being a WAVE file reader/writer with very basic functionality, it may not be
  98  *  able to read WAVE files that come with unusual configurations.
  99  *  Details on how to use the interface functions can be found in every
 100  *  (encoder/decoder) example framework.
 101  */
 102
 103 #ifndef __WAV_FILE_H__
 104 #define __WAV_FILE_H__
 105
 106
 107
 108 #include "genericStds.h"
 109
 110 #ifdef __cplusplus
 111 extern "C" {
 112 #endif
 113
 114 #define SPEAKER_FRONT_LEFT             0x1
 115 #define SPEAKER_FRONT_RIGHT            0x2
 116 #define SPEAKER_FRONT_CENTER           0x4
 117 #define SPEAKER_LOW_FREQUENCY          0x8
 118 #define SPEAKER_BACK_LEFT              0x10
 119 #define SPEAKER_BACK_RIGHT             0x20
 120 #define SPEAKER_FRONT_LEFT_OF_CENTER   0x40
 121 #define SPEAKER_FRONT_RIGHT_OF_CENTER  0x80
 122 #define SPEAKER_BACK_CENTER            0x100
 123 #define SPEAKER_SIDE_LEFT              0x200
 124 #define SPEAKER_SIDE_RIGHT             0x400
 125 #define SPEAKER_TOP_CENTER             0x800
 126 #define SPEAKER_TOP_FRONT_LEFT         0x1000
 127 #define SPEAKER_TOP_FRONT_CENTER       0x2000
 128 #define SPEAKER_TOP_FRONT_RIGHT        0x4000
 129 #define SPEAKER_TOP_BACK_LEFT          0x8000
 130 #define SPEAKER_TOP_BACK_CENTER        0x10000
 131 #define SPEAKER_TOP_BACK_RIGHT         0x20000
 132 #define SPEAKER_RESERVED               0x80000000
 133
 134 /*!
 135  * RIFF WAVE file struct.
 136  * For details see WAVE file format documentation (for example at http://www.wotsit.org).
 137  */
 138 typedef struct WAV_HEADER
 139 {
 140   char   riffType[4];
 141   UINT   riffSize;
 142   char   waveType[4];
 143   char   formatType[4];
 144   UINT   formatSize;
 145   USHORT compressionCode;
 146   USHORT numChannels;
 147   UINT   sampleRate;
 148   UINT   bytesPerSecond;
 149   USHORT blockAlign;
 150   USHORT bitsPerSample;
 151   char   dataType[4];
 152   UINT   dataSize;
 153 } WAV_HEADER;
 154
 155 struct WAV
 156 {
 157   WAV_HEADER header;
 158   FDKFILE *fp;
 159   UINT channelMask;
 160 };
 161
 162 typedef struct WAV *HANDLE_WAV;
 163
 164 /**
 165  * \brief  Open a WAV file handle for reading.
 166  *
 167  * \param pWav      Pointer to a memory location, where a WAV handle is returned.
 168  * \param filename  File name to be opened.
 169  *
 170  * \return  0 on success and non-zero on failure.
 171  */
 172 INT WAV_InputOpen (HANDLE_WAV *pWav, const char *filename);
 173
 174 /**
 175  * \brief  Read samples from a WAVE file. The samples are automatically re-ordered to the
 176  *         native host endianess and scaled to full scale of the INT_PCM type, from
 177  *         whatever BPS the WAVE file had specified in its header data.
 178  *
 179  *  \param wav           Handle of WAV file.
 180  *  \param sampleBuffer  Pointer to store audio data.
 181  *  \param numSamples    Desired number of samples to read.
 182  *  \param nBufBits      Size in bit of each audio sample of sampleBuffer.
 183  *
 184  *  \return  Number of samples actually read.
 185  */
 186 INT WAV_InputRead (HANDLE_WAV wav, void *sampleBuffer, UINT numSamples, int nBufBits);
 187
 188 /**
 189  * \brief       Close a WAV file reading handle.
 190  * \param pWav  Pointer to a WAV file reading handle.
 191  * \return      void
 192  */
 193 void WAV_InputClose(HANDLE_WAV *pWav);
 194
 195 /**
 196  * \brief  Open WAV output/writer handle.
 197  *
 198  * \param pWav            Pointer to WAV handle to be returned.
 199  * \param outputFilename  File name of the file to be written to.
 200  * \param sampleRate      Desired samplerate of the resulting WAV file.
 201  * \param numChannels     Desired number of audio channels of the resulting WAV file.
 202  * \param bitsPerSample   Desired number of bits per audio sample of the resulting WAV file.
 203  *
 204  * \return  0: ok; -1: error
 205  */
 206 INT WAV_OutputOpen(HANDLE_WAV *pWav, const char *outputFilename, INT sampleRate, INT numChannels, INT bitsPerSample);
 207
 208 /**
 209  * \brief  Write data to WAV file asociated to WAV handle.
 210  *
 211  * \param wav              Handle of WAV file
 212  * \param sampleBuffer     Pointer to audio samples, right justified integer values.
 213  * \param numberOfSamples  The number of individual audio sample valuesto be written.
 214  * \param nBufBits         Size in bits of each audio sample in sampleBuffer.
 215  * \param nSigBits         Amount of significant bits of each nBufBits in sampleBuffer.
 216  *
 217  * \return 0: ok; -1: error
 218  */
 219 INT WAV_OutputWrite(HANDLE_WAV wav, void *sampleBuffer, UINT numberOfSamples, int nBufBits, int nSigBits);
 220
 221 /**
 222  * \brief       Close WAV output handle.
 223  * \param pWav  Pointer to WAV handle. *pWav is set to NULL.
 224  * \return      void
 225  */
 226 void WAV_OutputClose(HANDLE_WAV *pWav);
 227
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232
 233 #endif /* __WAV_FILE_H__ */