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