Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
| 11 | #ifndef PC_RTPTRANSCEIVER_H_ |
| 12 | #define PC_RTPTRANSCEIVER_H_ |
| 13 | |
| 14 | #include <string> |
| 15 | #include <vector> |
| 16 | |
| 17 | #include "api/rtptransceiverinterface.h" |
| 18 | #include "pc/rtpreceiver.h" |
| 19 | #include "pc/rtpsender.h" |
| 20 | |
| 21 | namespace webrtc { |
| 22 | |
| 23 | // Implementation of the public RtpTransceiverInterface. |
| 24 | // |
| 25 | // The RtpTransceiverInterface is only intended to be used with a PeerConnection |
| 26 | // that enables Unified Plan SDP. Thus, the methods that only need to implement |
| 27 | // public API features and are not used internally can assume exactly one sender |
| 28 | // and receiver. |
| 29 | // |
| 30 | // Since the RtpTransceiver is used internally by PeerConnection for tracking |
| 31 | // RtpSenders, RtpReceivers, and BaseChannels, and PeerConnection needs to be |
| 32 | // backwards compatible with Plan B SDP, this implementation is more flexible |
| 33 | // than that required by the WebRTC specification. |
| 34 | // |
| 35 | // With Plan B SDP, an RtpTransceiver can have any number of senders and |
| 36 | // receivers which map to a=ssrc lines in the m= section. |
| 37 | // With Unified Plan SDP, an RtpTransceiver will have exactly one sender and one |
| 38 | // receiver which are encapsulated by the m= section. |
| 39 | // |
| 40 | // This class manages the RtpSenders, RtpReceivers, and BaseChannel associated |
| 41 | // with this m= section. Since the transceiver, senders, and receivers are |
| 42 | // reference counted and can be referenced from JavaScript (in Chromium), these |
| 43 | // objects must be ready to live for an arbitrary amount of time. The |
| 44 | // BaseChannel is not reference counted and is owned by the ChannelManager, so |
| 45 | // the PeerConnection must take care of creating/deleting the BaseChannel and |
| 46 | // setting the channel reference in the transceiver to null when it has been |
| 47 | // deleted. |
| 48 | // |
| 49 | // The RtpTransceiver is specialized to either audio or video according to the |
| 50 | // MediaType specified in the constructor. Audio RtpTransceivers will have |
| 51 | // AudioRtpSenders, AudioRtpReceivers, and a VoiceChannel. Video RtpTransceivers |
| 52 | // will have VideoRtpSenders, VideoRtpReceivers, and a VideoChannel. |
| 53 | class RtpTransceiver final |
Steve Anton | 6077675 | 2018-01-10 11:51:34 -0800 | [diff] [blame^] | 54 | : public rtc::RefCountedObject<RtpTransceiverInterface>, |
| 55 | public sigslot::has_slots<> { |
Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 56 | public: |
Steve Anton | 79e7960 | 2017-11-20 10:25:56 -0800 | [diff] [blame] | 57 | // Construct a Plan B-style RtpTransceiver with no senders, receivers, or |
| 58 | // channel set. |
Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 59 | // |media_type| specifies the type of RtpTransceiver (and, by transitivity, |
| 60 | // the type of senders, receivers, and channel). Can either by audio or video. |
| 61 | explicit RtpTransceiver(cricket::MediaType media_type); |
Steve Anton | 79e7960 | 2017-11-20 10:25:56 -0800 | [diff] [blame] | 62 | // Construct a Unified Plan-style RtpTransceiver with the given sender and |
| 63 | // receiver. The media type will be derived from the media types of the sender |
| 64 | // and receiver. The sender and receiver should have the same media type. |
| 65 | RtpTransceiver( |
| 66 | rtc::scoped_refptr<RtpSenderProxyWithInternal<RtpSenderInternal>> sender, |
| 67 | rtc::scoped_refptr<RtpReceiverProxyWithInternal<RtpReceiverInternal>> |
| 68 | receiver); |
Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 69 | ~RtpTransceiver() override; |
| 70 | |
| 71 | cricket::MediaType media_type() const { return media_type_; } |
| 72 | |
| 73 | // Returns the Voice/VideoChannel set for this transceiver. May be null if |
| 74 | // the transceiver is not in the currently set local/remote description. |
| 75 | cricket::BaseChannel* channel() const { return channel_; } |
| 76 | |
| 77 | // Sets the Voice/VideoChannel. The caller must pass in the correct channel |
| 78 | // implementation based on the type of the transceiver. |
| 79 | void SetChannel(cricket::BaseChannel* channel); |
| 80 | |
| 81 | // Adds an RtpSender of the appropriate type to be owned by this transceiver. |
| 82 | // Must not be null. |
| 83 | void AddSender( |
| 84 | rtc::scoped_refptr<RtpSenderProxyWithInternal<RtpSenderInternal>> sender); |
| 85 | |
| 86 | // Removes the given RtpSender. Returns false if the sender is not owned by |
| 87 | // this transceiver. |
| 88 | bool RemoveSender(RtpSenderInterface* sender); |
| 89 | |
| 90 | // Returns a vector of the senders owned by this transceiver. |
| 91 | std::vector<rtc::scoped_refptr<RtpSenderProxyWithInternal<RtpSenderInternal>>> |
| 92 | senders() const { |
| 93 | return senders_; |
| 94 | } |
| 95 | |
| 96 | // Adds an RtpReceiver of the appropriate type to be owned by this |
| 97 | // transceiver. Must not be null. |
| 98 | void AddReceiver( |
| 99 | rtc::scoped_refptr<RtpReceiverProxyWithInternal<RtpReceiverInternal>> |
| 100 | receiver); |
| 101 | |
| 102 | // Removes the given RtpReceiver. Returns false if the sender is not owned by |
| 103 | // this transceiver. |
| 104 | bool RemoveReceiver(RtpReceiverInterface* receiver); |
| 105 | |
| 106 | // Returns a vector of the receivers owned by this transceiver. |
| 107 | std::vector< |
| 108 | rtc::scoped_refptr<RtpReceiverProxyWithInternal<RtpReceiverInternal>>> |
| 109 | receivers() const { |
| 110 | return receivers_; |
| 111 | } |
| 112 | |
Steve Anton | f9381f0 | 2017-12-14 10:23:57 -0800 | [diff] [blame] | 113 | // Returns the backing object for the transceiver's Unified Plan sender. |
| 114 | rtc::scoped_refptr<RtpSenderInternal> sender_internal() const; |
| 115 | |
| 116 | // Returns the backing object for the transceiver's Unified Plan receiver. |
| 117 | rtc::scoped_refptr<RtpReceiverInternal> receiver_internal() const; |
| 118 | |
Steve Anton | dcc3c02 | 2017-12-22 16:02:54 -0800 | [diff] [blame] | 119 | // RtpTransceivers are not associated until they have a corresponding media |
| 120 | // section set in SetLocalDescription or SetRemoteDescription. Therefore, |
| 121 | // when setting a local offer we need a way to remember which transceiver was |
| 122 | // used to create which media section in the offer. Storing the mline index |
| 123 | // in CreateOffer is specified in JSEP to allow us to do that. |
| 124 | rtc::Optional<size_t> mline_index() const { return mline_index_; } |
| 125 | void set_mline_index(rtc::Optional<size_t> mline_index) { |
| 126 | mline_index_ = mline_index; |
| 127 | } |
| 128 | |
| 129 | // Sets the MID for this transceiver. If the MID is not null, then the |
| 130 | // transceiver is considered "associated" with the media section that has the |
| 131 | // same MID. |
| 132 | void set_mid(const rtc::Optional<std::string>& mid) { mid_ = mid; } |
| 133 | |
| 134 | // Sets the intended direction for this transceiver. Intended to be used |
| 135 | // internally over SetDirection since this does not trigger a negotiation |
| 136 | // needed callback. |
| 137 | void set_direction(RtpTransceiverDirection direction) { |
| 138 | direction_ = direction; |
| 139 | } |
| 140 | |
| 141 | // Sets the current direction for this transceiver as negotiated in an offer/ |
| 142 | // answer exchange. The current direction is null before an answer with this |
| 143 | // transceiver has been set. |
| 144 | void set_current_direction(RtpTransceiverDirection direction); |
| 145 | |
Steve Anton | f9381f0 | 2017-12-14 10:23:57 -0800 | [diff] [blame] | 146 | // According to JSEP rules for SetRemoteDescription, RtpTransceivers can be |
| 147 | // reused only if they were added by AddTrack. |
| 148 | void set_created_by_addtrack(bool created_by_addtrack) { |
| 149 | created_by_addtrack_ = created_by_addtrack; |
| 150 | } |
| 151 | bool created_by_addtrack() const { return created_by_addtrack_; } |
| 152 | |
| 153 | // Returns true if this transceiver has ever had the current direction set to |
| 154 | // sendonly or sendrecv. |
| 155 | bool has_ever_been_used_to_send() const { |
| 156 | return has_ever_been_used_to_send_; |
| 157 | } |
| 158 | |
Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 159 | // RtpTransceiverInterface implementation. |
| 160 | rtc::Optional<std::string> mid() const override; |
| 161 | rtc::scoped_refptr<RtpSenderInterface> sender() const override; |
| 162 | rtc::scoped_refptr<RtpReceiverInterface> receiver() const override; |
| 163 | bool stopped() const override; |
| 164 | RtpTransceiverDirection direction() const override; |
| 165 | void SetDirection(RtpTransceiverDirection new_direction) override; |
| 166 | rtc::Optional<RtpTransceiverDirection> current_direction() const override; |
| 167 | void Stop() override; |
| 168 | void SetCodecPreferences(rtc::ArrayView<RtpCodecCapability> codecs) override; |
| 169 | |
| 170 | private: |
Steve Anton | 6077675 | 2018-01-10 11:51:34 -0800 | [diff] [blame^] | 171 | void OnFirstPacketReceived(cricket::BaseChannel* channel); |
| 172 | |
Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 173 | const bool unified_plan_; |
| 174 | const cricket::MediaType media_type_; |
| 175 | std::vector<rtc::scoped_refptr<RtpSenderProxyWithInternal<RtpSenderInternal>>> |
| 176 | senders_; |
| 177 | std::vector< |
| 178 | rtc::scoped_refptr<RtpReceiverProxyWithInternal<RtpReceiverInternal>>> |
| 179 | receivers_; |
| 180 | |
| 181 | bool stopped_ = false; |
| 182 | RtpTransceiverDirection direction_ = RtpTransceiverDirection::kInactive; |
| 183 | rtc::Optional<RtpTransceiverDirection> current_direction_; |
| 184 | rtc::Optional<std::string> mid_; |
Steve Anton | dcc3c02 | 2017-12-22 16:02:54 -0800 | [diff] [blame] | 185 | rtc::Optional<size_t> mline_index_; |
Steve Anton | f9381f0 | 2017-12-14 10:23:57 -0800 | [diff] [blame] | 186 | bool created_by_addtrack_ = false; |
Steve Anton | f9381f0 | 2017-12-14 10:23:57 -0800 | [diff] [blame] | 187 | bool has_ever_been_used_to_send_ = false; |
Steve Anton | 6e634bf | 2017-11-13 10:44:53 -0800 | [diff] [blame] | 188 | |
| 189 | cricket::BaseChannel* channel_ = nullptr; |
| 190 | }; |
| 191 | |
| 192 | BEGIN_SIGNALING_PROXY_MAP(RtpTransceiver) |
| 193 | PROXY_SIGNALING_THREAD_DESTRUCTOR() |
| 194 | PROXY_CONSTMETHOD0(rtc::Optional<std::string>, mid); |
| 195 | PROXY_CONSTMETHOD0(rtc::scoped_refptr<RtpSenderInterface>, sender); |
| 196 | PROXY_CONSTMETHOD0(rtc::scoped_refptr<RtpReceiverInterface>, receiver); |
| 197 | PROXY_CONSTMETHOD0(bool, stopped); |
| 198 | PROXY_CONSTMETHOD0(RtpTransceiverDirection, direction); |
| 199 | PROXY_METHOD1(void, SetDirection, RtpTransceiverDirection); |
| 200 | PROXY_CONSTMETHOD0(rtc::Optional<RtpTransceiverDirection>, current_direction); |
| 201 | PROXY_METHOD0(void, Stop); |
| 202 | PROXY_METHOD1(void, SetCodecPreferences, rtc::ArrayView<RtpCodecCapability>); |
| 203 | END_PROXY_MAP(); |
| 204 | |
| 205 | } // namespace webrtc |
| 206 | |
| 207 | #endif // PC_RTPTRANSCEIVER_H_ |