2 * Copyright (C) 2013 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
14 * * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include "platform/image-decoders/gif/GIFImageDecoder.h"
35 #include "platform/SharedBuffer.h"
36 #include "public/platform/Platform.h"
37 #include "public/platform/WebData.h"
38 #include "public/platform/WebSize.h"
39 #include "public/platform/WebUnitTestSupport.h"
40 #include "wtf/OwnPtr.h"
41 #include "wtf/PassOwnPtr.h"
42 #include "wtf/StringHasher.h"
43 #include "wtf/Vector.h"
44 #include <gtest/gtest.h>
46 using namespace WebCore;
47 using namespace blink;
51 PassRefPtr<SharedBuffer> readFile(const char* fileName)
53 String filePath = Platform::current()->unitTestSupport()->webKitRootDir();
54 filePath.append(fileName);
56 return Platform::current()->unitTestSupport()->readFromFile(filePath);
59 PassOwnPtr<GIFImageDecoder> createDecoder()
61 return adoptPtr(new GIFImageDecoder(ImageSource::AlphaNotPremultiplied, ImageSource::GammaAndColorProfileApplied, ImageDecoder::noDecodedImageByteLimit));
64 unsigned hashSkBitmap(const SkBitmap& bitmap)
66 return StringHasher::hashMemory(bitmap.getPixels(), bitmap.getSize());
69 void createDecodingBaseline(SharedBuffer* data, Vector<unsigned>* baselineHashes)
71 OwnPtr<GIFImageDecoder> decoder = createDecoder();
72 decoder->setData(data, true);
73 size_t frameCount = decoder->frameCount();
74 for (size_t i = 0; i < frameCount; ++i) {
75 ImageFrame* frame = decoder->frameBufferAtIndex(i);
76 baselineHashes->append(hashSkBitmap(frame->getSkBitmap()));
80 void testRandomFrameDecode(const char* gifFile)
82 SCOPED_TRACE(gifFile);
84 RefPtr<SharedBuffer> fullData = readFile(gifFile);
85 ASSERT_TRUE(fullData.get());
86 Vector<unsigned> baselineHashes;
87 createDecodingBaseline(fullData.get(), &baselineHashes);
88 size_t frameCount = baselineHashes.size();
90 // Random decoding should get the same results as sequential decoding.
91 OwnPtr<GIFImageDecoder> decoder = createDecoder();
92 decoder->setData(fullData.get(), true);
93 const size_t skippingStep = 5;
94 for (size_t i = 0; i < skippingStep; ++i) {
95 for (size_t j = i; j < frameCount; j += skippingStep) {
96 SCOPED_TRACE(testing::Message() << "Random i:" << i << " j:" << j);
97 ImageFrame* frame = decoder->frameBufferAtIndex(j);
98 EXPECT_EQ(baselineHashes[j], hashSkBitmap(frame->getSkBitmap()));
102 // Decoding in reverse order.
103 decoder = createDecoder();
104 decoder->setData(fullData.get(), true);
105 for (size_t i = frameCount; i; --i) {
106 SCOPED_TRACE(testing::Message() << "Reverse i:" << i);
107 ImageFrame* frame = decoder->frameBufferAtIndex(i - 1);
108 EXPECT_EQ(baselineHashes[i - 1], hashSkBitmap(frame->getSkBitmap()));
112 void testRandomDecodeAfterClearFrameBufferCache(const char* gifFile)
114 SCOPED_TRACE(gifFile);
116 RefPtr<SharedBuffer> data = readFile(gifFile);
117 ASSERT_TRUE(data.get());
118 Vector<unsigned> baselineHashes;
119 createDecodingBaseline(data.get(), &baselineHashes);
120 size_t frameCount = baselineHashes.size();
122 OwnPtr<GIFImageDecoder> decoder = createDecoder();
123 decoder->setData(data.get(), true);
124 for (size_t clearExceptFrame = 0; clearExceptFrame < frameCount; ++clearExceptFrame) {
125 decoder->clearCacheExceptFrame(clearExceptFrame);
126 const size_t skippingStep = 5;
127 for (size_t i = 0; i < skippingStep; ++i) {
128 for (size_t j = 0; j < frameCount; j += skippingStep) {
129 SCOPED_TRACE(testing::Message() << "Random i:" << i << " j:" << j);
130 ImageFrame* frame = decoder->frameBufferAtIndex(j);
131 EXPECT_EQ(baselineHashes[j], hashSkBitmap(frame->getSkBitmap()));
139 TEST(GIFImageDecoderTest, decodeTwoFrames)
141 OwnPtr<GIFImageDecoder> decoder = createDecoder();
143 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
144 ASSERT_TRUE(data.get());
145 decoder->setData(data.get(), true);
146 EXPECT_EQ(cAnimationLoopOnce, decoder->repetitionCount());
148 ImageFrame* frame = decoder->frameBufferAtIndex(0);
149 uint32_t generationID0 = frame->getSkBitmap().getGenerationID();
150 EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
151 EXPECT_EQ(16, frame->getSkBitmap().width());
152 EXPECT_EQ(16, frame->getSkBitmap().height());
154 frame = decoder->frameBufferAtIndex(1);
155 uint32_t generationID1 = frame->getSkBitmap().getGenerationID();
156 EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
157 EXPECT_EQ(16, frame->getSkBitmap().width());
158 EXPECT_EQ(16, frame->getSkBitmap().height());
159 EXPECT_TRUE(generationID0 != generationID1);
161 EXPECT_EQ(2u, decoder->frameCount());
162 EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
165 TEST(GIFImageDecoderTest, parseAndDecode)
167 OwnPtr<GIFImageDecoder> decoder = createDecoder();
169 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
170 ASSERT_TRUE(data.get());
171 decoder->setData(data.get(), true);
172 EXPECT_EQ(cAnimationLoopOnce, decoder->repetitionCount());
174 // This call will parse the entire file.
175 EXPECT_EQ(2u, decoder->frameCount());
177 ImageFrame* frame = decoder->frameBufferAtIndex(0);
178 EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
179 EXPECT_EQ(16, frame->getSkBitmap().width());
180 EXPECT_EQ(16, frame->getSkBitmap().height());
182 frame = decoder->frameBufferAtIndex(1);
183 EXPECT_EQ(ImageFrame::FrameComplete, frame->status());
184 EXPECT_EQ(16, frame->getSkBitmap().width());
185 EXPECT_EQ(16, frame->getSkBitmap().height());
186 EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
189 TEST(GIFImageDecoderTest, parseByteByByte)
191 OwnPtr<GIFImageDecoder> decoder = createDecoder();
193 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
194 ASSERT_TRUE(data.get());
196 size_t frameCount = 0;
198 // Pass data to decoder byte by byte.
199 for (size_t length = 1; length <= data->size(); ++length) {
200 RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), length);
201 decoder->setData(tempData.get(), length == data->size());
203 EXPECT_LE(frameCount, decoder->frameCount());
204 frameCount = decoder->frameCount();
207 EXPECT_EQ(2u, decoder->frameCount());
209 decoder->frameBufferAtIndex(0);
210 decoder->frameBufferAtIndex(1);
211 EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
214 TEST(GIFImageDecoderTest, parseAndDecodeByteByByte)
216 OwnPtr<GIFImageDecoder> decoder = createDecoder();
218 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated-gif-with-offsets.gif");
219 ASSERT_TRUE(data.get());
221 size_t frameCount = 0;
222 size_t framesDecoded = 0;
224 // Pass data to decoder byte by byte.
225 for (size_t length = 1; length <= data->size(); ++length) {
226 RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), length);
227 decoder->setData(tempData.get(), length == data->size());
229 EXPECT_LE(frameCount, decoder->frameCount());
230 frameCount = decoder->frameCount();
232 ImageFrame* frame = decoder->frameBufferAtIndex(frameCount - 1);
233 if (frame && frame->status() == ImageFrame::FrameComplete && framesDecoded < frameCount)
237 EXPECT_EQ(5u, decoder->frameCount());
238 EXPECT_EQ(5u, framesDecoded);
239 EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
242 TEST(GIFImageDecoderTest, brokenSecondFrame)
244 OwnPtr<GIFImageDecoder> decoder = createDecoder();
246 RefPtr<SharedBuffer> data = readFile("/Source/web/tests/data/broken.gif");
247 ASSERT_TRUE(data.get());
248 decoder->setData(data.get(), true);
250 // One frame is detected but cannot be decoded.
251 EXPECT_EQ(1u, decoder->frameCount());
252 ImageFrame* frame = decoder->frameBufferAtIndex(1);
256 TEST(GIFImageDecoderTest, progressiveDecode)
258 RefPtr<SharedBuffer> fullData = readFile("/Source/web/tests/data/radient.gif");
259 ASSERT_TRUE(fullData.get());
260 const size_t fullLength = fullData->size();
262 OwnPtr<GIFImageDecoder> decoder;
265 Vector<unsigned> truncatedHashes;
266 Vector<unsigned> progressiveHashes;
268 // Compute hashes when the file is truncated.
269 const size_t increment = 1;
270 for (size_t i = 1; i <= fullLength; i += increment) {
271 decoder = createDecoder();
272 RefPtr<SharedBuffer> data = SharedBuffer::create(fullData->data(), i);
273 decoder->setData(data.get(), i == fullLength);
274 frame = decoder->frameBufferAtIndex(0);
276 truncatedHashes.append(0);
279 truncatedHashes.append(hashSkBitmap(frame->getSkBitmap()));
282 // Compute hashes when the file is progressively decoded.
283 decoder = createDecoder();
284 EXPECT_EQ(cAnimationLoopOnce, decoder->repetitionCount());
285 for (size_t i = 1; i <= fullLength; i += increment) {
286 RefPtr<SharedBuffer> data = SharedBuffer::create(fullData->data(), i);
287 decoder->setData(data.get(), i == fullLength);
288 frame = decoder->frameBufferAtIndex(0);
290 progressiveHashes.append(0);
293 progressiveHashes.append(hashSkBitmap(frame->getSkBitmap()));
295 EXPECT_EQ(cAnimationNone, decoder->repetitionCount());
298 for (size_t i = 0; i < truncatedHashes.size(); ++i) {
299 if (truncatedHashes[i] != progressiveHashes[i]) {
307 TEST(GIFImageDecoderTest, allDataReceivedTruncation)
309 OwnPtr<GIFImageDecoder> decoder = createDecoder();
311 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
312 ASSERT_TRUE(data.get());
314 ASSERT_GE(data->size(), 10u);
315 RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), data->size() - 10);
316 decoder->setData(tempData.get(), true);
318 EXPECT_EQ(2u, decoder->frameCount());
319 EXPECT_FALSE(decoder->failed());
321 decoder->frameBufferAtIndex(0);
322 EXPECT_FALSE(decoder->failed());
323 decoder->frameBufferAtIndex(1);
324 EXPECT_TRUE(decoder->failed());
327 TEST(GIFImageDecoderTest, frameIsComplete)
329 OwnPtr<GIFImageDecoder> decoder = createDecoder();
331 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
332 ASSERT_TRUE(data.get());
333 decoder->setData(data.get(), true);
335 EXPECT_EQ(2u, decoder->frameCount());
336 EXPECT_FALSE(decoder->failed());
337 EXPECT_TRUE(decoder->frameIsCompleteAtIndex(0));
338 EXPECT_TRUE(decoder->frameIsCompleteAtIndex(1));
339 EXPECT_EQ(cAnimationLoopInfinite, decoder->repetitionCount());
342 TEST(GIFImageDecoderTest, frameIsCompleteLoading)
344 OwnPtr<GIFImageDecoder> decoder = createDecoder();
346 RefPtr<SharedBuffer> data = readFile("/LayoutTests/fast/images/resources/animated.gif");
347 ASSERT_TRUE(data.get());
349 ASSERT_GE(data->size(), 10u);
350 RefPtr<SharedBuffer> tempData = SharedBuffer::create(data->data(), data->size() - 10);
351 decoder->setData(tempData.get(), false);
353 EXPECT_EQ(2u, decoder->frameCount());
354 EXPECT_FALSE(decoder->failed());
355 EXPECT_TRUE(decoder->frameIsCompleteAtIndex(0));
356 EXPECT_FALSE(decoder->frameIsCompleteAtIndex(1));
358 decoder->setData(data.get(), true);
359 EXPECT_EQ(2u, decoder->frameCount());
360 EXPECT_TRUE(decoder->frameIsCompleteAtIndex(0));
361 EXPECT_TRUE(decoder->frameIsCompleteAtIndex(1));
364 TEST(GIFImageDecoderTest, badTerminator)
366 RefPtr<SharedBuffer> referenceData = readFile("/Source/web/tests/data/radient.gif");
367 RefPtr<SharedBuffer> testData = readFile("/Source/web/tests/data/radient-bad-terminator.gif");
368 ASSERT_TRUE(referenceData.get());
369 ASSERT_TRUE(testData.get());
371 OwnPtr<GIFImageDecoder> referenceDecoder(createDecoder());
372 referenceDecoder->setData(referenceData.get(), true);
373 EXPECT_EQ(1u, referenceDecoder->frameCount());
374 ImageFrame* referenceFrame = referenceDecoder->frameBufferAtIndex(0);
375 ASSERT(referenceFrame);
377 OwnPtr<GIFImageDecoder> testDecoder(createDecoder());
378 testDecoder->setData(testData.get(), true);
379 EXPECT_EQ(1u, testDecoder->frameCount());
380 ImageFrame* testFrame = testDecoder->frameBufferAtIndex(0);
383 EXPECT_EQ(hashSkBitmap(referenceFrame->getSkBitmap()), hashSkBitmap(testFrame->getSkBitmap()));
386 TEST(GIFImageDecoderTest, updateRequiredPreviousFrameAfterFirstDecode)
388 OwnPtr<GIFImageDecoder> decoder = createDecoder();
390 RefPtr<SharedBuffer> fullData = readFile("/LayoutTests/fast/images/resources/animated-10color.gif");
391 ASSERT_TRUE(fullData.get());
393 // Give it data that is enough to parse but not decode in order to check the status
394 // of requiredPreviousFrameIndex before decoding.
395 size_t partialSize = 1;
397 RefPtr<SharedBuffer> data = SharedBuffer::create(fullData->data(), partialSize);
398 decoder->setData(data.get(), false);
400 } while (!decoder->frameCount() || decoder->frameBufferAtIndex(0)->status() == ImageFrame::FrameEmpty);
402 EXPECT_EQ(kNotFound, decoder->frameBufferAtIndex(0)->requiredPreviousFrameIndex());
403 unsigned frameCount = decoder->frameCount();
404 for (size_t i = 1; i < frameCount; ++i)
405 EXPECT_EQ(i - 1, decoder->frameBufferAtIndex(i)->requiredPreviousFrameIndex());
407 decoder->setData(fullData.get(), true);
408 for (size_t i = 0; i < frameCount; ++i)
409 EXPECT_EQ(kNotFound, decoder->frameBufferAtIndex(i)->requiredPreviousFrameIndex());
412 TEST(GIFImageDecoderTest, randomFrameDecode)
414 // Single frame image.
415 testRandomFrameDecode("/Source/web/tests/data/radient.gif");
416 // Multiple frame images.
417 testRandomFrameDecode("/LayoutTests/fast/images/resources/animated-gif-with-offsets.gif");
418 testRandomFrameDecode("/LayoutTests/fast/images/resources/animated-10color.gif");
421 TEST(GIFImageDecoderTest, randomDecodeAfterClearFrameBufferCache)
423 // Single frame image.
424 testRandomDecodeAfterClearFrameBufferCache("/Source/web/tests/data/radient.gif");
425 // Multiple frame images.
426 testRandomDecodeAfterClearFrameBufferCache("/LayoutTests/fast/images/resources/animated-gif-with-offsets.gif");
427 testRandomDecodeAfterClearFrameBufferCache("/LayoutTests/fast/images/resources/animated-10color.gif");
430 TEST(GIFImageDecoderTest, resumePartialDecodeAfterClearFrameBufferCache)
432 RefPtr<SharedBuffer> fullData = readFile("/LayoutTests/fast/images/resources/animated-10color.gif");
433 ASSERT_TRUE(fullData.get());
434 Vector<unsigned> baselineHashes;
435 createDecodingBaseline(fullData.get(), &baselineHashes);
436 size_t frameCount = baselineHashes.size();
438 OwnPtr<GIFImageDecoder> decoder = createDecoder();
440 // Let frame 0 be partially decoded.
441 size_t partialSize = 1;
443 RefPtr<SharedBuffer> data = SharedBuffer::create(fullData->data(), partialSize);
444 decoder->setData(data.get(), false);
446 } while (!decoder->frameCount() || decoder->frameBufferAtIndex(0)->status() == ImageFrame::FrameEmpty);
448 // Skip to the last frame and clear.
449 decoder->setData(fullData.get(), true);
450 EXPECT_EQ(frameCount, decoder->frameCount());
451 ImageFrame* lastFrame = decoder->frameBufferAtIndex(frameCount - 1);
452 EXPECT_EQ(baselineHashes[frameCount - 1], hashSkBitmap(lastFrame->getSkBitmap()));
453 decoder->clearCacheExceptFrame(kNotFound);
455 // Resume decoding of the first frame.
456 ImageFrame* firstFrame = decoder->frameBufferAtIndex(0);
457 EXPECT_EQ(ImageFrame::FrameComplete, firstFrame->status());
458 EXPECT_EQ(baselineHashes[0], hashSkBitmap(firstFrame->getSkBitmap()));
461 // The first LZW codes in the image are invalid values that try to create a loop
462 // in the dictionary. Decoding should fail, but not infinitely loop or corrupt memory.
463 TEST(GIFImageDecoderTest, badInitialCode)
465 RefPtr<SharedBuffer> testData = readFile("/Source/platform/image-decoders/testing/bad-initial-code.gif");
466 ASSERT_TRUE(testData.get());
468 OwnPtr<GIFImageDecoder> testDecoder(createDecoder());
469 testDecoder->setData(testData.get(), true);
470 EXPECT_EQ(1u, testDecoder->frameCount());
471 ASSERT_TRUE(testDecoder->frameBufferAtIndex(0));
472 EXPECT_TRUE(testDecoder->failed());
475 // The image has an invalid LZW code that exceeds dictionary size. Decoding should fail.
476 TEST(GIFImageDecoderTest, badCode)
478 RefPtr<SharedBuffer> testData = readFile("/Source/platform/image-decoders/testing/bad-code.gif");
479 ASSERT_TRUE(testData.get());
481 OwnPtr<GIFImageDecoder> testDecoder(createDecoder());
482 testDecoder->setData(testData.get(), true);
483 EXPECT_EQ(1u, testDecoder->frameCount());
484 ASSERT_TRUE(testDecoder->frameBufferAtIndex(0));
485 EXPECT_TRUE(testDecoder->failed());
488 TEST(GIFImageDecoderTest, invalidDisposalMethod)
490 OwnPtr<GIFImageDecoder> decoder = createDecoder();
492 // The image has 2 frames, with disposal method 4 and 5, respectively.
493 RefPtr<SharedBuffer> data = readFile("/Source/web/tests/data/invalid-disposal-method.gif");
494 ASSERT_TRUE(data.get());
495 decoder->setData(data.get(), true);
497 EXPECT_EQ(2u, decoder->frameCount());
498 // Disposal method 4 is converted to ImageFrame::DisposeOverwritePrevious.
499 EXPECT_EQ(ImageFrame::DisposeOverwritePrevious, decoder->frameBufferAtIndex(0)->disposalMethod());
500 // Disposal method 5 is ignored.
501 EXPECT_EQ(ImageFrame::DisposeNotSpecified, decoder->frameBufferAtIndex(1)->disposalMethod());