3132c01af69647d65188c80d31b82d8dc90d8917
[WebKit-https.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 "CanvasBase.h"
31 #include "FloatRect.h"
32 #include "HTMLElement.h"
33 #include "ImageBitmapRenderingContextSettings.h"
34 #include "IntSize.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 CanvasRenderingContext2D;
46 class GraphicsContext;
47 class GraphicsContextStateSaver;
48 class Image;
49 class ImageBuffer;
50 class ImageData;
51 class MediaSample;
52 class MediaStream;
53 class WebGLRenderingContextBase;
54 class GPUCanvasContext;
55 class WebMetalRenderingContext;
56 struct UncachedString;
57
58 namespace DisplayList {
59 using AsTextFlags = unsigned;
60 }
61
62 class HTMLCanvasElement final : public HTMLElement, public CanvasBase {
63     WTF_MAKE_ISO_ALLOCATED(HTMLCanvasElement);
64 public:
65     static Ref<HTMLCanvasElement> create(Document&);
66     static Ref<HTMLCanvasElement> create(const QualifiedName&, Document&);
67     virtual ~HTMLCanvasElement();
68
69     unsigned width() const final { return size().width(); }
70     unsigned height() const final { return size().height(); }
71
72     WEBCORE_EXPORT ExceptionOr<void> setWidth(unsigned);
73     WEBCORE_EXPORT ExceptionOr<void> setHeight(unsigned);
74
75     const IntSize& size() const final { return m_size; }
76
77     void setSize(const IntSize& newSize) override
78     { 
79         if (newSize == size())
80             return;
81         m_ignoreReset = true; 
82         setWidth(newSize.width());
83         setHeight(newSize.height());
84         m_ignoreReset = false;
85         reset();
86     }
87
88     ExceptionOr<Optional<RenderingContext>> getContext(JSC::ExecState&, const String& contextId, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
89
90     CanvasRenderingContext* getContext(const String&);
91
92     static bool is2dType(const String&);
93     CanvasRenderingContext2D* createContext2d(const String& type);
94     CanvasRenderingContext2D* getContext2d(const String&);
95
96 #if ENABLE(WEBGL)
97     static bool isWebGLType(const String&);
98     WebGLRenderingContextBase* createContextWebGL(const String&, WebGLContextAttributes&& = { });
99     WebGLRenderingContextBase* getContextWebGL(const String&, WebGLContextAttributes&& = { });
100 #endif
101 #if ENABLE(WEBGPU)
102     static bool isWebGPUType(const String&);
103     GPUCanvasContext* createContextWebGPU(const String&);
104     GPUCanvasContext* getContextWebGPU(const String&);
105 #endif
106 #if ENABLE(WEBMETAL)
107     static bool isWebMetalType(const String&);
108     WebMetalRenderingContext* createContextWebMetal(const String&);
109     WebMetalRenderingContext* getContextWebMetal(const String&);
110 #endif
111
112     static bool isBitmapRendererType(const String&);
113     ImageBitmapRenderingContext* createContextBitmapRenderer(const String&, ImageBitmapRenderingContextSettings&& = { });
114     ImageBitmapRenderingContext* getContextBitmapRenderer(const String&, ImageBitmapRenderingContextSettings&& = { });
115
116     WEBCORE_EXPORT ExceptionOr<UncachedString> toDataURL(const String& mimeType, JSC::JSValue quality);
117     WEBCORE_EXPORT ExceptionOr<UncachedString> toDataURL(const String& mimeType);
118     ExceptionOr<void> toBlob(ScriptExecutionContext&, Ref<BlobCallback>&&, const String& mimeType, JSC::JSValue quality);
119
120     // Used for rendering
121     void didDraw(const FloatRect&) final;
122
123     void paint(GraphicsContext&, const LayoutRect&);
124
125     GraphicsContext* drawingContext() const final;
126     GraphicsContext* existingDrawingContext() const final;
127
128 #if ENABLE(MEDIA_STREAM)
129     RefPtr<MediaSample> toMediaSample();
130     ExceptionOr<Ref<MediaStream>> captureStream(ScriptExecutionContext&, Optional<double>&& frameRequestRate);
131 #endif
132
133     ImageBuffer* buffer() const;
134     Image* copiedImage() const final;
135     void clearCopiedImage();
136     RefPtr<ImageData> getImageData();
137     void makePresentationCopy();
138     void clearPresentationCopy();
139
140     SecurityOrigin* securityOrigin() const final;
141
142     AffineTransform baseTransform() const final;
143
144     void makeRenderingResultsAvailable() final;
145     bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
146
147     bool shouldAccelerate(const IntSize&) const;
148
149     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
150     WEBCORE_EXPORT void setTracksDisplayListReplay(bool);
151     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
152     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
153
154     size_t memoryCost() const;
155     size_t externalMemoryCost() const;
156
157     // FIXME: Only some canvas rendering contexts need an ImageBuffer.
158     // It would be better to have the contexts own the buffers.
159     void setImageBufferAndMarkDirty(std::unique_ptr<ImageBuffer>&&);
160
161 private:
162     HTMLCanvasElement(const QualifiedName&, Document&);
163
164     bool isHTMLCanvasElement() const final { return true; }
165
166     void parseAttribute(const QualifiedName&, const AtomicString&) final;
167     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
168
169     bool canContainRangeEndPoint() const final;
170     bool canStartSelection() const final;
171
172     void reset();
173
174     void createImageBuffer() const;
175     void clearImageBuffer() const;
176
177     void setSurfaceSize(const IntSize&);
178     void setImageBuffer(std::unique_ptr<ImageBuffer>&&) const;
179     void releaseImageBufferAndContext();
180
181     bool paintsIntoCanvasBuffer() const;
182
183     bool isGPUBased() const;
184
185     void refCanvasBase() final { HTMLElement::ref(); }
186     void derefCanvasBase() final { HTMLElement::deref(); }
187
188     FloatRect m_dirtyRect;
189     mutable IntSize m_size;
190
191     bool m_ignoreReset { false };
192
193     bool m_usesDisplayListDrawing { false };
194     bool m_tracksDisplayListReplay { false };
195
196     mutable Lock m_imageBufferAssignmentLock;
197     
198     // m_createdImageBuffer means we tried to malloc the buffer.  We didn't necessarily get it.
199     mutable bool m_hasCreatedImageBuffer { false };
200     mutable bool m_didClearImageBuffer { false };
201     mutable std::unique_ptr<ImageBuffer> m_imageBuffer;
202     mutable std::unique_ptr<GraphicsContextStateSaver> m_contextStateSaver;
203     
204     mutable RefPtr<Image> m_presentedImage;
205     mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).
206 };
207
208 } // namespace WebCore
209
210 namespace WTF {
211 template<typename ArgType> class TypeCastTraits<const WebCore::HTMLCanvasElement, ArgType, false /* isBaseType */> {
212 public:
213     static bool isOfType(ArgType& node) { return checkTagName(node); }
214 private:
215     static bool checkTagName(const WebCore::CanvasBase& base) { return base.isHTMLCanvasElement(); }
216     static bool checkTagName(const WebCore::HTMLElement& element) { return element.hasTagName(WebCore::HTMLNames::canvasTag); }
217     static bool checkTagName(const WebCore::Node& node) { return node.hasTagName(WebCore::HTMLNames::canvasTag); }
218     static bool checkTagName(const WebCore::EventTarget& target) { return is<WebCore::Node>(target) && checkTagName(downcast<WebCore::Node>(target)); }
219 };
220 }
221