1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
/*
* Copyright (C) 2017 Apple 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 INC. ``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 INC. OR
* 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.
*/
#pragma once
#include "CanvasNoiseInjection.h"
#include "FloatRect.h"
#include "IntSize.h"
#include "PixelBuffer.h"
#include "TaskSource.h"
#include <atomic>
#include <wtf/AbstractRefCountedAndCanMakeWeakPtr.h>
#include <wtf/HashSet.h>
#include <wtf/TypeCasts.h>
#include <wtf/WeakHashSet.h>
namespace WebCore {
class CanvasDisplayBufferObserver;
}
namespace WTF {
template<typename T> struct IsDeprecatedWeakRefSmartPointerException;
template<> struct IsDeprecatedWeakRefSmartPointerException<WebCore::CanvasDisplayBufferObserver> : std::true_type { };
}
namespace WebCore {
class AffineTransform;
class CanvasBase;
class CanvasObserver;
class CanvasRenderingContext;
class Element;
class Event;
class GraphicsContext;
class GraphicsContextStateSaver;
class Image;
class ImageBuffer;
class IntRect;
class ScriptExecutionContext;
class SecurityOrigin;
class WebCoreOpaqueRoot;
struct CSSParserContext;
enum class ShouldApplyPostProcessingToDirtyRect : bool { No, Yes };
class CanvasDisplayBufferObserver : public CanMakeWeakPtr<CanvasDisplayBufferObserver> {
public:
virtual ~CanvasDisplayBufferObserver() = default;
virtual void canvasDisplayBufferPrepared(CanvasBase&) = 0;
};
class CanvasBase : public AbstractRefCountedAndCanMakeWeakPtr<CanvasBase> {
public:
virtual ~CanvasBase();
virtual bool isHTMLCanvasElement() const { return false; }
virtual bool isOffscreenCanvas() const { return false; }
virtual bool isCustomPaintCanvas() const { return false; }
virtual unsigned width() const { return m_size.width(); }
virtual unsigned height() const { return m_size.height(); }
const IntSize& size() const { return m_size; }
ImageBuffer* buffer() const;
virtual void setImageBufferAndMarkDirty(RefPtr<ImageBuffer>&&) { }
RefPtr<ImageBuffer> makeRenderingResultsAvailable(ShouldApplyPostProcessingToDirtyRect = ShouldApplyPostProcessingToDirtyRect::Yes);
size_t memoryCost() const;
#if ENABLE(RESOURCE_USAGE)
size_t externalMemoryCost() const;
#endif
void setOriginClean() { m_originClean = true; }
void setOriginTainted() { m_originClean = false; }
bool originClean() const { return m_originClean; }
virtual SecurityOrigin* securityOrigin() const { return nullptr; }
ScriptExecutionContext* scriptExecutionContext() const { return canvasBaseScriptExecutionContext(); }
virtual CanvasRenderingContext* renderingContext() const = 0;
virtual const CSSParserContext& cssParserContext() const = 0;
void addObserver(CanvasObserver&);
void removeObserver(CanvasObserver&);
bool hasObserver(CanvasObserver&) const;
void notifyObserversCanvasChanged(const FloatRect&);
void notifyObserversCanvasResized();
void notifyObserversCanvasDestroyed(); // Must be called in destruction before clearing m_context.
void addDisplayBufferObserver(CanvasDisplayBufferObserver&);
void removeDisplayBufferObserver(CanvasDisplayBufferObserver&);
void notifyObserversCanvasDisplayBufferPrepared();
bool hasDisplayBufferObservers() const { return !m_displayBufferObservers.isEmptyIgnoringNullReferences(); }
UncheckedKeyHashSet<Element*> cssCanvasClients() const;
// !rect means caller knows the full canvas is invalidated previously.
void didDraw(const std::optional<FloatRect>& rect) { return didDraw(rect, ShouldApplyPostProcessingToDirtyRect::Yes); }
virtual void didDraw(const std::optional<FloatRect>&, ShouldApplyPostProcessingToDirtyRect);
virtual Image* copiedImage() const = 0;
virtual void clearCopiedImage() const = 0;
bool hasActiveInspectorCanvasCallTracer() const;
bool shouldAccelerate(const IntSize&) const;
WEBCORE_EXPORT static void setMaxCanvasAreaForTesting(std::optional<size_t>);
virtual void queueTaskKeepingObjectAlive(TaskSource, Function<void()>&&) = 0;
virtual void dispatchEvent(Event&) = 0;
bool postProcessPixelBufferResults(Ref<PixelBuffer>&&) const;
void recordLastFillText(const String&);
void resetGraphicsContextState() const;
void setNoiseInjectionSalt(NoiseInjectionHashSalt salt) { m_canvasNoiseHashSalt = salt; }
bool havePendingCanvasNoiseInjection() const { return m_canvasNoiseInjection.haveDirtyRects(); }
// FIXME(https://bugs.webkit.org/show_bug.cgi?id=275100): The image buffer from CanvasBase should be moved to CanvasRenderingContext2DBase.
RefPtr<ImageBuffer> allocateImageBuffer() const;
void setHasCreatedImageBuffer(bool hasCreatedImageBuffer) { m_hasCreatedImageBuffer = hasCreatedImageBuffer; }
bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
RefPtr<ImageBuffer> createImageForNoiseInjection() const;
protected:
explicit CanvasBase(IntSize, ScriptExecutionContext&);
virtual ScriptExecutionContext* canvasBaseScriptExecutionContext() const = 0;
virtual void setSize(const IntSize&);
RefPtr<ImageBuffer> setImageBuffer(RefPtr<ImageBuffer>&&) const;
String lastFillText() const { return m_lastFillText; }
void addCanvasNeedingPreparationForDisplayOrFlush();
void removeCanvasNeedingPreparationForDisplayOrFlush();
private:
bool shouldInjectNoiseBeforeReadback() const;
virtual void createImageBuffer() const { }
bool shouldAccelerate(uint64_t area) const;
mutable IntSize m_size;
mutable RefPtr<ImageBuffer> m_imageBuffer;
mutable std::atomic<size_t> m_imageBufferMemoryCost { 0 };
mutable std::unique_ptr<GraphicsContextStateSaver> m_contextStateSaver;
String m_lastFillText;
WeakHashSet<CanvasObserver> m_observers;
WeakHashSet<CanvasDisplayBufferObserver> m_displayBufferObservers;
CanvasNoiseInjection m_canvasNoiseInjection;
Markable<NoiseInjectionHashSalt, IntegralMarkableTraits<NoiseInjectionHashSalt, std::numeric_limits<int64_t>::max()>> m_canvasNoiseHashSalt;
bool m_originClean { true };
// m_hasCreatedImageBuffer means we tried to malloc the buffer. We didn't necessarily get it.
bool m_hasCreatedImageBuffer { false };
#if ASSERT_ENABLED
bool m_didNotifyObserversCanvasDestroyed { false };
#endif
};
WebCoreOpaqueRoot root(CanvasBase*);
} // namespace WebCore
#define SPECIALIZE_TYPE_TRAITS_CANVAS(ToValueTypeName, predicate) \
SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
static bool isType(const WebCore::CanvasBase& canvas) { return canvas.predicate; } \
SPECIALIZE_TYPE_TRAITS_END()
|