Next batch of conversions to use C++ enum class instead of strings for enumerations
[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 #pragma once
27
28 #if ENABLE(MEDIA_SESSION)
29
30 #include "MediaRemoteControls.h"
31 #include "MediaSessionMetadata.h"
32
33 namespace WebCore {
34
35 class Dictionary;
36 class Document;
37 class HTMLMediaElement;
38
39 enum class MediaSessionKind { Content, Transient, TransientSolo, Ambient };
40
41 class MediaSession final : public RefCounted<MediaSession> {
42 public:
43     enum class State { Idle, Active, Interrupted };
44
45     static Ref<MediaSession> create(ScriptExecutionContext& context, MediaSessionKind kind)
46     {
47         return adoptRef(*new MediaSession(context, kind));
48     }
49
50     ~MediaSession();
51
52     MediaSessionKind kind() const { return m_kind; }
53     MediaRemoteControls* controls();
54
55     WEBCORE_EXPORT State currentState() const { return m_currentState; }
56     bool hasActiveMediaElements() const;
57
58     void setMetadata(const Dictionary&);
59
60     void deactivate();
61
62     // Runs the media session invocation algorithm and returns true on success.
63     bool invoke();
64
65     void handleDuckInterruption();
66     void handleIndefinitePauseInterruption();
67     void handlePauseInterruption();
68     void handleUnduckInterruption();
69     void handleUnpauseInterruption();
70
71     void togglePlayback();
72     void skipToNextTrack();
73     void skipToPreviousTrack();
74
75     void controlIsEnabledDidChange();
76
77 private:
78     friend class HTMLMediaElement;
79
80     MediaSession(ScriptExecutionContext&, const String&);
81
82     void addMediaElement(HTMLMediaElement&);
83     void removeMediaElement(HTMLMediaElement&);
84
85     void safelyIterateActiveMediaElements(std::function<void(HTMLMediaElement*)>);
86     void changeActiveMediaElements(std::function<void(void)>);
87     void addActiveMediaElement(HTMLMediaElement&);
88     bool isMediaElementActive(HTMLMediaElement&);
89
90     void releaseInternal();
91
92     State m_currentState { State::Idle };
93     HashSet<HTMLMediaElement*> m_participatingElements;
94     HashSet<HTMLMediaElement*> m_activeParticipatingElements;
95     HashSet<HTMLMediaElement*>* m_iteratedActiveParticipatingElements { nullptr };
96
97     Document& m_document;
98     const MediaSessionKind m_kind;
99     RefPtr<MediaRemoteControls> m_controls;
100     MediaSessionMetadata m_metadata;
101 };
102
103 } // namespace WebCore
104
105 #endif /* ENABLE(MEDIA_SESSION) */