added predictors (#86)

Added crate-public unpredict_float/hdiff functions. 
Added a PredictorInfo struct, inspired by tiff2.

* added predictors
* improved tests, fixed some bugs
* added docs+doctests
* added padding test, fixed corresponding bugs, removed printlns
* Remove registry
* Rename to Unpredict
* Change to pub(crate) fields
* Change to pub(crate)
* Remove lifetime and store a single element for bits_per_pixel
* Remove unused planar configuration
* chunk_width and chunk_height without unwrap
* Move PredictorInfo into predictor.rs
* Remove unnecessary doctests and unused code
* Only call chunks_* once
* Ensure no copies when endianness matches system endianness
* added planar_configuration back, updated bits_per_pixel and added tests
* removed UnPredict trait in favour of separate functions; small change to fix_endianness
* added doc comment clarifying that strips are also tiles
* made floating point predictor(s) use

---------

Co-authored-by: Kyle Barron <[email protected]>
Co-authored-by: Wei Ji <[email protected]>

Author: 3 people

src/cog.rs

@@ -23,7 +23,6 @@ mod test {
     use std::io::BufReader;
     use std::sync::Arc;
 
-    use crate::decoder::DecoderRegistry;
     use crate::metadata::{PrefetchBuffer, TiffMetadataReader};
     use crate::reader::{AsyncFileReader, ObjectReader};
 
@@ -51,9 +50,8 @@ mod test {
         let tiff = TIFF::new(ifds);
 
         let ifd = &tiff.ifds[1];
-        let decoder_registry = DecoderRegistry::default();
         let tile = ifd.fetch_tile(0, 0, reader.as_ref()).await.unwrap();
-        let tile = tile.decode(&decoder_registry).unwrap();
+        let tile = tile.decode(&Default::default()).unwrap();
         std::fs::write("img.buf", tile).unwrap();
     }
 

src/error.rs

@@ -15,6 +15,10 @@ pub enum AsyncTiffError {
     #[error("General error: {0}")]
     General(String),
 
+    /// Tile index error
+    #[error("Tile index out of bounds: {0}, {1}")]
+    TileIndexError(u32, u32),
+
     /// IO Error.
     #[error(transparent)]
     IOError(#[from] std::io::Error),

src/ifd.rs

@@ -6,7 +6,8 @@ use num_enum::TryFromPrimitive;
 
 use crate::error::{AsyncTiffError, AsyncTiffResult};
 use crate::geo::{GeoKeyDirectory, GeoKeyTag};
-use crate::reader::AsyncFileReader;
+use crate::predictor::PredictorInfo;
+use crate::reader::{AsyncFileReader, Endianness};
 use crate::tiff::tags::{
     CompressionMethod, PhotometricInterpretation, PlanarConfiguration, Predictor, ResolutionUnit,
     SampleFormat, Tag,
@@ -21,6 +22,8 @@ const DOCUMENT_NAME: u16 = 269;
 #[allow(dead_code)]
 #[derive(Debug, Clone)]
 pub struct ImageFileDirectory {
+    pub(crate) endianness: Endianness,
+
     pub(crate) new_subfile_type: Option<u32>,
 
     /// The number of columns in the image, i.e., the number of pixels per row.
@@ -143,7 +146,10 @@ pub struct ImageFileDirectory {
 
 impl ImageFileDirectory {
     /// Create a new ImageFileDirectory from tag data
-    pub fn from_tags(tag_data: HashMap<Tag, Value>) -> AsyncTiffResult<Self> {
+    pub fn from_tags(
+        tag_data: HashMap<Tag, Value>,
+        endianness: Endianness,
+    ) -> AsyncTiffResult<Self> {
         let mut new_subfile_type = None;
         let mut image_width = None;
         let mut image_height = None;
@@ -349,6 +355,7 @@ impl ImageFileDirectory {
             PlanarConfiguration::Chunky
         };
         Ok(Self {
+            endianness,
             new_subfile_type,
             image_width: image_width.expect("image_width not found"),
             image_height: image_height.expect("image_height not found"),
@@ -689,6 +696,8 @@ impl ImageFileDirectory {
         Ok(Tile {
             x,
             y,
+            predictor: self.predictor.unwrap_or(Predictor::None),
+            predictor_info: PredictorInfo::from_ifd(self),
             compressed_bytes,
             compression_method: self.compression,
             photometric_interpretation: self.photometric_interpretation,
@@ -705,6 +714,8 @@ impl ImageFileDirectory {
     ) -> AsyncTiffResult<Vec<Tile>> {
         assert_eq!(x.len(), y.len(), "x and y should have same len");
 
+        let predictor_info = PredictorInfo::from_ifd(self);
+
         // 1: Get all the byte ranges for all tiles
         let byte_ranges = x
             .iter()
@@ -724,6 +735,8 @@ impl ImageFileDirectory {
             let tile = Tile {
                 x,
                 y,
+                predictor: self.predictor.unwrap_or(Predictor::None),
+                predictor_info,
                 compressed_bytes,
                 compression_method: self.compression,
                 photometric_interpretation: self.photometric_interpretation,

src/lib.rs

@@ -9,6 +9,7 @@ pub mod error;
 pub mod geo;
 mod ifd;
 pub mod metadata;
+pub mod predictor;
 pub mod tiff;
 mod tile;
 

src/metadata/reader.rs

@@ -226,7 +226,7 @@ impl ImageFileDirectoryReader {
             let (tag, value) = self.read_tag(fetch, tag_idx).await?;
             tags.insert(tag, value);
         }
-        ImageFileDirectory::from_tags(tags)
+        ImageFileDirectory::from_tags(tags, self.endianness)
     }
 
     /// Finish this reader, reading the byte offset of the next IFD
@@ -623,11 +623,14 @@ async fn read_tag_value<F: MetadataFetch>(
 
 #[cfg(test)]
 mod test {
+    use crate::{
+        metadata::{reader::read_tag, MetadataFetch},
+        reader::Endianness,
+        tiff::{tags::Tag, Value},
+    };
     use bytes::Bytes;
     use futures::FutureExt;
 
-    use super::*;
-
     impl MetadataFetch for Bytes {
         fn fetch(
             &self,