comparison x265/source/x265cli.h @ 0:772086c29cc7

Initial import.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 16 Nov 2016 11:16:33 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:772086c29cc7
1 /*****************************************************************************
2 * Copyright (C) 2013 x265 project
3 *
4 * Authors: Steve Borho <steve@borho.org>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111, USA.
19 *
20 * This program is also available under a commercial proprietary license.
21 * For more information, contact us at license @ x265.com.
22 *****************************************************************************/
23
24 #ifndef X265CLI_H
25 #define X265CLI_H 1
26
27 #include "common.h"
28 #include "param.h"
29
30 #include <getopt.h>
31
32 #ifdef __cplusplus
33 namespace X265_NS {
34 #endif
35
36 static const char short_options[] = "o:D:P:p:f:F:r:I:i:b:s:t:q:m:hwV?";
37 static const struct option long_options[] =
38 {
39 { "help", no_argument, NULL, 'h' },
40 { "version", no_argument, NULL, 'V' },
41 { "asm", required_argument, NULL, 0 },
42 { "no-asm", no_argument, NULL, 0 },
43 { "pools", required_argument, NULL, 0 },
44 { "numa-pools", required_argument, NULL, 0 },
45 { "preset", required_argument, NULL, 'p' },
46 { "tune", required_argument, NULL, 't' },
47 { "frame-threads", required_argument, NULL, 'F' },
48 { "no-pmode", no_argument, NULL, 0 },
49 { "pmode", no_argument, NULL, 0 },
50 { "no-pme", no_argument, NULL, 0 },
51 { "pme", no_argument, NULL, 0 },
52 { "log-level", required_argument, NULL, 0 },
53 { "profile", required_argument, NULL, 'P' },
54 { "level-idc", required_argument, NULL, 0 },
55 { "high-tier", no_argument, NULL, 0 },
56 { "no-high-tier", no_argument, NULL, 0 },
57 { "allow-non-conformance",no_argument, NULL, 0 },
58 { "no-allow-non-conformance",no_argument, NULL, 0 },
59 { "csv", required_argument, NULL, 0 },
60 { "csv-log-level", required_argument, NULL, 0 },
61 { "no-cu-stats", no_argument, NULL, 0 },
62 { "cu-stats", no_argument, NULL, 0 },
63 { "y4m", no_argument, NULL, 0 },
64 { "no-progress", no_argument, NULL, 0 },
65 { "output", required_argument, NULL, 'o' },
66 { "output-depth", required_argument, NULL, 'D' },
67 { "input", required_argument, NULL, 0 },
68 { "input-depth", required_argument, NULL, 0 },
69 { "input-res", required_argument, NULL, 0 },
70 { "input-csp", required_argument, NULL, 0 },
71 { "interlace", required_argument, NULL, 0 },
72 { "no-interlace", no_argument, NULL, 0 },
73 { "fps", required_argument, NULL, 0 },
74 { "seek", required_argument, NULL, 0 },
75 { "frame-skip", required_argument, NULL, 0 },
76 { "frames", required_argument, NULL, 'f' },
77 { "recon", required_argument, NULL, 'r' },
78 { "recon-depth", required_argument, NULL, 0 },
79 { "no-wpp", no_argument, NULL, 0 },
80 { "wpp", no_argument, NULL, 0 },
81 { "ctu", required_argument, NULL, 's' },
82 { "min-cu-size", required_argument, NULL, 0 },
83 { "max-tu-size", required_argument, NULL, 0 },
84 { "tu-intra-depth", required_argument, NULL, 0 },
85 { "tu-inter-depth", required_argument, NULL, 0 },
86 { "me", required_argument, NULL, 0 },
87 { "subme", required_argument, NULL, 'm' },
88 { "merange", required_argument, NULL, 0 },
89 { "max-merge", required_argument, NULL, 0 },
90 { "no-temporal-mvp", no_argument, NULL, 0 },
91 { "temporal-mvp", no_argument, NULL, 0 },
92 { "rdpenalty", required_argument, NULL, 0 },
93 { "no-rect", no_argument, NULL, 0 },
94 { "rect", no_argument, NULL, 0 },
95 { "no-amp", no_argument, NULL, 0 },
96 { "amp", no_argument, NULL, 0 },
97 { "no-early-skip", no_argument, NULL, 0 },
98 { "early-skip", no_argument, NULL, 0 },
99 { "no-fast-cbf", no_argument, NULL, 0 },
100 { "fast-cbf", no_argument, NULL, 0 },
101 { "no-tskip", no_argument, NULL, 0 },
102 { "tskip", no_argument, NULL, 0 },
103 { "no-tskip-fast", no_argument, NULL, 0 },
104 { "tskip-fast", no_argument, NULL, 0 },
105 { "cu-lossless", no_argument, NULL, 0 },
106 { "no-cu-lossless", no_argument, NULL, 0 },
107 { "no-constrained-intra", no_argument, NULL, 0 },
108 { "constrained-intra", no_argument, NULL, 0 },
109 { "cip", no_argument, NULL, 0 },
110 { "no-cip", no_argument, NULL, 0 },
111 { "fast-intra", no_argument, NULL, 0 },
112 { "no-fast-intra", no_argument, NULL, 0 },
113 { "no-open-gop", no_argument, NULL, 0 },
114 { "open-gop", no_argument, NULL, 0 },
115 { "keyint", required_argument, NULL, 'I' },
116 { "min-keyint", required_argument, NULL, 'i' },
117 { "scenecut", required_argument, NULL, 0 },
118 { "no-scenecut", no_argument, NULL, 0 },
119 { "rc-lookahead", required_argument, NULL, 0 },
120 { "lookahead-slices", required_argument, NULL, 0 },
121 { "bframes", required_argument, NULL, 'b' },
122 { "bframe-bias", required_argument, NULL, 0 },
123 { "b-adapt", required_argument, NULL, 0 },
124 { "no-b-adapt", no_argument, NULL, 0 },
125 { "no-b-pyramid", no_argument, NULL, 0 },
126 { "b-pyramid", no_argument, NULL, 0 },
127 { "ref", required_argument, NULL, 0 },
128 { "limit-refs", required_argument, NULL, 0 },
129 { "no-weightp", no_argument, NULL, 0 },
130 { "weightp", no_argument, NULL, 'w' },
131 { "no-weightb", no_argument, NULL, 0 },
132 { "weightb", no_argument, NULL, 0 },
133 { "crf", required_argument, NULL, 0 },
134 { "crf-max", required_argument, NULL, 0 },
135 { "crf-min", required_argument, NULL, 0 },
136 { "vbv-maxrate", required_argument, NULL, 0 },
137 { "vbv-bufsize", required_argument, NULL, 0 },
138 { "vbv-init", required_argument, NULL, 0 },
139 { "bitrate", required_argument, NULL, 0 },
140 { "qp", required_argument, NULL, 'q' },
141 { "aq-mode", required_argument, NULL, 0 },
142 { "aq-strength", required_argument, NULL, 0 },
143 { "ipratio", required_argument, NULL, 0 },
144 { "pbratio", required_argument, NULL, 0 },
145 { "qcomp", required_argument, NULL, 0 },
146 { "qpstep", required_argument, NULL, 0 },
147 { "ratetol", required_argument, NULL, 0 },
148 { "cplxblur", required_argument, NULL, 0 },
149 { "qblur", required_argument, NULL, 0 },
150 { "cbqpoffs", required_argument, NULL, 0 },
151 { "crqpoffs", required_argument, NULL, 0 },
152 { "rd", required_argument, NULL, 0 },
153 { "rdoq-level", required_argument, NULL, 0 },
154 { "no-rdoq-level", no_argument, NULL, 0 },
155 { "psy-rd", required_argument, NULL, 0 },
156 { "psy-rdoq", required_argument, NULL, 0 },
157 { "no-psy-rd", no_argument, NULL, 0 },
158 { "no-psy-rdoq", no_argument, NULL, 0 },
159 { "scaling-list", required_argument, NULL, 0 },
160 { "lossless", no_argument, NULL, 0 },
161 { "no-lossless", no_argument, NULL, 0 },
162 { "no-signhide", no_argument, NULL, 0 },
163 { "signhide", no_argument, NULL, 0 },
164 { "no-lft", no_argument, NULL, 0 }, /* DEPRECATED */
165 { "lft", no_argument, NULL, 0 }, /* DEPRECATED */
166 { "no-deblock", no_argument, NULL, 0 },
167 { "deblock", required_argument, NULL, 0 },
168 { "no-sao", no_argument, NULL, 0 },
169 { "sao", no_argument, NULL, 0 },
170 { "no-sao-non-deblock", no_argument, NULL, 0 },
171 { "sao-non-deblock", no_argument, NULL, 0 },
172 { "no-ssim", no_argument, NULL, 0 },
173 { "ssim", no_argument, NULL, 0 },
174 { "no-psnr", no_argument, NULL, 0 },
175 { "psnr", no_argument, NULL, 0 },
176 { "hash", required_argument, NULL, 0 },
177 { "no-strong-intra-smoothing", no_argument, NULL, 0 },
178 { "strong-intra-smoothing", no_argument, NULL, 0 },
179 { "no-cutree", no_argument, NULL, 0 },
180 { "cutree", no_argument, NULL, 0 },
181 { "no-hrd", no_argument, NULL, 0 },
182 { "hrd", no_argument, NULL, 0 },
183 { "sar", required_argument, NULL, 0 },
184 { "overscan", required_argument, NULL, 0 },
185 { "videoformat", required_argument, NULL, 0 },
186 { "range", required_argument, NULL, 0 },
187 { "colorprim", required_argument, NULL, 0 },
188 { "transfer", required_argument, NULL, 0 },
189 { "colormatrix", required_argument, NULL, 0 },
190 { "chromaloc", required_argument, NULL, 0 },
191 { "display-window", required_argument, NULL, 0 },
192 { "crop-rect", required_argument, NULL, 0 }, /* DEPRECATED */
193 { "master-display", required_argument, NULL, 0 },
194 { "max-cll", required_argument, NULL, 0 },
195 { "min-luma", required_argument, NULL, 0 },
196 { "max-luma", required_argument, NULL, 0 },
197 { "no-dither", no_argument, NULL, 0 },
198 { "dither", no_argument, NULL, 0 },
199 { "no-repeat-headers", no_argument, NULL, 0 },
200 { "repeat-headers", no_argument, NULL, 0 },
201 { "aud", no_argument, NULL, 0 },
202 { "no-aud", no_argument, NULL, 0 },
203 { "info", no_argument, NULL, 0 },
204 { "no-info", no_argument, NULL, 0 },
205 { "zones", required_argument, NULL, 0 },
206 { "qpfile", required_argument, NULL, 0 },
207 { "lambda-file", required_argument, NULL, 0 },
208 { "b-intra", no_argument, NULL, 0 },
209 { "no-b-intra", no_argument, NULL, 0 },
210 { "nr-intra", required_argument, NULL, 0 },
211 { "nr-inter", required_argument, NULL, 0 },
212 { "stats", required_argument, NULL, 0 },
213 { "pass", required_argument, NULL, 0 },
214 { "slow-firstpass", no_argument, NULL, 0 },
215 { "no-slow-firstpass", no_argument, NULL, 0 },
216 { "analysis-mode", required_argument, NULL, 0 },
217 { "analysis-file", required_argument, NULL, 0 },
218 { "strict-cbr", no_argument, NULL, 0 },
219 { "temporal-layers", no_argument, NULL, 0 },
220 { "no-temporal-layers", no_argument, NULL, 0 },
221 { "qg-size", required_argument, NULL, 0 },
222 { "recon-y4m-exec", required_argument, NULL, 0 },
223 { 0, 0, 0, 0 },
224 { 0, 0, 0, 0 },
225 { 0, 0, 0, 0 },
226 { 0, 0, 0, 0 },
227 { 0, 0, 0, 0 }
228 };
229
230 static void printVersion(x265_param *param, const x265_api* api)
231 {
232 x265_log(param, X265_LOG_INFO, "HEVC encoder version %s\n", api->version_str);
233 x265_log(param, X265_LOG_INFO, "build info %s\n", api->build_info_str);
234 }
235
236 static void showHelp(x265_param *param)
237 {
238 int level = param->logLevel;
239
240 #define OPT(value) (value ? "enabled" : "disabled")
241 #define H0 printf
242 #define H1 if (level >= X265_LOG_DEBUG) printf
243
244 H0("\nSyntax: x265 [options] infile [-o] outfile\n");
245 H0(" infile can be YUV or Y4M\n");
246 H0(" outfile is raw HEVC bitstream\n");
247 H0("\nExecutable Options:\n");
248 H0("-h/--help Show this help text and exit\n");
249 H0("-V/--version Show version info and exit\n");
250 H0("\nOutput Options:\n");
251 H0("-o/--output <filename> Bitstream output file name\n");
252 H0("-D/--output-depth 8|10|12 Output bit depth (also internal bit depth). Default %d\n", param->internalBitDepth);
253 H0(" --log-level <string> Logging level: none error warning info debug full. Default %s\n", X265_NS::logLevelNames[param->logLevel + 1]);
254 H0(" --no-progress Disable CLI progress reports\n");
255 H0(" --csv <filename> Comma separated log file, if csv-log-level > 0 frame level statistics, else one line per run\n");
256 H0(" --csv-log-level Level of csv logging, if csv-log-level > 0 frame level statistics, else one line per run: 0-2\n");
257 H0("\nInput Options:\n");
258 H0(" --input <filename> Raw YUV or Y4M input file name. `-` for stdin\n");
259 H1(" --y4m Force parsing of input stream as YUV4MPEG2 regardless of file extension\n");
260 H0(" --fps <float|rational> Source frame rate (float or num/denom), auto-detected if Y4M\n");
261 H0(" --input-res WxH Source picture size [w x h], auto-detected if Y4M\n");
262 H1(" --input-depth <integer> Bit-depth of input file. Default 8\n");
263 H1(" --input-csp <string> Source color space: i420, i444 or i422, auto-detected if Y4M. Default: i420\n");
264 H0("-f/--frames <integer> Maximum number of frames to encode. Default all\n");
265 H0(" --seek <integer> First frame to encode\n");
266 H1(" --[no-]interlace <bff|tff> Indicate input pictures are interlace fields in temporal order. Default progressive\n");
267 H1(" --dither Enable dither if downscaling to 8 bit pixels. Default disabled\n");
268 H0("\nQuality reporting metrics:\n");
269 H0(" --[no-]ssim Enable reporting SSIM metric scores. Default %s\n", OPT(param->bEnableSsim));
270 H0(" --[no-]psnr Enable reporting PSNR metric scores. Default %s\n", OPT(param->bEnablePsnr));
271 H0("\nProfile, Level, Tier:\n");
272 H0("-P/--profile <string> Enforce an encode profile: main, main10, mainstillpicture\n");
273 H0(" --level-idc <integer|float> Force a minimum required decoder level (as '5.0' or '50')\n");
274 H0(" --[no-]high-tier If a decoder level is specified, this modifier selects High tier of that level\n");
275 H0(" --[no-]allow-non-conformance Allow the encoder to generate profile NONE bitstreams. Default %s\n", OPT(param->bAllowNonConformance));
276 H0("\nThreading, performance:\n");
277 H0(" --pools <integer,...> Comma separated thread count per thread pool (pool per NUMA node)\n");
278 H0(" '-' implies no threads on node, '+' implies one thread per core on node\n");
279 H0("-F/--frame-threads <integer> Number of concurrently encoded frames. 0: auto-determined by core count\n");
280 H0(" --[no-]wpp Enable Wavefront Parallel Processing. Default %s\n", OPT(param->bEnableWavefront));
281 H0(" --[no-]pmode Parallel mode analysis. Default %s\n", OPT(param->bDistributeModeAnalysis));
282 H0(" --[no-]pme Parallel motion estimation. Default %s\n", OPT(param->bDistributeMotionEstimation));
283 H0(" --[no-]asm <bool|int|string> Override CPU detection. Default: auto\n");
284 H0("\nPresets:\n");
285 H0("-p/--preset <string> Trade off performance for compression efficiency. Default medium\n");
286 H0(" ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow, or placebo\n");
287 H0("-t/--tune <string> Tune the settings for a particular type of source or situation:\n");
288 H0(" psnr, ssim, grain, zerolatency, fastdecode\n");
289 H0("\nQuad-Tree size and depth:\n");
290 H0("-s/--ctu <64|32|16> Maximum CU size (WxH). Default %d\n", param->maxCUSize);
291 H0(" --min-cu-size <64|32|16|8> Minimum CU size (WxH). Default %d\n", param->minCUSize);
292 H0(" --max-tu-size <32|16|8|4> Maximum TU size (WxH). Default %d\n", param->maxTUSize);
293 H0(" --tu-intra-depth <integer> Max TU recursive depth for intra CUs. Default %d\n", param->tuQTMaxIntraDepth);
294 H0(" --tu-inter-depth <integer> Max TU recursive depth for inter CUs. Default %d\n", param->tuQTMaxInterDepth);
295 H0("\nAnalysis:\n");
296 H0(" --rd <0..6> Level of RDO in mode decision 0:least....6:full RDO. Default %d\n", param->rdLevel);
297 H0(" --[no-]psy-rd <0..2.0> Strength of psycho-visual rate distortion optimization, 0 to disable. Default %.1f\n", param->psyRd);
298 H0(" --[no-]rdoq-level <0|1|2> Level of RDO in quantization 0:none, 1:levels, 2:levels & coding groups. Default %d\n", param->rdoqLevel);
299 H0(" --[no-]psy-rdoq <0..50.0> Strength of psycho-visual optimization in RDO quantization, 0 to disable. Default %.1f\n", param->psyRdoq);
300 H0(" --[no-]early-skip Enable early SKIP detection. Default %s\n", OPT(param->bEnableEarlySkip));
301 H1(" --[no-]tskip-fast Enable fast intra transform skipping. Default %s\n", OPT(param->bEnableTSkipFast));
302 H1(" --nr-intra <integer> An integer value in range of 0 to 2000, which denotes strength of noise reduction in intra CUs. Default 0\n");
303 H1(" --nr-inter <integer> An integer value in range of 0 to 2000, which denotes strength of noise reduction in inter CUs. Default 0\n");
304 H0("\nCoding tools:\n");
305 H0("-w/--[no-]weightp Enable weighted prediction in P slices. Default %s\n", OPT(param->bEnableWeightedPred));
306 H0(" --[no-]weightb Enable weighted prediction in B slices. Default %s\n", OPT(param->bEnableWeightedBiPred));
307 H0(" --[no-]cu-lossless Consider lossless mode in CU RDO decisions. Default %s\n", OPT(param->bCULossless));
308 H0(" --[no-]signhide Hide sign bit of one coeff per TU (rdo). Default %s\n", OPT(param->bEnableSignHiding));
309 H1(" --[no-]tskip Enable intra 4x4 transform skipping. Default %s\n", OPT(param->bEnableTransformSkip));
310 H0("\nTemporal / motion search options:\n");
311 H0(" --max-merge <1..5> Maximum number of merge candidates. Default %d\n", param->maxNumMergeCand);
312 H0(" --ref <integer> max number of L0 references to be allowed (1 .. 16) Default %d\n", param->maxNumReferences);
313 H0(" --limit-refs <0|1|2|3> limit references per depth (1) or CU (2) or both (3). Default %d\n", param->limitReferences);
314 H0(" --me <string> Motion search method dia hex umh star full. Default %d\n", param->searchMethod);
315 H0("-m/--subme <integer> Amount of subpel refinement to perform (0:least .. 7:most). Default %d \n", param->subpelRefine);
316 H0(" --merange <integer> Motion search range. Default %d\n", param->searchRange);
317 H0(" --[no-]rect Enable rectangular motion partitions Nx2N and 2NxN. Default %s\n", OPT(param->bEnableRectInter));
318 H0(" --[no-]amp Enable asymmetric motion partitions, requires --rect. Default %s\n", OPT(param->bEnableAMP));
319 H1(" --[no-]temporal-mvp Enable temporal MV predictors. Default %s\n", OPT(param->bEnableTemporalMvp));
320 H0("\nSpatial / intra options:\n");
321 H0(" --[no-]strong-intra-smoothing Enable strong intra smoothing for 32x32 blocks. Default %s\n", OPT(param->bEnableStrongIntraSmoothing));
322 H0(" --[no-]constrained-intra Constrained intra prediction (use only intra coded reference pixels) Default %s\n", OPT(param->bEnableConstrainedIntra));
323 H0(" --[no-]b-intra Enable intra in B frames in veryslow presets. Default %s\n", OPT(param->bIntraInBFrames));
324 H0(" --[no-]fast-intra Enable faster search method for angular intra predictions. Default %s\n", OPT(param->bEnableFastIntra));
325 H0(" --rdpenalty <0..2> penalty for 32x32 intra TU in non-I slices. 0:disabled 1:RD-penalty 2:maximum. Default %d\n", param->rdPenalty);
326 H0("\nSlice decision options:\n");
327 H0(" --[no-]open-gop Enable open-GOP, allows I slices to be non-IDR. Default %s\n", OPT(param->bOpenGOP));
328 H0("-I/--keyint <integer> Max IDR period in frames. -1 for infinite-gop. Default %d\n", param->keyframeMax);
329 H0("-i/--min-keyint <integer> Scenecuts closer together than this are coded as I, not IDR. Default: auto\n");
330 H0(" --no-scenecut Disable adaptive I-frame decision\n");
331 H0(" --scenecut <integer> How aggressively to insert extra I-frames. Default %d\n", param->scenecutThreshold);
332 H0(" --rc-lookahead <integer> Number of frames for frame-type lookahead (determines encoder latency) Default %d\n", param->lookaheadDepth);
333 H1(" --lookahead-slices <0..16> Number of slices to use per lookahead cost estimate. Default %d\n", param->lookaheadSlices);
334 H0(" --bframes <integer> Maximum number of consecutive b-frames (now it only enables B GOP structure) Default %d\n", param->bframes);
335 H1(" --bframe-bias <integer> Bias towards B frame decisions. Default %d\n", param->bFrameBias);
336 H0(" --b-adapt <0..2> 0 - none, 1 - fast, 2 - full (trellis) adaptive B frame scheduling. Default %d\n", param->bFrameAdaptive);
337 H0(" --[no-]b-pyramid Use B-frames as references. Default %s\n", OPT(param->bBPyramid));
338 H1(" --qpfile <string> Force frametypes and QPs for some or all frames\n");
339 H1(" Format of each line: framenumber frametype QP\n");
340 H1(" QP is optional (none lets x265 choose). Frametypes: I,i,P,B,b.\n");
341 H1(" QPs are restricted by qpmin/qpmax.\n");
342 H0("\nRate control, Adaptive Quantization:\n");
343 H0(" --bitrate <integer> Target bitrate (kbps) for ABR (implied). Default %d\n", param->rc.bitrate);
344 H1("-q/--qp <integer> QP for P slices in CQP mode (implied). --ipratio and --pbration determine other slice QPs\n");
345 H0(" --crf <float> Quality-based VBR (0-51). Default %.1f\n", param->rc.rfConstant);
346 H1(" --[no-]lossless Enable lossless: bypass transform, quant and loop filters globally. Default %s\n", OPT(param->bLossless));
347 H1(" --crf-max <float> With CRF+VBV, limit RF to this value. Default %f\n", param->rc.rfConstantMax);
348 H1(" May cause VBV underflows!\n");
349 H1(" --crf-min <float> With CRF+VBV, limit RF to this value. Default %f\n", param->rc.rfConstantMin);
350 H1(" this specifies a minimum rate factor value for encode!\n");
351 H0(" --vbv-maxrate <integer> Max local bitrate (kbit/s). Default %d\n", param->rc.vbvMaxBitrate);
352 H0(" --vbv-bufsize <integer> Set size of the VBV buffer (kbit). Default %d\n", param->rc.vbvBufferSize);
353 H0(" --vbv-init <float> Initial VBV buffer occupancy (fraction of bufsize or in kbits). Default %.2f\n", param->rc.vbvBufferInit);
354 H0(" --pass Multi pass rate control.\n"
355 " - 1 : First pass, creates stats file\n"
356 " - 2 : Last pass, does not overwrite stats file\n"
357 " - 3 : Nth pass, overwrites stats file\n");
358 H0(" --stats Filename for stats file in multipass pass rate control. Default x265_2pass.log\n");
359 H0(" --[no-]slow-firstpass Enable a slow first pass in a multipass rate control mode. Default %s\n", OPT(param->rc.bEnableSlowFirstPass));
360 H0(" --[no-]strict-cbr Enable stricter conditions and tolerance for bitrate deviations in CBR mode. Default %s\n", OPT(param->rc.bStrictCbr));
361 H0(" --analysis-mode <string|int> save - Dump analysis info into file, load - Load analysis buffers from the file. Default %d\n", param->analysisMode);
362 H0(" --analysis-file <filename> Specify file name used for either dumping or reading analysis data.\n");
363 H0(" --aq-mode <integer> Mode for Adaptive Quantization - 0:none 1:uniform AQ 2:auto variance 3:auto variance with bias to dark scenes. Default %d\n", param->rc.aqMode);
364 H0(" --aq-strength <float> Reduces blocking and blurring in flat and textured areas (0 to 3.0). Default %.2f\n", param->rc.aqStrength);
365 H0(" --qg-size <int> Specifies the size of the quantization group (64, 32, 16). Default %d\n", param->rc.qgSize);
366 H0(" --[no-]cutree Enable cutree for Adaptive Quantization. Default %s\n", OPT(param->rc.cuTree));
367 H1(" --ipratio <float> QP factor between I and P. Default %.2f\n", param->rc.ipFactor);
368 H1(" --pbratio <float> QP factor between P and B. Default %.2f\n", param->rc.pbFactor);
369 H1(" --qcomp <float> Weight given to predicted complexity. Default %.2f\n", param->rc.qCompress);
370 H1(" --qpstep <integer> The maximum single adjustment in QP allowed to rate control. Default %d\n", param->rc.qpStep);
371 H1(" --cbqpoffs <integer> Chroma Cb QP Offset [-12..12]. Default %d\n", param->cbQpOffset);
372 H1(" --crqpoffs <integer> Chroma Cr QP Offset [-12..12]. Default %d\n", param->crQpOffset);
373 H1(" --scaling-list <string> Specify a file containing HM style quant scaling lists or 'default' or 'off'. Default: off\n");
374 H1(" --zones <zone0>/<zone1>/... Tweak the bitrate of regions of the video\n");
375 H1(" Each zone is of the form\n");
376 H1(" <start frame>,<end frame>,<option>\n");
377 H1(" where <option> is either\n");
378 H1(" q=<integer> (force QP)\n");
379 H1(" or b=<float> (bitrate multiplier)\n");
380 H1(" --lambda-file <string> Specify a file containing replacement values for the lambda tables\n");
381 H1(" MAX_MAX_QP+1 floats for lambda table, then again for lambda2 table\n");
382 H1(" Blank lines and lines starting with hash(#) are ignored\n");
383 H1(" Comma is considered to be white-space\n");
384 H0("\nLoop filters (deblock and SAO):\n");
385 H0(" --[no-]deblock Enable Deblocking Loop Filter, optionally specify tC:Beta offsets Default %s\n", OPT(param->bEnableLoopFilter));
386 H0(" --[no-]sao Enable Sample Adaptive Offset. Default %s\n", OPT(param->bEnableSAO));
387 H1(" --[no-]sao-non-deblock Use non-deblocked pixels, else right/bottom boundary areas skipped. Default %s\n", OPT(param->bSaoNonDeblocked));
388 H0("\nVUI options:\n");
389 H0(" --sar <width:height|int> Sample Aspect Ratio, the ratio of width to height of an individual pixel.\n");
390 H0(" Choose from 0=undef, 1=1:1(\"square\"), 2=12:11, 3=10:11, 4=16:11,\n");
391 H0(" 5=40:33, 6=24:11, 7=20:11, 8=32:11, 9=80:33, 10=18:11, 11=15:11,\n");
392 H0(" 12=64:33, 13=160:99, 14=4:3, 15=3:2, 16=2:1 or custom ratio of <int:int>. Default %d\n", param->vui.aspectRatioIdc);
393 H1(" --display-window <string> Describe overscan cropping region as 'left,top,right,bottom' in pixels\n");
394 H1(" --overscan <string> Specify whether it is appropriate for decoder to show cropped region: undef, show or crop. Default undef\n");
395 H0(" --videoformat <string> Specify video format from undef, component, pal, ntsc, secam, mac. Default undef\n");
396 H0(" --range <string> Specify black level and range of luma and chroma signals as full or limited Default limited\n");
397 H0(" --colorprim <string> Specify color primaries from undef, bt709, bt470m, bt470bg, smpte170m,\n");
398 H0(" smpte240m, film, bt2020. Default undef\n");
399 H0(" --transfer <string> Specify transfer characteristics from undef, bt709, bt470m, bt470bg, smpte170m,\n");
400 H0(" smpte240m, linear, log100, log316, iec61966-2-4, bt1361e, iec61966-2-1,\n");
401 H0(" bt2020-10, bt2020-12, smpte-st-2084, smpte-st-428, arib-std-b67. Default undef\n");
402 H1(" --colormatrix <string> Specify color matrix setting from undef, bt709, fcc, bt470bg, smpte170m,\n");
403 H1(" smpte240m, GBR, YCgCo, bt2020nc, bt2020c. Default undef\n");
404 H1(" --chromaloc <integer> Specify chroma sample location (0 to 5). Default of %d\n", param->vui.chromaSampleLocTypeTopField);
405 H0(" --master-display <string> SMPTE ST 2086 master display color volume info SEI (HDR)\n");
406 H0(" format: G(x,y)B(x,y)R(x,y)WP(x,y)L(max,min)\n");
407 H0(" --max-cll <string> Emit content light level info SEI as \"cll,fall\" (HDR)\n");
408 H0(" --min-luma <integer> Minimum luma plane value of input source picture\n");
409 H0(" --max-luma <integer> Maximum luma plane value of input source picture\n");
410 H0("\nBitstream options:\n");
411 H0(" --[no-]repeat-headers Emit SPS and PPS headers at each keyframe. Default %s\n", OPT(param->bRepeatHeaders));
412 H0(" --[no-]info Emit SEI identifying encoder and parameters. Default %s\n", OPT(param->bEmitInfoSEI));
413 H0(" --[no-]hrd Enable HRD parameters signaling. Default %s\n", OPT(param->bEmitHRDSEI));
414 H0(" --[no-]temporal-layers Enable a temporal sublayer for unreferenced B frames. Default %s\n", OPT(param->bEnableTemporalSubLayers));
415 H0(" --[no-]aud Emit access unit delimiters at the start of each access unit. Default %s\n", OPT(param->bEnableAccessUnitDelimiters));
416 H1(" --hash <integer> Decoded Picture Hash SEI 0: disabled, 1: MD5, 2: CRC, 3: Checksum. Default %d\n", param->decodedPictureHashSEI);
417 H1("\nReconstructed video options (debugging):\n");
418 H1("-r/--recon <filename> Reconstructed raw image YUV or Y4M output file name\n");
419 H1(" --recon-depth <integer> Bit-depth of reconstructed raw image file. Defaults to input bit depth, or 8 if Y4M\n");
420 H1(" --recon-y4m-exec <string> pipe reconstructed frames to Y4M viewer, ex:\"ffplay -i pipe:0 -autoexit\"\n");
421 H1("\nExecutable return codes:\n");
422 H1(" 0 - encode successful\n");
423 H1(" 1 - unable to parse command line\n");
424 H1(" 2 - unable to open encoder\n");
425 H1(" 3 - unable to generate stream headers\n");
426 H1(" 4 - encoder abort\n");
427 #undef OPT
428 #undef H0
429 #undef H1
430
431 if (level < X265_LOG_DEBUG)
432 printf("\nUse --log-level full --help for a full listing\n");
433 printf("\n\nComplete documentation may be found at http://x265.readthedocs.org/en/default/cli.html\n");
434 exit(1);
435 }
436
437 #ifdef __cplusplus
438 }
439 #endif
440
441 #endif