5abad98614470f5f61f81b4060dbf5393c6d5c33
[WebKit-https.git] / Source / WebCore / Modules / mediastream / PeerConnectionBackend.h
1 /*
2  * Copyright (C) 2015 Ericsson AB. All rights reserved.
3  * Copyright (C) 2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer
13  *    in the documentation and/or other materials provided with the
14  *    distribution.
15  * 3. Neither the name of Ericsson nor the names of its contributors
16  *    may be used to endorse or promote products derived from this
17  *    software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #if ENABLE(WEB_RTC)
35
36 #include "JSDOMPromiseDeferred.h"
37 #include "RTCRtpParameters.h"
38 #include "RTCSessionDescription.h"
39 #include "RTCSignalingState.h"
40
41 namespace WebCore {
42
43 class MediaStream;
44 class MediaStreamTrack;
45 class PeerConnectionBackend;
46 class RTCDataChannelHandler;
47 class RTCIceCandidate;
48 class RTCPeerConnection;
49 class RTCRtpReceiver;
50 class RTCRtpSender;
51 class RTCSessionDescription;
52 class RTCStatsReport;
53
54 struct MediaEndpointConfiguration;
55 struct RTCAnswerOptions;
56 struct RTCDataChannelInit;
57 struct RTCOfferOptions;
58
59 namespace PeerConnection {
60 using SessionDescriptionPromise = DOMPromiseDeferred<IDLDictionary<RTCSessionDescription::Init>>;
61 using StatsPromise = DOMPromiseDeferred<IDLInterface<RTCStatsReport>>;
62 }
63
64 using CreatePeerConnectionBackend = std::unique_ptr<PeerConnectionBackend> (*)(RTCPeerConnection&);
65
66 class PeerConnectionBackend {
67 public:
68     WEBCORE_EXPORT static CreatePeerConnectionBackend create;
69
70     PeerConnectionBackend(RTCPeerConnection& peerConnection) : m_peerConnection(peerConnection) { }
71     virtual ~PeerConnectionBackend() { }
72
73     void createOffer(RTCOfferOptions&&, PeerConnection::SessionDescriptionPromise&&);
74     void createAnswer(RTCAnswerOptions&&, PeerConnection::SessionDescriptionPromise&&);
75     void setLocalDescription(RTCSessionDescription&, DOMPromiseDeferred<void>&&);
76     void setRemoteDescription(RTCSessionDescription&, DOMPromiseDeferred<void>&&);
77     void addIceCandidate(RTCIceCandidate*, DOMPromiseDeferred<void>&&);
78
79     virtual std::unique_ptr<RTCDataChannelHandler> createDataChannelHandler(const String&, const RTCDataChannelInit&) = 0;
80
81     void stop();
82
83     virtual RefPtr<RTCSessionDescription> localDescription() const = 0;
84     virtual RefPtr<RTCSessionDescription> currentLocalDescription() const = 0;
85     virtual RefPtr<RTCSessionDescription> pendingLocalDescription() const = 0;
86
87     virtual RefPtr<RTCSessionDescription> remoteDescription() const = 0;
88     virtual RefPtr<RTCSessionDescription> currentRemoteDescription() const = 0;
89     virtual RefPtr<RTCSessionDescription> pendingRemoteDescription() const = 0;
90
91     virtual bool setConfiguration(MediaEndpointConfiguration&&) = 0;
92
93     virtual void getStats(MediaStreamTrack*, Ref<DeferredPromise>&&) = 0;
94
95     virtual Vector<RefPtr<MediaStream>> getRemoteStreams() const = 0;
96
97     virtual Ref<RTCRtpReceiver> createReceiver(const String& transceiverMid, const String& trackKind, const String& trackId) = 0;
98     virtual void replaceTrack(RTCRtpSender&, Ref<MediaStreamTrack>&&, DOMPromiseDeferred<void>&&) = 0;
99     virtual void notifyAddedTrack(RTCRtpSender&) { }
100     virtual void notifyRemovedTrack(RTCRtpSender&) { }
101
102     virtual RTCRtpParameters getParameters(RTCRtpSender&) const { return { }; }
103
104     void markAsNeedingNegotiation();
105     bool isNegotiationNeeded() const { return m_negotiationNeeded; };
106     void clearNegotiationNeededState() { m_negotiationNeeded = false; };
107
108     virtual void emulatePlatformEvent(const String& action) = 0;
109
110     void newICECandidate(String&& sdp, String&& mid);
111     void disableICECandidateFiltering();
112     void enableICECandidateFiltering();
113
114     virtual void applyRotationForOutgoingVideoSources() { }
115
116 protected:
117     void fireICECandidateEvent(RefPtr<RTCIceCandidate>&&);
118     void doneGatheringCandidates();
119
120     void updateSignalingState(RTCSignalingState);
121
122     void createOfferSucceeded(String&&);
123     void createOfferFailed(Exception&&);
124
125     void createAnswerSucceeded(String&&);
126     void createAnswerFailed(Exception&&);
127
128     void setLocalDescriptionSucceeded();
129     void setLocalDescriptionFailed(Exception&&);
130
131     void setRemoteDescriptionSucceeded();
132     void setRemoteDescriptionFailed(Exception&&);
133
134     void addIceCandidateSucceeded();
135     void addIceCandidateFailed(Exception&&);
136
137     String filterSDP(String&&) const;
138
139 private:
140     virtual void doCreateOffer(RTCOfferOptions&&) = 0;
141     virtual void doCreateAnswer(RTCAnswerOptions&&) = 0;
142     virtual void doSetLocalDescription(RTCSessionDescription&) = 0;
143     virtual void doSetRemoteDescription(RTCSessionDescription&) = 0;
144     virtual void doAddIceCandidate(RTCIceCandidate&) = 0;
145     virtual void endOfIceCandidates(DOMPromiseDeferred<void>&& promise) { promise.resolve(); }
146     virtual void doStop() = 0;
147
148 protected:
149     RTCPeerConnection& m_peerConnection;
150
151 private:
152     std::optional<PeerConnection::SessionDescriptionPromise> m_offerAnswerPromise;
153     std::optional<DOMPromiseDeferred<void>> m_setDescriptionPromise;
154     std::optional<DOMPromiseDeferred<void>> m_addIceCandidatePromise;
155
156     bool m_shouldFilterICECandidates { true };
157     struct PendingICECandidate {
158         // Fields described in https://www.w3.org/TR/webrtc/#idl-def-rtcicecandidateinit.
159         String sdp;
160         String mid;
161     };
162     Vector<PendingICECandidate> m_pendingICECandidates;
163
164     bool m_negotiationNeeded { false };
165 };
166
167 } // namespace WebCore
168
169 #endif // ENABLE(WEB_RTC)