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