Add clarifying comment on isAvifHeader

facebook · Apr 15, 2024 · d6ad34f · d6ad34f
1 parent dce820b
commit d6ad34f
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/imagepipeline-base/src/main/java/com/facebook/imageformat/DefaultImageFormatChecker.kt b/imagepipeline-base/src/main/java/com/facebook/imageformat/DefaultImageFormatChecker.kt
@@ -271,8 +271,13 @@ class DefaultImageFormatChecker : FormatChecker {
             (ImageFormatCheckerUtils.startsWithPattern(imageHeaderBytes, DNG_HEADER_II) ||
                 ImageFormatCheckerUtils.startsWithPattern(imageHeaderBytes, DNG_HEADER_MM))
 
+    /**
+     * Checks if [imageHeaderBytes] contains 'avif'.
+     *
+     * This check may not be sufficient, though it works for most AVIF images.
+     * Details on AVIF can be found [here](https://aomediacodec.github.io/av1-avif/).
+     * */
     private fun isAvifHeader(imageHeaderBytes: ByteArray): Boolean {
-      // This check may not enough
       return imageHeaderBytes
               .toString(Charset.forName("UTF-8"))
               .contains("avif")