commit 46459a75e7fa9c5fa1c5d6fd076e141646f765c1
author Wan-Teh Chang <wtc@google.com> Tue Jul 13 15:14:49 2021 -0700
committer Joe Drago <joedrago@gmail.com> Tue Jul 13 15:19:43 2021 -0700
tree 520a39cbcd281120025a494788c7d14d174984c0
parent db275902edb11767e3d0ebba483a14e39ccac1fd

Clarify the comment for avifDecodeSample.spatialID

Clarify the comment for the spatialID member of the avifDecodeSample
struct. Avoid the ambiguous word "otherwise".

Fix https://github.com/AOMediaCodec/libavif/issues/697.

include/avif/internal.h

diff --git a/include/avif/internal.h b/include/avif/internal.h
index 93a4d8e..8f4e9f9 100644
--- a/include/avif/internal.h
+++ b/include/avif/internal.h
@@ -176,8 +176,8 @@
     uint32_t itemID;   // if non-zero, data comes from a mergedExtents buffer in an avifDecoderItem, not a file offset
     uint64_t offset;   // additional offset into data. Can be used to offset into an itemID's payload as well.
     size_t size;       //
-    uint8_t spatialID; // If set to a value other than AVIF_SPATIAL_ID_UNSET, the output frame's spatial_id must match
-                       // this ID, otherwise output frames from this sample should be skipped until it does.
+    uint8_t spatialID; // If set to a value other than AVIF_SPATIAL_ID_UNSET, output frames from this sample should be
+                       // skipped until the output frame's spatial_id matches this ID.
     avifBool sync;     // is sync sample (keyframe)
 } avifDecodeSample;
 AVIF_ARRAY_DECLARE(avifDecodeSampleArray, avifDecodeSample, sample);