blob: b97ac7799e117bf0915f23e34764113e9a6f8eb2 [file] [log] [blame]
/*
* Copyright (C) 2012 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:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, 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/graphics/chromium/ImageDecodingStore.h"
#include "core/platform/SharedBuffer.h"
#include "core/platform/graphics/chromium/ImageFrameGenerator.h"
#include "core/platform/graphics/chromium/test/MockDiscardablePixelRef.h"
#include "core/platform/graphics/chromium/test/MockImageDecoder.h"
#include <gtest/gtest.h>
using namespace WebCore;
namespace {
class ImageDecodingStoreTest : public ::testing::Test, public MockImageDecoderClient {
public:
virtual void SetUp()
{
ImageDecodingStore::initializeOnce();
m_data = SharedBuffer::create();
m_generator = ImageFrameGenerator::create(SkISize::Make(100, 100), m_data, true);
m_decodersDestroyed = 0;
}
virtual void TearDown()
{
ImageDecodingStore::shutdown();
}
virtual void decoderBeingDestroyed()
{
++m_decodersDestroyed;
}
virtual void frameBufferRequested()
{
// Decoder is never used by ImageDecodingStore.
ASSERT_TRUE(false);
}
virtual ImageFrame::FrameStatus frameStatus()
{
return ImageFrame::FramePartial;
}
protected:
PassOwnPtr<ScaledImageFragment> createCompleteImage(const SkISize& size, bool discardable = false)
{
SkBitmap bitmap;
bitmap.setConfig(SkBitmap::kARGB_8888_Config, size.width(), size.height());
if (!discardable)
bitmap.allocPixels();
else
bitmap.setPixelRef(new MockDiscardablePixelRef())->unref();
return ScaledImageFragment::create(size, bitmap, true);
}
PassOwnPtr<ScaledImageFragment> createIncompleteImage(const SkISize& size, bool discardable = false)
{
SkBitmap bitmap;
bitmap.setConfig(SkBitmap::kARGB_8888_Config, size.width(), size.height());
if (!discardable)
bitmap.allocPixels();
else
bitmap.setPixelRef(new MockDiscardablePixelRef())->unref();
return ScaledImageFragment::create(size, bitmap, false);
}
void insertCache(const SkISize& size)
{
const ScaledImageFragment* image = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createCompleteImage(size));
unlockCache(image);
}
const ScaledImageFragment* lockCache(const SkISize& size)
{
const ScaledImageFragment* cachedImage = 0;
if (ImageDecodingStore::instance()->lockCache(m_generator.get(), size, ImageDecodingStore::CacheCanBeIncomplete, &cachedImage))
return cachedImage;
return 0;
}
void unlockCache(const ScaledImageFragment* cachedImage)
{
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
}
void evictOneCache()
{
size_t memoryUsageInBytes = ImageDecodingStore::instance()->memoryUsageInBytes();
if (memoryUsageInBytes)
ImageDecodingStore::instance()->setCacheLimitInBytes(memoryUsageInBytes - 1);
else
ImageDecodingStore::instance()->setCacheLimitInBytes(0);
}
bool isCacheAlive(const SkISize& size)
{
const ScaledImageFragment* cachedImage = lockCache(size);
if (!cachedImage)
return false;
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
return true;
}
RefPtr<SharedBuffer> m_data;
RefPtr<ImageFrameGenerator> m_generator;
int m_decodersDestroyed;
};
TEST_F(ImageDecodingStoreTest, evictOneCache)
{
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
insertCache(SkISize::Make(3, 3));
EXPECT_EQ(3u, ImageDecodingStore::instance()->cacheEntries());
evictOneCache();
EXPECT_EQ(2u, ImageDecodingStore::instance()->cacheEntries());
evictOneCache();
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
}
TEST_F(ImageDecodingStoreTest, pruneOrderIsLeastRecentlyUsed)
{
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
insertCache(SkISize::Make(3, 3));
insertCache(SkISize::Make(4, 4));
insertCache(SkISize::Make(5, 5));
EXPECT_EQ(5u, ImageDecodingStore::instance()->cacheEntries());
// Use cache in the order 3, 2, 4, 1, 5.
EXPECT_TRUE(isCacheAlive(SkISize::Make(3, 3)));
EXPECT_TRUE(isCacheAlive(SkISize::Make(2, 2)));
EXPECT_TRUE(isCacheAlive(SkISize::Make(4, 4)));
EXPECT_TRUE(isCacheAlive(SkISize::Make(1, 1)));
EXPECT_TRUE(isCacheAlive(SkISize::Make(5, 5)));
// Evict 3.
evictOneCache();
EXPECT_FALSE(isCacheAlive(SkISize::Make(3, 3)));
EXPECT_EQ(4u, ImageDecodingStore::instance()->cacheEntries());
// Evict 2.
evictOneCache();
EXPECT_FALSE(isCacheAlive(SkISize::Make(2, 2)));
EXPECT_EQ(3u, ImageDecodingStore::instance()->cacheEntries());
// Evict 4.
evictOneCache();
EXPECT_FALSE(isCacheAlive(SkISize::Make(4, 4)));
EXPECT_EQ(2u, ImageDecodingStore::instance()->cacheEntries());
// Evict 1.
evictOneCache();
EXPECT_FALSE(isCacheAlive(SkISize::Make(1, 1)));
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
// Evict 5.
evictOneCache();
EXPECT_FALSE(isCacheAlive(SkISize::Make(5, 5)));
EXPECT_EQ(0u, ImageDecodingStore::instance()->cacheEntries());
}
TEST_F(ImageDecodingStoreTest, pruneCausedByInsertion)
{
ImageDecodingStore::instance()->setCacheLimitInBytes(100);
// Insert 100 entries.
// Cache entries stored should increase and eventually decrease to 1.
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
insertCache(SkISize::Make(3, 3));
EXPECT_EQ(3u, ImageDecodingStore::instance()->cacheEntries());
for (int i = 4; i <= 100; ++i)
insertCache(SkISize::Make(i, i));
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
for (int i = 1; i <= 99; ++i)
EXPECT_FALSE(isCacheAlive(SkISize::Make(i, i)));
EXPECT_TRUE(isCacheAlive(SkISize::Make(100, 100)));
}
TEST_F(ImageDecodingStoreTest, cacheInUseNotEvicted)
{
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
insertCache(SkISize::Make(3, 3));
EXPECT_EQ(3u, ImageDecodingStore::instance()->cacheEntries());
const ScaledImageFragment* cachedImage = lockCache(SkISize::Make(1, 1));
ASSERT_TRUE(cachedImage);
// Cache 2 is evicted because cache 1 is in use.
evictOneCache();
EXPECT_TRUE(isCacheAlive(SkISize::Make(1, 1)));
EXPECT_FALSE(isCacheAlive(SkISize::Make(2, 2)));
EXPECT_TRUE(isCacheAlive(SkISize::Make(3, 3)));
EXPECT_EQ(2u, ImageDecodingStore::instance()->cacheEntries());
unlockCache(cachedImage);
}
TEST_F(ImageDecodingStoreTest, destroyImageFrameGenerator)
{
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
insertCache(SkISize::Make(3, 3));
EXPECT_EQ(3u, ImageDecodingStore::instance()->cacheEntries());
m_generator.clear();
EXPECT_FALSE(ImageDecodingStore::instance()->cacheEntries());
}
TEST_F(ImageDecodingStoreTest, insertIncompleteCache)
{
const SkISize size = SkISize::Make(1, 1);
const ScaledImageFragment* cachedImage = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createIncompleteImage(size), MockImageDecoder::create(this));
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
unlockCache(cachedImage);
ImageDecoder* decoder = 0;
EXPECT_TRUE(ImageDecodingStore::instance()->lockCache(m_generator.get(), size, ImageDecodingStore::CacheCanBeIncomplete, &cachedImage, &decoder));
EXPECT_TRUE(decoder);
ASSERT_TRUE(cachedImage);
EXPECT_FALSE(cachedImage->isComplete());
unlockCache(cachedImage);
EXPECT_EQ(0, m_decodersDestroyed);
}
TEST_F(ImageDecodingStoreTest, insertCompleteCacheWithDecoder)
{
const ScaledImageFragment* cachedImage = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createCompleteImage(SkISize::Make(1, 1)), MockImageDecoder::create(this));
unlockCache(cachedImage);
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
EXPECT_EQ(1, m_decodersDestroyed);
}
TEST_F(ImageDecodingStoreTest, incompleteCacheBecomesComplete)
{
const SkISize size = SkISize::Make(1, 1);
const ScaledImageFragment* cachedImage = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createIncompleteImage(size), MockImageDecoder::create(this));
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
ImageDecoder* decoder = 0;
EXPECT_TRUE(ImageDecodingStore::instance()->lockCache(m_generator.get(), size, ImageDecodingStore::CacheCanBeIncomplete, &cachedImage, &decoder));
EXPECT_TRUE(decoder);
ASSERT_TRUE(cachedImage);
EXPECT_FALSE(cachedImage->isComplete());
cachedImage = ImageDecodingStore::instance()->overwriteAndLockCache(
m_generator.get(), cachedImage, createCompleteImage(size));
EXPECT_TRUE(cachedImage->isComplete());
EXPECT_EQ(1, m_decodersDestroyed);
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
}
TEST_F(ImageDecodingStoreTest, lockCacheFailedAfterMemoryDiscarded)
{
const ScaledImageFragment* cachedImage = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createCompleteImage(SkISize::Make(1, 1), true), MockImageDecoder::create(this));
unlockCache(cachedImage);
MockDiscardablePixelRef* pixelRef = static_cast<MockDiscardablePixelRef*>(cachedImage->bitmap().pixelRef());
pixelRef->discard();
EXPECT_EQ(0, lockCache(SkISize::Make(1, 1)));
EXPECT_EQ(0u, ImageDecodingStore::instance()->cacheEntries());
}
TEST_F(ImageDecodingStoreTest, overwriteNonDiscardableCacheWithDiscardable)
{
const SkISize size = SkISize::Make(1, 1);
const ScaledImageFragment* cachedImage = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createIncompleteImage(size), MockImageDecoder::create(this));
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
EXPECT_LT(0u, ImageDecodingStore::instance()->memoryUsageInBytes());
ImageDecoder* decoder = 0;
EXPECT_TRUE(ImageDecodingStore::instance()->lockCache(m_generator.get(), size, ImageDecodingStore::CacheCanBeIncomplete, &cachedImage, &decoder));
EXPECT_FALSE(cachedImage->isComplete());
cachedImage = ImageDecodingStore::instance()->overwriteAndLockCache(
m_generator.get(), cachedImage, createCompleteImage(size, true));
EXPECT_TRUE(cachedImage->isComplete());
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
EXPECT_EQ(0u, ImageDecodingStore::instance()->memoryUsageInBytes());
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
}
TEST_F(ImageDecodingStoreTest, overwriteDiscardableCacheWithNonDiscardable)
{
const SkISize size = SkISize::Make(1, 1);
const ScaledImageFragment* cachedImage = ImageDecodingStore::instance()->insertAndLockCache(
m_generator.get(), createIncompleteImage(size, true), MockImageDecoder::create(this));
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
EXPECT_EQ(0u, ImageDecodingStore::instance()->memoryUsageInBytes());
ImageDecoder* decoder = 0;
EXPECT_TRUE(ImageDecodingStore::instance()->lockCache(m_generator.get(), size, ImageDecodingStore::CacheCanBeIncomplete, &cachedImage, &decoder));
EXPECT_FALSE(cachedImage->isComplete());
cachedImage = ImageDecodingStore::instance()->overwriteAndLockCache(
m_generator.get(), cachedImage, createCompleteImage(size));
EXPECT_TRUE(cachedImage->isComplete());
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
EXPECT_LT(0u, ImageDecodingStore::instance()->memoryUsageInBytes());
ImageDecodingStore::instance()->unlockCache(m_generator.get(), cachedImage);
}
TEST_F(ImageDecodingStoreTest, clear)
{
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
EXPECT_EQ(2u, ImageDecodingStore::instance()->cacheEntries());
ImageDecodingStore::instance()->clear();
EXPECT_EQ(0u, ImageDecodingStore::instance()->cacheEntries());
}
TEST_F(ImageDecodingStoreTest, clearInUse)
{
insertCache(SkISize::Make(1, 1));
insertCache(SkISize::Make(2, 2));
EXPECT_EQ(2u, ImageDecodingStore::instance()->cacheEntries());
const ScaledImageFragment* cachedImage = lockCache(SkISize::Make(1, 1));
ASSERT_TRUE(cachedImage);
ImageDecodingStore::instance()->clear();
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
unlockCache(cachedImage);
EXPECT_EQ(1u, ImageDecodingStore::instance()->cacheEntries());
}
} // namespace