Update usage and readme.

This commit is contained in:
Ari Koivula 2015-01-12 10:59:28 +02:00
parent f4bd322804
commit bbae2e8a27
2 changed files with 14 additions and 9 deletions

View file

@ -12,8 +12,6 @@ http://github.com/ultravideo/kvazaar/wiki/List-of-suggested-topics for a list of
[![Build Status](https://travis-ci.org/ultravideo/kvazaar.svg?branch=master)](https://travis-ci.org/ultravideo/kvazaar) [![Build Status](https://travis-ci.org/ultravideo/kvazaar.svg?branch=master)](https://travis-ci.org/ultravideo/kvazaar)
##Using Kvazaar ##Using Kvazaar
Currently most of the features are turned on/off from the code on compile time, but they are
meant to be user configurable later.
Usage: Usage:
kvazaar -i <input> --input-res <width>x<height> -o <output> kvazaar -i <input> --input-res <width>x<height> -o <output>
@ -46,6 +44,10 @@ meant to be user configurable later.
--subme <integer> : Set fractional pixel motion estimation level [1]. --subme <integer> : Set fractional pixel motion estimation level [1].
0: only integer motion estimation 0: only integer motion estimation
1: fractional pixel motion estimation enabled 1: fractional pixel motion estimation enabled
--pu-depth-inter <int>-<int> : Range for sizes of inter prediction units to try.
0: 64x64, 1: 32x32, 2: 16x16, 3: 8x8
--pu-depth-intra <int>-<int> : Range for sizes of intra prediction units to try.
0: 64x64, 1: 32x32, 2: 16x16, 3: 8x8, 4: 4x4
Video Usability Information: Video Usability Information:
--sar <width:height> : Specify Sample Aspect Ratio --sar <width:height> : Specify Sample Aspect Ratio
@ -67,25 +69,25 @@ meant to be user configurable later.
- undef, bt709, fcc, bt470bg, smpte170m, - undef, bt709, fcc, bt470bg, smpte170m,
smpte240m, GBR, YCgCo, bt2020nc, bt2020c smpte240m, GBR, YCgCo, bt2020nc, bt2020c
--chromaloc <integer> : Specify chroma sample location (0 to 5) [0] --chromaloc <integer> : Specify chroma sample location (0 to 5) [0]
Parallel processing: Parallel processing:
--threads <integer> : Maximum number of threads to use. --threads <integer> : Maximum number of threads to use.
Disable threads if set to 0. Disable threads if set to 0.
Tiles: Tiles:
--tiles-width-split <string>|u<int>: --tiles-width-split <string>|u<int> :
Specifies a comma separated list of pixel Specifies a comma separated list of pixel
positions of tiles columns separation coordinates. positions of tiles columns separation coordinates.
Can also be u followed by and a single int n, Can also be u followed by and a single int n,
in which case it produces columns of uniform width. in which case it produces columns of uniform width.
--tiles-height-split <string>|u<int>: --tiles-height-split <string>|u<int> :
Specifies a comma separated list of pixel Specifies a comma separated list of pixel
positions of tiles rows separation coordinates. positions of tiles rows separation coordinates.
Can also be u followed by and a single int n, Can also be u followed by and a single int n,
in which case it produces rows of uniform height. in which case it produces rows of uniform height.
Wpp: Wpp:
--wpp: Enable wavefront parallel processing --wpp : Enable wavefront parallel processing
--owf <integer>|auto : Number of parallel frames to process. 0 to disable. --owf <integer>|auto : Number of parallel frames to process. 0 to disable.
Slices: Slices:
@ -101,7 +103,6 @@ meant to be user configurable later.
-h, --height : Height of input in pixels -h, --height : Height of input in pixels
Example: Example:
kvazaar -i <INPUT_YUV> --input-res <WIDTH>x<HEIGHT> -o <OUTPUT.BIN> -n <NUMBER_OF_FRAMES> -q <QP> kvazaar -i <INPUT_YUV> --input-res <WIDTH>x<HEIGHT> -o <OUTPUT.BIN> -n <NUMBER_OF_FRAMES> -q <QP>
eg. `kvazaar -i BQMall_832x480_60.yuv --input-res 832x480 -o out.bin -n 600 -q 32` eg. `kvazaar -i BQMall_832x480_60.yuv --input-res 832x480 -o out.bin -n 600 -q 32`

View file

@ -122,6 +122,10 @@ int main(int argc, char *argv[])
" --subme <integer> : Set fractional pixel motion estimation level [1].\n" " --subme <integer> : Set fractional pixel motion estimation level [1].\n"
" 0: only integer motion estimation\n" " 0: only integer motion estimation\n"
" 1: fractional pixel motion estimation enabled\n" " 1: fractional pixel motion estimation enabled\n"
" --pu-depth-inter <int>-<int> : Range for sizes of inter prediction units to try.\n"
" 0: 64x64, 1: 32x32, 2: 16x16, 3: 8x8\n"
" --pu-depth-intra <int>-<int> : Range for sizes of intra prediction units to try.\n"
" 0: 64x64, 1: 32x32, 2: 16x16, 3: 8x8, 4: 4x4\n"
"\n" "\n"
" Video Usability Information:\n" " Video Usability Information:\n"
" --sar <width:height> : Specify Sample Aspect Ratio\n" " --sar <width:height> : Specify Sample Aspect Ratio\n"
@ -144,7 +148,7 @@ int main(int argc, char *argv[])
" smpte240m, GBR, YCgCo, bt2020nc, bt2020c\n" " smpte240m, GBR, YCgCo, bt2020nc, bt2020c\n"
" --chromaloc <integer> : Specify chroma sample location (0 to 5) [0]\n" " --chromaloc <integer> : Specify chroma sample location (0 to 5) [0]\n"
"\n" "\n"
" Parallel processing :\n" " Parallel processing:\n"
" --threads <integer> : Maximum number of threads to use.\n" " --threads <integer> : Maximum number of threads to use.\n"
" Disable threads if set to 0.\n" " Disable threads if set to 0.\n"
"\n" "\n"