#pragma once
#include "Image.h"
#include "Color.h"
#include "ImageObserver.h"
#include "ImageOrientation.h"
#include "ImageSource.h"
#include "IntSize.h"
#if USE(CG) || USE(APPKIT)
#include <wtf/RetainPtr.h>
#endif
#if USE(APPKIT)
OBJC_CLASS NSImage;
#endif
#if PLATFORM(WIN)
typedef struct HBITMAP__ *HBITMAP;
#endif
namespace WebCore {
class Settings;
class Timer;
class BitmapImage final : public Image {
public:
static Ref<BitmapImage> create(NativeImagePtr&& nativeImage, ImageObserver* observer = nullptr)
{
return adoptRef(*new BitmapImage(WTFMove(nativeImage), observer));
}
static Ref<BitmapImage> create(ImageObserver* observer = nullptr)
{
return adoptRef(*new BitmapImage(observer));
}
#if PLATFORM(WIN)
WEBCORE_EXPORT static RefPtr<BitmapImage> create(HBITMAP);
#endif
virtual ~BitmapImage();
void updateFromSettings(const Settings&);
bool hasSingleSecurityOrigin() const override { return true; }
EncodedDataStatus dataChanged(bool allDataReceived) override;
unsigned decodedSize() const { return m_source->decodedSize(); }
EncodedDataStatus encodedDataStatus() const { return m_source->encodedDataStatus(); }
size_t frameCount() const { return m_source->frameCount(); }
RepetitionCount repetitionCount() const { return m_source->repetitionCount(); }
String uti() const override { return m_source->uti(); }
String filenameExtension() const override { return m_source->filenameExtension(); }
std::optional<IntPoint> hotSpot() const override { return m_source->hotSpot(); }
FloatSize size() const override { return m_source->size(); }
IntSize sizeRespectingOrientation() const { return m_source->sizeRespectingOrientation(); }
Color singlePixelSolidColor() const override { return m_source->singlePixelSolidColor(); }
bool frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(size_t index, const DecodingOptions& decodingOptions) const { return m_source->frameIsBeingDecodedAndIsCompatibleWithOptionsAtIndex(index, decodingOptions); }
DecodingStatus frameDecodingStatusAtIndex(size_t index) const { return m_source->frameDecodingStatusAtIndex(index); }
bool frameIsCompleteAtIndex(size_t index) const { return frameDecodingStatusAtIndex(index) == DecodingStatus::Complete; }
bool frameHasAlphaAtIndex(size_t index) const { return m_source->frameHasAlphaAtIndex(index); }
bool frameHasFullSizeNativeImageAtIndex(size_t index, SubsamplingLevel subsamplingLevel) { return m_source->frameHasFullSizeNativeImageAtIndex(index, subsamplingLevel); }
bool frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(size_t index, const std::optional<SubsamplingLevel>& subsamplingLevel, const DecodingOptions& decodingOptions) { return m_source->frameHasDecodedNativeImageCompatibleWithOptionsAtIndex(index, subsamplingLevel, decodingOptions); }
SubsamplingLevel frameSubsamplingLevelAtIndex(size_t index) const { return m_source->frameSubsamplingLevelAtIndex(index); }
Seconds frameDurationAtIndex(size_t index) const { return m_source->frameDurationAtIndex(index); }
ImageOrientation frameOrientationAtIndex(size_t index) const { return m_source->frameOrientationAtIndex(index); }
size_t currentFrame() const { return m_currentFrame; }
bool currentFrameKnownToBeOpaque() const override { return !frameHasAlphaAtIndex(currentFrame()); }
ImageOrientation orientationForCurrentFrame() const override { return frameOrientationAtIndex(currentFrame()); }
bool canAnimate() const;
bool shouldUseAsyncDecodingForAnimatedImagesForTesting() const { return m_frameDecodingDurationForTesting > 0_s; }
void setFrameDecodingDurationForTesting(Seconds duration) { m_frameDecodingDurationForTesting = duration; }
bool canUseAsyncDecodingForLargeImages() const;
bool shouldUseAsyncDecodingForAnimatedImages() const;
void setClearDecoderAfterAsyncFrameRequestForTesting(bool value) { m_clearDecoderAfterAsyncFrameRequestForTesting = value; }
void setLargeImageAsyncDecodingEnabledForTesting(bool enabled) { m_largeImageAsyncDecodingEnabledForTesting = enabled; }
bool isLargeImageAsyncDecodingEnabledForTesting() const { return m_largeImageAsyncDecodingEnabledForTesting; }
WEBCORE_EXPORT unsigned decodeCountForTesting() const;
#if USE(APPKIT)
NSImage *nsImage() override;
RetainPtr<NSImage> snapshotNSImage() override;
#endif
#if PLATFORM(COCOA)
CFDataRef tiffRepresentation() override;
#endif
#if PLATFORM(WIN)
bool getHBITMAP(HBITMAP) override;
bool getHBITMAPOfSize(HBITMAP, const IntSize*) override;
#endif
#if PLATFORM(GTK)
GdkPixbuf* getGdkPixbuf() override;
#endif
WEBCORE_EXPORT NativeImagePtr nativeImage(const GraphicsContext* = nullptr) override;
NativeImagePtr nativeImageForCurrentFrame(const GraphicsContext* = nullptr) override;
#if USE(CG)
NativeImagePtr nativeImageOfSize(const IntSize&, const GraphicsContext* = nullptr) override;
Vector<NativeImagePtr> framesNativeImages() override;
#endif
protected:
WEBCORE_EXPORT BitmapImage(NativeImagePtr&&, ImageObserver* = nullptr);
WEBCORE_EXPORT BitmapImage(ImageObserver* = nullptr);
NativeImagePtr frameImageAtIndex(size_t index) { return m_source->frameImageAtIndex(index); }
NativeImagePtr frameImageAtIndexCacheIfNeeded(size_t, SubsamplingLevel = SubsamplingLevel::Default, const GraphicsContext* = nullptr);
void destroyDecodedData(bool destroyAll = true) override;
void destroyDecodedDataIfNecessary(bool destroyAll = true);
ImageDrawResult draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, DecodingMode, ImageOrientationDescription) override;
void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendModeNormal) override;
#if PLATFORM(WIN)
void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) override;
#endif
enum class StartAnimationStatus { CannotStart, IncompleteData, TimerActive, DecodingActive, Started };
bool isAnimated() const override { return m_source->frameCount() > 1; }
bool shouldAnimate() const;
void startAnimation() override { internalStartAnimation(); }
StartAnimationStatus internalStartAnimation();
void advanceAnimation();
void internalAdvanceAnimation();
bool isAnimating() const final;
void stopAnimation() override;
void resetAnimation() override;
void invalidatePlatformData();
#if !ASSERT_DISABLED
bool notSolidColor() override;
#endif
#if PLATFORM(COCOA)
RetainPtr<CFDataRef> tiffRepresentation(const Vector<NativeImagePtr>&);
#endif
private:
void clearTimer();
void startTimer(Seconds delay);
SubsamplingLevel subsamplingLevelForScaleFactor(GraphicsContext&, const FloatSize& scaleFactor);
bool canDestroyDecodedData();
void setCurrentFrameDecodingStatusIfNecessary(DecodingStatus);
bool isBitmapImage() const override { return true; }
void decode(WTF::Function<void()>&&) override;
void callDecodingCallbacks();
void imageFrameAvailableAtIndex(size_t) override;
void dump(WTF::TextStream&) const override;
static const unsigned LargeAnimationCutoff = 30 * 1024 * 1024;
mutable Ref<ImageSource> m_source;
size_t m_currentFrame { 0 }; SubsamplingLevel m_currentSubsamplingLevel { SubsamplingLevel::Default };
DecodingStatus m_currentFrameDecodingStatus { DecodingStatus::Invalid };
std::unique_ptr<Timer> m_frameTimer;
RepetitionCount m_repetitionsComplete { RepetitionCountNone }; MonotonicTime m_desiredFrameStartTime;
std::unique_ptr<Vector<Function<void()>, 1>> m_decodingCallbacks;
Seconds m_frameDecodingDurationForTesting;
MonotonicTime m_desiredFrameDecodeTimeForTesting;
bool m_animationFinished { false };
#if PLATFORM(IOS)
bool m_allowSubsampling { true };
#else
bool m_allowSubsampling { false };
#endif
bool m_allowAnimatedImageAsyncDecoding { false };
bool m_showDebugBackground { false };
bool m_clearDecoderAfterAsyncFrameRequestForTesting { false };
bool m_largeImageAsyncDecodingEnabledForTesting { false };
#if !LOG_DISABLED
size_t m_lateFrameCount { 0 };
size_t m_earlyFrameCount { 0 };
size_t m_cachedFrameCount { 0 };
#endif
unsigned m_decodeCountForTesting { 0 };
#if USE(APPKIT)
mutable RetainPtr<NSImage> m_nsImage; #endif
#if USE(CG)
mutable RetainPtr<CFDataRef> m_tiffRep; #endif
RefPtr<Image> m_cachedImage;
};
}
SPECIALIZE_TYPE_TRAITS_IMAGE(BitmapImage)