Merge pull request #222 from image-rs/release-0.14.0

Release 0.14.0

Author: 197g

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "gif"
 license = "MIT OR Apache-2.0"
-version = "0.13.3"
+version = "0.14.0"
 description = "GIF de- and encoder"
 authors = ["The image-rs Developers"]
 readme = "README.md"
@@ -21,8 +21,8 @@ color_quant = { version = "1.1", optional = true }
 
 [dev-dependencies]
 glob = "0.3"
-criterion = "0.5.1"
-png = "0.17.16"
+criterion = "0.7.0"
+png = "0.18.0"
 rayon = "1.10.0" # for parallel reencoding example
 
 [features]

Changes.md

@@ -1,3 +1,15 @@
+# v0.14.0
+
+- `EncodingError` and `DecodingError` are now `#[non_exhaustive]`
+- Modified several error paths to return a new variant of `EncodingError` instead of boxing them into
+  an `io::Error`, several return `Result` types are adjusted accordingly.
+- The `Decoded` enum no longer communicates data from decoded sub-blocks such as the repetition count.
+  It now only contains the meta information on framing and extension data. This ensures we are yielding
+  less often for performance.
+- `last_ext` was renamed to `last_extension_sub_block` for clarity.
+- The `Decoder` will now collect XMP and ICC metadata subblocks, making them available after decoding.
+
+
 # v0.13.3
 
 - Fix interpretation of LZW stream when multiple intermediate reset codes are used.

benches/decode.rs

@@ -1,7 +1,6 @@
-use criterion::{
-    black_box, measurement::Measurement, BenchmarkGroup, BenchmarkId, Criterion, Throughput,
-};
+use criterion::{measurement::Measurement, BenchmarkGroup, BenchmarkId, Criterion, Throughput};
 use gif::Decoder;
+use std::hint::black_box;
 
 fn read_image(image: &[u8]) -> Option<Vec<u8>> {
     let decoder = Decoder::new(black_box(image));

benches/rgb_frame.rs

@@ -1,4 +1,4 @@
-use std::fs;
+use std::{fs, io};
 
 use criterion::{Criterion, Throughput};
 use gif::{Encoder, Frame, Repeat};
@@ -19,11 +19,11 @@ fn main() {
 
         let mut reader = {
             let input = fs::File::open(&path).unwrap();
-            let decoder = png::Decoder::new(input);
+            let decoder = png::Decoder::new(io::BufReader::new(input));
             decoder.read_info().unwrap()
         };
 
-        let mut buf = vec![0; reader.output_buffer_size()];
+        let mut buf = vec![0; reader.output_buffer_size().unwrap()];
         let info = reader.next_frame(&mut buf).unwrap();
 
         let (w, h, size) = {

src/common.rs

@@ -2,7 +2,7 @@ use alloc::borrow::Cow;
 use alloc::vec::Vec;
 
 #[cfg(feature = "color_quant")]
-use std::collections::{BTreeMap, BTreeSet};
+use alloc::collections::{BTreeMap, BTreeSet};
 
 /// Disposal method
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]

src/reader/decoder.rs

@@ -329,7 +329,7 @@ impl LzwReader {
 
         let (status, consumed_in, consumed_out) = match decode_buffer {
             OutputBuffer::Slice(buf) => {
-                let decoded = decoder.decode_bytes(lzw_data, &mut **buf);
+                let decoded = decoder.decode_bytes(lzw_data, buf);
                 (decoded.status, decoded.consumed_in, decoded.consumed_out)
             }
             OutputBuffer::None => {