Explicitly keep track of active HTMLMediaElements in MediaSessions.
[WebKit-https.git] / Source / WebCore / Modules / mediasession / MediaSession.h
1 /*
2  * Copyright (C) 2015 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 #ifndef MediaSession_h
27 #define MediaSession_h
28
29 #if ENABLE(MEDIA_SESSION)
30
31 #include "MediaRemoteControls.h"
32
33 namespace WebCore {
34
35 class HTMLMediaElement;
36
37 class MediaSession final : public RefCounted<MediaSession> {
38 public:
39     enum class State {
40         Idle,
41         Active,
42         Interrupted
43     };
44     
45     static Ref<MediaSession> create(ScriptExecutionContext& context, const String& kind)
46     {
47         return adoptRef(*new MediaSession(context, kind));
48     }
49
50     MediaSession(ScriptExecutionContext&, const String&);
51     ~MediaSession();
52
53     String kind() const { return m_kind; }
54     MediaRemoteControls* controls(bool& isNull);
55     
56     State currentState() const { return m_currentState; }
57
58     void releaseSession();
59
60     void togglePlayback();
61
62 private:
63     friend class HTMLMediaElement;
64
65     void addMediaElement(HTMLMediaElement&);
66     void removeMediaElement(HTMLMediaElement&);
67
68     void addActiveMediaElement(HTMLMediaElement&);
69
70     State m_currentState { State::Idle };
71     Vector<HTMLMediaElement*> m_participatingElements;
72     HashSet<HTMLMediaElement*> m_activeParticipatingElements;
73
74     const String m_kind;
75     RefPtr<MediaRemoteControls> m_controls;
76 };
77
78 } // namespace WebCore
79
80 #endif /* ENABLE(MEDIA_SESSION) */
81
82 #endif /* MediaSession_h */