[Modern Media Controls] Turn modern media controls on by default
[WebKit-https.git] / Source / WebCore / Modules / mediacontrols / MediaControlsHost.h
1 /*
2  * Copyright (C) 2013, 2014 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(MEDIA_CONTROLS_SCRIPT)
29
30 #include <bindings/ScriptObject.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/Variant.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class AudioTrack;
39 class AudioTrackList;
40 class Element;
41 class HTMLMediaElement;
42 class MediaControlTextTrackContainerElement;
43 class TextTrack;
44 class TextTrackList;
45
46 class MediaControlsHost : public RefCounted<MediaControlsHost> {
47 public:
48     static Ref<MediaControlsHost> create(HTMLMediaElement*);
49     ~MediaControlsHost();
50
51     static const AtomicString& automaticKeyword();
52     static const AtomicString& forcedOnlyKeyword();
53     static const AtomicString& alwaysOnKeyword();
54     static const AtomicString& manualKeyword();
55
56     Vector<RefPtr<TextTrack>> sortedTrackListForMenu(TextTrackList&);
57     Vector<RefPtr<AudioTrack>> sortedTrackListForMenu(AudioTrackList&);
58
59     using TextOrAudioTrack = WTF::Variant<RefPtr<TextTrack>, RefPtr<AudioTrack>>;
60     String displayNameForTrack(const std::optional<TextOrAudioTrack>&);
61
62     TextTrack* captionMenuOffItem();
63     TextTrack* captionMenuAutomaticItem();
64     AtomicString captionDisplayMode() const;
65     void setSelectedTextTrack(TextTrack*);
66     Element* textTrackContainer();
67     void updateTextTrackContainer();
68     bool allowsInlineMediaPlayback() const;
69     bool supportsFullscreen() const;
70     bool isVideoLayerInline() const;
71     bool isInMediaDocument() const;
72     bool userGestureRequired() const;
73     void setPreparedToReturnVideoLayerToInline(bool);
74
75     void updateCaptionDisplaySizes();
76     void enteredFullscreen();
77     void exitedFullscreen();
78
79     String externalDeviceDisplayName() const;
80
81     enum class DeviceType { None, Airplay, Tvout };
82     DeviceType externalDeviceType() const;
83
84     bool controlsDependOnPageScaleFactor() const;
85     void setControlsDependOnPageScaleFactor(bool v);
86
87     String generateUUID() const;
88
89     String shadowRootCSSText() const;
90     String base64StringForIconAndPlatform(const String& iconName, const String& platform) const;
91
92 private:
93     MediaControlsHost(HTMLMediaElement*);
94
95     HTMLMediaElement* m_mediaElement;
96     RefPtr<MediaControlTextTrackContainerElement> m_textTrackContainer;
97 };
98
99 }
100
101 #endif