{"id":706,"date":"2018-11-13T12:57:55","date_gmt":"2018-11-13T12:57:55","guid":{"rendered":"http:\/\/blogs.gentoo.org\/lu_zero\/?p=706"},"modified":"2018-11-13T12:57:55","modified_gmt":"2018-11-13T12:57:55","slug":"rav1e-and-crav1e-a-fast-and-safe-av1-encoder-some-howto","status":"publish","type":"post","link":"https:\/\/blogs.gentoo.org\/lu_zero\/2018\/11\/13\/rav1e-and-crav1e-a-fast-and-safe-av1-encoder-some-howto\/","title":{"rendered":"rav1e and crav1e – A fast and safe AV1 encoder – Some HowTo"},"content":{"rendered":"

Over the year I contributed to an AV1<\/a> encoder written in rust<\/a>.<\/p>\n

Here a small tutorial about what is available right now, there is still lots to do, but I think we could enjoy more user-feedback (and possibly also some help).<\/p>\n

Setting up<\/h2>\n

Install the rust toolchain<\/h3>\n

If you do not have rust<\/a> installed, it is quite simple to get a full environment using rustup<\/a><\/p>\n

$ curl https:\/\/sh.rustup.rs -sSf | sh\n# Answer the questions asked and make sure you source the `.profile` file created.\n$ source ~\/.profile\n<\/code><\/pre>\n
Install cmake, perl and nasm<\/h3>\n
rav1e<\/a> uses libaom<\/a> for testing and and on x86\/x86_64 some components have SIMD variants written directly using nasm<\/code>.<\/p>\n
You may follow the instructions<\/a>, or just install:
\n– nasm<\/a> (version 2.13 or better)
\n– perl<\/a> (any recent perl5)
\n– cmake<\/a> (any recent version)<\/p>\n
Once you have those dependencies in you are set.<\/p>\n
Building rav1e<\/h3>\n
We use cargo<\/strong>, so the process is straightforward:<\/p>\n
## Pull in the customized libaom if you want to run all the tests\n$ git submodule update --init\n\n## Build everything\n$ cargo build --release\n\n## Test to make sure everything works as intended\n$ cargo test --features decode_test --release\n\n## Install rav1e\n$ cargo install\n<\/code><\/pre>\n
Using rav1e<\/h2>\n
Right now rav1e has a quite simple interface:<\/p>\n
rav1e 0.1.0\nAV1 video encoder\n\nUSAGE:\n    rav1e [OPTIONS]  --output \n\nFLAGS:\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nOPTIONS:\n    -I, --keyint     Keyframe interval [default: 30]\n    -l, --limit                  Maximum number of frames to encode [default: 0]\n        --low_latency      low latency mode. true or false [default: true]\n    -o, --output                Compressed AV1 in IVF video output\n        --quantizer                 Quantizer (0-255) [default: 100]\n    -r \n    -s, --speed                  Speed level (0(slow)-10(fast)) [default: 3]\n        --tune                    Quality tuning (Will enforce partition sizes >= 8x8) [default: psnr]  [possible\n                                        values: Psnr, Psychovisual]\n\nARGS:\n        Uncompressed YUV4MPEG2 video input\n\n<\/code><\/pre>\n
It accepts y4m<\/code> raw source and produces ivf<\/code> files.<\/p>\n
You can configure the encoder by setting the speed<\/code> and quantizer<\/code> levels.<\/p>\n
The low_latency<\/code> flag can be turned off to run some additional analysis over a set of frames and have additional quality gains.<\/p>\n
Crav1e<\/h2>\n
While ave<\/a> and gst-rs<\/a> will use the rav1e<\/strong> crate directly, there are a number of software such as handbrake<\/a> or vlc<\/a> that would be much happier to consume a C API.<\/p>\n
Thanks to the staticlib<\/code> target and cbindgen<\/a> is quite easy to produce a C-ABI library and its matching header.<\/p>\n
Setup<\/h3>\n
crav1e<\/a> is built using cargo<\/a>, so nothing special is needed right now beside nasm<\/code> if you are building it on x86\/x86_64<\/code>.<\/p>\n
Build the library<\/h4>\n
This step is completely straightforward, you can build it as release<\/code>:<\/p>\n
$ cargo build --release\n<\/code><\/pre>\n
or as debug<\/code><\/p>\n
$ cargo build\n<\/code><\/pre>\n
It will produce a target\/release\/librav1e.a<\/code> or a target\/debug\/librav1e.a<\/code>.
\nThe C header will be in include\/rav1e.h<\/code>.<\/p>\n
Try the example code<\/h4>\n
I provided a quite minimal sample case.<\/p>\n
cc -Wall c-examples\/simple_encoding.c -Ltarget\/release\/ -lrav1e -Iinclude\/ -o c-examples\/simple_encoding\n.\/c-examples\/simple_encoding\n<\/code><\/pre>\n
If it builds and runs correctly you are set.<\/p>\n
Manually copy the .a<\/code> and the .h<\/code><\/h4>\n
Currently cargo install<\/code> does not work for our purposes, but it will change in the future.<\/p>\n
$ cp target\/release\/librav1e.a \/usr\/local\/lib\n$ cp include\/rav1e.h \/usr\/local\/include\/\n<\/code><\/pre>\n
Missing pieces<\/h3>\n
Right now crav1e<\/code> works well enough but there are few shortcomings I’m trying to address.<\/p>\n
Shared library support<\/h4>\n
The cdylib<\/code> target does exist and produce a nearly usable library but there are some issues with soname<\/a> support. I’m trying to address<\/a> them with upstream, but it might take some time.<\/p>\n
Meanwhile some people suggest to use patchelf<\/a> or similar tools to fix the library after the fact.<\/p>\n
Install target<\/h4>\n
cargo<\/code> is generally awesome, but sadly its support for installing arbitrary files to arbitrary paths is limited<\/a>, luckily there are people proposing solutions.<\/p>\n
pkg-config<\/code> file generation<\/h5>\n
I consider a library not proper if a .pc<\/code> file is not provided with it.<\/p>\n
Right now there are means to extract the information need to build a pkg-config<\/code> file, but there isn’t a simple way to do it.<\/p>\n
$ cargo rustc -- --print native-static-libs\n<\/code><\/pre>\n
Provides what is needed for Libs.private<\/code>, ideally it should be created as part of the install step since you need to know the prefix<\/code>, libdir<\/code> and includedir<\/code> paths.<\/p>\n
Coming next<\/h2>\n
Probably the next blog post will be about my efforts to make cargo<\/a> able to produce proper cdylib<\/code> or something quite different.<\/p>\n
\n  PS<\/strong>: If somebody feels to help me with matroska in AV1<\/a> would be great \ud83d\ude42\n<\/p><\/blockquote>\n","protected":false},"excerpt":{"rendered":"
Over the year I contributed to an AV1 encoder written in rust. Here a small tutorial about what is available right now, there is still lots to do, but I think we could enjoy more user-feedback (and possibly also some help). Setting up Install the rust toolchain If you do not have rust installed, it … Continue reading rav1e and crav1e – A fast and safe AV1 encoder – Some HowTo<\/span><\/a><\/p>\n","protected":false},"author":10,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"spay_email":"","jetpack_publicize_message":"","jetpack_is_tweetstorm":false,"jetpack_publicize_feature_enabled":true},"categories":[1],"tags":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p1aGWH-bo","_links":{"self":[{"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/posts\/706"}],"collection":[{"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/users\/10"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/comments?post=706"}],"version-history":[{"count":5,"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/posts\/706\/revisions"}],"predecessor-version":[{"id":711,"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/posts\/706\/revisions\/711"}],"wp:attachment":[{"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/media?parent=706"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/categories?post=706"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.gentoo.org\/lu_zero\/wp-json\/wp\/v2\/tags?post=706"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}