libavcodec/ac3.h

   1 /*
   2  * Common code between AC3 encoder and decoder
   3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard.
   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 ac3.h
  24  * Common code between AC3 encoder and decoder.
  25  */
  26
  27 #ifndef FFMPEG_AC3_H
  28 #define FFMPEG_AC3_H
  29
  30 #include "ac3tab.h"
  31
  32 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
  33 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
  34
  35 #define NB_BLOCKS 6 /* number of PCM blocks inside an AC3 frame */
  36 #define AC3_FRAME_SIZE (NB_BLOCKS * 256)
  37
  38 /* exponent encoding strategy */
  39 #define EXP_REUSE 0
  40 #define EXP_NEW   1
  41
  42 #define EXP_D15   1
  43 #define EXP_D25   2
  44 #define EXP_D45   3
  45
  46 /** Delta bit allocation strategy */
  47 typedef enum {
  48     DBA_REUSE = 0,
  49     DBA_NEW,
  50     DBA_NONE,
  51     DBA_RESERVED
  52 } AC3DeltaStrategy;
  53
  54 /** Channel mode (audio coding mode) */
  55 typedef enum {
  56     AC3_ACMOD_DUALMONO = 0,
  57     AC3_ACMOD_MONO,
  58     AC3_ACMOD_STEREO,
  59     AC3_ACMOD_3F,
  60     AC3_ACMOD_2F1R,
  61     AC3_ACMOD_3F1R,
  62     AC3_ACMOD_2F2R,
  63     AC3_ACMOD_3F2R
  64 } AC3ChannelMode;
  65
  66 typedef struct AC3BitAllocParameters {
  67     int fscod; /* frequency */
  68     int halfratecod;
  69     int sgain, sdecay, fdecay, dbknee, floor;
  70     int cplfleak, cplsleak;
  71 } AC3BitAllocParameters;
  72
  73 /**
  74  * @struct AC3HeaderInfo
  75  * Coded AC-3 header values up to the lfeon element, plus derived values.
  76  */
  77 typedef struct {
  78     /** @defgroup coded Coded elements
  79      * @{
  80      */
  81     uint16_t sync_word;
  82     uint16_t crc1;
  83     uint8_t fscod;
  84     uint8_t frmsizecod;
  85     uint8_t bsid;
  86     uint8_t bsmod;
  87     uint8_t acmod;
  88     uint8_t cmixlev;
  89     uint8_t surmixlev;
  90     uint8_t dsurmod;
  91     uint8_t lfeon;
  92     /** @} */
  93
  94     /** @defgroup derived Derived values
  95      * @{
  96      */
  97     uint8_t halfratecod;
  98     uint16_t sample_rate;
  99     uint32_t bit_rate;
 100     uint8_t channels;
 101     uint16_t frame_size;
 102     /** @} */
 103 } AC3HeaderInfo;
 104
 105
 106 void ac3_common_init(void);
 107
 108 /**
 109  * Calculates the log power-spectral density of the input signal.
 110  * This gives a rough estimate of signal power in the frequency domain by using
 111  * the spectral envelope (exponents).  The psd is also separately grouped
 112  * into critical bands for use in the calculating the masking curve.
 113  * 128 units in psd = -6 dB.  The dbknee parameter in AC3BitAllocParameters
 114  * determines the reference level.
 115  *
 116  * @param[in]  exp        frequency coefficient exponents
 117  * @param[in]  start      starting bin location
 118  * @param[in]  end        ending bin location
 119  * @param[out] psd        signal power for each frequency bin
 120  * @param[out] bndpsd     signal power for each critical band
 121  */
 122 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
 123                                int16_t *bndpsd);
 124
 125 /**
 126  * Calculates the masking curve.
 127  * First, the excitation is calculated using parameters in \p s and the signal
 128  * power in each critical band.  The excitation is compared with a predefined
 129  * hearing threshold table to produce the masking curve.  If delta bit
 130  * allocation information is provided, it is used for adjusting the masking
 131  * curve, usually to give a closer match to a better psychoacoustic model.
 132  *
 133  * @param[in]  s          adjustable bit allocation parameters
 134  * @param[in]  bndpsd     signal power for each critical band
 135  * @param[in]  start      starting bin location
 136  * @param[in]  end        ending bin location
 137  * @param[in]  fgain      fast gain (estimated signal-to-mask ratio)
 138  * @param[in]  is_lfe     whether or not the channel being processed is the LFE
 139  * @param[in]  deltbae    delta bit allocation exists (none, reuse, or new)
 140  * @param[in]  deltnseg   number of delta segments
 141  * @param[in]  deltoffst  location offsets for each segment
 142  * @param[in]  deltlen    length of each segment
 143  * @param[in]  deltba     delta bit allocation for each segment
 144  * @param[out] mask       calculated masking curve
 145  */
 146 void ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *bndpsd,
 147                                 int start, int end, int fgain, int is_lfe,
 148                                 int deltbae, int deltnseg, uint8_t *deltoffst,
 149                                 uint8_t *deltlen, uint8_t *deltba,
 150                                 int16_t *mask);
 151
 152 /**
 153  * Calculates bit allocation pointers.
 154  * The SNR is the difference between the masking curve and the signal.  AC-3
 155  * uses this value for each frequency bin to allocate bits.  The \p snroffset
 156  * parameter is a global adjustment to the SNR for all bins.
 157  *
 158  * @param[in]  mask       masking curve
 159  * @param[in]  psd        signal power for each frequency bin
 160  * @param[in]  start      starting bin location
 161  * @param[in]  end        ending bin location
 162  * @param[in]  snroffset  SNR adjustment
 163  * @param[in]  floor      noise floor
 164  * @param[out] bap        bit allocation pointers
 165  */
 166 void ff_ac3_bit_alloc_calc_bap(int16_t *mask, int16_t *psd, int start, int end,
 167                                int snroffset, int floor, uint8_t *bap);
 168
 169 void ac3_parametric_bit_allocation(AC3BitAllocParameters *s, uint8_t *bap,
 170                                    int8_t *exp, int start, int end,
 171                                    int snroffset, int fgain, int is_lfe,
 172                                    int deltbae,int deltnseg,
 173                                    uint8_t *deltoffst, uint8_t *deltlen, uint8_t *deltba);
 174
 175 #endif /* FFMPEG_AC3_H */