Expand description
mediadecode-ffmpeg
Implements mediadecode’s VideoAdapter / AudioAdapter /
SubtitleAdapter / ImageAdapter traits, the matching push-style
*StreamDecoder traits, the one-shot ImageDecoder, and Demuxer.
Every byte a frame or packet carries is copied once, at the FFmpeg
boundary, into an FfmpegBytes — mediadecode 0.9’s D-seat
amputation contract. A delivered frame is owned, Send + Sync, and
cheap to clone (a refcount bump); it holds nothing of libavcodec’s
open, so it can cross a channel, be read from several threads, and
outlive the decoder that produced it. Through 0.8 the planes were
refcounted views into AVBufferRef behind an FfmpegBuffer type,
which meant every consumer inherited an FFmpeg lifetime it could not
see. That type is gone.
FfmpegVideoStreamDecoder mirrors the send_packet / receive_frame
shape of ffmpeg::decoder::Video, auto-probes the host’s HW backends,
and falls through to a software decoder when none takes the stream
before its first picture. Audio and
subtitles use parallel FfmpegAudioStreamDecoder /
FfmpegSubtitleStreamDecoder types.
§Backends
FfmpegVideoStreamDecoder::open walks this probe order, opening the
first backend that accepts the stream:
| Target | Probe order |
|---|---|
| macOS / iOS / tvOS | VideoToolbox → software |
| Linux | VAAPI → CUDA → software |
| Windows | D3D11VA → CUDA → software |
| other | software |
Output frames are CPU-side, downloaded with av_hwframe_transfer_data
(NV12 for 8-bit, P010/P012/P016/P210/P212/P216/P410/P412/P416 for
10/12/16-bit). Pixel-format conversion is intentionally out of scope
— downstream
colconv handles it.
The probe keeps every packet it consumes until the first picture comes
out. When no backend takes the stream by then, open (that is,
DecodePath::Auto) replays those packets into the software decoder, so
nothing is lost; DecodePath::AnyHardware and a DecodePath::Hardware
pin report VideoDecodeError::Decode(Error::AllBackendsFailed(p))
instead, carrying them (p.unconsumed_packets() /
p.into_unconsumed_packets()) — so non-seekable callers (live streams,
pipes, network sources) can replay them through a software decoder of
their own without re-demuxing.
After the first picture nothing changes the road, on any path, and
nothing is classified. A decoder failure, VideoDecodeError::Decode, is
that picture’s own error, reported as the decoder minted it, and nothing
of it is remembered, so the next call reaches libavcodec. FFmpeg has no
reliable signal that a hardware session is gone (AVERROR_EXTERNAL, for
one, also answers a single picture), and whether a hardware session
recovers is FFmpeg’s, not this crate’s. FFmpeg 9.0.1 does not always
recover one. After a VideoToolbox restart that fails, every picture
fails the same way until a new parameter set re-arms the restart, and
flush does not change that: it drops the pictures and references the
codec holds, and it rebuilds no hardware session. VideoDecoder’s
documentation cites the FFmpeg lines.
A VideoDecodeError::Convert is the wrapper’s own failure, not the
decoder’s: FfmpegVideoStreamDecoder could not convert a decoded
picture into a frame (a frame ceiling, a pixel format or plane layout it
cannot carry, an allocation). One that failed on an allocation parks the
picture: the next receive_frame converts it again, and until one
delivers it, send_packet and send_eof answer Sent::MustDrain
without reaching libavcodec. That is the wrapper’s back pressure, not a
failure.
So a caller that sees a hardware session’s decoder failures persist
rebuilds: it opens a session on DecodePath::Software from the same
parameters and feeds it forward. What the new session can be fed depends
on the road the failure came from:
send_packet: the failure names the packet in hand, and the new session is given that packet.receive_frame: the failure may concern a packet accepted earlier. FFmpeg decouples input from output and may hold several pictures (libavcodec/avcodec.h90–139 in FFmpeg 9.0.1), so no packet is named: the new session is given the next packet, and the caller accepts the gap.send_eof: the end has no packet to give a new session. What the hardware session still held is recoverable only from packets kept from before, or by a seek.
When to rebuild is the caller’s policy, not the decoder’s, because it is
the caller that sees the failures on the three roads, the packets’ key
flags and what it has delivered. What a policy counts is the hardware
session’s decoder failures; a Convert error is reported, not counted.
The usage example below carries the simplest one.
§Usage
A file’s video track, decoded under the simplest policy for a hardware
session the caller stops trusting. It counts the hardware session’s
decoder failures on all three roads, and only a delivered picture ends
the count. At FAILURES_BEFORE_SOFTWARE failures in a row it opens a
session on DecodePath::Software from the same parameters and feeds it
forward: the packet in hand when the failure came from send_packet,
otherwise what comes next, the next packet or the end. It keeps no
packets and replays nothing, so every picture the new session delivers
is delivered as it is. A Convert error is reported, not counted: the
example returns it, as it returns every error it does not handle.
use ffmpeg_next as ffmpeg;
use ffmpeg::{codec, format, media};
use mediadecode::{Received, Sent, Timebase, decoder::VideoStreamDecoder};
use mediadecode_ffmpeg::{
DecodePath, DecoderLimits, Error, FfmpegVideoStreamDecoder, PacketLimits, VideoDecodeError,
VideoFrame, VideoPacket, empty_video_frame, video_packet_from_ffmpeg_in,
};
type BoxError = Box<dyn std::error::Error>;
/// This caller's threshold, not the decoder's: how many decoder failures
/// in a row, with no picture delivered between them, it takes from a
/// hardware session before it rebuilds on software.
const FAILURES_BEFORE_SOFTWARE: u32 = 3;
fn main() -> Result<(), BoxError> {
ffmpeg::init()?;
let path = std::env::args().nth(1).expect("usage: <input-file>");
let mut input = format::input(&path)?;
let stream = input.streams().best(media::Type::Video).unwrap();
let stream_index = stream.index();
let time_base = Timebase::new(
stream.time_base().numerator(),
std::num::NonZeroI32::new(stream.time_base().denominator()).unwrap(),
);
// A copy of its own: a software session opened later opens from it.
let parameters = stream.parameters().clone();
let mut track = Track::open(parameters, time_base)?;
for (s, av_packet) in input.packets() {
if s.index() != stream_index { continue; }
// `Ok(None)` is an empty packet; an `Err` is a payload that is
// there and could not be referenced, which is never silently
// skipped.
// **By value.** The bare names are the view lane, where a packet's
// payload is a window into libavformat's own buffer — so the source
// is handed over rather than lent. (The borrowing doors,
// `owned_*`, are the owned lane: they copy, so the packet stays
// yours.)
let Some(pkt) =
video_packet_from_ffmpeg_in(av_packet, time_base, PacketLimits::default())?
else { continue };
track.push(&pkt)?;
}
track.finish()
}
/// A video track decoded under this caller's policy for a hardware
/// session it stops trusting.
///
/// The policy feeds forward and does nothing else: it keeps no packets,
/// replays nothing and matches no pictures. That costs the pictures from
/// a failure to the next keyframe: a new session holds no reference
/// pictures, so libavcodec drops or conceals what comes before one, and
/// what the hardware session still held goes with it. A caller that
/// cannot afford that gap keeps the packets since the last clean keyframe
/// and replays them with a picture identity of its own; that bookkeeping
/// is the caller's design and is not shown here, because a doc example
/// cannot carry it correctly.
struct Track {
parameters: codec::Parameters,
time_base: Timebase,
decoder: FfmpegVideoStreamDecoder,
frame: VideoFrame,
/// The hardware session's decoder failures since the last picture
/// delivered.
failures_in_a_row: u32,
}
impl Track {
fn open(parameters: codec::Parameters, time_base: Timebase) -> Result<Self, BoxError> {
// Probes HW backends in order and falls back to software when none
// takes the stream before its first picture — so an error here means
// software could not open it either.
let decoder =
FfmpegVideoStreamDecoder::open(parameters.clone(), time_base, DecoderLimits::default())?;
Ok(Self {
parameters,
time_base,
decoder,
frame: empty_video_frame(),
failures_in_a_row: 0,
})
}
/// The `send_packet` road. A failure here names this packet.
fn push(&mut self, pkt: &VideoPacket) -> Result<(), BoxError> {
loop {
match self.decoder.send_packet(pkt) {
Ok(Sent::Accepted) => return self.drain(),
// Back pressure, not a failure: nothing was consumed, so drain
// and offer this same packet again. The old idiom — submit
// twice and treat the second failure as real — is what this
// arm replaces.
Ok(Sent::MustDrain) => self.drain()?,
Err(VideoDecodeError::Decode(e)) => {
// A software session opened for this failure is given this
// packet; otherwise the packet is behind us.
if self.failed(e)? {
continue;
}
return self.drain();
}
// `VideoDecodeError` is `#[non_exhaustive]`: a fault this code
// has never heard of takes the generic road, which is the right
// handling for one.
Err(e) => return Err(e.into()),
}
}
}
/// The `send_eof` road, then the tail. The end has no packet: a
/// software session opened for a failure here is given the end and
/// nothing else, so what the hardware session still held is lost.
fn finish(&mut self) -> Result<(), BoxError> {
loop {
match self.decoder.send_eof() {
Ok(Sent::Accepted) => return self.drain(),
Ok(Sent::MustDrain) => self.drain()?,
Err(VideoDecodeError::Decode(e)) => {
if self.failed(e)? {
continue;
}
// The end stays refused: what is ready is drained, and what
// the session still holds is lost with it.
return self.drain();
}
Err(e) => return Err(e.into()),
}
}
}
/// The `receive_frame` road: every picture the session has ready, up
/// to `NeedsInput`, or to `Ended` once the end is taken. `Received` is
/// a state, so the loop stops on one rather than on whatever the last
/// error was.
fn drain(&mut self) -> Result<(), BoxError> {
loop {
match self.decoder.receive_frame(&mut self.frame) {
Ok(Received::Frame) => self.deliver(),
Ok(Received::NeedsInput | Received::Ended) => return Ok(()),
// A failure here may concern a packet accepted earlier: FFmpeg
// decouples input from output and may hold several pictures. No
// packet is named, so a software session opened for it is given
// the next packet.
Err(VideoDecodeError::Decode(e)) => {
if self.failed(e)? {
return Ok(());
}
}
// Not counted: a `Convert` error is the wrapper's own, a decoded
// picture it could not convert into a frame, and not a decoder
// failure. It is reported, as is anything this code has never
// heard of.
Err(e) => return Err(e.into()),
}
}
}
/// A picture, delivered to the rest of the program as it is.
fn deliver(&mut self) {
// The count ends here, at a delivered picture, and nowhere else.
self.failures_in_a_row = 0;
// self.frame.pixel_format(), .width(), .height(), .planes() — view
// carriers: read them here and drop. A frame held is a pool slot
// held. Use the `Owned*` family when a frame has to outlive this.
}
/// A decoder failure on any of the three roads. On hardware it counts,
/// and at `FAILURES_BEFORE_SOFTWARE` the session is replaced by one on
/// `DecodePath::Software`, opened from the same parameters. Answers
/// whether it was, so the road can feed the new session.
fn failed(&mut self, e: Error) -> Result<bool, BoxError> {
eprintln!("decode failure: {e}");
// Software is where this policy ends: its failures are reported,
// and the stream goes on.
if !self.decoder.is_hardware() {
return Ok(false);
}
self.failures_in_a_row += 1;
if self.failures_in_a_row < FAILURES_BEFORE_SOFTWARE {
return Ok(false);
}
self.decoder = FfmpegVideoStreamDecoder::open_as(
self.parameters.clone(),
self.time_base,
DecoderLimits::default(),
DecodePath::Software,
)?;
Ok(true)
}
}Audio and subtitle decoding share the shape — see
examples/decode_via_trait.rs and
tests/audio_subtitle_via_trait.rs
for end-to-end demuxer-driven runs that cover all three streams.
§Public surface map
- Decoders:
FfmpegVideoStreamDecoder,FfmpegAudioStreamDecoder,FfmpegSubtitleStreamDecoder. Plus their error types:VideoDecodeError,AudioDecodeError,SubtitleDecodeError. - Decode path:
DecodePathandFfmpegVideoStreamDecoder::open_as—Auto(whatopendoes: probe hardware, fall back to software before the first picture),AnyHardware(the same probe, never software),Software, or the pinHardware(Backend). After the first picture no path changes its decoder, and a decoder failure is the picture’s own error; when to stop trusting a hardware session is the caller’s policy.is_hardware()/is_software()stay the live reading of where a session is. - Demuxer:
FfmpegDemuxer—mediadecode’sDemuxeroverlibavformat, opened from a path (open) or from anyRead + Seekbyte source through a customAVIOContext(open_reader). PlusDemuxError, andformat()→ContainerFormat— libavformat’s own identification of the bytes ("matroska,webm","mov,mp4,m4a,3gp,3g2,mj2"), read from the container rather than guessed from a path. - Codec identity:
CodecId— the number FFmpeg keys on, withname()/long_name()reading libavcodec’s own descriptor table for the word beside it ("h264","aac"), so a stored track row can cross into a typed codec vocabulary. The number stays the identity; an id libavcodec has no descriptor for has no name, rather than a"unknown_codec"sentinel. - Resampler (
resamplefeature, on by default):FfmpegResampler—mediadecode’sAudioResampleroverswresample, built from two explicitResampleSpecs (the source read off a track or off the opened decoder, the target the caller’s). PlusResampleError, which carries faults and theSourceChangedmid-stream refusal — “needs more input” and “the tail is finished” aremediadecode::Receivedstates out ofreceive_frame, not error variants. Disabling the feature drops the type and thelibswresamplelink along with it. FfmpegImageDecoder: the one-shotImageDecoder— cover art in,ImageFrameout. Opened from an attachment track’s codec parameters, which the demuxer’s cover-art reclassification retains in full. The picture’s EXIF orientation comes back typed onImageFrameExtra, read off the display matrix libavcodec emits for it.- Type aliases:
VideoPacket,AudioPacket,SubtitlePacket,DataPacket,AttachmentPacket,DemuxedPacket,VideoFrame,AudioFrame,SubtitleFrame,ImageFrame,TrackInfo,TrackParams— themediadecodegeneric types pre-parameterized with this crate’s adapter / carrier / extras, so you don’t have to spell them out. - Carrier:
FfmpegBytes— owned,Send + Sync,AsRef<[u8]>, cloning by refcount. Opaque over anArc<[u8]>, because the storage gains a pooled strategy later (#35) and a consumer must not have to recompile for it. Construct one withFfmpegBytes::copy_from_slice/::emptywhen feeding a packet back into a decoder. - Boundary helpers:
video_packet_from_ffmpeg,audio_packet_from_ffmpeg,subtitle_packet_from_ffmpeg— convert a borrowedffmpeg::Packetinto the matchingmediadecodepacket, copying the compressed payload out. Their*_insiblings (video_packet_from_ffmpeg_in,audio_packet_from_ffmpeg_in,subtitle_packet_from_ffmpeg_in,data_packet_from_ffmpeg_in) take the stream’s timebase, so the producedTimestampsays what its ticks mean instead of carrying the 1/1 placeholder anAVPacketalone leaves you with.attachment_packet_from_ffmpegwraps a cover-art packet, which has no timestamps to carry. - Empty-frame builders:
empty_video_frame,empty_audio_frame,empty_subtitle_frame— well-formed destinations forreceive_frame.
§Running tests and benches
The fixture-gated tests and the benchmark expect real media files,
named by five environment variables. The unit tests run
unconditionally; the gated ones are #[ignore]d, so --ignored
is what opts into them.
| Variable | Feeds |
|---|---|
HWDECODE_SAMPLE_VIDEO | tests/decode.rs, tests/hw_smoke.rs, benches/decode.rs, and the three decoder::tests backend cases |
MEDIADECODE_SAMPLE_VIDEO | tests/decode_via_trait.rs |
MEDIADECODE_SAMPLE_AUDIO | the audio-through-trait case (any container with an audio track) |
MEDIADECODE_SAMPLE_SUBTITLE | the subtitle-through-trait case (needs a container that really carries a subtitle track) |
MEDIADECODE_FX3_SAMPLE | the Sony FX3 H.264 High 4:2:2 10-bit probe-era HW→SW fallback case |
HWDECODE_SAMPLE_VIDEO=/path/to/clip.mp4 cargo test --test hw_smoke -- --ignored
HWDECODE_SAMPLE_VIDEO=/path/to/clip.mp4 cargo bench
# The whole fixture-gated set at once.
HWDECODE_SAMPLE_VIDEO=/path/to/clip.mp4 \
MEDIADECODE_SAMPLE_VIDEO=/path/to/clip.mp4 \
MEDIADECODE_SAMPLE_AUDIO=/path/to/clip.mp4 \
MEDIADECODE_SAMPLE_SUBTITLE=/path/to/subtitled.mkv \
MEDIADECODE_FX3_SAMPLE=/path/to/12_sony_fx3_xavc.mp4 \
cargo test --all-features -- --ignoredA variable left unset is not always a quiet skip: the FX3 case prints
a notice and returns, but the trait cases panic on a missing path
once --ignored has opted into them.
§Build requirements
- A system FFmpeg ≥ 5.1 linkable via
pkg-config(we referenceAV_PIX_FMT_P212LE/AV_PIX_FMT_P412LE, which were added in 5.1). Tested against 9.0. Verify withffmpeg -hwaccelsthat your build has the backends you expect compiled in (e.g.videotoolboxon macOS,vaapi/cudaon Linux,d3d11va/cudaon Windows). - Rust ≥ 1.95, edition 2024.
§License
mediadecode-ffmpeg is under the terms of both the MIT license and the
Apache License (Version 2.0).
See LICENSE-APACHE, LICENSE-MIT for details.
Copyright (c) 2026 FinDIT Studio authors.
Re-exports§
pub use boundary::MediaKind;pub use boundary::PacketBuildError;pub use boundary::SendPayloadTooLarge;pub use boundary::SendSideDataTooLarge;pub use boundary::attachment_packet_from_ffmpeg;pub use boundary::audio_packet_from_ffmpeg;pub use boundary::audio_packet_from_ffmpeg_in;pub use boundary::data_packet_from_ffmpeg_in;pub use boundary::empty_audio_frame;pub use boundary::empty_owned_audio_frame;pub use boundary::empty_owned_subtitle_frame;pub use boundary::empty_owned_video_frame;pub use boundary::empty_subtitle_frame;pub use boundary::empty_video_frame;pub use boundary::ffmpeg_packet_from_audio_packet;pub use boundary::ffmpeg_packet_from_owned_audio_packet;pub use boundary::ffmpeg_packet_from_owned_subtitle_packet;pub use boundary::ffmpeg_packet_from_owned_video_packet;pub use boundary::ffmpeg_packet_from_subtitle_packet;pub use boundary::ffmpeg_packet_from_video_packet;pub use boundary::from_av_pixel_format;pub use boundary::is_hardware_pix_fmt;pub use boundary::owned_attachment_packet_from_ffmpeg;pub use boundary::owned_audio_packet_from_ffmpeg_in;pub use boundary::owned_data_packet_from_ffmpeg_in;pub use boundary::owned_subtitle_packet_from_ffmpeg_in;pub use boundary::owned_video_packet_from_ffmpeg_in;pub use boundary::subtitle_packet_from_ffmpeg;pub use boundary::subtitle_packet_from_ffmpeg_in;pub use boundary::video_packet_from_ffmpeg;pub use boundary::video_packet_from_ffmpeg_in;pub use channel_layout::ChannelLayoutFault;pub use channel_layout::channel_layout_description_from_ffmpeg;pub use channel_layout::channel_layout_from_ffmpeg;pub use channel_layout::channel_order_from_ffmpeg;pub use limits::DEFAULT_MAX_ATTACHMENT_BYTES;pub use limits::DEFAULT_MAX_CHAPTERS;pub use limits::DEFAULT_MAX_CODEC_PARAMETER_BYTES;pub use limits::DEFAULT_MAX_FRAME_BYTES;pub use limits::DEFAULT_MAX_IMAGE_INPUT_BYTES;pub use limits::DEFAULT_MAX_IMAGE_SIDE_DATA_BYTES;pub use limits::DEFAULT_MAX_PACKET_BYTES;pub use limits::DEFAULT_MAX_PIXELS;pub use limits::DEFAULT_MAX_PROBE_BYTES;pub use limits::DEFAULT_MAX_STREAMS;pub use limits::DEFAULT_MAX_TOTAL_ATTACHMENT_BYTES;pub use limits::DEFAULT_MAX_TOTAL_CHAPTER_TITLE_BYTES;pub use limits::DEFAULT_MAX_TOTAL_CODEC_PARAMETER_BYTES;pub use limits::DEFAULT_MAX_TOTAL_STREAM_METADATA_BYTES;pub use limits::DecoderLimits;pub use limits::DemuxLimits;pub use limits::FrameLimits;pub use limits::PacketLimits;pub use ticket::ChannelLayoutTicket;pub use ticket::CodecTicket;pub use ticket::CustomChannel;pub use ticket::DolbyVisionConfig;pub use ticket::Ratio;
Modules§
- boundary
- Boundary conversions between FFmpeg’s bindgen integers and the
unified
mediadecodevocabulary. - channel_
layout - Conversions from FFmpeg’s
ffmpeg_next::ChannelLayout/ffmpeg_next::ffi::AVChannelOrderto the channel-layout vocabularymediaframeowns (ChannelLayout,ChannelOrder,ChannelSpec,ChannelLayoutDescription). - convert
- Conversion helpers from FFmpeg
AVFrame/AVPacketto themediadecodetypes parameterized bycrate::FfmpegandFfmpegBytes. - extras
- Backend-specific
*Extracarriers used as themediadecode::*Adapter::*Extraassociated types. - limits
- Resource ceilings — the finite budgets every copy across the FFmpeg boundary is checked against before it allocates.
- ticket
- The owned codec ticket — one stream’s
AVCodecParameters, mirrored into plain Rust and rebuilt on demand.
Structs§
- Carrier
Audio Stream Decoder mediadecode::AudioStreamDecoderimpl wrappingffmpeg::decoder::Audio.- Carrier
Demuxer mediadecode::demuxer::Demuxerimpl wrappingffmpeg::format::context::Input.- Carrier
Image Decoder mediadecode::ImageDecoderimpl wrappingffmpeg::decoder::Video.- Carrier
Resampler resample mediadecode::resampler::AudioResamplerimpl wrappingswresample.- Carrier
Subtitle Stream Decoder mediadecode::SubtitleDecoderimpl wrappingffmpeg::decoder::Subtitle.- Carrier
Video Stream Decoder mediadecode::VideoStreamDecoderimpl over FFmpeg’s hardware and software decoders, on theDecodePathit was opened on — underDecodePath::Auto, hardware with a lossless fallback to software before the first picture.- Chapter
Alloc - Payload for
DemuxError::ChapterAlloc. - Chapter
Timebase Invalid - Payload for
DemuxError::ChapterTimebaseInvalid. - Chapter
Title Alloc - Payload for
DemuxError::ChapterTitleAlloc. - Chapter
Title Budget Exhausted - Payload for
DemuxError::ChapterTitleBudgetExhausted. - Chapter
Title TooLong - Payload for
DemuxError::ChapterTitleTooLong. - CodecId
- Codec identifier. Wraps the integer value of an
AVCodecIDenum variant; comparisons and storage work without ever transmuting back into the bindgen enum. - Container
Format - The container identification libavformat made for a session.
- Corrupt
- Payload for
ImageDecodeError::Corrupt. - Ffmpeg
- Zero-sized type carrying the FFmpeg adapter’s vocabulary.
- Ffmpeg
Buffer - Refcounted view onto a contiguous byte range inside an
AVBufferRef. - Ffmpeg
Bytes - The bytes every packet and frame this crate produces are carried in.
- Frame
- CPU-side decoded video frame produced by
crate::VideoDecoder. - Frame
Budget Exceeded - Payload for
Error::FrameBudgetExceeded. - HwSurface
TooLarge - Payload for
Error::HwSurfaceTooLarge. - HwTransfer
TooLarge - Payload for
Error::HwTransferTooLarge. - Input
TooLarge - Payload for
ImageDecodeError::InputTooLarge. - Output
TooLarge resample - Payload for
ResampleError::OutputTooLarge. - Owned
- The owned lane: every byte copied once at the boundary.
- Parameters
Channel Map - Payload for
DemuxError::ParametersChannelMap. - Parameters
Layout Shape - Payload for
DemuxError::ParametersLayoutShape. - Probe
Budget Exhausted - Payload for
DemuxError::ProbeBudgetExhausted. - Resample
Spec resample - One end of a conversion: sample rate, sample format, channel layout.
- Sample
Format - Audio sample format identifier.
- TooMany
Chapters - Payload for
DemuxError::TooManyChapters. - Track
Metadata Alloc - Payload for
DemuxError::TrackMetadataAlloc. - Track
Metadata Budget Exhausted - Payload for
DemuxError::TrackMetadataBudgetExhausted. - Track
Metadata TooLong - Payload for
DemuxError::TrackMetadataTooLong. - Track
Table Alloc - Payload for
DemuxError::TrackTableAlloc. - Track
Timebase Invalid - Payload for
DemuxError::TrackTimebaseInvalid. - Trusted
Payload - Payload for
PacketBufferError::TrustedPayloadandcrate::boundary::PacketBuildError::TrustedPayload. - Unsupported
Spec Channel Count resample - Payload for
ResampleError::UnsupportedChannelCount. - Video
Decoder - Hardware-accelerated video decoder.
- View
- The view lane: refcounted zero-copy handles onto FFmpeg’s own allocations.
Enums§
- Audio
Decode Error - Errors from [
FfmpegAudioStreamDecoder] — faults only. - Backend
- Hardware decoding backend.
- Corrupt
Source - Which side of the decode declared the corruption.
- Decode
Path - Which decode path a video session takes — the choice
CarrierVideoStreamDecoder::open_asis given. - Demux
Error - Errors from [
FfmpegDemuxer]. - Error
- Errors returned from
crate::VideoDecoder. - Frame
Medium - Which kind of frame a
FrameBudgetExceededrefers to. - Image
Decode Error - Errors from [
FfmpegImageDecoder]. - Packet
Buffer Error - Why a packet could not be carried across the boundary — its payload, or the side data that comes with it.
- Resample
Error resample - Errors from [
FfmpegResampler] — faults and the two send-side refusals (Self::SourceChanged,Self::AfterEof). - SpecEnd
resample - Which end of a conversion a refusal is about.
- Subtitle
Decode Error - Errors from [
FfmpegSubtitleStreamDecoder] — faults and the send-side refusal. - Video
Decode Error - Error type for [
FfmpegVideoStreamDecoder] — faults and the send-side refusal.
Traits§
- Ffmpeg
Carrier - How a lane turns FFmpeg’s bytes into a carrier.
Type Aliases§
- Attachment
Packet - Attachment payload pre-parameterized with this crate’s extras and
view carrier — a font, or the cover art
FfmpegImageDecoderdecodes. - Audio
Frame - Decoded audio frame pre-parameterized with this crate’s sample format / channel layout / extras / view carrier.
- Audio
Packet - Compressed audio packet pre-parameterized with this crate’s extras and view carrier.
- Chapter
- One row of the chapter table
FfmpegDemuxer::chaptersreturns. - Data
Packet - Timed opaque-data packet pre-parameterized with this crate’s extras and view carrier.
- Demuxed
Packet - The five-arm demux envelope
FfmpegDemuxerdelivers. - Ffmpeg
Audio Stream Decoder - The audio decoder on the view lane.
- Ffmpeg
Demuxer - The demuxer, on the view lane — the ordinary road.
- Ffmpeg
Image Decoder - The still-image decoder on the view lane.
- Ffmpeg
Owned Audio Stream Decoder - The audio decoder on the owned lane.
- Ffmpeg
Owned Demuxer - The demuxer on the owned lane: every byte copied once at the boundary into memory Rust owns.
- Ffmpeg
Owned Image Decoder - The still-image decoder on the owned lane.
- Ffmpeg
Owned Resampler resample - The resampler, on the owned lane — every produced plane copied out of the output frame.
- Ffmpeg
Owned Subtitle Stream Decoder - The subtitle decoder on the owned lane.
- Ffmpeg
Owned Video Stream Decoder - The video stream decoder on the owned lane.
- Ffmpeg
Resampler resample - The resampler, on the view lane — planes shared out of its own output frame.
- Ffmpeg
Subtitle Stream Decoder - The subtitle decoder on the view lane.
- Ffmpeg
Video Stream Decoder - The video stream decoder on the view lane.
- Image
Frame - Decoded still image pre-parameterized with this crate’s pixel
format / extras / view carrier — what
FfmpegImageDecoderproduces. - Owned
Attachment Packet AttachmentPacketon the owned lane.- Owned
Audio Frame AudioFrameon the owned lane.- Owned
Audio Packet AudioPacketon the owned lane.- Owned
Data Packet DataPacketon the owned lane.- Owned
Demuxed Packet DemuxedPacketon the owned lane.- Owned
Image Frame ImageFrameon the owned lane — whatFfmpegOwnedImageDecoderproduces.- Owned
Subtitle Frame SubtitleFrameon the owned lane.- Owned
Subtitle Packet SubtitlePacketon the owned lane.- Owned
Video Frame VideoFrameon the owned lane — planes copied out of the decoder’s buffer, so the frame outlives it and the pool slot goes straight back.- Owned
Video Packet VideoPacketon the owned lane.- Result
- Crate result alias.
- Subtitle
Frame - Decoded subtitle frame pre-parameterized with this crate’s extras / view carrier.
- Subtitle
Packet - Compressed subtitle packet pre-parameterized with this crate’s extras and view carrier.
- Track
Info - One row of the track table
FfmpegDemuxer::tracksreturns. - Track
Params - A track’s per-kind codec parameters, as
TrackInfocarries them. - Video
Frame - Decoded video frame pre-parameterized with this crate’s pixel format / extras / view carrier.
- Video
Packet - Compressed video packet pre-parameterized with this crate’s extras
and view carrier — the type
FfmpegVideoStreamDecoderconsumes viamediadecode::decoder::VideoStreamDecoder::send_packet.