git.sesse.net Git - vlc/blob - modules/codec/avcodec/avcodec.h

   1 /*****************************************************************************
   2  * avcodec.h: decoder and encoder using libavcodec
   3  *****************************************************************************
   4  * Copyright (C) 2001-2008 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #include "chroma.h"
  25 #include "avcommon.h"
  26
  27 /* VLC <-> avcodec tables */
  28 int GetFfmpegCodec( vlc_fourcc_t i_fourcc, int *pi_cat,
  29                     unsigned *pi_ffmpeg_codec, const char **ppsz_name );
  30 int GetVlcFourcc( unsigned i_ffmpeg_codec, int *pi_cat,
  31                   vlc_fourcc_t *pi_fourcc, const char **ppsz_name );
  32 vlc_fourcc_t GetVlcAudioFormat( int i_sample_fmt );
  33
  34 /* Video encoder module */
  35 int  OpenEncoder ( vlc_object_t * );
  36 void CloseEncoder( vlc_object_t * );
  37
  38 /* Audio encoder module */
  39 int  OpenAudioEncoder ( vlc_object_t * );
  40 void CloseAudioEncoder( vlc_object_t * );
  41
  42 /* Deinterlace video filter module */
  43 int  OpenDeinterlace( vlc_object_t * );
  44 void CloseDeinterlace( vlc_object_t * );
  45
  46 /* Video Decoder */
  47 int InitVideoDec( decoder_t *p_dec, AVCodecContext *p_context,
  48                   const AVCodec *p_codec, int i_codec_id );
  49 void EndVideoDec( decoder_t *p_dec );
  50
  51 /* Audio Decoder */
  52 int InitAudioDec( decoder_t *p_dec, AVCodecContext *p_context,
  53                   const AVCodec *p_codec, int i_codec_id );
  54
  55 /* Subtitle Decoder */
  56 int InitSubtitleDec( decoder_t *p_dec, AVCodecContext *p_context,
  57                      const AVCodec *p_codec, int i_codec_id );
  58
  59 /* Initialize decoder */
  60 int ffmpeg_OpenCodec( decoder_t *p_dec );
  61
  62 /*****************************************************************************
  63  * Module descriptor help strings
  64  *****************************************************************************/
  65 #define DR_TEXT N_("Direct rendering")
  66 /* FIXME Does somebody who knows what it does, explain */
  67
  68 #define ERROR_TEXT N_("Error resilience")
  69 #define ERROR_LONGTEXT N_( \
  70     "libavcodec can do error resilience.\n" \
  71     "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
  72     "this can produce a lot of errors.\n" \
  73     "Valid values range from 0 to 4 (0 disables all errors resilience).")
  74
  75 #define BUGS_TEXT N_("Workaround bugs")
  76 #define BUGS_LONGTEXT N_( \
  77     "Try to fix some bugs:\n" \
  78     "1  autodetect\n" \
  79     "2  old msmpeg4\n" \
  80     "4  xvid interlaced\n" \
  81     "8  ump4 \n" \
  82     "16 no padding\n" \
  83     "32 ac vlc\n" \
  84     "64 Qpel chroma.\n" \
  85     "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
  86     "\"ump4\", enter 40.")
  87
  88 #define HURRYUP_TEXT N_("Hurry up")
  89 #define HURRYUP_LONGTEXT N_( \
  90     "The decoder can partially decode or skip frame(s) " \
  91     "when there is not enough time. It's useful with low CPU power " \
  92     "but it can produce distorted pictures.")
  93
  94 #define FAST_TEXT N_("Allow speed tricks")
  95 #define FAST_LONGTEXT N_( \
  96     "Allow non specification compliant speedup tricks. Faster but error-prone.")
  97
  98 #define SKIP_FRAME_TEXT N_("Skip frame (default=0)")
  99 #define SKIP_FRAME_LONGTEXT N_( \
 100     "Force skipping of frames to speed up decoding " \
 101     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
 102
 103 #define SKIP_IDCT_TEXT N_("Skip idct (default=0)")
 104 #define SKIP_IDCT_LONGTEXT N_( \
 105     "Force skipping of idct to speed up decoding for frame types " \
 106     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
 107
 108 #define DEBUG_TEXT N_( "Debug mask" )
 109 #define DEBUG_LONGTEXT N_( "Set FFmpeg debug mask" )
 110
 111 #define CODEC_TEXT N_( "Codec name" )
 112 #define CODEC_LONGTEXT N_( "Internal libavcodec codec name" )
 113
 114 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
 115 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
 116     "usually has a detrimental effect on quality. However it provides a big " \
 117     "speedup for high definition streams." )
 118
 119 #define HW_TEXT N_("Hardware decoding")
 120 #define HW_LONGTEXT N_("This allows hardware decoding when available.")
 121
 122 #define VDA_PIX_FMT_TEXT N_("VDA output pixel format")
 123 #define VDA_PIX_FMT_LONGTEXT N_("The pixel format for output image buffers.")
 124
 125 #define THREADS_TEXT N_( "Threads" )
 126 #define THREADS_LONGTEXT N_( "Number of threads used for decoding, 0 meaning auto" )
 127
 128 /*
 129  * Encoder options
 130  */
 131 #define ENC_CFG_PREFIX "sout-avcodec-"
 132
 133 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
 134 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
 135   "that will be coded for one key frame." )
 136
 137 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
 138 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
 139   "B frames that will be coded between two reference frames." )
 140
 141 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
 142 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
 143
 144 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
 145 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
 146   "algorithms for interlaced frames." )
 147
 148 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
 149 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
 150   "motion estimation algorithms. This requires more CPU." )
 151
 152 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
 153 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
 154   "estimation algorithm.")
 155
 156 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
 157 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
 158   "buffer size (in kbytes). A bigger buffer will allow for better rate " \
 159   "control, but will cause a delay in the stream." )
 160
 161 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
 162 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
 163   "buffer aggressiveness." )
 164
 165 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
 166 #define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
 167   "Quantization factor of I frames, compared with P frames (for instance " \
 168   "1.0 => same qscale for I and P frames)." )
 169
 170 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
 171 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
 172   "reduction algorithm to lower the encoding length and bitrate, at the " \
 173   "expense of lower quality frames." )
 174
 175 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
 176 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
 177   "quantization matrix for MPEG2 encoding. This generally yields a " \
 178   "better looking picture, while still retaining the compatibility with " \
 179   "standard MPEG2 decoders.")
 180
 181 #define ENC_HQ_TEXT N_( "Quality level" )
 182 #define ENC_HQ_LONGTEXT N_( "Quality level " \
 183   "for the encoding of motions vectors (this can slow down the encoding " \
 184   "very much)." )
 185
 186 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
 187 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
 188   "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
 189   "the encoding rate. It will disable trellis quantization, then the rate " \
 190   "distortion of motion vectors (hq), and raise the noise reduction " \
 191   "threshold to ease the encoder's task." )
 192
 193 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
 194 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
 195   "quantizer scale." )
 196
 197 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
 198 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
 199   "quantizer scale." )
 200
 201 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
 202 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
 203   "quantization (rate distortion for block coefficients)." )
 204
 205 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
 206 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
 207   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
 208
 209 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
 210 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
 211   "compliance when encoding (accepted values: -2 to 2)." )
 212
 213 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
 214 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 215   "very bright macroblocks (default: 0.0)." )
 216
 217 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
 218 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 219   "very dark macroblocks (default: 0.0)." )
 220
 221 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
 222 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 223   "macroblocks with a high temporal complexity (default: 0.0)." )
 224
 225 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
 226 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
 227   "for macroblocks at the border of the frame (default: 0.0)." )
 228
 229 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
 230 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
 231   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 232   "recommends -4." )
 233
 234 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
 235 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
 236   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 237   "recommends 7." )
 238
 239 #define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
 240 #define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
 241    "for encoding the audio bitstream. It takes the following options: " \
 242    "main, low, ssr (not supported),ltp, hev1, hev2 (default: low). " \
 243    "hev1 and hev2 are currently supported only with libfdk-aac enabled libavcodec" )
 244
 245 #define AVCODEC_COMMON_MEMBERS   \
 246     int i_codec_id;             \
 247     AVCodecContext *p_context;  \
 248     const AVCodec  *p_codec;    \
 249     bool b_delayed_open;
 250
 251 #ifndef AV_VERSION_INT
 252 #   define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
 253 #endif
 254
 255 #if defined(FF_THREAD_FRAME)
 256 #   define HAVE_AVCODEC_MT
 257 #endif
 258