hashirama/uvg266
1
0
Fork 0
mirror of https://github.com/ultravideo/uvg266.git synced 2024-11-30 12:44:07 +00:00
Code Issues Actions Projects Releases Wiki Activity

Update README.

Browse source 
- Moves the link to List suggested topics to section Contributing to
  Kvazaar.
- Removes the redundant command line usage example.
- Adds information about the Kvazaar library.
- Reorders subsections of section Compiling Kvazaar.
- Adds instructions for using NASM as the assembler.
- Adds information about how the libraries are built with the Makefile.
This commit is contained in:
Arttu Ylä-Outinen 2015-10-27 11:04:00 +02:00
parent d71f1b5bd0
commit 9579fb40c8
1 changed files with 37 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -7,8 +7,6 @@ Kvazaar is not yet finished and does not implement all the features of HEVC. Com
http://ultravideo.cs.tut.fi/#encoder for more information. http://ultravideo.cs.tut.fi/#encoder for more information.
http://github.com/ultravideo/kvazaar/wiki/List-of-suggested-topics for a list of topics you might want to examine if you would like to do something bigger than a bug fix but don't know what yet.
[![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
@ -123,45 +121,60 @@ http://github.com/ultravideo/kvazaar/wiki/List-of-suggested-topics for a list of
-w, --width : Width of input in pixels -w, --width : Width of input in pixels
-h, --height : Height of input in pixels -h, --height : Height of input in pixels
Example: For example:
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` kvazaar -i BQMall_832x480_60.yuv --input-res 832x480 -o out.hevc -n 600 -q 32
The only accepted input format so far is 8-bit YUV 4:2:0. The only accepted input format so far is 8-bit YUV 4:2:0.
##Kvazaar library
See [kvazaar.h](src/kvazaar.h) for the library API and its
documentation.
When using the static Kvazaar library on Windows, macro `KVZ_STATIC_LIB`
must be defined. On other platforms it's not strictly required.
The needed linker and compiler flags can be obtained with pkg-config.
##Compiling Kvazaar ##Compiling Kvazaar
If you have trouble regarding compiling the source code, please make an [issue](https://github.com/ultravideo/kvazaar/issues) about in Github. Others might encounter the same problem and there is probably much to improve in the build process. We want to make this as simple as possible. If you have trouble regarding compiling the source code, please make an [issue](https://github.com/ultravideo/kvazaar/issues) about in Github. Others might encounter the same problem and there is probably much to improve in the build process. We want to make this as simple as possible.
###Required libraries ###Required libraries
- For Visual Studio pthreads-w32 library is required. Platforms with native posix thread support don't need anything. - For Visual Studio, the pthreads-w32 library is required. Platforms with native POSIX thread support don't need anything.
- The project file expects the library to be in ../pthreads.2/ relative to kvazaar. You can just extract the pre-built library there. - The project file expects the library to be in ../pthreads.2/ relative to Kvazaar. You can just extract the pre-built library there.
- The executable needs pthreadVC2.dll to be present. Either install it somewhere or ship it with the executable. - The executable needs pthreadVC2.dll to be present. Either install it somewhere or ship it with the executable.
###Visual Studio 2010
- VS2010 and older does not have support for some of the c99 features that we use. Please use VS2013 or newer or GCC (MinGW) to compile on windows.
###Visual Studio 2013
- project files included
- requires external [vsyasm.exe](http://yasm.tortall.net/Download.html) in %PATH%
- run `rundll32 sysdm.cpl,EditEnvironmentVariables` and add PATH to user variables
###GCC ###GCC
- Simple Makefile included in src/ - Makefile can be found in the src directory.
- Yasm is expected to be in PATH - Yasm is expected to be in PATH.
- Alternatively, NASM can be used by passing `AS=nasm` to make.
On Linux, both the shared and the static library are built and installed
by default. On Windows and OS&nbsp;X, the default is to only build the
DLL/dylib. The static command line program is built by default on all
platforms.
The default targets can be installed by running `make install`.
###OS X ###OS X
- The program should compile and work on OS X but you might need a newer version of GCC than what comes with the platform. - The program should compile and work on OS X but you might need a newer version of GCC than what comes with the platform.
###Other ###Visual Studio
- There is a scons SConstruct file that should work on both Windows and Linux. - VS2010 and older do not have support for some of the C99 features that we use. Please use VS2013 or newer or GCC (MinGW) to compile on Windows.
- Contact us for support or write an [issue in Github](https://github.com/ultravideo/kvazaar/issues) - Project files can be found under build/.
- Requires external [vsyasm.exe](http://yasm.tortall.net/Download.html) in %PATH%
- Run `rundll32 sysdm.cpl,EditEnvironmentVariables` and add PATH to user variables
- Building the Kvazaar library is not yet supported.
##Contributing to Kvazaar ##Contributing to Kvazaar
See http://github.com/ultravideo/kvazaar/wiki/List-of-suggested-topics
for a list of topics you might want to examine if you would like to do
something bigger than a bug fix but don't know what yet.
###For version control we try to follow these conventions: ###For version control we try to follow these conventions:
- Master branch always produces a working bitstream (can be decoded with HM). - Master branch always produces a working bitstream (can be decoded with HM).
@ -170,14 +183,14 @@ If you have trouble regarding compiling the source code, please make an [issue](
- Every commit should at least compile. Producing a working bitstream is nice as well, but not always possible. Features may be temporarily disabled to produce a working bitstream, but remember to re-enbable them before merging to master. - Every commit should at least compile. Producing a working bitstream is nice as well, but not always possible. Features may be temporarily disabled to produce a working bitstream, but remember to re-enbable them before merging to master.
###Testing: ###Testing
- We do not have a proper testing framework yet. We test mainly by decoding the bitstream with HM and checking that the result matches the encoders own reconstruction. - We do not have a proper testing framework yet. We test mainly by decoding the bitstream with HM and checking that the result matches the encoders own reconstruction.
- You should at least test that HM decodes a bitstream file made with your changes without throwing checksum errors. If your changes shouldn't alter the bitstream, you should check that they don't. - You should at least test that HM decodes a bitstream file made with your changes without throwing checksum errors. If your changes shouldn't alter the bitstream, you should check that they don't.
- We would like to have a suite of automatic tests that also check for BD-rate increase and speed decrease in addition to checking that the bitstream is valid. As of yet there is no such suite. - We would like to have a suite of automatic tests that also check for BD-rate increase and speed decrease in addition to checking that the bitstream is valid. As of yet there is no such suite.
###Unit tests: ###Unit tests
- There are some unit tests located in the tests directory. We would like to have more. - There are some unit tests located in the tests directory. We would like to have more.
- The Visual Studio project links the unit tests against the actual .lib file used by the encoder. There is no Makefile as of yet. - The Visual Studio project links the unit tests against the actual .lib file used by the encoder. There is no Makefile as of yet.
- The unit tests use "greatest" unit testing framework. It is included as a submodule, but getting it requires the following commands to be run in the root directory of kvazaar: - The unit tests use "greatest" unit testing framework. It is included as a submodule, but getting it requires the following commands to be run in the root directory of kvazaar:
@ -186,7 +199,7 @@ If you have trouble regarding compiling the source code, please make an [issue](
git submodule update git submodule update
###Code style: ###Code style
We try to follow the following conventions: We try to follow the following conventions:
- C99 without features not supported by Visual Studio 2013 (VLAs). - C99 without features not supported by Visual Studio 2013 (VLAs).
@ -200,7 +213,7 @@ We try to follow the following conventions:
- Functions only used inside the module shouldn't be defined in the module header. They can be defined in the beginning of the .c file if necessary. - Functions only used inside the module shouldn't be defined in the module header. They can be defined in the beginning of the .c file if necessary.
###Resources for HEVC bitstream features: ###Resources for HEVC bitstream features
- A good first resource for HEVC bitstream is JCTVC-N1002 High Efficiency Video Coding (HEVC) Test Model 12 (HM12) Encoder Description - A good first resource for HEVC bitstream is JCTVC-N1002 High Efficiency Video Coding (HEVC) Test Model 12 (HM12) Encoder Description
- Many good articles regarding specific parts of HEVC can be found on IEEE Transactions on Circuits and Systems for Video Technology, Combined issue on High Efficiency Video Coding (HEVC) Standards and Research - Many good articles regarding specific parts of HEVC can be found on IEEE Transactions on Circuits and Systems for Video Technology, Combined issue on High Efficiency Video Coding (HEVC) Standards and Research