Inline media controls cut off PiP and fullscreen buttons on cnn.com
[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/Vector.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace WebCore {
36
37 class AudioTrack;
38 class AudioTrackList;
39 class Element;
40 class HTMLMediaElement;
41 class MediaControlTextTrackContainerElement;
42 class TextTrack;
43 class TextTrackList;
44
45 class MediaControlsHost : public RefCounted<MediaControlsHost> {
46 public:
47     static Ref<MediaControlsHost> create(HTMLMediaElement*);
48     ~MediaControlsHost();
49
50     static const AtomicString& automaticKeyword();
51     static const AtomicString& forcedOnlyKeyword();
52     static const AtomicString& alwaysOnKeyword();
53     static const AtomicString& manualKeyword();
54
55     Vector<RefPtr<TextTrack>> sortedTrackListForMenu(TextTrackList*);
56     Vector<RefPtr<AudioTrack>> sortedTrackListForMenu(AudioTrackList*);
57     String displayNameForTrack(TextTrack*);
58     String displayNameForTrack(AudioTrack*);
59     TextTrack* captionMenuOffItem();
60     TextTrack* captionMenuAutomaticItem();
61     AtomicString captionDisplayMode();
62     void setSelectedTextTrack(TextTrack*);
63     Element* textTrackContainer();
64     void updateTextTrackContainer();
65     bool allowsInlineMediaPlayback() const;
66     bool supportsFullscreen();
67     bool isVideoLayerInline();
68     bool userGestureRequired() const;
69     void setPreparedForInline(bool);
70
71     void updateCaptionDisplaySizes();
72     void enteredFullscreen();
73     void exitedFullscreen();
74
75     String externalDeviceDisplayName() const;
76
77     enum class DeviceType { None, Airplay, Tvout };
78     DeviceType externalDeviceType() const;
79
80     bool controlsDependOnPageScaleFactor() const;
81     void setControlsDependOnPageScaleFactor(bool v);
82
83     String generateUUID() const;
84
85 private:
86     MediaControlsHost(HTMLMediaElement*);
87
88     HTMLMediaElement* m_mediaElement;
89     RefPtr<MediaControlTextTrackContainerElement> m_textTrackContainer;
90 };
91
92 }
93
94 #endif