diff --git a/CHANGES.md b/CHANGES.md index f0d4d0a..63533af 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,12 @@ +# Version 0.6.0-alpha + +* Support for decoding BigTIFF with 64-bit offsets +* Better support for adding auxiliary tags before encoding image data +* Fixed decoding of inline ASCII in tags +* Fixed handling after null terminator in ASCII data +* Recognize tile and sample format tags +* Note: these notes will be merged into 0.6.0 when it is released + # Version 0.5.0 * Added support for 32-bit and 64-bit decoded values. diff --git a/Cargo.toml b/Cargo.toml index ee78534..36c7a34 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "tiff" -version = "0.5.0" +version = "0.6.0-alpha" authors = [ "ccgn", "bvssvni ", @@ -17,6 +17,7 @@ repository = "https://github.com/image-rs/image-tiff" exclude = ["tests/images/*", "tests/fuzz_images/*"] [dependencies] -byteorder = "1.2" lzw = "0.10" -miniz_oxide = "0.3" +[dependencies.miniz_oxide] +version = "0.4.1" +features = ["no_extern_crate_alloc"] diff --git a/src/bytecast.rs b/src/bytecast.rs new file mode 100644 index 0000000..906ac79 --- /dev/null +++ b/src/bytecast.rs @@ -0,0 +1,33 @@ +//! Trivial, internal byte transmutation. +//! +//! A dependency like bytemuck would give us extra assurance of the safety but overall would not +//! reduce the amount of total unsafety. We don't use it in the interface where the traits would +//! really become useful. +//! +//! SAFETY: These are benign casts as we apply them to fixed size integer types only. All of them +//! are naturally aligned, valid for all bit patterns and their alignment is surely at most their +//! size (we assert the latter fact since it is 'implementation defined' if following the letter of +//! the unsafe code guidelines). +//! +//! TODO: Would like to use std-lib here. +use std::{mem, slice}; + +macro_rules! integral_slice_as_bytes{($int:ty, $const:ident $(,$mut:ident)*) => { + pub(crate) fn $const(slice: &[$int]) -> &[u8] { + assert!(mem::align_of::<$int>() <= mem::size_of::<$int>()); + unsafe { slice::from_raw_parts(slice.as_ptr() as *const u8, mem::size_of_val(slice)) } + } + $(pub(crate) fn $mut(slice: &mut [$int]) -> &mut [u8] { + assert!(mem::align_of::<$int>() <= mem::size_of::<$int>()); + unsafe { slice::from_raw_parts_mut(slice.as_mut_ptr() as *mut u8, mem::size_of_val(slice)) } + })* +}} + +integral_slice_as_bytes!(i8, i8_as_ne_bytes); +integral_slice_as_bytes!(u16, u16_as_ne_bytes, u16_as_ne_mut_bytes); +integral_slice_as_bytes!(i16, i16_as_ne_bytes); +integral_slice_as_bytes!(u32, u32_as_ne_bytes, u32_as_ne_mut_bytes); +integral_slice_as_bytes!(i32, i32_as_ne_bytes); +integral_slice_as_bytes!(u64, u64_as_ne_bytes, u64_as_ne_mut_bytes); +integral_slice_as_bytes!(f32, f32_as_ne_bytes, f32_as_ne_mut_bytes); +integral_slice_as_bytes!(f64, f64_as_ne_bytes, f64_as_ne_mut_bytes); diff --git a/src/decoder/ifd.rs b/src/decoder/ifd.rs index 7276069..8667299 100644 --- a/src/decoder/ifd.rs +++ b/src/decoder/ifd.rs @@ -1,7 +1,7 @@ //! Function for reading TIFF tags use std::collections::HashMap; -use std::convert::TryFrom; +use std::convert::{TryInto, TryFrom}; use std::io::{self, Read, Seek}; use std::mem; @@ -9,19 +9,23 @@ use super::stream::{ByteOrder, EndianReader, SmartReader}; use tags::{Tag, Type}; use {TiffError, TiffFormatError, TiffResult, TiffUnsupportedError}; -use self::Value::{Ascii, List, Rational, Unsigned, Signed, SRational, Float, Double}; +use self::Value::{Ascii, List, Float, Double, Rational, Unsigned, Signed, SRational, RationalBig, UnsignedBig, SignedBig, SRationalBig}; #[allow(unused_qualifications)] #[derive(Debug, Clone, PartialEq)] pub enum Value { Signed(i32), + SignedBig(i64), Unsigned(u32), + UnsignedBig(u64), Float(f32), Double(f64), List(Vec), Rational(u32, u32), + RationalBig(u64, u64), SRational(i32, i32), + SRationalBig(i64, i64), Ascii(String), #[doc(hidden)] // Do not match against this. __NonExhaustive, @@ -31,6 +35,7 @@ impl Value { pub fn into_u32(self) -> TiffResult { match self { Unsigned(val) => Ok(val), + UnsignedBig(val) => Ok(u32::try_from(val)?), val => Err(TiffError::FormatError( TiffFormatError::UnsignedIntegerExpected(val), )), @@ -40,6 +45,27 @@ impl Value { pub fn into_i32(self) -> TiffResult { match self { Signed(val) => Ok(val), + SignedBig(val) => Ok(i32::try_from(val)?), + val => Err(TiffError::FormatError( + TiffFormatError::SignedIntegerExpected(val), + )), + } + } + + pub fn into_u64(self) -> TiffResult { + match self { + Unsigned(val) => Ok(val.into()), + UnsignedBig(val) => Ok(val), + val => Err(TiffError::FormatError( + TiffFormatError::UnsignedIntegerExpected(val), + )), + } + } + + pub fn into_i64(self) -> TiffResult { + match self { + Signed(val) => Ok(val.into()), + SignedBig(val) => Ok(val), val => Err(TiffError::FormatError( TiffFormatError::SignedIntegerExpected(val), )), @@ -74,7 +100,9 @@ impl Value { Ok(new_vec) } Unsigned(val) => Ok(vec![val]), + UnsignedBig(val) => Ok(vec![u32::try_from(val)?]), Rational(numerator, denominator) => Ok(vec![numerator, denominator]), + RationalBig(numerator, denominator) => Ok(vec![u32::try_from(numerator)?, u32::try_from(denominator)?]), Ascii(val) => Ok(val.chars().map(u32::from).collect()), val => Err(TiffError::FormatError( TiffFormatError::UnsignedIntegerExpected(val), @@ -92,13 +120,19 @@ impl Value { new_vec.push(numerator); new_vec.push(denominator); } - _ => new_vec.push(v.into_i32()?) + SRationalBig(numerator, denominator) => { + new_vec.push(i32::try_from(numerator)?); + new_vec.push(i32::try_from(denominator)?); + } + _ => new_vec.push(v.into_i32()?), } } Ok(new_vec) } Signed(val) => Ok(vec![val]), + SignedBig(val) => Ok(vec![i32::try_from(val)?]), SRational(numerator, denominator) => Ok(vec![numerator, denominator]), + SRationalBig(numerator, denominator) => Ok(vec![i32::try_from(numerator)?, i32::try_from(denominator)?]), val => Err(TiffError::FormatError( TiffFormatError::SignedIntegerExpected(val), )), @@ -136,13 +170,62 @@ impl Value { )), } } -} + pub fn into_u64_vec(self) -> TiffResult> { + match self { + List(vec) => { + let mut new_vec = Vec::with_capacity(vec.len()); + for v in vec { + new_vec.push(v.into_u64()?) + } + Ok(new_vec) + } + Unsigned(val) => Ok(vec![val.into()]), + UnsignedBig(val) => Ok(vec![val]), + Rational(numerator, denominator) => Ok(vec![numerator.into(), denominator.into()]), + RationalBig(numerator, denominator) => Ok(vec![numerator, denominator]), + Ascii(val) => Ok(val.chars().map(u32::from).map(u64::from).collect()), + val => Err(TiffError::FormatError( + TiffFormatError::UnsignedIntegerExpected(val), + )), + } + } + + pub fn into_i64_vec(self) -> TiffResult> { + match self { + List(vec) => { + let mut new_vec = Vec::with_capacity(vec.len()); + for v in vec { + match v { + SRational(numerator, denominator) => { + new_vec.push(numerator.into()); + new_vec.push(denominator.into()); + } + SRationalBig(numerator, denominator) => { + new_vec.push(numerator); + new_vec.push(denominator); + } + _ => new_vec.push(v.into_i64()?), + } + } + Ok(new_vec) + } + Signed(val) => Ok(vec![val.into()]), + SignedBig(val) => Ok(vec![val]), + SRational(numerator, denominator) => Ok(vec![numerator.into(), denominator.into()]), + SRationalBig(numerator, denominator) => Ok(vec![numerator, denominator]), + val => Err(TiffError::FormatError( + TiffFormatError::SignedIntegerExpected(val), + )), + } + } +} + #[derive(Clone)] pub struct Entry { type_: Type, - count: u32, - offset: [u8; 4], + count: u64, + offset: [u8; 8], } impl ::std::fmt::Debug for Entry { @@ -156,6 +239,12 @@ impl ::std::fmt::Debug for Entry { impl Entry { pub fn new(type_: Type, count: u32, offset: [u8; 4]) -> Entry { + let mut offset = offset.to_vec(); + offset.append(&mut vec![0; 4]); + Entry::new_u64(type_, count.into(), offset[..].try_into().unwrap()) + } + + pub fn new_u64(type_: Type, count: u64, offset: [u8; 8]) -> Entry { Entry { type_, count, @@ -174,108 +263,178 @@ impl Entry { decoder: &mut super::Decoder, ) -> TiffResult { let bo = decoder.byte_order(); - match (self.type_, self.count) { - // TODO check if this could give wrong results - // at a different endianess of file/computer. - (Type::BYTE, 1) => Ok(Unsigned(u32::from(self.offset[0]))), - (Type::BYTE, 2) => offset_to_bytes(2, self), - (Type::BYTE, 3) => offset_to_bytes(3, self), - (Type::BYTE, 4) => offset_to_bytes(4, self), - (Type::BYTE, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Unsigned(u32::from(decoder.read_byte()?))) - }), - (Type::SBYTE, 1) => Ok(Signed(i32::from(self.offset[0] as i8))), - (Type::SBYTE, 2) => offset_to_sbytes(2, self), - (Type::SBYTE, 3) => offset_to_sbytes(3, self), - (Type::SBYTE, 4) => offset_to_sbytes(4, self), - (Type::SBYTE, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Signed(i32::from(decoder.read_byte()? as i8))) - }), - (Type::SHORT, 1) => Ok(Unsigned(u32::from(self.r(bo).read_u16()?))), - (Type::SSHORT, 1) => Ok(Signed(i32::from(self.r(bo).read_i16()?))), - (Type::SHORT, 2) => { - let mut r = self.r(bo); - Ok(List(vec![ - Unsigned(u32::from(r.read_u16()?)), - Unsigned(u32::from(r.read_u16()?)), - ])) + let bigtiff_value = if decoder.bigtiff { + match (self.type_, self.count) { + (Type::BYTE, 5) => Some(offset_to_bytes(5, self)?), + (Type::BYTE, 6) => Some(offset_to_bytes(6, self)?), + (Type::BYTE, 7) => Some(offset_to_bytes(7, self)?), + (Type::BYTE, 8) => Some(offset_to_bytes(8, self)?), + (Type::SBYTE, 5) => Some(offset_to_sbytes(5, self)?), + (Type::SBYTE, 6) => Some(offset_to_sbytes(6, self)?), + (Type::SBYTE, 7) => Some(offset_to_sbytes(7, self)?), + (Type::SBYTE, 8) => Some(offset_to_sbytes(8, self)?), + (Type::SHORT, 3) => { + let mut r = self.r(bo); + Some(List(vec![ + Unsigned(u32::from(r.read_u16()?)), + Unsigned(u32::from(r.read_u16()?)), + Unsigned(u32::from(r.read_u16()?)), + ])) + } + (Type::SSHORT, 3) => { + let mut r = self.r(bo); + Some(List(vec![ + Signed(i32::from(r.read_i16()?)), + Signed(i32::from(r.read_i16()?)), + Signed(i32::from(r.read_i16()?)), + ])) + } + (Type::SHORT, 4) => { + let mut r = self.r(bo); + Some(List(vec![ + Unsigned(u32::from(r.read_u16()?)), + Unsigned(u32::from(r.read_u16()?)), + Unsigned(u32::from(r.read_u16()?)), + Unsigned(u32::from(r.read_u16()?)), + ])) + } + (Type::SSHORT, 4) => { + let mut r = self.r(bo); + Some(List(vec![ + Signed(i32::from(r.read_i16()?)), + Signed(i32::from(r.read_i16()?)), + Signed(i32::from(r.read_i16()?)), + Signed(i32::from(r.read_i16()?)), + ])) + } + (Type::LONG, 2) => { + let mut r = self.r(bo); + Some(List(vec![ + Unsigned(r.read_u32()?), + Unsigned(r.read_u32()?), + ])) + } + (Type::SLONG, 2) => { + let mut r = self.r(bo); + Some(List(vec![ + Signed(r.read_i32()?), + Signed(r.read_i32()?), + ])) + } + (Type::RATIONAL, 1) => { + let mut r = self.r(bo); + let numerator = r.read_u32()?; + let denominator = r.read_u32()?; + Some(Rational(numerator, denominator)) + } + (Type::SRATIONAL, 1) => { + let mut r = self.r(bo); + let numerator = r.read_i32()?; + let denominator = r.read_i32()?; + Some(SRational(numerator, denominator)) + } + _ => None } - (Type::SSHORT, 2) => { - let mut r = self.r(bo); - Ok(List(vec![ - Signed(i32::from(r.read_i16()?)), - Signed(i32::from(r.read_i16()?)), - ])) - } - (Type::SHORT, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Unsigned(u32::from(decoder.read_short()?))) - }), - (Type::SSHORT, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Signed(i32::from(decoder.read_sshort()?))) - }), - (Type::LONG, 1) => Ok(Unsigned(self.r(bo).read_u32()?)), - (Type::SLONG, 1) => Ok(Signed(self.r(bo).read_i32()?)), - (Type::LONG, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Unsigned(decoder.read_long()?)) - }), - (Type::SLONG, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Signed(decoder.read_slong()?)) - }), - (Type::FLOAT, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + } else { + None + }; + + if let Some(v) = bigtiff_value { + Ok(v) + } else { + match (self.type_, self.count) { + // TODO check if this could give wrong results + // at a different endianess of file/computer. + (Type::BYTE, 1) => Ok(Unsigned(u32::from(self.offset[0]))), + (Type::BYTE, 2) => offset_to_bytes(2, self), + (Type::BYTE, 3) => offset_to_bytes(3, self), + (Type::BYTE, 4) => offset_to_bytes(4, self), + (Type::BYTE, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(UnsignedBig(u64::from(decoder.read_byte()?))) + }), + (Type::SBYTE, 1) => Ok(Signed(i32::from(self.offset[0] as i8))), + (Type::SBYTE, 2) => offset_to_sbytes(2, self), + (Type::SBYTE, 3) => offset_to_sbytes(3, self), + (Type::SBYTE, 4) => offset_to_sbytes(4, self), + (Type::SBYTE, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(SignedBig(i64::from(decoder.read_byte()? as i8))) + }), + (Type::SHORT, 1) => Ok(Unsigned(u32::from(self.r(bo).read_u16()?))), + (Type::SSHORT, 1) => Ok(Signed(i32::from(self.r(bo).read_i16()?))), + (Type::SHORT, 2) => { + let mut r = self.r(bo); + Ok(List(vec![ + Unsigned(u32::from(r.read_u16()?)), + Unsigned(u32::from(r.read_u16()?)), + ])) + } + (Type::SSHORT, 2) => { + let mut r = self.r(bo); + Ok(List(vec![ + Signed(i32::from(r.read_i16()?)), + Signed(i32::from(r.read_i16()?)), + ])) + } + (Type::SHORT, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(UnsignedBig(u64::from(decoder.read_short()?))) + }), + (Type::SSHORT, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(SignedBig(i64::from(decoder.read_sshort()?))) + }), + (Type::LONG, 1) => Ok(Unsigned(self.r(bo).read_u32()?)), + (Type::SLONG, 1) => Ok(Signed(self.r(bo).read_i32()?)), + (Type::LONG, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(Unsigned(decoder.read_long()?)) + }), + (Type::SLONG, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(Signed(decoder.read_slong()?)) + }), + (Type::FLOAT, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { Ok(Float(decoder.read_float()?)) - }), - (Type::DOUBLE, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + }), + (Type::DOUBLE, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { Ok(Double(decoder.read_double()?)) - }), - (Type::RATIONAL, 1) => { - decoder.goto_offset(self.r(bo).read_u32()?)?; - let numerator = decoder.read_long()?; - let denominator = decoder.read_long()?; - Ok(Rational(numerator, denominator)) - } - (Type::SRATIONAL, 1) => { - decoder.goto_offset(self.r(bo).read_u32()?)?; - let numerator = decoder.read_slong()?; - let denominator = decoder.read_slong()?; - Ok(SRational(numerator, denominator)) - } - (Type::RATIONAL, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(Rational( - decoder.read_long()?, - decoder.read_long()?, - )) - }), - (Type::SRATIONAL, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { - Ok(SRational( - decoder.read_slong()?, - decoder.read_slong()?, - )) - }), - (Type::ASCII, n) => { - let n = usize::try_from(n)?; - if n > limits.decoding_buffer_size { - return Err(TiffError::LimitsExceeded); - } - if n <= 4 { - let mut buf = vec![0; n]; - self.r(bo).read_exact(&mut buf )?; - let v = String::from_utf8(buf)?; - let v = v.trim_matches(char::from(0)); - Ok(Ascii(v.into())) - } else { - decoder.goto_offset(self.r(bo).read_u32()?)?; - let string = decoder.read_string(n)?; - Ok(Ascii(string)) + }), + (Type::RATIONAL, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(Rational(decoder.read_long()?, decoder.read_long()?)) + }), + (Type::SRATIONAL, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(SRational(decoder.read_slong()?, decoder.read_slong()?)) + }), + (Type::LONG8, n) => self.decode_offset(n, bo, limits, decoder, |decoder| { + Ok(UnsignedBig(decoder.read_long8()?)) + }), + (Type::ASCII, n) => { + let n = usize::try_from(n)?; + if n > limits.decoding_buffer_size { + return Err(TiffError::LimitsExceeded); + } + + if (n <= 4 && !decoder.bigtiff) || (n <= 8 && decoder.bigtiff) { + let mut buf = vec![0; n]; + self.r(bo).read_exact(&mut buf )?; + let v = String::from_utf8(buf)?; + let v = v.trim_matches(char::from(0)); + Ok(Ascii(v.into())) + } else { + if decoder.bigtiff { + decoder.goto_offset_u64(self.r(bo).read_u64()?)? + } else { + decoder.goto_offset(self.r(bo).read_u32()?)? + } + let string = decoder.read_string(n)?; + Ok(Ascii(string)) + } } + _ => Err(TiffError::UnsupportedError( + TiffUnsupportedError::UnsupportedDataType, + )), } - _ => Err(TiffError::UnsupportedError( - TiffUnsupportedError::UnsupportedDataType, - )), } } #[inline] - fn decode_offset(&self, value_count: u32, bo: ByteOrder, limits: &super::Limits, decoder: &mut super::Decoder, decode_fn: F) -> TiffResult + fn decode_offset(&self, value_count: u64, bo: ByteOrder, limits: &super::Limits, decoder: &mut super::Decoder, decode_fn: F) -> TiffResult where R: Read + Seek, F: Fn(&mut super::Decoder) -> TiffResult, @@ -286,7 +445,11 @@ impl Entry { } let mut v = Vec::with_capacity(value_count); - decoder.goto_offset(self.r(bo).read_u32()?)?; + if decoder.bigtiff { + decoder.goto_offset_u64(self.r(bo).read_u64()?)? + } else { + decoder.goto_offset(self.r(bo).read_u32()?)? + } for _ in 0..value_count { v.push(decode_fn(decoder)?) } diff --git a/src/decoder/mod.rs b/src/decoder/mod.rs index d559dd9..fcb1736 100644 --- a/src/decoder/mod.rs +++ b/src/decoder/mod.rs @@ -148,8 +148,8 @@ impl<'a> DecodingBuffer<'a> { #[derive(Debug)] struct StripDecodeState { strip_index: usize, - strip_offsets: Vec, - strip_bytes: Vec, + strip_offsets: Vec, + strip_bytes: Vec, } /// Decoding limits @@ -189,8 +189,9 @@ where { reader: SmartReader, byte_order: ByteOrder, + bigtiff: bool, limits: Limits, - next_ifd: Option, + next_ifd: Option, ifd: Option, width: u32, height: u32, @@ -309,6 +310,7 @@ impl Decoder { Decoder { reader: SmartReader::wrap(r, ByteOrder::LittleEndian), byte_order: ByteOrder::LittleEndian, + bigtiff: false, limits: Default::default(), next_ifd: None, ifd: None, @@ -392,12 +394,28 @@ impl Decoder { )) } } - if self.read_short()? != 42 { - return Err(TiffError::FormatError( + match self.read_short()? { + 42 => self.bigtiff = false, + 43 => { + self.bigtiff = true; + // Read bytesize of offsets (in bigtiff it's alway 8 but provide a way to move to 16 some day) + if self.read_short()? != 8 { + return Err(TiffError::FormatError( + TiffFormatError::TiffSignatureNotFound, + )) + } + // This constant should always be 0 + if self.read_short()? != 0 { + return Err(TiffError::FormatError( + TiffFormatError::TiffSignatureNotFound, + )) + } + }, + _ => return Err(TiffError::FormatError( TiffFormatError::TiffSignatureInvalid, - )); + )) } - self.next_ifd = match self.read_long()? { + self.next_ifd = match self.read_ifd_offset()? { 0 => None, n => Some(n), }; @@ -461,6 +479,15 @@ impl Decoder { self.byte_order } + #[inline] + pub fn read_ifd_offset(&mut self) -> Result { + if self.bigtiff { + self.read_long8() + } else { + self.read_long().map(u64::from) + } + } + /// Reads a TIFF byte value #[inline] pub fn read_byte(&mut self) -> Result { @@ -505,6 +532,11 @@ impl Decoder { self.reader.read_f64() } + #[inline] + pub fn read_long8(&mut self) -> Result { + self.reader.read_u64() + } + /// Reads a string #[inline] pub fn read_string(&mut self, length: usize) -> TiffResult { @@ -519,17 +551,33 @@ impl Decoder { /// Reads a TIFF IFA offset/value field #[inline] - pub fn read_offset(&mut self) -> Result<[u8; 4], io::Error> { + pub fn read_offset(&mut self) -> TiffResult<[u8; 4]> { + if self.bigtiff { + return Err(TiffError::FormatError(TiffFormatError::InconsistentSizesEncountered)) + } let mut val = [0; 4]; self.reader.read_exact(&mut val)?; Ok(val) } + /// Reads a TIFF IFA offset/value field + #[inline] + pub fn read_offset_u64(&mut self) -> Result<[u8; 8], io::Error> { + let mut val = [0; 8]; + self.reader.read_exact(&mut val)?; + Ok(val) + } + /// Moves the cursor to the specified offset #[inline] pub fn goto_offset(&mut self, offset: u32) -> io::Result<()> { + self.goto_offset_u64(offset.into()) + } + + #[inline] + pub fn goto_offset_u64(&mut self, offset: u64) -> io::Result<()> { self.reader - .seek(io::SeekFrom::Start(u64::from(offset))) + .seek(io::SeekFrom::Start(offset)) .map(|_| ()) } @@ -551,13 +599,22 @@ impl Decoder { return Ok(None); } }; - Ok(Some(( - tag, + let entry = if self.bigtiff { + ifd::Entry::new_u64( + type_, + self.read_long8()?, + self.read_offset_u64()? + ) + } else { ifd::Entry::new( type_, - self.read_long()?, // count - self.read_offset()?, // offset - ), + self.read_long()?, + self.read_offset()? + ) + }; + Ok(Some(( + tag, + entry, ))) } @@ -570,16 +627,17 @@ impl Decoder { TiffFormatError::ImageFileDirectoryNotFound, )) } - Some(offset) => self.goto_offset(offset)?, + Some(offset) => self.goto_offset_u64(offset)?, } - for _ in 0..self.read_short()? { + let num_tags = if self.bigtiff { self.read_long8()? } else { self.read_short()?.into() }; + for _ in 0..num_tags { let (tag, entry) = match self.read_entry()? { Some(val) => val, None => continue, // Unknown data type in tag, skip }; dir.insert(tag, entry); } - self.next_ifd = match self.read_long()? { + self.next_ifd = match self.read_ifd_offset()? { 0 => None, n => Some(n), }; @@ -600,9 +658,9 @@ impl Decoder { } /// Tries to retrieve a tag and convert it to the desired unsigned type. - pub fn find_tag_unsigned>(&mut self, tag: Tag) -> TiffResult> { + pub fn find_tag_unsigned>(&mut self, tag: Tag) -> TiffResult> { self.find_tag(tag)? - .map(|v| v.into_u32()).transpose()? + .map(|v| v.into_u64()).transpose()? .map(|value| T::try_from(value) .map_err(|_| TiffFormatError::InvalidTagValueType(tag).into())) .transpose() @@ -610,9 +668,9 @@ impl Decoder { /// Tries to retrieve a vector of all a tag's values and convert them to /// the desired unsigned type. - pub fn find_tag_unsigned_vec>(&mut self, tag: Tag) -> TiffResult>> { + pub fn find_tag_unsigned_vec>(&mut self, tag: Tag) -> TiffResult>> { self.find_tag(tag)? - .map(|v| v.into_u32_vec()).transpose()? + .map(|v| v.into_u64_vec()).transpose()? .map(|v| v.into_iter() .map(|u| T::try_from(u).map_err(|_| TiffFormatError::InvalidTagValueType(tag).into())) .collect()) @@ -621,7 +679,7 @@ impl Decoder { /// Tries to retrieve a tag and convert it to the desired unsigned type. /// Returns an error if the tag is not present. - pub fn get_tag_unsigned>(&mut self, tag: Tag) -> TiffResult { + pub fn get_tag_unsigned>(&mut self, tag: Tag) -> TiffResult { self.find_tag_unsigned(tag)? .ok_or_else(|| TiffFormatError::RequiredTagNotFound(tag).into()) } @@ -641,6 +699,9 @@ impl Decoder { pub fn get_tag_u32(&mut self, tag: Tag) -> TiffResult { self.get_tag(tag)?.into_u32() } + pub fn get_tag_u64(&mut self, tag: Tag) -> TiffResult { + self.get_tag(tag)?.into_u64() + } /// Tries to retrieve a tag and convert it to the desired type. pub fn get_tag_f32(&mut self, tag: Tag) -> TiffResult { @@ -656,6 +717,9 @@ impl Decoder { pub fn get_tag_u32_vec(&mut self, tag: Tag) -> TiffResult> { self.get_tag(tag)?.into_u32_vec() } + pub fn get_tag_u64_vec(&mut self, tag: Tag) -> TiffResult> { + self.get_tag(tag)?.into_u64_vec() + } /// Tries to retrieve a tag and convert it to the desired type. pub fn get_tag_f32_vec(&mut self, tag: Tag) -> TiffResult> { @@ -672,13 +736,13 @@ impl Decoder { fn expand_strip<'a>( &mut self, buffer: DecodingBuffer<'a>, - offset: u32, - length: u32, + offset: u64, + length: u64, max_uncompressed_length: usize, ) -> TiffResult { let color_type = self.colortype()?; - self.goto_offset(offset)?; - let (bytes, mut reader): (usize, Box) = match self.compression_method { + self.goto_offset_u64(offset)?; + let (bytes, mut reader): (usize, Box) = match self.compression_method { CompressionMethod::None => { let order = self.reader.byte_order; ( @@ -836,8 +900,8 @@ impl Decoder { fn initialize_strip_decoder(&mut self) -> TiffResult<()> { if self.strip_decoder.is_none() { - let strip_offsets = self.get_tag_u32_vec(Tag::StripOffsets)?; - let strip_bytes = self.get_tag_u32_vec(Tag::StripByteCounts)?; + let strip_offsets = self.get_tag_u64_vec(Tag::StripOffsets)?; + let strip_bytes = self.get_tag_u64_vec(Tag::StripByteCounts)?; self.strip_decoder = Some(StripDecodeState { strip_index: 0, diff --git a/src/decoder/stream.rs b/src/decoder/stream.rs index cdee074..2796fe4 100644 --- a/src/decoder/stream.rs +++ b/src/decoder/stream.rs @@ -1,7 +1,7 @@ //! All IO functionality needed for TIFF decoding +use crate::bytecast; use crate::error::{TiffError, TiffResult}; -use byteorder::{BigEndian, LittleEndian, ReadBytesExt}; use lzw; use miniz_oxide::inflate; use std::io::{self, Read, Seek}; @@ -23,124 +23,158 @@ pub trait EndianReader: Read { /// Reads an u16 #[inline(always)] fn read_u16(&mut self) -> Result { - match self.byte_order() { - ByteOrder::LittleEndian => ::read_u16::(self), - ByteOrder::BigEndian => ::read_u16::(self), - } + let mut n = [0u8; 2]; + self.read_exact(&mut n)?; + Ok(match self.byte_order() { + ByteOrder::LittleEndian => u16::from_le_bytes(n), + ByteOrder::BigEndian => u16::from_be_bytes(n), + }) } #[inline(always)] fn read_u16_into(&mut self, buffer: &mut [u16]) -> Result<(), io::Error> { + self.read_exact(bytecast::u16_as_ne_mut_bytes(buffer))?; match self.byte_order() { - ByteOrder::LittleEndian => { - ::read_u16_into::(self, buffer) - } - ByteOrder::BigEndian => { - ::read_u16_into::(self, buffer) - } + ByteOrder::LittleEndian => + for n in buffer { + *n = u16::from_le(*n); + }, + ByteOrder::BigEndian => + for n in buffer { + *n = u16::from_be(*n); + }, } + Ok(()) } /// Reads an i16 #[inline(always)] fn read_i16(&mut self) -> Result { - match self.byte_order() { - ByteOrder::LittleEndian => ::read_i16::(self), - ByteOrder::BigEndian => ::read_i16::(self), - } + let mut n = [0u8; 2]; + self.read_exact(&mut n)?; + Ok(match self.byte_order() { + ByteOrder::LittleEndian => i16::from_le_bytes(n), + ByteOrder::BigEndian => i16::from_be_bytes(n), + }) } /// Reads an u32 #[inline(always)] fn read_u32(&mut self) -> Result { - match self.byte_order() { - ByteOrder::LittleEndian => ::read_u32::(self), - ByteOrder::BigEndian => ::read_u32::(self), - } + let mut n = [0u8; 4]; + self.read_exact(&mut n)?; + Ok(match self.byte_order() { + ByteOrder::LittleEndian => u32::from_le_bytes(n), + ByteOrder::BigEndian => u32::from_be_bytes(n), + }) } #[inline(always)] fn read_u32_into(&mut self, buffer: &mut [u32]) -> Result<(), io::Error> { + self.read_exact(bytecast::u32_as_ne_mut_bytes(buffer))?; match self.byte_order() { - ByteOrder::LittleEndian => { - ::read_u32_into::(self, buffer) - } - ByteOrder::BigEndian => { - ::read_u32_into::(self, buffer) - } - } - } - - /// Reads an u64 - #[inline(always)] - fn read_u64(&mut self) -> Result { - match self.byte_order() { - ByteOrder::LittleEndian => ::read_u64::(self), - ByteOrder::BigEndian => ::read_u64::(self), - } - } - - #[inline(always)] - fn read_u64_into(&mut self, buffer: &mut [u64]) -> Result<(), io::Error> { - match self.byte_order() { - ByteOrder::LittleEndian => { - ::read_u64_into::(self, buffer) - } - ByteOrder::BigEndian => { - ::read_u64_into::(self, buffer) - } + ByteOrder::LittleEndian => + for n in buffer { + *n = u32::from_le(*n); + }, + ByteOrder::BigEndian => + for n in buffer { + *n = u32::from_be(*n); + }, } + Ok(()) } /// Reads an i32 #[inline(always)] fn read_i32(&mut self) -> Result { + let mut n = [0u8; 4]; + self.read_exact(&mut n)?; + Ok(match self.byte_order() { + ByteOrder::LittleEndian => i32::from_le_bytes(n), + ByteOrder::BigEndian => i32::from_be_bytes(n), + }) + } + + /// Reads an u64 + #[inline(always)] + fn read_u64(&mut self) -> Result { + let mut n = [0u8; 8]; + self.read_exact(&mut n)?; + Ok(match self.byte_order() { + ByteOrder::LittleEndian => u64::from_le_bytes(n), + ByteOrder::BigEndian => u64::from_be_bytes(n), + }) + } + + #[inline(always)] + fn read_u64_into(&mut self, buffer: &mut [u64]) -> Result<(), io::Error> { + self.read_exact(bytecast::u64_as_ne_mut_bytes(buffer))?; match self.byte_order() { - ByteOrder::LittleEndian => ::read_i32::(self), - ByteOrder::BigEndian => ::read_i32::(self), + ByteOrder::LittleEndian => + for n in buffer { + *n = u64::from_le(*n); + }, + ByteOrder::BigEndian => + for n in buffer { + *n = u64::from_be(*n); + }, } + Ok(()) } /// Reads an f32 #[inline(always)] fn read_f32(&mut self) -> Result { - match self.byte_order() { - ByteOrder::LittleEndian => ::read_f32::(self), - ByteOrder::BigEndian => ::read_f32::(self), - } + let mut n = [0u8; 4]; + self.read_exact(&mut n)?; + Ok(f32::from_bits(match self.byte_order() { + ByteOrder::LittleEndian => u32::from_le_bytes(n), + ByteOrder::BigEndian => u32::from_be_bytes(n), + })) } #[inline(always)] fn read_f32_into(&mut self, buffer: &mut [f32]) -> Result<(), io::Error> { + self.read_exact(bytecast::f32_as_ne_mut_bytes(buffer))?; match self.byte_order() { - ByteOrder::LittleEndian => { - ::read_f32_into::(self, buffer) - } - ByteOrder::BigEndian => { - ::read_f32_into::(self, buffer) - } + ByteOrder::LittleEndian => + for n in buffer { + *n = f32::from_bits(u32::from_le(n.to_bits())); + }, + ByteOrder::BigEndian => + for n in buffer { + *n = f32::from_bits(u32::from_be(n.to_bits())); + }, } + Ok(()) } /// Reads an f64 #[inline(always)] fn read_f64(&mut self) -> Result { - match self.byte_order() { - ByteOrder::LittleEndian => ::read_f64::(self), - ByteOrder::BigEndian => ::read_f64::(self), - } + let mut n = [0u8; 8]; + self.read_exact(&mut n)?; + Ok(f64::from_bits(match self.byte_order() { + ByteOrder::LittleEndian => u64::from_le_bytes(n), + ByteOrder::BigEndian => u64::from_be_bytes(n), + })) } #[inline(always)] fn read_f64_into(&mut self, buffer: &mut [f64]) -> Result<(), io::Error> { + self.read_exact(bytecast::f64_as_ne_mut_bytes(buffer))?; match self.byte_order() { - ByteOrder::LittleEndian => { - ::read_f64_into::(self, buffer) - } - ByteOrder::BigEndian => { - ::read_f64_into::(self, buffer) - } + ByteOrder::LittleEndian => + for n in buffer { + *n = f64::from_bits(u64::from_le(n.to_bits())); + }, + ByteOrder::BigEndian => + for n in buffer { + *n = f64::from_bits(u64::from_be(n.to_bits())); + }, } + Ok(()) } } diff --git a/src/encoder/mod.rs b/src/encoder/mod.rs index c99be5e..63c52b5 100644 --- a/src/encoder/mod.rs +++ b/src/encoder/mod.rs @@ -1,9 +1,9 @@ -use byteorder::NativeEndian; use std::collections::BTreeMap; use std::convert::TryFrom; use std::io::{Seek, Write}; use std::mem; +use bytecast; use tags::{self, ResolutionUnit, Tag, Type}; use error::{TiffError, TiffFormatError, TiffResult}; @@ -60,9 +60,7 @@ impl TiffValue for [i8] { } fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { - // We write using nativeedian so this should be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len()) }; + let slice = bytecast::i8_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -77,9 +75,7 @@ impl TiffValue for [u16] { } fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { - // We write using nativeedian so this sould be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * 2) }; + let slice = bytecast::u16_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -94,9 +90,7 @@ impl TiffValue for [i16] { } fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { - // We write using nativeedian so this should be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * Self::BYTE_LEN as usize) }; + let slice = bytecast::i16_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -111,9 +105,7 @@ impl TiffValue for [u32] { } fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { - // We write using nativeedian so this sould be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * 4) }; + let slice = bytecast::u32_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -128,9 +120,7 @@ impl TiffValue for [i32] { } fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { - // We write using nativeedian so this should be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * Self::BYTE_LEN as usize) }; + let slice = bytecast::i32_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -145,9 +135,7 @@ impl TiffValue for [u64] { } fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { - // We write using nativeedian so this sould be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * 8) }; + let slice = bytecast::u64_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -163,8 +151,7 @@ impl TiffValue for [f32] { fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { // We write using nativeedian so this sould be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * 4) }; + let slice = bytecast::f32_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -180,8 +167,7 @@ impl TiffValue for [f64] { fn write(&self, writer: &mut TiffWriter) -> TiffResult<()> { // We write using nativeedian so this sould be safe - let slice = - unsafe { ::std::slice::from_raw_parts(self.as_ptr() as *const u8, self.len() * 8) }; + let slice = bytecast::f64_as_ne_bytes(self); writer.write_bytes(slice)?; Ok(()) } @@ -437,7 +423,7 @@ impl TiffEncoder { writer: TiffWriter::new(writer), }; - NativeEndian::write_header(&mut encoder.writer)?; + write_tiff_header(&mut encoder.writer)?; // blank the IFD offset location encoder.writer.write_u32(0)?; @@ -598,7 +584,7 @@ impl<'a, W: Write + Seek> Drop for DirectoryEncoder<'a, W> { /// let mut tiff = TiffEncoder::new(&mut file).unwrap(); /// let mut image = tiff.new_image::(100, 100).unwrap(); /// -/// // You can encode tags here +/// // You can encode tags here /// image.encoder().write_tag(Tag::Artist, "Image-tiff").unwrap(); /// /// let mut idx = 0; diff --git a/src/encoder/writer.rs b/src/encoder/writer.rs index 8d3929d..33df28c 100644 --- a/src/encoder/writer.rs +++ b/src/encoder/writer.rs @@ -1,29 +1,17 @@ use error::TiffResult; -use byteorder::{BigEndian, ByteOrder, LittleEndian, NativeEndian, WriteBytesExt}; use std::io::{self, Seek, SeekFrom, Write}; -pub trait TiffByteOrder: ByteOrder { - fn write_header(writer: &mut TiffWriter) -> TiffResult<()>; -} +pub fn write_tiff_header(writer: &mut TiffWriter) -> TiffResult<()> { + #[cfg(target_endian = "little")] + let boi: u8 = 0x49; + #[cfg(not(target_endian = "little"))] + let boi: u8 = 0x4d; -impl TiffByteOrder for LittleEndian { - fn write_header(writer: &mut TiffWriter) -> TiffResult<()> { - writer.writer.write_u16::(0x4949)?; - writer.writer.write_u16::(42)?; - writer.offset += 4; + writer.writer.write_all(&[boi, boi])?; + writer.writer.write_all(&42u16.to_ne_bytes())?; + writer.offset += 4; - Ok(()) - } -} - -impl TiffByteOrder for BigEndian { - fn write_header(writer: &mut TiffWriter) -> TiffResult<()> { - writer.writer.write_u16::(0x4d4d)?; - writer.writer.write_u16::(42)?; - writer.offset += 4; - - Ok(()) - } + Ok(()) } pub struct TiffWriter { @@ -47,61 +35,61 @@ impl TiffWriter { } pub fn write_u8(&mut self, n: u8) -> Result<(), io::Error> { - self.writer.write_u8(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 1; Ok(()) } pub fn write_i8(&mut self, n: i8) -> Result<(), io::Error> { - self.writer.write_i8(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 1; Ok(()) } pub fn write_u16(&mut self, n: u16) -> Result<(), io::Error> { - self.writer.write_u16::(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 2; Ok(()) } pub fn write_i16(&mut self, n: i16) -> Result<(), io::Error> { - self.writer.write_i16::(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 2; Ok(()) } pub fn write_u32(&mut self, n: u32) -> Result<(), io::Error> { - self.writer.write_u32::(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 4; Ok(()) } pub fn write_i32(&mut self, n: i32) -> Result<(), io::Error> { - self.writer.write_i32::(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 4; Ok(()) } pub fn write_u64(&mut self, n: u64) -> Result<(), io::Error> { - self.writer.write_u64::(n)?; + self.writer.write_all(&n.to_ne_bytes())?; self.offset += 8; Ok(()) } pub fn write_f32(&mut self, n: f32) -> Result<(), io::Error> { - self.writer.write_f32::(n)?; + self.writer.write_all(&u32::to_ne_bytes(n.to_bits()))?; self.offset += 4; Ok(()) } pub fn write_f64(&mut self, n: f64) -> Result<(), io::Error> { - self.writer.write_f64::(n)?; + self.writer.write_all(&u64::to_ne_bytes(n.to_bits()))?; self.offset += 8; Ok(()) diff --git a/src/lib.rs b/src/lib.rs index 9906732..7bb874b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -6,10 +6,10 @@ //! # Related Links //! * - The TIFF specification -extern crate byteorder; extern crate lzw; extern crate miniz_oxide; +mod bytecast; pub mod decoder; pub mod encoder; mod error; diff --git a/tests/decode_bigtiff_images.rs b/tests/decode_bigtiff_images.rs new file mode 100644 index 0000000..9113f42 --- /dev/null +++ b/tests/decode_bigtiff_images.rs @@ -0,0 +1,46 @@ +extern crate tiff; + +use tiff::decoder::Decoder; +use tiff::tags::Tag; +use tiff::ColorType; + +use std::fs::File; +use std::path::PathBuf; + +const TEST_IMAGE_DIR: &str = "./tests/images/bigtiff"; + +#[test] +fn test_big_tiff() { + let filenames = ["BigTIFF.tif", "BigTIFFMotorola.tif", "BigTIFFLong.tif"]; + for filename in filenames.iter() { + let path = PathBuf::from(TEST_IMAGE_DIR).join(filename); + let img_file = File::open(path).expect("Cannot find test image!"); + let mut decoder = Decoder::new(img_file).expect("Cannot create decoder"); + assert_eq!( + decoder.dimensions().expect("Cannot get dimensions"), + (64, 64) + ); + assert_eq!( + decoder.colortype().expect("Cannot get colortype"), + ColorType::RGB(8) + ); + assert_eq!( + decoder + .get_tag_u64(Tag::StripOffsets) + .expect("Cannot get StripOffsets"), + 16 + ); + assert_eq!( + decoder + .get_tag_u64(Tag::RowsPerStrip) + .expect("Cannot get RowsPerStrip"), + 64 + ); + assert_eq!( + decoder + .get_tag_u64(Tag::StripByteCounts) + .expect("Cannot get StripByteCounts"), + 12288 + ) + } +} diff --git a/tests/images/bigtiff/BigTIFF.tif b/tests/images/bigtiff/BigTIFF.tif new file mode 100644 index 0000000..8a0e5a2 Binary files /dev/null and b/tests/images/bigtiff/BigTIFF.tif differ diff --git a/tests/images/bigtiff/BigTIFFLong.tif b/tests/images/bigtiff/BigTIFFLong.tif new file mode 100644 index 0000000..1a321ef Binary files /dev/null and b/tests/images/bigtiff/BigTIFFLong.tif differ diff --git a/tests/images/bigtiff/BigTIFFMotorola.tif b/tests/images/bigtiff/BigTIFFMotorola.tif new file mode 100644 index 0000000..4699ecd Binary files /dev/null and b/tests/images/bigtiff/BigTIFFMotorola.tif differ