[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / Modules / mediastream / PeerConnectionBackend.h
1 /*
2  * Copyright (C) 2015 Ericsson AB. 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  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer
12  *    in the documentation and/or other materials provided with the
13  *    distribution.
14  * 3. Neither the name of Ericsson nor the names of its contributors
15  *    may be used to endorse or promote products derived from this
16  *    software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #if ENABLE(WEB_RTC)
34
35 #include "JSDOMPromise.h"
36 #include "PeerConnectionStates.h"
37 #include "RTCDataChannel.h"
38
39 namespace WebCore {
40
41 class DOMError;
42 class Event;
43 class MediaStream;
44 class MediaStreamTrack;
45 class PeerConnectionBackend;
46 class RTCConfiguration;
47 class RTCDataChannelHandler;
48 class RTCIceCandidate;
49 class RTCPeerConnection;
50 class RTCRtpReceiver;
51 class RTCRtpSender;
52 class RTCRtpSenderClient;
53 class RTCRtpTransceiver;
54 class RTCSessionDescription;
55 class RTCStatsResponse;
56 class ScriptExecutionContext;
57
58 struct RTCAnswerOptions;
59 struct RTCOfferOptions;
60
61 namespace PeerConnection {
62 typedef DOMPromise<RTCSessionDescription> SessionDescriptionPromise;
63 typedef DOMPromise<void> VoidPromise;
64 typedef DOMPromise<RTCStatsResponse> StatsPromise;
65 }
66
67 typedef std::unique_ptr<PeerConnectionBackend> (*CreatePeerConnectionBackend)(RTCPeerConnection&);
68
69 class PeerConnectionBackend {
70 public:
71     WEBCORE_EXPORT static CreatePeerConnectionBackend create;
72
73     PeerConnectionBackend(RTCPeerConnection& peerConnection) : m_peerConnection(peerConnection) { }
74     virtual ~PeerConnectionBackend() { }
75
76     void createOffer(RTCOfferOptions&&, PeerConnection::SessionDescriptionPromise&&);
77     void createAnswer(RTCAnswerOptions&&, PeerConnection::SessionDescriptionPromise&&);
78     void setLocalDescription(RTCSessionDescription&, PeerConnection::VoidPromise&&);
79     void setRemoteDescription(RTCSessionDescription&, PeerConnection::VoidPromise&&);
80     void addIceCandidate(RTCIceCandidate&, PeerConnection::VoidPromise&&);
81
82     virtual std::unique_ptr<RTCDataChannelHandler> createDataChannelHandler(const String&, const RTCDataChannelInit&) = 0;
83
84     void stop();
85
86     virtual RefPtr<RTCSessionDescription> localDescription() const = 0;
87     virtual RefPtr<RTCSessionDescription> currentLocalDescription() const = 0;
88     virtual RefPtr<RTCSessionDescription> pendingLocalDescription() const = 0;
89
90     virtual RefPtr<RTCSessionDescription> remoteDescription() const = 0;
91     virtual RefPtr<RTCSessionDescription> currentRemoteDescription() const = 0;
92     virtual RefPtr<RTCSessionDescription> pendingRemoteDescription() const = 0;
93
94     virtual void setConfiguration(RTCConfiguration&) = 0;
95
96     virtual void getStats(MediaStreamTrack*, PeerConnection::StatsPromise&&) = 0;
97
98     virtual Vector<RefPtr<MediaStream>> getRemoteStreams() const = 0;
99
100     virtual Ref<RTCRtpReceiver> createReceiver(const String& transceiverMid, const String& trackKind, const String& trackId) = 0;
101     virtual void replaceTrack(RTCRtpSender&, RefPtr<MediaStreamTrack>&&, PeerConnection::VoidPromise&&) = 0;
102
103     virtual bool isNegotiationNeeded() const = 0;
104     virtual void markAsNeedingNegotiation() = 0;
105     virtual void clearNegotiationNeededState() = 0;
106
107     virtual void emulatePlatformEvent(const String& action) = 0;
108
109 protected:
110     void fireICECandidateEvent(RefPtr<RTCIceCandidate>&&);
111     void doneGatheringCandidates();
112
113     void updateSignalingState(PeerConnectionStates::SignalingState);
114
115     void createOfferSucceeded(String&&);
116     void createOfferFailed(Exception&&);
117
118     void createAnswerSucceeded(String&&);
119     void createAnswerFailed(Exception&&);
120
121     void setLocalDescriptionSucceeded();
122     void setLocalDescriptionFailed(Exception&&);
123
124     void setRemoteDescriptionSucceeded();
125     void setRemoteDescriptionFailed(Exception&&);
126
127     void addIceCandidateSucceeded();
128     void addIceCandidateFailed(Exception&&);
129
130 private:
131     virtual void doCreateOffer(RTCOfferOptions&&) = 0;
132     virtual void doCreateAnswer(RTCAnswerOptions&&) = 0;
133     virtual void doSetLocalDescription(RTCSessionDescription&) = 0;
134     virtual void doSetRemoteDescription(RTCSessionDescription&) = 0;
135     virtual void doAddIceCandidate(RTCIceCandidate&) = 0;
136     virtual void doStop() = 0;
137
138 protected:
139     RTCPeerConnection& m_peerConnection;
140
141 private:
142     std::optional<PeerConnection::SessionDescriptionPromise> m_offerAnswerPromise;
143     std::optional<PeerConnection::VoidPromise> m_setDescriptionPromise;
144     std::optional<PeerConnection::VoidPromise> m_addIceCandidatePromise;
145 };
146
147 } // namespace WebCore
148
149 #endif // ENABLE(WEB_RTC)