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

   1 /*****************************************************************************
   2  * ffmpeg.h: decoder using the ffmpeg library
   3  *****************************************************************************
   4  * Copyright (C) 2001 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 #include "codecs.h"                                      /* BITMAPINFOHEADER */
  25
  26 #if LIBAVCODEC_BUILD >= 4663
  27 #   define LIBAVCODEC_PP
  28 #else
  29 #   undef  LIBAVCODEC_PP
  30 #endif
  31
  32 struct picture_t;
  33 struct AVFrame;
  34 struct AVCodecContext;
  35 struct AVCodec;
  36
  37 void E_(InitLibavcodec)( vlc_object_t * );
  38 int E_(GetFfmpegCodec) ( vlc_fourcc_t, int *, int *, char ** );
  39 int E_(GetVlcFourcc)   ( int, int *, vlc_fourcc_t *, char ** );
  40 int E_(GetFfmpegChroma)( vlc_fourcc_t );
  41 vlc_fourcc_t E_(GetVlcChroma)( int );
  42
  43 /* Video decoder module */
  44 int  E_( InitVideoDec )( decoder_t *, AVCodecContext *, AVCodec *,
  45                          int, char * );
  46 void E_( EndVideoDec ) ( decoder_t * );
  47 picture_t *E_( DecodeVideo ) ( decoder_t *, block_t ** );
  48
  49 /* Audio decoder module */
  50 int  E_( InitAudioDec )( decoder_t *, AVCodecContext *, AVCodec *,
  51                          int, char * );
  52 void E_( EndAudioDec ) ( decoder_t * );
  53 aout_buffer_t *E_( DecodeAudio ) ( decoder_t *, block_t ** );
  54
  55 /* Chroma conversion module */
  56 int  E_(OpenChroma)( vlc_object_t * );
  57 void E_(CloseChroma)( vlc_object_t * );
  58
  59 /* Video encoder module */
  60 int  E_(OpenEncoder) ( vlc_object_t * );
  61 void E_(CloseEncoder)( vlc_object_t * );
  62
  63 /* Audio encoder module */
  64 int  E_(OpenAudioEncoder) ( vlc_object_t * );
  65 void E_(CloseAudioEncoder)( vlc_object_t * );
  66
  67 /* Demux module */
  68 int  E_(OpenDemux) ( vlc_object_t * );
  69 void E_(CloseDemux)( vlc_object_t * );
  70
  71 /* Mux module */
  72 int  E_(OpenMux) ( vlc_object_t * );
  73 void E_(CloseMux)( vlc_object_t * );
  74
  75 /* Video filter module */
  76 int  E_(OpenFilter)( vlc_object_t * );
  77 int  E_(OpenCropPadd)( vlc_object_t * );
  78 void E_(CloseFilter)( vlc_object_t * );
  79 int  E_(OpenDeinterlace)( vlc_object_t * );
  80 void E_(CloseDeinterlace)( vlc_object_t * );
  81
  82 /* Postprocessing module */
  83 void *E_(OpenPostproc)( decoder_t *, vlc_bool_t * );
  84 int E_(InitPostproc)( decoder_t *, void *, int, int, int );
  85 int E_(PostprocPict)( decoder_t *, void *, picture_t *, AVFrame * );
  86 void E_(ClosePostproc)( decoder_t *, void * );
  87
  88 /*****************************************************************************
  89  * Module descriptor help strings
  90  *****************************************************************************/
  91 #define DR_TEXT N_("Direct rendering")
  92 /* FIXME Does somebody who knows what it does, explain */
  93 #define DR_LONGTEXT N_("Direct rendering")
  94
  95 #define ERROR_TEXT N_("Error resilience")
  96 #define ERROR_LONGTEXT N_( \
  97     "Ffmpeg can do error resilience.\n" \
  98     "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
  99     "this can produce a lot of errors.\n" \
 100     "Valid values range from 0 to 4 (0 disables all errors resilience).")
 101
 102 #define BUGS_TEXT N_("Workaround bugs")
 103 #define BUGS_LONGTEXT N_( \
 104     "Try to fix some bugs:\n" \
 105     "1  autodetect\n" \
 106     "2  old msmpeg4\n" \
 107     "4  xvid interlaced\n" \
 108     "8  ump4 \n" \
 109     "16 no padding\n" \
 110     "32 ac vlc\n" \
 111     "64 Qpel chroma.\n" \
 112     "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
 113     "\"ump4\", enter 40.")
 114
 115 #define HURRYUP_TEXT N_("Hurry up")
 116 #define HURRYUP_LONGTEXT N_( \
 117     "The decoder can partially decode or skip frame(s) " \
 118     "when there is not enough time. It's useful with low CPU power " \
 119     "but it can produce distorted pictures.")
 120
 121 #define PP_Q_TEXT N_("Post processing quality")
 122 #define PP_Q_LONGTEXT N_( \
 123     "Quality of post processing. Valid range is 0 to 6\n" \
 124     "Higher levels require considerable more CPU power, but produce " \
 125     "better looking pictures." )
 126
 127 #define DEBUG_TEXT N_( "Debug mask" )
 128 #define DEBUG_LONGTEXT N_( "Set ffmpeg debug mask" )
 129
 130 /* TODO: Use a predefined list, with 0,1,2,4,7 */
 131 #define VISMV_TEXT N_( "Visualize motion vectors" )
 132 #define VISMV_LONGTEXT N_( \
 133     "You can overlay the motion vectors (arrows showing how the images move) "\
 134     "on the image. This value is a mask, based on these values:\n"\
 135     "1 - visualize forward predicted MVs of P frames\n" \
 136     "2 - visualize forward predicted MVs of B frames\n" \
 137     "4 - visualize backward predicted MVs of B frames\n" \
 138     "To visualize all vectors, the value should be 7." )
 139
 140 #define LOWRES_TEXT N_( "Low resolution decoding" )
 141 #define LOWRES_LONGTEXT N_( "Only decode a low resolution version of " \
 142     "the video. This requires less processing power" )
 143
 144 #define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
 145 #define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
 146     "usually has a detrimental effect on quality. However it provides a big " \
 147     "speedup for high definition streams." )
 148
 149 #define LIBAVCODEC_PP_TEXT N_("FFmpeg post processing filter chains")
 150 /* FIXME (cut/past from ffmpeg */
 151 #define LIBAVCODEC_PP_LONGTEXT \
 152 N_("<filterName>[:<option>[:<option>...]][[,|/][-]<filterName>[:<option>...]]...\n" \
 153 "long form example:\n" \
 154 "vdeblock:autoq/hdeblock:autoq/linblenddeint    default,-vdeblock\n" \
 155 "short form example:\n" \
 156 "vb:a/hb:a/lb de,-vb\n" \
 157 "more examples:\n" \
 158 "tn:64:128:256\n" \
 159 "Filters                        Options\n" \
 160 "short  long name       short   long option     Description\n" \
 161 "*      *               a       autoq           cpu power dependant enabler\n" \
 162 "                       c       chrom           chrominance filtring enabled\n" \
 163 "                       y       nochrom         chrominance filtring disabled\n" \
 164 "hb     hdeblock        (2 Threshold)           horizontal deblocking filter\n" \
 165 "       1. difference factor: default=64, higher -> more deblocking\n" \
 166 "       2. flatness threshold: default=40, lower -> more deblocking\n" \
 167 "                       the h & v deblocking filters share these\n" \
 168 "                       so u cant set different thresholds for h / v\n" \
 169 "vb     vdeblock        (2 Threshold)           vertical deblocking filter\n" \
 170 "h1     x1hdeblock                              Experimental h deblock filter 1\n" \
 171 "v1     x1vdeblock                              Experimental v deblock filter 1\n" \
 172 "dr     dering                                  Deringing filter\n" \
 173 "al     autolevels                              automatic brightness / contrast\n" \
 174 "                       f       fullyrange      stretch luminance to (0..255)\n" \
 175 "lb     linblenddeint                           linear blend deinterlacer\n" \
 176 "li     linipoldeint                            linear interpolating deinterlace\n" \
 177 "ci     cubicipoldeint                          cubic interpolating deinterlacer\n" \
 178 "md     mediandeint                             median deinterlacer\n" \
 179 "fd     ffmpegdeint                             ffmpeg deinterlacer\n" \
 180 "de     default                                 hb:a,vb:a,dr:a,al\n" \
 181 "fa     fast                                    h1:a,v1:a,dr:a,al\n" \
 182 "tn     tmpnoise        (3 Thresholds)          Temporal Noise Reducer\n" \
 183 "                       1. <= 2. <= 3.          larger -> stronger filtering\n" \
 184 "fq     forceQuant      <quantizer>             Force quantizer\n")
 185
 186 /*
 187  * Encoder options
 188  */
 189 #define ENC_CFG_PREFIX "sout-ffmpeg-"
 190
 191 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
 192 #define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
 193   "that will be coded for one key frame." )
 194
 195 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
 196 #define ENC_BFRAMES_LONGTEXT N_( "Number of " \
 197   "B frames that will be coded between two reference frames." )
 198
 199 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
 200 #define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
 201
 202 #define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
 203 #define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
 204   "algorithms for interlaced frames." )
 205
 206 #define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
 207 #define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
 208   "motion estimation algorithms. This requires more CPU." )
 209
 210 #define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
 211 #define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
 212   "estimation algorithm.")
 213
 214 #define ENC_RC_STRICT_TEXT N_( "Strict rate control" )
 215 #define ENC_RC_STRICT_LONGTEXT N_( "Enable the strict rate " \
 216   "control algorithm." )
 217
 218 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
 219 #define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
 220   "buffer size (in kbytes). A bigger buffer will allow for better rate " \
 221   "control, but will cause a delay in the stream." )
 222
 223 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
 224 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
 225   "buffer aggressiveness." )
 226
 227 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
 228 #define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
 229   "Quantization factor of I frames, compared with P frames (for instance " \
 230   "1.0 => same qscale for I and P frames)." )
 231
 232 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
 233 #define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
 234   "reduction algorithm to lower the encoding length and bitrate, at the " \
 235   "expense of lower quality frames." )
 236
 237 #define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
 238 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
 239   "quantization matrix for MPEG2 encoding. This generally yields a " \
 240   "better looking picture, while still retaining the compatibility with " \
 241   "standard MPEG2 decoders.")
 242
 243 #define ENC_HQ_TEXT N_( "Quality level" )
 244 #define ENC_HQ_LONGTEXT N_( "Quality level " \
 245   "for the encoding of motions vectors (this can slow down the encoding " \
 246   "very much)." )
 247
 248 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
 249 #define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
 250   "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
 251   "the encoding rate. It will disable trellis quantization, then the rate " \
 252   "distortion of motion vectors (hq), and raise the noise reduction " \
 253   "threshold to ease the encoder's task." )
 254
 255 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
 256 #define ENC_QMIN_LONGTEXT N_( "Minimum video " \
 257   "quantizer scale." )
 258
 259 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
 260 #define ENC_QMAX_LONGTEXT N_( "Maximum video " \
 261   "quantizer scale." )
 262
 263 #define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
 264 #define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
 265   "quantization (rate distortion for block coefficients)." )
 266
 267 #define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
 268 #define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
 269   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
 270
 271 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
 272 #define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
 273   "compliance when encoding (accepted values: -1, 0, 1)." )
 274
 275 #define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
 276 #define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 277   "very bright macroblocks (default: 0.0)." )
 278
 279 #define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
 280 #define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 281   "very dark macroblocks (default: 0.0)." )
 282
 283 #define ENC_P_MASKING_TEXT N_( "Motion masking" )
 284 #define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
 285   "macroblocks with a high temporal complexity (default: 0.0)." )
 286
 287 #define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
 288 #define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
 289   "for macroblocks at the border of the frame (default: 0.0)." )
 290
 291 #define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
 292 #define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
 293   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 294   "recommends -4." )
 295
 296 #define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
 297 #define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
 298   "the PSNR isn't much changed (default: 0.0). The H264 specification " \
 299   "recommends 7." )