(this article is also available on my dev.to<\/a> profile, I might use it more often since wordpress is pretty horrible at managing markdown.)<\/small><\/p>\n \nAV1<\/a> is a modern video codec brought to you by an alliance of many<\/a> different bigger and smaller players in the multimedia field. rav1e<\/a>: The safest and fastest AV1 encoder, built by many volunteers and Mozilla\/Xiph developers. crav1e<\/a>: A companion crate<\/a>, written by yours truly<\/a>, that provides a C-API, so the encoder can be used by C libraries and programs.<\/p><\/blockquote>\n This article will just give a quick overview of the API available right now and it is mainly to help people start using it and hopefully report issues and problem.<\/p>\n The current API is built around the following 4 structs and 1 enum:<\/p>\n The The NOTE<\/strong>: Some of the fields above may be shuffled around until the API is marked as stable.<\/p><\/blockquote>\n It produces a new encoding context. Where It is produced by The The encoder works by processing each
\nI’m part of the VideoLan<\/a> organization and I spent quite a bit of time on this codec lately.<\/p><\/blockquote>\n
\n
\nIt is written in rust<\/a> and strives to provide good speed, quality and stay maintainable.<\/p><\/blockquote>\n
\n
\nRav1e API<\/h2>\n
\n
struct Frame<\/code>: The raw pixel data<\/li>\nstruct Packet<\/code>: The encoded bitstream<\/li>\nstruct Config<\/code>: The encoder configuration<\/li>\nstruct Context<\/code>: The encoder state<\/li>\n<\/ul>\n
\n\n
enum EncoderStatus<\/code>: Fatal and non-fatal condition returned by the Context<\/code>methods.<\/li>\n<\/ul>\nConfig<\/h3>\n
Config<\/code> struct currently is simply constructed.<\/p>\n<\/span> <\/span>struct<\/span> Config<\/span> <\/span>{<\/span><\/span>\n <\/span>enc<\/span>: EncoderConfig<\/span>,<\/span><\/span>\n <\/span>threads<\/span>: usize<\/span>,<\/span><\/span>\n <\/span>}<\/span><\/span>\n<\/pre>\n<\/div>\nEncoderConfig<\/code> stores all the settings that have an impact to the actual bitstream while settings such as threads<\/code> are kept outside.<\/p>\n<\/span> <\/span>let<\/span> <\/span>mut<\/span> <\/span>enc<\/span> <\/span>=<\/span> <\/span>EncoderConfig<\/span>::with_speed_preset<\/span>(<\/span>speed<\/span>);<\/span><\/span>\n <\/span>enc<\/span>.<\/span>width<\/span> <\/span>=<\/span> <\/span>w<\/span>;<\/span><\/span>\n <\/span>enc<\/span>.<\/span>height<\/span> <\/span>=<\/span> <\/span>h<\/span>;<\/span><\/span>\n <\/span>enc<\/span>.<\/span>bit_depth<\/span> <\/span>=<\/span> <\/span>8<\/span>;<\/span><\/span>\n <\/span>let<\/span> <\/span>cfg<\/span> <\/span>=<\/span> <\/span>Config<\/span> <\/span>{<\/span> <\/span>enc<\/span>,<\/span> <\/span>threads<\/span>: 0<\/span> <\/span>};<\/span><\/span>\n<\/pre>\n<\/div>\nMethods<\/h4>\n
new_context<\/h5>\n
<\/span> <\/span>let<\/span> <\/span>cfg<\/span> <\/span>=<\/span> <\/span>Config<\/span> <\/span>{<\/span> <\/span>enc<\/span>,<\/span> <\/span>threads<\/span>: 0<\/span> <\/span>};<\/span><\/span>\n <\/span>let<\/span> <\/span>ctx<\/span>: Context<\/span><<\/span>u8<\/span>><\/span> <\/span>=<\/span> <\/span>cfg<\/span>.<\/span>new_context<\/span>();<\/span><\/span>\n<\/pre>\n<\/div>\nbit_depth<\/code> is 8<\/em>, it is possible to use an optimized u8<\/code> codepath, otherwise u16<\/code> must be used.<\/p>\nContext<\/h3>\n
Config::new_context<\/code>, its implementation details are hidden.<\/p>\nMethods<\/h4>\n
Context<\/code> can be grouped into essential<\/strong>, optional<\/strong> and convenience<\/strong>.<\/p>\n<\/span> <\/span>\/\/ Essential API<\/span>\n <\/span>pub<\/span> <\/span>fn<\/span> send_frame<\/span><<\/span>F<\/span>><\/span>(<\/span>&<\/span>mut<\/span> <\/span>self<\/span>,<\/span> <\/span>frame<\/span>: F<\/span>)<\/span> <\/span>-> Result<\/span><<\/span>(),<\/span> <\/span>EncoderStatus<\/span>><\/span><\/span>\n <\/span>where<\/span> <\/span>F<\/span>: Into<\/span><<\/span>Option<\/span><<\/span>Arc<\/span><<\/span>Frame<\/span><<\/span>T<\/span>>>>><\/span>,<\/span> <\/span>T<\/span>: Pixel<\/span>;<\/span><\/span>\n <\/span>pub<\/span> <\/span>fn<\/span> receive_packet<\/span>(<\/span>&<\/span>mut<\/span> <\/span>self<\/span>)<\/span> <\/span>-> Result<\/span><<\/span>Packet<\/span><<\/span>T<\/span>><\/span>,<\/span> <\/span>EncoderStatus<\/span>><\/span>;<\/span><\/span>\n<\/pre>\n<\/div>\nFrame<\/code> fed through send_frame<\/code> and producing each Packet<\/code> that can be retrieved by receive_packet<\/code>.<\/p>\n