Merge pull request #43 from johannesvollmer/rgba-image

Prepare for pubishing Version 0.7.4

Author: johannesvollmer

Cargo.lock

@@ -4,7 +4,7 @@ description = "Read and write OpenEXR files without any unsafe code"
 keywords = ["exr", "openexr", "file", "binary", "io"]
 categories = ["encoding", "filesystem", "graphics", "multimedia"]
 
-version = "0.7.3"
+version = "0.7.4"
 edition = "2018"
 authors = ["johannesvollmer <[email protected]>"]
 
@@ -26,16 +26,16 @@ plugin = false
 proc-macro = false
 
 [dependencies]
-lebe = "0.5.0"        # generic binary serialization
-half = "1.4.1"        # 16 bit float pixel data type
+lebe = "0.5.1"        # generic binary serialization
+half = "1.5.0"        # 16 bit float pixel data type
 bit_field = "0.10.0"  # exr file version bit flags
 libflate = "0.1.27"   # zlib compression
-smallvec = "1.2.0"    # make cache friendly allocations             TODO profile if smallvec is really an improvement!
+smallvec = "1.3.0"    # make cache friendly allocations             TODO profile if smallvec is really an improvement!
 rayon = "1.3.0"       # multi-core compression and decompression     TODO make this an optional feature?
 
 [dev-dependencies]
 bencher = "0.1.5"
-image = "0.23.0"          # used to convert one exr to some pngs
+image = "0.23.3"          # used to convert one exr to some pngs
 walkdir = "2.3.1"         # automatically test things for all files in a directory
 rand = "0.7.3"            # used for fuzz testing
 

Cargo.toml

@@ -116,9 +116,9 @@ please leave an issue on this repository, containing the image file.
     - [x] Tiles
     - [x] Multipart
     - [ ] Deep Data
-    - [ ] User supplied line order
+    - [x] User supplied line order
     - [x] Rip/Mip Maps _(coded, but untested)_
-    - [ ] 100% correct meta data
+    - [x] 100% correct meta data
     - [x] Compression Methods
         - [x] Uncompressed
         - [x] ZIPS
@@ -157,7 +157,7 @@ please leave an issue on this repository, containing the image file.
 Add this to your `Cargo.toml`:
 ```toml
 [dependencies]
-exr = "0.7.0"
+exr = "0.7.4"
 
 # also, optionally add this to your crate for smaller binary size 
 # and better runtime performance
@@ -176,11 +176,11 @@ fn main() {
     let my_image = unimplemented!("this is your own image value");
 
     let get_pixel = |position: Vec2<usize>| {
-        let [r, g, b, a] = my_image.pixel_at_xy(position.0, position.1);
+        let [r, g, b, a] = my_image.pixel_at_xy(position.x(), position.y());
         rgba::Pixel::rgba(r, g, b, a)
     };
 
-    let image_info = rgba::Image::rgb(
+    let image_info = rgba::ImageInfo::rgb(
         (my_image.width, my_image.height), 
 
         // all numbers will be converted to f16 automatically
@@ -240,7 +240,7 @@ Allocations have a safe maximum size that will not be exceeded at once.
 
 ### Running Tests
 
-To run all fast tests, use `cargo test --no-fail-fast`.
+To run all fast tests, use `cargo test`.
 To start fuzzing indefinitely, use `cargo test --package exr --test fuzz fuzz -- --exact --ignored`.
 
 ### Specification

README.md

@@ -12,7 +12,7 @@ fn read_single_image(bench: &mut Bencher) {
     let path = "tests/images/valid/custom/crowskull/crow_uncompressed.exr";
 
     bench.iter(||{
-        rgba::Image::read_from_file(path, read_options::low(), rgba::pixels::flattened_f16).unwrap();
+        rgba::ImageInfo::read_pixels_from_file(path, read_options::low(), rgba::pixels::flattened_f16).unwrap();
     })
 }
 
@@ -21,7 +21,7 @@ fn read_single_image_from_buffer(bench: &mut Bencher) {
     let file = fs::read("tests/images/valid/custom/crowskull/crow_uncompressed.exr").unwrap();
 
     bench.iter(||{
-        rgba::Image::read_from_buffered(std::io::Cursor::new(&file), read_options::low(), rgba::pixels::flattened_f16).unwrap();
+        rgba::ImageInfo::read_pixels_from_buffered(std::io::Cursor::new(&file), read_options::low(), rgba::pixels::flattened_f16).unwrap();
     })
 }
 

benches/profiling.rs

@@ -11,7 +11,7 @@ fn read_rgba(bench: &mut Bencher) {
     bench.iter(||{
         let path = "tests/images/valid/custom/crowskull/crow_uncompressed.exr";
 
-        let image = rgba::Image::read_from_file(path, read_options::low(), rgba::pixels::flattened_f16).unwrap();
+        let image = rgba::ImageInfo::read_pixels_from_file(path, read_options::low(), rgba::pixels::flattened_f16).unwrap();
         bencher::black_box(image);
     })
 }

benches/rgba.rs

@@ -4,7 +4,8 @@
 extern crate exr;
 use exr::meta::MetaData;
 
-/// Print the custom meta data of a file, excluding technical file meta data.
+/// Print the custom meta data of a file, excluding technical encoding meta data.
+/// Prints compression method and tile size, but not chunk count.
 fn main() {
     let meta_data = MetaData::read_from_file("tests/images/valid/custom/crowskull/crow_uncompressed.exr").unwrap();
 

examples/read_meta.rs examples/0_read_meta.rsexamples/read_meta.rs renamed to examples/0_read_meta.rs

@@ -5,9 +5,11 @@ use exr::prelude::*;
 use exr::meta::attributes::SampleType;
 
 /// Write an RGBA exr file, generating the pixel values on the fly.
+/// This streams the generated pixel directly to the file,
+/// never allocating the actual total pixel memory of the image.
 fn main() {
 
-    // this function can generate a color for each pixel
+    // this function can generate a color for any pixel
     let generate_pixels = |position: Vec2<usize>| {
 
         // generate some arbitrary rgb colors, with varying size per channel
@@ -26,7 +28,8 @@ fn main() {
         )
     };
 
-    let image_info = rgba::Image::rgb(
+
+    let image_info = rgba::ImageInfo::rgb(
         (2*2048, 2*2048),
 
         // the generated f32 is converted to an f16 while writing the file
@@ -35,9 +38,10 @@ fn main() {
 
     // write it to a file with all cores in parallel
     image_info
-        .with_encoding(rgba::Encoding::compress(Compression::RLE))
-        .write_to_file(
+        .with_encoding(rgba::Encoding::for_compression(Compression::RLE))
+        .write_pixels_to_file(
             "tests/images/out/generated_rgba.exr",
-            write_options::high(), &generate_pixels
+            write_options::high(), // this will actually generate the pixels in parallel on all cores
+            &generate_pixels
         ).unwrap();
 }