#include "config.h"
#include "ImageSource.h"
#if USE(CG)
#include "ImageSourceCG.h"
#include "CoreGraphicsSPI.h"
#include "ImageOrientation.h"
#include "IntPoint.h"
#include "IntSize.h"
#include "MIMETypeRegistry.h"
#include "SharedBuffer.h"
#include <wtf/NeverDestroyed.h>
#if !PLATFORM(IOS)
#include <ApplicationServices/ApplicationServices.h>
#else
#include <ImageIO/ImageIO.h>
#include <wtf/RetainPtr.h>
#endif
#if __has_include(<ImageIO/CGImageSourcePrivate.h>)
#import <ImageIO/CGImageSourcePrivate.h>
#else
const CFStringRef kCGImageSourceSubsampleFactor = CFSTR("kCGImageSourceSubsampleFactor");
#endif
namespace WebCore {
const CFStringRef WebCoreCGImagePropertyAPNGUnclampedDelayTime = CFSTR("UnclampedDelayTime");
const CFStringRef WebCoreCGImagePropertyAPNGDelayTime = CFSTR("DelayTime");
const CFStringRef WebCoreCGImagePropertyAPNGLoopCount = CFSTR("LoopCount");
const CFStringRef kCGImageSourceShouldPreferRGB32 = CFSTR("kCGImageSourceShouldPreferRGB32");
const CFStringRef kCGImageSourceSkipMetadata = CFSTR("kCGImageSourceSkipMetadata");
#if !PLATFORM(COCOA)
size_t sharedBufferGetBytesAtPosition(void* info, void* buffer, off_t position, size_t count)
{
SharedBuffer* sharedBuffer = static_cast<SharedBuffer*>(info);
size_t sourceSize = sharedBuffer->size();
if (position >= sourceSize)
return 0;
const char* source = sharedBuffer->data() + position;
size_t amount = std::min<size_t>(count, sourceSize - position);
memcpy(buffer, source, amount);
return amount;
}
void sharedBufferRelease(void* info)
{
SharedBuffer* sharedBuffer = static_cast<SharedBuffer*>(info);
sharedBuffer->deref();
}
#endif
ImageSource::ImageSource(ImageSource::AlphaOption, ImageSource::GammaAndColorProfileOption)
: m_decoder(0)
{
}
ImageSource::~ImageSource()
{
clear(true);
}
void ImageSource::clear(bool destroyAllFrames, size_t, SharedBuffer* data, bool allDataReceived)
{
if (!destroyAllFrames)
return;
if (m_decoder) {
CFRelease(m_decoder);
m_decoder = 0;
}
if (data)
setData(data, allDataReceived);
}
static RetainPtr<CFDictionaryRef> createImageSourceOptions(SubsamplingLevel subsamplingLevel)
{
if (!subsamplingLevel) {
const unsigned numOptions = 3;
const void* keys[numOptions] = { kCGImageSourceShouldCache, kCGImageSourceShouldPreferRGB32, kCGImageSourceSkipMetadata };
const void* values[numOptions] = { kCFBooleanTrue, kCFBooleanTrue, kCFBooleanTrue };
return CFDictionaryCreate(nullptr, keys, values, numOptions, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
}
short constrainedSubsamplingLevel = std::min<short>(3, std::max<short>(0, subsamplingLevel));
int subsampleInt = 1 << constrainedSubsamplingLevel;
RetainPtr<CFNumberRef> subsampleNumber = adoptCF(CFNumberCreate(nullptr, kCFNumberIntType, &subsampleInt));
const CFIndex numOptions = 4;
const void* keys[numOptions] = { kCGImageSourceShouldCache, kCGImageSourceShouldPreferRGB32, kCGImageSourceSkipMetadata, kCGImageSourceSubsampleFactor };
const void* values[numOptions] = { kCFBooleanTrue, kCFBooleanTrue, kCFBooleanTrue, subsampleNumber.get() };
return adoptCF(CFDictionaryCreate(nullptr, keys, values, numOptions, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
}
static RetainPtr<CFDictionaryRef> imageSourceOptions(SubsamplingLevel subsamplingLevel = 0)
{
if (subsamplingLevel)
return createImageSourceOptions(subsamplingLevel);
static NeverDestroyed<RetainPtr<CFDictionaryRef>> options = createImageSourceOptions(0);
return options;
}
bool ImageSource::initialized() const
{
return m_decoder;
}
void ImageSource::setData(SharedBuffer* data, bool allDataReceived)
{
#if PLATFORM(COCOA)
if (!m_decoder)
m_decoder = CGImageSourceCreateIncremental(0);
CGImageSourceUpdateData(m_decoder, data->createCFData().get(), allDataReceived);
#else
if (!m_decoder)
m_decoder = CGImageSourceCreateIncremental(0);
data->ref();
CGDataProviderDirectCallbacks providerCallbacks = { 0, 0, 0, sharedBufferGetBytesAtPosition, sharedBufferRelease };
RetainPtr<CGDataProviderRef> dataProvider = adoptCF(CGDataProviderCreateDirect(data, data->size(), &providerCallbacks));
CGImageSourceUpdateDataProvider(m_decoder, dataProvider.get(), allDataReceived);
#endif
}
String ImageSource::filenameExtension() const
{
if (!m_decoder)
return String();
CFStringRef imageSourceType = CGImageSourceGetType(m_decoder);
return WebCore::preferredExtensionForImageSourceType(imageSourceType);
}
SubsamplingLevel ImageSource::subsamplingLevelForScale(float scale) const
{
float clampedScale = std::max<float>(0.125, std::min<float>(1, scale));
int result = ceilf(log2f(1 / clampedScale));
ASSERT(result >=0 && result <= 3);
return result;
}
bool ImageSource::isSizeAvailable()
{
if (CGImageSourceGetStatus(m_decoder) < kCGImageStatusIncomplete)
return false;
RetainPtr<CFDictionaryRef> image0Properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_decoder, 0, imageSourceOptions().get()));
if (!image0Properties)
return false;
return CFDictionaryContainsKey(image0Properties.get(), kCGImagePropertyPixelWidth)
&& CFDictionaryContainsKey(image0Properties.get(), kCGImagePropertyPixelHeight);
}
static ImageOrientation orientationFromProperties(CFDictionaryRef imageProperties)
{
ASSERT(imageProperties);
CFNumberRef orientationProperty = (CFNumberRef)CFDictionaryGetValue(imageProperties, kCGImagePropertyOrientation);
if (!orientationProperty)
return DefaultImageOrientation;
int exifValue;
CFNumberGetValue(orientationProperty, kCFNumberIntType, &exifValue);
return ImageOrientation::fromEXIFValue(exifValue);
}
bool ImageSource::allowSubsamplingOfFrameAtIndex(size_t) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_decoder, 0, imageSourceOptions().get()));
if (!properties)
return false;
CFDictionaryRef jfifProperties = static_cast<CFDictionaryRef>(CFDictionaryGetValue(properties.get(), kCGImagePropertyJFIFDictionary));
if (jfifProperties) {
CFBooleanRef isProgCFBool = static_cast<CFBooleanRef>(CFDictionaryGetValue(jfifProperties, kCGImagePropertyJFIFIsProgressive));
if (isProgCFBool) {
bool isProgressive = CFBooleanGetValue(isProgCFBool);
return !isProgressive;
}
}
return true;
}
IntSize ImageSource::frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel, ImageOrientationDescription description) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_decoder, index, imageSourceOptions(subsamplingLevel).get()));
if (!properties)
return IntSize();
int width = 0;
int height = 0;
CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(properties.get(), kCGImagePropertyPixelWidth);
if (num)
CFNumberGetValue(num, kCFNumberIntType, &width);
num = (CFNumberRef)CFDictionaryGetValue(properties.get(), kCGImagePropertyPixelHeight);
if (num)
CFNumberGetValue(num, kCFNumberIntType, &height);
if ((description.respectImageOrientation() == RespectImageOrientation) && orientationFromProperties(properties.get()).usesWidthAsHeight())
return IntSize(height, width);
return IntSize(width, height);
}
ImageOrientation ImageSource::orientationAtIndex(size_t index) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_decoder, index, imageSourceOptions().get()));
if (!properties)
return DefaultImageOrientation;
return orientationFromProperties(properties.get());
}
IntSize ImageSource::size(ImageOrientationDescription description) const
{
return frameSizeAtIndex(0, 0, description);
}
bool ImageSource::getHotSpot(IntPoint& hotSpot) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_decoder, 0, imageSourceOptions().get()));
if (!properties)
return false;
int x = -1, y = -1;
CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(properties.get(), CFSTR("hotspotX"));
if (!num || !CFNumberGetValue(num, kCFNumberIntType, &x))
return false;
num = (CFNumberRef)CFDictionaryGetValue(properties.get(), CFSTR("hotspotY"));
if (!num || !CFNumberGetValue(num, kCFNumberIntType, &y))
return false;
if (x < 0 || y < 0)
return false;
hotSpot = IntPoint(x, y);
return true;
}
size_t ImageSource::bytesDecodedToDetermineProperties() const
{
return 13088;
}
int ImageSource::repetitionCount()
{
if (!initialized())
return cAnimationLoopOnce;
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyProperties(m_decoder, imageSourceOptions().get()));
if (!properties)
return cAnimationLoopOnce;
CFDictionaryRef gifProperties = (CFDictionaryRef)CFDictionaryGetValue(properties.get(), kCGImagePropertyGIFDictionary);
if (gifProperties) {
CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(gifProperties, kCGImagePropertyGIFLoopCount);
if (!num)
return cAnimationLoopOnce;
int loopCount;
CFNumberGetValue(num, kCFNumberIntType, &loopCount);
return loopCount ? loopCount : cAnimationLoopInfinite;
}
CFDictionaryRef pngProperties = (CFDictionaryRef)CFDictionaryGetValue(properties.get(), kCGImagePropertyPNGDictionary);
if (pngProperties) {
CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(pngProperties, WebCoreCGImagePropertyAPNGLoopCount);
if (!num)
return cAnimationLoopOnce;
int loopCount;
CFNumberGetValue(num, kCFNumberIntType, &loopCount);
return loopCount ? loopCount : cAnimationLoopInfinite;
}
return cAnimationNone;
}
size_t ImageSource::frameCount() const
{
return m_decoder ? CGImageSourceGetCount(m_decoder) : 0;
}
CGImageRef ImageSource::createFrameAtIndex(size_t index, SubsamplingLevel subsamplingLevel)
{
if (!initialized())
return nullptr;
RetainPtr<CGImageRef> image = adoptCF(CGImageSourceCreateImageAtIndex(m_decoder, index, imageSourceOptions(subsamplingLevel).get()));
#if PLATFORM(IOS)
#if COMPILER(CLANG)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
#endif
CGImageSetCachingFlags(image.get(), kCGImageCachingTemporary);
#if COMPILER(CLANG)
#pragma clang diagnostic pop
#endif
#endif // PLATFORM(IOS)
CFStringRef imageUTI = CGImageSourceGetType(m_decoder);
static const CFStringRef xbmUTI = CFSTR("public.xbitmap-image");
if (!imageUTI)
return image.leakRef();
#if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101000
if (CFEqual(imageUTI, kUTTypeGIF)) {
CGImageSetCachingFlags(image.get(), kCGImageCachingTransient);
return image.leakRef();
}
#endif
if (!CFEqual(imageUTI, xbmUTI))
return image.leakRef();
const CGFloat maskingColors[6] = {255, 255, 255, 255, 255, 255};
RetainPtr<CGImageRef> maskedImage = adoptCF(CGImageCreateWithMaskingColors(image.get(), maskingColors));
if (!maskedImage)
return image.leakRef();
return maskedImage.leakRef();
}
bool ImageSource::frameIsCompleteAtIndex(size_t index)
{
ASSERT(frameCount());
return CGImageSourceGetStatusAtIndex(m_decoder, index) == kCGImageStatusComplete;
}
float ImageSource::frameDurationAtIndex(size_t index)
{
if (!initialized())
return 0;
float duration = 0;
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_decoder, index, imageSourceOptions().get()));
if (properties) {
CFDictionaryRef gifProperties = (CFDictionaryRef)CFDictionaryGetValue(properties.get(), kCGImagePropertyGIFDictionary);
if (gifProperties) {
if (CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(gifProperties, kCGImagePropertyGIFUnclampedDelayTime)) {
CFNumberGetValue(num, kCFNumberFloatType, &duration);
} else if (CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(gifProperties, kCGImagePropertyGIFDelayTime)) {
CFNumberGetValue(num, kCFNumberFloatType, &duration);
}
}
CFDictionaryRef pngProperties = (CFDictionaryRef)CFDictionaryGetValue(properties.get(), kCGImagePropertyPNGDictionary);
if (pngProperties) {
if (CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(pngProperties, WebCoreCGImagePropertyAPNGUnclampedDelayTime))
CFNumberGetValue(num, kCFNumberFloatType, &duration);
else if (CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(pngProperties, WebCoreCGImagePropertyAPNGDelayTime))
CFNumberGetValue(num, kCFNumberFloatType, &duration);
}
}
if (duration < 0.011f)
return 0.1f;
return duration;
}
bool ImageSource::frameHasAlphaAtIndex(size_t index)
{
if (!m_decoder)
return false;
if (!frameIsCompleteAtIndex(index))
return true;
CFStringRef imageType = CGImageSourceGetType(m_decoder);
if (!imageType || CFEqual(imageType, CFSTR("public.jpeg")))
return false;
return true;
}
unsigned ImageSource::frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel) const
{
IntSize frameSize = frameSizeAtIndex(index, subsamplingLevel, ImageOrientationDescription(RespectImageOrientation));
return frameSize.width() * frameSize.height() * 4;
}
}
#endif // USE(CG)