1
0
mirror of https://github.com/mstorsjo/fdk-aac.git synced 2024-12-08 06:31:30 +01:00
fdk-aac/libMpegTPDec/include/tpdec_lib.h
Fraunhofer IIS FDK 6cfabd3536 Upgrade to FDKv2
Bug: 71430241
Test: CTS DecoderTest and DecoderTestAacDrc

original-Change-Id: Iaa20f749b8a04d553b20247cfe1a8930ebbabe30

Apply clang-format also on header files.

original-Change-Id: I14de1ef16bbc79ec0283e745f98356a10efeb2e4

Fixes for MPEG-D DRC

original-Change-Id: If1de2d74bbbac84b3f67de3b88b83f6a23b8a15c

Catch unsupported tw_mdct at an early stage

original-Change-Id: Ied9dd00d754162a0e3ca1ae3e6b854315d818afe

Fixing PVC transition frames

original-Change-Id: Ib75725abe39252806c32d71176308f2c03547a4e

Move qmf bands sanity check

original-Change-Id: Iab540c3013c174d9490d2ae100a4576f51d8dbc4

Initialize scaling variable

original-Change-Id: I3c4087101b70e998c71c1689b122b0d7762e0f9e

Add 16 qmf band configuration to getSlotNrgHQ()

original-Change-Id: I49a5d30f703a1b126ff163df9656db2540df21f1

Always apply byte alignment at the end of the AudioMuxElement

original-Change-Id: I42d560287506d65d4c3de8bfe3eb9a4ebeb4efc7

Setup SBR element only if no parse error exists

original-Change-Id: I1915b73704bc80ab882b9173d6bec59cbd073676

Additional array index check in HCR

original-Change-Id: I18cc6e501ea683b5009f1bbee26de8ddd04d8267

Fix fade-in index selection in concealment module

original-Change-Id: Ibf802ed6ed8c05e9257e1f3b6d0ac1162e9b81c1

Enable explicit backward compatible parser for AAC_LD

original-Change-Id: I27e9c678dcb5d40ed760a6d1e06609563d02482d

Skip spatial specific config in explicit backward compatible ASC

original-Change-Id: Iff7cc365561319e886090cedf30533f562ea4d6e

Update flags description in decoder API

original-Change-Id: I9a5b4f8da76bb652f5580cbd3ba9760425c43830

Add QMF domain reset function

original-Change-Id: I4f89a8a2c0277d18103380134e4ed86996e9d8d6

DRC upgrade v2.1.0

original-Change-Id: I5731c0540139dab220094cd978ef42099fc45b74

Fix integer overflow in sqrtFixp_lookup()

original-Change-Id: I429a6f0d19aa2cc957e0f181066f0ca73968c914

Fix integer overflow in invSqrtNorm2()

original-Change-Id: I84de5cbf9fb3adeb611db203fe492fabf4eb6155

Fix integer overflow in GenerateRandomVector()

original-Change-Id: I3118a641008bd9484d479e5b0b1ee2b5d7d44d74

Fix integer overflow in adjustTimeSlot_EldGrid()

original-Change-Id: I29d503c247c5c8282349b79df940416a512fb9d5

Fix integer overflow in FDKsbrEnc_codeEnvelope()

original-Change-Id: I6b34b61ebb9d525b0c651ed08de2befc1f801449

Follow-up on: Fix integer overflow in adjustTimeSlot_EldGrid()

original-Change-Id: I6f8f578cc7089e5eb7c7b93e580b72ca35ad689a

Fix integer overflow in get_pk_v2()

original-Change-Id: I63375bed40d45867f6eeaa72b20b1f33e815938c

Fix integer overflow in Syn_filt_zero()

original-Change-Id: Ie0c02fdfbe03988f9d3b20d10cd9fe4c002d1279

Fix integer overflow in CFac_CalcFacSignal()

original-Change-Id: Id2d767c40066c591b51768e978eb8af3b803f0c5

Fix integer overflow in FDKaacEnc_FDKaacEnc_calcPeNoAH()

original-Change-Id: Idcbd0f4a51ae2550ed106aa6f3d678d1f9724841

Fix integer overflow in sbrDecoder_calculateGainVec()

original-Change-Id: I7081bcbe29c5cede9821b38d93de07c7add2d507

Fix integer overflow in CLpc_SynthesisLattice()

original-Change-Id: I4a95ddc18de150102352d4a1845f06094764c881

Fix integer overflow in Pred_Lt4()

original-Change-Id: I4dbd012b2de7d07c3e70a47b92e3bfae8dbc750a

Fix integer overflow in FDKsbrEnc_InitSbrFastTransientDetector()

original-Change-Id: I788cbec1a4a00f44c2f3a72ad7a4afa219807d04

Fix unsigned integer overflow in FDKaacEnc_WriteBitstream()

original-Change-Id: I68fc75166e7d2cd5cd45b18dbe3d8c2a92f1822a

Fix unsigned integer overflow in FDK_MetadataEnc_Init()

original-Change-Id: Ie8d025f9bcdb2442c704bd196e61065c03c10af4

Fix overflow in pseudo random number generators

original-Change-Id: I3e2551ee01356297ca14e3788436ede80bd5513c

Fix unsigned integer overflow in sbrDecoder_Parse()

original-Change-Id: I3f231b2f437e9c37db4d5b964164686710eee971

Fix unsigned integer overflow in longsub()

original-Change-Id: I73c2bc50415cac26f1f5a29e125bbe75f9180a6e

Fix unsigned integer overflow in CAacDecoder_DecodeFrame()

original-Change-Id: Ifce2db4b1454b46fa5f887e9d383f1cc43b291e4

Fix overflow at CLpdChannelStream_Read()

original-Change-Id: Idb9d822ce3a4272e4794b643644f5434e2d4bf3f

Fix unsigned integer overflow in Hcr_State_BODY_SIGN_ESC__ESC_WORD()

original-Change-Id: I1ccf77c0015684b85534c5eb97162740a870b71c

Fix unsigned integer overflow in UsacConfig_Parse()

original-Change-Id: Ie6d27f84b6ae7eef092ecbff4447941c77864d9f

Fix unsigned integer overflow in aacDecoder_drcParse()

original-Change-Id: I713f28e883eea3d70b6fa56a7b8f8c22bcf66ca0

Fix unsigned integer overflow in aacDecoder_drcReadCompression()

original-Change-Id: Ia34dfeb88c4705c558bce34314f584965cafcf7a

Fix unsigned integer overflow in CDataStreamElement_Read()

original-Change-Id: Iae896cc1d11f0a893d21be6aa90bd3e60a2c25f0

Fix unsigned integer overflow in transportDec_AdjustEndOfAccessUnit()

original-Change-Id: I64cf29a153ee784bb4a16fdc088baabebc0007dc

Fix unsigned integer overflow in transportDec_GetAuBitsRemaining()

original-Change-Id: I975b3420faa9c16a041874ba0db82e92035962e4

Fix unsigned integer overflow in extractExtendedData()

original-Change-Id: I2a59eb09e2053cfb58dfb75fcecfad6b85a80a8f

Fix signed integer overflow in CAacDecoder_ExtPayloadParse()

original-Change-Id: I4ad5ca4e3b83b5d964f1c2f8c5e7b17c477c7929

Fix unsigned integer overflow in CAacDecoder_DecodeFrame()

original-Change-Id: I29a39df77d45c52a0c9c5c83c1ba81f8d0f25090

Follow-up on: Fix integer overflow in CLpc_SynthesisLattice()

original-Change-Id: I8fb194ffc073a3432a380845be71036a272d388f

Fix signed integer overflow in _interpolateDrcGain()

original-Change-Id: I879ec9ab14005069a7c47faf80e8bc6e03d22e60

Fix unsigned integer overflow in FDKreadBits()

original-Change-Id: I1f47a6a8037ff70375aa8844947d5681bb4287ad

Fix unsigned integer overflow in FDKbyteAlign()

original-Change-Id: Id5f3a11a0c9e50fc6f76ed6c572dbd4e9f2af766

Fix unsigned integer overflow in FDK_get32()

original-Change-Id: I9d33b8e97e3d38cbb80629cb859266ca0acdce96

Fix unsigned integer overflow in FDK_pushBack()

original-Change-Id: Ic87f899bc8c6acf7a377a8ca7f3ba74c3a1e1c19

Fix unsigned integer overflow in FDK_pushForward()

original-Change-Id: I3b754382f6776a34be1602e66694ede8e0b8effc

Fix unsigned integer overflow in ReadPsData()

original-Change-Id: I25361664ba8139e32bbbef2ca8c106a606ce9c37

Fix signed integer overflow in E_UTIL_residu()

original-Change-Id: I8c3abd1f437ee869caa8fb5903ce7d3d641b6aad

REVERT: Follow-up on: Integer overflow in CLpc_SynthesisLattice().

original-Change-Id: I3d340099acb0414795c8dfbe6362bc0a8f045f9b

Follow-up on: Fix integer overflow in CLpc_SynthesisLattice()

original-Change-Id: I4aedb8b3a187064e9f4d985175aa55bb99cc7590

Follow-up on: Fix unsigned integer overflow in aacDecoder_drcParse()

original-Change-Id: I2aa2e13916213bf52a67e8b0518e7bf7e57fb37d

Fix integer overflow in acelp

original-Change-Id: Ie6390c136d84055f8b728aefbe4ebef6e029dc77

Fix unsigned integer overflow in aacDecoder_UpdateBitStreamCounters()

original-Change-Id: I391ffd97ddb0b2c184cba76139bfb356a3b4d2e2

Adjust concealment default settings

original-Change-Id: I6a95db935a327c47df348030bcceafcb29f54b21

Saturate estimatedStartPos

original-Change-Id: I27be2085e0ae83ec9501409f65e003f6bcba1ab6

Negative shift exponent in _interpolateDrcGain()

original-Change-Id: I18edb26b26d002aafd5e633d4914960f7a359c29

Negative shift exponent in calculateICC()

original-Change-Id: I3dcd2ae98d2eb70ee0d59750863cbb2a6f4f8aba

Too large shift exponent in FDK_put()

original-Change-Id: Ib7d9aaa434d2d8de4a13b720ca0464b31ca9b671

Too large shift exponent in CalcInvLdData()

original-Change-Id: I43e6e78d4cd12daeb1dcd5d82d1798bdc2550262

Member access within null pointer of type SBR_CHANNEL

original-Change-Id: Idc5e4ea8997810376d2f36bbdf628923b135b097

Member access within null pointer of type CpePersistentData

original-Change-Id: Ib6c91cb0d37882768e5baf63324e429589de0d9d

Member access within null pointer FDKaacEnc_psyMain()

original-Change-Id: I7729b7f4479970531d9dc823abff63ca52e01997

Member access within null pointer FDKaacEnc_GetPnsParam()

original-Change-Id: I9aa3b9f3456ae2e0f7483dbd5b3dde95fc62da39

Member access within null pointer FDKsbrEnc_EnvEncodeFrame()

original-Change-Id: I67936f90ea714e90b3e81bc0dd1472cc713eb23a

Add HCR sanity check

original-Change-Id: I6c1d9732ebcf6af12f50b7641400752f74be39f7

Fix memory issue for HBE edge case with 8:3 SBR

original-Change-Id: I11ea58a61e69fbe8bf75034b640baee3011e63e9

Additional SBR parametrization sanity check for ELD

original-Change-Id: Ie26026fbfe174c2c7b3691f6218b5ce63e322140

Add MPEG-D DRC channel layout check

original-Change-Id: Iea70a74f171b227cce636a9eac4ba662777a2f72

Additional out-of-bounds checks in MPEG-D DRC

original-Change-Id: Ife4a8c3452c6fde8a0a09e941154a39a769777d4

Change-Id: Ic63cb2f628720f54fe9b572b0cb528e2599c624e
2018-04-19 11:21:15 -07:00

665 lines
28 KiB
C

/* -----------------------------------------------------------------------------
Software License for The Fraunhofer FDK AAC Codec Library for Android
© Copyright 1995 - 2018 Fraunhofer-Gesellschaft zur Förderung der angewandten
Forschung e.V. All rights reserved.
1. INTRODUCTION
The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
scheme for digital audio. This FDK AAC Codec software is intended to be used on
a wide variety of Android devices.
AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
general perceptual audio codecs. AAC-ELD is considered the best-performing
full-bandwidth communications codec by independent studies and is widely
deployed. AAC has been standardized by ISO and IEC as part of the MPEG
specifications.
Patent licenses for necessary patent claims for the FDK AAC Codec (including
those of Fraunhofer) may be obtained through Via Licensing
(www.vialicensing.com) or through the respective patent owners individually for
the purpose of encoding or decoding bit streams in products that are compliant
with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
Android devices already license these patent claims through Via Licensing or
directly from the patent owners, and therefore FDK AAC Codec software may
already be covered under those patent licenses when it is used for those
licensed purposes only.
Commercially-licensed AAC software libraries, including floating-point versions
with enhanced sound quality, are also available from Fraunhofer. Users are
encouraged to check the Fraunhofer website for additional applications
information and documentation.
2. COPYRIGHT LICENSE
Redistribution and use in source and binary forms, with or without modification,
are permitted without payment of copyright license fees provided that you
satisfy the following conditions:
You must retain the complete text of this software license in redistributions of
the FDK AAC Codec or your modifications thereto in source code form.
You must retain the complete text of this software license in the documentation
and/or other materials provided with redistributions of the FDK AAC Codec or
your modifications thereto in binary form. You must make available free of
charge copies of the complete source code of the FDK AAC Codec and your
modifications thereto to recipients of copies in binary form.
The name of Fraunhofer may not be used to endorse or promote products derived
from this library without prior written permission.
You may not charge copyright license fees for anyone to use, copy or distribute
the FDK AAC Codec software or your modifications thereto.
Your modified versions of the FDK AAC Codec must carry prominent notices stating
that you changed the software and the date of any change. For modified versions
of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
AAC Codec Library for Android."
3. NO PATENT LICENSE
NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
Fraunhofer provides no warranty of patent non-infringement with respect to this
software.
You may use this FDK AAC Codec software or modifications thereto only for
purposes that are authorized by appropriate patent licenses.
4. DISCLAIMER
This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
including but not limited to the implied warranties of merchantability and
fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
or consequential damages, including but not limited to procurement of substitute
goods or services; loss of use, data, or profits, or business interruption,
however caused and on any theory of liability, whether in contract, strict
liability, or tort (including negligence), arising in any way out of the use of
this software, even if advised of the possibility of such damage.
5. CONTACT INFORMATION
Fraunhofer Institute for Integrated Circuits IIS
Attention: Audio and Multimedia Departments - FDK AAC LL
Am Wolfsmantel 33
91058 Erlangen, Germany
www.iis.fraunhofer.de/amm
amm-info@iis.fraunhofer.de
----------------------------------------------------------------------------- */
/******************* MPEG transport format decoder library *********************
Author(s): Manuel Jander
Description: MPEG Transport decoder
*******************************************************************************/
#ifndef TPDEC_LIB_H
#define TPDEC_LIB_H
#include "tp_data.h"
#include "FDK_bitstream.h"
typedef enum {
TRANSPORTDEC_OK = 0, /*!< All fine. */
/* Synchronization errors. Wait for new input data and try again. */
tpdec_sync_error_start = 0x100,
TRANSPORTDEC_NOT_ENOUGH_BITS, /*!< Out of bits. Provide more bits and try
again. */
TRANSPORTDEC_SYNC_ERROR, /*!< No sync was found or sync got lost. Keep trying.
*/
tpdec_sync_error_end,
/* Decode errors. Mostly caused due to bit errors. */
tpdec_decode_error_start = 0x400,
TRANSPORTDEC_PARSE_ERROR, /*!< Bitstream data showed inconsistencies (wrong
syntax). */
TRANSPORTDEC_UNSUPPORTED_FORMAT, /*!< Unsupported format or feature found in
the bitstream data. */
TRANSPORTDEC_CRC_ERROR, /*!< CRC error encountered in bitstream data. */
tpdec_decode_error_end,
/* Fatal errors. Stop immediately on one of these errors! */
tpdec_fatal_error_start = 0x200,
TRANSPORTDEC_UNKOWN_ERROR, /*!< An unknown error occured. */
TRANSPORTDEC_INVALID_PARAMETER, /*!< An invalid parameter was passed to a
function. */
TRANSPORTDEC_NEED_TO_RESTART, /*!< The decoder needs to be restarted, since
the requiered configuration change cannot
be performed. */
TRANSPORTDEC_TOO_MANY_BITS, /*!< In case of packet based formats: Supplied
number of bits exceed the size of the
internal bit buffer. */
tpdec_fatal_error_end
} TRANSPORTDEC_ERROR;
/** Macro to identify decode errors. */
#define TPDEC_IS_DECODE_ERROR(err) \
(((err >= tpdec_decode_error_start) && (err <= tpdec_decode_error_end)) ? 1 \
: 0)
/** Macro to identify fatal errors. */
#define TPDEC_IS_FATAL_ERROR(err) \
(((err >= tpdec_fatal_error_start) && (err <= tpdec_fatal_error_end)) ? 1 : 0)
/**
* \brief Parameter identifiers for transportDec_SetParam()
*/
typedef enum {
TPDEC_PARAM_MINIMIZE_DELAY = 1, /** Delay minimization strategy. 0: none, 1:
discard as many frames as possible. */
TPDEC_PARAM_EARLY_CONFIG, /** Enable early config discovery. */
TPDEC_PARAM_IGNORE_BUFFERFULLNESS, /** Ignore buffer fullness. */
TPDEC_PARAM_SET_BITRATE, /** Set average bit rate for bit stream interruption
frame misses estimation. */
TPDEC_PARAM_RESET, /** Reset transport decoder instance status. */
TPDEC_PARAM_BURST_PERIOD, /** Set data reception burst period in mili seconds.
*/
TPDEC_PARAM_TARGETLAYOUT, /** Set CICP target layout */
TPDEC_PARAM_FORCE_CONFIG_CHANGE, /** Force config change for next received
config */
TPDEC_PARAM_USE_ELEM_SKIPPING
} TPDEC_PARAM;
/*!
\brief Reset Program Config Element.
\param pPce Program Config Element structure.
\return void
*/
void CProgramConfig_Reset(CProgramConfig *pPce);
/*!
\brief Initialize Program Config Element.
\param pPce Program Config Element structure.
\return void
*/
void CProgramConfig_Init(CProgramConfig *pPce);
/*!
\brief Inquire state of present Program Config Element
structure. \param pPce Program Config Element structure. \return
1 if the PCE structure is filled correct, 0 if no valid PCE present.
*/
int CProgramConfig_IsValid(const CProgramConfig *pPce);
/*!
\brief Read Program Config Element.
\param pPce Program Config Element structure.
\param bs Bitstream buffer to read from.
\param alignAnchor Align bitstream to alignAnchor bits after all read
operations. \return void
*/
void CProgramConfig_Read(CProgramConfig *pPce, HANDLE_FDK_BITSTREAM bs,
UINT alignAnchor);
/*!
\brief Compare two Program Config Elements.
\param pPce1 Pointer to first Program Config Element structure.
\param pPce2 Pointer to second Program Config Element structure.
\return -1 if PCEs are completely different,
0 if PCEs are completely equal,
1 if PCEs are different but have the same channel
config, 2 if PCEs have different channel config but same number of channels.
*/
int CProgramConfig_Compare(const CProgramConfig *const pPce1,
const CProgramConfig *const pPce2);
/*!
\brief Get a Program Config Element that matches the predefined
MPEG-4 channel configurations 1-14. \param pPce Program Config
Element structure. \param channelConfig MPEG-4 channel configuration. \return
void
*/
void CProgramConfig_GetDefault(CProgramConfig *pPce, const UINT channelConfig);
/**
* \brief Lookup and verify a given element. The decoder calls this
* method with every new element ID found in the bitstream.
*
* \param pPce A valid Program config structure.
* \param chConfig MPEG-4 channel configuration.
* \param tag Tag of the current element to be looked up.
* \param channelIdx The current channel count of the decoder parser.
* \param chMapping Array to store the canonical channel mapping indexes.
* \param chType Array to store the audio channel type.
* \param chIndex Array to store the individual audio channel type index.
* \param chDescrLen Length of the output channel description array.
* \param elMapping Pointer where the canonical element index is stored.
* \param elType The element id of the current element to be looked up.
*
* \return Non-zero if the element belongs to the current program,
* zero if it does not.
*/
int CProgramConfig_LookupElement(CProgramConfig *pPce, UINT chConfig,
const UINT tag, const UINT channelIdx,
UCHAR chMapping[], AUDIO_CHANNEL_TYPE chType[],
UCHAR chIndex[], const UINT chDescrLen,
UCHAR *elMapping, MP4_ELEMENT_ID elList[],
MP4_ELEMENT_ID elType);
/**
* \brief Get table of channel indices in the order of their
* appearance in by the program config field.
* \param pPce A valid program config structure.
* \param pceChMap Array to store the channel mapping indices like they
* appear in the PCE.
* \param pceChMapLen Lenght of the channel mapping index array (pceChMap).
*
* \return Non-zero if any error occured otherwise zero.
*/
int CProgramConfig_GetPceChMap(const CProgramConfig *pPce, UCHAR pceChMap[],
const UINT pceChMapLen);
/**
* \brief Get table of elements in canonical order from a
* give program config field.
* \param pPce A valid program config structure.
* \param table An array where the element IDs are stored.
* \param elListSize The length of the table array.
* \param pChMapIdx Pointer to a field receiving the corresponding
* implicit channel configuration index of the given
* PCE. If none can be found it receives the value 0.
* \return Total element count including all SCE, CPE and LFE.
*/
int CProgramConfig_GetElementTable(const CProgramConfig *pPce,
MP4_ELEMENT_ID table[], const INT elListSize,
UCHAR *pChMapIdx);
/**
* \brief Get channel description (type and index) for implicit
configurations (chConfig > 0) in MPEG canonical order.
* \param chConfig MPEG-4 channel configuration.
* \param chType Array to store the audio channel type.
* \param chIndex Array to store the individual audio channel type index.
* \return void
*/
void CProgramConfig_GetChannelDescription(const UINT chConfig,
const CProgramConfig *pPce,
AUDIO_CHANNEL_TYPE chType[],
UCHAR chIndex[]);
/**
* \brief Initialize a given AudioSpecificConfig structure.
* \param pAsc A pointer to an allocated CSAudioSpecificConfig struct.
* \return void
*/
void AudioSpecificConfig_Init(CSAudioSpecificConfig *pAsc);
/**
* \brief Parse a AudioSpecificConfig from a given bitstream handle.
*
* \param pAsc A pointer to an allocated
* CSAudioSpecificConfig struct.
* \param hBs Bitstream handle.
* \param fExplicitBackwardCompatible Do explicit backward compatibility
* parsing if set (flag).
* \param cb pointer to structure holding callback information
* \param configMode Config modes: memory allocation mode or config change
* detection mode.
* \param configChanged Indicates a config change.
* \param m_aot in case of unequal AOT_NULL_OBJECT only the specific config is
* parsed.
*
* \return Total element count including all SCE, CPE and LFE.
*/
TRANSPORTDEC_ERROR AudioSpecificConfig_Parse(
CSAudioSpecificConfig *pAsc, HANDLE_FDK_BITSTREAM hBs,
int fExplicitBackwardCompatible, CSTpCallBacks *cb, UCHAR configMode,
UCHAR configChanged, AUDIO_OBJECT_TYPE m_aot);
/* CELP stuff */
enum { MPE = 0, RPE = 1, fs8KHz = 0, fs16KHz = 1 };
/* Defintion of flags that can be passed to transportDecOpen() */
#define TP_FLAG_MPEG4 1
/* Capability flags */
#define CAPF_TPDEC_ADIF \
0x00001000 /**< Flag indicating support for ADIF transport format. */
#define CAPF_TPDEC_ADTS \
0x00002000 /**< Flag indicating support for ADTS transport format. */
#define CAPF_TPDEC_LOAS \
0x00004000 /**< Flag indicating support for LOAS transport format. */
#define CAPF_TPDEC_LATM \
0x00008000 /**< Flag indicating support for LATM transport format. */
#define CAPF_TPDEC_RAWPACKETS \
0x00010000 /**< Flag indicating support for raw packets transport format. */
typedef struct TRANSPORTDEC *HANDLE_TRANSPORTDEC;
/**
* \brief Configure Transport Decoder via a binary coded AudioSpecificConfig or
* StreamMuxConfig. The previously requested configuration callback will be
* called as well. The buffer conf must containt a SMC in case of
* LOAS/LATM transport format, and an ASC elseways.
*
* \param hTp Handle of a transport decoder.
* \param conf UCHAR buffer of the binary coded config (ASC or SMC).
* \param length The length in bytes of the conf buffer.
*
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_OutOfBandConfig(const HANDLE_TRANSPORTDEC hTp,
UCHAR *conf, const UINT length,
const UINT layer);
/**
* \brief Configure Transport Decoder via a binary coded USAC/RSV603DA Config.
* The buffer newConfig contains a binary coded USAC/RSV603DA config of
* length newConfigLength bytes. If the new config and the previous config are
* different configChanged is set to 1 otherwise it is set to 0.
*
* \param hTp Handle of a transport decoder.
* \param newConfig buffer of the binary coded config.
* \param newConfigLength Length of new config in bytes.
* \param buildUpStatus Indicates build up status: off|on|idle.
* \param configChanged Indicates if config changed.
* \param layer Instance layer.
*
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_InBandConfig(
const HANDLE_TRANSPORTDEC hTp, UCHAR *newConfig, const UINT newConfigLength,
const UCHAR buildUpStatus, UCHAR *configChanged, const UINT layer,
UCHAR *implicitExplicitCfgDiff);
/**
* \brief Open Transport medium for reading.
*
* \param transportDecFmt Format of the transport decoder medium to be accessed.
* \param flags Transport decoder flags. Currently only TP_FLAG_MPEG4,
* which signals a MPEG4 capable decoder (relevant for ADTS only).
*
* \return A pointer to a valid and allocated HANDLE_TRANSPORTDEC or a null
* pointer on failure.
*/
HANDLE_TRANSPORTDEC transportDec_Open(TRANSPORT_TYPE transportDecFmt,
const UINT flags, const UINT nrOfLayer);
/**
* \brief Register configuration change callback.
* \param hTp Handle of transport decoder.
* \param cbUpdateConfig Pointer to a callback function to handle audio config
* changes.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterAscCallback(HANDLE_TRANSPORTDEC hTp,
const cbUpdateConfig_t cbUpdateConfig,
void *user_data);
/**
* \brief Register free memory callback.
* \param hTp Handle of transport decoder.
* \param cbFreeMem Pointer to a callback function to free config dependent
* memory.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterFreeMemCallback(HANDLE_TRANSPORTDEC hTp,
const cbFreeMem_t cbFreeMem,
void *user_data);
/**
* \brief Register config change control callback.
* \param hTp Handle of transport decoder.
* \param cbCtrlCFGChange Pointer to a callback function for config change
* control.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterCtrlCFGChangeCallback(
HANDLE_TRANSPORTDEC hTp, const cbCtrlCFGChange_t cbCtrlCFGChange,
void *user_data);
/**
* \brief Register SSC parser callback.
* \param hTp Handle of transport decoder.
* \param cbUpdateConfig Pointer to a callback function to handle SSC parsing.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterSscCallback(HANDLE_TRANSPORTDEC hTp,
const cbSsc_t cbSscParse, void *user_data);
/**
* \brief Register SBR header parser callback.
* \param hTp Handle of transport decoder.
* \param cbUpdateConfig Pointer to a callback function to handle SBR header
* parsing.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterSbrCallback(HANDLE_TRANSPORTDEC hTpDec,
const cbSbr_t cbSbr, void *user_data);
/**
* \brief Register USAC SC parser callback.
* \param hTp Handle of transport decoder.
* \param cbUpdateConfig Pointer to a callback function to handle USAC SC
* parsing.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterUsacCallback(HANDLE_TRANSPORTDEC hTpDec,
const cbUsac_t cbUsac, void *user_data);
/**
* \brief Register uniDrcConfig and loudnessInfoSet parser
* callback.
* \param hTp Handle of transport decoder.
* \param cbUpdateConfig Pointer to a callback function to handle uniDrcConfig
* and loudnessInfoSet parsing.
* \param user_data void pointer for user data passed to the callback as
* first parameter.
* \return 0 on success.
*/
int transportDec_RegisterUniDrcConfigCallback(HANDLE_TRANSPORTDEC hTpDec,
const cbUniDrc_t cbUniDrc,
void *user_data,
UINT *pLoudnessInfoSetPosition);
/**
* \brief Fill internal input buffer with bitstream data from the external input
* buffer. The function only copies such data as long as the decoder-internal
* input buffer is not full. So it grabs whatever it can from pBuffer and
* returns information (bytesValid) so that at a subsequent call of
* %transportDec_FillData(), the right position in pBuffer can be determined to
* grab the next data.
*
* \param hTp Handle of transportDec.
* \param pBuffer Pointer to external input buffer.
* \param bufferSize Size of external input buffer. This argument is required
* because decoder-internally we need the information to calculate the offset to
* pBuffer, where the next available data is, which is then
* fed into the decoder-internal buffer (as much as
* possible). Our example framework implementation fills the
* buffer at pBuffer again, once it contains no available valid bytes anymore
* (meaning bytesValid equal 0).
* \param bytesValid Number of bitstream bytes in the external bitstream buffer
* that have not yet been copied into the decoder's internal bitstream buffer by
* calling this function. The value is updated according to
* the amount of newly copied bytes.
* \param layer The layer the bitstream belongs to.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_FillData(const HANDLE_TRANSPORTDEC hTp,
UCHAR *pBuffer, const UINT bufferSize,
UINT *pBytesValid, const INT layer);
/**
* \brief Get transportDec bitstream handle.
* \param hTp Pointer to a transport decoder handle.
* \return HANDLE_FDK_BITSTREAM bitstream handle.
*/
HANDLE_FDK_BITSTREAM transportDec_GetBitstream(const HANDLE_TRANSPORTDEC hTp,
const UINT layer);
/**
* \brief Get transport format.
* \param hTp Pointer to a transport decoder handle.
* \return The transport format.
*/
TRANSPORT_TYPE transportDec_GetFormat(const HANDLE_TRANSPORTDEC hTp);
/**
* \brief Get the current buffer fullness value.
*
* \param hTp Handle of a transport decoder.
*
* \return Buffer fullness
*/
INT transportDec_GetBufferFullness(const HANDLE_TRANSPORTDEC hTp);
/**
* \brief Close and deallocate transportDec.
* \param phTp Pointer to a previously allocated transport decoder handle.
* \return void
*/
void transportDec_Close(HANDLE_TRANSPORTDEC *phTp);
/**
* \brief Read one access unit from the transportDec medium.
* \param hTp Handle of transportDec.
* \param length On return, this value is overwritten with the actual access
* unit length in bits. Set to -1 if length is unknown.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_ReadAccessUnit(const HANDLE_TRANSPORTDEC hTp,
const UINT layer);
/**
* \brief Get AudioSpecificConfig.
* \param hTp Handle of transportDec.
* \param layer Transport layer.
* \param asc Pointer to AudioSpecificConfig.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_GetAsc(const HANDLE_TRANSPORTDEC hTp,
const UINT layer,
CSAudioSpecificConfig *asc);
/**
* \brief Get the remaining amount of bits of the current access unit. The
* result can be below zero, meaning that too many bits have been read.
* \param hTp Handle of transportDec.
* \return amount of remaining bits.
*/
INT transportDec_GetAuBitsRemaining(const HANDLE_TRANSPORTDEC hTp,
const UINT layer);
/**
* \brief Get the total amount of bits of the current access unit.
* \param hTp Handle of transportDec.
* \return amount of total bits.
*/
INT transportDec_GetAuBitsTotal(const HANDLE_TRANSPORTDEC hTp,
const UINT layer);
/**
* \brief This function is required to be called when the decoder has
* finished parsing one Access Unit for bitstream housekeeping.
* \param hTp Transport Handle.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_EndAccessUnit(const HANDLE_TRANSPORTDEC hTp);
/**
* \brief Obtain the amount of missing access units if applicable in case
* of a bit stream synchronization error. Each time
* transportDec_ReadAccessUnit() returns TRANSPORTDEC_SYNC_ERROR
* this function can be called to retrieve an estimate of the amount
* of missing access units. This works only in case of constant
* average bit rate (has to be known) and if the parameter
* TPDEC_PARAM_SET_BITRATE has been set accordingly.
* \param hTp Transport Handle.
* \param pNAccessUnits pointer to a memory location where the estimated lost
* frame count will be stored into.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_GetMissingAccessUnitCount(
INT *pNAccessUnits, HANDLE_TRANSPORTDEC hTp);
/**
* \brief Set a given setting.
* \param hTp Transport Handle.
* \param param Identifier of the parameter to be changed.
* \param value Value for the parameter to be changed.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_SetParam(const HANDLE_TRANSPORTDEC hTp,
const TPDEC_PARAM param,
const INT value);
/**
* \brief Get number of subframes (for LATM or ADTS)
* \param hTp Transport Handle.
* \return Number of ADTS/LATM subframes (return 1 for all other transport
* types).
*/
UINT transportDec_GetNrOfSubFrames(HANDLE_TRANSPORTDEC hTp);
/**
* \brief Get info structure of transport decoder library.
* \param info A pointer to an allocated LIB_INFO struct.
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_GetLibInfo(LIB_INFO *info);
/* ADTS CRC support */
/**
* \brief Set current bitstream position as start of a new data region.
* \param hTp Transport handle.
* \param mBits Size in bits of the data region. Set to 0 if it should not be
* of a fixed size.
* \return Data region ID, which should be used when calling
* transportDec_CrcEndReg().
*/
int transportDec_CrcStartReg(const HANDLE_TRANSPORTDEC hTp, const INT mBits);
/**
* \brief Set end of data region.
* \param hTp Transport handle.
* \param reg Data region ID, opbtained from transportDec_CrcStartReg().
* \return void
*/
void transportDec_CrcEndReg(const HANDLE_TRANSPORTDEC hTp, const INT reg);
/**
* \brief Calculate ADTS crc and check if it is correct. The ADTS checksum
* is held internally.
* \param hTp Transport handle.
* \return Return TRANSPORTDEC_OK if the CRC is ok, or error if CRC is not
* correct.
*/
TRANSPORTDEC_ERROR transportDec_CrcCheck(const HANDLE_TRANSPORTDEC hTp);
/**
* \brief Only check whether a given config seems to be valid without modifying
* internal states.
*
* \param conf UCHAR buffer of the binary coded config (SDC type 9).
* \param length The length in bytes of the conf buffer.
*
* \return Error code.
*/
TRANSPORTDEC_ERROR transportDec_DrmRawSdcAudioConfig_Check(UCHAR *conf,
const UINT length);
#endif /* #ifndef TPDEC_LIB_H */