mp4-atom 0.10.1

use crate::{Any, FourCC};

#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("out of bounds")]
    OutOfBounds,

    #[error("short read")]
    ShortRead,

    #[error("over decode: {0}")]
    OverDecode(FourCC),

    #[error("under decode: {0}")]
    UnderDecode(FourCC),

    #[error("atom too large")]
    TooLarge(FourCC),

    #[error("invalid size")]
    InvalidSize,

    #[error("invalid fourcc")]
    InvalidFourCC,

    #[error("unknown version: {0}")]
    UnknownVersion(u8),

    #[error("invalid string: {0}")]
    InvalidString(String),

    #[error("missing box: {0}")]
    MissingBox(FourCC),

    #[error("unexpected box: {0}")]
    UnexpectedBox(FourCC),

    #[error("duplicate box: {0}")]
    DuplicateBox(FourCC),

    #[error("missing descriptor: {0}")]
    MissingDescriptor(u8),

    #[error("unexpected descriptor: {0}")]
    UnexpectedDescriptor(u8),

    #[error("unexpected eof")]
    UnexpectedEof,

    #[error("unknown quicktime version: {0}")]
    UnknownQuicktimeVersion(u16),

    #[error("unsupported: {0}")]
    Unsupported(&'static str),

    // Returned in the rare case when we can't represent a value in the desired type
    #[error("out of memory")]
    OutOfMemory,

    #[error("reserved")]
    Reserved,

    #[error("io error: {0}")]
    Io(#[from] std::io::Error),

    #[error("missing required content: {0}")]
    MissingContent(&'static str),
}

pub type Result<T> = std::result::Result<T, Error>;

/// Either logs or returns an error depending on the strict feature flag.
pub(crate) fn decode_unknown(atom: &Any, parent: FourCC) -> Result<()> {
    if cfg!(feature = "strict") || cfg!(test) {
        tracing::error!(kind = %atom.kind(), parent = %parent, "unexpected box");
        return Err(Error::UnexpectedBox(atom.kind()));
    } else {
        tracing::warn!(kind = %atom.kind(), parent = %parent, "unexpected box");
    }
    Ok(())
}