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

1 files changed, 539 insertions, 0 deletions

diff --git a/libSACdec/src/sac_dec.h b/libSACdec/src/sac_dec.h
new file mode 100644
index 0000000..992acad
--- /dev/null
+++ b/libSACdec/src/sac_dec.h
@@ -0,0 +1,539 @@
+/* -----------------------------------------------------------------------------
+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 surround decoder library *************************
+
+   Author(s):
+
+   Description: SAC Decoder Library structures
+
+*******************************************************************************/
+
+#ifndef SAC_DEC_H
+#define SAC_DEC_H
+
+#include "common_fix.h"
+
+#include "sac_dec_interface.h" /* library interface in ../include */
+
+#include "FDK_qmf_domain.h"
+#include "sac_qmf.h"
+#include "FDK_bitstream.h" /* mp4 bitbuffer */
+#include "sac_calcM1andM2.h"
+#include "FDK_hybrid.h"
+#include "FDK_decorrelate.h"
+#include "sac_reshapeBBEnv.h"
+
+#include "sac_dec_conceal.h"
+
+#include "sac_tsd.h"
+
+#ifndef MAX
+#define MAX(a, b) ((a) > (b) ? (a) : (b))
+#endif
+
+#define ICCdefault 0
+#define IPDdefault 0
+#define arbdmxGainDefault 0
+#define CPCdefault 10
+#define tttCLD1default 15
+#define tttCLD2default 0
+
+#define IS_HQ_ONLY(aot)                                                      \
+  ((aot) == AOT_ER_AAC_LD || (aot) == AOT_ER_AAC_ELD || (aot) == AOT_USAC || \
+   (aot) == AOT_RSVD50)
+
+#define SCONST(x) FL2FXCONST_DBL(x)
+
+#define PC_NUM_BANDS (8)
+#define PC_NUM_HYB_BANDS (PC_NUM_BANDS - 3 + 10)
+#define ABS_THR (1e-9f * 32768 * 32768)
+
+#define MAX_HYBRID_BANDS (MAX_NUM_QMF_BANDS - 3 + 10)
+#define HYBRID_FILTER_DELAY (6)
+
+#define MAX_RESIDUAL_FRAMES (4)
+#define MAX_RESIDUAL_BISTREAM \
+  (836) /*  48000 bps * 3 res / (8 * 44100 / 2048 ) */
+#define MAX_MDCT_COEFFS (1024)
+#define SACDEC_RESIDUAL_BS_BUF_SIZE \
+  (1024) /* used to setup and check residual bitstream buffer */
+
+#define MAX_NUM_PARAMS (MAX_NUM_OTT + 4 * MAX_NUM_TTT + MAX_INPUT_CHANNELS)
+#define MAX_NUM_PARAMETERS (MAX(MAX_NUM_PARAMS, MAX_NUM_OTT))
+
+#define MAX_PARAMETER_SETS (9)
+
+#define MAX_M2_INPUT (MAX_OUTPUT_CHANNELS) /* 3 direct + 5 diffuse */
+
+#define MAX_QMF_BANDS_TO_HYBRID \
+  (3) /* 3 bands are filtered again in "40 bands" case */
+#define PROTO_LEN (13)
+#define BUFFER_LEN_LF (PROTO_LEN)
+#define BUFFER_LEN_HF ((PROTO_LEN - 1) / 2)
+
+#define MAX_NO_DECORR_CHANNELS (MAX_OUTPUT_CHANNELS)
+#define HRTF_AZIMUTHS (5)
+
+#define MAX_NUM_OTT_AT 0
+
+/* left out */
+
+typedef enum {
+  UPMIXTYPE_BYPASS = -1, /*just bypass the input channels without processing*/
+  UPMIXTYPE_NORMAL = 0   /*multichannel loudspeaker upmix with spatial data*/
+} UPMIXTYPE;
+
+static inline int isTwoChMode(UPMIXTYPE upmixType) {
+  int retval = 0;
+  return retval;
+}
+
+  /* left out end */
+
+#define MPEGS_BYPASSMODE (0x00000001)
+#define MPEGS_CONCEAL (0x00000002)
+
+typedef struct STP_DEC *HANDLE_STP_DEC;
+
+typedef struct {
+  SCHAR bsQuantCoarseXXXprev;
+  SCHAR bsQuantCoarseXXXprevParse;
+} LOSSLESSSTATE;
+
+typedef struct {
+  SCHAR bsXXXDataMode[MAX_PARAMETER_SETS];
+  SCHAR bsQuantCoarseXXX[MAX_PARAMETER_SETS];
+  SCHAR bsFreqResStrideXXX[MAX_PARAMETER_SETS];
+  SCHAR nocmpQuantCoarseXXX[MAX_PARAMETER_SETS];
+  LOSSLESSSTATE *state; /* Link to persistent state information */
+} LOSSLESSDATA;
+
+struct SPATIAL_BS_FRAME_struct {
+  UCHAR bsIndependencyFlag;
+  UCHAR newBsData;
+  UCHAR numParameterSets;
+
+  /*
+  If bsFramingType == 0, then the paramSlot[ps] for 0 <= ps < numParamSets is
+  calculated as follows: paramSlot[ps] = ceil(numSlots*(ps+1)/numParamSets) - 1
+  Otherwise, it is
+    paramSlot[ps] = bsParamSlot[ps]
+  */
+  INT paramSlot[MAX_PARAMETER_SETS];
+
+  /* These arrays contain the compact indices, only one value per pbstride, only
+   * paramsets actually containing data. */
+  /* These values are written from the parser in ecDataDec() and read during
+   * decode in mapIndexData() */
+  SCHAR cmpOttCLDidx[MAX_NUM_OTT + MAX_NUM_OTT_AT][MAX_PARAMETER_SETS]
+                    [MAX_PARAMETER_BANDS];
+  SCHAR cmpOttICCidx[MAX_NUM_OTT][MAX_PARAMETER_SETS][MAX_PARAMETER_BANDS];
+
+  /* Smoothing */
+  UCHAR bsSmoothMode[MAX_PARAMETER_SETS];
+  UCHAR bsSmoothTime[MAX_PARAMETER_SETS];
+  UCHAR bsFreqResStrideSmg[MAX_PARAMETER_SETS];
+  UCHAR bsSmgData[MAX_PARAMETER_SETS]
+                 [MAX_PARAMETER_BANDS]; /* smoothing flags, one if band is
+                                           smoothed, otherwise zero */
+
+  /* Arbitrary Downmix */
+  SCHAR (*cmpArbdmxGainIdx)[MAX_PARAMETER_SETS][MAX_PARAMETER_BANDS];
+
+  /* Lossless control */
+  LOSSLESSDATA *CLDLosslessData;
+  LOSSLESSDATA *ICCLosslessData;
+  /* LOSSLESSDATA *ADGLosslessData; -> is stored in CLDLosslessData[offset] */
+
+  LOSSLESSDATA *IPDLosslessData;
+  SCHAR (*cmpOttIPDidx)[MAX_PARAMETER_SETS][MAX_PARAMETER_BANDS];
+  int phaseMode;
+  int OpdSmoothingMode;
+
+  UCHAR tempShapeEnableChannelGES[MAX_OUTPUT_CHANNELS]; /*!< GES side info. */
+  UCHAR bsEnvShapeData[MAX_OUTPUT_CHANNELS]
+                      [MAX_TIME_SLOTS]; /*!< GES side info (quantized). */
+
+  UCHAR tempShapeEnableChannelSTP[MAX_OUTPUT_CHANNELS]; /*!< STP side info. */
+
+  TSD_DATA TsdData[1]; /*!< TSD data structure. */
+};
+
+typedef struct {
+  /* Lossless state */
+  LOSSLESSSTATE CLDLosslessState[MAX_NUM_PARAMETERS];
+  LOSSLESSSTATE ICCLosslessState[MAX_NUM_PARAMETERS];
+  LOSSLESSSTATE IPDLosslessState[MAX_NUM_PARAMETERS];
+} BS_LL_STATE;
+
+typedef struct {
+  int prevParamSlot;
+  int prevSmgTime;
+  UCHAR prevSmgData[MAX_PARAMETER_BANDS];
+
+  FIXP_DBL opdLeftState__FDK[MAX_PARAMETER_BANDS];
+  FIXP_DBL opdRightState__FDK[MAX_PARAMETER_BANDS];
+
+} SMOOTHING_STATE;
+
+typedef struct {
+  FIXP_DBL alpha__FDK;
+  FIXP_DBL beta__FDK;
+  FIXP_DBL partNrgPrev__FDK[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS]
+                           [BB_ENV_SIZE];
+  FIXP_DBL normNrgPrev__FDK[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS];
+  FIXP_DBL frameNrgPrev__FDK[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS];
+  INT partNrgPrevSF[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS];
+  INT partNrgPrev2SF[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS];
+  INT normNrgPrevSF[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS];
+  INT frameNrgPrevSF[2 * MAX_OUTPUT_CHANNELS + MAX_INPUT_CHANNELS];
+} RESHAPE_BBENV_STATE;
+
+typedef struct {
+  int maxNumInputChannels;
+  int maxNumOutputChannels;
+  int maxNumQmfBands;
+  int maxNumHybridBands;
+  int maxNumXChannels;
+  int maxNumVChannels;
+  int maxNumDecorChannels;
+  int maxNumCmplxQmfBands;
+  int maxNumCmplxHybBands;
+  int maxNumResChannels;
+  int bProcResidual; /* process residual */
+  int maxNumResidualChannels;
+  int maxNumOttBoxes;
+  int maxNumParams;
+
+} SACDEC_CREATION_PARAMS;
+
+struct spatialDec_struct {
+  SACDEC_ERROR
+  errInt;             /* Field to store internal errors.
+                         Will be clear at the very beginning of each process call. */
+  int staticDecScale; /* static scale of decoder */
+
+  /* GENERAL */
+  int samplingFreq;       /* [Hz] */
+  CFG_LEVEL decoderLevel; /* 0..5 */
+  CFG_EXTENT decoderMode;
+  CFG_BINAURAL binauralMode;
+
+  SACDEC_CREATION_PARAMS createParams;
+
+  int numComplexProcessingBands;
+
+  int treeConfig; /* TREE_5151 = 5151, TREE_5152 = 5152, TREE_525 = 525, defined
+                     in sac_bitdec.h */
+
+  int numInputChannels;  /* 1 (M) or 2 (L,R) */
+  int numOutputChannels; /* 6 for 3/2.1 (FL,FR,FC,LF,BL,BR) */
+  int numOttBoxes;       /* number of ott boxes */
+  int numM2rows;
+
+  int numOutputChannelsAT; /* Number of output channels after arbitrary tree
+                              processing */
+
+  int quantMode; /* QUANT_FINE, QUANT_EBQ1, QUANT_EBQ2, defined in sac_bitdec.h
+                  */
+  int arbitraryDownmix; /* (arbitraryDownmix != 0) 1 arbitrary downmix data
+                           present, 2 arbitrary downmix residual data present*/
+  int residualCoding;   /* (residualCoding != 0) => residual coding data present
+                         */
+  UCHAR nrResidualFrame;
+  UCHAR nrArbDownmixResidualFrame;
+  FDK_BITSTREAM **hResidualBitstreams;
+  int tempShapeConfig; /* */
+  int decorrType;      /* Indicates to use PS or none PS decorrelator. */
+  int decorrConfig;    /* chosen decorrelator */
+  int envQuantMode;    /* quantization mode of envelope reshaping data */
+
+  FIXP_DBL clipProtectGain__FDK; /* global gain for upmix */
+  char clipProtectGainSF__FDK;   /* global gain for upmix */
+
+  /* Currently ignoring center decorr
+     numVChannels = numDirektSignals + numDecorSignals */
+  int numDirektSignals;  /* needed for W, Number of direkt signals 515 -> 1 525
+                            -> 3 */
+  int wStartResidualIdx; /* Where to start read residuals for W, = 0 for 515, =
+                            1 for 525 since one residual is used in V */
+  int numDecorSignals;   /* needed for W, Number of residual and decorrelated
+                            signals, = 2, 3 for center deccorelation*/
+  int numVChannels;      /* direct signals + decorelator signals */
+  int numXChannels;      /* direct input signals + TTT-residuals */
+
+  int timeSlots;    /* length of spatial frame in QMF samples */
+  int curTimeSlot;  /* pointer to the current time slot used for hyperframing */
+  int prevTimeSlot; /*  */
+  int curPs;
+  int frameLength; /* number of output waveform samples/channel/frame */
+  UPMIXTYPE upmixType;
+  int partiallyComplex;
+  int useFDreverb;
+
+  int bShareDelayWithSBR;
+
+  int tp_hybBandBorder; /* Hybrid band indicating the HP filter cut-off. */
+
+  /* FREQUENCY MAPPING */
+  int qmfBands;
+  int hybridBands;
+  const SCHAR *kernels; /* Mapping hybrid band to parameter band. */
+
+  int TsdTs; /**< TSD QMF slot counter 0<= ts < numSlots */
+
+  int *param2hyb; /* Mapping parameter bands to hybrid bands */
+  int kernels_width[MAX_PARAMETER_BANDS]; /* Mapping parmeter band to hybrid
+                                             band offsets. */
+
+  /* Residual coding */
+  int residualSamplingFreq;
+  UCHAR residualPresent[MAX_NUM_OTT + MAX_NUM_TTT];
+  UCHAR residualBands[MAX_NUM_OTT + MAX_NUM_TTT];    /* 0, if no residual data
+                                                        present for this box */
+  UCHAR residualQMFBands[MAX_NUM_OTT + MAX_NUM_TTT]; /* needed for optimized
+                                                        mdct2qmf calculation */
+  SPATIAL_SPECIFIC_CONFIG *pConfigCurrent;
+
+  int arbdmxFramesPerSpatialFrame;
+  int arbdmxUpdQMF;
+
+  int numParameterBands; /* Number of parameter bands 40, 28, 20, 14, 10, ...
+                            .*/
+  int bitstreamParameterBands;
+  int *numOttBands; /* number of bands for each ott, is != numParameterBands for
+                       LFEs */
+
+  /* 1 MAPPING */
+  UCHAR extendFrame;
+  UCHAR numParameterSetsPrev;
+
+  int *smgTime;
+  UCHAR **smgData;
+
+  /* PARAMETER DATA decoded and dequantized */
+
+  /* Last parameters from prev frame required during decode in mapIndexData()
+   * and not touched during parse */
+  SCHAR **ottCLDidxPrev;
+  SCHAR **ottICCidxPrev;
+  SCHAR **arbdmxGainIdxPrev;
+  SCHAR **ottIPDidxPrev;
+  SCHAR ***outIdxData; /* is this really persistent memory ? */
+
+  /* State mem required during parse in SpatialDecParseFrameData() */
+  SCHAR **cmpOttCLDidxPrev;
+  SCHAR **cmpOttICCidxPrev;
+  SCHAR ***ottICCdiffidx;
+  SCHAR **cmpOttIPDidxPrev;
+
+  /* State mem required in parseArbitraryDownmixData */
+  SCHAR **cmpArbdmxGainIdxPrev;
+
+  SCHAR ***ottCLD__FDK;
+  SCHAR ***ottICC__FDK;
+
+  SCHAR ***arbdmxGain__FDK; /* Holds the artistic downmix correction index.*/
+
+  FIXP_DBL *arbdmxAlpha__FDK;
+  FIXP_DBL *arbdmxAlphaPrev__FDK;
+
+  UCHAR stereoConfigIndex;
+  int highRateMode;
+
+  int phaseCoding;
+
+  SCHAR ***ottIPD__FDK;
+
+  FIXP_DBL PhaseLeft__FDK[MAX_PARAMETER_BANDS];
+  FIXP_DBL PhaseRight__FDK[MAX_PARAMETER_BANDS];
+  FIXP_DBL PhasePrevLeft__FDK[MAX_PARAMETER_BANDS];
+  FIXP_DBL PhasePrevRight__FDK[MAX_PARAMETER_BANDS];
+  int numOttBandsIPD;
+
+  /* GAIN MATRICIES FOR CURRENT and PREVIOUS PARMATER SET(s)*/
+  FIXP_DBL ***M2Real__FDK;
+  FIXP_DBL ***M2Imag__FDK;
+  FIXP_DBL ***M2RealPrev__FDK;
+  FIXP_DBL ***M2ImagPrev__FDK;
+
+  /* INPUT SIGNALS */
+  FIXP_DBL ***qmfInputRealDelayBuffer__FDK;
+  FIXP_DBL ***qmfInputImagDelayBuffer__FDK;
+
+  int pc_filterdelay; /* additional delay to align HQ with LP before hybird
+                         analysis */
+  int qmfInputDelayBufPos;
+  FIXP_DBL **qmfInputReal__FDK;
+  FIXP_DBL **qmfInputImag__FDK;
+
+  FIXP_DBL **hybInputReal__FDK;
+  FIXP_DBL **hybInputImag__FDK;
+
+  FIXP_DBL **binInputReverb;
+
+  FIXP_DBL binGain, reverbGain;
+  FIXP_DBL binCenterGain, reverbCenterGain;
+
+  /* RESIDUAL SIGNALS */
+
+  FIXP_DBL ***qmfResidualReal__FDK;
+  FIXP_DBL ***qmfResidualImag__FDK;
+
+  FIXP_DBL **hybResidualReal__FDK;
+  FIXP_DBL **hybResidualImag__FDK;
+
+  int qmfOutputRealDryDelayBufPos;
+  FIXP_DBL ***qmfOutputRealDryDelayBuffer__FDK;
+  FIXP_DBL ***qmfOutputImagDryFilterBuffer__FDK;
+  FIXP_DBL *qmfOutputImagDryFilterBufferBase__FDK;
+
+  /* TEMPORARY SIGNALS */
+
+  FIXP_DBL **wReal__FDK;
+  FIXP_DBL **wImag__FDK;
+
+  /* OUTPUT SIGNALS */
+  FIXP_DBL **hybOutputRealDry__FDK;
+  FIXP_DBL **hybOutputImagDry__FDK;
+  FIXP_DBL **hybOutputRealWet__FDK;
+  FIXP_DBL **hybOutputImagWet__FDK;
+  PCM_MPS *timeOut__FDK;
+
+  HANDLE_FDK_QMF_DOMAIN pQmfDomain;
+
+  FDK_ANA_HYB_FILTER
+  *hybridAnalysis; /*!< pointer Analysis hybrid filterbank array. */
+  FDK_SYN_HYB_FILTER
+  *hybridSynthesis; /*!< pointer Synthesis hybrid filterbank array. */
+  FIXP_DBL **
+      pHybridAnaStatesLFdmx; /*!< pointer to analysis hybrid filter states LF */
+  FIXP_DBL **
+      pHybridAnaStatesHFdmx; /*!< pointer to analysis hybrid filter states HF */
+  FIXP_DBL **
+      pHybridAnaStatesLFres; /*!< pointer to analysis hybrid filter states LF */
+  FIXP_DBL **
+      pHybridAnaStatesHFres; /*!< pointer to analysis hybrid filter states HF */
+
+  DECORR_DEC *apDecor; /*!< pointer decorrelator array. */
+  FIXP_DBL **pDecorBufferCplx;
+
+  SMOOTHING_STATE *smoothState; /*!< Pointer to smoothing states. */
+
+  RESHAPE_BBENV_STATE *reshapeBBEnvState; /*!< GES handle. */
+  SCHAR row2channelDmxGES[MAX_OUTPUT_CHANNELS];
+
+  HANDLE_STP_DEC hStpDec; /*!< STP handle. */
+
+  const UCHAR *pActivM2ParamBands;
+
+  int bOverwriteM1M2prev; /* Overwrite previous M2/M2 params with first set of
+                             new frame after SSC change (aka
+                             decodeAfterConfigHasChangedFlag). */
+  SpatialDecConcealmentInfo concealInfo;
+};
+
+#define SACDEC_SYNTAX_MPS 1
+#define SACDEC_SYNTAX_USAC 2
+#define SACDEC_SYNTAX_RSVD50 4
+#define SACDEC_SYNTAX_L2 8
+#define SACDEC_SYNTAX_L3 16
+#define SACDEC_SYNTAX_LD 32
+
+static inline int GetProcBand(spatialDec_struct *self, int qs) {
+  return self->kernels[qs];
+}
+
+#endif /* SAC_DEC_H */