xberg_libheif/
errors.rs

1use std::ffi::CStr;
2use std::fmt;
3
4use libheif_sys as lh;
5
6#[derive(Debug, Copy, Clone, enumn::N)]
7#[non_exhaustive]
8#[repr(C)]
9pub enum HeifErrorCode {
10    /// Input file does not exist.
11    InputDoesNotExist = lh::heif_error_code_heif_error_Input_does_not_exist as _,
12    /// Error in input file. Corrupted or invalid content.
13    InvalidInput = lh::heif_error_code_heif_error_Invalid_input as _,
14    UnsupportedFileType = lh::heif_error_code_heif_error_Unsupported_filetype as _,
15    /// Image requires an unsupported decoder feature.
16    UnsupportedFeature = lh::heif_error_code_heif_error_Unsupported_feature as _,
17    /// Library API has been used in an invalid way.
18    UsageError = lh::heif_error_code_heif_error_Usage_error as _,
19    /// Could not allocate enough memory.
20    MemoryAllocationError = lh::heif_error_code_heif_error_Memory_allocation_error as _,
21    /// The decoder plugin generated an error.
22    DecoderPluginError = lh::heif_error_code_heif_error_Decoder_plugin_error as _,
23    /// The encoder plugin generated an error.
24    EncoderPluginError = lh::heif_error_code_heif_error_Encoder_plugin_error as _,
25    /// Error during encoding or when writing to the output.
26    EncodingError = lh::heif_error_code_heif_error_Encoding_error as _,
27    /// Application has asked for a color profile type that does not exist.
28    ColorProfileDoesNotExist = lh::heif_error_code_heif_error_Color_profile_does_not_exist as _,
29    /// Error loading a dynamic plugin.
30    PluginLoadingError = lh::heif_error_code_heif_error_Plugin_loading_error as _,
31    /// Operation has been canceled.
32    #[cfg(feature = "v1_19")]
33    Canceled = lh::heif_error_code_heif_error_Canceled as _,
34    #[cfg(feature = "v1_20")]
35    EndOfSequence = lh::heif_error_code_heif_error_End_of_sequence as _,
36    ContextCreateFailed,
37    /// This value is used when library `libheif` returns unknown value of error code.
38    Unknown,
39}
40
41#[derive(Debug, Copy, Clone, enumn::N)]
42#[non_exhaustive]
43#[repr(C)]
44pub enum HeifErrorSubCode {
45    Unspecified = lh::heif_suberror_code_heif_suberror_Unspecified as _,
46    EndOfData = lh::heif_suberror_code_heif_suberror_End_of_data as _,
47    InvalidBoxSize = lh::heif_suberror_code_heif_suberror_Invalid_box_size as _,
48    NoFtypBox = lh::heif_suberror_code_heif_suberror_No_ftyp_box as _,
49    NoIdatBox = lh::heif_suberror_code_heif_suberror_No_idat_box as _,
50    NoMetaBox = lh::heif_suberror_code_heif_suberror_No_meta_box as _,
51    NoHdlrBox = lh::heif_suberror_code_heif_suberror_No_hdlr_box as _,
52    NoHvccBox = lh::heif_suberror_code_heif_suberror_No_hvcC_box as _,
53    NoPitmBox = lh::heif_suberror_code_heif_suberror_No_pitm_box as _,
54    NoIpcoBox = lh::heif_suberror_code_heif_suberror_No_ipco_box as _,
55    NoIpmaBox = lh::heif_suberror_code_heif_suberror_No_ipma_box as _,
56    NoIlocBox = lh::heif_suberror_code_heif_suberror_No_iloc_box as _,
57    NoIinfBox = lh::heif_suberror_code_heif_suberror_No_iinf_box as _,
58    NoIprpBox = lh::heif_suberror_code_heif_suberror_No_iprp_box as _,
59    NoIrefBox = lh::heif_suberror_code_heif_suberror_No_iref_box as _,
60    NoPictHandler = lh::heif_suberror_code_heif_suberror_No_pict_handler as _,
61    IpmaBoxReferencesNonExistingProperty =
62        lh::heif_suberror_code_heif_suberror_Ipma_box_references_nonexisting_property as _,
63    NoPropertiesAssignedToItem = lh::heif_suberror_code_heif_suberror_No_properties_assigned_to_item as _,
64    NoItemData = lh::heif_suberror_code_heif_suberror_No_item_data as _,
65    InvalidGridData = lh::heif_suberror_code_heif_suberror_Invalid_grid_data as _,
66    MissingGridImages = lh::heif_suberror_code_heif_suberror_Missing_grid_images as _,
67    InvalidCleanAperture = lh::heif_suberror_code_heif_suberror_Invalid_clean_aperture as _,
68    InvalidOverlayData = lh::heif_suberror_code_heif_suberror_Invalid_overlay_data as _,
69    OverlayImageOutsideOfCanvas = lh::heif_suberror_code_heif_suberror_Overlay_image_outside_of_canvas as _,
70    AuxiliaryImageTypeUnspecified = lh::heif_suberror_code_heif_suberror_Auxiliary_image_type_unspecified as _,
71    NoOrInvalidPrimaryItem = lh::heif_suberror_code_heif_suberror_No_or_invalid_primary_item as _,
72    NoInfeBox = lh::heif_suberror_code_heif_suberror_No_infe_box as _,
73    UnknownColorProfileType = lh::heif_suberror_code_heif_suberror_Unknown_color_profile_type as _,
74    WrongTileImageChromaFormat = lh::heif_suberror_code_heif_suberror_Wrong_tile_image_chroma_format as _,
75    InvalidFractionalNumber = lh::heif_suberror_code_heif_suberror_Invalid_fractional_number as _,
76    InvalidImageSize = lh::heif_suberror_code_heif_suberror_Invalid_image_size as _,
77    InvalidPixiBox = lh::heif_suberror_code_heif_suberror_Invalid_pixi_box as _,
78    NoAv1cBox = lh::heif_suberror_code_heif_suberror_No_av1C_box as _,
79    WrongTileImagePixelDepth = lh::heif_suberror_code_heif_suberror_Wrong_tile_image_pixel_depth as _,
80    SecurityLimitExceeded = lh::heif_suberror_code_heif_suberror_Security_limit_exceeded as _,
81    NonExistingItemReferenced = lh::heif_suberror_code_heif_suberror_Nonexisting_item_referenced as _,
82    NullPointerArgument = lh::heif_suberror_code_heif_suberror_Null_pointer_argument as _,
83    NonExistingImageChannelReferenced = lh::heif_suberror_code_heif_suberror_Nonexisting_image_channel_referenced as _,
84    UnsupportedPluginVersion = lh::heif_suberror_code_heif_suberror_Unsupported_plugin_version as _,
85    UnsupportedWriterVersion = lh::heif_suberror_code_heif_suberror_Unsupported_writer_version as _,
86    UnsupportedParameter = lh::heif_suberror_code_heif_suberror_Unsupported_parameter as _,
87    InvalidParameterValue = lh::heif_suberror_code_heif_suberror_Invalid_parameter_value as _,
88    UnsupportedCodec = lh::heif_suberror_code_heif_suberror_Unsupported_codec as _,
89    UnsupportedImageType = lh::heif_suberror_code_heif_suberror_Unsupported_image_type as _,
90    UnsupportedDataVersion = lh::heif_suberror_code_heif_suberror_Unsupported_data_version as _,
91    UnsupportedColorConversion = lh::heif_suberror_code_heif_suberror_Unsupported_color_conversion as _,
92    UnsupportedItemConstructionMethod = lh::heif_suberror_code_heif_suberror_Unsupported_item_construction_method as _,
93    UnsupportedBitDepth = lh::heif_suberror_code_heif_suberror_Unsupported_bit_depth as _,
94    CannotWriteOutputData = lh::heif_suberror_code_heif_suberror_Cannot_write_output_data as _,
95    UnknownNclxColorPrimaries = lh::heif_suberror_code_heif_suberror_Unknown_NCLX_color_primaries as _,
96    UnknownNclxTransferCharacteristics =
97        lh::heif_suberror_code_heif_suberror_Unknown_NCLX_transfer_characteristics as _,
98    UnknownNclxMatrixCoefficients = lh::heif_suberror_code_heif_suberror_Unknown_NCLX_matrix_coefficients as _,
99    UnsupportedHeaderCompressionMethod =
100        lh::heif_suberror_code_heif_suberror_Unsupported_header_compression_method as _,
101    PluginLoadingError = lh::heif_suberror_code_heif_suberror_Plugin_loading_error as _,
102    PluginIsNotLoaded = lh::heif_suberror_code_heif_suberror_Plugin_is_not_loaded as _,
103    CannotReadPluginDirectory = lh::heif_suberror_code_heif_suberror_Cannot_read_plugin_directory as _,
104    InvalidRegionData = lh::heif_suberror_code_heif_suberror_Invalid_region_data as _,
105    InvalidProperty = lh::heif_suberror_code_heif_suberror_Invalid_property as _,
106    ItemReferenceCycle = lh::heif_suberror_code_heif_suberror_Item_reference_cycle as _,
107    EncoderInitialization = lh::heif_suberror_code_heif_suberror_Encoder_initialization as _,
108    EncoderEncoding = lh::heif_suberror_code_heif_suberror_Encoder_encoding as _,
109    EncoderCleanup = lh::heif_suberror_code_heif_suberror_Encoder_cleanup as _,
110    TooManyRegions = lh::heif_suberror_code_heif_suberror_Too_many_regions as _,
111    #[cfg(feature = "v1_18")]
112    NoIspeProperty = lh::heif_suberror_code_heif_suberror_No_ispe_property as _,
113    #[cfg(feature = "v1_18")]
114    CameraIntrinsicMatrixUndefined = lh::heif_suberror_code_heif_suberror_Camera_intrinsic_matrix_undefined as _,
115    #[cfg(feature = "v1_18")]
116    CameraExtrinsicMatrixUndefined = lh::heif_suberror_code_heif_suberror_Camera_extrinsic_matrix_undefined as _,
117    #[cfg(feature = "v1_18")]
118    InvalidJ2kCodeStream = lh::heif_suberror_code_heif_suberror_Invalid_J2K_codestream as _,
119    #[cfg(feature = "v1_18")]
120    NoVvccBox = lh::heif_suberror_code_heif_suberror_No_vvcC_box as _,
121    #[cfg(feature = "v1_18")]
122    NoIcbrBox = lh::heif_suberror_code_heif_suberror_No_icbr_box as _,
123    #[cfg(feature = "v1_18")]
124    DecompressionInvalidData = lh::heif_suberror_code_heif_suberror_Decompression_invalid_data as _,
125    #[cfg(feature = "v1_18")]
126    CompressionInitialisationError = lh::heif_suberror_code_heif_suberror_Compression_initialisation_error as _,
127    #[cfg(feature = "v1_18")]
128    UnsupportedGenericCompressionMethod =
129        lh::heif_suberror_code_heif_suberror_Unsupported_generic_compression_method as _,
130    #[cfg(feature = "v1_18")]
131    NoMatchingDecoderInstalled = lh::heif_suberror_code_heif_suberror_No_matching_decoder_installed as _,
132    #[cfg(feature = "v1_19")]
133    NoAvccBox = lh::heif_suberror_code_heif_suberror_No_avcC_box as _,
134    #[cfg(feature = "v1_19")]
135    InvalidMiniBox = lh::heif_suberror_code_heif_suberror_Invalid_mini_box as _,
136    #[cfg(feature = "v1_19")]
137    UnsupportedEssentialProperty = lh::heif_suberror_code_heif_suberror_Unsupported_essential_property as _,
138    #[cfg(feature = "v1_20")]
139    NoMoovBox = lh::heif_suberror_code_heif_suberror_No_moov_box as _,
140    #[cfg(feature = "v1_21")]
141    UnsupportedTrackType = lh::heif_suberror_code_heif_suberror_Unsupported_track_type as _,
142    /// This value is used when library `libheif` returns unknown value of error sub-code.
143    Unknown,
144}
145
146#[derive(Debug, Clone)]
147pub struct HeifError {
148    pub code: HeifErrorCode,
149    pub sub_code: HeifErrorSubCode,
150    pub message: String,
151}
152
153pub type Result<T> = std::result::Result<T, HeifError>;
154
155impl std::error::Error for HeifError {}
156
157#[allow(unsafe_code)]
158impl fmt::Display for HeifError {
159    #[allow(unsafe_code)]
160    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
161        write!(f, "{:?}({:?}) {}", self.code, self.sub_code, self.message)
162    }
163}
164
165#[allow(unsafe_code)]
166impl HeifError {
167    #[allow(unsafe_code)]
168    pub fn from_heif_error(err: lh::heif_error) -> Result<()> {
169        if err.code == 0 {
170            return Ok(());
171        }
172
173        let message = if err.message.is_null() {
174            ""
175        } else {
176            let res = unsafe { CStr::from_ptr(err.message).to_str() };
177            res.unwrap_or("")
178        };
179
180        Err(HeifError {
181            code: HeifErrorCode::n(err.code).unwrap_or(HeifErrorCode::Unknown),
182            sub_code: HeifErrorSubCode::n(err.subcode).unwrap_or(HeifErrorSubCode::Unknown),
183            message: String::from(message),
184        })
185    }
186}
xberg_libheif/errors.rs

xberg_libheif/
errors.rs
