]> git.sesse.net Git - ffmpeg/blob - libavcodec/aacpsy.c
dnxhddec: better support for 4:4:4
[ffmpeg] / libavcodec / aacpsy.c
1 /*
2  * AAC encoder psychoacoustic model
3  * Copyright (C) 2008 Konstantin Shishkov
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * AAC encoder psychoacoustic model
25  */
26
27 #include "libavutil/attributes.h"
28 #include "libavutil/libm.h"
29
30 #include "avcodec.h"
31 #include "aactab.h"
32 #include "psymodel.h"
33
34 /***********************************
35  *              TODOs:
36  * try other bitrate controlling mechanism (maybe use ratecontrol.c?)
37  * control quality for quality-based output
38  **********************************/
39
40 /**
41  * constants for 3GPP AAC psychoacoustic model
42  * @{
43  */
44 #define PSY_3GPP_THR_SPREAD_HI   1.5f // spreading factor for low-to-hi threshold spreading  (15 dB/Bark)
45 #define PSY_3GPP_THR_SPREAD_LOW  3.0f // spreading factor for hi-to-low threshold spreading  (30 dB/Bark)
46 /* spreading factor for low-to-hi energy spreading, long block, > 22kbps/channel (20dB/Bark) */
47 #define PSY_3GPP_EN_SPREAD_HI_L1 2.0f
48 /* spreading factor for low-to-hi energy spreading, long block, <= 22kbps/channel (15dB/Bark) */
49 #define PSY_3GPP_EN_SPREAD_HI_L2 1.5f
50 /* spreading factor for low-to-hi energy spreading, short block (15 dB/Bark) */
51 #define PSY_3GPP_EN_SPREAD_HI_S  1.5f
52 /* spreading factor for hi-to-low energy spreading, long block (30dB/Bark) */
53 #define PSY_3GPP_EN_SPREAD_LOW_L 3.0f
54 /* spreading factor for hi-to-low energy spreading, short block (20dB/Bark) */
55 #define PSY_3GPP_EN_SPREAD_LOW_S 2.0f
56
57 #define PSY_3GPP_RPEMIN      0.01f
58 #define PSY_3GPP_RPELEV      2.0f
59
60 #define PSY_3GPP_C1          3.0f           /* log2(8) */
61 #define PSY_3GPP_C2          1.3219281f     /* log2(2.5) */
62 #define PSY_3GPP_C3          0.55935729f    /* 1 - C2 / C1 */
63
64 #define PSY_SNR_1DB          7.9432821e-1f  /* -1dB */
65 #define PSY_SNR_25DB         3.1622776e-3f  /* -25dB */
66
67 #define PSY_3GPP_SAVE_SLOPE_L  -0.46666667f
68 #define PSY_3GPP_SAVE_SLOPE_S  -0.36363637f
69 #define PSY_3GPP_SAVE_ADD_L    -0.84285712f
70 #define PSY_3GPP_SAVE_ADD_S    -0.75f
71 #define PSY_3GPP_SPEND_SLOPE_L  0.66666669f
72 #define PSY_3GPP_SPEND_SLOPE_S  0.81818181f
73 #define PSY_3GPP_SPEND_ADD_L   -0.35f
74 #define PSY_3GPP_SPEND_ADD_S   -0.26111111f
75 #define PSY_3GPP_CLIP_LO_L      0.2f
76 #define PSY_3GPP_CLIP_LO_S      0.2f
77 #define PSY_3GPP_CLIP_HI_L      0.95f
78 #define PSY_3GPP_CLIP_HI_S      0.75f
79
80 #define PSY_3GPP_AH_THR_LONG    0.5f
81 #define PSY_3GPP_AH_THR_SHORT   0.63f
82
83 enum {
84     PSY_3GPP_AH_NONE,
85     PSY_3GPP_AH_INACTIVE,
86     PSY_3GPP_AH_ACTIVE
87 };
88
89 #define PSY_3GPP_BITS_TO_PE(bits) ((bits) * 1.18f)
90 #define PSY_3GPP_PE_TO_BITS(bits) ((bits) / 1.18f)
91
92 /* LAME psy model constants */
93 #define PSY_LAME_FIR_LEN 21         ///< LAME psy model FIR order
94 #define AAC_BLOCK_SIZE_LONG 1024    ///< long block size
95 #define AAC_BLOCK_SIZE_SHORT 128    ///< short block size
96 #define AAC_NUM_BLOCKS_SHORT 8      ///< number of blocks in a short sequence
97 #define PSY_LAME_NUM_SUBBLOCKS 3    ///< Number of sub-blocks in each short block
98
99 /**
100  * @}
101  */
102
103 /**
104  * information for single band used by 3GPP TS26.403-inspired psychoacoustic model
105  */
106 typedef struct AacPsyBand{
107     float energy;       ///< band energy
108     float thr;          ///< energy threshold
109     float thr_quiet;    ///< threshold in quiet
110     float nz_lines;     ///< number of non-zero spectral lines
111     float active_lines; ///< number of active spectral lines
112     float pe;           ///< perceptual entropy
113     float pe_const;     ///< constant part of the PE calculation
114     float norm_fac;     ///< normalization factor for linearization
115     int   avoid_holes;  ///< hole avoidance flag
116 }AacPsyBand;
117
118 /**
119  * single/pair channel context for psychoacoustic model
120  */
121 typedef struct AacPsyChannel{
122     AacPsyBand band[128];               ///< bands information
123     AacPsyBand prev_band[128];          ///< bands information from the previous frame
124
125     float       win_energy;              ///< sliding average of channel energy
126     float       iir_state[2];            ///< hi-pass IIR filter state
127     uint8_t     next_grouping;           ///< stored grouping scheme for the next frame (in case of 8 short window sequence)
128     enum WindowSequence next_window_seq; ///< window sequence to be used in the next frame
129     /* LAME psy model specific members */
130     float attack_threshold;              ///< attack threshold for this channel
131     float prev_energy_subshort[AAC_NUM_BLOCKS_SHORT * PSY_LAME_NUM_SUBBLOCKS];
132     int   prev_attack;                   ///< attack value for the last short block in the previous sequence
133 }AacPsyChannel;
134
135 /**
136  * psychoacoustic model frame type-dependent coefficients
137  */
138 typedef struct AacPsyCoeffs{
139     float ath;           ///< absolute threshold of hearing per bands
140     float barks;         ///< Bark value for each spectral band in long frame
141     float spread_low[2]; ///< spreading factor for low-to-high threshold spreading in long frame
142     float spread_hi [2]; ///< spreading factor for high-to-low threshold spreading in long frame
143     float min_snr;       ///< minimal SNR
144 }AacPsyCoeffs;
145
146 /**
147  * 3GPP TS26.403-inspired psychoacoustic model specific data
148  */
149 typedef struct AacPsyContext{
150     int chan_bitrate;     ///< bitrate per channel
151     int frame_bits;       ///< average bits per frame
152     int fill_level;       ///< bit reservoir fill level
153     struct {
154         float min;        ///< minimum allowed PE for bit factor calculation
155         float max;        ///< maximum allowed PE for bit factor calculation
156         float previous;   ///< allowed PE of the previous frame
157         float correction; ///< PE correction factor
158     } pe;
159     AacPsyCoeffs psy_coef[2][64];
160     AacPsyChannel *ch;
161 }AacPsyContext;
162
163 /**
164  * LAME psy model preset struct
165  */
166 typedef struct PsyLamePreset {
167     int   quality;  ///< Quality to map the rest of the vaules to.
168      /* This is overloaded to be both kbps per channel in ABR mode, and
169       * requested quality in constant quality mode.
170       */
171     float st_lrm;   ///< short threshold for L, R, and M channels
172 } PsyLamePreset;
173
174 /**
175  * LAME psy model preset table for ABR
176  */
177 static const PsyLamePreset psy_abr_map[] = {
178 /* TODO: Tuning. These were taken from LAME. */
179 /* kbps/ch st_lrm   */
180     {  8,  6.60},
181     { 16,  6.60},
182     { 24,  6.60},
183     { 32,  6.60},
184     { 40,  6.60},
185     { 48,  6.60},
186     { 56,  6.60},
187     { 64,  6.40},
188     { 80,  6.00},
189     { 96,  5.60},
190     {112,  5.20},
191     {128,  5.20},
192     {160,  5.20}
193 };
194
195 /**
196 * LAME psy model preset table for constant quality
197 */
198 static const PsyLamePreset psy_vbr_map[] = {
199 /* vbr_q  st_lrm    */
200     { 0,  4.20},
201     { 1,  4.20},
202     { 2,  4.20},
203     { 3,  4.20},
204     { 4,  4.20},
205     { 5,  4.20},
206     { 6,  4.20},
207     { 7,  4.20},
208     { 8,  4.20},
209     { 9,  4.20},
210     {10,  4.20}
211 };
212
213 /**
214  * LAME psy model FIR coefficient table
215  */
216 static const float psy_fir_coeffs[] = {
217     -8.65163e-18 * 2, -0.00851586 * 2, -6.74764e-18 * 2, 0.0209036 * 2,
218     -3.36639e-17 * 2, -0.0438162 * 2,  -1.54175e-17 * 2, 0.0931738 * 2,
219     -5.52212e-17 * 2, -0.313819 * 2
220 };
221
222 #if ARCH_MIPS
223 #   include "mips/aacpsy_mips.h"
224 #endif /* ARCH_MIPS */
225
226 /**
227  * Calculate the ABR attack threshold from the above LAME psymodel table.
228  */
229 static float lame_calc_attack_threshold(int bitrate)
230 {
231     /* Assume max bitrate to start with */
232     int lower_range = 12, upper_range = 12;
233     int lower_range_kbps = psy_abr_map[12].quality;
234     int upper_range_kbps = psy_abr_map[12].quality;
235     int i;
236
237     /* Determine which bitrates the value specified falls between.
238      * If the loop ends without breaking our above assumption of 320kbps was correct.
239      */
240     for (i = 1; i < 13; i++) {
241         if (FFMAX(bitrate, psy_abr_map[i].quality) != bitrate) {
242             upper_range = i;
243             upper_range_kbps = psy_abr_map[i    ].quality;
244             lower_range = i - 1;
245             lower_range_kbps = psy_abr_map[i - 1].quality;
246             break; /* Upper range found */
247         }
248     }
249
250     /* Determine which range the value specified is closer to */
251     if ((upper_range_kbps - bitrate) > (bitrate - lower_range_kbps))
252         return psy_abr_map[lower_range].st_lrm;
253     return psy_abr_map[upper_range].st_lrm;
254 }
255
256 /**
257  * LAME psy model specific initialization
258  */
259 static av_cold void lame_window_init(AacPsyContext *ctx, AVCodecContext *avctx)
260 {
261     int i, j;
262
263     for (i = 0; i < avctx->channels; i++) {
264         AacPsyChannel *pch = &ctx->ch[i];
265
266         if (avctx->flags & AV_CODEC_FLAG_QSCALE)
267             pch->attack_threshold = psy_vbr_map[avctx->global_quality / FF_QP2LAMBDA].st_lrm;
268         else
269             pch->attack_threshold = lame_calc_attack_threshold(avctx->bit_rate / avctx->channels / 1000);
270
271         for (j = 0; j < AAC_NUM_BLOCKS_SHORT * PSY_LAME_NUM_SUBBLOCKS; j++)
272             pch->prev_energy_subshort[j] = 10.0f;
273     }
274 }
275
276 /**
277  * Calculate Bark value for given line.
278  */
279 static av_cold float calc_bark(float f)
280 {
281     return 13.3f * atanf(0.00076f * f) + 3.5f * atanf((f / 7500.0f) * (f / 7500.0f));
282 }
283
284 #define ATH_ADD 4
285 /**
286  * Calculate ATH value for given frequency.
287  * Borrowed from Lame.
288  */
289 static av_cold float ath(float f, float add)
290 {
291     f /= 1000.0f;
292     return    3.64 * pow(f, -0.8)
293             - 6.8  * exp(-0.6  * (f - 3.4) * (f - 3.4))
294             + 6.0  * exp(-0.15 * (f - 8.7) * (f - 8.7))
295             + (0.6 + 0.04 * add) * 0.001 * f * f * f * f;
296 }
297
298 static av_cold int psy_3gpp_init(FFPsyContext *ctx) {
299     AacPsyContext *pctx;
300     float bark;
301     int i, j, g, start;
302     float prev, minscale, minath, minsnr, pe_min;
303     const int chan_bitrate = ctx->avctx->bit_rate / ctx->avctx->channels;
304     const int bandwidth    = ctx->avctx->cutoff ? ctx->avctx->cutoff : AAC_CUTOFF(ctx->avctx);
305     const float num_bark   = calc_bark((float)bandwidth);
306
307     ctx->model_priv_data = av_mallocz(sizeof(AacPsyContext));
308     if (!ctx->model_priv_data)
309         return AVERROR(ENOMEM);
310     pctx = (AacPsyContext*) ctx->model_priv_data;
311
312     pctx->chan_bitrate = chan_bitrate;
313     pctx->frame_bits   = chan_bitrate * AAC_BLOCK_SIZE_LONG / ctx->avctx->sample_rate;
314     pctx->pe.min       =  8.0f * AAC_BLOCK_SIZE_LONG * bandwidth / (ctx->avctx->sample_rate * 2.0f);
315     pctx->pe.max       = 12.0f * AAC_BLOCK_SIZE_LONG * bandwidth / (ctx->avctx->sample_rate * 2.0f);
316     ctx->bitres.size   = 6144 - pctx->frame_bits;
317     ctx->bitres.size  -= ctx->bitres.size % 8;
318     pctx->fill_level   = ctx->bitres.size;
319     minath = ath(3410 - 0.733 * ATH_ADD, ATH_ADD);
320     for (j = 0; j < 2; j++) {
321         AacPsyCoeffs *coeffs = pctx->psy_coef[j];
322         const uint8_t *band_sizes = ctx->bands[j];
323         float line_to_frequency = ctx->avctx->sample_rate / (j ? 256.f : 2048.0f);
324         float avg_chan_bits = chan_bitrate * (j ? 128.0f : 1024.0f) / ctx->avctx->sample_rate;
325         /* reference encoder uses 2.4% here instead of 60% like the spec says */
326         float bark_pe = 0.024f * PSY_3GPP_BITS_TO_PE(avg_chan_bits) / num_bark;
327         float en_spread_low = j ? PSY_3GPP_EN_SPREAD_LOW_S : PSY_3GPP_EN_SPREAD_LOW_L;
328         /* High energy spreading for long blocks <= 22kbps/channel and short blocks are the same. */
329         float en_spread_hi  = (j || (chan_bitrate <= 22.0f)) ? PSY_3GPP_EN_SPREAD_HI_S : PSY_3GPP_EN_SPREAD_HI_L1;
330
331         i = 0;
332         prev = 0.0;
333         for (g = 0; g < ctx->num_bands[j]; g++) {
334             i += band_sizes[g];
335             bark = calc_bark((i-1) * line_to_frequency);
336             coeffs[g].barks = (bark + prev) / 2.0;
337             prev = bark;
338         }
339         for (g = 0; g < ctx->num_bands[j] - 1; g++) {
340             AacPsyCoeffs *coeff = &coeffs[g];
341             float bark_width = coeffs[g+1].barks - coeffs->barks;
342             coeff->spread_low[0] = pow(10.0, -bark_width * PSY_3GPP_THR_SPREAD_LOW);
343             coeff->spread_hi [0] = pow(10.0, -bark_width * PSY_3GPP_THR_SPREAD_HI);
344             coeff->spread_low[1] = pow(10.0, -bark_width * en_spread_low);
345             coeff->spread_hi [1] = pow(10.0, -bark_width * en_spread_hi);
346             pe_min = bark_pe * bark_width;
347             minsnr = exp2(pe_min / band_sizes[g]) - 1.5f;
348             coeff->min_snr = av_clipf(1.0f / minsnr, PSY_SNR_25DB, PSY_SNR_1DB);
349         }
350         start = 0;
351         for (g = 0; g < ctx->num_bands[j]; g++) {
352             minscale = ath(start * line_to_frequency, ATH_ADD);
353             for (i = 1; i < band_sizes[g]; i++)
354                 minscale = FFMIN(minscale, ath((start + i) * line_to_frequency, ATH_ADD));
355             coeffs[g].ath = minscale - minath;
356             start += band_sizes[g];
357         }
358     }
359
360     pctx->ch = av_mallocz_array(ctx->avctx->channels, sizeof(AacPsyChannel));
361     if (!pctx->ch) {
362         av_freep(&ctx->model_priv_data);
363         return AVERROR(ENOMEM);
364     }
365
366     lame_window_init(pctx, ctx->avctx);
367
368     return 0;
369 }
370
371 /**
372  * IIR filter used in block switching decision
373  */
374 static float iir_filter(int in, float state[2])
375 {
376     float ret;
377
378     ret = 0.7548f * (in - state[0]) + 0.5095f * state[1];
379     state[0] = in;
380     state[1] = ret;
381     return ret;
382 }
383
384 /**
385  * window grouping information stored as bits (0 - new group, 1 - group continues)
386  */
387 static const uint8_t window_grouping[9] = {
388     0xB6, 0x6C, 0xD8, 0xB2, 0x66, 0xC6, 0x96, 0x36, 0x36
389 };
390
391 /**
392  * Tell encoder which window types to use.
393  * @see 3GPP TS26.403 5.4.1 "Blockswitching"
394  */
395 static av_unused FFPsyWindowInfo psy_3gpp_window(FFPsyContext *ctx,
396                                                  const int16_t *audio,
397                                                  const int16_t *la,
398                                                  int channel, int prev_type)
399 {
400     int i, j;
401     int br               = ctx->avctx->bit_rate / ctx->avctx->channels;
402     int attack_ratio     = br <= 16000 ? 18 : 10;
403     AacPsyContext *pctx = (AacPsyContext*) ctx->model_priv_data;
404     AacPsyChannel *pch  = &pctx->ch[channel];
405     uint8_t grouping     = 0;
406     int next_type        = pch->next_window_seq;
407     FFPsyWindowInfo wi  = { { 0 } };
408
409     if (la) {
410         float s[8], v;
411         int switch_to_eight = 0;
412         float sum = 0.0, sum2 = 0.0;
413         int attack_n = 0;
414         int stay_short = 0;
415         for (i = 0; i < 8; i++) {
416             for (j = 0; j < 128; j++) {
417                 v = iir_filter(la[i*128+j], pch->iir_state);
418                 sum += v*v;
419             }
420             s[i]  = sum;
421             sum2 += sum;
422         }
423         for (i = 0; i < 8; i++) {
424             if (s[i] > pch->win_energy * attack_ratio) {
425                 attack_n        = i + 1;
426                 switch_to_eight = 1;
427                 break;
428             }
429         }
430         pch->win_energy = pch->win_energy*7/8 + sum2/64;
431
432         wi.window_type[1] = prev_type;
433         switch (prev_type) {
434         case ONLY_LONG_SEQUENCE:
435             wi.window_type[0] = switch_to_eight ? LONG_START_SEQUENCE : ONLY_LONG_SEQUENCE;
436             next_type = switch_to_eight ? EIGHT_SHORT_SEQUENCE : ONLY_LONG_SEQUENCE;
437             break;
438         case LONG_START_SEQUENCE:
439             wi.window_type[0] = EIGHT_SHORT_SEQUENCE;
440             grouping = pch->next_grouping;
441             next_type = switch_to_eight ? EIGHT_SHORT_SEQUENCE : LONG_STOP_SEQUENCE;
442             break;
443         case LONG_STOP_SEQUENCE:
444             wi.window_type[0] = switch_to_eight ? LONG_START_SEQUENCE : ONLY_LONG_SEQUENCE;
445             next_type = switch_to_eight ? EIGHT_SHORT_SEQUENCE : ONLY_LONG_SEQUENCE;
446             break;
447         case EIGHT_SHORT_SEQUENCE:
448             stay_short = next_type == EIGHT_SHORT_SEQUENCE || switch_to_eight;
449             wi.window_type[0] = stay_short ? EIGHT_SHORT_SEQUENCE : LONG_STOP_SEQUENCE;
450             grouping = next_type == EIGHT_SHORT_SEQUENCE ? pch->next_grouping : 0;
451             next_type = switch_to_eight ? EIGHT_SHORT_SEQUENCE : LONG_STOP_SEQUENCE;
452             break;
453         }
454
455         pch->next_grouping = window_grouping[attack_n];
456         pch->next_window_seq = next_type;
457     } else {
458         for (i = 0; i < 3; i++)
459             wi.window_type[i] = prev_type;
460         grouping = (prev_type == EIGHT_SHORT_SEQUENCE) ? window_grouping[0] : 0;
461     }
462
463     wi.window_shape   = 1;
464     if (wi.window_type[0] != EIGHT_SHORT_SEQUENCE) {
465         wi.num_windows = 1;
466         wi.grouping[0] = 1;
467     } else {
468         int lastgrp = 0;
469         wi.num_windows = 8;
470         for (i = 0; i < 8; i++) {
471             if (!((grouping >> i) & 1))
472                 lastgrp = i;
473             wi.grouping[lastgrp]++;
474         }
475     }
476
477     return wi;
478 }
479
480 /* 5.6.1.2 "Calculation of Bit Demand" */
481 static int calc_bit_demand(AacPsyContext *ctx, float pe, int bits, int size,
482                            int short_window)
483 {
484     const float bitsave_slope  = short_window ? PSY_3GPP_SAVE_SLOPE_S  : PSY_3GPP_SAVE_SLOPE_L;
485     const float bitsave_add    = short_window ? PSY_3GPP_SAVE_ADD_S    : PSY_3GPP_SAVE_ADD_L;
486     const float bitspend_slope = short_window ? PSY_3GPP_SPEND_SLOPE_S : PSY_3GPP_SPEND_SLOPE_L;
487     const float bitspend_add   = short_window ? PSY_3GPP_SPEND_ADD_S   : PSY_3GPP_SPEND_ADD_L;
488     const float clip_low       = short_window ? PSY_3GPP_CLIP_LO_S     : PSY_3GPP_CLIP_LO_L;
489     const float clip_high      = short_window ? PSY_3GPP_CLIP_HI_S     : PSY_3GPP_CLIP_HI_L;
490     float clipped_pe, bit_save, bit_spend, bit_factor, fill_level;
491
492     ctx->fill_level += ctx->frame_bits - bits;
493     ctx->fill_level  = av_clip(ctx->fill_level, 0, size);
494     fill_level = av_clipf((float)ctx->fill_level / size, clip_low, clip_high);
495     clipped_pe = av_clipf(pe, ctx->pe.min, ctx->pe.max);
496     bit_save   = (fill_level + bitsave_add) * bitsave_slope;
497     assert(bit_save <= 0.3f && bit_save >= -0.05000001f);
498     bit_spend  = (fill_level + bitspend_add) * bitspend_slope;
499     assert(bit_spend <= 0.5f && bit_spend >= -0.1f);
500     /* The bit factor graph in the spec is obviously incorrect.
501      *      bit_spend + ((bit_spend - bit_spend))...
502      * The reference encoder subtracts everything from 1, but also seems incorrect.
503      *      1 - bit_save + ((bit_spend + bit_save))...
504      * Hopefully below is correct.
505      */
506     bit_factor = 1.0f - bit_save + ((bit_spend - bit_save) / (ctx->pe.max - ctx->pe.min)) * (clipped_pe - ctx->pe.min);
507     /* NOTE: The reference encoder attempts to center pe max/min around the current pe. */
508     ctx->pe.max = FFMAX(pe, ctx->pe.max);
509     ctx->pe.min = FFMIN(pe, ctx->pe.min);
510
511     return FFMIN(ctx->frame_bits * bit_factor, ctx->frame_bits + size - bits);
512 }
513
514 static float calc_pe_3gpp(AacPsyBand *band)
515 {
516     float pe, a;
517
518     band->pe           = 0.0f;
519     band->pe_const     = 0.0f;
520     band->active_lines = 0.0f;
521     if (band->energy > band->thr) {
522         a  = log2f(band->energy);
523         pe = a - log2f(band->thr);
524         band->active_lines = band->nz_lines;
525         if (pe < PSY_3GPP_C1) {
526             pe = pe * PSY_3GPP_C3 + PSY_3GPP_C2;
527             a  = a  * PSY_3GPP_C3 + PSY_3GPP_C2;
528             band->active_lines *= PSY_3GPP_C3;
529         }
530         band->pe       = pe * band->nz_lines;
531         band->pe_const = a  * band->nz_lines;
532     }
533
534     return band->pe;
535 }
536
537 static float calc_reduction_3gpp(float a, float desired_pe, float pe,
538                                  float active_lines)
539 {
540     float thr_avg, reduction;
541
542     if(active_lines == 0.0)
543         return 0;
544
545     thr_avg   = exp2f((a - pe) / (4.0f * active_lines));
546     reduction = exp2f((a - desired_pe) / (4.0f * active_lines)) - thr_avg;
547
548     return FFMAX(reduction, 0.0f);
549 }
550
551 static float calc_reduced_thr_3gpp(AacPsyBand *band, float min_snr,
552                                    float reduction)
553 {
554     float thr = band->thr;
555
556     if (band->energy > thr) {
557         thr = sqrtf(thr);
558         thr = sqrtf(thr) + reduction;
559         thr *= thr;
560         thr *= thr;
561
562         /* This deviates from the 3GPP spec to match the reference encoder.
563          * It performs min(thr_reduced, max(thr, energy/min_snr)) only for bands
564          * that have hole avoidance on (active or inactive). It always reduces the
565          * threshold of bands with hole avoidance off.
566          */
567         if (thr > band->energy * min_snr && band->avoid_holes != PSY_3GPP_AH_NONE) {
568             thr = FFMAX(band->thr, band->energy * min_snr);
569             band->avoid_holes = PSY_3GPP_AH_ACTIVE;
570         }
571     }
572
573     return thr;
574 }
575
576 #ifndef calc_thr_3gpp
577 static void calc_thr_3gpp(const FFPsyWindowInfo *wi, const int num_bands, AacPsyChannel *pch,
578                           const uint8_t *band_sizes, const float *coefs)
579 {
580     int i, w, g;
581     int start = 0;
582     for (w = 0; w < wi->num_windows*16; w += 16) {
583         for (g = 0; g < num_bands; g++) {
584             AacPsyBand *band = &pch->band[w+g];
585
586             float form_factor = 0.0f;
587             float Temp;
588             band->energy = 0.0f;
589             for (i = 0; i < band_sizes[g]; i++) {
590                 band->energy += coefs[start+i] * coefs[start+i];
591                 form_factor  += sqrtf(fabs(coefs[start+i]));
592             }
593             Temp = band->energy > 0 ? sqrtf((float)band_sizes[g] / band->energy) : 0;
594             band->thr      = band->energy * 0.001258925f;
595             band->nz_lines = form_factor * sqrtf(Temp);
596
597             start += band_sizes[g];
598         }
599     }
600 }
601 #endif /* calc_thr_3gpp */
602
603 #ifndef psy_hp_filter
604 static void psy_hp_filter(const float *firbuf, float *hpfsmpl, const float *psy_fir_coeffs)
605 {
606     int i, j;
607     for (i = 0; i < AAC_BLOCK_SIZE_LONG; i++) {
608         float sum1, sum2;
609         sum1 = firbuf[i + (PSY_LAME_FIR_LEN - 1) / 2];
610         sum2 = 0.0;
611         for (j = 0; j < ((PSY_LAME_FIR_LEN - 1) / 2) - 1; j += 2) {
612             sum1 += psy_fir_coeffs[j] * (firbuf[i + j] + firbuf[i + PSY_LAME_FIR_LEN - j]);
613             sum2 += psy_fir_coeffs[j + 1] * (firbuf[i + j + 1] + firbuf[i + PSY_LAME_FIR_LEN - j - 1]);
614         }
615         /* NOTE: The LAME psymodel expects it's input in the range -32768 to 32768.
616          *       Tuning this for normalized floats would be difficult. */
617         hpfsmpl[i] = (sum1 + sum2) * 32768.0f;
618     }
619 }
620 #endif /* psy_hp_filter */
621
622 /**
623  * Calculate band thresholds as suggested in 3GPP TS26.403
624  */
625 static void psy_3gpp_analyze_channel(FFPsyContext *ctx, int channel,
626                                      const float *coefs, const FFPsyWindowInfo *wi)
627 {
628     AacPsyContext *pctx = (AacPsyContext*) ctx->model_priv_data;
629     AacPsyChannel *pch  = &pctx->ch[channel];
630     int i, w, g;
631     float desired_bits, desired_pe, delta_pe, reduction= NAN, spread_en[128] = {0};
632     float a = 0.0f, active_lines = 0.0f, norm_fac = 0.0f;
633     float pe = pctx->chan_bitrate > 32000 ? 0.0f : FFMAX(50.0f, 100.0f - pctx->chan_bitrate * 100.0f / 32000.0f);
634     const int      num_bands   = ctx->num_bands[wi->num_windows == 8];
635     const uint8_t *band_sizes  = ctx->bands[wi->num_windows == 8];
636     AacPsyCoeffs  *coeffs      = pctx->psy_coef[wi->num_windows == 8];
637     const float avoid_hole_thr = wi->num_windows == 8 ? PSY_3GPP_AH_THR_SHORT : PSY_3GPP_AH_THR_LONG;
638
639     //calculate energies, initial thresholds and related values - 5.4.2 "Threshold Calculation"
640     calc_thr_3gpp(wi, num_bands, pch, band_sizes, coefs);
641
642     //modify thresholds and energies - spread, threshold in quiet, pre-echo control
643     for (w = 0; w < wi->num_windows*16; w += 16) {
644         AacPsyBand *bands = &pch->band[w];
645
646         /* 5.4.2.3 "Spreading" & 5.4.3 "Spread Energy Calculation" */
647         spread_en[0] = bands[0].energy;
648         for (g = 1; g < num_bands; g++) {
649             bands[g].thr   = FFMAX(bands[g].thr,    bands[g-1].thr * coeffs[g].spread_hi[0]);
650             spread_en[w+g] = FFMAX(bands[g].energy, spread_en[w+g-1] * coeffs[g].spread_hi[1]);
651         }
652         for (g = num_bands - 2; g >= 0; g--) {
653             bands[g].thr   = FFMAX(bands[g].thr,   bands[g+1].thr * coeffs[g].spread_low[0]);
654             spread_en[w+g] = FFMAX(spread_en[w+g], spread_en[w+g+1] * coeffs[g].spread_low[1]);
655         }
656         //5.4.2.4 "Threshold in quiet"
657         for (g = 0; g < num_bands; g++) {
658             AacPsyBand *band = &bands[g];
659
660             band->thr_quiet = band->thr = FFMAX(band->thr, coeffs[g].ath);
661             //5.4.2.5 "Pre-echo control"
662             if (!(wi->window_type[0] == LONG_STOP_SEQUENCE || (wi->window_type[1] == LONG_START_SEQUENCE && !w)))
663                 band->thr = FFMAX(PSY_3GPP_RPEMIN*band->thr, FFMIN(band->thr,
664                                   PSY_3GPP_RPELEV*pch->prev_band[w+g].thr_quiet));
665
666             /* 5.6.1.3.1 "Preparatory steps of the perceptual entropy calculation" */
667             pe += calc_pe_3gpp(band);
668             a  += band->pe_const;
669             active_lines += band->active_lines;
670
671             /* 5.6.1.3.3 "Selection of the bands for avoidance of holes" */
672             if (spread_en[w+g] * avoid_hole_thr > band->energy || coeffs[g].min_snr > 1.0f)
673                 band->avoid_holes = PSY_3GPP_AH_NONE;
674             else
675                 band->avoid_holes = PSY_3GPP_AH_INACTIVE;
676         }
677     }
678
679     /* 5.6.1.3.2 "Calculation of the desired perceptual entropy" */
680     ctx->ch[channel].entropy = pe;
681     desired_bits = calc_bit_demand(pctx, pe, ctx->bitres.bits, ctx->bitres.size, wi->num_windows == 8);
682     desired_pe = PSY_3GPP_BITS_TO_PE(desired_bits);
683     /* NOTE: PE correction is kept simple. During initial testing it had very
684      *       little effect on the final bitrate. Probably a good idea to come
685      *       back and do more testing later.
686      */
687     if (ctx->bitres.bits > 0)
688         desired_pe *= av_clipf(pctx->pe.previous / PSY_3GPP_BITS_TO_PE(ctx->bitres.bits),
689                                0.85f, 1.15f);
690     pctx->pe.previous = PSY_3GPP_BITS_TO_PE(desired_bits);
691     ctx->bitres.alloc = desired_bits;
692
693     if (desired_pe < pe) {
694         /* 5.6.1.3.4 "First Estimation of the reduction value" */
695         for (w = 0; w < wi->num_windows*16; w += 16) {
696             reduction = calc_reduction_3gpp(a, desired_pe, pe, active_lines);
697             pe = 0.0f;
698             a  = 0.0f;
699             active_lines = 0.0f;
700             for (g = 0; g < num_bands; g++) {
701                 AacPsyBand *band = &pch->band[w+g];
702
703                 band->thr = calc_reduced_thr_3gpp(band, coeffs[g].min_snr, reduction);
704                 /* recalculate PE */
705                 pe += calc_pe_3gpp(band);
706                 a  += band->pe_const;
707                 active_lines += band->active_lines;
708             }
709         }
710
711         /* 5.6.1.3.5 "Second Estimation of the reduction value" */
712         for (i = 0; i < 2; i++) {
713             float pe_no_ah = 0.0f, desired_pe_no_ah;
714             active_lines = a = 0.0f;
715             for (w = 0; w < wi->num_windows*16; w += 16) {
716                 for (g = 0; g < num_bands; g++) {
717                     AacPsyBand *band = &pch->band[w+g];
718
719                     if (band->avoid_holes != PSY_3GPP_AH_ACTIVE) {
720                         pe_no_ah += band->pe;
721                         a        += band->pe_const;
722                         active_lines += band->active_lines;
723                     }
724                 }
725             }
726             desired_pe_no_ah = FFMAX(desired_pe - (pe - pe_no_ah), 0.0f);
727             if (active_lines > 0.0f)
728                 reduction = calc_reduction_3gpp(a, desired_pe_no_ah, pe_no_ah, active_lines);
729
730             pe = 0.0f;
731             for (w = 0; w < wi->num_windows*16; w += 16) {
732                 for (g = 0; g < num_bands; g++) {
733                     AacPsyBand *band = &pch->band[w+g];
734
735                     if (active_lines > 0.0f)
736                         band->thr = calc_reduced_thr_3gpp(band, coeffs[g].min_snr, reduction);
737                     pe += calc_pe_3gpp(band);
738                     if (band->thr > 0.0f)
739                         band->norm_fac = band->active_lines / band->thr;
740                     else
741                         band->norm_fac = 0.0f;
742                     norm_fac += band->norm_fac;
743                 }
744             }
745             delta_pe = desired_pe - pe;
746             if (fabs(delta_pe) > 0.05f * desired_pe)
747                 break;
748         }
749
750         if (pe < 1.15f * desired_pe) {
751             /* 6.6.1.3.6 "Final threshold modification by linearization" */
752             norm_fac = 1.0f / norm_fac;
753             for (w = 0; w < wi->num_windows*16; w += 16) {
754                 for (g = 0; g < num_bands; g++) {
755                     AacPsyBand *band = &pch->band[w+g];
756
757                     if (band->active_lines > 0.5f) {
758                         float delta_sfb_pe = band->norm_fac * norm_fac * delta_pe;
759                         float thr = band->thr;
760
761                         thr *= exp2f(delta_sfb_pe / band->active_lines);
762                         if (thr > coeffs[g].min_snr * band->energy && band->avoid_holes == PSY_3GPP_AH_INACTIVE)
763                             thr = FFMAX(band->thr, coeffs[g].min_snr * band->energy);
764                         band->thr = thr;
765                     }
766                 }
767             }
768         } else {
769             /* 5.6.1.3.7 "Further perceptual entropy reduction" */
770             g = num_bands;
771             while (pe > desired_pe && g--) {
772                 for (w = 0; w < wi->num_windows*16; w+= 16) {
773                     AacPsyBand *band = &pch->band[w+g];
774                     if (band->avoid_holes != PSY_3GPP_AH_NONE && coeffs[g].min_snr < PSY_SNR_1DB) {
775                         coeffs[g].min_snr = PSY_SNR_1DB;
776                         band->thr = band->energy * PSY_SNR_1DB;
777                         pe += band->active_lines * 1.5f - band->pe;
778                     }
779                 }
780             }
781             /* TODO: allow more holes (unused without mid/side) */
782         }
783     }
784
785     for (w = 0; w < wi->num_windows*16; w += 16) {
786         for (g = 0; g < num_bands; g++) {
787             AacPsyBand *band     = &pch->band[w+g];
788             FFPsyBand  *psy_band = &ctx->ch[channel].psy_bands[w+g];
789
790             psy_band->threshold = band->thr;
791             psy_band->energy    = band->energy;
792             psy_band->spread    = band->active_lines * 2.0f / band_sizes[g];
793             psy_band->bits      = PSY_3GPP_PE_TO_BITS(band->pe);
794         }
795     }
796
797     memcpy(pch->prev_band, pch->band, sizeof(pch->band));
798 }
799
800 static void psy_3gpp_analyze(FFPsyContext *ctx, int channel,
801                                    const float **coeffs, const FFPsyWindowInfo *wi)
802 {
803     int ch;
804     FFPsyChannelGroup *group = ff_psy_find_group(ctx, channel);
805
806     for (ch = 0; ch < group->num_ch; ch++)
807         psy_3gpp_analyze_channel(ctx, channel + ch, coeffs[ch], &wi[ch]);
808 }
809
810 static av_cold void psy_3gpp_end(FFPsyContext *apc)
811 {
812     AacPsyContext *pctx = (AacPsyContext*) apc->model_priv_data;
813     av_freep(&pctx->ch);
814     av_freep(&apc->model_priv_data);
815 }
816
817 static void lame_apply_block_type(AacPsyChannel *ctx, FFPsyWindowInfo *wi, int uselongblock)
818 {
819     int blocktype = ONLY_LONG_SEQUENCE;
820     if (uselongblock) {
821         if (ctx->next_window_seq == EIGHT_SHORT_SEQUENCE)
822             blocktype = LONG_STOP_SEQUENCE;
823     } else {
824         blocktype = EIGHT_SHORT_SEQUENCE;
825         if (ctx->next_window_seq == ONLY_LONG_SEQUENCE)
826             ctx->next_window_seq = LONG_START_SEQUENCE;
827         if (ctx->next_window_seq == LONG_STOP_SEQUENCE)
828             ctx->next_window_seq = EIGHT_SHORT_SEQUENCE;
829     }
830
831     wi->window_type[0] = ctx->next_window_seq;
832     ctx->next_window_seq = blocktype;
833 }
834
835 static FFPsyWindowInfo psy_lame_window(FFPsyContext *ctx, const float *audio,
836                                        const float *la, int channel, int prev_type)
837 {
838     AacPsyContext *pctx = (AacPsyContext*) ctx->model_priv_data;
839     AacPsyChannel *pch  = &pctx->ch[channel];
840     int grouping     = 0;
841     int uselongblock = 1;
842     int attacks[AAC_NUM_BLOCKS_SHORT + 1] = { 0 };
843     float clippings[AAC_NUM_BLOCKS_SHORT];
844     int i;
845     FFPsyWindowInfo wi = { { 0 } };
846
847     if (la) {
848         float hpfsmpl[AAC_BLOCK_SIZE_LONG];
849         float const *pf = hpfsmpl;
850         float attack_intensity[(AAC_NUM_BLOCKS_SHORT + 1) * PSY_LAME_NUM_SUBBLOCKS];
851         float energy_subshort[(AAC_NUM_BLOCKS_SHORT + 1) * PSY_LAME_NUM_SUBBLOCKS];
852         float energy_short[AAC_NUM_BLOCKS_SHORT + 1] = { 0 };
853         const float *firbuf = la + (AAC_BLOCK_SIZE_SHORT/4 - PSY_LAME_FIR_LEN);
854         int att_sum = 0;
855
856         /* LAME comment: apply high pass filter of fs/4 */
857         psy_hp_filter(firbuf, hpfsmpl, psy_fir_coeffs);
858
859         /* Calculate the energies of each sub-shortblock */
860         for (i = 0; i < PSY_LAME_NUM_SUBBLOCKS; i++) {
861             energy_subshort[i] = pch->prev_energy_subshort[i + ((AAC_NUM_BLOCKS_SHORT - 1) * PSY_LAME_NUM_SUBBLOCKS)];
862             assert(pch->prev_energy_subshort[i + ((AAC_NUM_BLOCKS_SHORT - 2) * PSY_LAME_NUM_SUBBLOCKS + 1)] > 0);
863             attack_intensity[i] = energy_subshort[i] / pch->prev_energy_subshort[i + ((AAC_NUM_BLOCKS_SHORT - 2) * PSY_LAME_NUM_SUBBLOCKS + 1)];
864             energy_short[0] += energy_subshort[i];
865         }
866
867         for (i = 0; i < AAC_NUM_BLOCKS_SHORT * PSY_LAME_NUM_SUBBLOCKS; i++) {
868             float const *const pfe = pf + AAC_BLOCK_SIZE_LONG / (AAC_NUM_BLOCKS_SHORT * PSY_LAME_NUM_SUBBLOCKS);
869             float p = 1.0f;
870             for (; pf < pfe; pf++)
871                 p = FFMAX(p, fabsf(*pf));
872             pch->prev_energy_subshort[i] = energy_subshort[i + PSY_LAME_NUM_SUBBLOCKS] = p;
873             energy_short[1 + i / PSY_LAME_NUM_SUBBLOCKS] += p;
874             /* NOTE: The indexes below are [i + 3 - 2] in the LAME source.
875              *       Obviously the 3 and 2 have some significance, or this would be just [i + 1]
876              *       (which is what we use here). What the 3 stands for is ambiguous, as it is both
877              *       number of short blocks, and the number of sub-short blocks.
878              *       It seems that LAME is comparing each sub-block to sub-block + 1 in the
879              *       previous block.
880              */
881             if (p > energy_subshort[i + 1])
882                 p = p / energy_subshort[i + 1];
883             else if (energy_subshort[i + 1] > p * 10.0f)
884                 p = energy_subshort[i + 1] / (p * 10.0f);
885             else
886                 p = 0.0;
887             attack_intensity[i + PSY_LAME_NUM_SUBBLOCKS] = p;
888         }
889
890         /* compare energy between sub-short blocks */
891         for (i = 0; i < (AAC_NUM_BLOCKS_SHORT + 1) * PSY_LAME_NUM_SUBBLOCKS; i++)
892             if (!attacks[i / PSY_LAME_NUM_SUBBLOCKS])
893                 if (attack_intensity[i] > pch->attack_threshold)
894                     attacks[i / PSY_LAME_NUM_SUBBLOCKS] = (i % PSY_LAME_NUM_SUBBLOCKS) + 1;
895
896         /* should have energy change between short blocks, in order to avoid periodic signals */
897         /* Good samples to show the effect are Trumpet test songs */
898         /* GB: tuned (1) to avoid too many short blocks for test sample TRUMPET */
899         /* RH: tuned (2) to let enough short blocks through for test sample FSOL and SNAPS */
900         for (i = 1; i < AAC_NUM_BLOCKS_SHORT + 1; i++) {
901             float const u = energy_short[i - 1];
902             float const v = energy_short[i];
903             float const m = FFMAX(u, v);
904             if (m < 40000) {                          /* (2) */
905                 if (u < 1.7f * v && v < 1.7f * u) {   /* (1) */
906                     if (i == 1 && attacks[0] < attacks[i])
907                         attacks[0] = 0;
908                     attacks[i] = 0;
909                 }
910             }
911             att_sum += attacks[i];
912         }
913
914         if (attacks[0] <= pch->prev_attack)
915             attacks[0] = 0;
916
917         att_sum += attacks[0];
918         /* 3 below indicates the previous attack happened in the last sub-block of the previous sequence */
919         if (pch->prev_attack == 3 || att_sum) {
920             uselongblock = 0;
921
922             for (i = 1; i < AAC_NUM_BLOCKS_SHORT + 1; i++)
923                 if (attacks[i] && attacks[i-1])
924                     attacks[i] = 0;
925         }
926     } else {
927         /* We have no lookahead info, so just use same type as the previous sequence. */
928         uselongblock = !(prev_type == EIGHT_SHORT_SEQUENCE);
929     }
930
931     lame_apply_block_type(pch, &wi, uselongblock);
932
933     /* Calculate input sample maximums and evaluate clipping risk */
934     if (audio) {
935         for (i = 0; i < AAC_NUM_BLOCKS_SHORT; i++) {
936             const float *wbuf = audio + i * AAC_BLOCK_SIZE_SHORT;
937             float max = 0;
938             int j;
939             for (j = 0; j < AAC_BLOCK_SIZE_SHORT; j++)
940                 max = FFMAX(max, fabsf(wbuf[j]));
941             clippings[i] = max;
942         }
943     } else {
944         for (i = 0; i < 8; i++)
945             clippings[i] = 0;
946     }
947
948     wi.window_type[1] = prev_type;
949     if (wi.window_type[0] != EIGHT_SHORT_SEQUENCE) {
950         float clipping = 0.0f;
951
952         wi.num_windows  = 1;
953         wi.grouping[0]  = 1;
954         if (wi.window_type[0] == LONG_START_SEQUENCE)
955             wi.window_shape = 0;
956         else
957             wi.window_shape = 1;
958
959         for (i = 0; i < 8; i++)
960             clipping = FFMAX(clipping, clippings[i]);
961         wi.clipping[0] = clipping;
962     } else {
963         int lastgrp = 0;
964
965         wi.num_windows = 8;
966         wi.window_shape = 0;
967         for (i = 0; i < 8; i++) {
968             if (!((pch->next_grouping >> i) & 1))
969                 lastgrp = i;
970             wi.grouping[lastgrp]++;
971         }
972
973         for (i = 0; i < 8; i += wi.grouping[i]) {
974             int w;
975             float clipping = 0.0f;
976             for (w = 0; w < wi.grouping[i] && !clipping; w++)
977                 clipping = FFMAX(clipping, clippings[i+w]);
978             wi.clipping[i] = clipping;
979         }
980     }
981
982     /* Determine grouping, based on the location of the first attack, and save for
983      * the next frame.
984      * FIXME: Move this to analysis.
985      * TODO: Tune groupings depending on attack location
986      * TODO: Handle more than one attack in a group
987      */
988     for (i = 0; i < 9; i++) {
989         if (attacks[i]) {
990             grouping = i;
991             break;
992         }
993     }
994     pch->next_grouping = window_grouping[grouping];
995
996     pch->prev_attack = attacks[8];
997
998     return wi;
999 }
1000
1001 const FFPsyModel ff_aac_psy_model =
1002 {
1003     .name    = "3GPP TS 26.403-inspired model",
1004     .init    = psy_3gpp_init,
1005     .window  = psy_lame_window,
1006     .analyze = psy_3gpp_analyze,
1007     .end     = psy_3gpp_end,
1008 };