Merge pull request #20 from scott-wilson/18-bind_imf_version

Wrap the imf_version module

openexr-rs/Cargo.toml

@@ -10,6 +10,7 @@ edition = "2018"
 openexr-sys = {path="../build/openexr-sys"}
 half = "1.7.1"
 thiserror = "1.0.24"
+bitflags = "1.2.1"
 
 [dev-dependencies]
 png = "0.16.8"

openexr-rs/src/lib.rs

@@ -62,6 +62,8 @@ pub use flat_image_level::{
 };
 pub mod flat_image_channel;
 pub use flat_image_channel::{FlatChannelF16, FlatChannelF32, FlatChannelU32};
+pub mod version;
+pub use version::{VersionFlags, Version};
 pub mod flat_image_io;
 
 pub(crate) mod cppstd;

openexr-rs/src/version.rs

@@ -0,0 +1,288 @@
+use openexr_sys as sys;
+use std::os::raw::{c_char, c_int};
+
+bitflags::bitflags! {
+    /// The version flags represents the options that are supported in the library and the EXR file.
+    ///
+    pub struct VersionFlags: i32 {
+        /// File is tiled
+        ///
+        const TILED = 0x00000200;
+        /// File contains long attribute or channel names
+        ///
+        const LONG_NAMES = 0x00000400;
+        /// File has at least one part which is not a regular scanline image or regular tiled image (that is, it is a deep format)
+        ///
+        const NON_IMAGE = 0x00000800;
+        /// File has multiple parts
+        ///
+        const MULTI_PART_FILE = 0x00001000;
+        /// Bitwise OR of all known flags
+        ///
+        const ALL = Self::TILED.bits | Self::LONG_NAMES.bits | Self::NON_IMAGE.bits | Self::MULTI_PART_FILE.bits;
+    }
+}
+
+impl VersionFlags {
+    /// The flag object is supported by the bound OpenEXR library.
+    ///
+    pub fn supports_flags(&self) -> bool {
+        let mut result: bool = false;
+
+        unsafe {
+            // NOTE: This will not raise an error, so error checking is skipped.
+            sys::Imf_supportsFlags(&mut result, self.bits);
+        }
+
+        result
+    }
+}
+
+/// The version represents a version number and the flags that are enabled for the file.
+///
+#[derive(Debug, Copy, Clone)]
+pub struct Version {
+    inner: c_int,
+}
+
+// NOTE: All of the functions below will not raise errors, so error checking is skipped.
+
+impl Version {
+    /// Create a version from a given version number and flag.
+    ///
+    /// # Panics
+    ///
+    /// The version number must be between 0 and 255, otherwise this will panic.
+    ///
+    pub fn new(version: i32, flags: VersionFlags) -> Self {
+        assert!(
+            version <= 0x000000ff && version >= 0,
+            "Version must be between 0 and 255"
+        );
+        Self {
+            inner: version | flags.bits,
+        }
+    }
+
+    /// Create a version from the wrapped OpenEXR API.
+    ///
+    pub fn from_c_int(version: c_int) -> Self {
+        Self { inner: version }
+    }
+
+    /// File is tiled
+    ///
+    pub fn is_tiled(&self) -> bool {
+        let mut result = false;
+
+        unsafe {
+            sys::Imf_isTiled_1(&mut result, self.inner);
+        }
+
+        result
+    }
+
+    /// File has multiple parts
+    ///
+    pub fn is_multi_part(&self) -> bool {
+        let mut result = false;
+
+        unsafe {
+            sys::Imf_isMultiPart(&mut result, self.inner);
+        }
+
+        result
+    }
+
+    /// File has at least one part which is not a regular scanline image or regular tiled image (that is, it is a deep format)
+    ///
+    pub fn is_non_image(&self) -> bool {
+        let mut result = false;
+
+        unsafe {
+            sys::Imf_isNonImage(&mut result, self.inner);
+        }
+
+        result
+    }
+
+    /// Return the version as a tiled version
+    ///
+    pub fn make_tiled(&self) -> Self {
+        let mut result: c_int = 0;
+
+        unsafe {
+            sys::Imf_makeTiled(&mut result, self.inner);
+        }
+
+        Self { inner: result }
+    }
+
+    /// Return the version as a non-tiled version
+    ///
+    pub fn make_non_tiled(&self) -> Self {
+        let mut result: c_int = 0;
+
+        unsafe {
+            sys::Imf_makeNotTiled(&mut result, self.inner);
+        }
+
+        Self { inner: result }
+    }
+
+    /// Get the version number portion of encoded version.
+    ///
+    pub fn version(&self) -> i32 {
+        let mut result: c_int = 0;
+
+        unsafe {
+            sys::Imf_getVersion(&mut result, self.inner);
+        }
+
+        result
+    }
+
+    /// Get the flags portion of encoded version.
+    ///
+    pub fn flags(&self) -> VersionFlags {
+        let mut result: c_int = 0;
+
+        unsafe {
+            sys::Imf_getFlags(&mut result, self.inner);
+        }
+
+        VersionFlags { bits: result }
+    }
+}
+
+/// Return if the byte array represents the OpenEXR magic number.
+///
+pub fn is_imf_magic(bytes: &[c_char; 4]) -> bool {
+    let mut result: bool = false;
+
+    unsafe {
+        sys::Imf_isImfMagic(&mut result, bytes.as_ptr());
+    }
+
+    result
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_version_new_success() {
+        super::Version::new(0, super::VersionFlags { bits: 0 });
+        super::Version::new(1, super::VersionFlags { bits: 0 });
+        super::Version::new(255, super::VersionFlags { bits: 0 });
+    }
+
+    #[test]
+    #[should_panic]
+    fn test_version_new_failure_version_less_than_0() {
+        super::Version::new(-1, super::VersionFlags { bits: 0 });
+    }
+
+    #[test]
+    #[should_panic]
+    fn test_version_new_failure_version_greater_than_255() {
+        super::Version::new(256, super::VersionFlags { bits: 0 });
+    }
+
+    #[test]
+    fn test_is_tiled_true() {
+        let version = super::Version::new(1, super::VersionFlags::TILED);
+        let result = version.is_tiled();
+        assert_eq!(result, true);
+    }
+
+    #[test]
+    fn test_is_tiled_false() {
+        let version = super::Version::new(1, super::VersionFlags { bits: 0 });
+        let result = version.is_tiled();
+        assert_eq!(result, false);
+    }
+
+    #[test]
+    fn test_is_multi_part_true() {
+        let version = super::Version::new(1, super::VersionFlags::MULTI_PART_FILE);
+        let result = version.is_multi_part();
+        assert_eq!(result, true);
+    }
+
+    #[test]
+    fn test_is_multi_part_false() {
+        let version = super::Version::new(1, super::VersionFlags { bits: 0 });
+        let result = version.is_multi_part();
+        assert_eq!(result, false);
+    }
+
+    #[test]
+    fn test_is_non_image_true() {
+        let version = super::Version::new(1, super::VersionFlags::NON_IMAGE);
+        let result = version.is_non_image();
+        assert_eq!(result, true);
+    }
+
+    #[test]
+    fn test_is_non_image_false() {
+        let version = super::Version::new(1, super::VersionFlags { bits: 0 });
+        let result = version.is_non_image();
+        assert_eq!(result, false);
+    }
+
+    #[test]
+    fn test_make_tiled_success() {
+        let version = super::Version::new(1, super::VersionFlags { bits: 0 }).make_tiled();
+        assert_eq!(version.is_tiled(), true);
+    }
+
+    #[test]
+    fn test_make_non_tiled_success() {
+        let version = super::Version::new(1, super::VersionFlags::TILED).make_non_tiled();
+        assert_eq!(version.is_tiled(), false);
+    }
+
+    #[test]
+    fn test_get_version_success() {
+        #[allow(overflowing_literals)]
+        let version = super::Version::from_c_int(0xffffffff);
+        let result = version.version();
+
+        assert_eq!(result, 0x000000ff);
+    }
+
+    #[test]
+    fn test_get_flags_success() {
+        #[allow(overflowing_literals)]
+        let version = super::Version::from_c_int(0xffffffff);
+        let result = version.flags();
+
+        #[allow(overflowing_literals)]
+        let expected = super::VersionFlags { bits: 0xffffff00 };
+        assert_eq!(result, expected);
+    }
+
+    #[test]
+    fn test_supports_flags_true() {
+        let result = super::VersionFlags::ALL.supports_flags();
+        assert_eq!(result, true);
+    }
+
+    #[test]
+    fn test_supports_flags_false() {
+        let result = super::VersionFlags { bits: 0x10000000 }.supports_flags();
+        assert_eq!(result, false);
+    }
+
+    #[test]
+    fn test_is_imf_magic_true() {
+        let result = super::is_imf_magic(&[118, 47, 49, 1]);
+        assert_eq!(result, true);
+    }
+
+    #[test]
+    fn test_is_imf_magic_false() {
+        let result = super::is_imf_magic(&[0, 0, 0, 0]);
+        assert_eq!(result, false);
+    }
+}