6d8e08277d644ed99a425078f773a3cb2d7c1de4
[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 int GetFfmpegCodec( vlc_fourcc_t i_fourcc, int *pi_cat,
25                     int *pi_ffmpeg_codec, const char **ppsz_name );
26 int GetVlcFourcc( int i_ffmpeg_codec, int *pi_cat,
27                   vlc_fourcc_t *pi_fourcc, const char **ppsz_name );
28
29 picture_t * DecodeVideo    ( decoder_t *, block_t ** );
30 aout_buffer_t * DecodeAudio( decoder_t *, block_t ** );
31
32 /* Video encoder module */
33 int  OpenEncoder ( vlc_object_t * );
34 void CloseEncoder( vlc_object_t * );
35
36 /* Audio encoder module */
37 int  OpenAudioEncoder ( vlc_object_t * );
38 void CloseAudioEncoder( vlc_object_t * );
39
40 /* Deinterlace video filter module */
41 int  OpenDeinterlace( vlc_object_t * );
42 void CloseDeinterlace( vlc_object_t * );
43
44 void InitLibavcodec( vlc_object_t *p_object );
45
46 /* Video Decoder */
47 int InitVideoDec( decoder_t *p_dec, AVCodecContext *p_context,
48                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
49 void EndVideoDec( decoder_t *p_dec );
50
51 /* Audio Decoder */
52 int InitAudioDec( decoder_t *p_dec, AVCodecContext *p_context,
53                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
54 void EndAudioDec( decoder_t *p_dec );
55
56 /* Avcodec global lock */
57 extern vlc_mutex_t avcodec_lock;
58
59 /*****************************************************************************
60  * Module descriptor help strings
61  *****************************************************************************/
62 #define DR_TEXT N_("Direct rendering")
63 /* FIXME Does somebody who knows what it does, explain */
64 #define DR_LONGTEXT N_("Direct rendering")
65
66 #define ERROR_TEXT N_("Error resilience")
67 #define ERROR_LONGTEXT N_( \
68     "Ffmpeg can do error resilience.\n" \
69     "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
70     "this can produce a lot of errors.\n" \
71     "Valid values range from 0 to 4 (0 disables all errors resilience).")
72
73 #define BUGS_TEXT N_("Workaround bugs")
74 #define BUGS_LONGTEXT N_( \
75     "Try to fix some bugs:\n" \
76     "1  autodetect\n" \
77     "2  old msmpeg4\n" \
78     "4  xvid interlaced\n" \
79     "8  ump4 \n" \
80     "16 no padding\n" \
81     "32 ac vlc\n" \
82     "64 Qpel chroma.\n" \
83     "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
84     "\"ump4\", enter 40.")
85
86 #define HURRYUP_TEXT N_("Hurry up")
87 #define HURRYUP_LONGTEXT N_( \
88     "The decoder can partially decode or skip frame(s) " \
89     "when there is not enough time. It's useful with low CPU power " \
90     "but it can produce distorted pictures.")
91
92 #define SKIP_FRAME_TEXT N_("Skip frame (default=0)")
93 #define SKIP_FRAME_LONGTEXT N_( \
94     "Force skipping of frames to speed up decoding " \
95     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
96
97 #define SKIP_IDCT_TEXT N_("Skip idct (default=0)")
98 #define SKIP_IDCT_LONGTEXT N_( \
99     "Force skipping of idct to speed up decoding for frame types" \
100     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
101
102 #define DEBUG_TEXT N_( "Debug mask" )
103 #define DEBUG_LONGTEXT N_( "Set ffmpeg debug mask" )
104
105 /* TODO: Use a predefined list, with 0,1,2,4,7 */
106 #define VISMV_TEXT N_( "Visualize motion vectors" )
107 #define VISMV_LONGTEXT N_( \
108     "You can overlay the motion vectors (arrows showing how the images move) "\
109     "on the image. This value is a mask, based on these values:\n"\
110     "1 - visualize forward predicted MVs of P frames\n" \
111     "2 - visualize forward predicted MVs of B frames\n" \
112     "4 - visualize backward predicted MVs of B frames\n" \
113     "To visualize all vectors, the value should be 7." )
114
115 #define LOWRES_TEXT N_( "Low resolution decoding" )
116 #define LOWRES_LONGTEXT N_( "Only decode a low resolution version of " \
117     "the video. This requires less processing power" )
118
119 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
120 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
121     "usually has a detrimental effect on quality. However it provides a big " \
122     "speedup for high definition streams." )
123
124 /*
125  * Encoder options
126  */
127 #define ENC_CFG_PREFIX "sout-ffmpeg-"
128
129 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
130 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
131   "that will be coded for one key frame." )
132
133 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
134 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
135   "B frames that will be coded between two reference frames." )
136
137 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
138 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
139
140 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
141 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
142   "algorithms for interlaced frames." )
143
144 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
145 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
146   "motion estimation algorithms. This requires more CPU." )
147
148 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
149 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
150   "estimation algorithm.")
151
152 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
153 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
154   "buffer size (in kbytes). A bigger buffer will allow for better rate " \
155   "control, but will cause a delay in the stream." )
156
157 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
158 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
159   "buffer aggressiveness." )
160
161 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
162 #define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
163   "Quantization factor of I frames, compared with P frames (for instance " \
164   "1.0 => same qscale for I and P frames)." )
165
166 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
167 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
168   "reduction algorithm to lower the encoding length and bitrate, at the " \
169   "expense of lower quality frames." )
170
171 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
172 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
173   "quantization matrix for MPEG2 encoding. This generally yields a " \
174   "better looking picture, while still retaining the compatibility with " \
175   "standard MPEG2 decoders.")
176
177 #define ENC_HQ_TEXT N_( "Quality level" )
178 #define ENC_HQ_LONGTEXT N_( "Quality level " \
179   "for the encoding of motions vectors (this can slow down the encoding " \
180   "very much)." )
181
182 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
183 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
184   "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
185   "the encoding rate. It will disable trellis quantization, then the rate " \
186   "distortion of motion vectors (hq), and raise the noise reduction " \
187   "threshold to ease the encoder's task." )
188
189 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
190 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
191   "quantizer scale." )
192
193 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
194 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
195   "quantizer scale." )
196
197 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
198 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
199   "quantization (rate distortion for block coefficients)." )
200
201 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
202 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
203   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
204
205 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
206 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
207   "compliance when encoding (accepted values: -1, 0, 1)." )
208
209 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
210 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
211   "very bright macroblocks (default: 0.0)." )
212
213 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
214 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
215   "very dark macroblocks (default: 0.0)." )
216
217 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
218 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
219   "macroblocks with a high temporal complexity (default: 0.0)." )
220
221 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
222 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
223   "for macroblocks at the border of the frame (default: 0.0)." )
224
225 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
226 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
227   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
228   "recommends -4." )
229
230 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
231 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
232   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
233   "recommends 7." )
234
235 #if LIBAVCODEC_VERSION_INT >= ((51<<16)+(40<<8)+4)
236 #define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
237 #define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
238    "for encoding the audio bitstream. It takes the following options: " \
239    "main, low, ssr (not supported) and ltp (default: main)" )
240 #endif
241
242 #define FFMPEG_COMMON_MEMBERS   \
243     int i_cat;                  \
244     int i_codec_id;             \
245     const char *psz_namecodec;  \
246     AVCodecContext *p_context;  \
247     AVCodec        *p_codec;
248