~ubuntu-branches/ubuntu/maverick/x264/maverick

« back to all changes in this revision

Viewing changes to debian/x264.1

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler, Loïc Minier, Reinhard Tartler
  • Date: 2010-03-14 10:10:26 UTC
  • Revision ID: james.westby@ubuntu.com-20100314101026-u2kv7qpkoutru323
Tags: 2:0.85.1448+git1a6d32-3
[ Loïc Minier ]
* Finish confflags logic and/or add workarounds

[ Reinhard Tartler ]
* build depend on libgpac-dev to enable mp4 support, LP: #464797
* simplify configure line, LP: #538555
* generate manpage with help2man to keep it up-to-date, LP: #391281

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2
 
.TH X264 "1" "March 2007" "x264" "User Commands"
3
 
.SH NAME
4
 
x264 \- H.264 encoder
5
 
.SH SYNOPSIS
6
 
\fBx264 [options] \-o outfile infile [widthxheight]
7
 
.SH DESCRIPTION
8
 
x264 encodes a video stream using the H.264 codec.
9
 
.PP
10
 
Infile can be raw YUV 4:2:0 (in which case resolution is required) or
11
 
YUV4MPEG 4:2:0 (*.y4m).
12
 
.PP
13
 
Outfile type is selected by filename: \fB.264\fR (raw bytestream) or
14
 
\fB.mkv\fR (Matroska).
15
 
.SH OPTIONS
16
 
.TP
17
 
\fB\-h\fR, \fB\-\-help\fR
18
 
List the more commonly used options
19
 
.TP
20
 
\fB\-\-longhelp\fR
21
 
List all options
22
 
.PP
23
 
Frame\-type options:
24
 
.TP
25
 
\fB\-I\fR, \fB\-\-keyint\fR <integer>
26
 
Maximum GOP size [250]
27
 
.TP
28
 
\fB\-i\fR, \fB\-\-min\-keyint\fR <integer>
29
 
Minimum GOP size [25]
30
 
.TP
31
 
\fB\-\-scenecut\fR <integer>
32
 
How aggressively to insert extra I\-frames [40]
33
 
.TP
34
 
\fB\-\-pre\-scenecut\fR
35
 
Faster, less precise scenecut detection.
36
 
Required and implied by multi\-threading.
37
 
.TP
38
 
\fB\-b\fR, \fB\-\-bframes\fR <integer>
39
 
Number of B\-frames between I and P [0]
40
 
.TP
41
 
\fB\-\-no\-b\-adapt\fR
42
 
Disable adaptive B\-frame decision
43
 
.TP
44
 
\fB\-\-b\-bias\fR <integer>
45
 
Influences how often B\-frames are used [0]
46
 
.TP
47
 
\fB\-\-b\-pyramid\fR
48
 
Keep some B\-frames as references
49
 
.TP
50
 
\fB\-\-no\-cabac\fR
51
 
Disable CABAC
52
 
.TP
53
 
\fB\-r\fR, \fB\-\-ref\fR <integer>
54
 
Number of reference frames [1]
55
 
.TP
56
 
\fB\-\-no\-deblock\fR
57
 
Disable loop filter
58
 
.TP
59
 
\fB\-f\fR, \fB\-\-deblock\fR <alpha:beta>
60
 
Loop filter AlphaC0 and Beta parameters [0:0]
61
 
.TP
62
 
\fB\-\-interlaced\fR
63
 
Enable pure\-interlaced mode
64
 
.PP
65
 
Ratecontrol:
66
 
.TP
67
 
\fB\-q\fR, \fB\-\-qp\fR <integer>
68
 
Set QP (0=lossless) [26]
69
 
.TP
70
 
\fB\-B\fR, \fB\-\-bitrate\fR <integer>
71
 
Set bitrate (kbit/s)
72
 
.TP
73
 
\fB\-\-crf\fR <float>
74
 
Quality\-based VBR (nominal QP)
75
 
.HP
76
 
\fB\-\-vbv\-maxrate\fR <integer> Max local bitrate (kbit/s) [0]
77
 
.HP
78
 
\fB\-\-vbv\-bufsize\fR <integer> Enable CBR and set size of the VBV buffer (kbit) [0]
79
 
.TP
80
 
\fB\-\-vbv\-init\fR <float>
81
 
Initial VBV buffer occupancy [0.9]
82
 
.TP
83
 
\fB\-\-qpmin\fR <integer>
84
 
Set min QP [10]
85
 
.TP
86
 
\fB\-\-qpmax\fR <integer>
87
 
Set max QP [51]
88
 
.TP
89
 
\fB\-\-qpstep\fR <integer>
90
 
Set max QP step [4]
91
 
.TP
92
 
\fB\-\-ratetol\fR <float>
93
 
Allowed variance of average bitrate [1.0]
94
 
.TP
95
 
\fB\-\-ipratio\fR <float>
96
 
QP factor between I and P [1.40]
97
 
.TP
98
 
\fB\-\-pbratio\fR <float>
99
 
QP factor between P and B [1.30]
100
 
.TP
101
 
\fB\-\-chroma\-qp\-offset\fR <integer>
102
 
QP difference between chroma and luma [0]
103
 
.TP
104
 
\fB\-p\fR, \fB\-\-pass\fR <1|2|3>
105
 
Enable multipass ratecontrol
106
 
\- 1: First pass, creates stats file
107
 
\- 2: Last pass, does not overwrite stats file
108
 
\- 3: Nth pass, overwrites stats file
109
 
.TP
110
 
\fB\-\-stats\fR <string>
111
 
Filename for 2 pass stats ["x264_2pass.log"]
112
 
.TP
113
 
\fB\-\-rceq\fR <string>
114
 
Ratecontrol equation ["blurCplx^(1\-qComp)"]
115
 
.TP
116
 
\fB\-\-qcomp\fR <float>
117
 
QP curve compression: 0.0 => CBR, 1.0 => CQP [0.60]
118
 
.TP
119
 
\fB\-\-cplxblur\fR <float>
120
 
Reduce fluctuations in QP (before curve compression) [20.0]
121
 
.TP
122
 
\fB\-\-qblur\fR <float>
123
 
Reduce fluctuations in QP (after curve compression) [0.5]
124
 
.TP
125
 
\fB\-\-zones\fR <zone0>/<zone1>/...
126
 
Tweak the bitrate of some regions of the video
127
 
Each zone is of the form
128
 
.IP
129
 
<start frame>,<end frame>,<option>
130
 
where <option> is either
131
 
.IP
132
 
q=<integer> (force QP)
133
 
.TP
134
 
or
135
 
b=<float> (bitrate multiplier)
136
 
.TP
137
 
\fB\-\-qpfile\fR <string>
138
 
Force frametypes and QPs
139
 
.PP
140
 
Analysis:
141
 
.TP
142
 
\fB\-A\fR, \fB\-\-partitions\fR <string>
143
 
Partitions to consider ["p8x8,b8x8,i8x8,i4x4"]
144
 
\- p8x8, p4x4, b8x8, i8x8, i4x4
145
 
\- none, all
146
 
(p4x4 requires p8x8. i8x8 requires \fB\-\-8x8dct\fR.)
147
 
.TP
148
 
\fB\-\-direct\fR <string>
149
 
Direct MV prediction mode ["spatial"]
150
 
\- none, spatial, temporal, auto
151
 
.TP
152
 
\fB\-\-direct\-8x8\fR <\-1|0|1>
153
 
Direct prediction size [\-1]
154
 
\-  0: 4x4
155
 
\-  1: 8x8
156
 
\- \fB\-1\fR: smallest possible according to level
157
 
.TP
158
 
\fB\-w\fR, \fB\-\-weightb\fR
159
 
Weighted prediction for B\-frames
160
 
.TP
161
 
\fB\-\-me\fR <string>
162
 
Integer pixel motion estimation method ["hex"]
163
 
\- dia: diamond search, radius 1 (fast)
164
 
\- hex: hexagonal search, radius 2
165
 
\- umh: uneven multi\-hexagon search
166
 
\- esa: exhaustive search (slow)
167
 
.TP
168
 
\fB\-\-merange\fR <integer>
169
 
Maximum motion vector search range [16]
170
 
.TP
171
 
\fB\-\-mvrange\fR <integer>
172
 
Maximum motion vector length [\-1 (auto)]
173
 
.TP
174
 
\fB\-\-mvrange\-thread\fR <int>
175
 
Minimum buffer between threads [\-1 (auto)]
176
 
.TP
177
 
\fB\-m\fR, \fB\-\-subme\fR <integer>
178
 
Subpixel motion estimation and partition
179
 
decision quality: 1=fast, 7=best. [5]
180
 
.TP
181
 
\fB\-\-b\-rdo\fR
182
 
RD based mode decision for B\-frames. Requires subme 6.
183
 
.TP
184
 
\fB\-\-mixed\-refs\fR
185
 
Decide references on a per partition basis
186
 
.TP
187
 
\fB\-\-no\-chroma\-me\fR
188
 
Ignore chroma in motion estimation
189
 
.TP
190
 
\fB\-8\fR, \fB\-\-8x8dct\fR
191
 
Adaptive spatial transform size
192
 
.TP
193
 
\fB\-t\fR, \fB\-\-trellis\fR <integer>
194
 
Trellis RD quantization. Requires CABAC. [0]
195
 
\- 0: disabled
196
 
\- 1: enabled only on the final encode of a MB
197
 
\- 2: enabled on all mode decisions
198
 
.TP
199
 
\fB\-\-no\-fast\-pskip\fR
200
 
Disables early SKIP detection on P\-frames
201
 
.TP
202
 
\fB\-\-no\-dct\-decimate\fR
203
 
Disables coefficient thresholding on P\-frames
204
 
.TP
205
 
\fB\-\-nr\fR <integer>
206
 
Noise reduction [0]
207
 
.TP
208
 
\fB\-\-deadzone\-inter\fR <int>
209
 
Set the size of the inter luma quantization deadzone [21]
210
 
.TP
211
 
\fB\-\-deadzone\-intra\fR <int>
212
 
Set the size of the intra luma quantization deadzone [11]
213
 
Deadzones should be in the range 0 \- 32.
214
 
.TP
215
 
\fB\-\-cqm\fR <string>
216
 
Preset quant matrices ["flat"]
217
 
\- jvt, flat
218
 
.TP
219
 
\fB\-\-cqmfile\fR <string>
220
 
Read custom quant matrices from a JM\-compatible file
221
 
Overrides any other \fB\-\-cqm\fR* options.
222
 
.TP
223
 
\fB\-\-cqm4\fR <list>
224
 
Set all 4x4 quant matrices
225
 
Takes a comma\-separated list of 16 integers.
226
 
.TP
227
 
\fB\-\-cqm8\fR <list>
228
 
Set all 8x8 quant matrices
229
 
Takes a comma\-separated list of 64 integers.
230
 
.TP
231
 
\fB\-\-cqm4i\fR, \fB\-\-cqm4p\fR, \fB\-\-cqm8i\fR, \fB\-\-cqm8p\fR
232
 
Set both luma and chroma quant matrices
233
 
.TP
234
 
\fB\-\-cqm4iy\fR, \fB\-\-cqm4ic\fR, \fB\-\-cqm4py\fR, \fB\-\-cqm4pc\fR
235
 
Set individual quant matrices
236
 
.PP
237
 
Video Usability Info (Annex E):
238
 
The VUI settings are not used by the encoder but are merely suggestions to
239
 
the playback equipment. See doc/vui.txt for details. Use at your own risk.
240
 
.TP
241
 
\fB\-\-overscan\fR <string>
242
 
Specify crop overscan setting ["undef"]
243
 
\- undef, show, crop
244
 
.TP
245
 
\fB\-\-videoformat\fR <string>
246
 
Specify video format ["undef"]
247
 
\- component, pal, ntsc, secam, mac, undef
248
 
.TP
249
 
\fB\-\-fullrange\fR <string>
250
 
Specify full range samples setting ["off"]
251
 
\- off, on
252
 
.TP
253
 
\fB\-\-colorprim\fR <string>
254
 
Specify color primaries ["undef"]
255
 
\- undef, bt709, bt470m, bt470bg
256
 
.IP
257
 
smpte170m, smpte240m, film
258
 
.TP
259
 
\fB\-\-transfer\fR <string>
260
 
Specify transfer characteristics ["undef"]
261
 
\- undef, bt709, bt470m, bt470bg, linear,
262
 
.IP
263
 
log100, log316, smpte170m, smpte240m
264
 
.TP
265
 
\fB\-\-colormatrix\fR <string>
266
 
Specify color matrix setting ["undef"]
267
 
\- undef, bt709, fcc, bt470bg
268
 
.IP
269
 
smpte170m, smpte240m, GBR, YCgCo
270
 
.TP
271
 
\fB\-\-chromaloc\fR <integer>
272
 
Specify chroma sample location (0 to 5) [0]
273
 
.PP
274
 
Input/Output:
275
 
.TP
276
 
\fB\-o\fR, \fB\-\-output\fR
277
 
Specify output file
278
 
.TP
279
 
\fB\-\-sar\fR width:height
280
 
Specify Sample Aspect Ratio
281
 
.TP
282
 
\fB\-\-fps\fR <float|rational>
283
 
Specify framerate
284
 
.TP
285
 
\fB\-\-seek\fR <integer>
286
 
First frame to encode
287
 
.TP
288
 
\fB\-\-frames\fR <integer>
289
 
Maximum number of frames to encode
290
 
.TP
291
 
\fB\-\-level\fR <string>
292
 
Specify level (as defined by Annex A)
293
 
.TP
294
 
\fB\-v\fR, \fB\-\-verbose\fR
295
 
Print stats for each frame
296
 
.TP
297
 
\fB\-\-progress\fR
298
 
Show a progress indicator while encoding
299
 
.TP
300
 
\fB\-\-quiet\fR
301
 
Quiet Mode
302
 
.TP
303
 
\fB\-\-no\-psnr\fR
304
 
Disable PSNR computation
305
 
.TP
306
 
\fB\-\-no\-ssim\fR
307
 
Disable SSIM computation
308
 
.TP
309
 
\fB\-\-threads\fR <integer>
310
 
Parallel encoding
311
 
.TP
312
 
\fB\-\-thread\-input\fR
313
 
Run Avisynth in its own thread
314
 
.TP
315
 
\fB\-\-non\-deterministic\fR
316
 
Slightly improve quality of SMP, at the cost of repeatability
317
 
.TP
318
 
\fB\-\-no\-asm\fR
319
 
Disable all CPU optimizations
320
 
.TP
321
 
\fB\-\-visualize\fR
322
 
Show MB types overlayed on the encoded video
323
 
.TP
324
 
\fB\-\-sps\-id\fR <integer>
325
 
Set SPS and PPS id numbers [0]
326
 
.TP
327
 
\fB\-\-aud\fR
328
 
Use access unit delimiters
329
 
.SH "SEE ALSO"
330
 
.B ffmpeg(1)
331
 
.SH AUTHORS
332
 
x264 was written by Laurent Aimar <fenrir@via.ecp.fr> et al.
333
 
.PP
334
 
This manual page was written by Sam Hocevar <sam@zoy.org> for the Debian
335
 
project (but may be used by others).