ImageDecoderCG.cpp [plain text]
#include "config.h"
#include "ImageDecoderCG.h"
#if USE(CG)
#include "ImageOrientation.h"
#include "IntPoint.h"
#include "IntSize.h"
#include "Logging.h"
#include "SharedBuffer.h"
#include <wtf/NeverDestroyed.h>
#if !PLATFORM(IOS)
#include <ApplicationServices/ApplicationServices.h>
#else
#include "CoreGraphicsSPI.h"
#include <ImageIO/ImageIO.h>
#endif
#if USE(APPLE_INTERNAL_SDK)
#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");
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;
}
static ImageOrientation orientationFromProperties(CFDictionaryRef imageProperties)
{
ASSERT(imageProperties);
CFNumberRef orientationProperty = (CFNumberRef)CFDictionaryGetValue(imageProperties, kCGImagePropertyOrientation);
if (!orientationProperty)
return ImageOrientation();
int exifValue;
CFNumberGetValue(orientationProperty, kCFNumberIntType, &exifValue);
return ImageOrientation::fromEXIFValue(exifValue);
}
#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
ImageDecoder::ImageDecoder()
{
m_nativeDecoder = adoptCF(CGImageSourceCreateIncremental(nullptr));
}
size_t ImageDecoder::bytesDecodedToDetermineProperties()
{
return 13088;
}
String ImageDecoder::filenameExtension() const
{
CFStringRef imageSourceType = CGImageSourceGetType(m_nativeDecoder.get());
return WebCore::preferredExtensionForImageSourceType(imageSourceType);
}
bool ImageDecoder::isSizeAvailable() const
{
if (CGImageSourceGetStatus(m_nativeDecoder.get()) < kCGImageStatusIncomplete)
return false;
RetainPtr<CFDictionaryRef> image0Properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_nativeDecoder.get(), 0, imageSourceOptions().get()));
if (!image0Properties)
return false;
return CFDictionaryContainsKey(image0Properties.get(), kCGImagePropertyPixelWidth)
&& CFDictionaryContainsKey(image0Properties.get(), kCGImagePropertyPixelHeight);
}
IntSize ImageDecoder::size() const
{
if (m_size.isEmpty())
m_size = frameSizeAtIndex(0, 0);
return m_size;
}
size_t ImageDecoder::frameCount() const
{
return CGImageSourceGetCount(m_nativeDecoder.get());
}
int ImageDecoder::repetitionCount() const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyProperties(m_nativeDecoder.get(), 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;
}
Optional<IntPoint> ImageDecoder::hotSpot() const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_nativeDecoder.get(), 0, imageSourceOptions().get()));
if (!properties)
return Nullopt;
int x = -1, y = -1;
CFNumberRef num = (CFNumberRef)CFDictionaryGetValue(properties.get(), CFSTR("hotspotX"));
if (!num || !CFNumberGetValue(num, kCFNumberIntType, &x))
return Nullopt;
num = (CFNumberRef)CFDictionaryGetValue(properties.get(), CFSTR("hotspotY"));
if (!num || !CFNumberGetValue(num, kCFNumberIntType, &y))
return Nullopt;
if (x < 0 || y < 0)
return Nullopt;
return IntPoint(x, y);
}
IntSize ImageDecoder::frameSizeAtIndex(size_t index, SubsamplingLevel subsamplingLevel) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_nativeDecoder.get(), index, imageSourceOptions(subsamplingLevel).get()));
if (!properties)
return { };
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);
return IntSize(width, height);
}
bool ImageDecoder::frameIsCompleteAtIndex(size_t index) const
{
ASSERT(frameCount());
return CGImageSourceGetStatusAtIndex(m_nativeDecoder.get(), index) == kCGImageStatusComplete;
}
ImageOrientation ImageDecoder::orientationAtIndex(size_t index) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_nativeDecoder.get(), index, imageSourceOptions().get()));
if (!properties)
return ImageOrientation();
return orientationFromProperties(properties.get());
}
float ImageDecoder::frameDurationAtIndex(size_t index) const
{
float duration = 0;
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_nativeDecoder.get(), 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 ImageDecoder::allowSubsamplingOfFrameAtIndex(size_t) const
{
RetainPtr<CFDictionaryRef> properties = adoptCF(CGImageSourceCopyPropertiesAtIndex(m_nativeDecoder.get(), 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;
}
bool ImageDecoder::frameHasAlphaAtIndex(size_t index) const
{
if (!frameIsCompleteAtIndex(index))
return true;
CFStringRef imageType = CGImageSourceGetType(m_nativeDecoder.get());
if (!imageType || CFEqual(imageType, CFSTR("public.jpeg")))
return false;
return true;
}
unsigned ImageDecoder::frameBytesAtIndex(size_t index, SubsamplingLevel subsamplingLevel) const
{
IntSize frameSize = frameSizeAtIndex(index, subsamplingLevel);
return frameSize.area() * 4;
}
NativeImagePtr ImageDecoder::createFrameImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) const
{
LOG(Images, "ImageDecoder %p createFrameImageAtIndex %lu", this, index);
RetainPtr<CGImageRef> image = adoptCF(CGImageSourceCreateImageAtIndex(m_nativeDecoder.get(), 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_nativeDecoder.get());
static const CFStringRef xbmUTI = CFSTR("public.xbitmap-image");
if (!imageUTI)
return image;
if (!CFEqual(imageUTI, xbmUTI))
return image;
const CGFloat maskingColors[6] = {255, 255, 255, 255, 255, 255};
RetainPtr<CGImageRef> maskedImage = adoptCF(CGImageCreateWithMaskingColors(image.get(), maskingColors));
return maskedImage ? maskedImage : image;
}
void ImageDecoder::setData(CFDataRef data, bool allDataReceived)
{
CGImageSourceUpdateData(m_nativeDecoder.get(), data, allDataReceived);
}
void ImageDecoder::setData(SharedBuffer& data, bool allDataReceived)
{
#if PLATFORM(COCOA)
setData(data.createCFData().get(), allDataReceived);
#else
data.ref();
CGDataProviderDirectCallbacks providerCallbacks = { 0, 0, 0, sharedBufferGetBytesAtPosition, sharedBufferRelease };
RetainPtr<CGDataProviderRef> dataProvider = adoptCF(CGDataProviderCreateDirect(&data, data.size(), &providerCallbacks));
CGImageSourceUpdateDataProvider(m_nativeDecoder.get(), dataProvider.get(), allDataReceived);
#endif
}
}
#endif // USE(CG)