50e7c2cdee10582b6a97ccd2a775674908dff38c
[WebKit.git] / Source / WebCore / html / HTMLCanvasElement.h
1 /*
2  * Copyright (C) 2004-2018 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
4  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #pragma once
29
30 #include "ActiveDOMObject.h"
31 #include "CanvasBase.h"
32 #include "FloatRect.h"
33 #include "HTMLElement.h"
34 #include "ImageBitmapRenderingContextSettings.h"
35 #include <memory>
36 #include <wtf/Forward.h>
37
38 #if ENABLE(WEBGL)
39 #include "WebGLContextAttributes.h"
40 #endif
41
42 namespace WebCore {
43
44 class BlobCallback;
45 class CanvasRenderingContext;
46 class CanvasRenderingContext2D;
47 class GraphicsContext;
48 class Image;
49 class ImageBuffer;
50 class ImageData;
51 class MediaSample;
52 class MediaStream;
53 class WebGLRenderingContextBase;
54 class GPUCanvasContext;
55 struct UncachedString;
56
57 namespace DisplayList {
58 using AsTextFlags = unsigned;
59 }
60
61 class HTMLCanvasElement final : public HTMLElement, public CanvasBase, public ActiveDOMObject {
62     WTF_MAKE_ISO_ALLOCATED(HTMLCanvasElement);
63 public:
64     static Ref<HTMLCanvasElement> create(Document&);
65     static Ref<HTMLCanvasElement> create(const QualifiedName&, Document&);
66     virtual ~HTMLCanvasElement();
67
68     WEBCORE_EXPORT ExceptionOr<void> setWidth(unsigned);
69     WEBCORE_EXPORT ExceptionOr<void> setHeight(unsigned);
70
71     void setSize(const IntSize& newSize) override;
72
73     CanvasRenderingContext* renderingContext() const final { return m_context.get(); }
74     ExceptionOr<Optional<RenderingContext>> getContext(JSC::JSGlobalObject&, const String& contextId, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
75
76     CanvasRenderingContext* getContext(const String&);
77
78     static bool is2dType(const String&);
79     CanvasRenderingContext2D* createContext2d(const String& type);
80     CanvasRenderingContext2D* getContext2d(const String&);
81
82 #if ENABLE(WEBGL)
83     static bool isWebGLType(const String&);
84     WebGLRenderingContextBase* createContextWebGL(const String&, WebGLContextAttributes&& = { });
85     WebGLRenderingContextBase* getContextWebGL(const String&, WebGLContextAttributes&& = { });
86 #endif
87 #if ENABLE(WEBGPU)
88     static bool isWebGPUType(const String&);
89     GPUCanvasContext* createContextWebGPU(const String&);
90     GPUCanvasContext* getContextWebGPU(const String&);
91 #endif
92
93     static bool isBitmapRendererType(const String&);
94     ImageBitmapRenderingContext* createContextBitmapRenderer(const String&, ImageBitmapRenderingContextSettings&& = { });
95     ImageBitmapRenderingContext* getContextBitmapRenderer(const String&, ImageBitmapRenderingContextSettings&& = { });
96
97     WEBCORE_EXPORT ExceptionOr<UncachedString> toDataURL(const String& mimeType, JSC::JSValue quality);
98     WEBCORE_EXPORT ExceptionOr<UncachedString> toDataURL(const String& mimeType);
99     ExceptionOr<void> toBlob(ScriptExecutionContext&, Ref<BlobCallback>&&, const String& mimeType, JSC::JSValue quality);
100
101     // Used for rendering
102     void didDraw(const FloatRect&) final;
103
104     void paint(GraphicsContext&, const LayoutRect&);
105
106 #if ENABLE(MEDIA_STREAM)
107     RefPtr<MediaSample> toMediaSample();
108     ExceptionOr<Ref<MediaStream>> captureStream(Document&, Optional<double>&& frameRequestRate);
109 #endif
110
111     Image* copiedImage() const final;
112     void clearCopiedImage();
113     RefPtr<ImageData> getImageData();
114     void makePresentationCopy();
115     void clearPresentationCopy();
116
117     SecurityOrigin* securityOrigin() const final;
118
119     bool shouldAccelerate(const IntSize&) const;
120
121     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
122     WEBCORE_EXPORT void setTracksDisplayListReplay(bool);
123     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
124     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
125
126     // FIXME: Only some canvas rendering contexts need an ImageBuffer.
127     // It would be better to have the contexts own the buffers.
128     void setImageBufferAndMarkDirty(std::unique_ptr<ImageBuffer>&&);
129
130     WEBCORE_EXPORT static void setMaxPixelMemoryForTesting(size_t);
131
132 private:
133     HTMLCanvasElement(const QualifiedName&, Document&);
134
135     bool isHTMLCanvasElement() const final { return true; }
136
137     // ActiveDOMObject.
138     const char* activeDOMObjectName() const final;
139     bool virtualHasPendingActivity() const final;
140
141     // EventTarget.
142     void eventListenersDidChange() final;
143
144     void parseAttribute(const QualifiedName&, const AtomString&) final;
145     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
146
147     bool canContainRangeEndPoint() const final;
148     bool canStartSelection() const final;
149
150     void reset();
151
152     void createImageBuffer() const final;
153     void clearImageBuffer() const;
154
155     bool hasCreatedImageBuffer() const final { return m_hasCreatedImageBuffer; }
156
157     void setSurfaceSize(const IntSize&);
158
159     bool paintsIntoCanvasBuffer() const;
160
161     bool isGPUBased() const;
162
163     void refCanvasBase() final { HTMLElement::ref(); }
164     void derefCanvasBase() final { HTMLElement::deref(); }
165
166     ScriptExecutionContext* canvasBaseScriptExecutionContext() const final { return HTMLElement::scriptExecutionContext(); }
167
168     FloatRect m_dirtyRect;
169
170     bool m_ignoreReset { false };
171
172     Optional<bool> m_usesDisplayListDrawing;
173     bool m_tracksDisplayListReplay { false };
174
175     std::unique_ptr<CanvasRenderingContext> m_context;
176
177     // m_hasCreatedImageBuffer means we tried to malloc the buffer. We didn't necessarily get it.
178     mutable bool m_hasCreatedImageBuffer { false };
179     mutable bool m_didClearImageBuffer { false };
180 #if ENABLE(WEBGL)
181     bool m_hasRelevantWebGLEventListener { false };
182 #endif
183
184     mutable RefPtr<Image> m_presentedImage;
185     mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).
186 };
187
188 } // namespace WebCore
189
190 namespace WTF {
191 template<typename ArgType> class TypeCastTraits<const WebCore::HTMLCanvasElement, ArgType, false /* isBaseType */> {
192 public:
193     static bool isOfType(ArgType& node) { return checkTagName(node); }
194 private:
195     static bool checkTagName(const WebCore::CanvasBase& base) { return base.isHTMLCanvasElement(); }
196     static bool checkTagName(const WebCore::HTMLElement& element) { return element.hasTagName(WebCore::HTMLNames::canvasTag); }
197     static bool checkTagName(const WebCore::Node& node) { return node.hasTagName(WebCore::HTMLNames::canvasTag); }
198     static bool checkTagName(const WebCore::EventTarget& target) { return is<WebCore::Node>(target) && checkTagName(downcast<WebCore::Node>(target)); }
199 };
200 }
201