1 /*****************************************************************************
2 * avcodec.c: video and audio decoder and encoder using libavcodec
3 *****************************************************************************
4 * Copyright (C) 1999-2008 VLC authors and VideoLAN
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Gildas Bazin <gbazin@videolan.org>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_codec.h>
35 #include <vlc_avcodec.h>
39 #include <libavcodec/avcodec.h>
45 #if LIBAVCODEC_VERSION_INT < AV_VERSION_INT( 53, 34, 0 )
46 # error You must update libavcodec to a version >= 53.34.0
47 #elif LIBAVCODEC_VERSION_INT < AV_VERSION_INT( 54, 25, 0 )
48 # warning You should update libavcodec to a version >= 54.25.0
51 /*****************************************************************************
52 * decoder_sys_t: decoder descriptor
53 *****************************************************************************/
56 /* Common part between video and audio decoder */
57 AVCODEC_COMMON_MEMBERS
60 /****************************************************************************
62 ****************************************************************************/
63 static int OpenDecoder( vlc_object_t * );
64 static void CloseDecoder( vlc_object_t * );
66 static const int nloopf_list[] = { 0, 1, 2, 3, 4 };
67 static const char *const nloopf_list_text[] =
68 { N_("None"), N_("Non-ref"), N_("Bidir"), N_("Non-key"), N_("All") };
71 static const char *const enc_hq_list[] = { "rd", "bits", "simple" };
72 static const char *const enc_hq_list_text[] = {
73 N_("rd"), N_("bits"), N_("simple") };
77 # include "../../demux/avformat/avformat.h"
78 # include "../../access/avio.h"
81 /*****************************************************************************
83 *****************************************************************************/
84 #define MODULE_DESCRIPTION N_( "Various audio and video decoders/encoders " \
85 "delivered by the FFmpeg library. This includes (MS)MPEG4, DivX, SV1,"\
86 "H261, H263, H264, WMV, WMA, AAC, AMR, DV, MJPEG and other codecs")
89 set_shortname( "FFmpeg")
90 add_shortcut( "ffmpeg" )
91 set_category( CAT_INPUT )
92 set_subcategory( SUBCAT_INPUT_VCODEC )
93 /* decoder main module */
94 set_description( N_("FFmpeg audio/video decoder") )
95 set_help( MODULE_DESCRIPTION )
96 set_capability( "decoder", 70 )
97 set_section( N_("Decoding") , NULL )
98 set_callbacks( OpenDecoder, CloseDecoder )
101 add_obsolete_bool( "ffmpeg-dr" ) /* removed since 2.1.0 */
102 add_bool( "avcodec-dr", true, DR_TEXT, DR_TEXT, true )
103 add_obsolete_integer ( "ffmpeg-error-resilience" ) /* removed since 2.1.0 */
104 add_integer ( "avcodec-error-resilience", 1, ERROR_TEXT,
105 ERROR_LONGTEXT, true )
106 add_obsolete_integer ( "ffmpeg-workaround-bugs" ) /* removed since 2.1.0 */
107 add_integer ( "avcodec-workaround-bugs", 1, BUGS_TEXT, BUGS_LONGTEXT,
109 add_obsolete_bool( "ffmpeg-hurry-up" ) /* removed since 2.1.0 */
110 add_bool( "avcodec-hurry-up", true, HURRYUP_TEXT, HURRYUP_LONGTEXT,
112 add_obsolete_integer( "ffmpeg-skip-frame") /* removed since 2.1.0 */
113 add_integer( "avcodec-skip-frame", 0, SKIP_FRAME_TEXT,
114 SKIP_FRAME_LONGTEXT, true )
115 change_integer_range( -1, 4 )
116 add_obsolete_integer( "ffmpeg-skip-idct" ) /* removed since 2.1.0 */
117 add_integer( "avcodec-skip-idct", 0, SKIP_IDCT_TEXT,
118 SKIP_IDCT_LONGTEXT, true )
119 change_integer_range( -1, 4 )
120 add_obsolete_integer ( "ffmpeg-vismv" ) /* removed since 2.1.0 */
121 add_integer ( "avcodec-vismv", 0, VISMV_TEXT, VISMV_LONGTEXT,
123 add_obsolete_integer ( "ffmpeg-lowres" ) /* removed since 2.1.0 */
124 add_obsolete_bool( "ffmpeg-fast" ) /* removed since 2.1.0 */
125 add_bool( "avcodec-fast", false, FAST_TEXT, FAST_LONGTEXT, false )
126 add_obsolete_integer ( "ffmpeg-skiploopfilter" ) /* removed since 2.1.0 */
127 add_integer ( "avcodec-skiploopfilter", 0, SKIPLOOPF_TEXT,
128 SKIPLOOPF_LONGTEXT, false)
130 change_integer_list( nloopf_list, nloopf_list_text )
131 #if LIBAVCODEC_VERSION_INT >= AV_VERSION_INT( 54, 41, 0 )
132 add_bool( "avcodec-ignorecrop", false, IGNORECROP_TEXT, IGNORECROP_LONGTEXT,
136 add_obsolete_integer( "ffmpeg-debug" ) /* removed since 2.1.0 */
137 add_integer( "avcodec-debug", 0, DEBUG_TEXT, DEBUG_LONGTEXT,
139 add_obsolete_string( "ffmpeg-codec" ) /* removed since 2.1.0 */
140 add_string( "avcodec-codec", NULL, CODEC_TEXT, CODEC_LONGTEXT, true )
141 add_obsolete_bool( "ffmpeg-hw" ) /* removed since 2.1.0 */
142 add_module( "avcodec-hw", "hw decoder", "none", HW_TEXT, HW_LONGTEXT, false )
143 #if defined(FF_THREAD_FRAME)
144 add_obsolete_integer( "ffmpeg-threads" ) /* removed since 2.1.0 */
145 add_integer( "avcodec-threads", 0, THREADS_TEXT, THREADS_LONGTEXT, true );
147 add_string( "avcodec-options", NULL, AV_OPTIONS_TEXT, AV_OPTIONS_LONGTEXT, true )
151 /* encoder submodule */
153 add_shortcut( "ffmpeg" )
154 set_section( N_("Encoding") , NULL )
155 set_description( N_("FFmpeg audio/video encoder") )
156 set_capability( "encoder", 100 )
157 set_callbacks( OpenEncoder, CloseEncoder )
159 /* removed in 2.1.0 */
160 add_obsolete_string( "sout-ffmpeg-codec" )
161 add_obsolete_string( "sout-ffmpeg-hq" )
162 add_obsolete_integer( "sout-ffmpeg-keyint" )
163 add_obsolete_integer( "sout-ffmpeg-bframes" )
164 add_obsolete_bool( "sout-ffmpeg-hurry-up" )
165 add_obsolete_bool( "sout-ffmpeg-interlace" )
166 add_obsolete_bool( "sout-ffmpeg-interlace-me" )
167 add_obsolete_integer( "sout-ffmpeg-vt" )
168 add_obsolete_bool( "sout-ffmpeg-pre-me" )
169 add_obsolete_integer( "sout-ffmpeg-rc-buffer-size" )
170 add_obsolete_float( "sout-ffmpeg-rc-buffer-aggressivity" )
171 add_obsolete_float( "sout-ffmpeg-i-quant-factor" )
172 add_obsolete_integer( "sout-ffmpeg-noise-reduction" )
173 add_obsolete_bool( "sout-ffmpeg-mpeg4-matrix" )
174 add_obsolete_integer( "sout-ffmpeg-qmin" )
175 add_obsolete_integer( "sout-ffmpeg-qmax" )
176 add_obsolete_bool( "sout-ffmpeg-trellis" )
177 add_obsolete_float( "sout-ffmpeg-qscale" )
178 add_obsolete_integer( "sout-ffmpeg-strict" )
179 add_obsolete_float( "sout-ffmpeg-lumi-masking" )
180 add_obsolete_float( "sout-ffmpeg-dark-masking" )
181 add_obsolete_float( "sout-ffmpeg-p-masking" )
182 add_obsolete_float( "sout-ffmpeg-border-masking" )
183 add_obsolete_integer( "sout-ffmpeg-luma-elim-threshold" )
184 add_obsolete_integer( "sout-ffmpeg-chroma-elim-threshold" )
185 add_obsolete_string( "sout-ffmpeg-aac-profile" )
188 add_string( ENC_CFG_PREFIX "codec", NULL, CODEC_TEXT, CODEC_LONGTEXT, true )
189 add_string( ENC_CFG_PREFIX "hq", "rd", ENC_HQ_TEXT,
190 ENC_HQ_LONGTEXT, false )
191 change_string_list( enc_hq_list, enc_hq_list_text )
192 add_integer( ENC_CFG_PREFIX "keyint", 0, ENC_KEYINT_TEXT,
193 ENC_KEYINT_LONGTEXT, false )
194 add_integer( ENC_CFG_PREFIX "bframes", 0, ENC_BFRAMES_TEXT,
195 ENC_BFRAMES_LONGTEXT, false )
196 add_bool( ENC_CFG_PREFIX "hurry-up", false, ENC_HURRYUP_TEXT,
197 ENC_HURRYUP_LONGTEXT, false )
198 add_bool( ENC_CFG_PREFIX "interlace", false, ENC_INTERLACE_TEXT,
199 ENC_INTERLACE_LONGTEXT, true )
200 add_bool( ENC_CFG_PREFIX "interlace-me", true, ENC_INTERLACE_ME_TEXT,
201 ENC_INTERLACE_ME_LONGTEXT, true )
202 add_integer( ENC_CFG_PREFIX "vt", 0, ENC_VT_TEXT,
203 ENC_VT_LONGTEXT, true )
204 add_bool( ENC_CFG_PREFIX "pre-me", false, ENC_PRE_ME_TEXT,
205 ENC_PRE_ME_LONGTEXT, true )
206 add_integer( ENC_CFG_PREFIX "rc-buffer-size", 0,
207 ENC_RC_BUF_TEXT, ENC_RC_BUF_LONGTEXT, true )
208 add_float( ENC_CFG_PREFIX "rc-buffer-aggressivity", 1.0,
209 ENC_RC_BUF_AGGR_TEXT, ENC_RC_BUF_AGGR_LONGTEXT, true )
210 add_float( ENC_CFG_PREFIX "i-quant-factor", 0,
211 ENC_IQUANT_FACTOR_TEXT, ENC_IQUANT_FACTOR_LONGTEXT, true )
212 add_integer( ENC_CFG_PREFIX "noise-reduction", 0,
213 ENC_NOISE_RED_TEXT, ENC_NOISE_RED_LONGTEXT, true )
214 add_bool( ENC_CFG_PREFIX "mpeg4-matrix", false,
215 ENC_MPEG4_MATRIX_TEXT, ENC_MPEG4_MATRIX_LONGTEXT, true )
216 add_integer( ENC_CFG_PREFIX "qmin", 0,
217 ENC_QMIN_TEXT, ENC_QMIN_LONGTEXT, true )
218 add_integer( ENC_CFG_PREFIX "qmax", 0,
219 ENC_QMAX_TEXT, ENC_QMAX_LONGTEXT, true )
220 add_bool( ENC_CFG_PREFIX "trellis", false,
221 ENC_TRELLIS_TEXT, ENC_TRELLIS_LONGTEXT, true )
222 add_float( ENC_CFG_PREFIX "qscale", 0,
223 ENC_QSCALE_TEXT, ENC_QSCALE_LONGTEXT, true )
224 add_integer( ENC_CFG_PREFIX "strict", 0,
225 ENC_STRICT_TEXT, ENC_STRICT_LONGTEXT, true )
226 change_integer_range( -2, 2 )
227 add_float( ENC_CFG_PREFIX "lumi-masking", 0.0,
228 ENC_LUMI_MASKING_TEXT, ENC_LUMI_MASKING_LONGTEXT, true )
229 add_float( ENC_CFG_PREFIX "dark-masking", 0.0,
230 ENC_DARK_MASKING_TEXT, ENC_DARK_MASKING_LONGTEXT, true )
231 add_float( ENC_CFG_PREFIX "p-masking", 0.0,
232 ENC_P_MASKING_TEXT, ENC_P_MASKING_LONGTEXT, true )
233 add_float( ENC_CFG_PREFIX "border-masking", 0.0,
234 ENC_BORDER_MASKING_TEXT, ENC_BORDER_MASKING_LONGTEXT, true )
235 add_integer( ENC_CFG_PREFIX "luma-elim-threshold", 0,
236 ENC_LUMA_ELIM_TEXT, ENC_LUMA_ELIM_LONGTEXT, true )
237 add_integer( ENC_CFG_PREFIX "chroma-elim-threshold", 0,
238 ENC_CHROMA_ELIM_TEXT, ENC_CHROMA_ELIM_LONGTEXT, true )
240 /* Audio AAC encoder profile */
241 add_string( ENC_CFG_PREFIX "aac-profile", "low",
242 ENC_PROFILE_TEXT, ENC_PROFILE_LONGTEXT, true )
244 add_string( ENC_CFG_PREFIX "options", NULL, AV_OPTIONS_TEXT, AV_OPTIONS_LONGTEXT, true )
245 #endif /* ENABLE_SOUT */
249 # include "../../demux/avformat/avformat.c"
255 /*****************************************************************************
256 * OpenDecoder: probe the decoder and return score
257 *****************************************************************************/
258 static int OpenDecoder( vlc_object_t *p_this )
260 decoder_t *p_dec = (decoder_t*) p_this;
261 int i_cat, i_codec_id, i_result;
262 const char *psz_namecodec;
264 AVCodecContext *p_context = NULL;
265 AVCodec *p_codec = NULL;
267 /* *** determine codec type *** */
268 if( !GetFfmpegCodec( p_dec->fmt_in.i_codec, &i_cat, &i_codec_id,
274 /* Initialization must be done before avcodec_find_decoder() */
277 /* *** ask ffmpeg for a decoder *** */
278 char *psz_decoder = var_CreateGetString( p_this, "avcodec-codec" );
279 if( psz_decoder && *psz_decoder )
281 p_codec = avcodec_find_decoder_by_name( psz_decoder );
283 msg_Err( p_this, "Decoder `%s' not found", psz_decoder );
284 else if( p_codec->id != i_codec_id )
286 msg_Err( p_this, "Decoder `%s' can't handle %4.4s",
287 psz_decoder, (char*)&p_dec->fmt_in.i_codec );
293 p_codec = avcodec_find_decoder( i_codec_id );
296 msg_Dbg( p_dec, "codec not found (%s)", psz_namecodec );
300 /* *** get a p_context *** */
301 p_context = avcodec_alloc_context3(p_codec);
304 p_context->debug = var_InheritInteger( p_dec, "avcodec-debug" );
305 p_context->opaque = (void *)p_this;
307 /* set CPU capabilities */
308 #if LIBAVUTIL_VERSION_CHECK(51, 25, 0, 42, 100)
309 av_set_cpu_flags_mask( INT_MAX & ~GetVlcDspMask() );
311 p_context->dsp_mask = GetVlcDspMask();
314 p_dec->b_need_packetized = true;
318 p_dec->pf_decode_video = DecodeVideo;
319 i_result = InitVideoDec ( p_dec, p_context, p_codec,
320 i_codec_id, psz_namecodec );
323 p_dec->pf_decode_audio = DecodeAudio;
324 i_result = InitAudioDec ( p_dec, p_context, p_codec,
325 i_codec_id, psz_namecodec );
328 p_dec->pf_decode_sub = DecodeSubtitle;
329 i_result = InitSubtitleDec( p_dec, p_context, p_codec,
330 i_codec_id, psz_namecodec );
333 i_result = VLC_EGENERIC;
336 if( i_result == VLC_SUCCESS )
338 p_dec->p_sys->i_cat = i_cat;
339 if( p_context->profile != FF_PROFILE_UNKNOWN)
340 p_dec->fmt_in.i_profile = p_context->profile;
341 if( p_context->level != FF_LEVEL_UNKNOWN)
342 p_dec->fmt_in.i_level = p_context->level;
348 /*****************************************************************************
349 * CloseDecoder: decoder destruction
350 *****************************************************************************/
351 static void CloseDecoder( vlc_object_t *p_this )
353 decoder_t *p_dec = (decoder_t *)p_this;
354 decoder_sys_t *p_sys = p_dec->p_sys;
356 switch( p_sys->i_cat )
359 EndVideoDec ( p_dec );
363 if( p_sys->p_context )
365 free( p_sys->p_context->extradata );
366 p_sys->p_context->extradata = NULL;
368 if( !p_sys->b_delayed_open )
371 avcodec_close( p_sys->p_context );
372 vlc_avcodec_unlock();
374 msg_Dbg( p_dec, "ffmpeg codec (%s) stopped", p_sys->psz_namecodec );
375 av_free( p_sys->p_context );
381 /*****************************************************************************
383 *****************************************************************************/
384 int ffmpeg_OpenCodec( decoder_t *p_dec )
386 decoder_sys_t *p_sys = p_dec->p_sys;
388 if( p_sys->p_context->extradata_size <= 0 )
390 if( p_sys->i_codec_id == AV_CODEC_ID_VC1 ||
391 p_sys->i_codec_id == AV_CODEC_ID_VORBIS ||
392 p_sys->i_codec_id == AV_CODEC_ID_THEORA ||
393 ( p_sys->i_codec_id == AV_CODEC_ID_AAC &&
394 !p_dec->fmt_in.b_packetized ) )
396 msg_Warn( p_dec, "waiting for extra data for codec %s",
397 p_sys->psz_namecodec );
401 if( p_dec->fmt_in.i_cat == VIDEO_ES )
403 p_sys->p_context->width = p_dec->fmt_in.video.i_width;
404 p_sys->p_context->height = p_dec->fmt_in.video.i_height;
405 p_sys->p_context->bits_per_coded_sample = p_dec->fmt_in.video.i_bits_per_pixel;
407 else if( p_dec->fmt_in.i_cat == AUDIO_ES )
409 p_sys->p_context->sample_rate = p_dec->fmt_in.audio.i_rate;
410 p_sys->p_context->channels = p_dec->fmt_in.audio.i_channels;
412 p_sys->p_context->block_align = p_dec->fmt_in.audio.i_blockalign;
413 p_sys->p_context->bit_rate = p_dec->fmt_in.i_bitrate;
414 p_sys->p_context->bits_per_coded_sample = p_dec->fmt_in.audio.i_bitspersample;
415 if( p_sys->i_codec_id == AV_CODEC_ID_ADPCM_G726 &&
416 p_sys->p_context->bit_rate > 0 &&
417 p_sys->p_context->sample_rate > 0)
418 p_sys->p_context->bits_per_coded_sample = p_sys->p_context->bit_rate /
419 p_sys->p_context->sample_rate;
422 char *psz_opts = var_InheritString( p_dec, "avcodec-options" );
423 AVDictionary *options = NULL;
424 if (psz_opts && *psz_opts)
425 options = vlc_av_get_options(psz_opts);
429 ret = avcodec_open2( p_sys->p_context, p_sys->p_codec, options ? &options : NULL );
430 vlc_avcodec_unlock();
432 AVDictionaryEntry *t = NULL;
433 while ((t = av_dict_get(options, "", t, AV_DICT_IGNORE_SUFFIX))) {
434 msg_Err( p_dec, "Unknown option \"%s\"", t->key );
436 av_dict_free(&options);
440 msg_Dbg( p_dec, "avcodec codec (%s) started", p_sys->psz_namecodec );
442 #ifdef HAVE_AVCODEC_MT
443 if( p_dec->fmt_in.i_cat == VIDEO_ES )
445 switch( p_sys->p_context->active_thread_type )
447 case FF_THREAD_FRAME:
448 msg_Dbg( p_dec, "using frame thread mode with %d threads",
449 p_sys->p_context->thread_count );
451 case FF_THREAD_SLICE:
452 msg_Dbg( p_dec, "using slice thread mode with %d threads",
453 p_sys->p_context->thread_count );
456 if( p_sys->p_context->thread_count > 1 )
457 msg_Warn( p_dec, "failed to enable threaded decoding" );
460 msg_Warn( p_dec, "using unknown thread mode with %d threads",
461 p_sys->p_context->thread_count );
467 p_sys->b_delayed_open = false;