3a8c1ccb424212c9ad2f584f1ff582d62d10725b
[WebKit-https.git] / Source / WebCore / platform / audio / MediaSession.h
1 /*
2  * Copyright (C) 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. 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 #ifndef MediaSession_h
27 #define MediaSession_h
28
29 #include "MediaPlayer.h"
30 #include <wtf/Noncopyable.h>
31
32 namespace WebCore {
33
34 class MediaSessionClient;
35
36 class MediaSession {
37 public:
38     static std::unique_ptr<MediaSession> create(MediaSessionClient&);
39
40     MediaSession(MediaSessionClient&);
41     virtual ~MediaSession();
42
43     enum MediaType {
44         None = 0,
45         Video,
46         Audio,
47         WebAudio,
48     };
49     MediaType mediaType() const;
50
51     enum State {
52         Idle,
53         Playing,
54         Paused,
55         Interrupted,
56     };
57     State state() const { return m_state; }
58     void setState(State);
59
60     enum EndInterruptionFlags {
61         NoFlags = 0,
62         MayResumePlaying = 1 << 0,
63     };
64     void beginInterruption();
65     void endInterruption(EndInterruptionFlags);
66
67     void applicationWillEnterForeground() const;
68     void applicationWillEnterBackground() const;
69
70     bool clientWillBeginPlayback();
71     bool clientWillPausePlayback();
72
73     void pauseSession();
74     
75     String title() const;
76     double duration() const;
77     double currentTime() const;
78
79     enum RemoteControlCommandType {
80         NoCommand,
81         PlayCommand,
82         PauseCommand,
83         StopCommand,
84         TogglePlayPauseCommand,
85         BeginSeekingBackwardCommand,
86         EndSeekingBackwardCommand,
87         BeginSeekingForwardCommand,
88         EndSeekingForwardCommand,
89     };
90     bool canReceiveRemoteControlCommands() const;
91     void didReceiveRemoteControlCommand(RemoteControlCommandType);
92
93 protected:
94     MediaSessionClient& client() const { return m_client; }
95
96 private:
97     MediaSessionClient& m_client;
98     State m_state;
99     State m_stateToRestore;
100     bool m_notifyingClient;
101 };
102
103 class MediaSessionClient {
104     WTF_MAKE_NONCOPYABLE(MediaSessionClient);
105 public:
106     MediaSessionClient() { }
107     
108     virtual MediaSession::MediaType mediaType() const = 0;
109     virtual void resumePlayback() = 0;
110     virtual void pausePlayback() = 0;
111
112     virtual String mediaSessionTitle() const { return String(); }
113     virtual double mediaSessionDuration() const { return MediaPlayer::invalidTime(); }
114     virtual double mediaSessionCurrentTime() const { return MediaPlayer::invalidTime(); }
115     
116     virtual bool canReceiveRemoteControlCommands() const = 0;
117     virtual void didReceiveRemoteControlCommand(MediaSession::RemoteControlCommandType) = 0;
118
119 protected:
120     virtual ~MediaSessionClient() { }
121 };
122
123 }
124
125 #endif // MediaSession_h