Clean up RTCPeerConnection IDL
[WebKit-https.git] / Source / WebCore / Modules / mediastream / RTCRtpTransceiver.h
1 /*
2  * Copyright (C) 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 "RTCEnums.h"
36 #include "RTCIceTransport.h"
37 #include "RTCRtpReceiver.h"
38 #include "RTCRtpSender.h"
39 #include "ScriptWrappable.h"
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42 #include <wtf/text/WTFString.h>
43
44 namespace WebCore {
45
46 class RTCRtpTransceiver : public RefCounted<RTCRtpTransceiver>, public ScriptWrappable {
47 public:
48     // This enum is mirrored in RTCPeerConnection.h
49     using Direction = RTCRtpTransceiverDirection;
50
51     static Ref<RTCRtpTransceiver> create(Ref<RTCRtpSender>&& sender, Ref<RTCRtpReceiver>&& receiver) { return adoptRef(*new RTCRtpTransceiver(WTFMove(sender), WTFMove(receiver))); }
52     virtual ~RTCRtpTransceiver() { }
53
54     bool hasSendingDirection() const;
55     void enableSendingDirection();
56     void disableSendingDirection();
57
58     const String& directionString() const;
59     Direction direction() const { return m_direction; }
60     void setDirection(Direction direction) { m_direction = direction; }
61
62     const String& provisionalMid() const { return m_provisionalMid; }
63     void setProvisionalMid(const String& provisionalMid) { m_provisionalMid = provisionalMid; }
64
65     const String& mid() const { return m_mid; }
66     void setMid(const String& mid) { m_mid = mid; }
67
68     RTCRtpSender& sender() { return m_sender.get(); }
69     RTCRtpReceiver& receiver() { return m_receiver.get(); }
70
71     bool stopped() const { return m_stopped; }
72     void stop() { m_stopped = true; }
73
74     // FIXME: Temporary solution to keep track of ICE states for this transceiver. Later, each
75     // sender and receiver will have up to two DTLS transports, which in turn will have an ICE
76     // transport each.
77     RTCIceTransport& iceTransport() { return m_iceTransport.get(); }
78
79     static String getNextMid();
80
81 private:
82     RTCRtpTransceiver(Ref<RTCRtpSender>&&, Ref<RTCRtpReceiver>&&);
83
84     String m_provisionalMid;
85     String m_mid;
86
87     Direction m_direction;
88
89     Ref<RTCRtpSender> m_sender;
90     Ref<RTCRtpReceiver> m_receiver;
91
92     bool m_stopped { false };
93
94     Ref<RTCIceTransport> m_iceTransport;
95 };
96
97 class RtpTransceiverSet {
98 public:
99     const Vector<RefPtr<RTCRtpTransceiver>>& list() const { return m_transceivers; }
100     void append(Ref<RTCRtpTransceiver>&&);
101
102     const Vector<std::reference_wrapper<RTCRtpSender>>& senders() const { return m_senders; }
103     const Vector<std::reference_wrapper<RTCRtpReceiver>>& receivers() const { return m_receivers; }
104
105 private:
106     Vector<RefPtr<RTCRtpTransceiver>> m_transceivers;
107
108     Vector<std::reference_wrapper<RTCRtpSender>> m_senders;
109     Vector<std::reference_wrapper<RTCRtpReceiver>> m_receivers;
110 };
111
112 } // namespace WebCore
113
114 #endif // ENABLE(WEB_RTC)