Source/WebCore:
[WebKit-https.git] / Source / WebCore / platform / cocoa / WebPlaybackSessionModel.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 <wtf/Forward.h>
31 #include <wtf/Ref.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 class TimeRanges;
37 class WebPlaybackSessionModelClient;
38 struct MediaSelectionOption;
39
40 class WebPlaybackSessionModel {
41 public:
42     virtual ~WebPlaybackSessionModel() { };
43     virtual void addClient(WebPlaybackSessionModelClient&) = 0;
44     virtual void removeClient(WebPlaybackSessionModelClient&) = 0;
45
46     virtual void play() = 0;
47     virtual void pause() = 0;
48     virtual void togglePlayState() = 0;
49     virtual void beginScrubbing() = 0;
50     virtual void endScrubbing() = 0;
51     virtual void seekToTime(double time) = 0;
52     virtual void fastSeek(double time) = 0;
53     virtual void beginScanningForward() = 0;
54     virtual void beginScanningBackward() = 0;
55     virtual void endScanning() = 0;
56     virtual void selectAudioMediaOption(uint64_t index) = 0;
57     virtual void selectLegibleMediaOption(uint64_t index) = 0;
58     virtual void togglePictureInPicture() = 0;
59     virtual void toggleMuted() = 0;
60
61     enum ExternalPlaybackTargetType { TargetTypeNone, TargetTypeAirPlay, TargetTypeTVOut };
62
63     virtual double playbackStartedTime() const = 0;
64     virtual double duration() const = 0;
65     virtual double currentTime() const = 0;
66     virtual double bufferedTime() const = 0;
67     virtual bool isPlaying() const = 0;
68     virtual bool isScrubbing() const = 0;
69     virtual float playbackRate() const = 0;
70     virtual Ref<TimeRanges> seekableRanges() const = 0;
71     virtual bool canPlayFastReverse() const = 0;
72     virtual Vector<MediaSelectionOption> audioMediaSelectionOptions() const = 0;
73     virtual uint64_t audioMediaSelectedIndex() const = 0;
74     virtual Vector<MediaSelectionOption> legibleMediaSelectionOptions() const = 0;
75     virtual uint64_t legibleMediaSelectedIndex() const = 0;
76     virtual bool externalPlaybackEnabled() const = 0;
77     virtual ExternalPlaybackTargetType externalPlaybackTargetType() const = 0;
78     virtual String externalPlaybackLocalizedDeviceName() const = 0;
79     virtual bool wirelessVideoPlaybackDisabled() const = 0;
80     virtual bool isMuted() const = 0;
81 };
82
83 class WebPlaybackSessionModelClient {
84 public:
85     virtual ~WebPlaybackSessionModelClient() { };
86     virtual void durationChanged(double) { }
87     virtual void currentTimeChanged(double /* currentTime */, double /* anchorTime */) { }
88     virtual void bufferedTimeChanged(double) { }
89     virtual void playbackStartedTimeChanged(double /* playbackStartedTime */) { }
90     virtual void rateChanged(bool /* isPlaying */, float /* playbackRate */) { }
91     virtual void seekableRangesChanged(const TimeRanges&) { }
92     virtual void canPlayFastReverseChanged(bool) { }
93     virtual void audioMediaSelectionOptionsChanged(const Vector<MediaSelectionOption>& /* options */, uint64_t /* selectedIndex */) { }
94     virtual void legibleMediaSelectionOptionsChanged(const Vector<MediaSelectionOption>& /* options */, uint64_t /* selectedIndex */) { }
95     virtual void audioMediaSelectionIndexChanged(uint64_t) { }
96     virtual void legibleMediaSelectionIndexChanged(uint64_t) { }
97     virtual void externalPlaybackChanged(bool /* enabled */, WebPlaybackSessionModel::ExternalPlaybackTargetType, const String& /* localizedDeviceName */) { }
98     virtual void wirelessVideoPlaybackDisabledChanged(bool) { }
99     virtual void mutedChanged(bool) { }
100 };
101
102 }
103
104 #endif // PLATFORM(IOS) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))