fix comments

nodeca · Mar 2, 2021 · 98c901a · 98c901a
1 parent 4251641
commit 98c901a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/lib/miaf_utils.js b/lib/miaf_utils.js
@@ -1,7 +1,8 @@
 // Utils used to parse miaf-based files (avif/heic/heif)
 //
-// We look for last `ispe` box (first box is presumably a thumbnail). Images with metadata encoded
-// after image data are not supported. Image sequences sometimes can't be recognized if they don't have `ispe` box.
+//  - image collections are not supported (only last size is reported)
+//  - images with metadata encoded after image data are not supported
+//  - images without any `ispe` box are not supported
 //
 // ISO media file spec:
 // https://web.archive.org/web/20180219054429/http://l.web.umkc.edu/lizhu/teaching/2016sp.video-communication/ref/mp4.pdf

diff --git a/lib/parse_stream/avif.js b/lib/parse_stream/avif.js
@@ -1,3 +1,9 @@
+// Utils used to parse miaf-based files (avif/heic/heif)
+//
+//  - image collections are not supported (only last size is reported)
+//  - images with metadata encoded after image data are not supported
+//  - images without any `ispe` box are not supported
+//
 
 'use strict';
 

diff --git a/lib/parse_sync/avif.js b/lib/parse_sync/avif.js
@@ -1,3 +1,9 @@
+// Utils used to parse miaf-based files (avif/heic/heif)
+//
+//  - image collections are not supported (only last size is reported)
+//  - images with metadata encoded after image data are not supported
+//  - images without any `ispe` box are not supported
+//
 
 /* eslint-disable consistent-return */