d8d57ca46be177b90c939b28f7592db64bb5179b
[WebKit-https.git] / Source / WebCore / platform / mediastream / MediaEndpoint.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 "MediaEndpointConfiguration.h"
36 #include "RealtimeMediaSource.h"
37 #include <wtf/HashMap.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 class IceCandidate;
43 class MediaEndpoint;
44 class MediaEndpointClient;
45 class MediaEndpointSessionConfiguration;
46 class MediaPayload;
47 class RealtimeMediaSource;
48
49 typedef std::unique_ptr<MediaEndpoint> (*CreateMediaEndpoint)(MediaEndpointClient&);
50 typedef Vector<RefPtr<MediaPayload>> MediaPayloadVector;
51 typedef HashMap<String, RealtimeMediaSource*> RealtimeMediaSourceMap;
52
53 class MediaEndpoint {
54 public:
55     WEBCORE_EXPORT static CreateMediaEndpoint create;
56     virtual ~MediaEndpoint() { }
57
58     enum class UpdateResult {
59         Success,
60         SuccessWithIceRestart,
61         Failed
62     };
63
64     using IceTransportState = PeerConnectionStates::IceTransportState;
65
66     virtual void setConfiguration(RefPtr<MediaEndpointConfiguration>&&) = 0;
67
68     virtual void generateDtlsInfo() = 0;
69     virtual MediaPayloadVector getDefaultAudioPayloads() = 0;
70     virtual MediaPayloadVector getDefaultVideoPayloads() = 0;
71     virtual MediaPayloadVector filterPayloads(const MediaPayloadVector& remotePayloads, const MediaPayloadVector& defaultPayloads) = 0;
72
73     virtual UpdateResult updateReceiveConfiguration(MediaEndpointSessionConfiguration*, bool isInitiator) = 0;
74     virtual UpdateResult updateSendConfiguration(MediaEndpointSessionConfiguration*, const RealtimeMediaSourceMap&, bool isInitiator) = 0;
75
76     virtual void addRemoteCandidate(IceCandidate&, const String& mid, const String& ufrag, const String& password) = 0;
77
78     virtual Ref<RealtimeMediaSource> createMutedRemoteSource(const String& mid, RealtimeMediaSource::Type) = 0;
79     virtual void replaceSendSource(RealtimeMediaSource&, const String& mid) = 0;
80
81     virtual void stop() = 0;
82
83     virtual void emulatePlatformEvent(const String&) { };
84 };
85
86 class MediaEndpointClient {
87 public:
88     virtual void gotDtlsFingerprint(const String& fingerprint, const String& fingerprintFunction) = 0;
89     virtual void gotIceCandidate(const String& mid, RefPtr<IceCandidate>&&) = 0;
90     virtual void doneGatheringCandidates(const String& mid) = 0;
91     virtual void iceTransportStateChanged(const String& mid, MediaEndpoint::IceTransportState) = 0;
92
93     virtual ~MediaEndpointClient() { }
94 };
95
96 } // namespace WebCore
97
98 #endif // ENABLE(WEB_RTC)