Added (but disabled at compilation time) VA-API support to our avcodec wrapper.
[vlc.git] / 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 /* VLC <-> avcodec tables */
25 int GetFfmpegCodec( vlc_fourcc_t i_fourcc, int *pi_cat,
26                     int *pi_ffmpeg_codec, const char **ppsz_name );
27 int GetVlcFourcc( int i_ffmpeg_codec, int *pi_cat,
28                   vlc_fourcc_t *pi_fourcc, const char **ppsz_name );
29 int TestFfmpegChroma( const int i_ffmpeg_id, const vlc_fourcc_t i_vlc_fourcc );
30 int GetFfmpegChroma( int *i_ffmpeg_chroma, const video_format_t fmt );
31 int GetVlcChroma( video_format_t *fmt, const int i_ffmpeg_chroma );
32
33
34 picture_t * DecodeVideo    ( decoder_t *, block_t ** );
35 aout_buffer_t * DecodeAudio( decoder_t *, block_t ** );
36
37 /* Video encoder module */
38 int  OpenEncoder ( vlc_object_t * );
39 void CloseEncoder( vlc_object_t * );
40
41 /* Audio encoder module */
42 int  OpenAudioEncoder ( vlc_object_t * );
43 void CloseAudioEncoder( vlc_object_t * );
44
45 /* Deinterlace video filter module */
46 int  OpenDeinterlace( vlc_object_t * );
47 void CloseDeinterlace( vlc_object_t * );
48
49 void InitLibavcodec( vlc_object_t *p_object );
50
51 /* Video Decoder */
52 int InitVideoDec( decoder_t *p_dec, AVCodecContext *p_context,
53                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
54 void EndVideoDec( decoder_t *p_dec );
55
56 /* Audio Decoder */
57 int InitAudioDec( decoder_t *p_dec, AVCodecContext *p_context,
58                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
59 void EndAudioDec( decoder_t *p_dec );
60
61 /*****************************************************************************
62  * Module descriptor help strings
63  *****************************************************************************/
64 #define DR_TEXT N_("Direct rendering")
65 /* FIXME Does somebody who knows what it does, explain */
66 #define DR_LONGTEXT N_("Direct rendering")
67
68 #define ERROR_TEXT N_("Error resilience")
69 #define ERROR_LONGTEXT N_( \
70     "Ffmpeg 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 /* TODO: Use a predefined list, with 0,1,2,4,7 */
112 #define VISMV_TEXT N_( "Visualize motion vectors" )
113 #define VISMV_LONGTEXT N_( \
114     "You can overlay the motion vectors (arrows showing how the images move) "\
115     "on the image. This value is a mask, based on these values:\n"\
116     "1 - visualize forward predicted MVs of P frames\n" \
117     "2 - visualize forward predicted MVs of B frames\n" \
118     "4 - visualize backward predicted MVs of B frames\n" \
119     "To visualize all vectors, the value should be 7." )
120
121 #define LOWRES_TEXT N_( "Low resolution decoding" )
122 #define LOWRES_LONGTEXT N_( "Only decode a low resolution version of " \
123     "the video. This requires less processing power" )
124
125 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
126 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
127     "usually has a detrimental effect on quality. However it provides a big " \
128     "speedup for high definition streams." )
129
130 #define HW_TEXT N_("Hardware decoding")
131 #define HW_LONGTEXT N_("This allows hardware decoding when available.")
132
133 /*
134  * Encoder options
135  */
136 #define ENC_CFG_PREFIX "sout-ffmpeg-"
137
138 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
139 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
140   "that will be coded for one key frame." )
141
142 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
143 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
144   "B frames that will be coded between two reference frames." )
145
146 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
147 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
148
149 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
150 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
151   "algorithms for interlaced frames." )
152
153 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
154 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
155   "motion estimation algorithms. This requires more CPU." )
156
157 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
158 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
159   "estimation algorithm.")
160
161 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
162 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
163   "buffer size (in kbytes). A bigger buffer will allow for better rate " \
164   "control, but will cause a delay in the stream." )
165
166 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
167 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
168   "buffer aggressiveness." )
169
170 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
171 #define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
172   "Quantization factor of I frames, compared with P frames (for instance " \
173   "1.0 => same qscale for I and P frames)." )
174
175 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
176 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
177   "reduction algorithm to lower the encoding length and bitrate, at the " \
178   "expense of lower quality frames." )
179
180 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
181 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
182   "quantization matrix for MPEG2 encoding. This generally yields a " \
183   "better looking picture, while still retaining the compatibility with " \
184   "standard MPEG2 decoders.")
185
186 #define ENC_HQ_TEXT N_( "Quality level" )
187 #define ENC_HQ_LONGTEXT N_( "Quality level " \
188   "for the encoding of motions vectors (this can slow down the encoding " \
189   "very much)." )
190
191 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
192 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
193   "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
194   "the encoding rate. It will disable trellis quantization, then the rate " \
195   "distortion of motion vectors (hq), and raise the noise reduction " \
196   "threshold to ease the encoder's task." )
197
198 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
199 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
200   "quantizer scale." )
201
202 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
203 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
204   "quantizer scale." )
205
206 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
207 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
208   "quantization (rate distortion for block coefficients)." )
209
210 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
211 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
212   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
213
214 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
215 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
216   "compliance when encoding (accepted values: -1, 0, 1)." )
217
218 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
219 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
220   "very bright macroblocks (default: 0.0)." )
221
222 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
223 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
224   "very dark macroblocks (default: 0.0)." )
225
226 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
227 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
228   "macroblocks with a high temporal complexity (default: 0.0)." )
229
230 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
231 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
232   "for macroblocks at the border of the frame (default: 0.0)." )
233
234 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
235 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
236   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
237   "recommends -4." )
238
239 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
240 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
241   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
242   "recommends 7." )
243
244 #if LIBAVCODEC_VERSION_INT >= ((51<<16)+(40<<8)+4)
245 #define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
246 #define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
247    "for encoding the audio bitstream. It takes the following options: " \
248    "main, low, ssr (not supported) and ltp (default: main)" )
249 #endif
250
251 #define FFMPEG_COMMON_MEMBERS   \
252     int i_cat;                  \
253     int i_codec_id;             \
254     const char *psz_namecodec;  \
255     AVCodecContext *p_context;  \
256     AVCodec        *p_codec;    \
257     bool b_delayed_open;
258
259 #ifndef AV_VERSION_INT
260 #   define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
261 #endif
262
263 /* Uncomment it to enable compilation with vaapi (you also must change the build
264  * system) */
265 //#define HAVE_AVCODEC_VAAPI 1