Source/WebCore:
[WebKit-https.git] / Source / WebCore / platform / cocoa / WebPlaybackSessionModelMediaElement.h
1 /*
2  * Copyright (C) 2016-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 #if PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
29
30 #include "EventListener.h"
31 #include "HTMLMediaElementEnums.h"
32 #include "WebPlaybackSessionModel.h"
33 #include <wtf/HashSet.h>
34 #include <wtf/RefPtr.h>
35 #include <wtf/Vector.h>
36
37 namespace WebCore {
38
39 class AudioTrack;
40 class HTMLMediaElement;
41 class TextTrack;
42 class WebPlaybackSessionInterface;
43
44 class WebPlaybackSessionModelMediaElement final : public WebPlaybackSessionModel, public EventListener {
45 public:
46     static Ref<WebPlaybackSessionModelMediaElement> create()
47     {
48         return adoptRef(*new WebPlaybackSessionModelMediaElement());
49     }
50     WEBCORE_EXPORT virtual ~WebPlaybackSessionModelMediaElement();
51     WEBCORE_EXPORT void setMediaElement(HTMLMediaElement*);
52     HTMLMediaElement* mediaElement() const { return m_mediaElement.get(); }
53
54     WEBCORE_EXPORT void handleEvent(WebCore::ScriptExecutionContext*, WebCore::Event*) final;
55     void updateForEventName(const WTF::AtomicString&);
56     bool operator==(const EventListener& rhs) const final { return static_cast<const WebCore::EventListener*>(this) == &rhs; }
57
58     WEBCORE_EXPORT void addClient(WebPlaybackSessionModelClient&);
59     WEBCORE_EXPORT void removeClient(WebPlaybackSessionModelClient&);
60     WEBCORE_EXPORT void play() final;
61     WEBCORE_EXPORT void pause() final;
62     WEBCORE_EXPORT void togglePlayState() final;
63     WEBCORE_EXPORT void beginScrubbing() final;
64     WEBCORE_EXPORT void endScrubbing() final;
65     WEBCORE_EXPORT void seekToTime(double time) final;
66     WEBCORE_EXPORT void fastSeek(double time) final;
67     WEBCORE_EXPORT void beginScanningForward() final;
68     WEBCORE_EXPORT void beginScanningBackward() final;
69     WEBCORE_EXPORT void endScanning() final;
70     WEBCORE_EXPORT void selectAudioMediaOption(uint64_t index) final;
71     WEBCORE_EXPORT void selectLegibleMediaOption(uint64_t index) final;
72     WEBCORE_EXPORT void togglePictureInPicture() final;
73     WEBCORE_EXPORT void toggleMuted() final;
74
75     double duration() const final;
76     double currentTime() const final;
77     double bufferedTime() const final;
78     bool isPlaying() const final;
79     bool isScrubbing() const final { return false; }
80     float playbackRate() const final;
81     Ref<TimeRanges> seekableRanges() const final;
82     bool canPlayFastReverse() const final;
83     Vector<MediaSelectionOption> audioMediaSelectionOptions() const final;
84     uint64_t audioMediaSelectedIndex() const final;
85     Vector<MediaSelectionOption> legibleMediaSelectionOptions() const final;
86     uint64_t legibleMediaSelectedIndex() const final;
87     bool externalPlaybackEnabled() const final;
88     ExternalPlaybackTargetType externalPlaybackTargetType() const final;
89     String externalPlaybackLocalizedDeviceName() const final;
90     bool wirelessVideoPlaybackDisabled() const final;
91     bool isMuted() const final;
92
93 protected:
94     WEBCORE_EXPORT WebPlaybackSessionModelMediaElement();
95
96 private:
97     static const Vector<WTF::AtomicString>& observedEventNames();
98     const WTF::AtomicString& eventNameAll();
99
100     RefPtr<HTMLMediaElement> m_mediaElement;
101     bool m_isListening { false };
102     HashSet<WebPlaybackSessionModelClient*> m_clients;
103     Vector<RefPtr<TextTrack>> m_legibleTracksForMenu;
104     Vector<RefPtr<AudioTrack>> m_audioTracksForMenu;
105     
106     double playbackStartedTime() const;
107     void updateMediaSelectionOptions();
108     void updateMediaSelectionIndices();
109 };
110
111 }
112
113 #endif