Enum Error 

#[non_exhaustive]
pub enum Error {
    NotStarted,
    Url(UrlError),
    OpenInputStream(OpenInputError),
    FindStream(FindStreamError),
    Decoder(DecoderError),
    FilterGraphParse(FilterGraphParseError),
    FilterDescUtf8,
    FilterNameUtf8,
    FilterZeroOutputs,
    FilterZeroInputs,
    ParseInteger,
    AllocOutputContext(AllocOutputContextError),
    OpenOutput(OpenOutputError),
    FileSameAsInput(String),
    FindDevices(FindDevicesError),
    AllocFrame(AllocFrameError),
    AllocPacket(AllocPacketError),
    FrameWritable(FrameWritableError),
    Muxing(MuxingOperationError),
    OpenEncoder(OpenEncoderOperationError),
    Encoding(EncodingOperationError),
    FilterGraph(FilterGraphOperationError),
    OpenDecoder(OpenDecoderOperationError),
    Decoding(DecodingOperationError),
    Demuxing(DemuxingOperationError),
    PacketScanner(PacketScannerError),
    FrameFilterInit(Box<dyn Error + Send + Sync>),
    FrameFilterProcess(Box<dyn Error + Send + Sync>),
    FrameFilterRequest(Box<dyn Error + Send + Sync>),
    FrameFilterTypeNoMatched(String, String),
    FrameFilterStreamTypeNoMatched(String, usize, String),
    FrameFilterDstFinished,
    FrameFilterFrameDuplicateFailed,
    FrameFilterThreadExited,
    WorkerPanicked(String),
    StartFailed,
    RtmpStreamAlreadyExists(String),
    RtmpCreateStream,
    RtmpRegistrationQueueFull,
    RtmpThreadExited,
    RtmpStreamClosed,
    RtmpServerAlreadyStarted,
    Subtitle(SubtitleError),
    WgpuFilter(WgpuFilterError),
    OpenGLFilter(OpenGLFilterError),
    IO(Error),
    EOF,
    Exit,
    Bug,
    InvalidRecipeArg(String),
    ContainerInfo(ContainerInfoError),
    FrameExport(FrameExportError),
    Writer(WriterError),
    Push(PushError),
    FrameSourceThreadExited,
    PacketSink(PacketSinkError),
    AmbiguousVideoSource {
        video_streams: usize,
    },
    UnconsumedCliOption {
        site: String,
        option: String,
    },
}

Top-level error type for all ez-ffmpeg operations.

Most variants wrap a stage-specific error enum (opening inputs and outputs, demuxing, decoding, filtering, encoding, muxing, …), so callers can match on the pipeline stage first and inspect the typed cause when they need to.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotStarted

Returned when an operation requires a scheduler that has been started, but it has not been.

Url(UrlError)

A URL or path string could not be converted into a C string for FFmpeg (see UrlError).

OpenInputStream(OpenInputError)

Opening an input file, stream, device, or custom input source failed.

FindStream(FindStreamError)

Probing stream information from an opened input failed.

Decoder(DecoderError)

Resolving a decoder failed (see DecoderError).

FilterGraphParse(FilterGraphParseError)

Parsing a filtergraph description failed.

FilterDescUtf8

Returned when a filtergraph link label could not be converted to a UTF-8 string.

FilterNameUtf8

Returned when a filter name could not be converted to a UTF-8 string.

FilterZeroOutputs

Returned when a filtergraph declares zero outputs, which is not supported.

FilterZeroInputs

Returned when a filtergraph declares zero inputs, which is not supported.

ParseInteger

Returned when a numeric field — such as a file index in a stream specifier or link label — could not be parsed as an integer.

AllocOutputContext(AllocOutputContextError)

Allocating an output format context failed.

OpenOutput(OpenOutputError)

Opening or configuring an output failed.

FileSameAsInput(String)

Returned when an output URL is identical to one of the input URLs; the payload is the offending path. In-place editing is not supported.

FindDevices(FindDevicesError)

Enumerating capture devices failed.

AllocFrame(AllocFrameError)

Allocating an AVFrame failed.

AllocPacket(AllocPacketError)

Allocating an AVPacket failed.

FrameWritable(FrameWritableError)

Making a frame’s data buffers writable failed (see FrameWritableError).

Muxing(MuxingOperationError)

A muxing operation failed while writing the output container.

OpenEncoder(OpenEncoderOperationError)

Opening or configuring an encoder failed.

Encoding(EncodingOperationError)

An encoding operation failed.

FilterGraph(FilterGraphOperationError)

A filtergraph runtime operation failed.

OpenDecoder(OpenDecoderOperationError)

Opening or configuring a decoder failed.

Decoding(DecodingOperationError)

A decoding operation failed.

Demuxing(DemuxingOperationError)

A demuxing operation failed.

PacketScanner(PacketScannerError)

A packet-scanning operation failed (see PacketScannerError).

FrameFilterInit(Box<dyn Error + Send + Sync>)

A frame filter failed to initialize; carries the error returned by the filter’s init.

FrameFilterProcess(Box<dyn Error + Send + Sync>)

A frame filter failed while processing a frame; carries the error returned by the filter’s filter_frame.

FrameFilterRequest(Box<dyn Error + Send + Sync>)

A frame filter failed while generating a frame; carries the error returned by the filter’s request_frame.

FrameFilterTypeNoMatched(String, String)

Returned while building a frame pipeline when no stream of the required media type exists at the named pipeline end; fields are the pipeline end (input/output) and the media type.

FrameFilterStreamTypeNoMatched(String, usize, String)

Returned while building a frame pipeline when no stream at the named pipeline end matches both the requested stream index and media type; fields are the pipeline end, the stream index, and the media type.

FrameFilterDstFinished

Returned when a frame pipeline tries to deliver a frame to a destination that has already finished.

FrameFilterFrameDuplicateFailed

Returned when a frame pipeline fails to duplicate a frame required for an additional destination.

FrameFilterThreadExited

Returned when spawning a frame pipeline’s worker thread fails, so the pipeline never ran.

WorkerPanicked(String)

A worker thread panicked; the payload is the worker’s thread name. Output may be incomplete.

StartFailed

Recorded as the scheduler result when start() fails after some worker threads were already launched. start() itself returns the actual init error to its caller; this recorded value is what concurrent observers (packet-sink terminal callbacks) report, so a sink can never mistake a torn-down startup for a settled-Ok job.

RtmpStreamAlreadyExists(String)

Returned when publishing to the embedded RTMP server with a stream key that is already in use; the payload is the key.

RtmpCreateStream

Returned when a stream could not be created on the embedded RTMP server, typically because the server has stopped.

RtmpRegistrationQueueFull

Returned when too many streams are waiting to be registered on the embedded RTMP server.

RtmpThreadExited

Returned when the embedded RTMP server’s thread has exited.

RtmpStreamClosed

Returned when the embedded RTMP server is no longer consuming a published stream.

RtmpServerAlreadyStarted

Returned when starting an embedded RTMP server that was already started; clones of one server share a single lifecycle that can be started only once.

Subtitle(SubtitleError)

A subtitle processing operation failed.

WgpuFilter(WgpuFilterError)

A wgpu GPU filter operation failed.

OpenGLFilter(OpenGLFilterError)

An OpenGL filter operation failed (deprecated opengl feature).

IO(Error)

An I/O error from the standard library.

EOF

Internal end-of-stream marker passed between pipeline stages; a normal end of input is consumed internally rather than reported as a job failure.

Exit

Internal control-flow marker instructing pipeline stages to shut down; normally consumed internally.

Bug

Internal invariant violation that should never occur; indicates a bug in this crate rather than a problem with user input.

InvalidRecipeArg(String)

Returned when a recipe or analysis option is invalid (out of range, malformed, or inconsistent); the payload describes the problem.

ContainerInfo(ContainerInfoError)

A container-info query was called with an out-of-range index.

FrameExport(FrameExportError)

A frame-export operation failed.

Writer(WriterError)

Building or opening a video writer failed.

Push(PushError)

Pushing a frame into a video writer failed.

FrameSourceThreadExited

Returned when a frame-source input’s worker thread failed to start.

PacketSink(PacketSinkError)

A packet-sink output failed (see PacketSinkError).

AmbiguousVideoSource

CLI-compat pipelines only: a -vf command was lowered onto an input whose OPENED demuxer does not carry exactly one video stream. The check runs on the demuxer instance the pipeline actually executes with (no separate probe opening, no TOCTOU window). The facade maps this to its public AmbiguousFilterSource diagnostic.

Fields

video_streams: usize

Number of video streams carried by the opened input.

UnconsumedCliOption

Strict AVOption handling (CLI-compat pipelines): an option the caller supplied was not consumed by the component it targeted. The default builder path only WARNS about such leftovers; pipelines built through the cli feature’s entry points fail instead, mirroring fftools’ check_avoptions abort. Only exists with the cli feature — the feature-off API surface is unchanged.

Fields

site: String

Human-readable description of the component that should have consumed the option (e.g. “the muxer of output 0”).

option: String

The option key that was left unconsumed.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AllocFrameError> for Error

fn from(source: AllocFrameError) -> Self

Converts to this type from the input type.

impl From<AllocOutputContextError> for Error

fn from(source: AllocOutputContextError) -> Self

Converts to this type from the input type.

impl From<AllocPacketError> for Error

fn from(source: AllocPacketError) -> Self

Converts to this type from the input type.

impl From<ContainerInfoError> for Error

fn from(source: ContainerInfoError) -> Self

Converts to this type from the input type.

impl From<DecoderError> for Error

fn from(source: DecoderError) -> Self

Converts to this type from the input type.

impl From<DecodingOperationError> for Error

fn from(source: DecodingOperationError) -> Self

Converts to this type from the input type.

impl From<DemuxingOperationError> for Error

fn from(source: DemuxingOperationError) -> Self

Converts to this type from the input type.

impl From<EncodingOperationError> for Error

fn from(source: EncodingOperationError) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for StreamError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FilterGraphOperationError> for Error

fn from(source: FilterGraphOperationError) -> Self

Converts to this type from the input type.

impl From<FilterGraphParseError> for Error

fn from(source: FilterGraphParseError) -> Self

Converts to this type from the input type.

impl From<FindDevicesError> for Error

fn from(source: FindDevicesError) -> Self

Converts to this type from the input type.

impl From<FindStreamError> for Error

fn from(source: FindStreamError) -> Self

Converts to this type from the input type.

impl From<FrameExportError> for Error

fn from(source: FrameExportError) -> Self

Converts to this type from the input type.

impl From<FrameWritableError> for Error

fn from(source: FrameWritableError) -> Self

Converts to this type from the input type.

impl From<MuxingOperationError> for Error

fn from(source: MuxingOperationError) -> Self

Converts to this type from the input type.

impl From<NulError> for Error

fn from(err: NulError) -> Self

Converts to this type from the input type.

impl From<OpenDecoderOperationError> for Error

fn from(source: OpenDecoderOperationError) -> Self

Converts to this type from the input type.

impl From<OpenEncoderOperationError> for Error

fn from(source: OpenEncoderOperationError) -> Self

Converts to this type from the input type.

impl From<OpenGLFilterError> for Error

Available on crate feature opengl only.

fn from(err: OpenGLFilterError) -> Self

Converts to this type from the input type.

impl From<OpenInputError> for Error

fn from(source: OpenInputError) -> Self

Converts to this type from the input type.

impl From<OpenOutputError> for Error

fn from(source: OpenOutputError) -> Self

Converts to this type from the input type.

impl From<OwnedPushError> for Error

Drops the recovered frame and wraps the cause as crate::error::Error::Push, so ? composes in functions returning crate::error::Result. Destructure the error first when the buffer should be reused.

fn from(rejected: OwnedPushError) -> Self

Converts to this type from the input type.

impl From<PacketScannerError> for Error

fn from(source: PacketScannerError) -> Self

Converts to this type from the input type.

impl From<PacketSinkError> for Error

fn from(source: PacketSinkError) -> Self

Converts to this type from the input type.

impl From<PushError> for Error

fn from(source: PushError) -> Self

Converts to this type from the input type.

impl From<SubtitleError> for Error

fn from(source: SubtitleError) -> Self

Converts to this type from the input type.

impl From<UrlError> for Error

fn from(source: UrlError) -> Self

Converts to this type from the input type.

impl From<WgpuFilterError> for Error

fn from(source: WgpuFilterError) -> Self

Converts to this type from the input type.

impl From<WriterError> for Error

fn from(source: WriterError) -> Self

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Self) -> bool

Structural equality for payload-less variants only. Variants carrying an inner error compare unequal even to themselves — use matches! on the variant when that is what you mean.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.