libMpegTPDec/include/mpegFileRead.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 /*****************************  MPEG-4 AAC Decoder  **************************
  85
  86    Author(s):   Manuel Jander
  87    Description: Bitstream data provider for MP4 decoders
  88
  89 ******************************************************************************/
  90
  91 #include "machine_type.h"
  92 #include "FDK_audio.h"
  93
  94 #define MPFREAD_MP4FF_DISABLE
  95
  96 #ifndef MPFREAD_MP4FF_DISABLE
  97   /*!< If MPFREAD_MP4FF_ENABLE is set, include support for MPEG ISO fileformat.
  98        If not set, no .mp4, .m4a and .3gp files can be used for input. */
  99   #define MPFREAD_MP4FF_ENABLE
 100 #endif
 101
 102 /* maximum number of layers which can be read        */
 103 /* shall equal max number of layers read by iisisoff */
 104 #define FILEREAD_MAX_LAYERS (2)
 105
 106 typedef struct STRUCT_FILEREAD *HANDLE_FILEREAD;
 107
 108 #ifdef __cplusplus
 109 extern "C" {
 110 #endif
 111
 112 /**
 113  * \brief           Open an MPEG audio file and try to detect its format.
 114  * \param filename  String of the filename to be opened.
 115  * \param fileFormat Skip file format detection and use given format if fileFormat != FF_UNKNOWN.
 116                     Else store detected format into *fileFmt.
 117  * \param transportType Skip transport type detection and use given format if transportType != TT_UNKNOWN.
 118                     Else store detected format into *fileFmt.
 119  * \param conf      Pointer to unsigned char to hold the AudioSpecificConfig of the input file, if
 120                     any (MPEG 4 file format). In case of RAW LATM it holds the StreamMuxConfig.
 121  * \param confSize  Pointer to an integer, where the length of the ASC or SMC (in case of RAW LATM)
 122                     is stored to.
 123  * \return          MPEG file read handle.
 124  */
 125 HANDLE_FILEREAD mpegFileRead_Open( const char     *filename,
 126                                    FILE_FORMAT     fileFormat,
 127                                    TRANSPORT_TYPE  transportType,
 128                                    UCHAR          *conf[],
 129                                    UINT            confSize[],
 130                                    INT            *noOfLayers
 131                                  );
 132
 133 /**
 134  * \brief           Get the file format of the input file.
 135  * \param hDataSrc  MPEG file read handle.
 136  * \return          File format of the input file.
 137  */
 138 FILE_FORMAT mpegFileRead_GetFileFormat(HANDLE_FILEREAD hDataSrc);
 139
 140 /**
 141  * \brief           Get the transport type of the input file.
 142  * \param hDataSrc  MPEG file read handle.
 143  * \return          Transport type of the input file.
 144  */
 145 TRANSPORT_TYPE mpegFileRead_GetTransportType(HANDLE_FILEREAD hDataSrc);
 146
 147 /**
 148  * \brief Read data from MPEG file. In case of packet file, read one packet, in case
 149  *        of streaming file with embedded synchronisation layer (LOAS/ADTS...), just
 150  *        fill the buffer.
 151  *
 152  * \param hMpegFile   MPEG file read handle.
 153  * \param inBuffer    Pointer to input buffer.
 154  * \param bufferSize  Size of input buffer.
 155  * \param bytesValid  Number of bytes that were read.
 156  * \return            0 on success, -1 if unsupported file format or file read error.
 157  */
 158 int mpegFileRead_Read( HANDLE_FILEREAD   hMpegFile,
 159                        UCHAR            *inBuffer[],
 160                        UINT              bufferSize,
 161                        UINT             *bytesValid
 162                      );
 163
 164 /**
 165  * \brief            Seek in file from origin by given offset in frames.
 166  * \param hMpegFile  MPEG file read handle.
 167  * \param origin     If 0, the origin is the file beginning (absolute seek).
 168  *                   If 1, the origin is the current position (relative seek).
 169  * \param offset     The amount of frames to seek from the given origin.
 170  * \return           0 on sucess, -1 if offset < 0 or file read error.
 171  */
 172 int mpegFileRead_seek( HANDLE_FILEREAD   hMpegFile,
 173                        INT               origin,
 174                        INT               offset
 175                       );
 176
 177 /**
 178  * \brief            Get file position in percent.
 179  * \param hMpegFile  MPEG file read handle.
 180  * \return           File position in percent.
 181  */
 182 int mpegFileRead_getPercent(HANDLE_FILEREAD hMpegFile);
 183
 184
 185 /**
 186  * \brief           Close MPEG audio file.
 187  * \param hMpegFile Mpeg file read handle.
 188  * \return          0 on sucess.
 189  */
 190 int mpegFileRead_Close(HANDLE_FILEREAD *hMpegFile);
 191
 192 #ifdef __cplusplus
 193 }
 194 #endif