third_party/jpeg-xl/CHANGELOG.md

   1 # Changelog
   2
   3 All notable changes to this project will be documented in this file.
   4
   5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
   6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   7
   8 ## Unreleased
   9
  10 ### Added
  11  - encoder API: add `JxlEncoderSetExtraChannelDistance` to adjust the quality
  12    of extra channels (like alpha) separately.
  13  - encoder API: new api functions for streaming encoding:
  14   - `JxlEncoderSetOutputProcessor`
  15   - `JxlEncoderFlushInput`
  16   - `JxlEncoderOutputProcessor` struct
  17   - `JxlEncoderSetOutputCallback`
  18   - `JxlChunkedFrameInputSource` struct
  19   - `JxlEncoderAddChunkedFrame`
  20  - encoder API: new options for more fine-grained control over metadata
  21    preservation when using `JxlEncoderAddJPEGFrame`:
  22   - `JXL_ENC_FRAME_SETTING_JPEG_KEEP_EXIF`
  23   - `JXL_ENC_FRAME_SETTING_JPEG_KEEP_XMP`
  24   - `JXL_ENC_FRAME_SETTING_JPEG_KEEP_JUMBF`
  25  - encoder API: new function `JxlEncoderSetUpsamplingMode` to change the upsampling
  26    method, e.g. to use nearest-neighbor upsampling for pixel art
  27  - cjxl can now be used to explicitly add/update/strip Exif/XMP/JUMBF metadata using
  28    the decoder-hints syntax, e.g. `cjxl input.ppm -x exif=input.exif output.jxl`
  29  - djxl can now be used to extract Exif/XMP/JUMBF metadata
  30
  31 ### Removed
  32  - API: the Butteraugli API (`jxl/butteraugli.h`) was removed.
  33  - encoder and decoder API: all deprecated functions were removed:
  34    `JxlDecoderDefaultPixelFormat`, `JxlEncoderOptionsSetLossless`,
  35    `JxlEncoderOptionsSetEffort`, `JxlEncoderOptionsSetDecodingSpeed`,
  36    `JxlEncoderOptionsSetDistance`, `JxlEncoderOptionsCreate`, as well as
  37    the deprecated enumerator values `JXL_DEC_EXTENSIONS`, `JXL_ENC_NOT_SUPPORTED`,
  38    `JXL_TYPE_BOOLEAN`, `JXL_TYPE_UINT32`, and deprecated type `JxlEncoderOptions`.
  39  - decoder API: the signature of `JxlDecoderGetColorAsEncodedProfile`,
  40    `JxlDecoderGetICCProfileSize`, and `JxlDecoderGetColorAsICCProfile`
  41    changed: a deprecated unused argument was removed.
  42
  43 ### Changed
  44  - changed the name of the cjxl flag `photon_noise` to `photon_noise_iso`
  45
  46 ## [0.8.0] - 2023-01-18
  47
  48 ### Added
  49  - decoder API: new function `JxlDecoderSetImageBitDepth` to set the bit depth
  50    of the output buffer.
  51  - decoder API proposal: add `JxlDecoderSetOutputColorProfile` and
  52    `JxlDecoderSetCms` to enable decoding to desired colorspace; NB: not
  53    implemented yet.
  54  - encoder API: new function `JxlEncoderSetFrameBitDepth` to set the bit depth
  55    of the input buffer.
  56  - encoder API: add an effort 10 option for lossless compression; using this
  57    setting requires calling `JxlEncoderAllowExpertOptions`.
  58  - encoder API: new `JXL_ENC_FRAME_SETTING_JPEG_COMPRESS_BOXES` enum value to
  59    allow explicit control of metadata compression
  60
  61 ### Removed
  62  - common API: removed `JxlIntrinsicSizeHeader`
  63  - decoder API: removed deprecated `JXL_DEC_NEED_DC_OUT_BUFFER` and
  64    `JXL_DEC_DC_IMAGE` events, `JxlDecoderDCOutBufferSize` and
  65    `JxlDecoderSetDCOutBuffer` functions
  66
  67 ### Changed / clarified
  68  - encoder API: `JxlEncoderProcessOutput` requires at least 32 bytes of output
  69    space to proceed and guarantees that at least one byte will be written
  70
  71 ## [0.7] - 2022-07-21
  72
  73 ### Added
  74  - Export version information in headers.
  75  - decoder API: Ability to decode the content of metadata boxes:
  76    `JXL_DEC_BOX`, `JXL_DEC_BOX_NEED_MORE_OUTPUT`, `JxlDecoderSetBoxBuffer`,
  77    `JxlDecoderGetBoxType`, `JxlDecoderGetBoxSizeRaw` and
  78    `JxlDecoderSetDecompressBoxes`.
  79  - decoder API: ability to mark the input is finished: `JxlDecoderCloseInput`.
  80  - decoder API: ability to request updates on different progressive events using
  81    `JxlDecoderSetProgressiveDetail`; currently supported events are
  82    `kDC`, `kLastPasses` and `kPasses`.
  83  - decoder API: ability to specify desired intensity target using
  84    `JxlDecoderSetDesiredIntensityTarget`
  85  - decoder API: new function `JxlDecoderSetCoalesced` to allow decoding
  86    non-coalesced (unblended) frames, e.g. layers of a composite still image
  87    or the cropped frames of a recompressed GIF/APNG.
  88  - decoder API: new function `JxlDecoderSetUnpremultiplyAlpha` to set
  89    preference for getting an associated alpha channel with premultiplied or
  90    unpremultiplied colors.
  91  - decoder API: field added to `JxlFrameHeader`: a `JxlLayerInfo` struct
  92    that contains crop dimensions and offsets and blending information for
  93    the non-coalesced case.
  94  - decoder API: new function `JxlDecoderGetExtraChannelBlendInfo` to get
  95    the blending information for extra channels in the non-coalesced case.
  96  - decoder API: new function `JxlDecoderSetMultithreadedImageOutCallback`,
  97    allowing output callbacks to receive more information about the number of
  98    threads on which they are running.
  99  - decoder API: new function `JxlDecoderSkipCurrentFrame` to skip processing
 100    the current frame after a progressive detail is reached.
 101  - decoder API: new function `JxlDecoderGetIntendedDownsamplingRatio` to get
 102    the intended downsampling ratio of progressive steps, based on the
 103    information in the frame header.
 104  - decoder API: new function `JxlDecoderSetRenderSpotcolors` to allow disabling
 105    rendering of spot colors.
 106  - decoder/encoder API: add two fields to `JXLBasicInfo`: `intrinsic_xsize`
 107    and `intrinsic_ysize` to signal the intrinsic size.
 108  - encoder API: ability to add metadata boxes, added new functions
 109    `JxlEncoderAddBox`, `JxlEncoderUseBoxes`, `JxlEncoderCloseBoxes` and
 110    `JxlEncoderCloseFrames`.
 111  - encoder API: added ability to set several encoder options / extra fields to
 112    frames using `JxlEncoderSetFrameName`, `JxlEncoderFrameSettingsSetOption`,
 113    `JxlEncoderFrameSettingsSetFloatOption`.
 114  - encoder API: added ability to check required codestream compatibility level
 115    and force specified using `JxlEncoderGetRequiredCodestreamLevel` and
 116    `JxlEncoderSetCodestreamLevel`.
 117  - encoder API: added ability to force emitting box-based container format
 118    using `JxlEncoderUseContainer`.
 119  - encoder API: added ability to store JPEG metadata for lossless reconstruction
 120    using `JxlEncoderStoreJPEGMetadata`
 121  - encoder API: new functions `JxlEncoderSetFrameHeader` and
 122    `JxlEncoderSetExtraChannelBlendInfo` to set animation
 123    and blending parameters of the frame, and `JxlEncoderInitFrameHeader` and
 124    `JxlEncoderInitBlendInfo` to initialize the structs to set.
 125  - encoder API: ability to encode arbitrary extra channels:
 126   `JxlEncoderInitExtraChannelInfo`, `JxlEncoderSetExtraChannelInfo`,
 127   `JxlEncoderSetExtraChannelName` and `JxlEncoderSetExtraChannelBuffer`.
 128  - encoder API: ability to plug custom CMS implementation using
 129    `JxlEncoderSetCms(JxlEncoder* enc, JxlCmsInterface cms)`
 130  - encoder API: added `JxlEncoderGetError` to retrieve last encoder error.
 131
 132 ### Changed
 133 - decoder API: using `JxlDecoderCloseInput` at the end of all input is required
 134   when using JXL_DEC_BOX, and is now also encouraged in other cases, but not
 135   required in those other cases for backwards compatibility.
 136 - encoder API: `JxlEncoderCloseInput` now closes both frames and boxes input.
 137 - CLI: `cjxl` and `djxl` have been reimplemented on the base of public decoder
 138   and encoder API; dropped dependency on `gflags` for argument parsing.
 139
 140 ### Deprecated
 141 - decoder API: `JXL_DEC_EXTENSIONS` event: use `JXL_DEC_BASIC_INFO`
 142 - decoder / encoder API: pixel types `JXL_TYPE_BOOLEAN` and `JXL_TYPE_UINT32`:
 143   consider using `JXL_TYPE_UINT8` and `JXL_TYPE_FLOAT` correspondingly.
 144 - decoder API: pixel format parameter for `JxlDecoderGetColorAsEncodedProfile`
 145   and `JxlDecoderGetICCProfileSize`: pass `NULL`.
 146 - decoder API: `JxlDecoderDefaultPixelFormat`
 147 - encoder API: `JxlEncoderOptions`: use `JxlEncoderFrameSettings` instead.
 148 - encoder API: `JxlEncoderOptionsCreate`: use `JxlEncoderFrameSettingsCreate`
 149   instead.
 150 - encoder API: `JxlEncoderOptionsSetDistance`: use `JxlEncoderSetFrameDistance`
 151   instead.
 152 - encoder API: `JxlEncoderOptionsSetLossless`: use `JxlEncoderSetFrameLossless`
 153   instead.
 154 - encoder API: `JxlEncoderOptionsSetEffort`: use
 155   `JxlEncoderFrameSettingsSetOption(frame_settings, JXL_ENC_FRAME_SETTING_EFFORT, effort)`
 156   instead.
 157 - encoder API: `JxlEncoderOptionsSetDecodingSpeed`: use
 158   `JxlEncoderFrameSettingsSetOption(frame_settings, JXL_ENC_FRAME_SETTING_DECODING_SPEED, tier)`
 159   instead.
 160 - encoder API: deprecated `JXL_ENC_NOT_SUPPORTED`, the encoder returns
 161   `JXL_ENC_ERROR` instead and there is no need to handle
 162   `JXL_ENC_NOT_SUPPORTED`.
 163
 164 ## [0.6.1] - 2021-10-29
 165 ### Changed
 166  - Security: Fix OOB read in splines rendering (#735 -
 167    [CVE-2021-22563](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-22563))
 168  - Security: Fix OOB copy (read/write) in out-of-order/multi-threaded decoding
 169    (#708 - [CVE-2021-22564](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-22564))
 170  - Fix segfault in `djxl` tool with `--allow_partial_files` flag (#781).
 171  - Fix border in extra channels when using upsampling (#796)
 172
 173 ## [0.6] - 2021-10-04
 174 ### Added
 175  - API: New functions to decode extra channels:
 176    `JxlDecoderExtraChannelBufferSize` and `JxlDecoderSetExtraChannelBuffer`.
 177  - API: New function `JxlEncoderInitBasicInfo` to initialize `JxlBasicInfo`
 178    (only needed when encoding). NOTE: it is now required to call this function
 179    when using the encoder. Padding was added to the struct for forward
 180    compatibility.
 181  - API: Support for encoding oriented images.
 182  - API: FLOAT16 support in the encoder API.
 183  - Rewrite of the GDK pixbuf loader plugin. Added proper color management and
 184    animation support.
 185  - Rewrite of GIMP plugin. Added compression parameters dialog and switched to
 186    using the public C API.
 187  - Debian packages for GDK pixbuf loader (`libjxl-gdk-pixbuf`) and GIMP
 188    (`libjxl-gimp-plugin`) plugins.
 189  - `cjxl`/`djxl` support for `stdin` and `stdout`.
 190
 191 ### Changed
 192  - API: Renamed the field `alpha_associated` in `JxlExtraChannelInfo` to
 193    `alpha_premultiplied`, to match the corresponding name in `JxlBasicInfo`.
 194  - Improved the 2x2 downscaling method in the encoder for the optional color
 195    channel resampling for low bit rates.
 196  - Fixed: the combination of floating point original data, XYB color encoding,
 197    and Modular mode was broken (in both encoder and decoder). It now works.
 198    NOTE: this can cause the current encoder to write jxl bitstreams that do
 199    not decode with the old decoder. In particular this will happen when using
 200    cjxl with PFM, EXR, or floating point PSD input, and a combination of XYB
 201    and modular mode is used (which caused an encoder error before), e.g.
 202    using options like `-m -q 80` (lossy modular), `-d 4.5` or `--progressive_dc=1`
 203    (modular DC frame), or default lossy encoding on an image where patches
 204    end up being used. There is no problem when using cjxl with PNG, JPEG, GIF,
 205    APNG, PPM, PGM, PGX, or integer (8-bit or 16-bit) PSD input.
 206  - `libjxl` static library now bundles skcms, fixing static linking in
 207    downstream projects when skcms is used.
 208  - Spline rendering performance improvements.
 209  - Butteraugli changes for less visual masking.
 210
 211 ## [0.5] - 2021-08-02
 212 ### Added
 213  - API: New function to decode the image using a callback outputting a part of a
 214    row per call.
 215  - API: 16-bit float output support.
 216  - API: `JxlDecoderRewind` and `JxlDecoderSkipFrames` functions to skip more
 217    efficiently to earlier animation frames.
 218  - API: `JxlDecoderSetPreferredColorProfile` function to choose color profile in
 219    certain circumstances.
 220  - encoder: Adding `center_x` and `center_y` flags for more control of the tile
 221    order.
 222  - New encoder speeds `lightning` (1) and `thunder` (2).
 223
 224 ### Changed
 225  - Re-licensed the project under a BSD 3-Clause license. See the
 226    [LICENSE](LICENSE) and [PATENTS](PATENTS) files for details.
 227  - Full JPEG XL part 1 specification support: Implemented all the spec required
 228    to decode files to pixels, including cases that are not used by the encoder
 229    yet. Part 2 of the spec (container format) is final but not fully implemented
 230    here.
 231  - Butteraugli metric improvements. Exact numbers are different from previous
 232    versions.
 233  - Memory reductions during decoding.
 234  - Reduce the size of the jxl_dec library by removing dependencies.
 235  - A few encoding speedups.
 236  - Clarify the security policy.
 237  - Significant encoding improvements (~5 %) and less ringing.
 238  - Butteraugli metric to have some less masking.
 239  - `cjxl` flag `--speed` is deprecated and replaced by the `--effort` synonym.
 240
 241 ### Removed
 242 - API for returning a downsampled DC was deprecated
 243   (`JxlDecoderDCOutBufferSize` and `JxlDecoderSetDCOutBuffer`) and will be
 244   removed in the next release.
 245
 246 ## [0.3.7] - 2021-03-29
 247 ### Changed
 248  - Fix a rounding issue in 8-bit decoding.
 249
 250 ## [0.3.6] - 2021-03-25
 251 ### Changed
 252  - Fix a bug that could result in the generation of invalid codestreams as
 253    well as failure to decode valid streams.
 254
 255 ## [0.3.5] - 2021-03-23
 256 ### Added
 257  - New encode-time options for faster decoding at the cost of quality.
 258  - Man pages for cjxl and djxl.
 259
 260 ### Changed
 261  - Memory usage improvements.
 262  - Faster decoding to 8-bit output with the C API.
 263  - GIMP plugin: avoid the sRGB conversion dialog for sRGB images, do not show
 264    a console window on Windows.
 265  - Various bug fixes.
 266
 267 ## [0.3.4] - 2021-03-16
 268 ### Changed
 269  - Improved box parsing.
 270  - Improved metadata handling.
 271  - Performance and memory usage improvements.
 272
 273 ## [0.3.3] - 2021-03-05
 274 ### Changed
 275  - Performance improvements for small images.
 276  - Add a (flag-protected) non-high-precision mode with better speed.
 277  - Significantly speed up the PQ EOTF.
 278  - Allow optional HDR tone mapping in djxl (--tone_map, --display_nits).
 279  - Change the behavior of djxl -j to make it consistent with cjxl (#153).
 280  - Improve image quality.
 281  - Improve EXIF handling.
 282
 283 ## [0.3.2] - 2021-02-12
 284 ### Changed
 285  - Fix embedded ICC encoding regression
 286    [#149](https://gitlab.com/wg1/jpeg-xl/-/issues/149).
 287
 288 ## [0.3.1] - 2021-02-10
 289 ### Changed
 290  - New experimental Butteraugli API (`jxl/butteraugli.h`).
 291  - Encoder improvements to low quality settings.
 292  - Bug fixes, including fuzzer-found potential security bug fixes.
 293  - Fixed `-q 100` and `-d 0` not triggering lossless modes.
 294
 295 ## [0.3] - 2021-01-29
 296 ### Changed
 297  - Minor change to the Decoder C API to accommodate future work for other ways
 298    to provide input.
 299  - Future decoder C API changes will be backwards compatible.
 300  - Lots of bug fixes since the previous version.
 301
 302 ## [0.2] - 2020-12-24
 303 ### Added
 304  - JPEG XL bitstream format is frozen. Files encoded with 0.2 will be supported
 305    by future versions.
 306
 307 ### Changed
 308  - Files encoded with previous versions are not supported.
 309
 310 ## [0.1.1] - 2020-12-01
 311
 312 ## [0.1] - 2020-11-14
 313 ### Added
 314  - Initial release of an encoder (`cjxl`) and decoder (`djxl`) that work
 315    together as well as a benchmark tool for comparison with other codecs
 316    (`benchmark_xl`).
 317  - Note: JPEG XL format is in the final stages of standardization, minor changes
 318    to the codestream format are still possible but we are not expecting any
 319    changes beyond what is required by bug fixing.
 320  - API: new decoder API in C, check the `examples/` directory for its example
 321    usage. The C API is a work in progress and likely to change both in API and
 322    ABI in future releases.