145eeb356d2f3c13baeda00e563a3d2654b21c7e
[WebKit-https.git] / Source / WebCore / html / HTMLVideoElement.h
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #if ENABLE(VIDEO)
29
30 #include "HTMLMediaElement.h"
31 #include <memory>
32
33 namespace WebCore {
34
35 class HTMLImageLoader;
36 class RenderVideo;
37
38 class HTMLVideoElement final : public HTMLMediaElement {
39 public:
40     static Ref<HTMLVideoElement> create(const QualifiedName&, Document&, bool createdByParser);
41
42     WEBCORE_EXPORT unsigned videoWidth() const;
43     WEBCORE_EXPORT unsigned videoHeight() const;
44
45     void webkitEnterFullscreen(ExceptionCode&);
46     void webkitExitFullscreen();
47     bool webkitSupportsFullscreen();
48     bool webkitDisplayingFullscreen();
49
50     void ancestorWillEnterFullscreen() override;
51     
52     // FIXME: Maintain "FullScreen" capitalization scheme for backwards compatibility.
53     // https://bugs.webkit.org/show_bug.cgi?id=36081
54     void webkitEnterFullScreen(ExceptionCode& ec) { webkitEnterFullscreen(ec); }
55     void webkitExitFullScreen() { webkitExitFullscreen(); }
56
57 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
58     bool webkitWirelessVideoPlaybackDisabled() const;
59     void setWebkitWirelessVideoPlaybackDisabled(bool);
60 #endif
61
62 #if ENABLE(MEDIA_STATISTICS)
63     unsigned webkitDecodedFrameCount() const;
64     unsigned webkitDroppedFrameCount() const;
65 #endif
66
67     // Used by canvas to gain raw pixel access
68     void paintCurrentFrameInContext(GraphicsContext&, const FloatRect&);
69
70     NativeImagePtr nativeImageForCurrentTime();
71
72     // Used by WebGL to do GPU-GPU textures copy if possible.
73     // See more details at MediaPlayer::copyVideoTextureToPlatformTexture() defined in Source/WebCore/platform/graphics/MediaPlayer.h.
74     bool copyVideoTextureToPlatformTexture(GraphicsContext3D*, Platform3DObject texture, GC3Denum target, GC3Dint level, GC3Denum internalFormat, GC3Denum format, GC3Denum type, bool premultiplyAlpha, bool flipY);
75
76     bool shouldDisplayPosterImage() const { return displayMode() == Poster || displayMode() == PosterWaitingForVideo; }
77
78     URL posterImageURL() const;
79     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) override;
80
81 #if ENABLE(VIDEO_PRESENTATION_MODE)
82     enum class VideoPresentationMode { Fullscreen, PictureInPicture, Inline };
83     bool webkitSupportsPresentationMode(VideoPresentationMode) const;
84     void webkitSetPresentationMode(VideoPresentationMode);
85     VideoPresentationMode webkitPresentationMode() const;
86     void setFullscreenMode(VideoFullscreenMode);
87     void fullscreenModeChanged(VideoFullscreenMode) override;
88 #endif
89
90 #if PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE)
91     void exitToFullscreenModeWithoutAnimationIfPossible(HTMLMediaElementEnums::VideoFullscreenMode fromMode, HTMLMediaElementEnums::VideoFullscreenMode toMode);
92 #endif
93
94     RenderVideo* renderer() const;
95
96 private:
97     HTMLVideoElement(const QualifiedName&, Document&, bool createdByParser);
98
99     void scheduleResizeEvent() override;
100     void scheduleResizeEventIfSizeChanged() override;
101     bool rendererIsNeeded(const RenderStyle&) override;
102     void didAttachRenderers() override;
103     void parseAttribute(const QualifiedName&, const AtomicString&) override;
104     bool isPresentationAttribute(const QualifiedName&) const override;
105     void collectStyleForPresentationAttribute(const QualifiedName&, const AtomicString&, MutableStyleProperties&) override;
106     bool isVideo() const override { return true; }
107     bool hasVideo() const override { return player() && player()->hasVideo(); }
108     bool supportsFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) const override;
109     bool isURLAttribute(const Attribute&) const override;
110     const AtomicString& imageSourceURL() const override;
111
112     bool hasAvailableVideoFrame() const;
113     void updateDisplayState() override;
114     void didMoveToNewDocument(Document* oldDocument) override;
115     void setDisplayMode(DisplayMode) override;
116
117     PlatformMediaSession::MediaType presentationType() const override { return PlatformMediaSession::Video; }
118
119     std::unique_ptr<HTMLImageLoader> m_imageLoader;
120
121     AtomicString m_defaultPosterURL;
122
123     unsigned m_lastReportedVideoWidth { 0 };
124     unsigned m_lastReportedVideoHeight { 0 };
125 };
126
127 } // namespace WebCore
128
129 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::HTMLVideoElement)
130     static bool isType(const WebCore::HTMLMediaElement& element) { return element.hasTagName(WebCore::HTMLNames::videoTag); }
131     static bool isType(const WebCore::Element& element) { return is<WebCore::HTMLMediaElement>(element) && isType(downcast<WebCore::HTMLMediaElement>(element)); }
132     static bool isType(const WebCore::Node& node) { return is<WebCore::HTMLMediaElement>(node) && isType(downcast<WebCore::HTMLMediaElement>(node)); }
133 SPECIALIZE_TYPE_TRAITS_END()
134
135 #endif // ENABLE(VIDEO)