1200b8781646f61a6f70c46b99bcc8efcf65ad1b
[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 struct ImageBitmapOptions;
48
49 class ImageBitmap : public ScriptWrappable, public RefCounted<ImageBitmap> {
50 public:
51     using Source = Variant<
52         RefPtr<HTMLImageElement>,
53 #if ENABLE(VIDEO)
54         RefPtr<HTMLVideoElement>,
55 #endif
56         RefPtr<HTMLCanvasElement>,
57         RefPtr<ImageBitmap>,
58         RefPtr<Blob>,
59         RefPtr<ImageData>
60     >;
61
62     using Promise = DOMPromiseDeferred<IDLInterface<ImageBitmap>>;
63
64     static void createPromise(ScriptExecutionContext&, Source&&, ImageBitmapOptions&&, Promise&&);
65     static void createPromise(ScriptExecutionContext&, Source&&, ImageBitmapOptions&&, int sx, int sy, int sw, int sh, Promise&&);
66
67     static Ref<ImageBitmap> create(IntSize);
68     static Ref<ImageBitmap> create(std::pair<std::unique_ptr<ImageBuffer>, bool>&&);
69
70     ~ImageBitmap();
71
72     unsigned width() const;
73     unsigned height() const;
74     void close();
75
76     bool isDetached() const { return m_detached; }
77
78     ImageBuffer* buffer() { return m_bitmapData.get(); }
79
80     bool originClean() const { return m_originClean; }
81
82     std::unique_ptr<ImageBuffer> transferOwnershipAndClose();
83
84     static Vector<std::pair<std::unique_ptr<ImageBuffer>, bool>> detachBitmaps(Vector<RefPtr<ImageBitmap>>&&);
85
86 private:
87     friend class ImageBitmapImageObserver;
88     friend class PendingImageBitmap;
89
90     static Ref<ImageBitmap> create(std::unique_ptr<ImageBuffer>&&);
91     ImageBitmap(std::unique_ptr<ImageBuffer>&&);
92
93     static void createPromise(ScriptExecutionContext&, RefPtr<HTMLImageElement>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
94 #if ENABLE(VIDEO)
95     static void createPromise(ScriptExecutionContext&, RefPtr<HTMLVideoElement>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
96 #endif
97     static void createPromise(ScriptExecutionContext&, RefPtr<HTMLCanvasElement>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
98     static void createPromise(ScriptExecutionContext&, RefPtr<ImageBitmap>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
99     static void createPromise(ScriptExecutionContext&, RefPtr<Blob>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
100     static void createPromise(ScriptExecutionContext&, RefPtr<ImageData>&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
101     static void createFromBuffer(Ref<ArrayBuffer>&&, String mimeType, long long expectedContentLength, const URL&, ImageBitmapOptions&&, std::optional<IntRect>, Promise&&);
102
103     std::unique_ptr<ImageBuffer> m_bitmapData;
104     bool m_detached { false };
105     bool m_originClean { true };
106 };
107
108 }