blob: ef41485898f353375e4c14d003594b546376cbe6 [file] [log] [blame]
ossu7bb87ee2017-01-23 04:56:25 -08001/*
2 * Copyright 2015 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// This file contains classes that implement RtpSenderInterface.
12// An RtpSender associates a MediaStreamTrackInterface with an underlying
13// transport (provided by AudioProviderInterface/VideoProviderInterface)
14
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020015#ifndef PC_RTPSENDER_H_
16#define PC_RTPSENDER_H_
ossu7bb87ee2017-01-23 04:56:25 -080017
18#include <memory>
19#include <string>
Steve Anton36b29d12017-10-30 09:57:42 -070020#include <vector>
ossu7bb87ee2017-01-23 04:56:25 -080021
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020022#include "api/mediastreaminterface.h"
23#include "api/rtpsenderinterface.h"
24#include "rtc_base/basictypes.h"
25#include "rtc_base/criticalsection.h"
Niels Möller6daa2782018-01-23 10:37:42 +010026#include "media/base/audiosource.h"
27#include "media/base/mediachannel.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020028#include "pc/dtmfsender.h"
ossu7bb87ee2017-01-23 04:56:25 -080029
30namespace webrtc {
31
Steve Anton2d8609c2018-01-23 16:38:46 -080032class StatsCollector;
33
ossu7bb87ee2017-01-23 04:56:25 -080034// Internal interface used by PeerConnection.
35class RtpSenderInternal : public RtpSenderInterface {
36 public:
Steve Anton57858b32018-02-15 15:19:50 -080037 // Sets the underlying MediaEngine channel associated with this RtpSender.
38 // SetVoiceMediaChannel should be used for audio RtpSenders and
39 // SetVideoMediaChannel should be used for video RtpSenders. Must call the
40 // appropriate SetXxxMediaChannel(nullptr) before the media channel is
41 // destroyed.
42 virtual void SetVoiceMediaChannel(
43 cricket::VoiceMediaChannel* voice_media_channel) = 0;
44 virtual void SetVideoMediaChannel(
45 cricket::VideoMediaChannel* video_media_channel) = 0;
46
ossu7bb87ee2017-01-23 04:56:25 -080047 // Used to set the SSRC of the sender, once a local description has been set.
48 // If |ssrc| is 0, this indiates that the sender should disconnect from the
49 // underlying transport (this occurs if the sender isn't seen in a local
50 // description).
51 virtual void SetSsrc(uint32_t ssrc) = 0;
52
Steve Anton8ffb9c32017-08-31 15:45:38 -070053 virtual void set_stream_ids(const std::vector<std::string>& stream_ids) = 0;
ossu7bb87ee2017-01-23 04:56:25 -080054
55 virtual void Stop() = 0;
Steve Anton57858b32018-02-15 15:19:50 -080056
57 // Returns an ID that changes every time SetTrack() is called, but
58 // otherwise remains constant. Used to generate IDs for stats.
59 // The special value zero means that no track is attached.
60 virtual int AttachmentId() const = 0;
ossu7bb87ee2017-01-23 04:56:25 -080061};
62
63// LocalAudioSinkAdapter receives data callback as a sink to the local
64// AudioTrack, and passes the data to the sink of AudioSource.
65class LocalAudioSinkAdapter : public AudioTrackSinkInterface,
66 public cricket::AudioSource {
67 public:
68 LocalAudioSinkAdapter();
69 virtual ~LocalAudioSinkAdapter();
70
71 private:
72 // AudioSinkInterface implementation.
73 void OnData(const void* audio_data,
74 int bits_per_sample,
75 int sample_rate,
76 size_t number_of_channels,
77 size_t number_of_frames) override;
78
79 // cricket::AudioSource implementation.
80 void SetSink(cricket::AudioSource::Sink* sink) override;
81
82 cricket::AudioSource::Sink* sink_;
83 // Critical section protecting |sink_|.
84 rtc::CriticalSection lock_;
85};
86
deadbeef20cb0c12017-02-01 20:27:00 -080087class AudioRtpSender : public DtmfProviderInterface,
88 public ObserverInterface,
ossu7bb87ee2017-01-23 04:56:25 -080089 public rtc::RefCountedObject<RtpSenderInternal> {
90 public:
91 // StatsCollector provided so that Add/RemoveLocalAudioTrack can be called
92 // at the appropriate times.
ossu7bb87ee2017-01-23 04:56:25 -080093
Steve Anton02ee47c2018-01-10 16:26:06 -080094 // Construct an AudioRtpSender with a null track, a single, randomly generated
Seth Hampson845e8782018-03-02 11:34:10 -080095 // stream id, and a randomly generated ID.
Steve Anton47136dd2018-01-12 10:49:35 -080096 AudioRtpSender(rtc::Thread* worker_thread, StatsCollector* stats);
ossu7bb87ee2017-01-23 04:56:25 -080097
Seth Hampson845e8782018-03-02 11:34:10 -080098 // Construct an AudioRtpSender with the given track and stream ids. The
Steve Anton02ee47c2018-01-10 16:26:06 -080099 // sender ID will be set to the track's ID.
Steve Anton47136dd2018-01-12 10:49:35 -0800100 AudioRtpSender(rtc::Thread* worker_thread,
101 rtc::scoped_refptr<AudioTrackInterface> track,
Seth Hampson845e8782018-03-02 11:34:10 -0800102 const std::vector<std::string>& stream_ids,
Steve Anton02ee47c2018-01-10 16:26:06 -0800103 StatsCollector* stats);
ossu7bb87ee2017-01-23 04:56:25 -0800104
105 virtual ~AudioRtpSender();
106
deadbeef20cb0c12017-02-01 20:27:00 -0800107 // DtmfSenderProvider implementation.
108 bool CanInsertDtmf() override;
109 bool InsertDtmf(int code, int duration) override;
110 sigslot::signal0<>* GetOnDestroyedSignal() override;
111
112 // ObserverInterface implementation.
ossu7bb87ee2017-01-23 04:56:25 -0800113 void OnChanged() override;
114
deadbeef20cb0c12017-02-01 20:27:00 -0800115 // RtpSenderInterface implementation.
ossu7bb87ee2017-01-23 04:56:25 -0800116 bool SetTrack(MediaStreamTrackInterface* track) override;
117 rtc::scoped_refptr<MediaStreamTrackInterface> track() const override {
118 return track_;
119 }
120
121 uint32_t ssrc() const override { return ssrc_; }
122
123 cricket::MediaType media_type() const override {
124 return cricket::MEDIA_TYPE_AUDIO;
125 }
126
127 std::string id() const override { return id_; }
128
Steve Anton8ffb9c32017-08-31 15:45:38 -0700129 std::vector<std::string> stream_ids() const override { return stream_ids_; }
ossu7bb87ee2017-01-23 04:56:25 -0800130
Max Morin909338b2018-05-07 06:09:37 +0000131 RtpParameters GetParameters() const override;
Zach Steinba37b4b2018-01-23 15:02:36 -0800132 RTCError SetParameters(const RtpParameters& parameters) override;
ossu7bb87ee2017-01-23 04:56:25 -0800133
deadbeef20cb0c12017-02-01 20:27:00 -0800134 rtc::scoped_refptr<DtmfSenderInterface> GetDtmfSender() const override;
135
ossu7bb87ee2017-01-23 04:56:25 -0800136 // RtpSenderInternal implementation.
137 void SetSsrc(uint32_t ssrc) override;
138
Steve Anton8ffb9c32017-08-31 15:45:38 -0700139 void set_stream_ids(const std::vector<std::string>& stream_ids) override {
140 stream_ids_ = stream_ids;
141 }
ossu7bb87ee2017-01-23 04:56:25 -0800142
143 void Stop() override;
144
Harald Alvestrandc72af932018-01-11 17:18:19 +0100145 int AttachmentId() const override { return attachment_id_; }
146
Steve Anton57858b32018-02-15 15:19:50 -0800147 void SetVoiceMediaChannel(
148 cricket::VoiceMediaChannel* voice_media_channel) override {
149 media_channel_ = voice_media_channel;
150 }
151 void SetVideoMediaChannel(
152 cricket::VideoMediaChannel* video_media_channel) override {
153 RTC_NOTREACHED();
Steve Anton47136dd2018-01-12 10:49:35 -0800154 }
ossu7bb87ee2017-01-23 04:56:25 -0800155
156 private:
157 // TODO(nisse): Since SSRC == 0 is technically valid, figure out
158 // some other way to test if we have a valid SSRC.
159 bool can_send_track() const { return track_ && ssrc_; }
160 // Helper function to construct options for
161 // AudioProviderInterface::SetAudioSend.
162 void SetAudioSend();
163 // Helper function to call SetAudioSend with "stop sending" parameters.
164 void ClearAudioSend();
165
deadbeef20cb0c12017-02-01 20:27:00 -0800166 sigslot::signal0<> SignalDestroyed;
167
Steve Anton47136dd2018-01-12 10:49:35 -0800168 rtc::Thread* const worker_thread_;
Steve Anton02ee47c2018-01-10 16:26:06 -0800169 const std::string id_;
Steve Anton8ffb9c32017-08-31 15:45:38 -0700170 std::vector<std::string> stream_ids_;
Steve Anton47136dd2018-01-12 10:49:35 -0800171 cricket::VoiceMediaChannel* media_channel_ = nullptr;
ossu7bb87ee2017-01-23 04:56:25 -0800172 StatsCollector* stats_;
173 rtc::scoped_refptr<AudioTrackInterface> track_;
deadbeef20cb0c12017-02-01 20:27:00 -0800174 rtc::scoped_refptr<DtmfSenderInterface> dtmf_sender_proxy_;
ossu7bb87ee2017-01-23 04:56:25 -0800175 uint32_t ssrc_ = 0;
176 bool cached_track_enabled_ = false;
177 bool stopped_ = false;
178
179 // Used to pass the data callback from the |track_| to the other end of
180 // cricket::AudioSource.
181 std::unique_ptr<LocalAudioSinkAdapter> sink_adapter_;
Harald Alvestrandc72af932018-01-11 17:18:19 +0100182 int attachment_id_ = 0;
ossu7bb87ee2017-01-23 04:56:25 -0800183};
184
185class VideoRtpSender : public ObserverInterface,
186 public rtc::RefCountedObject<RtpSenderInternal> {
187 public:
Steve Anton02ee47c2018-01-10 16:26:06 -0800188 // Construct a VideoRtpSender with a null track, a single, randomly generated
Seth Hampson845e8782018-03-02 11:34:10 -0800189 // stream id, and a randomly generated ID.
Steve Anton47136dd2018-01-12 10:49:35 -0800190 explicit VideoRtpSender(rtc::Thread* worker_thread);
ossu7bb87ee2017-01-23 04:56:25 -0800191
Seth Hampson845e8782018-03-02 11:34:10 -0800192 // Construct a VideoRtpSender with the given track and stream ids. The
Steve Anton02ee47c2018-01-10 16:26:06 -0800193 // sender ID will be set to the track's ID.
Steve Anton47136dd2018-01-12 10:49:35 -0800194 VideoRtpSender(rtc::Thread* worker_thread,
195 rtc::scoped_refptr<VideoTrackInterface> track,
Seth Hampson845e8782018-03-02 11:34:10 -0800196 const std::vector<std::string>& stream_ids);
ossu7bb87ee2017-01-23 04:56:25 -0800197
198 virtual ~VideoRtpSender();
199
200 // ObserverInterface implementation
201 void OnChanged() override;
202
203 // RtpSenderInterface implementation
204 bool SetTrack(MediaStreamTrackInterface* track) override;
205 rtc::scoped_refptr<MediaStreamTrackInterface> track() const override {
206 return track_;
207 }
208
209 uint32_t ssrc() const override { return ssrc_; }
210
211 cricket::MediaType media_type() const override {
212 return cricket::MEDIA_TYPE_VIDEO;
213 }
214
215 std::string id() const override { return id_; }
216
Steve Anton8ffb9c32017-08-31 15:45:38 -0700217 std::vector<std::string> stream_ids() const override { return stream_ids_; }
ossu7bb87ee2017-01-23 04:56:25 -0800218
Max Morin909338b2018-05-07 06:09:37 +0000219 RtpParameters GetParameters() const override;
Zach Steinba37b4b2018-01-23 15:02:36 -0800220 RTCError SetParameters(const RtpParameters& parameters) override;
ossu7bb87ee2017-01-23 04:56:25 -0800221
deadbeef20cb0c12017-02-01 20:27:00 -0800222 rtc::scoped_refptr<DtmfSenderInterface> GetDtmfSender() const override;
223
ossu7bb87ee2017-01-23 04:56:25 -0800224 // RtpSenderInternal implementation.
225 void SetSsrc(uint32_t ssrc) override;
226
Steve Anton8ffb9c32017-08-31 15:45:38 -0700227 void set_stream_ids(const std::vector<std::string>& stream_ids) override {
228 stream_ids_ = stream_ids;
229 }
ossu7bb87ee2017-01-23 04:56:25 -0800230
231 void Stop() override;
Harald Alvestrandc72af932018-01-11 17:18:19 +0100232 int AttachmentId() const override { return attachment_id_; }
ossu7bb87ee2017-01-23 04:56:25 -0800233
Steve Anton57858b32018-02-15 15:19:50 -0800234 void SetVoiceMediaChannel(
235 cricket::VoiceMediaChannel* voice_media_channel) override {
236 RTC_NOTREACHED();
237 }
238 void SetVideoMediaChannel(
239 cricket::VideoMediaChannel* video_media_channel) override {
240 media_channel_ = video_media_channel;
Steve Anton47136dd2018-01-12 10:49:35 -0800241 }
ossu7bb87ee2017-01-23 04:56:25 -0800242
243 private:
244 bool can_send_track() const { return track_ && ssrc_; }
245 // Helper function to construct options for
246 // VideoProviderInterface::SetVideoSend.
247 void SetVideoSend();
248 // Helper function to call SetVideoSend with "stop sending" parameters.
249 void ClearVideoSend();
250
Steve Anton47136dd2018-01-12 10:49:35 -0800251 rtc::Thread* worker_thread_;
Steve Anton02ee47c2018-01-10 16:26:06 -0800252 const std::string id_;
Steve Anton8ffb9c32017-08-31 15:45:38 -0700253 std::vector<std::string> stream_ids_;
Steve Anton47136dd2018-01-12 10:49:35 -0800254 cricket::VideoMediaChannel* media_channel_ = nullptr;
ossu7bb87ee2017-01-23 04:56:25 -0800255 rtc::scoped_refptr<VideoTrackInterface> track_;
256 uint32_t ssrc_ = 0;
ossu7bb87ee2017-01-23 04:56:25 -0800257 VideoTrackInterface::ContentHint cached_track_content_hint_ =
258 VideoTrackInterface::ContentHint::kNone;
259 bool stopped_ = false;
Harald Alvestrandc72af932018-01-11 17:18:19 +0100260 int attachment_id_ = 0;
ossu7bb87ee2017-01-23 04:56:25 -0800261};
262
263} // namespace webrtc
264
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200265#endif // PC_RTPSENDER_H_