modules/codec/avcodec/avcodec.h

   1 /*****************************************************************************
   2  * avcodec.h: decoder and encoder using libavcodec
   3  *****************************************************************************
   4  * Copyright (C) 2001-2008 the VideoLAN team
   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
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #include "chroma.h"
  25 /* VLC <-> avcodec tables */
  26 int GetFfmpegCodec( vlc_fourcc_t i_fourcc, int *pi_cat,
  27                     int *pi_ffmpeg_codec, const char **ppsz_name );
  28 int GetVlcFourcc( int i_ffmpeg_codec, int *pi_cat,
  29                   vlc_fourcc_t *pi_fourcc, const char **ppsz_name );
  30 void GetVlcAudioFormat( vlc_fourcc_t *, unsigned *pi_bits, int i_sample_fmt );
  31
  32 picture_t * DecodeVideo    ( decoder_t *, block_t ** );
  33 aout_buffer_t * DecodeAudio( decoder_t *, block_t ** );
  34 subpicture_t *DecodeSubtitle( decoder_t *p_dec, block_t ** );
  35
  36 /* Video encoder module */
  37 int  OpenEncoder ( vlc_object_t * );
  38 void CloseEncoder( vlc_object_t * );
  39
  40 /* Audio encoder module */
  41 int  OpenAudioEncoder ( vlc_object_t * );
  42 void CloseAudioEncoder( vlc_object_t * );
  43
  44 /* Deinterlace video filter module */
  45 int  OpenDeinterlace( vlc_object_t * );
  46 void CloseDeinterlace( vlc_object_t * );
  47
  48 void InitLibavcodec( vlc_object_t *p_object );
  49
  50 /* Video Decoder */
  51 int InitVideoDec( decoder_t *p_dec, AVCodecContext *p_context,
  52                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
  53 void EndVideoDec( decoder_t *p_dec );
  54
  55 /* Audio Decoder */
  56 int InitAudioDec( decoder_t *p_dec, AVCodecContext *p_context,
  57                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
  58 void EndAudioDec( decoder_t *p_dec );
  59
  60 /* Subtitle Decoder */
  61 int InitSubtitleDec( decoder_t *p_dec, AVCodecContext *p_context,
  62                      AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
  63 void EndSubtitleDec( decoder_t *p_dec );
  64
  65 /* Initialize decoder */
  66 int ffmpeg_OpenCodec( decoder_t *p_dec );
  67
  68 /*****************************************************************************
  69  * Module descriptor help strings
  70  *****************************************************************************/
  71 #define DR_TEXT N_("Direct rendering")
  72 /* FIXME Does somebody who knows what it does, explain */
  73 #define DR_LONGTEXT N_("Direct rendering")
  74
  75 #define ERROR_TEXT N_("Error resilience")
  76 #define ERROR_LONGTEXT N_( \
  77     "FFmpeg can do error resilience.\n" \
  78     "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
  79     "this can produce a lot of errors.\n" \
  80     "Valid values range from 0 to 4 (0 disables all errors resilience).")
  81
  82 #define BUGS_TEXT N_("Workaround bugs")
  83 #define BUGS_LONGTEXT N_( \
  84     "Try to fix some bugs:\n" \
  85     "1  autodetect\n" \
  86     "2  old msmpeg4\n" \
  87     "4  xvid interlaced\n" \
  88     "8  ump4 \n" \
  89     "16 no padding\n" \
  90     "32 ac vlc\n" \
  91     "64 Qpel chroma.\n" \
  92     "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
  93     "\"ump4\", enter 40.")
  94
  95 #define HURRYUP_TEXT N_("Hurry up")
  96 #define HURRYUP_LONGTEXT N_( \
  97     "The decoder can partially decode or skip frame(s) " \
  98     "when there is not enough time. It's useful with low CPU power " \
  99     "but it can produce distorted pictures.")
 100
 101 #define FAST_TEXT N_("Allow speed tricks")
 102 #define FAST_LONGTEXT N_( \
 103     "Allow non specification compliant speedup tricks. Faster but error-prone.")
 104
 105 #define SKIP_FRAME_TEXT N_("Skip frame (default=0)")
 106 #define SKIP_FRAME_LONGTEXT N_( \
 107     "Force skipping of frames to speed up decoding " \
 108     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
 109
 110 #define SKIP_IDCT_TEXT N_("Skip idct (default=0)")
 111 #define SKIP_IDCT_LONGTEXT N_( \
 112     "Force skipping of idct to speed up decoding for frame types" \
 113     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
 114
 115 #define DEBUG_TEXT N_( "Debug mask" )
 116 #define DEBUG_LONGTEXT N_( "Set FFmpeg debug mask" )
 117
 118 /* TODO: Use a predefined list, with 0,1,2,4,7 */
 119 #define VISMV_TEXT N_( "Visualize motion vectors" )
 120 #define VISMV_LONGTEXT N_( \
 121     "You can overlay the motion vectors (arrows showing how the images move) "\
 122     "on the image. This value is a mask, based on these values:\n"\
 123     "1 - visualize forward predicted MVs of P frames\n" \
 124     "2 - visualize forward predicted MVs of B frames\n" \
 125     "4 - visualize backward predicted MVs of B frames\n" \
 126     "To visualize all vectors, the value should be 7." )
 127
 128 #define LOWRES_TEXT N_( "Low resolution decoding" )
 129 #define LOWRES_LONGTEXT N_( "Only decode a low resolution version of " \
 130     "the video. This requires less processing power" )
 131
 132 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
 133 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
 134     "usually has a detrimental effect on quality. However it provides a big " \
 135     "speedup for high definition streams." )
 136
 137 #define HW_TEXT N_("Hardware decoding")
 138 #define HW_LONGTEXT N_("This allows hardware decoding when available.")
 139
 140 #define THREADS_TEXT N_( "Threads" )
 141 #define THREADS_LONGTEXT N_( "Number of threads used for decoding, 0 meaning auto" )
 142
 143 /*
 144  * Encoder options
 145  */
 146 #define ENC_CFG_PREFIX "sout-ffmpeg-"
 147
 148 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
 149 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
 150   "that will be coded for one key frame." )
 151
 152 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
 153 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
 154   "B frames that will be coded between two reference frames." )
 155
 156 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
 157 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
 158
 159 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
 160 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
 161   "algorithms for interlaced frames." )
 162
 163 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
 164 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
 165   "motion estimation algorithms. This requires more CPU." )
 166
 167 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
 168 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
 169   "estimation algorithm.")
 170
 171 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
 172 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
 173   "buffer size (in kbytes). A bigger buffer will allow for better rate " \
 174   "control, but will cause a delay in the stream." )
 175
 176 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
 177 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
 178   "buffer aggressiveness." )
 179
 180 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
 181 #define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
 182   "Quantization factor of I frames, compared with P frames (for instance " \
 183   "1.0 => same qscale for I and P frames)." )
 184
 185 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
 186 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
 187   "reduction algorithm to lower the encoding length and bitrate, at the " \
 188   "expense of lower quality frames." )
 189
 190 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
 191 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
 192   "quantization matrix for MPEG2 encoding. This generally yields a " \
 193   "better looking picture, while still retaining the compatibility with " \
 194   "standard MPEG2 decoders.")
 195
 196 #define ENC_HQ_TEXT N_( "Quality level" )
 197 #define ENC_HQ_LONGTEXT N_( "Quality level " \
 198   "for the encoding of motions vectors (this can slow down the encoding " \
 199   "very much)." )
 200
 201 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
 202 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
 203   "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
 204   "the encoding rate. It will disable trellis quantization, then the rate " \
 205   "distortion of motion vectors (hq), and raise the noise reduction " \
 206   "threshold to ease the encoder's task." )
 207
 208 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
 209 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
 210   "quantizer scale." )
 211
 212 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
 213 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
 214   "quantizer scale." )
 215
 216 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
 217 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
 218   "quantization (rate distortion for block coefficients)." )
 219
 220 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
 221 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
 222   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
 223
 224 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
 225 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
 226   "compliance when encoding (accepted values: -1, 0, 1)." )
 227
 228 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
 229 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 230   "very bright macroblocks (default: 0.0)." )
 231
 232 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
 233 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 234   "very dark macroblocks (default: 0.0)." )
 235
 236 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
 237 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 238   "macroblocks with a high temporal complexity (default: 0.0)." )
 239
 240 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
 241 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
 242   "for macroblocks at the border of the frame (default: 0.0)." )
 243
 244 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
 245 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
 246   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 247   "recommends -4." )
 248
 249 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
 250 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
 251   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 252   "recommends 7." )
 253
 254 #define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
 255 #define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
 256    "for encoding the audio bitstream. It takes the following options: " \
 257    "main, low, ssr (not supported) and ltp (default: main)" )
 258
 259 #define AVCODEC_COMMON_MEMBERS   \
 260     int i_cat;                  \
 261     int i_codec_id;             \
 262     const char *psz_namecodec;  \
 263     AVCodecContext *p_context;  \
 264     AVCodec        *p_codec;    \
 265     bool b_delayed_open;
 266
 267 #ifndef AV_VERSION_INT
 268 #   define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
 269 #endif
 270
 271 #if defined(FF_THREAD_FRAME)
 272 #   define HAVE_AVCODEC_MT
 273 #endif
 274
 275 /* Uncomment it to enable compilation with vaapi/dxva2 (you also must change the build
 276  * system) */
 277 //#define HAVE_AVCODEC_VAAPI 1
 278 //#define HAVE_AVCODEC_DXVA2 1
 279
 280 /* Ugly ifdefinitions to provide backwards compatibility with older ffmpeg/libav
 281  * versions */
 282 #ifndef AV_CPU_FLAG_FORCE
 283 #   define AV_CPU_FLAG_FORCE       FF_MM_FORCE
 284 #   define AV_CPU_FLAG_MMX         FF_MM_MMX
 285 #   define AV_CPU_FLAG_3DNOW       FF_MM_3DNOW
 286 #   define AV_CPU_FLAG_MMX2        FF_MM_MMX2
 287 #   define AV_CPU_FLAG_SSE         FF_MM_SSE
 288 #   define AV_CPU_FLAG_SSE2        FF_MM_SSE2
 289 #   define AV_CPU_FLAG_SSE2SLOW    FF_MM_SSE2SLOW
 290 #   define AV_CPU_FLAG_3DNOWEXT    FF_MM_3DNOWEXT
 291 #   define AV_CPU_FLAG_SSE3        FF_MM_SSE3
 292 #   define AV_CPU_FLAG_SSE3SLOW    FF_MM_SSE3SLOW
 293 #   define AV_CPU_FLAG_SSSE3       FF_MM_SSSE3
 294 #   define AV_CPU_FLAG_SSE4        FF_MM_SSE4
 295 #   define AV_CPU_FLAG_SSE42       FF_MM_SSE42
 296 #   define AV_CPU_FLAG_IWMMXT      FF_MM_IWMMXT
 297 #   define AV_CPU_FLAG_ALTIVEC     FF_MM_ALTIVEC
 298 #endif
 299
 300 #if LIBAVCODEC_VERSION_MAJOR < 53
 301 #   define AVMediaType             CodecType
 302 #   define AVMEDIA_TYPE_AUDIO      CODEC_TYPE_AUDIO
 303 #   define AVMEDIA_TYPE_VIDEO      CODEC_TYPE_VIDEO
 304 #   define AVMEDIA_TYPE_SUBTITLE   CODEC_TYPE_SUBTITLE
 305 #   define AVMEDIA_TYPE_DATA       CODEC_TYPE_DATA
 306 #   define AVMEDIA_TYPE_ATTACHMENT CODEC_TYPE_ATTACHMENT
 307 #endif
 308
 309 #ifndef AV_PKT_FLAG_KEY
 310 #   define AV_PKT_FLAG_KEY         PKT_FLAG_KEY
 311 #endif