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