13524dd9e5df6f45182335735876dcbfb0cddabf
[vlc.git] / modules / codec / avcodec / avcodec.c
1 /*****************************************************************************
2  * avcodec.c: video and audio decoder and encoder using libavcodec
3  *****************************************************************************
4  * Copyright (C) 1999-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *          Gildas Bazin <gbazin@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_codec.h>
35 #include <vlc_avcodec.h>
36
37 /* ffmpeg header */
38 #define HAVE_MMX 1
39 #ifdef HAVE_LIBAVCODEC_AVCODEC_H
40 #   include <libavcodec/avcodec.h>
41 #elif defined(HAVE_FFMPEG_AVCODEC_H)
42 #   include <ffmpeg/avcodec.h>
43 #else
44 #   include <avcodec.h>
45 #endif
46
47 #if LIBAVCODEC_BUILD < 5000
48 #   error You must have a libavcodec >= 5000 (get svn)
49 #endif
50
51 #include "avcodec.h"
52 #include "avutil.h"
53
54 /*****************************************************************************
55  * decoder_sys_t: decoder descriptor
56  *****************************************************************************/
57 struct decoder_sys_t
58 {
59     /* Common part between video and audio decoder */
60     FFMPEG_COMMON_MEMBERS
61 };
62
63 /****************************************************************************
64  * Local prototypes
65  ****************************************************************************/
66 static int OpenDecoder( vlc_object_t * );
67 static void CloseDecoder( vlc_object_t * );
68
69 static const int  nloopf_list[] = { 0, 1, 2, 3, 4 };
70 static const char *const nloopf_list_text[] =
71   { N_("None"), N_("Non-ref"), N_("Bidir"), N_("Non-key"), N_("All") };
72
73 #ifdef ENABLE_SOUT
74 static const char *const enc_hq_list[] = { "rd", "bits", "simple" };
75 static const char *const enc_hq_list_text[] = {
76     N_("rd"), N_("bits"), N_("simple") };
77 #endif
78
79 /*****************************************************************************
80  * Module descriptor
81  *****************************************************************************/
82 #define MODULE_DESCRIPTION N_( "Various audio and video decoders/encoders" \
83         "delivered by the FFmpeg library. This includes (MS)MPEG4, DivX, SV1,"\
84         "H261, H263, H264, WMV, WMA, AAC, AMR, DV, MJPEG and other codecs")
85
86 vlc_module_begin ()
87     set_shortname( "FFmpeg")
88     add_shortcut( "ffmpeg" )
89     set_category( CAT_INPUT )
90     set_subcategory( SUBCAT_INPUT_SCODEC )
91     /* decoder main module */
92 #if defined(MODULE_NAME_is_ffmpegaltivec) \
93      || (defined(CAN_COMPILE_ALTIVEC) && !defined(NO_ALTIVEC_IN_FFMPEG))
94     set_description( N_("AltiVec FFmpeg audio/video decoder ((MS)MPEG4,SVQ1,H263,WMV,WMA)") )
95     /*add_requirement( ALTIVEC )*/
96     set_capability( "decoder", 71 )
97 #else
98     set_description( N_("FFmpeg audio/video decoder") )
99     set_help( MODULE_DESCRIPTION )
100     set_capability( "decoder", 70 )
101 #endif
102     set_section( N_("Decoding") , NULL )
103     set_callbacks( OpenDecoder, CloseDecoder )
104
105
106     add_bool( "ffmpeg-dr", 1, NULL, DR_TEXT, DR_TEXT, true )
107     add_integer ( "ffmpeg-error-resilience", 1, NULL, ERROR_TEXT,
108         ERROR_LONGTEXT, true )
109     add_integer ( "ffmpeg-workaround-bugs", 1, NULL, BUGS_TEXT, BUGS_LONGTEXT,
110         false )
111     add_bool( "ffmpeg-hurry-up", 1, NULL, HURRYUP_TEXT, HURRYUP_LONGTEXT,
112         false )
113     add_integer( "ffmpeg-skip-frame", 0, NULL, SKIP_FRAME_TEXT,
114         SKIP_FRAME_LONGTEXT, true )
115         change_integer_range( -1, 4 )
116     add_integer( "ffmpeg-skip-idct", 0, NULL, SKIP_IDCT_TEXT,
117         SKIP_IDCT_LONGTEXT, true )
118         change_integer_range( -1, 4 )
119     add_integer ( "ffmpeg-vismv", 0, NULL, VISMV_TEXT, VISMV_LONGTEXT,
120         true )
121     add_integer ( "ffmpeg-lowres", 0, NULL, LOWRES_TEXT, LOWRES_LONGTEXT,
122         true )
123         change_integer_range( 0, 2 )
124     add_bool( "ffmpeg-fast", 0, NULL, FAST_TEXT, FAST_LONGTEXT, true )
125     add_integer ( "ffmpeg-skiploopfilter", 0, NULL, SKIPLOOPF_TEXT,
126                   SKIPLOOPF_LONGTEXT, true )
127         change_safe ()
128         change_integer_list( nloopf_list, nloopf_list_text, NULL )
129
130     add_integer( "ffmpeg-debug", 0, NULL, DEBUG_TEXT, DEBUG_LONGTEXT,
131                  true )
132 #ifdef HAVE_AVCODEC_VAAPI
133     add_bool( "ffmpeg-hw", true, NULL, HW_TEXT, HW_LONGTEXT, true )
134 #endif
135
136 #ifdef ENABLE_SOUT
137     /* encoder submodule */
138     add_submodule ()
139     add_shortcut( "ffmpeg" )
140     set_section( N_("Encoding") , NULL )
141     set_description( N_("FFmpeg audio/video encoder") )
142     set_capability( "encoder", 100 )
143     set_callbacks( OpenEncoder, CloseEncoder )
144
145     add_string( ENC_CFG_PREFIX "hq", "simple", NULL, ENC_HQ_TEXT,
146                 ENC_HQ_LONGTEXT, false )
147         change_string_list( enc_hq_list, enc_hq_list_text, 0 )
148     add_integer( ENC_CFG_PREFIX "keyint", 0, NULL, ENC_KEYINT_TEXT,
149                  ENC_KEYINT_LONGTEXT, false )
150     add_integer( ENC_CFG_PREFIX "bframes", 0, NULL, ENC_BFRAMES_TEXT,
151                  ENC_BFRAMES_LONGTEXT, false )
152     add_bool( ENC_CFG_PREFIX "hurry-up", 0, NULL, ENC_HURRYUP_TEXT,
153               ENC_HURRYUP_LONGTEXT, false )
154     add_bool( ENC_CFG_PREFIX "interlace", 0, NULL, ENC_INTERLACE_TEXT,
155               ENC_INTERLACE_LONGTEXT, true )
156     add_bool( ENC_CFG_PREFIX "interlace-me", 1, NULL, ENC_INTERLACE_ME_TEXT,
157               ENC_INTERLACE_ME_LONGTEXT, true )
158     add_integer( ENC_CFG_PREFIX "vt", 0, NULL, ENC_VT_TEXT,
159                  ENC_VT_LONGTEXT, true )
160     add_bool( ENC_CFG_PREFIX "pre-me", 0, NULL, ENC_PRE_ME_TEXT,
161               ENC_PRE_ME_LONGTEXT, true )
162     add_integer( ENC_CFG_PREFIX "rc-buffer-size", 224*1024*8, NULL,
163                  ENC_RC_BUF_TEXT, ENC_RC_BUF_LONGTEXT, true )
164     add_float( ENC_CFG_PREFIX "rc-buffer-aggressivity", 1.0, NULL,
165                ENC_RC_BUF_AGGR_TEXT, ENC_RC_BUF_AGGR_LONGTEXT, true )
166     add_float( ENC_CFG_PREFIX "i-quant-factor", 0, NULL,
167                ENC_IQUANT_FACTOR_TEXT, ENC_IQUANT_FACTOR_LONGTEXT, true )
168     add_integer( ENC_CFG_PREFIX "noise-reduction", 0, NULL,
169                  ENC_NOISE_RED_TEXT, ENC_NOISE_RED_LONGTEXT, true )
170     add_bool( ENC_CFG_PREFIX "mpeg4-matrix", 0, NULL,
171               ENC_MPEG4_MATRIX_TEXT, ENC_MPEG4_MATRIX_LONGTEXT, true )
172     add_integer( ENC_CFG_PREFIX "qmin", 0, NULL,
173                  ENC_QMIN_TEXT, ENC_QMIN_LONGTEXT, true )
174     add_integer( ENC_CFG_PREFIX "qmax", 0, NULL,
175                  ENC_QMAX_TEXT, ENC_QMAX_LONGTEXT, true )
176     add_bool( ENC_CFG_PREFIX "trellis", 0, NULL,
177               ENC_TRELLIS_TEXT, ENC_TRELLIS_LONGTEXT, true )
178     add_float( ENC_CFG_PREFIX "qscale", 0, NULL,
179                ENC_QSCALE_TEXT, ENC_QSCALE_LONGTEXT, true )
180     add_integer( ENC_CFG_PREFIX "strict", 0, NULL,
181                  ENC_STRICT_TEXT, ENC_STRICT_LONGTEXT, true )
182     add_float( ENC_CFG_PREFIX "lumi-masking", 0.0, NULL,
183                ENC_LUMI_MASKING_TEXT, ENC_LUMI_MASKING_LONGTEXT, true )
184     add_float( ENC_CFG_PREFIX "dark-masking", 0.0, NULL,
185                ENC_DARK_MASKING_TEXT, ENC_DARK_MASKING_LONGTEXT, true )
186     add_float( ENC_CFG_PREFIX "p-masking", 0.0, NULL,
187                ENC_P_MASKING_TEXT, ENC_P_MASKING_LONGTEXT, true )
188     add_float( ENC_CFG_PREFIX "border-masking", 0.0, NULL,
189                ENC_BORDER_MASKING_TEXT, ENC_BORDER_MASKING_LONGTEXT, true )
190     add_integer( ENC_CFG_PREFIX "luma-elim-threshold", 0, NULL,
191                  ENC_LUMA_ELIM_TEXT, ENC_LUMA_ELIM_LONGTEXT, true )
192     add_integer( ENC_CFG_PREFIX "chroma-elim-threshold", 0, NULL,
193                  ENC_CHROMA_ELIM_TEXT, ENC_CHROMA_ELIM_LONGTEXT, true )
194
195 #if LIBAVCODEC_VERSION_INT >= ((51<<16)+(40<<8)+4)
196     /* Audio AAC encoder profile */
197     add_string( ENC_CFG_PREFIX "aac-profile", "low", NULL,
198                 ENC_PROFILE_TEXT, ENC_PROFILE_LONGTEXT, true )
199 #endif
200 #endif /* ENABLE_SOUT */
201
202     /* video filter submodule */
203     add_submodule ()
204     set_capability( "video filter2", 0 )
205     set_callbacks( OpenDeinterlace, CloseDeinterlace )
206     set_description( N_("FFmpeg deinterlace video filter") )
207     add_shortcut( "ffmpeg-deinterlace" )
208
209 vlc_module_end ()
210
211 /*****************************************************************************
212  * OpenDecoder: probe the decoder and return score
213  *****************************************************************************/
214 static int OpenDecoder( vlc_object_t *p_this )
215 {
216     decoder_t *p_dec = (decoder_t*) p_this;
217     int i_cat, i_codec_id, i_result;
218     const char *psz_namecodec;
219
220     AVCodecContext *p_context = NULL;
221     AVCodec        *p_codec = NULL;
222
223     /* *** determine codec type *** */
224     if( !GetFfmpegCodec( p_dec->fmt_in.i_codec, &i_cat, &i_codec_id,
225                              &psz_namecodec ) )
226     {
227         return VLC_EGENERIC;
228     }
229
230     /* Initialization must be done before avcodec_find_decoder() */
231     InitLibavcodec(p_this);
232
233     /* *** ask ffmpeg for a decoder *** */
234     p_codec = avcodec_find_decoder( i_codec_id );
235     if( !p_codec )
236     {
237         msg_Dbg( p_dec, "codec not found (%s)", psz_namecodec );
238         return VLC_EGENERIC;
239     }
240
241     /* *** get a p_context *** */
242     p_context = avcodec_alloc_context();
243     if( !p_context )
244         return VLC_ENOMEM;
245     p_context->debug = config_GetInt( p_dec, "ffmpeg-debug" );
246     p_context->opaque = (void *)p_this;
247
248     /* Set CPU capabilities */
249     unsigned i_cpu = vlc_CPU();
250     p_context->dsp_mask = 0;
251     if( !(i_cpu & CPU_CAPABILITY_MMX) )
252     {
253         p_context->dsp_mask |= FF_MM_MMX;
254     }
255     if( !(i_cpu & CPU_CAPABILITY_MMXEXT) )
256     {
257         p_context->dsp_mask |= FF_MM_MMXEXT;
258     }
259     if( !(i_cpu & CPU_CAPABILITY_3DNOW) )
260     {
261         p_context->dsp_mask |= FF_MM_3DNOW;
262     }
263     if( !(i_cpu & CPU_CAPABILITY_SSE) )
264     {
265         p_context->dsp_mask |= FF_MM_SSE;
266     }
267     if( !(i_cpu & CPU_CAPABILITY_SSE2) )
268     {
269         p_context->dsp_mask |= FF_MM_SSE2;
270     }
271
272     p_dec->b_need_packetized = true;
273     switch( i_cat )
274     {
275     case VIDEO_ES:
276         p_dec->pf_decode_video = DecodeVideo;
277         i_result =  InitVideoDec ( p_dec, p_context, p_codec,
278                                        i_codec_id, psz_namecodec );
279         break;
280     case AUDIO_ES:
281         p_dec->pf_decode_audio = DecodeAudio;
282         i_result =  InitAudioDec ( p_dec, p_context, p_codec,
283                                        i_codec_id, psz_namecodec );
284         break;
285     default:
286         i_result = VLC_EGENERIC;
287     }
288
289     if( i_result == VLC_SUCCESS ) p_dec->p_sys->i_cat = i_cat;
290
291     return i_result;
292 }
293
294 /*****************************************************************************
295  * CloseDecoder: decoder destruction
296  *****************************************************************************/
297 static void CloseDecoder( vlc_object_t *p_this )
298 {
299     decoder_t *p_dec = (decoder_t *)p_this;
300     decoder_sys_t *p_sys = p_dec->p_sys;
301
302     switch( p_sys->i_cat )
303     {
304     case AUDIO_ES:
305          EndAudioDec ( p_dec );
306         break;
307     case VIDEO_ES:
308          EndVideoDec ( p_dec );
309         break;
310     }
311
312     if( p_sys->p_context )
313     {
314         free( p_sys->p_context->extradata );
315         p_sys->p_context->extradata = NULL;
316
317         if( !p_sys->b_delayed_open )
318         {
319             vlc_avcodec_lock();
320             avcodec_close( p_sys->p_context );
321             vlc_avcodec_unlock();
322         }
323         msg_Dbg( p_dec, "ffmpeg codec (%s) stopped", p_sys->psz_namecodec );
324         av_free( p_sys->p_context );
325     }
326
327     free( p_sys );
328 }
329
330 void InitLibavcodec( vlc_object_t *p_object )
331 {
332     static bool b_ffmpeginit = false;
333
334     vlc_avcodec_lock();
335
336     /* *** init ffmpeg library (libavcodec) *** */
337     if( !b_ffmpeginit )
338     {
339         avcodec_init();
340         avcodec_register_all();
341         av_log_set_callback( LibavutilCallback );
342         b_ffmpeginit = true;
343
344         msg_Dbg( p_object, "libavcodec initialized (interface 0x%x)",
345                  LIBAVCODEC_VERSION_INT );
346     }
347     else
348     {
349         msg_Dbg( p_object, "libavcodec already initialized" );
350     }
351
352     vlc_avcodec_unlock();
353 }