Merge pull request #41 from ShadowMitia/add-feature-flag-formats

Add features flags for each image format

Author: Roughsketch

Cargo.toml

@@ -20,4 +20,52 @@ walkdir = "2.3"
 
 [[bench]]
 name = "parse_benchmark"
-harness = false
+harness = false
+
+[features]
+default = [
+    "aesprite",
+    "bmp",
+    "dds",
+    "exr",
+    "farbfeld",
+    "gif",
+    "hdr",
+    "ico",
+    "ilbm",
+    "jpeg",
+    "jxl",
+    "ktx2",
+    "mod",
+    "png",
+    "pnm",
+    "psd",
+    "qoi",
+    "tga",
+    "tiff",
+    "vtf",
+    "webp",
+    "heif",
+]
+aesprite = []
+bmp = []
+dds = []
+exr = []
+farbfeld = []
+gif = []
+hdr = []
+ico = []
+ilbm = []
+jpeg = []
+jxl = []
+ktx2 = []
+mod = []
+png = []
+pnm = []
+psd = []
+qoi = []
+tga = []
+tiff = []
+vtf = []
+webp = []
+heif = []

src/formats/mod.rs

@@ -1,22 +1,42 @@
+#[cfg(feature = "aesprite")]
 pub mod aesprite;
+#[cfg(feature = "bmp")]
 pub mod bmp;
+#[cfg(feature = "dds")]
 pub mod dds;
+#[cfg(feature = "exr")]
 pub mod exr;
+#[cfg(feature = "farbfeld")]
 pub mod farbfeld;
+#[cfg(feature = "gif")]
 pub mod gif;
+#[cfg(feature = "hdr")]
 pub mod hdr;
+#[cfg(feature = "ico")]
 pub mod ico;
+#[cfg(feature = "ilbm")]
 pub mod ilbm;
+#[cfg(feature = "jpeg")]
 pub mod jpeg;
+#[cfg(feature = "jxl")]
 pub mod jxl;
+#[cfg(feature = "ktx2")]
 pub mod ktx2;
+#[cfg(feature = "png")]
 pub mod png;
+#[cfg(feature = "pnm")]
 pub mod pnm;
+#[cfg(feature = "psd")]
 pub mod psd;
+#[cfg(feature = "qoi")]
 pub mod qoi;
+#[cfg(feature = "tga")]
 pub mod tga;
+#[cfg(feature = "tiff")]
 pub mod tiff;
+#[cfg(feature = "vtf")]
 pub mod vtf;
+#[cfg(feature = "webp")]
 pub mod webp;
 
 use crate::{container, ImageError, ImageResult, ImageType};
@@ -35,87 +55,108 @@ pub fn image_type<R: BufRead + Seek>(reader: &mut R) -> ImageResult<ImageType> {
 
     // This is vaguely organized in what I assume are the most commonly used formats.
     // I don't know how much this matters for actual execution time.
+    #[cfg(feature = "jpeg")]
     if jpeg::matches(&header) {
         return Ok(ImageType::Jpeg);
     }
 
+    #[cfg(feature = "png")]
     if png::matches(&header) {
         return Ok(ImageType::Png);
     }
 
+    #[cfg(feature = "gif")]
     if gif::matches(&header) {
         return Ok(ImageType::Gif);
     }
 
+    #[cfg(feature = "tiff")]
     if tiff::matches(&header) {
         return Ok(ImageType::Tiff);
     }
 
+    #[cfg(feature = "webp")]
     if webp::matches(&header) {
         return Ok(ImageType::Webp);
     }
 
+    #[cfg(feature = "heif")]
     if let Some(c) = container::heif::matches(&header, reader) {
         return Ok(ImageType::Heif(c));
     }
 
+    #[cfg(feature = "jxl")]
     if jxl::matches(&header) {
         return Ok(ImageType::Jxl);
     }
 
+    #[cfg(feature = "bmp")]
     if bmp::matches(&header) {
         return Ok(ImageType::Bmp);
     }
 
+    #[cfg(feature = "psd")]
     if psd::matches(&header) {
         return Ok(ImageType::Psd);
     }
 
+    #[cfg(feature = "ico")]
     if ico::matches(&header) {
         return Ok(ImageType::Ico);
     }
 
+    #[cfg(feature = "aesprite")]
     if aesprite::matches(&header) {
         return Ok(ImageType::Aseprite);
     }
 
+    #[cfg(feature = "exr")]
     if exr::matches(&header) {
         return Ok(ImageType::Exr);
     }
 
+    #[cfg(feature = "hdr")]
     if hdr::matches(&header) {
         return Ok(ImageType::Hdr);
     }
 
+    #[cfg(feature = "dds")]
     if dds::matches(&header) {
         return Ok(ImageType::Dds);
     }
 
+    #[cfg(feature = "ktx2")]
     if ktx2::matches(&header) {
         return Ok(ImageType::Ktx2);
     }
 
+    #[cfg(feature = "qoi")]
     if qoi::matches(&header) {
         return Ok(ImageType::Qoi);
     }
 
+    #[cfg(feature = "farbfeld")]
     if farbfeld::matches(&header) {
         return Ok(ImageType::Farbfeld);
     }
 
+    #[cfg(feature = "pnm")]
     if pnm::matches(&header) {
         return Ok(ImageType::Pnm);
     }
 
+    #[cfg(feature = "vtf")]
     if vtf::matches(&header) {
         return Ok(ImageType::Vtf);
     }
 
+    #[cfg(feature = "ilbm")]
     if ilbm::matches(&header) {
         return Ok(ImageType::Ilbm);
     }
 
     // Keep TGA last because it has the highest probability of false positives
+    #[cfg(feature = "tga")]
     if tga::matches(&header, reader) {
         return Ok(ImageType::Tga);
     }

src/lib.rs

@@ -1,3 +1,5 @@
+#![allow(dead_code)]
+
 use std::error::Error;
 use std::fmt;
 use std::fs::File;
@@ -52,48 +54,69 @@ pub type ImageResult<T> = Result<T, ImageError>;
 pub enum ImageType {
     /// Animated sprite image format
     /// <https://github.com/aseprite/aseprite>
+    #[cfg(feature = "aesprite")]
     Aseprite,
     /// Standard Bitmap
+    #[cfg(feature = "bmp")]
     Bmp,
     /// DirectDraw Surface
+    #[cfg(feature = "dds")]
     Dds,
     /// OpenEXR
+    #[cfg(feature = "exr")]
     Exr,
     /// Farbfeld
     /// <https://tools.suckless.org/farbfeld/>
+    #[cfg(feature = "farbfeld")]
     Farbfeld,
     /// Standard GIF
+    #[cfg(feature = "gif")]
     Gif,
     /// Radiance HDR
+    #[cfg(feature = "hdr")]
     Hdr,
     /// Image Container Format
+    #[cfg(feature = "heif")]
     Heif(Compression),
     /// Icon file
+    #[cfg(feature = "ico")]
     Ico,
     /// Interleaved Bitmap
+    #[cfg(feature = "ilbm")]
     Ilbm,
     /// Standard JPEG
+    #[cfg(feature = "jpeg")]
     Jpeg,
     /// JPEG XL
+    #[cfg(feature = "jxl")]
     Jxl,
     /// Khronos Texture Container
+    #[cfg(feature = "ktx2")]
     Ktx2,
     /// Standard PNG
+    #[cfg(feature = "png")]
     Png,
     /// Portable Any Map
+    #[cfg(feature = "pnm")]
     Pnm,
     /// Photoshop Document
+    #[cfg(feature = "psd")]
     Psd,
     /// Quite OK Image Format
     /// <https://qoiformat.org/>
+    #[cfg(feature = "qoi")]
     Qoi,
     /// Truevision Graphics Adapter
+    #[cfg(feature = "tga")]
     Tga,
     /// Standard TIFF
+    #[cfg(feature = "tiff")]
     Tiff,
     /// Valve Texture Format
+    #[cfg(feature = "vtf")]
     Vtf,
     /// Standard Webp
+    #[cfg(feature = "webp")]
     Webp,
 }
 
@@ -253,27 +276,48 @@ pub fn reader_size<R: BufRead + Seek>(mut reader: R) -> ImageResult<ImageSize> {
 /// * `header` - The header of the file
 fn dispatch_header<R: BufRead + Seek>(reader: &mut R) -> ImageResult<ImageSize> {
     match formats::image_type(reader)? {
+        #[cfg(feature = "aesprite")]
         ImageType::Aseprite => aesprite::size(reader),
+        #[cfg(feature = "bmp")]
         ImageType::Bmp => bmp::size(reader),
+        #[cfg(feature = "dds")]
         ImageType::Dds => dds::size(reader),
+        #[cfg(feature = "exr")]
         ImageType::Exr => exr::size(reader),
+        #[cfg(feature = "farbfeld")]
         ImageType::Farbfeld => farbfeld::size(reader),
+        #[cfg(feature = "gif")]
         ImageType::Gif => gif::size(reader),
+        #[cfg(feature = "hdr")]
         ImageType::Hdr => hdr::size(reader),
+        #[cfg(feature = "ico")]
         ImageType::Ico => ico::size(reader),
+        #[cfg(feature = "ilbm")]
         ImageType::Ilbm => ilbm::size(reader),
+        #[cfg(feature = "jpeg")]
         ImageType::Jpeg => jpeg::size(reader),
+        #[cfg(feature = "jxl")]
         ImageType::Jxl => jxl::size(reader),
+        #[cfg(feature = "ktx2")]
         ImageType::Ktx2 => ktx2::size(reader),
+        #[cfg(feature = "png")]
         ImageType::Png => png::size(reader),
+        #[cfg(feature = "pnm")]
         ImageType::Pnm => pnm::size(reader),
+        #[cfg(feature = "psd")]
         ImageType::Psd => psd::size(reader),
+        #[cfg(feature = "qoi")]
         ImageType::Qoi => qoi::size(reader),
+        #[cfg(feature = "tga")]
         ImageType::Tga => tga::size(reader),
+        #[cfg(feature = "tiff")]
         ImageType::Tiff => tiff::size(reader),
+        #[cfg(feature = "vtf")]
         ImageType::Vtf => vtf::size(reader),
+        #[cfg(feature = "webp")]
         ImageType::Webp => webp::size(reader),
 
+        #[cfg(feature = "heif")]
         ImageType::Heif(..) => heif::size(reader),
     }
 }

tests/aseprite.rs

@@ -2,6 +2,7 @@
 use imagesize::{size, ImageSize};
 
 #[test]
+#[cfg(feature = "aesprite")]
 fn aseprite_test() {
     let dim = size("tests/images/aseprite/1.ase").unwrap();
 

tests/avif.rs

@@ -2,6 +2,7 @@
 use imagesize::{image_type, size, Compression, ImageSize, ImageType};
 
 #[test]
+#[cfg(feature = "heif")]
 fn avif_test() {
     let dim = size("tests/images/avif/test.avif").unwrap();
     assert_eq!(
@@ -14,6 +15,7 @@ fn avif_test() {
 }
 
 #[test]
+#[cfg(feature = "heif")]
 fn avif_multi_picks_largest() {
     let dim = size("tests/images/avif/test.avifs").unwrap();
     assert_eq!(
@@ -26,6 +28,7 @@ fn avif_multi_picks_largest() {
 }
 
 #[test]
+#[cfg(feature = "heif")]
 fn avif_type() {
     use std::{fs::File, io::Read};
 
@@ -38,6 +41,7 @@ fn avif_type() {
 }
 
 #[test]
+#[cfg(feature = "heif")]
 fn avif_seq_type() {
     use std::{fs::File, io::Read};
 

tests/blob.rs

@@ -2,6 +2,7 @@
 use imagesize::{blob_size, ImageSize};
 
 #[test]
+#[cfg(feature = "png")]
 fn blob_test() {
     //  PNG Header with size 123x321
     #[rustfmt::skip]
@@ -45,6 +46,7 @@ fn gif_blob_too_small_test() {
 }
 
 #[test]
+#[cfg(feature = "ico")]
 fn blob_test_partial_ico() {
     #[rustfmt::skip]
     let data = vec![

tests/bmp.rs

@@ -2,6 +2,7 @@
 use imagesize::{size, ImageSize};
 
 #[test]
+#[cfg(feature = "bmp")]
 fn bmp_test() {
     let dim = size("tests/images/bmp/test.bmp").unwrap();
     assert_eq!(