panimg_core/codec/

mod.rs

use crate::error::{PanimgError, Result};
use crate::format::ImageFormat;
use image::DynamicImage;
use std::path::Path;

/// Options for decoding an image.
#[derive(Debug, Clone)]
pub struct DecodeOptions {
    /// DPI for rasterizing vector/document formats (PDF). Default: 150.
    pub dpi: f32,
}

impl Default for DecodeOptions {
    fn default() -> Self {
        Self { dpi: 150.0 }
    }
}

impl DecodeOptions {
    /// Create DecodeOptions with an optional DPI override.
    /// Falls back to the default (150) when `None` is given.
    pub fn with_dpi(dpi: Option<f32>) -> Self {
        match dpi {
            Some(d) => Self { dpi: d },
            None => Self::default(),
        }
    }
}

/// Options for encoding an image.
#[derive(Debug, Clone)]
pub struct EncodeOptions {
    pub format: ImageFormat,
    pub quality: Option<u8>,
    pub strip_metadata: bool,
}

impl Default for EncodeOptions {
    fn default() -> Self {
        Self {
            format: ImageFormat::Png,
            quality: None,
            strip_metadata: false,
        }
    }
}

/// Registry that handles decoding and encoding images.
pub struct CodecRegistry;

impl CodecRegistry {
    /// Decode an image from a file path with default options.
    pub fn decode(path: &Path) -> Result<DynamicImage> {
        Self::decode_with_options(path, &DecodeOptions::default())
    }

    /// Decode an image from a file path with custom options.
    pub fn decode_with_options(path: &Path, options: &DecodeOptions) -> Result<DynamicImage> {
        if !path.exists() {
            return Err(PanimgError::FileNotFound {
                path: path.to_path_buf(),
                suggestion: "check that the file path is correct".into(),
            });
        }

        let data = std::fs::read(path).map_err(|e| PanimgError::IoError {
            message: e.to_string(),
            path: Some(path.to_path_buf()),
            suggestion: "check file permissions".into(),
        })?;

        let format = ImageFormat::from_bytes(&data)
            .or_else(|| ImageFormat::from_path_extension(path))
            .ok_or_else(|| PanimgError::UnknownFormat {
                path: path.to_path_buf(),
                suggestion: "specify the format explicitly or use a recognized extension".into(),
            })?;

        Self::decode_bytes(&data, format, Some(path), options)
    }

    /// Decode an image from bytes with a known format.
    fn decode_bytes(
        data: &[u8],
        format: ImageFormat,
        path: Option<&Path>,
        _options: &DecodeOptions,
    ) -> Result<DynamicImage> {
        match format {
            ImageFormat::Jpeg
            | ImageFormat::Png
            | ImageFormat::WebP
            | ImageFormat::Gif
            | ImageFormat::Bmp
            | ImageFormat::Tiff
            | ImageFormat::Qoi
            | ImageFormat::Avif => {
                let img_fmt = format.to_image_format().unwrap();
                image::load_from_memory_with_format(data, img_fmt).map_err(|e| {
                    PanimgError::DecodeError {
                        message: e.to_string(),
                        path: path.map(|p| p.to_path_buf()),
                        suggestion: "the file may be corrupted".into(),
                    }
                })
            }
            #[cfg(feature = "svg")]
            ImageFormat::Svg => decode_svg(data, path),
            #[cfg(feature = "jxl")]
            ImageFormat::Jxl => decode_jxl(data, path),
            #[cfg(feature = "pdf")]
            ImageFormat::Pdf => decode_pdf(data, path, _options),
            #[cfg(all(feature = "heic", target_vendor = "apple"))]
            ImageFormat::Heic => decode_heic(data, path),
            #[allow(unreachable_patterns)]
            _ => Err(PanimgError::UnsupportedFormat {
                format: format.to_string(),
                suggestion: format!(
                    "enable the '{}' feature to support this format",
                    format.extension()
                ),
            }),
        }
    }

    /// Encode an image and write to a file path.
    pub fn encode(img: &DynamicImage, path: &Path, options: &EncodeOptions) -> Result<()> {
        if !options.format.can_encode() {
            return Err(PanimgError::UnsupportedFormat {
                format: options.format.to_string(),
                suggestion: "this format is not supported for encoding".into(),
            });
        }

        let img_fmt =
            options
                .format
                .to_image_format()
                .ok_or_else(|| PanimgError::UnsupportedFormat {
                    format: options.format.to_string(),
                    suggestion: "this format is not supported for encoding".into(),
                })?;

        // For JPEG, set quality
        if options.format == ImageFormat::Jpeg {
            let quality = options.quality.unwrap_or(85);
            let file = std::fs::File::create(path).map_err(|e| PanimgError::IoError {
                message: e.to_string(),
                path: Some(path.to_path_buf()),
                suggestion: "check output directory exists and permissions".into(),
            })?;
            let mut writer = std::io::BufWriter::new(file);
            let encoder = image::codecs::jpeg::JpegEncoder::new_with_quality(&mut writer, quality);
            img.write_with_encoder(encoder)
                .map_err(|e| PanimgError::EncodeError {
                    message: e.to_string(),
                    path: Some(path.to_path_buf()),
                    suggestion: "check that the image data is valid".into(),
                })?;
            return Ok(());
        }

        // Default: use image crate's save method
        img.save_with_format(path, img_fmt)
            .map_err(|e| PanimgError::EncodeError {
                message: e.to_string(),
                path: Some(path.to_path_buf()),
                suggestion: "check output directory exists and permissions".into(),
            })
    }
}

#[cfg(feature = "svg")]
fn decode_svg(data: &[u8], path: Option<&Path>) -> Result<DynamicImage> {
    let tree =
        resvg::usvg::Tree::from_data(data, &resvg::usvg::Options::default()).map_err(|e| {
            PanimgError::DecodeError {
                message: e.to_string(),
                path: path.map(|p| p.to_path_buf()),
                suggestion: "check that the SVG is well-formed".into(),
            }
        })?;
    let size = tree.size();
    let width = size.width() as u32;
    let height = size.height() as u32;
    let mut pixmap =
        resvg::tiny_skia::Pixmap::new(width, height).ok_or_else(|| PanimgError::DecodeError {
            message: "failed to create pixmap".into(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "SVG dimensions may be invalid".into(),
        })?;
    resvg::render(
        &tree,
        resvg::usvg::Transform::default(),
        &mut pixmap.as_mut(),
    );
    let rgba_data = pixmap.data().to_vec();
    image::RgbaImage::from_raw(width, height, rgba_data)
        .map(DynamicImage::ImageRgba8)
        .ok_or_else(|| PanimgError::DecodeError {
            message: "failed to create image from SVG render".into(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "SVG dimensions may be invalid".into(),
        })
}

#[cfg(all(feature = "heic", target_vendor = "apple"))]
fn decode_heic(data: &[u8], path: Option<&Path>) -> Result<DynamicImage> {
    use libheif_rs::{ColorSpace, HeifContext, LibHeif, RgbChroma};

    let ctx = HeifContext::read_from_bytes(data).map_err(|e| PanimgError::DecodeError {
        message: e.to_string(),
        path: path.map(|p| p.to_path_buf()),
        suggestion: "check that the HEIC/HEIF file is valid".into(),
    })?;

    let handle = ctx
        .primary_image_handle()
        .map_err(|e| PanimgError::DecodeError {
            message: e.to_string(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "failed to get primary image from HEIC container".into(),
        })?;

    let has_alpha = handle.has_alpha_channel();
    let color_space = if has_alpha {
        ColorSpace::Rgb(RgbChroma::Rgba)
    } else {
        ColorSpace::Rgb(RgbChroma::Rgb)
    };

    let lib_heif = LibHeif::new();
    let decoded =
        lib_heif
            .decode(&handle, color_space, None)
            .map_err(|e| PanimgError::DecodeError {
                message: e.to_string(),
                path: path.map(|p| p.to_path_buf()),
                suggestion: "failed to decode HEIC image data".into(),
            })?;

    let width = decoded.width();
    let height = decoded.height();
    let planes = decoded.planes();
    let interleaved = planes.interleaved.ok_or_else(|| PanimgError::DecodeError {
        message: "no interleaved plane data in decoded HEIC image".into(),
        path: path.map(|p| p.to_path_buf()),
        suggestion: "the HEIC file may use an unsupported pixel format".into(),
    })?;

    let stride = interleaved.stride;
    let src_data = interleaved.data;
    let channels: usize = if has_alpha { 4 } else { 3 };
    let row_bytes = (width as usize) * channels;

    // Validate that the source buffer is large enough
    let required_len = (height as usize).saturating_sub(1) * stride + row_bytes;
    if src_data.len() < required_len {
        return Err(PanimgError::DecodeError {
            message: format!(
                "HEIC plane data too short: need {} bytes but got {}",
                required_len,
                src_data.len()
            ),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "the HEIC file may be truncated or corrupted".into(),
        });
    }

    // Copy pixel data, handling stride != row_bytes
    let buf = if stride == row_bytes {
        src_data[..row_bytes * (height as usize)].to_vec()
    } else {
        let mut buf = Vec::with_capacity((width as usize) * (height as usize) * channels);
        for row in 0..height as usize {
            let start = row * stride;
            buf.extend_from_slice(&src_data[start..start + row_bytes]);
        }
        buf
    };

    if has_alpha {
        image::RgbaImage::from_raw(width, height, buf)
            .map(DynamicImage::ImageRgba8)
            .ok_or_else(|| PanimgError::DecodeError {
                message: "failed to create image from HEIC data".into(),
                path: path.map(|p| p.to_path_buf()),
                suggestion: "HEIC data may be invalid".into(),
            })
    } else {
        image::RgbImage::from_raw(width, height, buf)
            .map(DynamicImage::ImageRgb8)
            .ok_or_else(|| PanimgError::DecodeError {
                message: "failed to create image from HEIC data".into(),
                path: path.map(|p| p.to_path_buf()),
                suggestion: "HEIC data may be invalid".into(),
            })
    }
}

#[cfg(feature = "jxl")]
fn decode_jxl(data: &[u8], path: Option<&Path>) -> Result<DynamicImage> {
    use jxl_oxide::JxlImage;
    let image = JxlImage::builder()
        .read(std::io::Cursor::new(data))
        .map_err(|e| PanimgError::DecodeError {
            message: e.to_string(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "check that the JPEG XL file is valid".into(),
        })?;
    let render = image
        .render_frame(0)
        .map_err(|e| PanimgError::DecodeError {
            message: e.to_string(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "failed to render JPEG XL frame".into(),
        })?;
    let fb = render.image_all_channels();
    let width = fb.width() as u32;
    let height = fb.height() as u32;
    let buf: Vec<u8> = fb
        .buf()
        .iter()
        .map(|&f| (f.clamp(0.0, 1.0) * 255.0) as u8)
        .collect();
    let channels = fb.channels();
    match channels {
        3 => image::RgbImage::from_raw(width, height, buf)
            .map(DynamicImage::ImageRgb8)
            .ok_or_else(|| PanimgError::DecodeError {
                message: "failed to create image from JXL data".into(),
                path: path.map(|p| p.to_path_buf()),
                suggestion: "JXL data may be invalid".into(),
            }),
        4 => image::RgbaImage::from_raw(width, height, buf)
            .map(DynamicImage::ImageRgba8)
            .ok_or_else(|| PanimgError::DecodeError {
                message: "failed to create image from JXL data".into(),
                path: path.map(|p| p.to_path_buf()),
                suggestion: "JXL data may be invalid".into(),
            }),
        _ => Err(PanimgError::DecodeError {
            message: format!("unsupported channel count: {channels}"),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "only RGB and RGBA JPEG XL images are supported".into(),
        }),
    }
}

#[cfg(feature = "pdf")]
fn decode_pdf(data: &[u8], path: Option<&Path>, options: &DecodeOptions) -> Result<DynamicImage> {
    use hayro::hayro_interpret::InterpreterSettings;
    use hayro::hayro_syntax::Pdf;
    use hayro::RenderSettings;

    let pdf_data: std::sync::Arc<dyn AsRef<[u8]> + Send + Sync> =
        std::sync::Arc::new(data.to_vec());
    let pdf = Pdf::new(pdf_data).map_err(|e| PanimgError::DecodeError {
        // LoadPdfError does not implement Display, use Debug
        message: format!("{e:?}"),
        path: path.map(|p| p.to_path_buf()),
        suggestion: "check that the PDF file is valid and not encrypted".into(),
    })?;

    let pages = pdf.pages();
    if pages.is_empty() {
        return Err(PanimgError::DecodeError {
            message: "PDF has no pages".into(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "the PDF file appears to be empty".into(),
        });
    }

    // Render the first page only. PDF default is 72 DPI, so scale = dpi / 72.
    let scale = options.dpi / 72.0;
    let interpreter_settings = InterpreterSettings::default();
    let render_settings = RenderSettings {
        x_scale: scale,
        y_scale: scale,
        bg_color: hayro::vello_cpu::color::palette::css::WHITE,
        ..Default::default()
    };

    let pixmap = hayro::render(&pages[0], &interpreter_settings, &render_settings);
    let width = pixmap.width() as u32;
    let height = pixmap.height() as u32;
    let unpremultiplied = pixmap.take_unpremultiplied();
    let rgba_data: Vec<u8> = unpremultiplied
        .into_iter()
        .flat_map(|p| [p.r, p.g, p.b, p.a])
        .collect();
    image::RgbaImage::from_raw(width, height, rgba_data)
        .map(DynamicImage::ImageRgba8)
        .ok_or_else(|| PanimgError::DecodeError {
            message: "failed to create image from PDF render".into(),
            path: path.map(|p| p.to_path_buf()),
            suggestion: "PDF page dimensions may be invalid".into(),
        })
}