WebP read support (#63)

Support for reading WebP as requested in #48.
Ashampoo · Jan 21, 2024 · 16c03b8 · 16c03b8
1 parent dc361f3
commit 16c03b8
Show file tree

Hide file tree

Showing 41 changed files with 780 additions and 114 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ It's part of [Ashampoo Photos](https://ashampoo.com/photos).
 * JPG: Read & Write EXIF, IPTC & XMP
 * PNG: Read & Write `eXIf` chunk & XMP
     + Also read non-standard EXIF & IPTC from `tEXt`/`zTXt` chunk
+* WebP: Read EXIF & XMP
 * HEIC / AVIF: Read EXIF & XMP
 * JPEG XL: Read EXIF & XMP of uncompressed files
 * TIFF / DNG / RAW: Read EXIF & XMP
@@ -35,7 +36,7 @@ of Ashampoo Photos, which, in turn, is driven by user community feedback.
 ## Installation
 
 ```
-implementation("com.ashampoo:kim:0.10")
+implementation("com.ashampoo:kim:0.11")
 ```
 
 ## Sample usages

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/ImageParser.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/ImageParser.kt
@@ -21,6 +21,7 @@ import com.ashampoo.kim.format.jpeg.JpegImageParser
 import com.ashampoo.kim.format.png.PngImageParser
 import com.ashampoo.kim.format.raf.RafImageParser
 import com.ashampoo.kim.format.tiff.TiffImageParser
+import com.ashampoo.kim.format.webp.WebPImageParser
 import com.ashampoo.kim.input.ByteReader
 import com.ashampoo.kim.model.ImageFormat
 
@@ -38,6 +39,8 @@ fun interface ImageParser {
 
                 ImageFormat.PNG -> PngImageParser
 
+                ImageFormat.WEBP -> WebPImageParser
+
                 ImageFormat.TIFF,
                 ImageFormat.CR2,
                 ImageFormat.NEF,
@@ -47,8 +50,8 @@ fun interface ImageParser {
 
                 ImageFormat.RAF -> RafImageParser
 
-                ImageFormat.HEIC -> BaseMediaFileFormatImageParser
-                ImageFormat.AVIF -> BaseMediaFileFormatImageParser
+                ImageFormat.HEIC,
+                ImageFormat.AVIF,
                 ImageFormat.JXL -> BaseMediaFileFormatImageParser
 
                 else -> null

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/BaseMediaFileFormatImageParser.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/BaseMediaFileFormatImageParser.kt
@@ -55,7 +55,7 @@ object BaseMediaFileFormatImageParser : ImageParser {
         if (allBoxes.isEmpty())
             throw ImageReadException("Illegal ISOBMFF: Has no boxes.")
 
-        val fileTypeBox = allBoxes.find { it.type == BoxType.FTYP } as? FileTypeBox
+        val fileTypeBox = allBoxes.filterIsInstance<FileTypeBox>().firstOrNull()
 
         if (fileTypeBox == null)
             throw ImageReadException("Illegal ISOBMFF: Has no 'ftyp' Box.")
@@ -68,7 +68,7 @@ object BaseMediaFileFormatImageParser : ImageParser {
         if (fileTypeBox.majorBrand == FileTypeBox.JXL_BRAND)
             return JxlHandler.createMetadata(allBoxes)
 
-        val metaBox = allBoxes.find { it.type == BoxType.META } as? MetaBox
+        val metaBox = allBoxes.filterIsInstance<MetaBox>().firstOrNull()
 
         if (metaBox == null)
             throw ImageReadException("Illegal ISOBMFF: Has no 'meta' Box.")
@@ -128,7 +128,7 @@ object BaseMediaFileFormatImageParser : ImageParser {
             imageSize = null, // not covered by ISO BMFF
             exif = exif,
             exifBytes = exifBytes,
-            iptc = null, // not covered by ISO BMFF
+            iptc = null, // not supported by ISO BMFF
             xmp = xmp
         )
     }

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/BoxReader.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/BoxReader.kt
@@ -32,7 +32,7 @@ import com.ashampoo.kim.format.bmff.box.XmlBox
 import com.ashampoo.kim.input.PositionTrackingByteReader
 
 /**
- * Reads ISOBMFF Boxes
+ * Reads ISOBMFF boxes
  */
 object BoxReader {
 
@@ -110,7 +110,7 @@ object BoxReader {
                 BoxType.EXIF -> ExifBox(globalOffset, actualLength, bytes)
                 BoxType.XML -> XmlBox(globalOffset, actualLength, bytes)
                 BoxType.JXLP -> JxlParticalCodestreamBox(globalOffset, actualLength, bytes)
-                else -> Box(globalOffset, type, actualLength, bytes)
+                else -> Box(type, globalOffset, actualLength, bytes)
             }
 
             boxes.add(box)

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/JxlHandler.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/JxlHandler.kt
@@ -25,9 +25,8 @@ internal object JxlHandler {
 
     fun createMetadata(allBoxes: List<Box>): ImageMetadata {
 
-        val exifBox = allBoxes.find { it.type == BoxType.EXIF } as? ExifBox
-
-        val xmlBox = allBoxes.find { it.type == BoxType.XML } as? XmlBox
+        val exifBox = allBoxes.filterIsInstance<ExifBox>().firstOrNull()
+        val xmlBox = allBoxes.filterIsInstance<XmlBox>().firstOrNull()
 
         return ImageMetadata(
             imageFormat = ImageFormat.JXL, // could be any ISO BMFF

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/Box.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/Box.kt
@@ -19,13 +19,13 @@ package com.ashampoo.kim.format.bmff.box
 import com.ashampoo.kim.format.bmff.BoxType
 
 open class Box(
-    val offset: Long,
     val type: BoxType,
+    val offset: Long,
     val length: Long,
     /* Payload bytes, not including type & length bytes */
     val payload: ByteArray
 ) {
 
     override fun toString(): String =
-        "Box $type @ $offset ($length bytes)"
+        "Box '$type' @ $offset ($length bytes)"
 }
diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ExifBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ExifBox.kt
@@ -27,7 +27,7 @@ class ExifBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.EXIF, length, payload) {
+) : Box(BoxType.EXIF, offset, length, payload) {
 
     val version: Int
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/FileTypeBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/FileTypeBox.kt
@@ -29,7 +29,7 @@ class FileTypeBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.FTYP, length, payload) {
+) : Box(BoxType.FTYP, offset, length, payload) {
 
     val majorBrand: String
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/HandlerReferenceBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/HandlerReferenceBox.kt
@@ -27,7 +27,7 @@ class HandlerReferenceBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.HDLR, length, payload) {
+) : Box(BoxType.HDLR, offset, length, payload) {
 
     val version: Int
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ItemInfoEntryBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ItemInfoEntryBox.kt
@@ -29,7 +29,7 @@ class ItemInfoEntryBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.INFE, length, payload) {
+) : Box(BoxType.INFE, offset, length, payload) {
 
     val version: Int
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ItemInformationBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ItemInformationBox.kt
@@ -29,7 +29,7 @@ class ItemInformationBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.IINF, length, payload), BoxContainer {
+) : Box(BoxType.IINF, offset, length, payload), BoxContainer {
 
     val version: Int
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ItemLocationBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/ItemLocationBox.kt
@@ -28,7 +28,7 @@ class ItemLocationBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.ILOC, length, payload) {
+) : Box(BoxType.ILOC, offset, length, payload) {
 
     /**
      * The version of the box.

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/JxlParticalCodestreamBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/JxlParticalCodestreamBox.kt
@@ -24,7 +24,7 @@ class JxlParticalCodestreamBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.JXLP, length, payload) {
+) : Box(BoxType.JXLP, offset, length, payload) {
 
     val isHeader: Boolean
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/MediaDataBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/MediaDataBox.kt
@@ -28,7 +28,7 @@ class MediaDataBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.MDAT, length, payload) {
+) : Box(BoxType.MDAT, offset, length, payload) {
 
     override fun toString(): String =
         "$type Box"

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/MetaBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/MetaBox.kt
@@ -33,7 +33,7 @@ class MetaBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.META, length, payload), BoxContainer {
+) : Box(BoxType.META, offset, length, payload), BoxContainer {
 
     val version: Int
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/PrimaryItemBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/PrimaryItemBox.kt
@@ -28,7 +28,7 @@ class PrimaryItemBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.PITM, length, payload) {
+) : Box(BoxType.PITM, offset, length, payload) {
 
     val version: Int
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/XmlBox.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/bmff/box/XmlBox.kt
@@ -24,7 +24,7 @@ class XmlBox(
     offset: Long,
     length: Long,
     payload: ByteArray
-) : Box(offset, BoxType.XML, length, payload) {
+) : Box(BoxType.XML, offset, length, payload) {
 
     val xmp: String
 

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/png/PngChunkType.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/png/PngChunkType.kt
@@ -17,6 +17,7 @@
 package com.ashampoo.kim.format.png
 
 import com.ashampoo.kim.common.toFourCCTypeString
+import com.ashampoo.kim.format.png.PngConstants.TPYE_LENGTH
 
 /**
  * Type of a PNG chunk.
@@ -75,8 +76,8 @@ data class PngChunkType internal constructor(
         @Suppress("MagicNumber")
         fun of(typeBytes: ByteArray): PngChunkType {
 
-            require(typeBytes.size == PngConstants.TPYE_LENGTH) {
-                "ChunkType must be always 4 bytes!"
+            require(typeBytes.size == TPYE_LENGTH) {
+                "ChunkType must be always 4 bytes, but got ${typeBytes.size} bytes!"
             }
 
             @Suppress("UnnecessaryParentheses")

diff --git a/src/commonMain/kotlin/com/ashampoo/kim/format/png/PngConstants.kt b/src/commonMain/kotlin/com/ashampoo/kim/format/png/PngConstants.kt
@@ -22,11 +22,12 @@ object PngConstants {
 
     val PNG_BYTE_ORDER = ByteOrder.BIG_ENDIAN
 
-    /* ChunkType must be always 4 bytes */
+    /* ChunkType is a FourCC, so it's 4 bytes. */
     const val TPYE_LENGTH = 4
 
     const val COMPRESSION_DEFLATE_INFLATE = 0
 
+    @Suppress("MagicNumber")
     val PNG_SIGNATURE = byteArrayOf(
         0x89.toByte(),
         'P'.code.toByte(),