1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
//! Bindings for the [NVIDIA Video Codec SDK](https://developer.nvidia.com/video-codec-sdk).
//!
//! The raw bindings can be found in [`sys`].
//! Parts of the API have been wrapped in [`safe`].
//!
//! Feel free to contribute!
//!
//! ---
//!
//! # Encoding
//!
//! See [NVIDIA Video Codec SDK - Video Encoder API Programming Guide](https://docs.nvidia.com/video-technologies/video-codec-sdk/12.0/nvenc-video-encoder-api-prog-guide/index.html).
//!
//! The main entrypoint for the encoder API is the [`Encoder`] type.
//!
//! Usage follows this structure:
//! 1. Initialize an [`Encoder`] with an encode device (such as CUDA).
//! 2. Configure the encoder and start a [`Session`].
//! 3. Create input [`Buffer`]s (or [`RegisteredResource`])
//! and output [`Bitstream`]s.
//! 4. Encode frames with [`Session::encode_picture`].
//!
//! See the mentioned types for more info on how to use each.
//!
//! # Decoding
//!
//! There is no safe wrapper yet.
#![warn(
missing_docs,
clippy::pedantic,
clippy::style,
clippy::unwrap_used,
missing_debug_implementations,
missing_copy_implementations
)]
pub mod safe;
pub mod sys;
#[macro_use]
extern crate lazy_static;
pub use safe::*;