libPCMutils/include/pcmutils_lib.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 /************************  FDK PCM up/downmixing module  *********************
  85
  86    Author(s):   Christian Griebel
  87    Description: Declares functions to interface with the PCM downmix processing
  88                 module.
  89
  90 *******************************************************************************/
  91
  92 #ifndef _PCMUTILS_LIB_H_
  93 #define _PCMUTILS_LIB_H_
  94
  95 #include "machine_type.h"
  96 #include "common_fix.h"
  97 #include "FDK_audio.h"
  98
  99 /* ------------------------ *
 100  *     MODULE SETTINGS:     *
 101  * ------------------------ */
 102 /* #define PCM_UPMIX_ENABLE */       /*!< Generally enable up mixing.                           */
 103 #define PCM_DOWNMIX_ENABLE           /*!< Generally enable down mixing.                         */
 104 #define DVB_MIXDOWN_ENABLE           /*!< Enable this to support DVB ancillary data for encoder
 105                                           assisted downmixing of MPEG-4 AAC and
 106                                           MPEG-1/2 layer 2 streams. PCM_DOWNMIX_ENABLE has to
 107                                           be enabled, too!                                      */
 108 #define MPEG_PCE_MIXDOWN_ENABLE      /*!< Enable this to support MPEG matrix mixdown with a
 109                                           coefficient carried in the PCE. PCM_DOWNMIX_ENABLE
 110                                           has to be enabled, too!                               */
 111 /* #define ARIB_MIXDOWN_ENABLE */    /*!< Enable modifications to the MPEG PCE mixdown method
 112                                           to fulfill ARIB standard. MPEG_PCE_MIXDOWN_ENABLE has
 113                                           to be set.                                            */
 114
 115 /* ------------------------ *
 116  *     ERROR CODES:         *
 117  * ------------------------ */
 118 typedef enum
 119 {
 120   PCMDMX_OK              = 0x0,    /*!< No error happened.                                     */
 121   PCMDMX_OUT_OF_MEMORY   = 0x2,    /*!< Not enough memory to set up an instance of the module. */
 122   PCMDMX_UNKNOWN         = 0x5,    /*!< Error condition is of unknown reason, or from a third
 123                                           party module.                                        */
 124   PCMDMX_INVALID_HANDLE,           /*!< The given instance handle is not valid.                */
 125   PCMDMX_INVALID_ARGUMENT,         /*!< One of the parameters handed over is invalid.          */
 126   PCMDMX_INVALID_CH_CONFIG,        /*!< The given channel configuration is not supported and
 127                                           thus no processing was performed.                    */
 128   PCMDMX_INVALID_MODE,             /*!< The set configuration/mode is not applicable.          */
 129   PCMDMX_UNKNOWN_PARAM,            /*!< The handed parameter is not known/supported.           */
 130   PCMDMX_UNABLE_TO_SET_PARAM,      /*!< Unable to set the specific parameter. Most probably
 131                                           the value ist out of range.                          */
 132   PCMDMX_CORRUPT_ANC_DATA          /*!< The read ancillary data was corrupt.                   */
 133
 134 } PCMDMX_ERROR;
 135
 136
 137 /* ------------------------ *
 138  *     RUNTIME PARAMS:      *
 139  * ------------------------ */
 140 typedef enum
 141 {
 142   DMX_BS_DATA_EXPIRY_FRAME,          /*!< The number of frames without new metadata that have to
 143                                             go by before the bitstream data expires. The value 0
 144                                             disables expiry.                                     */
 145   DMX_BS_DATA_DELAY,                 /*!< The number of delay frames of the output samples
 146                                             compared to the bitstream data.                      */
 147   NUMBER_OF_OUTPUT_CHANNELS ,        /*!< The number of output channels (equals the number of
 148                                             channels processed by the audio output setup).       */
 149   DUAL_CHANNEL_DOWNMIX_MODE          /*!< Downmix mode for two channel audio data.               */
 150
 151 } PCMDMX_PARAM;
 152
 153
 154 typedef enum
 155 {
 156   STEREO_MODE = 0x0,           /*!< Leave stereo signals as they are.                            */
 157   CH1_MODE    = 0x1,           /*!< Create a dual mono output signal from channel 1.             */
 158   CH2_MODE    = 0x2,           /*!< Create a dual mono output signal from channel 2.             */
 159   MIXED_MODE  = 0x3            /*!< Create a dual mono output signal by mixing the two channels. */
 160
 161 } DUAL_CHANNEL_MODE;
 162
 163
 164 /* ------------------------ *
 165  *     MODULES INTERFACE:   *
 166  * ------------------------ */
 167 typedef struct PCM_DMX_INSTANCE *HANDLE_PCM_DOWNMIX;
 168
 169 /* Modules reset flags */
 170 #define PCMDMX_RESET_PARAMS   ( 1 )
 171 #define PCMDMX_RESET_BS_DATA  ( 2 )
 172 #define PCMDMX_RESET_FULL     ( PCMDMX_RESET_PARAMS | PCMDMX_RESET_BS_DATA )
 173
 174 #ifdef __cplusplus
 175 extern "C"
 176 {
 177 #endif
 178
 179 /** Open and initialize an instance of the PCM downmix module
 180  * @param [out] Pointer to a buffer receiving the handle of the new instance.
 181  * @returns Returns an error code.
 182  **/
 183 PCMDMX_ERROR pcmDmx_Open (
 184     HANDLE_PCM_DOWNMIX *pSelf
 185   );
 186
 187 /** Set one parameter for one instance of the PCM downmix module.
 188  * @param [in] Handle of PCM downmix instance.
 189  * @param [in] Parameter to be set.
 190  * @param [in] Parameter value.
 191  * @returns Returns an error code.
 192  **/
 193 PCMDMX_ERROR pcmDmx_SetParam (
 194     HANDLE_PCM_DOWNMIX  self,
 195     PCMDMX_PARAM        param,
 196     UINT                value
 197   );
 198
 199 /** Read the ancillary data transported in DSEs of DVB streams with MPEG-4 content
 200  * @param [in] Handle of PCM downmix instance.
 201  * @param [in] Pointer to ancillary data buffer.
 202  * @param [in] Size of ancillary data.
 203  * @param [in] Flag indicating wheter the ancillary data is from a MPEG-1/2 or an MPEG-4 stream.
 204  * @returns Returns an error code.
 205  **/
 206 PCMDMX_ERROR pcmDmx_ReadDvbAncData (
 207     HANDLE_PCM_DOWNMIX  self,
 208     UCHAR *pAncDataBuf,
 209     UINT   ancDataBytes,
 210     int    isMpeg2
 211   );
 212
 213 /** Set the matrix mixdown information extracted from the PCE of an AAC bitstream.
 214  *  Note: Call only if matrix_mixdown_idx_present is true.
 215  * @param [in] Handle of PCM downmix instance.
 216  * @param [in] Matrix mixdown index present flag extracted from PCE.
 217  * @param [in] The 2 bit matrix mixdown index extracted from PCE.
 218  * @param [in] The pseudo surround enable flag extracted from PCE.
 219  * @returns Returns an error code.
 220  **/
 221 PCMDMX_ERROR pcmDmx_SetMatrixMixdownFromPce (
 222     HANDLE_PCM_DOWNMIX  self,
 223     int                 matrixMixdownPresent,
 224     int                 matrixMixdownIdx,
 225     int                 pseudoSurroundEnable
 226   );
 227
 228 /** Reset the module.
 229  * @param [in] Handle of PCM downmix instance.
 230  * @param [in] Flags telling which parts of the module shall be reset.
 231  * @returns Returns an error code.
 232  **/
 233 PCMDMX_ERROR pcmDmx_Reset (
 234     HANDLE_PCM_DOWNMIX  self,
 235     UINT                flags
 236   );
 237
 238 /** Apply down or up mixing.
 239  *
 240  * \param [in]    Handle of PCM downmix module instance.
 241  * \param [inout] Pointer to time buffer with decoded PCM samples.
 242  * \param [in]    Pointer where the amount of output samples is returned into.
 243  * \param [inout] Pointer where the amount of output channels is returned into.
 244  * \param [in]    Flag which indicates if output time data are writtern interleaved or as subsequent blocks.
 245  * \param [inout] Array were the corresponding channel type for each output audio channel is stored into.
 246  * \param [inout] Array were the corresponding channel type index for each output audio channel is stored into.
 247  * \param [in]    Array containing the output channel mapping to be used (From MPEG PCE ordering to whatever is required).
 248  *
 249  * @returns Returns an error code.
 250  **/
 251 PCMDMX_ERROR pcmDmx_ApplyFrame (
 252     HANDLE_PCM_DOWNMIX      self,
 253     INT_PCM                *pPcmBuf,
 254     UINT                    frameSize,
 255     INT                    *nChannels,
 256
 257     int                     fInterleaved,
 258     AUDIO_CHANNEL_TYPE      channelType[],
 259     UCHAR                   channelIndices[],
 260     const UCHAR             channelMapping[][8]
 261   );
 262
 263 /** Close an instance of the PCM downmix module.
 264  * @param [inout] Pointer to a buffer containing the handle of the instance.
 265  * @returns Returns an error code.
 266  **/
 267 PCMDMX_ERROR pcmDmx_Close (
 268     HANDLE_PCM_DOWNMIX *pSelf
 269   );
 270
 271 /** Get library info for this module.
 272  * @param [out] Pointer to an allocated LIB_INFO structure.
 273  * @returns Returns an error code.
 274  */
 275 PCMDMX_ERROR pcmDmx_GetLibInfo( LIB_INFO *info );
 276
 277
 278 #ifdef __cplusplus
 279 }
 280 #endif
 281
 282 #endif  /* _PCMUTILS_LIB_H_ */