git.sesse.net Git - vlc/blob - modules/codec/avcodec/avcodec.h

   1 /*****************************************************************************
   2  * avcodec.h: decoder and encoder using libavcodec
   3  *****************************************************************************
   4  * Copyright (C) 2001-2008 VLC authors and VideoLAN
   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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #include "chroma.h"
  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 vlc_fourcc_t GetVlcAudioFormat( int i_sample_fmt );
  31
  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 ** );
  35
  36 /* Video encoder module */
  37 int  OpenEncoder ( vlc_object_t * );
  38 void CloseEncoder( vlc_object_t * );
  39
  40 /* Audio encoder module */
  41 int  OpenAudioEncoder ( vlc_object_t * );
  42 void CloseAudioEncoder( vlc_object_t * );
  43
  44 /* Deinterlace video filter module */
  45 int  OpenDeinterlace( vlc_object_t * );
  46 void CloseDeinterlace( vlc_object_t * );
  47
  48 /* Video Decoder */
  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 );
  52
  53 /* Audio Decoder */
  54 int InitAudioDec( decoder_t *p_dec, AVCodecContext *p_context,
  55                   AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
  56
  57 /* Subtitle Decoder */
  58 int InitSubtitleDec( decoder_t *p_dec, AVCodecContext *p_context,
  59                      AVCodec *p_codec, int i_codec_id, const char *psz_namecodec );
  60 void EndSubtitleDec( decoder_t *p_dec );
  61
  62 /* Initialize decoder */
  63 int ffmpeg_OpenCodec( decoder_t *p_dec );
  64
  65 /*****************************************************************************
  66  * Module descriptor help strings
  67  *****************************************************************************/
  68 #define DR_TEXT N_("Direct rendering")
  69 /* FIXME Does somebody who knows what it does, explain */
  70 #define DR_LONGTEXT N_("Direct rendering")
  71
  72 #define ERROR_TEXT N_("Error resilience")
  73 #define ERROR_LONGTEXT N_( \
  74     "libavcodec can do error resilience.\n" \
  75     "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
  76     "this can produce a lot of errors.\n" \
  77     "Valid values range from 0 to 4 (0 disables all errors resilience).")
  78
  79 #define BUGS_TEXT N_("Workaround bugs")
  80 #define BUGS_LONGTEXT N_( \
  81     "Try to fix some bugs:\n" \
  82     "1  autodetect\n" \
  83     "2  old msmpeg4\n" \
  84     "4  xvid interlaced\n" \
  85     "8  ump4 \n" \
  86     "16 no padding\n" \
  87     "32 ac vlc\n" \
  88     "64 Qpel chroma.\n" \
  89     "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
  90     "\"ump4\", enter 40.")
  91
  92 #define HURRYUP_TEXT N_("Hurry up")
  93 #define HURRYUP_LONGTEXT N_( \
  94     "The decoder can partially decode or skip frame(s) " \
  95     "when there is not enough time. It's useful with low CPU power " \
  96     "but it can produce distorted pictures.")
  97
  98 #define FAST_TEXT N_("Allow speed tricks")
  99 #define FAST_LONGTEXT N_( \
 100     "Allow non specification compliant speedup tricks. Faster but error-prone.")
 101
 102 #define SKIP_FRAME_TEXT N_("Skip frame (default=0)")
 103 #define SKIP_FRAME_LONGTEXT N_( \
 104     "Force skipping of frames to speed up decoding " \
 105     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
 106
 107 #define SKIP_IDCT_TEXT N_("Skip idct (default=0)")
 108 #define SKIP_IDCT_LONGTEXT N_( \
 109     "Force skipping of idct to speed up decoding for frame types " \
 110     "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )
 111
 112 #define IGNORECROP_TEXT N_("Discard cropping information")
 113 #define IGNORECROP_LONGTEXT N_("Discard internal cropping parameters (e.g. from H.264 SPS)." )
 114
 115 #define DEBUG_TEXT N_( "Debug mask" )
 116 #define DEBUG_LONGTEXT N_( "Set FFmpeg debug mask" )
 117
 118 #define CODEC_TEXT N_( "Codec name" )
 119 #define CODEC_LONGTEXT N_( "Internal libavcodec codec name" )
 120
 121 /* TODO: Use a predefined list, with 0,1,2,4,7 */
 122 #define VISMV_TEXT N_( "Visualize motion vectors" )
 123 #define VISMV_LONGTEXT N_( \
 124     "You can overlay the motion vectors (arrows showing how the images move) "\
 125     "on the image. This value is a mask, based on these values:\n"\
 126     "1 - visualize forward predicted MVs of P frames\n" \
 127     "2 - visualize forward predicted MVs of B frames\n" \
 128     "4 - visualize backward predicted MVs of B frames\n" \
 129     "To visualize all vectors, the value should be 7." )
 130
 131 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
 132 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
 133     "usually has a detrimental effect on quality. However it provides a big " \
 134     "speedup for high definition streams." )
 135
 136 #define HW_TEXT N_("Hardware decoding")
 137 #define HW_LONGTEXT N_("This allows hardware decoding when available.")
 138
 139 #define VDA_PIX_FMT_TEXT N_("VDA output pixel format")
 140 #define VDA_PIX_FMT_LONGTEXT N_("The pixel format for output image buffers.")
 141
 142 #define THREADS_TEXT N_( "Threads" )
 143 #define THREADS_LONGTEXT N_( "Number of threads used for decoding, 0 meaning auto" )
 144
 145 /*
 146  * Encoder options
 147  */
 148 #define ENC_CFG_PREFIX "sout-avcodec-"
 149
 150 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
 151 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
 152   "that will be coded for one key frame." )
 153
 154 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
 155 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
 156   "B frames that will be coded between two reference frames." )
 157
 158 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
 159 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
 160
 161 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
 162 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
 163   "algorithms for interlaced frames." )
 164
 165 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
 166 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
 167   "motion estimation algorithms. This requires more CPU." )
 168
 169 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
 170 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
 171   "estimation algorithm.")
 172
 173 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
 174 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
 175   "buffer size (in kbytes). A bigger buffer will allow for better rate " \
 176   "control, but will cause a delay in the stream." )
 177
 178 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
 179 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
 180   "buffer aggressiveness." )
 181
 182 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
 183 #define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
 184   "Quantization factor of I frames, compared with P frames (for instance " \
 185   "1.0 => same qscale for I and P frames)." )
 186
 187 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
 188 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
 189   "reduction algorithm to lower the encoding length and bitrate, at the " \
 190   "expense of lower quality frames." )
 191
 192 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
 193 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
 194   "quantization matrix for MPEG2 encoding. This generally yields a " \
 195   "better looking picture, while still retaining the compatibility with " \
 196   "standard MPEG2 decoders.")
 197
 198 #define ENC_HQ_TEXT N_( "Quality level" )
 199 #define ENC_HQ_LONGTEXT N_( "Quality level " \
 200   "for the encoding of motions vectors (this can slow down the encoding " \
 201   "very much)." )
 202
 203 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
 204 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
 205   "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
 206   "the encoding rate. It will disable trellis quantization, then the rate " \
 207   "distortion of motion vectors (hq), and raise the noise reduction " \
 208   "threshold to ease the encoder's task." )
 209
 210 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
 211 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
 212   "quantizer scale." )
 213
 214 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
 215 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
 216   "quantizer scale." )
 217
 218 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
 219 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
 220   "quantization (rate distortion for block coefficients)." )
 221
 222 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
 223 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
 224   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
 225
 226 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
 227 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
 228   "compliance when encoding (accepted values: -2 to 2)." )
 229
 230 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
 231 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 232   "very bright macroblocks (default: 0.0)." )
 233
 234 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
 235 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 236   "very dark macroblocks (default: 0.0)." )
 237
 238 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
 239 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 240   "macroblocks with a high temporal complexity (default: 0.0)." )
 241
 242 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
 243 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
 244   "for macroblocks at the border of the frame (default: 0.0)." )
 245
 246 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
 247 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
 248   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 249   "recommends -4." )
 250
 251 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
 252 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
 253   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 254   "recommends 7." )
 255
 256 #define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
 257 #define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
 258    "for encoding the audio bitstream. It takes the following options: " \
 259    "main, low, ssr (not supported),ltp, hev1, hev2 (default: low). " \
 260    "hev1 and hev2 are currently supported only with libfdk-aac enabled libavcodec" )
 261
 262 #define AVCODEC_COMMON_MEMBERS   \
 263     int i_cat;                  \
 264     int i_codec_id;             \
 265     const char *psz_namecodec;  \
 266     AVCodecContext *p_context;  \
 267     AVCodec        *p_codec;    \
 268     bool b_delayed_open;
 269
 270 #ifndef AV_VERSION_INT
 271 #   define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
 272 #endif
 273
 274 #if defined(FF_THREAD_FRAME)
 275 #   define HAVE_AVCODEC_MT
 276 #endif
 277
 278
 279 /* LIBAVCODEC_VERSION_CHECK checks for the right version of libav and FFmpeg
 280  * a is the major version
 281  * b and c the minor and micro versions of libav
 282  * d and e the minor and micro versions of FFmpeg */
 283 #define LIBAVCODEC_VERSION_CHECK( a, b, c, d, e ) \
 284     (LIBAVCODEC_VERSION_MICRO <  100 && LIBAVCODEC_VERSION_INT >= AV_VERSION_INT( a, b, c ) ) || \
 285     (LIBAVCODEC_VERSION_MICRO >= 100 && LIBAVCODEC_VERSION_INT >= AV_VERSION_INT( a, d, e ) )