git.sesse.net Git - ffmpeg/blob - libavcodec/ac3.h

   1 /*
   2  * Common code between the AC-3 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
  24  * Common code between the AC-3 encoder and decoder.
  25  */
  26
  27 #ifndef AVCODEC_AC3_H
  28 #define AVCODEC_AC3_H
  29
  30 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
  31 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
  32
  33 #define AC3_MAX_COEFS   256
  34 #define AC3_BLOCK_SIZE  256
  35 #define AC3_MAX_BLOCKS    6
  36 #define AC3_FRAME_SIZE (AC3_MAX_BLOCKS * 256)
  37 #define AC3_WINDOW_SIZE (AC3_BLOCK_SIZE * 2)
  38 #define AC3_CRITICAL_BANDS 50
  39
  40 #include "ac3tab.h"
  41
  42 /* exponent encoding strategy */
  43 #define EXP_REUSE 0
  44 #define EXP_NEW   1
  45
  46 #define EXP_D15   1
  47 #define EXP_D25   2
  48 #define EXP_D45   3
  49
  50 /** Delta bit allocation strategy */
  51 typedef enum {
  52     DBA_REUSE = 0,
  53     DBA_NEW,
  54     DBA_NONE,
  55     DBA_RESERVED
  56 } AC3DeltaStrategy;
  57
  58 /** Channel mode (audio coding mode) */
  59 typedef enum {
  60     AC3_CHMODE_DUALMONO = 0,
  61     AC3_CHMODE_MONO,
  62     AC3_CHMODE_STEREO,
  63     AC3_CHMODE_3F,
  64     AC3_CHMODE_2F1R,
  65     AC3_CHMODE_3F1R,
  66     AC3_CHMODE_2F2R,
  67     AC3_CHMODE_3F2R
  68 } AC3ChannelMode;
  69
  70 typedef struct AC3BitAllocParameters {
  71     int sr_code;
  72     int sr_shift;
  73     int slow_gain, slow_decay, fast_decay, db_per_bit, floor;
  74     int cpl_fast_leak, cpl_slow_leak;
  75 } AC3BitAllocParameters;
  76
  77 /**
  78  * @struct AC3HeaderInfo
  79  * Coded AC-3 header values up to the lfeon element, plus derived values.
  80  */
  81 typedef struct {
  82     /** @defgroup coded Coded elements
  83      * @{
  84      */
  85     uint16_t sync_word;
  86     uint16_t crc1;
  87     uint8_t sr_code;
  88     uint8_t bitstream_id;
  89     uint8_t channel_mode;
  90     uint8_t lfe_on;
  91     uint8_t frame_type;
  92     int substreamid;                        ///< substream identification
  93     int center_mix_level;                   ///< Center mix level index
  94     int surround_mix_level;                 ///< Surround mix level index
  95     uint16_t channel_map;
  96     int num_blocks;                         ///< number of audio blocks
  97     /** @} */
  98
  99     /** @defgroup derived Derived values
 100      * @{
 101      */
 102     uint8_t sr_shift;
 103     uint16_t sample_rate;
 104     uint32_t bit_rate;
 105     uint8_t channels;
 106     uint16_t frame_size;
 107     int64_t channel_layout;
 108     /** @} */
 109 } AC3HeaderInfo;
 110
 111 typedef enum {
 112     EAC3_FRAME_TYPE_INDEPENDENT = 0,
 113     EAC3_FRAME_TYPE_DEPENDENT,
 114     EAC3_FRAME_TYPE_AC3_CONVERT,
 115     EAC3_FRAME_TYPE_RESERVED
 116 } EAC3FrameType;
 117
 118 void ac3_common_init(void);
 119
 120 /**
 121  * Calculate the log power-spectral density of the input signal.
 122  * This gives a rough estimate of signal power in the frequency domain by using
 123  * the spectral envelope (exponents).  The psd is also separately grouped
 124  * into critical bands for use in the calculating the masking curve.
 125  * 128 units in psd = -6 dB.  The dbknee parameter in AC3BitAllocParameters
 126  * determines the reference level.
 127  *
 128  * @param[in]  exp        frequency coefficient exponents
 129  * @param[in]  start      starting bin location
 130  * @param[in]  end        ending bin location
 131  * @param[out] psd        signal power for each frequency bin
 132  * @param[out] band_psd   signal power for each critical band
 133  */
 134 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
 135                                int16_t *band_psd);
 136
 137 /**
 138  * Calculate the masking curve.
 139  * First, the excitation is calculated using parameters in s and the signal
 140  * power in each critical band.  The excitation is compared with a predefined
 141  * hearing threshold table to produce the masking curve.  If delta bit
 142  * allocation information is provided, it is used for adjusting the masking
 143  * curve, usually to give a closer match to a better psychoacoustic model.
 144  *
 145  * @param[in]  s            adjustable bit allocation parameters
 146  * @param[in]  band_psd     signal power for each critical band
 147  * @param[in]  start        starting bin location
 148  * @param[in]  end          ending bin location
 149  * @param[in]  fast_gain    fast gain (estimated signal-to-mask ratio)
 150  * @param[in]  is_lfe       whether or not the channel being processed is the LFE
 151  * @param[in]  dba_mode     delta bit allocation mode (none, reuse, or new)
 152  * @param[in]  dba_nsegs    number of delta segments
 153  * @param[in]  dba_offsets  location offsets for each segment
 154  * @param[in]  dba_lengths  length of each segment
 155  * @param[in]  dba_values   delta bit allocation for each segment
 156  * @param[out] mask         calculated masking curve
 157  * @return returns 0 for success, non-zero for error
 158  */
 159 int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
 160                                int start, int end, int fast_gain, int is_lfe,
 161                                int dba_mode, int dba_nsegs, uint8_t *dba_offsets,
 162                                uint8_t *dba_lengths, uint8_t *dba_values,
 163                                int16_t *mask);
 164
 165 /**
 166  * Calculate bit allocation pointers.
 167  * The SNR is the difference between the masking curve and the signal.  AC-3
 168  * uses this value for each frequency bin to allocate bits.  The snroffset
 169  * parameter is a global adjustment to the SNR for all bins.
 170  *
 171  * @param[in]  mask       masking curve
 172  * @param[in]  psd        signal power for each frequency bin
 173  * @param[in]  start      starting bin location
 174  * @param[in]  end        ending bin location
 175  * @param[in]  snr_offset SNR adjustment
 176  * @param[in]  floor      noise floor
 177  * @param[in]  bap_tab    look-up table for bit allocation pointers
 178  * @param[out] bap        bit allocation pointers
 179  */
 180 void ff_ac3_bit_alloc_calc_bap(int16_t *mask, int16_t *psd, int start, int end,
 181                                int snr_offset, int floor,
 182                                const uint8_t *bap_tab, uint8_t *bap);
 183
 184 #endif /* AVCODEC_AC3_H */