ffmpeg-sys-the-third 5.0.0+ffmpeg-8.1

FFI bindings to FFmpeg
Documentation 
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use libc::{c_char, c_int, size_t};

// Note: FFmpeg's AVERROR and AVUNERROR are conditionally defined based on
// whether EDOM is positive, claiming that "Some platforms have E* and errno
// already negated". This can be traced to a commit in 2007 where "some
// platforms" were specifically identified as BeOS (so maybe also Haiku?):
// https://github.com/FFmpeg/FFmpeg/commit/8fa36ae09dddb1b639b4df5d505c0dbcf4e916e4
// constness is more valuable than BeOS support, so if someone really needs it,
// send a patch with cfg_attr.

#[inline(always)]
pub const fn AVERROR(e: c_int) -> c_int {
    -e
}

#[inline(always)]
pub const fn AVUNERROR(e: c_int) -> c_int {
    -e
}

#[inline(always)]
pub const fn MKTAG(a: u8, b: u8, c: u8, d: u8) -> u32 {
    u32::from_le_bytes([a, b, c, d])
}

#[inline(always)]
pub const fn MKBETAG(a: u8, b: u8, c: u8, d: u8) -> u32 {
    u32::from_be_bytes([a, b, c, d])
}

#[inline(always)]
pub const fn FFERRTAG(a: u8, b: u8, c: u8, d: u8) -> c_int {
    let tag = MKTAG(a, b, c, d);
    assert!(c_int::MAX as u32 >= tag, "error tag must fit inside c_int");

    -(tag as c_int)
}

pub const AVERROR_BSF_NOT_FOUND: c_int = FFERRTAG(0xF8, b'B', b'S', b'F');
pub const AVERROR_BUG: c_int = FFERRTAG(b'B', b'U', b'G', b'!');
pub const AVERROR_BUFFER_TOO_SMALL: c_int = FFERRTAG(b'B', b'U', b'F', b'S');
pub const AVERROR_DECODER_NOT_FOUND: c_int = FFERRTAG(0xF8, b'D', b'E', b'C');
pub const AVERROR_DEMUXER_NOT_FOUND: c_int = FFERRTAG(0xF8, b'D', b'E', b'M');
pub const AVERROR_ENCODER_NOT_FOUND: c_int = FFERRTAG(0xF8, b'E', b'N', b'C');
pub const AVERROR_EOF: c_int = FFERRTAG(b'E', b'O', b'F', b' ');
pub const AVERROR_EXIT: c_int = FFERRTAG(b'E', b'X', b'I', b'T');
pub const AVERROR_EXTERNAL: c_int = FFERRTAG(b'E', b'X', b'T', b' ');
pub const AVERROR_FILTER_NOT_FOUND: c_int = FFERRTAG(0xF8, b'F', b'I', b'L');
pub const AVERROR_INVALIDDATA: c_int = FFERRTAG(b'I', b'N', b'D', b'A');
pub const AVERROR_MUXER_NOT_FOUND: c_int = FFERRTAG(0xF8, b'M', b'U', b'X');
pub const AVERROR_OPTION_NOT_FOUND: c_int = FFERRTAG(0xF8, b'O', b'P', b'T');
pub const AVERROR_PATCHWELCOME: c_int = FFERRTAG(b'P', b'A', b'W', b'E');
pub const AVERROR_PROTOCOL_NOT_FOUND: c_int = FFERRTAG(0xF8, b'P', b'R', b'O');

pub const AVERROR_STREAM_NOT_FOUND: c_int = FFERRTAG(0xF8, b'S', b'T', b'R');

pub const AVERROR_BUG2: c_int = FFERRTAG(b'B', b'U', b'G', b' ');
pub const AVERROR_UNKNOWN: c_int = FFERRTAG(b'U', b'N', b'K', b'N');

pub const AVERROR_HTTP_BAD_REQUEST: c_int = FFERRTAG(0xF8, b'4', b'0', b'0');
pub const AVERROR_HTTP_UNAUTHORIZED: c_int = FFERRTAG(0xF8, b'4', b'0', b'1');
pub const AVERROR_HTTP_FORBIDDEN: c_int = FFERRTAG(0xF8, b'4', b'0', b'3');
pub const AVERROR_HTTP_NOT_FOUND: c_int = FFERRTAG(0xF8, b'4', b'0', b'4');
#[cfg(feature = "ffmpeg_7_1")]
pub const AVERROR_HTTP_TOO_MANY_REQUESTS: c_int = FFERRTAG(0xF8, b'4', b'2', b'9');
pub const AVERROR_HTTP_OTHER_4XX: c_int = FFERRTAG(0xF8, b'4', b'X', b'X');
pub const AVERROR_HTTP_SERVER_ERROR: c_int = FFERRTAG(0xF8, b'5', b'X', b'X');

/// Fills the `errbuf` with a description for `errnum` or a generic message
/// if no specific description can be found.
///
/// The returned C-string will be null-terminated.
///
/// # Safety
///
/// `errbuf` and `errbuf_size` must describe a valid C-style char array, i.e.
/// - `errbuf` must be non-null and well-aligned and
/// - `errbuf` must be valid for `errbuf_size` reads/writes.
#[inline(always)]
pub unsafe fn av_make_error_string(
    errbuf: *mut c_char,
    errbuf_size: size_t,
    errnum: c_int,
) -> *mut c_char {
    crate::av_strerror(errnum, errbuf, errbuf_size);

    errbuf
}