Coverage Report

Created: 2025-08-26 06:50

/src/aac/libDRCdec/src/drcGainDec_init.cpp
Line
Count
Source (jump to first uncovered line)
1
/* -----------------------------------------------------------------------------
2
Software License for The Fraunhofer FDK AAC Codec Library for Android
3
4
© Copyright  1995 - 2019 Fraunhofer-Gesellschaft zur Förderung der angewandten
5
Forschung e.V. All rights reserved.
6
7
 1.    INTRODUCTION
8
The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
9
that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
10
scheme for digital audio. This FDK AAC Codec software is intended to be used on
11
a wide variety of Android devices.
12
13
AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
14
general perceptual audio codecs. AAC-ELD is considered the best-performing
15
full-bandwidth communications codec by independent studies and is widely
16
deployed. AAC has been standardized by ISO and IEC as part of the MPEG
17
specifications.
18
19
Patent licenses for necessary patent claims for the FDK AAC Codec (including
20
those of Fraunhofer) may be obtained through Via Licensing
21
(www.vialicensing.com) or through the respective patent owners individually for
22
the purpose of encoding or decoding bit streams in products that are compliant
23
with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
24
Android devices already license these patent claims through Via Licensing or
25
directly from the patent owners, and therefore FDK AAC Codec software may
26
already be covered under those patent licenses when it is used for those
27
licensed purposes only.
28
29
Commercially-licensed AAC software libraries, including floating-point versions
30
with enhanced sound quality, are also available from Fraunhofer. Users are
31
encouraged to check the Fraunhofer website for additional applications
32
information and documentation.
33
34
2.    COPYRIGHT LICENSE
35
36
Redistribution and use in source and binary forms, with or without modification,
37
are permitted without payment of copyright license fees provided that you
38
satisfy the following conditions:
39
40
You must retain the complete text of this software license in redistributions of
41
the FDK AAC Codec or your modifications thereto in source code form.
42
43
You must retain the complete text of this software license in the documentation
44
and/or other materials provided with redistributions of the FDK AAC Codec or
45
your modifications thereto in binary form. You must make available free of
46
charge copies of the complete source code of the FDK AAC Codec and your
47
modifications thereto to recipients of copies in binary form.
48
49
The name of Fraunhofer may not be used to endorse or promote products derived
50
from this library without prior written permission.
51
52
You may not charge copyright license fees for anyone to use, copy or distribute
53
the FDK AAC Codec software or your modifications thereto.
54
55
Your modified versions of the FDK AAC Codec must carry prominent notices stating
56
that you changed the software and the date of any change. For modified versions
57
of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
58
must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
59
AAC Codec Library for Android."
60
61
3.    NO PATENT LICENSE
62
63
NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
64
limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
65
Fraunhofer provides no warranty of patent non-infringement with respect to this
66
software.
67
68
You may use this FDK AAC Codec software or modifications thereto only for
69
purposes that are authorized by appropriate patent licenses.
70
71
4.    DISCLAIMER
72
73
This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
74
holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
75
including but not limited to the implied warranties of merchantability and
76
fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
77
CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
78
or consequential damages, including but not limited to procurement of substitute
79
goods or services; loss of use, data, or profits, or business interruption,
80
however caused and on any theory of liability, whether in contract, strict
81
liability, or tort (including negligence), arising in any way out of the use of
82
this software, even if advised of the possibility of such damage.
83
84
5.    CONTACT INFORMATION
85
86
Fraunhofer Institute for Integrated Circuits IIS
87
Attention: Audio and Multimedia Departments - FDK AAC LL
88
Am Wolfsmantel 33
89
91058 Erlangen, Germany
90
91
www.iis.fraunhofer.de/amm
92
amm-info@iis.fraunhofer.de
93
----------------------------------------------------------------------------- */
94
95
/************************* MPEG-D DRC decoder library **************************
96
97
   Author(s):
98
99
   Description:
100
101
*******************************************************************************/
102
103
#include "drcDec_types.h"
104
#include "drcDec_tools.h"
105
#include "drcDec_gainDecoder.h"
106
#include "drcGainDec_init.h"
107
108
static DRC_ERROR _generateDrcInstructionsDerivedData(
109
    HANDLE_DRC_GAIN_DECODER hGainDec, HANDLE_UNI_DRC_CONFIG hUniDrcConfig,
110
    DRC_INSTRUCTIONS_UNI_DRC* pInst, DRC_COEFFICIENTS_UNI_DRC* pCoef,
111
14.6k
    ACTIVE_DRC* pActiveDrc) {
112
14.6k
  DRC_ERROR err = DE_OK;
113
14.6k
  int g;
114
14.6k
  int gainElementCount = 0;
115
14.6k
  UCHAR nDrcChannelGroups = 0;
116
14.6k
  SCHAR gainSetIndexForChannelGroup[8];
117
118
14.6k
  err = deriveDrcChannelGroups(
119
14.6k
      pInst->drcSetEffect, pInst->drcChannelCount, pInst->gainSetIndex,
120
14.6k
      pInst->drcSetEffect & (EB_DUCK_OTHER | EB_DUCK_SELF)
121
14.6k
          ? pInst->duckingModificationForChannel
122
14.6k
          : NULL,
123
14.6k
      &nDrcChannelGroups, gainSetIndexForChannelGroup,
124
14.6k
      pActiveDrc->channelGroupForChannel,
125
14.6k
      pInst->drcSetEffect & (EB_DUCK_OTHER | EB_DUCK_SELF)
126
14.6k
          ? pActiveDrc->duckingModificationForChannelGroup
127
14.6k
          : NULL);
128
14.6k
  if (err) return (err);
129
130
  /* sanity check */
131
14.6k
  if (nDrcChannelGroups != pInst->nDrcChannelGroups) return DE_NOT_OK;
132
63.6k
  for (g = 0; g < pInst->nDrcChannelGroups; g++) {
133
48.9k
    if (gainSetIndexForChannelGroup[g] != pInst->gainSetIndexForChannelGroup[g])
134
0
      return DE_NOT_OK;
135
48.9k
  }
136
137
63.6k
  for (g = 0; g < pInst->nDrcChannelGroups; g++) {
138
48.9k
    int seq = pInst->gainSetIndexForChannelGroup[g];
139
48.9k
    if (seq != -1 && (hUniDrcConfig->drcCoefficientsUniDrcCount == 0 ||
140
48.9k
                      seq >= pCoef->gainSetCount)) {
141
47.8k
      pActiveDrc->channelGroupIsParametricDrc[g] = 1;
142
47.8k
    } else {
143
1.18k
      pActiveDrc->channelGroupIsParametricDrc[g] = 0;
144
1.18k
      if (seq >= pCoef->gainSetCount) {
145
0
        return DE_NOT_OK;
146
0
      }
147
1.18k
    }
148
48.9k
  }
149
150
  /* gainElementCount */
151
14.6k
  if (pInst->drcSetEffect & (EB_DUCK_OTHER | EB_DUCK_SELF)) {
152
49.5k
    for (g = 0; g < pInst->nDrcChannelGroups; g++) {
153
40.9k
      pActiveDrc->bandCountForChannelGroup[g] = 1;
154
40.9k
    }
155
8.63k
    pActiveDrc->gainElementCount =
156
8.63k
        pInst->nDrcChannelGroups; /* one gain element per channel group */
157
8.63k
  } else {
158
14.1k
    for (g = 0; g < pInst->nDrcChannelGroups; g++) {
159
8.06k
      if (pActiveDrc->channelGroupIsParametricDrc[g]) {
160
7.00k
        gainElementCount++;
161
7.00k
        pActiveDrc->bandCountForChannelGroup[g] = 1;
162
7.00k
      } else {
163
1.06k
        int seq, bandCount;
164
1.06k
        seq = pInst->gainSetIndexForChannelGroup[g];
165
1.06k
        bandCount = pCoef->gainSet[seq].bandCount;
166
1.06k
        pActiveDrc->bandCountForChannelGroup[g] = bandCount;
167
1.06k
        gainElementCount += bandCount;
168
1.06k
      }
169
8.06k
    }
170
6.05k
    pActiveDrc->gainElementCount = gainElementCount;
171
6.05k
  }
172
173
  /* prepare gainElementForGroup (cumulated sum of bandCountForChannelGroup) */
174
14.6k
  pActiveDrc->gainElementForGroup[0] = 0;
175
53.4k
  for (g = 1; g < pInst->nDrcChannelGroups; g++) {
176
38.7k
    pActiveDrc->gainElementForGroup[g] =
177
38.7k
        pActiveDrc->gainElementForGroup[g - 1] +
178
38.7k
        pActiveDrc->bandCountForChannelGroup[g - 1]; /* index of first gain
179
                                                        sequence in channel
180
                                                        group */
181
38.7k
  }
182
183
14.6k
  return DE_OK;
184
14.6k
}
185
186
DRC_ERROR
187
143k
initGainDec(HANDLE_DRC_GAIN_DECODER hGainDec) {
188
143k
  int i, j, k;
189
190
  /* sanity check */
191
143k
  if (hGainDec->deltaTminDefault > hGainDec->frameSize) return DE_NOT_OK;
192
193
573k
  for (i = 0; i < MAX_ACTIVE_DRCS; i++) {
194
3.86M
    for (j = 0; j < 8; j++) {
195
      /* use startup node at the beginning */
196
3.43M
      hGainDec->activeDrc[i].lnbIndexForChannel[j][0] = 0;
197
17.1M
      for (k = 1; k < NUM_LNB_FRAMES; k++) {
198
13.7M
        hGainDec->activeDrc[i].lnbIndexForChannel[j][k] = -1;
199
13.7M
      }
200
3.43M
    }
201
429k
  }
202
203
1.28M
  for (j = 0; j < 8; j++) {
204
1.14M
    hGainDec->channelGain[j] = FL2FXCONST_DBL(1.0f / (float)(1 << 8));
205
1.14M
  }
206
207
2.43M
  for (i = 0; i < 4 * 1024 / 256; i++) {
208
2.29M
    hGainDec->dummySubbandGains[i] = FL2FXCONST_DBL(1.0f / (float)(1 << 7));
209
2.29M
  }
210
211
143k
  hGainDec->status = 0; /* startup */
212
213
143k
  return DE_OK;
214
143k
}
215
216
143k
void initDrcGainBuffers(const int frameSize, DRC_GAIN_BUFFERS* drcGainBuffers) {
217
143k
  int i, c, j;
218
  /* prepare 12 instances of node buffers */
219
1.86M
  for (i = 0; i < 12; i++) {
220
10.3M
    for (j = 0; j < NUM_LNB_FRAMES; j++) {
221
8.59M
      drcGainBuffers->linearNodeBuffer[i].nNodes[j] = 1;
222
8.59M
      drcGainBuffers->linearNodeBuffer[i].linearNode[j][0].gainLin =
223
8.59M
          FL2FXCONST_DBL(1.0f / (float)(1 << 7));
224
8.59M
      if (j == 0) {
225
1.71M
        drcGainBuffers->linearNodeBuffer[i].linearNode[j][0].time =
226
1.71M
            0; /* initialize last node with startup node */
227
6.87M
      } else {
228
6.87M
        drcGainBuffers->linearNodeBuffer[i].linearNode[j][0].time =
229
6.87M
            frameSize - 1;
230
6.87M
      }
231
8.59M
    }
232
1.71M
  }
233
234
  /* prepare dummyLnb, a linearNodeBuffer containing a constant gain of 0 dB,
235
   * for the "no DRC processing" case */
236
143k
  drcGainBuffers->dummyLnb.gainInterpolationType = GIT_LINEAR;
237
859k
  for (i = 0; i < NUM_LNB_FRAMES; i++) {
238
716k
    drcGainBuffers->dummyLnb.nNodes[i] = 1;
239
716k
    drcGainBuffers->dummyLnb.linearNode[i][0].gainLin =
240
716k
        FL2FXCONST_DBL(1.0f / (float)(1 << 7));
241
716k
    drcGainBuffers->dummyLnb.linearNode[i][0].time = frameSize - 1;
242
716k
  }
243
244
  /* prepare channelGain delay line */
245
1.28M
  for (c = 0; c < 8; c++) {
246
6.87M
    for (i = 0; i < NUM_LNB_FRAMES; i++) {
247
5.73M
      drcGainBuffers->channelGain[c][i] =
248
5.73M
          FL2FXCONST_DBL(1.0f / (float)(1 << 8));
249
5.73M
    }
250
1.14M
  }
251
252
143k
  drcGainBuffers->lnbPointer = 0;
253
143k
}
254
255
DRC_ERROR
256
initActiveDrc(HANDLE_DRC_GAIN_DECODER hGainDec,
257
              HANDLE_UNI_DRC_CONFIG hUniDrcConfig, const int drcSetIdSelected,
258
128k
              const int downmixIdSelected) {
259
128k
  int g, isMultiband = 0;
260
128k
  DRC_ERROR err = DE_OK;
261
128k
  DRC_INSTRUCTIONS_UNI_DRC* pInst = NULL;
262
128k
  DRC_COEFFICIENTS_UNI_DRC* pCoef = NULL;
263
264
128k
  pInst = selectDrcInstructions(hUniDrcConfig, drcSetIdSelected);
265
128k
  if (pInst == NULL) {
266
0
    return DE_NOT_OK;
267
0
  }
268
269
128k
  if (pInst->drcSetId >= 0) {
270
14.9k
    pCoef = selectDrcCoefficients(hUniDrcConfig, pInst->drcLocation);
271
14.9k
    if (pCoef == NULL) {
272
0
      return DE_NOT_OK;
273
0
    }
274
275
14.9k
    if (pCoef->drcFrameSizePresent) {
276
362
      if (pCoef->drcFrameSize != hGainDec->frameSize) {
277
271
        return DE_NOT_OK;
278
271
      }
279
362
    }
280
281
14.6k
    err = _generateDrcInstructionsDerivedData(
282
14.6k
        hGainDec, hUniDrcConfig, pInst, pCoef,
283
14.6k
        &(hGainDec->activeDrc[hGainDec->nActiveDrcs]));
284
14.6k
    if (err) return err;
285
14.6k
  }
286
287
128k
  hGainDec->activeDrc[hGainDec->nActiveDrcs].pInst = pInst;
288
128k
  hGainDec->activeDrc[hGainDec->nActiveDrcs].pCoef = pCoef;
289
290
176k
  for (g = 0; g < pInst->nDrcChannelGroups; g++) {
291
48.9k
    if (hGainDec->activeDrc[hGainDec->nActiveDrcs].bandCountForChannelGroup[g] >
292
48.9k
        1) {
293
1.04k
      if (hGainDec->multiBandActiveDrcIndex != -1) {
294
289
        return DE_NOT_OK;
295
289
      }
296
758
      isMultiband = 1;
297
758
    }
298
48.9k
  }
299
300
127k
  if (isMultiband) {
301
    /* Keep activeDrc index of multiband DRC set */
302
758
    hGainDec->multiBandActiveDrcIndex = hGainDec->nActiveDrcs;
303
758
  }
304
305
127k
  if ((hGainDec->channelGainActiveDrcIndex == -1) &&
306
127k
      (downmixIdSelected == DOWNMIX_ID_BASE_LAYOUT) &&
307
127k
      (hUniDrcConfig->drcInstructionsUniDrcCount >
308
118k
       0)) { /* use this activeDrc to apply channelGains */
309
12.9k
    hGainDec->channelGainActiveDrcIndex = hGainDec->nActiveDrcs;
310
12.9k
  }
311
312
127k
  hGainDec->nActiveDrcs++;
313
127k
  if (hGainDec->nActiveDrcs > MAX_ACTIVE_DRCS) return DE_NOT_OK;
314
315
127k
  return DE_OK;
316
127k
}
317
318
DRC_ERROR
319
122k
initActiveDrcOffset(HANDLE_DRC_GAIN_DECODER hGainDec) {
320
122k
  int a, accGainElementCount;
321
322
122k
  accGainElementCount = 0;
323
247k
  for (a = 0; a < hGainDec->nActiveDrcs; a++) {
324
127k
    hGainDec->activeDrc[a].activeDrcOffset = accGainElementCount;
325
127k
    accGainElementCount += hGainDec->activeDrc[a].gainElementCount;
326
127k
    if (accGainElementCount > 12) {
327
1.77k
      hGainDec->nActiveDrcs = a;
328
1.77k
      return DE_NOT_OK;
329
1.77k
    }
330
127k
  }
331
332
120k
  return DE_OK;
333
122k
}