onnegotiationneeded should only be called once
[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 "JSDOMPromise.h"
37 #include "RTCRtpParameters.h"
38 #include "RTCSignalingState.h"
39
40 namespace WebCore {
41
42 class MediaStream;
43 class MediaStreamTrack;
44 class PeerConnectionBackend;
45 class RTCDataChannelHandler;
46 class RTCIceCandidate;
47 class RTCPeerConnection;
48 class RTCRtpReceiver;
49 class RTCRtpSender;
50 class RTCSessionDescription;
51 class RTCStatsReport;
52
53 struct MediaEndpointConfiguration;
54 struct RTCAnswerOptions;
55 struct RTCDataChannelInit;
56 struct RTCOfferOptions;
57
58 namespace PeerConnection {
59 using SessionDescriptionPromise = DOMPromise<IDLInterface<RTCSessionDescription>>;
60 using StatsPromise = DOMPromise<IDLInterface<RTCStatsReport>>;
61 }
62
63 using CreatePeerConnectionBackend = std::unique_ptr<PeerConnectionBackend> (*)(RTCPeerConnection&);
64
65 class PeerConnectionBackend {
66 public:
67     WEBCORE_EXPORT static CreatePeerConnectionBackend create;
68
69     PeerConnectionBackend(RTCPeerConnection& peerConnection) : m_peerConnection(peerConnection) { }
70     virtual ~PeerConnectionBackend() { }
71
72     void createOffer(RTCOfferOptions&&, PeerConnection::SessionDescriptionPromise&&);
73     void createAnswer(RTCAnswerOptions&&, PeerConnection::SessionDescriptionPromise&&);
74     void setLocalDescription(RTCSessionDescription&, DOMPromise<void>&&);
75     void setRemoteDescription(RTCSessionDescription&, DOMPromise<void>&&);
76     void addIceCandidate(RTCIceCandidate*, DOMPromise<void>&&);
77
78     virtual std::unique_ptr<RTCDataChannelHandler> createDataChannelHandler(const String&, const RTCDataChannelInit&) = 0;
79
80     void stop();
81
82     virtual RefPtr<RTCSessionDescription> localDescription() const = 0;
83     virtual RefPtr<RTCSessionDescription> currentLocalDescription() const = 0;
84     virtual RefPtr<RTCSessionDescription> pendingLocalDescription() const = 0;
85
86     virtual RefPtr<RTCSessionDescription> remoteDescription() const = 0;
87     virtual RefPtr<RTCSessionDescription> currentRemoteDescription() const = 0;
88     virtual RefPtr<RTCSessionDescription> pendingRemoteDescription() const = 0;
89
90     virtual void setConfiguration(MediaEndpointConfiguration&&) = 0;
91
92     virtual void getStats(MediaStreamTrack*, Ref<DeferredPromise>&&) = 0;
93
94     virtual Vector<RefPtr<MediaStream>> getRemoteStreams() const = 0;
95
96     virtual Ref<RTCRtpReceiver> createReceiver(const String& transceiverMid, const String& trackKind, const String& trackId) = 0;
97     virtual void replaceTrack(RTCRtpSender&, Ref<MediaStreamTrack>&&, DOMPromise<void>&&) = 0;
98     virtual void notifyAddedTrack(RTCRtpSender&) { }
99     virtual void notifyRemovedTrack(RTCRtpSender&) { }
100
101     virtual RTCRtpParameters getParameters(RTCRtpSender&) const { return { }; }
102
103     void markAsNeedingNegotiation();
104     bool isNegotiationNeeded() const { return m_negotiationNeeded; };
105     void clearNegotiationNeededState() { m_negotiationNeeded = false; };
106
107     virtual void emulatePlatformEvent(const String& action) = 0;
108
109     void newICECandidate(String&& sdp, String&& mid);
110     void disableICECandidateFiltering();
111     void enableICECandidateFiltering();
112
113 protected:
114     void fireICECandidateEvent(RefPtr<RTCIceCandidate>&&);
115     void doneGatheringCandidates();
116
117     void updateSignalingState(RTCSignalingState);
118
119     void createOfferSucceeded(String&&);
120     void createOfferFailed(Exception&&);
121
122     void createAnswerSucceeded(String&&);
123     void createAnswerFailed(Exception&&);
124
125     void setLocalDescriptionSucceeded();
126     void setLocalDescriptionFailed(Exception&&);
127
128     void setRemoteDescriptionSucceeded();
129     void setRemoteDescriptionFailed(Exception&&);
130
131     void addIceCandidateSucceeded();
132     void addIceCandidateFailed(Exception&&);
133
134 private:
135     virtual void doCreateOffer(RTCOfferOptions&&) = 0;
136     virtual void doCreateAnswer(RTCAnswerOptions&&) = 0;
137     virtual void doSetLocalDescription(RTCSessionDescription&) = 0;
138     virtual void doSetRemoteDescription(RTCSessionDescription&) = 0;
139     virtual void doAddIceCandidate(RTCIceCandidate&) = 0;
140     virtual void endOfIceCandidates(DOMPromise<void>&& promise) { promise.resolve(); }
141     virtual void doStop() = 0;
142
143 protected:
144     RTCPeerConnection& m_peerConnection;
145
146 private:
147     std::optional<PeerConnection::SessionDescriptionPromise> m_offerAnswerPromise;
148     std::optional<DOMPromise<void>> m_setDescriptionPromise;
149     std::optional<DOMPromise<void>> m_addIceCandidatePromise;
150
151     bool m_shouldFilterICECandidates { true };
152     struct PendingICECandidate {
153         // Fields described in https://www.w3.org/TR/webrtc/#idl-def-rtcicecandidateinit.
154         String sdp;
155         String mid;
156     };
157     Vector<PendingICECandidate> m_pendingICECandidates;
158
159     bool m_negotiationNeeded { false };
160 };
161
162 } // namespace WebCore
163
164 #endif // ENABLE(WEB_RTC)