Decode GIF image frames on demand.

Source/core/platform/image-decoders/gif/GIFImageDecoderTest.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 14 matching lines @@
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 
 #include "core/platform/image-decoders/gif/GIFImageDecoder.h"
 
-#include <gtest/gtest.h>
 #include "core/platform/FileSystem.h"
 #include "core/platform/SharedBuffer.h"
+#include "wtf/OwnPtr.h"
+#include "wtf/PassOwnPtr.h"
+#include "wtf/StringHasher.h"
+#include "wtf/Vector.h"
+#include <gtest/gtest.h>
 #include <public/Platform.h>
 #include <public/WebData.h>
 #include <public/WebSize.h>
 #include <public/WebUnitTestSupport.h>
-#include <wtf/OwnPtr.h>
-#include <wtf/PassOwnPtr.h>
-#include <wtf/StringHasher.h>
-#include <wtf/Vector.h>
 
 using namespace WebCore;
 using namespace WebKit;
 
 namespace {
 
 #if !OS(ANDROID)
 
 static PassRefPtr<SharedBuffer> readFile(const char* fileName)
 {
@@ skipping 15 matching lines @@
 static PassOwnPtr<GIFImageDecoder> createDecoder()
 {
     return adoptPtr(new GIFImageDecoder(ImageSource::AlphaNotPremultiplied, ImageSource::GammaAndColorProfileApplied));
 }
 
 static unsigned hashSkBitmap(const SkBitmap& bitmap)
 {
     return StringHasher::hashMemory(bitmap.getPixels(), bitmap.getSize());
 }
 
+static void createDecodingBaseline(SharedBuffer* data, Vector<unsigned>* baselineHashes)
+{
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
+    decoder->setData(data, true);
+    size_t frameCount = decoder->frameCount();
+    for (size_t i = 0; i < frameCount; ++i) {
+        ImageFrame* frame = decoder->frameBufferAtIndex(i);
+        baselineHashes->append(hashSkBitmap(frame->getSkBitmap()));
+    }
+}
+
 TEST(GIFImageDecoderTest, decodeTwoFrames)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
     ASSERT_TRUE(data.get());
     decoder->setData(data.get(), true);
     EXPECT_EQ(cAnimationLoopOnce, decoder->repetitionCount());
 
     ImageFrame* frame = decoder->frameBufferAtIndex(0);
     EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
     EXPECT_EQ(16, frame->getSkBitmap().width());
     EXPECT_EQ(16, frame->getSkBitmap().height());
 
     frame = decoder->frameBufferAtIndex(1);
     EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
     EXPECT_EQ(16, frame->getSkBitmap().width());
     EXPECT_EQ(16, frame->getSkBitmap().height());
 
     EXPECT_EQ(2u, decoder->frameCount());
     EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
 }
 
 TEST(GIFImageDecoderTest, parseAndDecode)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
     ASSERT_TRUE(data.get());
     decoder->setData(data.get(), true);
     EXPECT_EQ(cAnimationLoopOnce, decoder->repetitionCount());
 
     // This call will parse the entire file.
     EXPECT_EQ(2u, decoder->frameCount());
 
     ImageFrame* frame = decoder->frameBufferAtIndex(0);
     EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
     EXPECT_EQ(16, frame->getSkBitmap().width());
     EXPECT_EQ(16, frame->getSkBitmap().height());
 
     frame = decoder->frameBufferAtIndex(1);
     EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
     EXPECT_EQ(16, frame->getSkBitmap().width());
     EXPECT_EQ(16, frame->getSkBitmap().height());
     EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
 }
 
 TEST(GIFImageDecoderTest, parseByteByByte)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
     ASSERT_TRUE(data.get());
 
     size_t frameCount = 0;
 
     // Pass data to decoder byte by byte.
-    for (unsigned length = 1; length <= data->size(); ++length) {
+    for (size_t length = 1; length <= data->size(); ++length) {
         RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), length);
         decoder->setData(tempData.get(), length == data->size());
 
         EXPECT_LE(frameCount, decoder->frameCount());
         frameCount = decoder->frameCount();
     }
 
     EXPECT_EQ(2u, decoder->frameCount());
 
     decoder->frameBufferAtIndex(0);
     decoder->frameBufferAtIndex(1);
     EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
 }
 
 TEST(GIFImageDecoderTest, parseAndDecodeByteByByte)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated-gif-with-offsets.gif");
     ASSERT_TRUE(data.get());
 
     size_t frameCount = 0;
     size_t framesDecoded = 0;
 
     // Pass data to decoder byte by byte.
-    for (unsigned length = 1; length <= data->size(); ++length) {
+    for (size_t length = 1; length <= data->size(); ++length) {
         RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), length);
         decoder->setData(tempData.get(), length == data->size());
 
         EXPECT_LE(frameCount, decoder->frameCount());
         frameCount = decoder->frameCount();
 
         ImageFrame* frame = decoder->frameBufferAtIndex(frameCount - 1);
         if (frame && frame->status() == ImageFrame::FrameComplete && framesDecoded < frameCount)
             ++framesDecoded;
     }
 
     EXPECT_EQ(5u, decoder->frameCount());
     EXPECT_EQ(5u, framesDecoded);
     EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
 }
 
 TEST(GIFImageDecoderTest, brokenSecondFrame)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/Source/WebKit/chromium/tests/data/broken.gif");
     ASSERT_TRUE(data.get());
     decoder->setData(data.get(), true);
 
     // One frame is detected but cannot be decoded.
     EXPECT_EQ(1u, decoder->frameCount());
     ImageFrame* frame = decoder->frameBufferAtIndex(1);
     EXPECT_FALSE(frame);
 }
@@ skipping 42 matching lines @@
         if (truncatedHashes[i] != progressiveHashes[i]) {
             match = false;
             break;
         }
     }
     EXPECT_TRUE(match);
 }
 
 TEST(GIFImageDecoderTest, allDataReceivedTruncation)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
     ASSERT_TRUE(data.get());
 
     ASSERT_GE(data->size(), 10u);
     RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), data->size() - 10);
     decoder->setData(tempData.get(), true);
 
     EXPECT_EQ(2u, decoder->frameCount());
     EXPECT_FALSE(decoder->failed());
 
     decoder->frameBufferAtIndex(0);
     EXPECT_FALSE(decoder->failed());
     decoder->frameBufferAtIndex(1);
     EXPECT_TRUE(decoder->failed());
 }
 
 TEST(GIFImageDecoderTest, frameIsComplete)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
     ASSERT_TRUE(data.get());
     decoder->setData(data.get(), true);
 
     EXPECT_EQ(2u, decoder->frameCount());
     EXPECT_FALSE(decoder->failed());
     EXPECT_TRUE(decoder->frameIsCompleteAtIndex(0));
     EXPECT_TRUE(decoder->frameIsCompleteAtIndex(1));
 }
 
 TEST(GIFImageDecoderTest, frameIsCompleteLoading)
 {
-    OwnPtr<GIFImageDecoder> decoder(createDecoder());
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
 
     RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
     ASSERT_TRUE(data.get());
 
     ASSERT_GE(data->size(), 10u);
     RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), data->size() - 10);
     decoder->setData(tempData.get(), false);
 
     EXPECT_EQ(2u, decoder->frameCount());
     EXPECT_FALSE(decoder->failed());
@@ skipping 21 matching lines @@
 
     OwnPtr<GIFImageDecoder> testDecoder(createDecoder());
     testDecoder->setData(testData.get(), true);
     EXPECT_EQ(1u, testDecoder->frameCount());
     ImageFrame* testFrame = testDecoder->frameBufferAtIndex(0);
     ASSERT(testFrame);
 
     EXPECT_EQ(hashSkBitmap(referenceFrame->getSkBitmap()), hashSkBitmap(testFrame->getSkBitmap()));
 }
 
+TEST(GIFImageDecoderTest, updateRequiredPreviousFrameAfterFirstDecode)
+{
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
+
+    RefPtr<SharedBuffer> fullData = readFile("/LayoutTests/fast/images/resources/animated-10color.gif");
+    ASSERT_TRUE(fullData.get());
+
+    // Give it data that is enough to parse but not decode in order to check the status
+    // of requiredPreviousFrameIndex before decoding.
+    size_t partialSize = 1;
+    do {
+        RefPtr<SharedBuffer> data = SharedBuffer::create(fullData->data(), partialSize);
+        decoder->setData(data.get(), false);
+        ++partialSize;
+    } while (!decoder->frameCount() || decoder->frameBufferAtIndex(0)->status() == ImageFrame::FrameEmpty);
+
+    EXPECT_EQ(notFound, decoder->frameBufferAtIndex(0)->requiredPreviousFrameIndex());
+    unsigned frameCount = decoder->frameCount();
+    for (size_t i = 1; i < frameCount; ++i)
+        EXPECT_EQ(i - 1, decoder->frameBufferAtIndex(i)->requiredPreviousFrameIndex());
+
+    decoder->setData(fullData.get(), true);
+    for (size_t i = 0; i < frameCount; ++i)
+        EXPECT_EQ(notFound, decoder->frameBufferAtIndex(i)->requiredPreviousFrameIndex());
+}
+
+void testRandomFrameDecode(const char* gifFile)
+{
+    SCOPED_TRACE(gifFile);
+
+    RefPtr<SharedBuffer> fullData = readFile(gifFile);
+    ASSERT_TRUE(fullData.get());
+    Vector<unsigned> baselineHashes;
+    createDecodingBaseline(fullData.get(), &baselineHashes);
+    size_t frameCount = baselineHashes.size();
+
+    // Random decoding should get the same results as sequential decoding.
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
+    decoder->setData(fullData.get(), true);
+    const size_t skippingStep = 5;
+    for (size_t i = 0; i < skippingStep; ++i) {
+        for (size_t j = i; j < frameCount; j += skippingStep) {
+            SCOPED_TRACE(testing::Message() << "Random i:" << i << " j:" << j);
+            ImageFrame* frame = decoder->frameBufferAtIndex(j);
+            EXPECT_EQ(baselineHashes[j], hashSkBitmap(frame->getSkBitmap()));
+        }
+    }
+
+    // Decoding in reverse order.
+    decoder = createDecoder();
+    decoder->setData(fullData.get(), true);
+    for (size_t i = frameCount; i; --i) {
+        SCOPED_TRACE(testing::Message() << "Reverse i:" << i);
+        ImageFrame* frame = decoder->frameBufferAtIndex(i - 1);
+        EXPECT_EQ(baselineHashes[i - 1], hashSkBitmap(frame->getSkBitmap()));
+    }
+}
+
+TEST(GIFImageDecoderTest, randomFrameDecode)
+{
+    // Single frame image.
+    testRandomFrameDecode("/Source/WebKit/chromium/tests/data/radient.gif");
+    // Multiple frame image.
+    testRandomFrameDecode("/LayoutTests/fast/images/resources/animated-gif-with-offsets.gif");
+    testRandomFrameDecode("/LayoutTests/fast/images/resources/animated-10color.gif");
+}
+
+void testRandomDecodeAfterClearFrameBufferCache(const char* gifFile)
+{
+    SCOPED_TRACE(gifFile);
+
+    RefPtr<SharedBuffer> data = readFile(gifFile);
+    ASSERT_TRUE(data.get());
+    Vector<unsigned> baselineHashes;
+    createDecodingBaseline(data.get(), &baselineHashes);
+    size_t frameCount = baselineHashes.size();
+
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
+    for (size_t clearExceptFrame = 0; clearExceptFrame < frameCount; ++clearExceptFrame) {
+        decoder->clearCacheExceptFrame(clearExceptFrame);
+        const size_t skippingStep = 5;
+        for (size_t i = 0; i < skippingStep; ++i) {
+            for (size_t j = 0; j < frameCount; j += skippingStep) {
+                SCOPED_TRACE(testing::Message() << "Random i:" << i << " j:" << j);
+                ImageFrame* frame = decoder->frameBufferAtIndex(j);
+                EXPECT_EQ(baselineHashes[j], hashSkBitmap(frame->getSkBitmap()));
+            }
+        }
+    }
+}
+
+TEST(GIFImageDecoderTest, randomDecodeAfterClearFrameBufferCache)
+{
+    // Single frame image.
+    testRandomFrameDecode("/Source/WebKit/chromium/tests/data/radient.gif");
+    // Multiple frame image.
+    testRandomFrameDecode("/LayoutTests/fast/images/resources/animated-gif-with-offsets.gif");
+    testRandomFrameDecode("/LayoutTests/fast/images/resources/animated-10color.gif");
+}
+
+TEST(GIFImageDecoderTest, resumePartialDecodeAfterClearFrameBufferCache)
+{
+    RefPtr<SharedBuffer> fullData = readFile("/LayoutTests/fast/images/resources/animated-10color.gif");
+    ASSERT_TRUE(fullData.get());
+    Vector<unsigned> baselineHashes;
+    createDecodingBaseline(fullData.get(), &baselineHashes);
+    size_t frameCount = baselineHashes.size();
+
+    OwnPtr<GIFImageDecoder> decoder = createDecoder();
+
+    // Let frame 0 be partially decoded.
+    size_t partialSize = 1;
+    do {
+        RefPtr<SharedBuffer> data = SharedBuffer::create(fullData->data(), partialSize);
+        decoder->setData(data.get(), false);
+        ++partialSize;
+    } while (!decoder->frameCount() || decoder->frameBufferAtIndex(0)->status() == ImageFrame::FrameEmpty);
+
+    // Skip to the last frame and clear.
+    decoder->setData(fullData.get(), true);
+    EXPECT_EQ(frameCount, decoder->frameCount());
+    ImageFrame* lastFrame = decoder->frameBufferAtIndex(frameCount - 1);
+    EXPECT_EQ(baselineHashes[frameCount - 1], hashSkBitmap(lastFrame->getSkBitmap()));
+    decoder->clearCacheExceptFrame(notFound);
+
+    // Resume decoding of the first frame.
+    ImageFrame* firstFrame = decoder->frameBufferAtIndex(0);
+    EXPECT_EQ(ImageFrame::FrameComplete, firstFrame->status());
+    EXPECT_EQ(baselineHashes[0], hashSkBitmap(firstFrame->getSkBitmap()));
+}
+
 #endif
 
 } // namespace