Struct openh264::decoder::Decoder

pub struct Decoder { /* private fields */ }

An OpenH264 decoder.

Implementations

impl Decoder

pub fn new() -> Result<Self, Error>

Create a decoder with default settings.

pub fn with_config(config: DecoderConfig) -> Result<Self, Error>

Create a decoder with the provided configuration.

pub fn decode(&mut self, packet: &[u8]) -> Result<Option<DecodedYUV<'_>>, Error>

Decodes a series of H.264 NAL packets and returns the latest picture.

This function can be called with:

• only a complete SPS / PPS header (usually the first some 30 bytes of a H.264 stream)
• the headers and series of complete frames
• new frames after previous headers and frames were successfully decoded.

In each case, it will return Some(decoded) image in YUV format if an image was available, or None if more data needs to be provided.

Errors

The function returns an error if the bitstream was corrupted.

pub unsafe fn raw_api(&mut self) -> &mut DecoderRawAPI

Obtain the raw API for advanced use cases.

When resorting to this call, please consider filing an issue / PR.

Safety

You must not set parameters the decoder relies on, we recommend checking the source.

Example

use openh264::decoder::{DecoderConfig, Decoder};

let config = DecoderConfig::default();
let mut decoder = Decoder::with_config(config)?;

unsafe {
    let _ = decoder.raw_api();
};

Trait Implementations

impl Debug for Decoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Decoder

fn drop(&mut self)

Executes the destructor for this type.