WebRTC: [GTK] Add MediaEndpointOwr - an OpenWebRTC WebRTC backend
[WebKit-https.git] / Source / WebCore / platform / mediastream / openwebrtc / MediaEndpointOwr.h
1 /*
2  * Copyright (C) 2015, 2016 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 "MediaEndpoint.h"
36 #include <owr/owr_session.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/RefPtr.h>
39
40 typedef struct _OwrMediaSession OwrMediaSession;
41 typedef struct _OwrMediaSource OwrMediaSource;
42 typedef struct _OwrTransportAgent OwrTransportAgent;
43
44 namespace WebCore {
45
46 class PeerMediaDescription;
47 class RealtimeMediaSourceOwr;
48 class RTCConfigurationPrivate;
49
50 class OwrTransceiver : public RefCounted<OwrTransceiver> {
51 public:
52     static Ref<OwrTransceiver> create(const String& mid, OwrSession* session)
53     {
54         return adoptRef(*new OwrTransceiver(mid, session));
55     }
56     virtual ~OwrTransceiver() { }
57
58     const String& mid() const { return m_mid; }
59     OwrSession* session() const { return m_session; }
60
61     OwrIceState owrIceState() const { return m_owrIceState; }
62     void setOwrIceState(OwrIceState state) { m_owrIceState = state; }
63
64     bool gotEndOfRemoteCandidates() const { return m_gotEndOfRemoteCandidates; }
65     void markGotEndOfRemoteCandidates() { m_gotEndOfRemoteCandidates = true; }
66
67 private:
68     OwrTransceiver(const String& mid, OwrSession* session)
69         : m_mid(mid)
70         , m_session(session)
71     { }
72
73     String m_mid;
74     OwrSession* m_session;
75
76     OwrIceState m_owrIceState { OWR_ICE_STATE_DISCONNECTED };
77     bool m_gotEndOfRemoteCandidates { false };
78 };
79
80 class MediaEndpointOwr : public MediaEndpoint {
81 public:
82     MediaEndpointOwr(MediaEndpointClient&);
83     ~MediaEndpointOwr();
84
85     void setConfiguration(RefPtr<MediaEndpointConfiguration>&&) override;
86
87     void generateDtlsInfo() override;
88     MediaPayloadVector getDefaultAudioPayloads() override;
89     MediaPayloadVector getDefaultVideoPayloads() override;
90     MediaPayloadVector filterPayloads(const MediaPayloadVector& remotePayloads, const MediaPayloadVector& defaultPayloads) override;
91
92     UpdateResult updateReceiveConfiguration(MediaEndpointSessionConfiguration*, bool isInitiator) override;
93     UpdateResult updateSendConfiguration(MediaEndpointSessionConfiguration*, const RealtimeMediaSourceMap&, bool isInitiator) override;
94
95     void addRemoteCandidate(IceCandidate&, const String& mid, const String& ufrag, const String& password) override;
96
97     Ref<RealtimeMediaSource> createMutedRemoteSource(const String& mid, RealtimeMediaSource::Type) override;
98     void replaceMutedRemoteSourceMid(const String&, const String&) final;
99     void replaceSendSource(RealtimeMediaSource&, const String& mid) override;
100
101     void stop() override;
102
103     size_t transceiverIndexForSession(OwrSession*) const;
104     const String& sessionMid(OwrSession*) const;
105     OwrTransceiver* matchTransceiverByMid(const String& mid) const;
106
107     void dispatchNewIceCandidate(const String& mid, RefPtr<IceCandidate>&&);
108     void dispatchGatheringDone(const String& mid);
109     void processIceTransportStateChange(OwrSession*);
110     void dispatchDtlsFingerprint(gchar* privateKey, gchar* certificate, const String& fingerprint, const String& fingerprintFunction);
111     void unmuteRemoteSource(const String& mid, OwrMediaSource*);
112
113 private:
114     enum SessionType { SessionTypeMedia };
115
116     struct TransceiverConfig {
117         SessionType type;
118         bool isDtlsClient;
119         String mid;
120     };
121
122     void prepareSession(OwrSession*, PeerMediaDescription*);
123     void prepareMediaSession(OwrMediaSession*, PeerMediaDescription*, bool isInitiator);
124
125     void ensureTransportAgentAndTransceivers(bool isInitiator, const Vector<TransceiverConfig>&);
126     void internalAddRemoteCandidate(OwrSession*, IceCandidate&, const String& ufrag, const String& password);
127
128     RefPtr<MediaEndpointConfiguration> m_configuration;
129     GRegex* m_helperServerRegEx;
130
131     OwrTransportAgent* m_transportAgent;
132     Vector<RefPtr<OwrTransceiver>> m_transceivers;
133     HashMap<String, RefPtr<RealtimeMediaSourceOwr>> m_mutedRemoteSources;
134
135     MediaEndpointClient& m_client;
136
137     unsigned m_numberOfReceivePreparedSessions;
138     unsigned m_numberOfSendPreparedSessions;
139
140     String m_dtlsPrivateKey;
141     String m_dtlsCertificate;
142 };
143
144 } // namespace WebCore
145
146 #endif // ENABLE(WEB_RTC)