maroontree 0.1.8

AV1 image & AV2 video and image encoder
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

/*
 * Copyright (c) Radzivon Bartoshyk 6/2026. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1.  Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2.  Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3.  Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

use crate::{BitDepth, ChromaFormat};
use std::fmt;

#[derive(Debug)]
pub enum EncodeError {
    InvalidDimensions {
        width: u32,
        height: u32,
    },
    InvalidInput,
    DctError(String),
    BitstreamError(String),
    IsobmffError(String),
    Io(std::io::Error),
    DimensionTooLarge {
        width: usize,
        height: usize,
    },
    InvalidQuality,
    UnsupportedChromaFormat(ChromaFormat),
    UnsupportedChromaBitDepth(BitDepth),
    /// The inter-video product deliberately accepts only the formats that pass
    /// the complete prediction -> reconstruction -> in-loop-filter -> DPB gate.
    UnsupportedVideoMode {
        chroma: ChromaFormat,
        bit_depth: BitDepth,
    },
    /// A frame changed a property fixed by the emitted sequence header.
    SequenceMismatch(&'static str),
}

impl fmt::Display for EncodeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidDimensions { width, height } => {
                write!(f, "Invalid image dimensions: {width}x{height}")
            }
            Self::InvalidInput => write!(
                f,
                "Invalid input: plane sizes or parameters are inconsistent"
            ),
            Self::DctError(msg) => write!(f, "DCT block error: {msg}"),
            Self::BitstreamError(msg) => write!(f, "Bitstream write error: {msg}"),
            Self::IsobmffError(msg) => write!(f, "ISOBMFF error: {msg}"),
            Self::Io(e) => write!(f, "IO error: {e}"),
            Self::DimensionTooLarge { width, height } => write!(
                f,
                "image dimensions {width}×{height} exceed the maximum ({})",
                16534
            ),
            Self::InvalidQuality => write!(f, "Invalid quality"),
            Self::UnsupportedChromaFormat(chroma) => {
                write!(f, "Chroma {:?} in current path is not supported", chroma)
            }
            EncodeError::UnsupportedChromaBitDepth(bp) => {
                write!(f, "Bit-depth {:?} is not supported", bp)
            }
            EncodeError::UnsupportedVideoMode { chroma, bit_depth } => write!(
                f,
                "unsupported AV2 inter-video mode: {chroma:?} {bit_depth:?}; only 4:2:0 8/10-bit is currently supported"
            ),
            EncodeError::SequenceMismatch(field) => {
                write!(f, "{field} changed after the sequence header was emitted")
            }
        }
    }
}

impl std::error::Error for EncodeError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            EncodeError::Io(e) => Some(e),
            _ => None,
        }
    }
}

impl From<std::io::Error> for EncodeError {
    fn from(e: std::io::Error) -> Self {
        EncodeError::Io(e)
    }
}