avcodec.h 9.31 KB
Newer Older
1
/*****************************************************************************
2
 * avcodec.h: decoder and encoder using libavcodec
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2001-2008 VLC authors and VideoLAN
5 6
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
Sam Hocevar's avatar
Sam Hocevar committed
7
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
8 9 10
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
11
 * (at your option) any later version.
Sam Hocevar's avatar
Sam Hocevar committed
12
 *
13 14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
15 16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
17
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
18 19 20
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 22
 *****************************************************************************/

23
#include "chroma.h"
24 25
#include "avcommon.h"

26
/* VLC <-> avcodec tables */
27
bool GetFfmpegCodec( enum es_format_category_e cat, vlc_fourcc_t i_fourcc,
28
                     unsigned *pi_ffmpeg_codec, const char **ppsz_name );
29
vlc_fourcc_t GetVlcFourcc( unsigned i_ffmpeg_codec );
30
vlc_fourcc_t GetVlcAudioFormat( int i_sample_fmt );
31

gbazin's avatar
 
gbazin committed
32
/* Video encoder module */
33 34
int  InitVideoEnc ( vlc_object_t * );
void EndVideoEnc( vlc_object_t * );
35

Rafaël Carré's avatar
Rafaël Carré committed
36
/* Video Decoder */
37 38
int InitVideoDec( vlc_object_t * );
void EndVideoDec( vlc_object_t * );
Rafaël Carré's avatar
Rafaël Carré committed
39 40

/* Audio Decoder */
41 42
int InitAudioDec( vlc_object_t * );
void EndAudioDec( vlc_object_t * );
Rafaël Carré's avatar
Rafaël Carré committed
43

44
/* Subtitle Decoder */
45 46
int InitSubtitleDec( vlc_object_t * );
void EndSubtitleDec( vlc_object_t * );
47

48
/* Initialize decoder */
49
AVCodecContext *ffmpeg_AllocContext( decoder_t *, const AVCodec ** );
50
int ffmpeg_OpenCodec( decoder_t *p_dec, AVCodecContext *, const AVCodec * );
51

gbazin's avatar
 
gbazin committed
52 53 54 55
/*****************************************************************************
 * Module descriptor help strings
 *****************************************************************************/
#define DR_TEXT N_("Direct rendering")
56
/* FIXME Does somebody who knows what it does, explain */
gbazin's avatar
 
gbazin committed
57

58 59 60
#define CORRUPTED_TEXT N_("Show corrupted frames")
#define CORRUPTED_LONGTEXT N_("Prefer visual artifacts instead of missing frames")

gbazin's avatar
 
gbazin committed
61 62
#define ERROR_TEXT N_("Error resilience")
#define ERROR_LONGTEXT N_( \
63
    "libavcodec can do error resilience.\n" \
64 65
    "However, with a buggy encoder (such as the ISO MPEG-4 encoder from M$) " \
    "this can produce a lot of errors.\n" \
gbazin's avatar
gbazin committed
66
    "Valid values range from 0 to 4 (0 disables all errors resilience).")
gbazin's avatar
 
gbazin committed
67 68 69

#define BUGS_TEXT N_("Workaround bugs")
#define BUGS_LONGTEXT N_( \
70
    "Try to fix some bugs:\n" \
gbazin's avatar
 
gbazin committed
71 72 73 74 75 76
    "1  autodetect\n" \
    "2  old msmpeg4\n" \
    "4  xvid interlaced\n" \
    "8  ump4 \n" \
    "16 no padding\n" \
    "32 ac vlc\n" \
zorglub's avatar
zorglub committed
77 78 79
    "64 Qpel chroma.\n" \
    "This must be the sum of the values. For example, to fix \"ac vlc\" and " \
    "\"ump4\", enter 40.")
gbazin's avatar
 
gbazin committed
80 81 82

#define HURRYUP_TEXT N_("Hurry up")
#define HURRYUP_LONGTEXT N_( \
83
    "The decoder can partially decode or skip frame(s) " \
gbazin's avatar
 
gbazin committed
84 85 86
    "when there is not enough time. It's useful with low CPU power " \
    "but it can produce distorted pictures.")

87 88 89 90 91 92 93
#define SKIP_FRAME_TEXT N_("Skip frame (default=0)")
#define SKIP_FRAME_LONGTEXT N_( \
    "Force skipping of frames to speed up decoding " \
    "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )

#define SKIP_IDCT_TEXT N_("Skip idct (default=0)")
#define SKIP_IDCT_LONGTEXT N_( \
Christoph Miebach's avatar
Christoph Miebach committed
94
    "Force skipping of idct to speed up decoding for frame types " \
95 96
    "(-1=None, 0=Default, 1=B-frames, 2=P-frames, 3=B+P frames, 4=all frames)." )

97
#define DEBUG_TEXT N_( "Debug mask" )
98
#define DEBUG_LONGTEXT N_( "Set FFmpeg debug mask" )
99

100 101 102
#define CODEC_TEXT N_( "Codec name" )
#define CODEC_LONGTEXT N_( "Internal libavcodec codec name" )

103 104
#define SKIPLOOPF_TEXT N_( "Skip the loop filter for H.264 decoding" )
#define SKIPLOOPF_LONGTEXT N_( "Skipping the loop filter (aka deblocking) " \
zorglub's avatar
zorglub committed
105 106
    "usually has a detrimental effect on quality. However it provides a big " \
    "speedup for high definition streams." )
107

Laurent Aimar's avatar
Laurent Aimar committed
108 109 110
#define THREADS_TEXT N_( "Threads" )
#define THREADS_LONGTEXT N_( "Number of threads used for decoding, 0 meaning auto" )

111 112 113
/*
 * Encoder options
 */
114
#define ENC_CFG_PREFIX "sout-avcodec-"
115 116

#define ENC_KEYINT_TEXT N_( "Ratio of key frames" )
117
#define ENC_KEYINT_LONGTEXT N_( "Number of frames " \
118 119 120
  "that will be coded for one key frame." )

#define ENC_BFRAMES_TEXT N_( "Ratio of B frames" )
121
#define ENC_BFRAMES_LONGTEXT N_( "Number of " \
122 123 124
  "B frames that will be coded between two reference frames." )

#define ENC_VT_TEXT N_( "Video bitrate tolerance" )
125
#define ENC_VT_LONGTEXT N_( "Video bitrate tolerance in kbit/s." )
126

zorglub's avatar
zorglub committed
127
#define ENC_INTERLACE_TEXT N_( "Interlaced encoding" )
128
#define ENC_INTERLACE_LONGTEXT N_( "Enable dedicated " \
129
  "algorithms for interlaced frames." )
130

zorglub's avatar
zorglub committed
131
#define ENC_INTERLACE_ME_TEXT N_( "Interlaced motion estimation" )
132
#define ENC_INTERLACE_ME_LONGTEXT N_( "Enable interlaced " \
zorglub's avatar
zorglub committed
133
  "motion estimation algorithms. This requires more CPU." )
134

zorglub's avatar
zorglub committed
135
#define ENC_PRE_ME_TEXT N_( "Pre-motion estimation" )
136 137
#define ENC_PRE_ME_LONGTEXT N_( "Enable the pre-motion " \
  "estimation algorithm.")
138 139

#define ENC_RC_BUF_TEXT N_( "Rate control buffer size" )
140
#define ENC_RC_BUF_LONGTEXT N_( "Rate control " \
zorglub's avatar
zorglub committed
141 142
  "buffer size (in kbytes). A bigger buffer will allow for better rate " \
  "control, but will cause a delay in the stream." )
143

144
#define ENC_RC_BUF_AGGR_TEXT N_( "Rate control buffer aggressiveness" )
zorglub's avatar
zorglub committed
145
#define ENC_RC_BUF_AGGR_LONGTEXT N_( "Rate control "\
146
  "buffer aggressiveness." )
147

148
#define ENC_IQUANT_FACTOR_TEXT N_( "I quantization factor" )
149 150
#define ENC_IQUANT_FACTOR_LONGTEXT N_(  \
  "Quantization factor of I frames, compared with P frames (for instance " \
151
  "1.0 => same qscale for I and P frames)." )
152 153

#define ENC_NOISE_RED_TEXT N_( "Noise reduction" )
154
#define ENC_NOISE_RED_LONGTEXT N_( "Enable a simple noise " \
155 156
  "reduction algorithm to lower the encoding length and bitrate, at the " \
  "expense of lower quality frames." )
157

zorglub's avatar
zorglub committed
158 159 160
#define ENC_MPEG4_MATRIX_TEXT N_( "MPEG4 quantization matrix" )
#define ENC_MPEG4_MATRIX_LONGTEXT N_( "Use the MPEG4 " \
  "quantization matrix for MPEG2 encoding. This generally yields a " \
161
  "better looking picture, while still retaining the compatibility with " \
zorglub's avatar
zorglub committed
162
  "standard MPEG2 decoders.")
163 164

#define ENC_HQ_TEXT N_( "Quality level" )
165
#define ENC_HQ_LONGTEXT N_( "Quality level " \
166 167
  "for the encoding of motions vectors (this can slow down the encoding " \
  "very much)." )
168 169

#define ENC_HURRYUP_TEXT N_( "Hurry up" )
170 171
#define ENC_HURRYUP_LONGTEXT N_( "The encoder " \
  "can make on-the-fly quality tradeoffs if your CPU can't keep up with " \
172
  "the encoding rate. It will disable trellis quantization, then the rate " \
173
  "distortion of motion vectors (hq), and raise the noise reduction " \
174
  "threshold to ease the encoder's task." )
175 176

#define ENC_QMIN_TEXT N_( "Minimum video quantizer scale" )
zorglub's avatar
zorglub committed
177
#define ENC_QMIN_LONGTEXT N_( "Minimum video " \
178 179 180
  "quantizer scale." )

#define ENC_QMAX_TEXT N_( "Maximum video quantizer scale" )
zorglub's avatar
zorglub committed
181
#define ENC_QMAX_LONGTEXT N_( "Maximum video " \
182 183
  "quantizer scale." )

zorglub's avatar
zorglub committed
184
#define ENC_TRELLIS_TEXT N_( "Trellis quantization" )
185
#define ENC_TRELLIS_LONGTEXT N_( "Enable trellis " \
186
  "quantization (rate distortion for block coefficients)." )
gbazin's avatar
gbazin committed
187

zorglub's avatar
zorglub committed
188
#define ENC_QSCALE_TEXT N_( "Fixed quantizer scale" )
189
#define ENC_QSCALE_LONGTEXT N_( "A fixed video " \
gbazin's avatar
gbazin committed
190 191 192
  "quantizer scale for VBR encoding (accepted values: 0.01 to 255.0)." )

#define ENC_STRICT_TEXT N_( "Strict standard compliance" )
193
#define ENC_STRICT_LONGTEXT N_( "Force a strict standard " \
194
  "compliance when encoding (accepted values: -2 to 2)." )
195 196

#define ENC_LUMI_MASKING_TEXT N_( "Luminance masking" )
197
#define ENC_LUMI_MASKING_LONGTEXT N_( "Raise the quantizer for " \
198 199 200
  "very bright macroblocks (default: 0.0)." )

#define ENC_DARK_MASKING_TEXT N_( "Darkness masking" )
201
#define ENC_DARK_MASKING_LONGTEXT N_( "Raise the quantizer for " \
202 203 204
  "very dark macroblocks (default: 0.0)." )

#define ENC_P_MASKING_TEXT N_( "Motion masking" )
205
#define ENC_P_MASKING_LONGTEXT N_( "Raise the quantizer for " \
206 207 208
  "macroblocks with a high temporal complexity (default: 0.0)." )

#define ENC_BORDER_MASKING_TEXT N_( "Border masking" )
209
#define ENC_BORDER_MASKING_LONGTEXT N_( "Raise the quantizer " \
210 211 212 213 214 215 216 217 218 219 220
  "for macroblocks at the border of the frame (default: 0.0)." )

#define ENC_LUMA_ELIM_TEXT N_( "Luminance elimination" )
#define ENC_LUMA_ELIM_LONGTEXT N_( "Eliminates luminance blocks when " \
  "the PSNR isn't much changed (default: 0.0). The H264 specification " \
  "recommends -4." )

#define ENC_CHROMA_ELIM_TEXT N_( "Chrominance elimination" )
#define ENC_CHROMA_ELIM_LONGTEXT N_( "Eliminates chrominance blocks when " \
  "the PSNR isn't much changed (default: 0.0). The H264 specification " \
  "recommends 7." )
221

222 223 224
#define ENC_PROFILE_TEXT N_( "Specify AAC audio profile to use" )
#define ENC_PROFILE_LONGTEXT N_( "Specify the AAC audio profile to use " \
   "for encoding the audio bitstream. It takes the following options: " \
225
   "main, low, ssr (not supported),ltp, hev1, hev2 (default: low). " \
226
   "hev1 and hev2 are currently supported only with libfdk-aac enabled libavcodec" )
227

228 229 230 231
#ifndef AV_VERSION_INT
#   define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c))
#endif