CSS Painting API should allow image values in inputProperties
[WebKit-https.git] / Source / WebCore / html / ImageBitmap.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "JSDOMPromiseDeferred.h"
29 #include "ScriptWrappable.h"
30 #include <wtf/Optional.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Variant.h>
33
34 namespace WebCore {
35
36 class Blob;
37 class HTMLCanvasElement;
38 class HTMLImageElement;
39 class HTMLVideoElement;
40 class ImageBitmapImageObserver;
41 class ImageBuffer;
42 class ImageData;
43 class IntRect;
44 class IntSize;
45 class PendingImageBitmap;
46 class ScriptExecutionContext;
47 class TypedOMCSSImageValue;
48 struct ImageBitmapOptions;
49
50 class ImageBitmap : public ScriptWrappable, public RefCounted<ImageBitmap> {
51 public:
52     using Source = Variant<
53         RefPtr<HTMLImageElement>,
54 #if ENABLE(VIDEO)
55         RefPtr<HTMLVideoElement>,
56 #endif
57         RefPtr<HTMLCanvasElement>,
58         RefPtr<ImageBitmap>,
59 #if ENABLE(CSS_PAINTING_API)
60         RefPtr<TypedOMCSSImageValue>,
61 #endif
62         RefPtr<Blob>,
63         RefPtr<ImageData>
64     >;
65
66     using Promise = DOMPromiseDeferred<IDLInterface<ImageBitmap>>;
67
68     static void createPromise(ScriptExecutionContext&, Source&&, ImageBitmapOptions&&, Promise&&);
69     static void createPromise(ScriptExecutionContext&, Source&&, ImageBitmapOptions&&, int sx, int sy, int sw, int sh, Promise&&);
70
71     static Ref<ImageBitmap> create(IntSize);
72     static Ref<ImageBitmap> create(std::pair<std::unique_ptr<ImageBuffer>, bool>&&);
73
74     ~ImageBitmap();
75
76     unsigned width() const;
77     unsigned height() const;
78     void close();
79
80     bool isDetached() const { return m_detached; }
81
82     ImageBuffer* buffer() { return m_bitmapData.get(); }
83
84     bool originClean() const { return m_originClean; }
85
86     std::unique_ptr<ImageBuffer> transferOwnershipAndClose();
87
88     static Vector<std::pair<std::unique_ptr<ImageBuffer>, bool>> detachBitmaps(Vector<RefPtr<ImageBitmap>>&&);
89
90 private:
91     friend class ImageBitmapImageObserver;
92     friend class PendingImageBitmap;
93
94     static Ref<ImageBitmap> create(std::unique_ptr<ImageBuffer>&&);
95     ImageBitmap(std::unique_ptr<ImageBuffer>&&);
96
97     static void createPromise(ScriptExecutionContext&, RefPtr<HTMLImageElement>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
98 #if ENABLE(VIDEO)
99     static void createPromise(ScriptExecutionContext&, RefPtr<HTMLVideoElement>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
100 #endif
101     static void createPromise(ScriptExecutionContext&, RefPtr<HTMLCanvasElement>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
102     static void createPromise(ScriptExecutionContext&, RefPtr<ImageBitmap>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
103     static void createPromise(ScriptExecutionContext&, RefPtr<Blob>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
104     static void createPromise(ScriptExecutionContext&, RefPtr<ImageData>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
105     static void createPromise(ScriptExecutionContext&, RefPtr<TypedOMCSSImageValue>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
106     static void createFromBuffer(Ref<ArrayBuffer>&&, String mimeType, long long expectedContentLength, const URL&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
107
108     std::unique_ptr<ImageBuffer> m_bitmapData;
109     bool m_detached { false };
110     bool m_originClean { true };
111 };
112
113 }