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 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
  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., 59 Temple Place - Suite 330, Boston, MA  02111, 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 /* Video filter module */
  72 int  E_(OpenFilter)( vlc_object_t * );
  73 void E_(CloseFilter)( vlc_object_t * );
  74 int  E_(OpenDeinterlace)( vlc_object_t * );
  75 void E_(CloseDeinterlace)( vlc_object_t * );
  76
  77 /* Postprocessing module */
  78 void *E_(OpenPostproc)( decoder_t *, vlc_bool_t * );
  79 int E_(InitPostproc)( decoder_t *, void *, int, int, int );
  80 int E_(PostprocPict)( decoder_t *, void *, picture_t *, AVFrame * );
  81 void E_(ClosePostproc)( decoder_t *, void * );
  82
  83 /*****************************************************************************
  84  * Module descriptor help strings
  85  *****************************************************************************/
  86 #define DR_TEXT N_("Direct rendering")
  87
  88 #define ERROR_TEXT N_("Error resilience")
  89 #define ERROR_LONGTEXT N_( \
  90     "ffmpeg can do error resilience.\n" \
  91     "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
  92     "this can produce a lot of errors.\n" \
  93     "Valid values range from 0 to 4 (0 disables all errors resilience).")
  94
  95 #define BUGS_TEXT N_("Workaround bugs")
  96 #define BUGS_LONGTEXT N_( \
  97     "Try to fix some bugs\n" \
  98     "1  autodetect\n" \
  99     "2  old msmpeg4\n" \
 100     "4  xvid interlaced\n" \
 101     "8  ump4 \n" \
 102     "16 no padding\n" \
 103     "32 ac vlc\n" \
 104     "64 Qpel chroma")
 105
 106 #define HURRYUP_TEXT N_("Hurry up")
 107 #define HURRYUP_LONGTEXT N_( \
 108     "Allow the decoder to partially decode or skip frame(s) " \
 109     "when there is not enough time. It's useful with low CPU power " \
 110     "but it can produce distorted pictures.")
 111
 112 #define PP_Q_TEXT N_("Post processing quality")
 113 #define PP_Q_LONGTEXT N_( \
 114     "Quality of post processing. Valid range is 0 to 6\n" \
 115     "Higher levels require considerable more CPU power, but produce " \
 116     "better looking pictures." )
 117
 118 #define DEBUG_TEXT N_( "Debug mask" )
 119 #define DEBUG_LONGTEXT N_( "Set ffmpeg debug mask" )
 120
 121 #define VISMV_TEXT N_( "Visualize motion vectors" )
 122 #define VISMV_LONGTEXT N_( "Set motion vectors visualization mask.\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" )
 126
 127 #define LIBAVCODEC_PP_TEXT N_("ffmpeg post processing filter chains")
 128 /* FIXME (cut/past from ffmpeg */
 129 #define LIBAVCODEC_PP_LONGTEXT \
 130 "<filterName>[:<option>[:<option>...]][[,|/][-]<filterName>[:<option>...]]...\n" \
 131 "long form example:\n" \
 132 "vdeblock:autoq/hdeblock:autoq/linblenddeint    default,-vdeblock\n" \
 133 "short form example:\n" \
 134 "vb:a/hb:a/lb de,-vb\n" \
 135 "more examples:\n" \
 136 "tn:64:128:256\n" \
 137 "Filters                        Options\n" \
 138 "short  long name       short   long option     Description\n" \
 139 "*      *               a       autoq           cpu power dependant enabler\n" \
 140 "                       c       chrom           chrominance filtring enabled\n" \
 141 "                       y       nochrom         chrominance filtring disabled\n" \
 142 "hb     hdeblock        (2 Threshold)           horizontal deblocking filter\n" \
 143 "       1. difference factor: default=64, higher -> more deblocking\n" \
 144 "       2. flatness threshold: default=40, lower -> more deblocking\n" \
 145 "                       the h & v deblocking filters share these\n" \
 146 "                       so u cant set different thresholds for h / v\n" \
 147 "vb     vdeblock        (2 Threshold)           vertical deblocking filter\n" \
 148 "h1     x1hdeblock                              Experimental h deblock filter 1\n" \
 149 "v1     x1vdeblock                              Experimental v deblock filter 1\n" \
 150 "dr     dering                                  Deringing filter\n" \
 151 "al     autolevels                              automatic brightness / contrast\n" \
 152 "                       f       fullyrange      stretch luminance to (0..255)\n" \
 153 "lb     linblenddeint                           linear blend deinterlacer\n" \
 154 "li     linipoldeint                            linear interpolating deinterlace\n" \
 155 "ci     cubicipoldeint                          cubic interpolating deinterlacer\n" \
 156 "md     mediandeint                             median deinterlacer\n" \
 157 "fd     ffmpegdeint                             ffmpeg deinterlacer\n" \
 158 "de     default                                 hb:a,vb:a,dr:a,al\n" \
 159 "fa     fast                                    h1:a,v1:a,dr:a,al\n" \
 160 "tn     tmpnoise        (3 Thresholds)          Temporal Noise Reducer\n" \
 161 "                       1. <= 2. <= 3.          larger -> stronger filtering\n" \
 162 "fq     forceQuant      <quantizer>             Force quantizer\n"
 163
 164 /*
 165  * Encoder options
 166  */
 167 #define ENC_CFG_PREFIX "sout-ffmpeg-"
 168
 169 #define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
 170 #define ENC_KEYINT_LONGTEXT N_( "Allows you to specify the number of frames " \
 171   "that will be coded for one key frame." )
 172
 173 #define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
 174 #define ENC_BFRAMES_LONGTEXT N_( "Allows you to specify the number of " \
 175   "B frames that will be coded between two reference frames." )
 176
 177 #define ENC_VT_TEXT N_( "Video bitrate tolerance" )
 178 #define ENC_VT_LONGTEXT N_( "Allows you to specify the video bitrate " \
 179   "tolerance in kbit/s." )
 180
 181 #define ENC_INTERLACE_TEXT N_( "Enable interlaced encoding" )
 182 #define ENC_INTERLACE_LONGTEXT N_( "Allows you to enable dedicated " \
 183   "algorithms for interlaced frames." )
 184
 185 #define ENC_PRE_ME_TEXT N_( "Enable pre motion estimation" )
 186 #define ENC_PRE_ME_LONGTEXT N_( "Allows you to enable the pre motion " \
 187   "estimation." )
 188
 189 #define ENC_RC_STRICT_TEXT N_( "Enable strict rate control" )
 190 #define ENC_RC_STRICT_LONGTEXT N_( "Allows you to enable the strict rate " \
 191   "control algorithm." )
 192
 193 #define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
 194 #define ENC_RC_BUF_LONGTEXT N_( "Allows you to specify the rate control " \
 195   "buffer size." )
 196
 197 #define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
 198 #define ENC_RC_BUF_AGGR_LONGTEXT N_( "Allows you to specify the rate control "\
 199   "buffer aggressiveness." )
 200
 201 #define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
 202 #define ENC_IQUANT_FACTOR_LONGTEXT N_( "Allows you to specify the " \
 203   "quantization factor of I frames, compared with P frames (for instance " \
 204   "1.0 => same qscale for I and P frames)." )
 205
 206 #define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
 207 #define ENC_NOISE_RED_LONGTEXT N_( "Allows you to enable a simple noise " \
 208   "reduction algorithm to lower the encoding length and bitrate, at the " \
 209   "expense of lower quality frames." )
 210
 211 #define ENC_MPEG4_MATRIX_TEXT N_( "Enable MPEG4 quantization matrix" )
 212 #define ENC_MPEG4_MATRIX_LONGTEXT N_( "Allows you to use the MPEG4 " \
 213   "quantization matrix for mpeg2 encoding. This generally yields a " \
 214   "better looking picture, while still retaining the compatibility with " \
 215   "standard MPEG-2 decoders.")
 216
 217 #define ENC_HQ_TEXT N_( "Quality level" )
 218 #define ENC_HQ_LONGTEXT N_( "Allows you to specify the quality level " \
 219   "for the encoding of motions vectors (this can slow down the encoding " \
 220   "very much)." )
 221
 222 #define ENC_HURRYUP_TEXT N_( "Hurry up" )
 223 #define ENC_HURRYUP_LONGTEXT N_( "Allows you to specify if the encoder " \
 224   "should make on-the-fly quality tradeoffs if your CPU can't keep up with " \
 225   "the encoding rate. It will disable trellis quantization, then the rate " \
 226   "distortion of motion vectors (hq), and raise the noise reduction " \
 227   "threshold to ease the encoder's task." )
 228
 229 #define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
 230 #define ENC_QMIN_LONGTEXT N_( "Allows you to specify the minimum video " \
 231   "quantizer scale." )
 232
 233 #define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
 234 #define ENC_QMAX_LONGTEXT N_( "Allows you to specify the maximum video " \
 235   "quantizer scale." )
 236
 237 #define ENC_TRELLIS_TEXT N_( "Enable trellis quantization" )
 238 #define ENC_TRELLIS_LONGTEXT N_( "Allows you to enable trellis " \
 239   "quantization (rate distortion for block coefficients)." )
 240
 241 #define ENC_QSCALE_TEXT N_( "Use fixed video quantizer scale" )
 242 #define ENC_QSCALE_LONGTEXT N_( "Allows you to specify a fixed video " \
 243   "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )
 244
 245 #define ENC_STRICT_TEXT N_( "Strict standard compliance" )
 246 #define ENC_STRICT_LONGTEXT N_( "Allows you to force a strict standard " \
 247   "compliance when encoding (accepted values: -1, 0, 1)." )