Coverage Report

Created: 2025-09-05 06:55

/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
13.0k
    ACTIVE_DRC* pActiveDrc) {
112
13.0k
  DRC_ERROR err = DE_OK;
113
13.0k
  int g;
114
13.0k
  int gainElementCount = 0;
115
13.0k
  UCHAR nDrcChannelGroups = 0;
116
13.0k
  SCHAR gainSetIndexForChannelGroup[8];
117
118
13.0k
  err = deriveDrcChannelGroups(
119
13.0k
      pInst->drcSetEffect, pInst->drcChannelCount, pInst->gainSetIndex,
120
13.0k
      pInst->drcSetEffect & (EB_DUCK_OTHER | EB_DUCK_SELF)
121
13.0k
          ? pInst->duckingModificationForChannel
122
13.0k
          : NULL,
123
13.0k
      &nDrcChannelGroups, gainSetIndexForChannelGroup,
124
13.0k
      pActiveDrc->channelGroupForChannel,
125
13.0k
      pInst->drcSetEffect & (EB_DUCK_OTHER | EB_DUCK_SELF)
126
13.0k
          ? pActiveDrc->duckingModificationForChannelGroup
127
13.0k
          : NULL);
128
13.0k
  if (err) return (err);
129
130
  /* sanity check */
131
13.0k
  if (nDrcChannelGroups != pInst->nDrcChannelGroups) return DE_NOT_OK;
132
49.1k
  for (g = 0; g < pInst->nDrcChannelGroups; g++) {
133
36.0k
    if (gainSetIndexForChannelGroup[g] != pInst->gainSetIndexForChannelGroup[g])
134
0
      return DE_NOT_OK;
135
36.0k
  }
136
137
49.1k
  for (g = 0; g < pInst->nDrcChannelGroups; g++) {
138
36.0k
    int seq = pInst->gainSetIndexForChannelGroup[g];
139
36.0k
    if (seq != -1 && (hUniDrcConfig->drcCoefficientsUniDrcCount == 0 ||
140
36.0k
                      seq >= pCoef->gainSetCount)) {
141
34.7k
      pActiveDrc->channelGroupIsParametricDrc[g] = 1;
142
34.7k
    } else {
143
1.28k
      pActiveDrc->channelGroupIsParametricDrc[g] = 0;
144
1.28k
      if (seq >= pCoef->gainSetCount) {
145
0
        return DE_NOT_OK;
146
0
      }
147
1.28k
    }
148
36.0k
  }
149
150
  /* gainElementCount */
151
13.0k
  if (pInst->drcSetEffect & (EB_DUCK_OTHER | EB_DUCK_SELF)) {
152
36.1k
    for (g = 0; g < pInst->nDrcChannelGroups; g++) {
153
29.0k
      pActiveDrc->bandCountForChannelGroup[g] = 1;
154
29.0k
    }
155
7.05k
    pActiveDrc->gainElementCount =
156
7.05k
        pInst->nDrcChannelGroups; /* one gain element per channel group */
157
7.05k
  } else {
158
13.0k
    for (g = 0; g < pInst->nDrcChannelGroups; g++) {
159
7.01k
      if (pActiveDrc->channelGroupIsParametricDrc[g]) {
160
5.92k
        gainElementCount++;
161
5.92k
        pActiveDrc->bandCountForChannelGroup[g] = 1;
162
5.92k
      } else {
163
1.09k
        int seq, bandCount;
164
1.09k
        seq = pInst->gainSetIndexForChannelGroup[g];
165
1.09k
        bandCount = pCoef->gainSet[seq].bandCount;
166
1.09k
        pActiveDrc->bandCountForChannelGroup[g] = bandCount;
167
1.09k
        gainElementCount += bandCount;
168
1.09k
      }
169
7.01k
    }
170
6.00k
    pActiveDrc->gainElementCount = gainElementCount;
171
6.00k
  }
172
173
  /* prepare gainElementForGroup (cumulated sum of bandCountForChannelGroup) */
174
13.0k
  pActiveDrc->gainElementForGroup[0] = 0;
175
40.7k
  for (g = 1; g < pInst->nDrcChannelGroups; g++) {
176
27.7k
    pActiveDrc->gainElementForGroup[g] =
177
27.7k
        pActiveDrc->gainElementForGroup[g - 1] +
178
27.7k
        pActiveDrc->bandCountForChannelGroup[g - 1]; /* index of first gain
179
                                                        sequence in channel
180
                                                        group */
181
27.7k
  }
182
183
13.0k
  return DE_OK;
184
13.0k
}
185
186
DRC_ERROR
187
145k
initGainDec(HANDLE_DRC_GAIN_DECODER hGainDec) {
188
145k
  int i, j, k;
189
190
  /* sanity check */
191
145k
  if (hGainDec->deltaTminDefault > hGainDec->frameSize) return DE_NOT_OK;
192
193
580k
  for (i = 0; i < MAX_ACTIVE_DRCS; i++) {
194
3.91M
    for (j = 0; j < 8; j++) {
195
      /* use startup node at the beginning */
196
3.48M
      hGainDec->activeDrc[i].lnbIndexForChannel[j][0] = 0;
197
17.4M
      for (k = 1; k < NUM_LNB_FRAMES; k++) {
198
13.9M
        hGainDec->activeDrc[i].lnbIndexForChannel[j][k] = -1;
199
13.9M
      }
200
3.48M
    }
201
435k
  }
202
203
1.30M
  for (j = 0; j < 8; j++) {
204
1.16M
    hGainDec->channelGain[j] = FL2FXCONST_DBL(1.0f / (float)(1 << 8));
205
1.16M
  }
206
207
2.46M
  for (i = 0; i < 4 * 1024 / 256; i++) {
208
2.32M
    hGainDec->dummySubbandGains[i] = FL2FXCONST_DBL(1.0f / (float)(1 << 7));
209
2.32M
  }
210
211
145k
  hGainDec->status = 0; /* startup */
212
213
145k
  return DE_OK;
214
145k
}
215
216
145k
void initDrcGainBuffers(const int frameSize, DRC_GAIN_BUFFERS* drcGainBuffers) {
217
145k
  int i, c, j;
218
  /* prepare 12 instances of node buffers */
219
1.88M
  for (i = 0; i < 12; i++) {
220
10.4M
    for (j = 0; j < NUM_LNB_FRAMES; j++) {
221
8.70M
      drcGainBuffers->linearNodeBuffer[i].nNodes[j] = 1;
222
8.70M
      drcGainBuffers->linearNodeBuffer[i].linearNode[j][0].gainLin =
223
8.70M
          FL2FXCONST_DBL(1.0f / (float)(1 << 7));
224
8.70M
      if (j == 0) {
225
1.74M
        drcGainBuffers->linearNodeBuffer[i].linearNode[j][0].time =
226
1.74M
            0; /* initialize last node with startup node */
227
6.96M
      } else {
228
6.96M
        drcGainBuffers->linearNodeBuffer[i].linearNode[j][0].time =
229
6.96M
            frameSize - 1;
230
6.96M
      }
231
8.70M
    }
232
1.74M
  }
233
234
  /* prepare dummyLnb, a linearNodeBuffer containing a constant gain of 0 dB,
235
   * for the "no DRC processing" case */
236
145k
  drcGainBuffers->dummyLnb.gainInterpolationType = GIT_LINEAR;
237
870k
  for (i = 0; i < NUM_LNB_FRAMES; i++) {
238
725k
    drcGainBuffers->dummyLnb.nNodes[i] = 1;
239
725k
    drcGainBuffers->dummyLnb.linearNode[i][0].gainLin =
240
725k
        FL2FXCONST_DBL(1.0f / (float)(1 << 7));
241
725k
    drcGainBuffers->dummyLnb.linearNode[i][0].time = frameSize - 1;
242
725k
  }
243
244
  /* prepare channelGain delay line */
245
1.30M
  for (c = 0; c < 8; c++) {
246
6.96M
    for (i = 0; i < NUM_LNB_FRAMES; i++) {
247
5.80M
      drcGainBuffers->channelGain[c][i] =
248
5.80M
          FL2FXCONST_DBL(1.0f / (float)(1 << 8));
249
5.80M
    }
250
1.16M
  }
251
252
145k
  drcGainBuffers->lnbPointer = 0;
253
145k
}
254
255
DRC_ERROR
256
initActiveDrc(HANDLE_DRC_GAIN_DECODER hGainDec,
257
              HANDLE_UNI_DRC_CONFIG hUniDrcConfig, const int drcSetIdSelected,
258
98.5k
              const int downmixIdSelected) {
259
98.5k
  int g, isMultiband = 0;
260
98.5k
  DRC_ERROR err = DE_OK;
261
98.5k
  DRC_INSTRUCTIONS_UNI_DRC* pInst = NULL;
262
98.5k
  DRC_COEFFICIENTS_UNI_DRC* pCoef = NULL;
263
264
98.5k
  pInst = selectDrcInstructions(hUniDrcConfig, drcSetIdSelected);
265
98.5k
  if (pInst == NULL) {
266
0
    return DE_NOT_OK;
267
0
  }
268
269
98.5k
  if (pInst->drcSetId >= 0) {
270
13.3k
    pCoef = selectDrcCoefficients(hUniDrcConfig, pInst->drcLocation);
271
13.3k
    if (pCoef == NULL) {
272
0
      return DE_NOT_OK;
273
0
    }
274
275
13.3k
    if (pCoef->drcFrameSizePresent) {
276
540
      if (pCoef->drcFrameSize != hGainDec->frameSize) {
277
311
        return DE_NOT_OK;
278
311
      }
279
540
    }
280
281
13.0k
    err = _generateDrcInstructionsDerivedData(
282
13.0k
        hGainDec, hUniDrcConfig, pInst, pCoef,
283
13.0k
        &(hGainDec->activeDrc[hGainDec->nActiveDrcs]));
284
13.0k
    if (err) return err;
285
13.0k
  }
286
287
98.2k
  hGainDec->activeDrc[hGainDec->nActiveDrcs].pInst = pInst;
288
98.2k
  hGainDec->activeDrc[hGainDec->nActiveDrcs].pCoef = pCoef;
289
290
134k
  for (g = 0; g < pInst->nDrcChannelGroups; g++) {
291
36.0k
    if (hGainDec->activeDrc[hGainDec->nActiveDrcs].bandCountForChannelGroup[g] >
292
36.0k
        1) {
293
1.06k
      if (hGainDec->multiBandActiveDrcIndex != -1) {
294
290
        return DE_NOT_OK;
295
290
      }
296
770
      isMultiband = 1;
297
770
    }
298
36.0k
  }
299
300
97.9k
  if (isMultiband) {
301
    /* Keep activeDrc index of multiband DRC set */
302
764
    hGainDec->multiBandActiveDrcIndex = hGainDec->nActiveDrcs;
303
764
  }
304
305
97.9k
  if ((hGainDec->channelGainActiveDrcIndex == -1) &&
306
97.9k
      (downmixIdSelected == DOWNMIX_ID_BASE_LAYOUT) &&
307
97.9k
      (hUniDrcConfig->drcInstructionsUniDrcCount >
308
89.7k
       0)) { /* use this activeDrc to apply channelGains */
309
13.0k
    hGainDec->channelGainActiveDrcIndex = hGainDec->nActiveDrcs;
310
13.0k
  }
311
312
97.9k
  hGainDec->nActiveDrcs++;
313
97.9k
  if (hGainDec->nActiveDrcs > MAX_ACTIVE_DRCS) return DE_NOT_OK;
314
315
97.9k
  return DE_OK;
316
97.9k
}
317
318
DRC_ERROR
319
93.0k
initActiveDrcOffset(HANDLE_DRC_GAIN_DECODER hGainDec) {
320
93.0k
  int a, accGainElementCount;
321
322
93.0k
  accGainElementCount = 0;
323
189k
  for (a = 0; a < hGainDec->nActiveDrcs; a++) {
324
97.5k
    hGainDec->activeDrc[a].activeDrcOffset = accGainElementCount;
325
97.5k
    accGainElementCount += hGainDec->activeDrc[a].gainElementCount;
326
97.5k
    if (accGainElementCount > 12) {
327
1.28k
      hGainDec->nActiveDrcs = a;
328
1.28k
      return DE_NOT_OK;
329
1.28k
    }
330
97.5k
  }
331
332
91.7k
  return DE_OK;
333
93.0k
}