1 /*****************************************************************************
2 * avcodec.h: decoder and encoder using libavcodec
3 *****************************************************************************
4 * Copyright (C) 2001-2008 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
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 );
32 picture_t * DecodeVideo( decoder_t *, block_t ** );
33 block_t * DecodeAudio( decoder_t *, block_t ** );
34 subpicture_t *DecodeSubtitle( decoder_t *p_dec, block_t ** );
36 /* Video encoder module */
37 int OpenEncoder ( vlc_object_t * );
38 void CloseEncoder( vlc_object_t * );
40 /* Audio encoder module */
41 int OpenAudioEncoder ( vlc_object_t * );
42 void CloseAudioEncoder( vlc_object_t * );
44 /* Deinterlace video filter module */
45 int OpenDeinterlace( vlc_object_t * );
46 void CloseDeinterlace( vlc_object_t * );
49 int InitVideoDec( decoder_t *p_dec, AVCodecContext *p_context,
50 AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
51 void EndVideoDec( decoder_t *p_dec );
54 int InitAudioDec( decoder_t *p_dec, AVCodecContext *p_context,
55 AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
56 void EndAudioDec( decoder_t *p_dec );
58 /* Subtitle Decoder */
59 int InitSubtitleDec( decoder_t *p_dec, AVCodecContext *p_context,
60 AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
61 void EndSubtitleDec( decoder_t *p_dec );
63 /* Initialize decoder */
64 int ffmpeg_OpenCodec( decoder_t *p_dec );
66 /*****************************************************************************
67 * Module descriptor help strings
68 *****************************************************************************/
69 #define DR_TEXT N_("Direct rendering")
70 /* FIXME Does somebody who knows what it does, explain */
71 #define DR_LONGTEXT N_("Direct rendering")
73 #define ERROR_TEXT N_("Error resilience")
74 #define ERROR_LONGTEXT N_( \
75 "libavcodec can do error resilience.\n" \
76 "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
77 "this can produce a lot of errors.\n" \
78 "Valid values range from 0 to 4 (0 disables all errors resilience).")
80 #define BUGS_TEXT N_("Workaround bugs")
81 #define BUGS_LONGTEXT N_( \
82 "Try to fix some bugs:\n" \
85 "4 xvid interlaced\n" \
90 "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
91 "\"ump4\", enter 40.")
93 #define HURRYUP_TEXT N_("Hurry up")
94 #define HURRYUP_LONGTEXT N_( \
95 "The decoder can partially decode or skip frame(s) " \
96 "when there is not enough time. It's useful with low CPU power " \
97 "but it can produce distorted pictures.")
99 #define FAST_TEXT N_("Allow speed tricks")
100 #define FAST_LONGTEXT N_( \
101 "Allow non specification compliant speedup tricks. Faster but error-prone.")
103 #define SKIP_FRAME_TEXT N_("Skip frame (default=0)")
104 #define SKIP_FRAME_LONGTEXT N_( \
105 "Force skipping of frames to speed up decoding " \
106 "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
108 #define SKIP_IDCT_TEXT N_("Skip idct (default=0)")
109 #define SKIP_IDCT_LONGTEXT N_( \
110 "Force skipping of idct to speed up decoding for frame types " \
111 "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
113 #define DEBUG_TEXT N_( "Debug mask" )
114 #define DEBUG_LONGTEXT N_( "Set FFmpeg debug mask" )
116 #define CODEC_TEXT N_( "Codec name" )
117 #define CODEC_LONGTEXT N_( "Internal libavcodec codec name" )
119 /* TODO: Use a predefined list, with 0,1,2,4,7 */
120 #define VISMV_TEXT N_( "Visualize motion vectors" )
121 #define VISMV_LONGTEXT N_( \
122 "You can overlay the motion vectors (arrows showing how the images move) "\
123 "on the image. This value is a mask, based on these values:\n"\
124 "1 - visualize forward predicted MVs of P frames\n" \
125 "2 - visualize forward predicted MVs of B frames\n" \
126 "4 - visualize backward predicted MVs of B frames\n" \
127 "To visualize all vectors, the value should be 7." )
129 #define LOWRES_TEXT N_( "Low resolution decoding" )
130 #define LOWRES_LONGTEXT N_( "Only decode a low resolution version of " \
131 "the video. This requires less processing power" )
133 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
134 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
135 "usually has a detrimental effect on quality. However it provides a big " \
136 "speedup for high definition streams." )
138 #define HW_TEXT N_("Hardware decoding")
139 #define HW_LONGTEXT N_("This allows hardware decoding when available.")
141 #define VDA_PIX_FMT_TEXT N_("VDA output pixel format")
142 #define VDA_PIX_FMT_LONGTEXT N_("The pixel format for output image buffers.")
144 #define THREADS_TEXT N_( "Threads" )
145 #define THREADS_LONGTEXT N_( "Number of threads used for decoding, 0 meaning auto" )
150 #define ENC_CFG_PREFIX "sout-avcodec-"
152 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
153 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
154 "that will be coded for one key frame." )
156 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
157 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
158 "B frames that will be coded between two reference frames." )
160 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
161 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
163 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
164 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
165 "algorithms for interlaced frames." )
167 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
168 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
169 "motion estimation algorithms. This requires more CPU." )
171 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
172 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
173 "estimation algorithm.")
175 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
176 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
177 "buffer size (in kbytes). A bigger buffer will allow for better rate " \
178 "control, but will cause a delay in the stream." )
180 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
181 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
182 "buffer aggressiveness." )
184 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
185 #define ENC_IQUANT_FACTOR_LONGTEXT N_( \
186 "Quantization factor of I frames, compared with P frames (for instance " \
187 "1.0 => same qscale for I and P frames)." )
189 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
190 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
191 "reduction algorithm to lower the encoding length and bitrate, at the " \
192 "expense of lower quality frames." )
194 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
195 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
196 "quantization matrix for MPEG2 encoding. This generally yields a " \
197 "better looking picture, while still retaining the compatibility with " \
198 "standard MPEG2 decoders.")
200 #define ENC_HQ_TEXT N_( "Quality level" )
201 #define ENC_HQ_LONGTEXT N_( "Quality level " \
202 "for the encoding of motions vectors (this can slow down the encoding " \
205 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
206 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
207 "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
208 "the encoding rate. It will disable trellis quantization, then the rate " \
209 "distortion of motion vectors (hq), and raise the noise reduction " \
210 "threshold to ease the encoder's task." )
212 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
213 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
216 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
217 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
220 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
221 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
222 "quantization (rate distortion for block coefficients)." )
224 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
225 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
226 "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
228 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
229 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
230 "compliance when encoding (accepted values: -2 to 2)." )
232 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
233 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
234 "very bright macroblocks (default: 0.0)." )
236 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
237 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
238 "very dark macroblocks (default: 0.0)." )
240 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
241 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
242 "macroblocks with a high temporal complexity (default: 0.0)." )
244 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
245 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
246 "for macroblocks at the border of the frame (default: 0.0)." )
248 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
249 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
250 "the PSNR isn't much changed (default: 0.0). The H264 specification " \
253 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
254 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
255 "the PSNR isn't much changed (default: 0.0). The H264 specification " \
258 #define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
259 #define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
260 "for encoding the audio bitstream. It takes the following options: " \
261 "main, low, ssr (not supported),ltp, hev1, hev2 (default: low). " \
262 "hev1 and hev2 are currently supported only with libfdk-aac enabled libavcodec" )
264 #define AVCODEC_COMMON_MEMBERS \
267 const char *psz_namecodec; \
268 AVCodecContext *p_context; \
272 #ifndef AV_VERSION_INT
273 # define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
276 #if defined(FF_THREAD_FRAME)
277 # define HAVE_AVCODEC_MT
281 /* LIBAVCODEC_VERSION_CHECK checks for the right version of libav and FFmpeg
282 * a is the major version
283 * b and c the minor and micro versions of libav
284 * d and e the minor and micro versions of FFmpeg */
285 #define LIBAVCODEC_VERSION_CHECK( a, b, c, d, e ) \
286 (LIBAVCODEC_VERSION_MICRO < 100 && LIBAVCODEC_VERSION_INT >= AV_VERSION_INT( a, b, c ) ) || \
287 (LIBAVCODEC_VERSION_MICRO >= 100 && LIBAVCODEC_VERSION_INT >= AV_VERSION_INT( a, d, e ) )
290 /* Uncomment it to enable compilation with vaapi/dxva2/vda (you also must change the build
292 //#define HAVE_AVCODEC_VAAPI 1
293 //#define HAVE_AVCODEC_DXVA2 1
294 //#define HAVE_AVCODEC_VDA 1
296 /* Ugly ifdefinitions to provide backwards compatibility with older ffmpeg/libav
298 #ifndef AV_CPU_FLAG_FORCE
299 # define AV_CPU_FLAG_FORCE FF_MM_FORCE
300 # define AV_CPU_FLAG_MMX FF_MM_MMX
301 # define AV_CPU_FLAG_3DNOW FF_MM_3DNOW
302 # define AV_CPU_FLAG_MMX2 FF_MM_MMX2
303 # define AV_CPU_FLAG_SSE FF_MM_SSE
304 # define AV_CPU_FLAG_SSE2 FF_MM_SSE2
305 # define AV_CPU_FLAG_SSE2SLOW FF_MM_SSE2SLOW
306 # define AV_CPU_FLAG_3DNOWEXT FF_MM_3DNOWEXT
307 # define AV_CPU_FLAG_SSE3 FF_MM_SSE3
308 # define AV_CPU_FLAG_SSE3SLOW FF_MM_SSE3SLOW
309 # define AV_CPU_FLAG_SSSE3 FF_MM_SSSE3
310 # define AV_CPU_FLAG_SSE4 FF_MM_SSE4
311 # define AV_CPU_FLAG_SSE42 FF_MM_SSE42
312 # define AV_CPU_FLAG_IWMMXT FF_MM_IWMMXT
313 # define AV_CPU_FLAG_ALTIVEC FF_MM_ALTIVEC
316 #if LIBAVCODEC_VERSION_MAJOR < 53
317 # define AVMediaType CodecType
318 # define AVMEDIA_TYPE_AUDIO CODEC_TYPE_AUDIO
319 # define AVMEDIA_TYPE_VIDEO CODEC_TYPE_VIDEO
320 # define AVMEDIA_TYPE_SUBTITLE CODEC_TYPE_SUBTITLE
321 # define AVMEDIA_TYPE_DATA CODEC_TYPE_DATA
322 # define AVMEDIA_TYPE_ATTACHMENT CODEC_TYPE_ATTACHMENT
325 #if LIBAVCODEC_VERSION_MAJOR < 54
326 # define AV_PICTURE_TYPE_B FF_B_TYPE
327 # define AV_PICTURE_TYPE_I FF_I_TYPE
328 # define AV_PICTURE_TYPE_P FF_P_TYPE
330 # define AV_SAMPLE_FMT_NONE SAMPLE_FMT_NONE
331 # define AV_SAMPLE_FMT_U8 SAMPLE_FMT_U8
332 # define AV_SAMPLE_FMT_S16 SAMPLE_FMT_S16
333 # define AV_SAMPLE_FMT_S32 SAMPLE_FMT_S32
334 # define AV_SAMPLE_FMT_FLT SAMPLE_FMT_FLT
335 # define AV_SAMPLE_FMT_DBL SAMPLE_FMT_DBL
337 #ifndef AV_CH_FRONT_LEFT
338 # define AV_CH_FRONT_LEFT CH_FRONT_LEFT
340 #ifndef AV_CH_FRONT_RIGHT
341 # define AV_CH_FRONT_RIGHT CH_FRONT_RIGHT
343 #ifndef AV_CH_FRONT_CENTER
344 # define AV_CH_FRONT_CENTER CH_FRONT_CENTER
346 #ifndef AV_CH_LOW_FREQUENCY
347 # define AV_CH_LOW_FREQUENCY CH_LOW_FREQUENCY
349 #ifndef AV_CH_BACK_LEFT
350 # define AV_CH_BACK_LEFT CH_BACK_LEFT
352 #ifndef AV_CH_BACK_RIGHT
353 # define AV_CH_BACK_RIGHT CH_BACK_RIGHT
355 #ifndef AV_CH_FRONT_LEFT_OF_CENTER
356 # define AV_CH_FRONT_LEFT_OF_CENTER CH_FRONT_LEFT_OF_CENTER
358 #ifndef AV_CH_FRONT_RIGHT_OF_CENTER
359 # define AV_CH_FRONT_RIGHT_OF_CENTER CH_FRONT_RIGHT_OF_CENTER
361 #ifndef AV_CH_BACK_CENTER
362 # define AV_CH_BACK_CENTER CH_BACK_CENTER
364 #ifndef AV_CH_SIDE_LEFT
365 # define AV_CH_SIDE_LEFT CH_SIDE_LEFT
367 #ifndef AV_CH_SIDE_RIGHT
368 # define AV_CH_SIDE_RIGHT CH_SIDE_RIGHT
370 #ifndef AV_CH_TOP_CENTER
371 # define AV_CH_TOP_CENTER CH_TOP_CENTER
373 #ifndef AV_CH_TOP_FRONT_LEFT
374 # define AV_CH_TOP_FRONT_LEFT CH_TOP_FRONT_LEFT
376 #ifndef AV_CH_TOP_FRONT_CENTER
377 # define AV_CH_TOP_FRONT_CENTER CH_TOP_FRONT_CENTER
379 #ifndef AV_CH_TOP_FRONT_RIGHT
380 # define AV_CH_TOP_FRONT_RIGHT CH_TOP_FRONT_RIGHT
382 #ifndef AV_CH_TOP_BACK_LEFT
383 # define AV_CH_TOP_BACK_LEFT CH_TOP_BACK_LEFT
385 #ifndef AV_CH_TOP_BACK_CENTER
386 # define AV_CH_TOP_BACK_CENTER CH_TOP_BACK_CENTER
388 #ifndef AV_CH_TOP_BACK_RIGHT
389 # define AV_CH_TOP_BACK_RIGHT CH_TOP_BACK_RIGHT
391 #ifndef AV_CH_STEREO_LEFT
392 # define AV_CH_STEREO_LEFT CH_STEREO_LEFT
394 #ifndef AV_CH_STEREO_RIGHT
395 # define AV_CH_STEREO_RIGHT CH_STEREO_RIGHT
401 #ifndef AV_PKT_FLAG_KEY
402 # define AV_PKT_FLAG_KEY PKT_FLAG_KEY