Implementors of memoryCost() need to be thread-safe.
[WebKit-https.git] / Source / WebCore / html / HTMLCanvasElement.h
1 /*
2  * Copyright (C) 2004-2017 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 "FloatRect.h"
31 #include "HTMLElement.h"
32 #include "IntSize.h"
33 #include <memory>
34 #include <wtf/Forward.h>
35 #include <wtf/HashSet.h>
36
37 #if ENABLE(WEBGL)
38 #include "WebGLContextAttributes.h"
39 #endif
40
41 namespace WebCore {
42
43 class BlobCallback;
44 class CanvasRenderingContext;
45 class GraphicsContext;
46 class GraphicsContextStateSaver;
47 class HTMLCanvasElement;
48 class Image;
49 class ImageBuffer;
50 class ImageData;
51 class MediaSample;
52 class MediaStream;
53
54 namespace DisplayList {
55 using AsTextFlags = unsigned;
56 }
57
58 class CanvasObserver {
59 public:
60     virtual ~CanvasObserver() { }
61
62     virtual bool isCanvasObserverProxy() const { return false; }
63
64     virtual void canvasChanged(HTMLCanvasElement&, const FloatRect& changedRect) = 0;
65     virtual void canvasResized(HTMLCanvasElement&) = 0;
66     virtual void canvasDestroyed(HTMLCanvasElement&) = 0;
67 };
68
69 class HTMLCanvasElement final : public HTMLElement {
70 public:
71     static Ref<HTMLCanvasElement> create(Document&);
72     static Ref<HTMLCanvasElement> create(const QualifiedName&, Document&);
73     virtual ~HTMLCanvasElement();
74
75     void addObserver(CanvasObserver&);
76     void removeObserver(CanvasObserver&);
77     HashSet<Element*> cssCanvasClients() const;
78
79     unsigned width() const { return size().width(); }
80     unsigned height() const { return size().height(); }
81
82     const IntSize& size() const { return m_size; }
83
84     WEBCORE_EXPORT void setWidth(unsigned);
85     WEBCORE_EXPORT void setHeight(unsigned);
86
87     void setSize(const IntSize& newSize)
88     { 
89         if (newSize == size())
90             return;
91         m_ignoreReset = true; 
92         setWidth(newSize.width());
93         setHeight(newSize.height());
94         m_ignoreReset = false;
95         reset();
96     }
97
98     CanvasRenderingContext* getContext(const String&);
99
100     static bool is2dType(const String&);
101     CanvasRenderingContext* getContext2d(const String&);
102
103 #if ENABLE(WEBGL)
104     static bool is3dType(const String&);
105     CanvasRenderingContext* getContextWebGL(const String&, WebGLContextAttributes&& = { });
106 #endif
107 #if ENABLE(WEBGPU)
108     static bool isWebGPUType(const String&);
109     CanvasRenderingContext* getContextWebGPU(const String&);
110 #endif
111
112     static String toEncodingMimeType(const String& mimeType);
113     WEBCORE_EXPORT ExceptionOr<String> toDataURL(const String& mimeType, std::optional<double> quality);
114     ExceptionOr<String> toDataURL(const String& mimeType) { return toDataURL(mimeType, std::nullopt); }
115     ExceptionOr<void> toBlob(ScriptExecutionContext&, Ref<BlobCallback>&&, const String& mimeType, JSC::JSValue qualityValue);
116
117     // Used for rendering
118     void didDraw(const FloatRect&);
119     void notifyObserversCanvasChanged(const FloatRect&);
120
121     void paint(GraphicsContext&, const LayoutRect&);
122
123     GraphicsContext* drawingContext() const;
124     GraphicsContext* existingDrawingContext() const;
125
126     CanvasRenderingContext* renderingContext() const { return m_context.get(); }
127
128 #if ENABLE(MEDIA_STREAM)
129     RefPtr<MediaSample> toMediaSample();
130     ExceptionOr<Ref<MediaStream>> captureStream(ScriptExecutionContext&, std::optional<double>&& frameRequestRate);
131 #endif
132
133     ImageBuffer* buffer() const;
134     Image* copiedImage() const;
135     void clearCopiedImage();
136     RefPtr<ImageData> getImageData();
137     void makePresentationCopy();
138     void clearPresentationCopy();
139
140     SecurityOrigin* securityOrigin() const;
141     void setOriginTainted() { m_originClean = false; }
142     bool originClean() const { return m_originClean; }
143
144     AffineTransform baseTransform() const;
145
146     void makeRenderingResultsAvailable();
147     bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
148
149     bool shouldAccelerate(const IntSize&) const;
150
151     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
152     WEBCORE_EXPORT void setTracksDisplayListReplay(bool);
153     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
154     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
155
156     size_t memoryCost() const;
157     size_t externalMemoryCost() const;
158
159 private:
160     HTMLCanvasElement(const QualifiedName&, Document&);
161
162     void parseAttribute(const QualifiedName&, const AtomicString&) final;
163     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
164
165     bool canContainRangeEndPoint() const final;
166     bool canStartSelection() const final;
167
168     void reset();
169
170     void createImageBuffer() const;
171     void clearImageBuffer() const;
172
173     void setSurfaceSize(const IntSize&);
174     void setImageBuffer(std::unique_ptr<ImageBuffer>) const;
175     void releaseImageBufferAndContext();
176
177     bool paintsIntoCanvasBuffer() const;
178
179     bool isGPUBased() const;
180
181     HashSet<CanvasObserver*> m_observers;
182     std::unique_ptr<CanvasRenderingContext> m_context;
183
184     FloatRect m_dirtyRect;
185     IntSize m_size;
186
187     bool m_originClean { true };
188     bool m_ignoreReset { false };
189
190     bool m_usesDisplayListDrawing { false };
191     bool m_tracksDisplayListReplay { false };
192
193     mutable Lock m_imageBufferAssignmentLock;
194     
195     // m_createdImageBuffer means we tried to malloc the buffer.  We didn't necessarily get it.
196     mutable bool m_hasCreatedImageBuffer { false };
197     mutable bool m_didClearImageBuffer { false };
198     mutable std::unique_ptr<ImageBuffer> m_imageBuffer;
199     mutable std::unique_ptr<GraphicsContextStateSaver> m_contextStateSaver;
200     
201     mutable RefPtr<Image> m_presentedImage;
202     mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).
203 };
204
205 } // namespace WebCore