Debian Codegraph @

.cargo/vendor/tiff/CHANGES.md

raw
1 # Version 0.10.3
2
3 New features:
4 - Group 4 `fax` is now recognized as a compression type and decoded.
5 - A crate feature `fax` controls related dependencies, on by default.
6
7 Changes:
8 - The presence of PhotometricInterpretation::WhiteIsZero now returns an error
9 if the color type can not be inverted by the library where they were
10 previously silently ignored. Please report any missing color types.
11
12 Fixes:
13 - The PhotometricInterpretation::WhiteIsZero is now also applied to 1-bit
14 images, as well as 2-bit and 4-bit sample types where previously the presence
15 of this tag was ignored.
16
17 # Version 0.10.2
18
19 Republished 0.10.1, fixing an accidentally removed method (`Decoder::find_tag_unsigned_vec`).
20
21 # Version 0.10.1
22
23 New features:
24 - Added a dedicated `Directory` type (#277)
25 - Expose methods related to `Directory` publicly (#278)
26 - Implement writing directories (#281, #283)
27 - Add ICC (color profile) to the set of known tags (#287)
28 - Added `Decoder.inner()` to access the underlying reader (#289)
29 - Added methods for reading into a pre-allocated byte buffer (#285)
30
31 Changes:
32 - No longer perform color conversion when decoding embedded JPEG. This fixes decoding for JPEG images with alpha channel. (#274)
33 - More lenient LZW decoding to match libtiff (#231)
34
35 Fixes:
36 - Fixed seeking multiple times in a row (#279)
37
38 # Version 0.10.0
39
40 New features:
41 - Added `ColorType::Multiband` and `ColorType::CMYKA`.
42 - Added `Value::Byte` and `Value::SignedByte` to represent `u8` and `i8` tags.
43 - Encoding can now use horizontal predictor.
44 - The `Decoder::tag_iter` method allows iterating over all tags in the image.
45 - Half precision floating point values are now supported during decoding.
46 - ZStandard compression has been added as an additional compression method
47 during decoding, but requires the `zstd` feature flag.
48
49 Changes:
50 - Switched `u16` and `i16` values to be intepreted as `Value::Short` and
51 `Value::SignedShort` respectively.
52 - Changed JPEG compression to use the `zune-jpeg` crate instead of
53 `jpeg-decoder`.
54 - The `deflate`, `jpeg`, and `lzw` compression methods are now controlled by
55 (enabled by default) feature flags.
56
57 Fixes:
58 - Fixed a bug in 1 bit-per-pixel decoding.
59
60 # Version 0.9.1
61
62 New features:
63 - Basic support for planar configuration.
64 - Allow arbitrary number of samples as long as all have the same bit depth.
65
66 Fixes:
67 - Don't panic when parsing metadata when custom compression is used.
68
69 # Version 0.9.0
70
71 New features:
72 * Added support for photometric interpretation `YCbCr` and added related
73 `ColorType`.
74
75 Fixes:
76 * Decoding tiled images calculates padding correctly when image width or height
77 is a multiple of tile size. It could previously corrupt the last tile per row
78 by skipping over data.
79
80 # Version 0.8.1
81
82 Changes:
83 * The jpeg decoder gained to ability to utilize the Photometric Interpretation
84 directly instead of relying on a custom APP segment.
85
86 Fixes:
87 * A spurious error within the PackBits decoder lead to the incorrect results
88 (wrong bits or errors), based on the maximum size of reads from the
89 underlying reader.
90 * Removed a panic path in jpeg decoding, when a feature such as photometric
91 interpretation is not supported. An error is returned instead.
92
93 # Version 0.8.0
94
95 Changes:
96 * The minimum supported rust version is now indicated in `Cargo.toml`.
97 * The enums `TiffFormatError` and `TiffUnsupportedError` are now
98 marked with the `#[non_exhaustive]` attribute.
99 * Additionally, tag related enums `Value`, `Tags`, `Type`, `CompressionMethod`,
100 `PhotometricInterpretation`, `PlanarConfiguration`, `Predictor`,
101 `ResolutionUnit`, `SampleFormat` are also changed.
102
103 Removals:
104 * Removed deprecated methods of `Decoder`: `init`, `read_jpeg`,
105 `read_strip_to_buffer`, `read_strip`, `read_tile`. The implicit chunk (row or
106 tile) index order could not be easily tracked by the caller. New separate
107 utility interfaces may be introduced at a later point, for now callers are
108 obligated to choose their own.
109
110 Fixes:
111 * Update to `jpeg_decoder = 0.3`.
112
113 # Version 0.7.4
114
115 New features:
116 * Creating an encoder for invalid, zero-sized images is now rejected.
117
118 Fixes:
119 * Fix panic, in a case where decoding jpeg encoded images did not expect the
120 jpeg decoder to return an error.
121 * Fix panic by validating `rows_per_strip` better, fixing a division-by-zero.
122
123 # Version 0.7.3
124
125 New features:
126 * Allow decoder to access specific tiles by index.
127 * Add support for floating point predictor.
128 * Tiled jpeg file support.
129
130 Changes:
131 * Various refactoring and performance improvements.
132
133 # Version 0.7.2
134
135 New features:
136 * Encoding with `ImageEncoder` now takes an optional compressor argument,
137 allowing compressed encoding. See the methods
138 `TiffEncoder::{new_image,write_image}_with_compression`.
139 * `jpeg_decoder` has been upgraded, now supports lossless JPEG.
140
141 Changes:
142 * Decoding now more consistently reads and interprets the initial IFD, instead
143 of performing _some_ interpretation lazily. (This change prepares fully lazy
144 and backwards seeking.)
145
146 # Version 0.7.1
147
148 New features:
149 * Encoding signed integer formats is now supported.
150 * Extensive fuzzing with `cargo fuzz`.
151
152 Changes:
153 * Tile decoding should be a little faster, requires one less intermediate buffer.
154 * Images whose IFDs form a cycle due to their offsets will now raise an error
155 when the cycle would be entered (jumping back should still be supported).
156
157 Fixes:
158 * Fixed a regression that caused conflict between strips and tile images,
159 causing errors in decoding some images.
160 * Use checked integer arithmetic in limit calculations, fixes overflows.
161 * IFD Tags are now always cleared between images.
162 * Found by fuzzing: Several memory limit overflows; JPEG now correctly
163 validates offsets and a minimum size of its table; Check upper limit of strip
164 byte size correctly;
165
166 Notes:
167 Our CI has warned that this version no longer builds on `1.34.2` out of the
168 box. We're still committed to the MSRV on this major version yet one
169 dependency—`flate2`—has already bumped it in a SemVer compatible version of its
170 own. This is out-of-our-control (cargo's dependency resolution does not allow
171 us to address this in a reasonable manner).
172
173 This can be address this by pinning the version of `flate2` to `1.0.21` in your
174 own files. However, you should understand that this puts you in considerable
175 maintenance debt as you will no longer receive any updates for this dependency
176 and any package that _requires_ a new version of the `1.0` series would be
177 incompatible with this requirement (cargo might yell at you very loudly).
178
179 # Version 0.7.0
180
181 New features:
182 * Support for encoding BigTiff ([#122](https://github.com/image-rs/image-tiff/pull/122))
183 * _Breaking:_ Encoder types now have a generic parameter to differentiate BigTiff and standard Tiff encoding. Defaults to standard Tiff.
184 * Basic tile decoding ([#125](https://github.com/image-rs/image-tiff/pull/125))
185 * _Breaking:_ There is a new `TiffError::UsageError` variant.
186 * Support for datatypes `Int8` and `Int16` ([#114](https://github.com/image-rs/image-tiff/pull/114))
187 * _Breaking:_ `DecodingResult` and `DecodingBuffer` have the two new variants `I8` and `I16`.
188 * Support for `i32` arrays ([#118](https://github.com/image-rs/image-tiff/pull/118/files))
189 * _Breaking:_ `DecodingResult` and `DecodingBuffer` have a new `I32` variant.
190 * Support for `Ifd` and `IfdBig` tag types and `I64` data type ([#119](https://github.com/image-rs/image-tiff/pull/119))
191 * _Breaking:_ `DecodingResult` and `DecodingBuffer` have a new `I64` variant.
192 * Add `SMinSampleValue` and `SMaxSampleValue` ([#123](https://github.com/image-rs/image-tiff/pull/123))
193
194 Changes:
195 * Improve deflate support ([#132](https://github.com/image-rs/image-tiff/pull/132))
196 * Switch to streaming decompression via `flate2`. Aside from performance improvements and lower RAM consumption, this fixes a bug where `max_uncompressed_length` was precalculated for a single tile but then used as a hard limit on the whole data, failing to decompress any tiled images.
197 * Add support for new `Deflate` tag in addition to `OldDeflate`.
198 * _Breaking:_ Remove `InflateError`, which is no longer needed with `flate2` ([#134](https://github.com/image-rs/image-tiff/pull/134))
199 * _Breaking:_ Support for `MinIsWhite` is restricted to unsigned and floating
200 point values. This is expected to be be re-added once some contradictory
201 interpretation regarding semantics for signed values is resolved.
202
203 Fixes:
204 * Validate that ASCII tags are valid ASCII and end with a null byte ([#121](https://github.com/image-rs/image-tiff/pull/121))
205
206 Internal:
207 * Simplify decompression logic ([#126](https://github.com/image-rs/image-tiff/pull/126))
208 * Simplify `expand_strip` ([#128](https://github.com/image-rs/image-tiff/pull/128))
209
210 # Version 0.6.1
211
212 New features:
213 * Support for reading `u16` and ascii string tags.
214 * Added `Limits::unlimited` for disabling all limits.
215 * Added `ImageEncoder::rows_per_strip` to overwrite the default.
216
217 Changes:
218 * The default strip size for chunked encoding is now 1MB, up from 8KB. This
219 should lead to more efficient decoding and compression.
220
221 Fixes:
222 * Fixed a bug where LZW compressed strips could not be decoded, instead
223 returning an error `Inconsistent sizes encountered`.
224 * Reading a tag with a complex type and a single value returns the proper Value
225 variant, instead of a vector with one entry.
226
227 # Version 0.6.0
228
229 New features:
230 * Support for decoding BigTIFF with 64-bit offsets
231 * The value types byte, `f32`, `f64` are now recognized
232 * Support for Modern JPEG encoded images
233
234 Improvements:
235 * Better support for adding auxiliary tags before encoding image data
236 * Switched to lzw decoder library `weezl` for performance
237 * The `ColorType` trait now supports `SAMPLE_ENCODING` hints
238
239 Fixes:
240 * Fixed decoding of inline ASCII in tags
241 * Fixed handling after null terminator in ASCII data
242 * Recognize tile and sample format tags
243
244 # Version 0.5.0
245
246 * Added support for 32-bit and 64-bit decoded values.
247 * Added CMYK(16|32|64) color type support.
248 * Check many internal integer conversions to increase stability. This should
249 only lead to images being reported as faulty that would previously silently
250 break platform limits. If there are any false positives, please report them.
251 * Remove an erroneous check of decoded length in lzw compressed images.
252
253 # Version 0.4.0
254
255 * Several enumerations are now non_exhaustive for future extensions.
256 These are `Tag`, `Type`, `Value`, `PhotometricInterpretation`,
257 `CompressionMethod`, `Predictor`.
258 * Enums gained a dedicated method to convert to their TIFF variant value with
259 the specified type. Performing these conversions by casting the discriminant
260 with `as` is not guaranteed to be stable, except where documented explicitly.
261 * Removed the num-derive and num dependencies.
262 * Added support for decoding `deflate` compressed images.
263 * Make the decoder `Limits` customizable by exposing members.
264 * Fixed multi-page TIFF encoding writing incorrect offsets.