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