xref: /aosp_15_r20/external/webrtc/pc/video_rtp_receiver.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright 2019 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_VIDEO_RTP_RECEIVER_H_
12 #define PC_VIDEO_RTP_RECEIVER_H_
13 
14 #include <stdint.h>
15 
16 #include <string>
17 #include <vector>
18 
19 #include "absl/types/optional.h"
20 #include "api/crypto/frame_decryptor_interface.h"
21 #include "api/dtls_transport_interface.h"
22 #include "api/frame_transformer_interface.h"
23 #include "api/media_stream_interface.h"
24 #include "api/media_types.h"
25 #include "api/rtp_parameters.h"
26 #include "api/rtp_receiver_interface.h"
27 #include "api/scoped_refptr.h"
28 #include "api/sequence_checker.h"
29 #include "api/transport/rtp/rtp_source.h"
30 #include "api/video/video_frame.h"
31 #include "api/video/video_sink_interface.h"
32 #include "api/video/video_source_interface.h"
33 #include "media/base/media_channel.h"
34 #include "pc/jitter_buffer_delay.h"
35 #include "pc/media_stream_track_proxy.h"
36 #include "pc/rtp_receiver.h"
37 #include "pc/video_rtp_track_source.h"
38 #include "pc/video_track.h"
39 #include "rtc_base/system/no_unique_address.h"
40 #include "rtc_base/thread.h"
41 #include "rtc_base/thread_annotations.h"
42 
43 namespace webrtc {
44 
45 class VideoRtpReceiver : public RtpReceiverInternal {
46  public:
47   // An SSRC of 0 will create a receiver that will match the first SSRC it
48   // sees. Must be called on signaling thread.
49   VideoRtpReceiver(rtc::Thread* worker_thread,
50                    std::string receiver_id,
51                    std::vector<std::string> streams_ids);
52   // TODO(hbos): Remove this when streams() is removed.
53   // https://crbug.com/webrtc/9480
54   VideoRtpReceiver(
55       rtc::Thread* worker_thread,
56       const std::string& receiver_id,
57       const std::vector<rtc::scoped_refptr<MediaStreamInterface>>& streams);
58 
59   virtual ~VideoRtpReceiver();
60 
video_track()61   rtc::scoped_refptr<VideoTrackInterface> video_track() const { return track_; }
62 
63   // RtpReceiverInterface implementation
track()64   rtc::scoped_refptr<MediaStreamTrackInterface> track() const override {
65     return track_;
66   }
67   rtc::scoped_refptr<DtlsTransportInterface> dtls_transport() const override;
68   std::vector<std::string> stream_ids() const override;
69   std::vector<rtc::scoped_refptr<MediaStreamInterface>> streams()
70       const override;
media_type()71   cricket::MediaType media_type() const override {
72     return cricket::MEDIA_TYPE_VIDEO;
73   }
74 
id()75   std::string id() const override { return id_; }
76 
77   RtpParameters GetParameters() const override;
78 
79   void SetFrameDecryptor(
80       rtc::scoped_refptr<FrameDecryptorInterface> frame_decryptor) override;
81 
82   rtc::scoped_refptr<FrameDecryptorInterface> GetFrameDecryptor()
83       const override;
84 
85   void SetDepacketizerToDecoderFrameTransformer(
86       rtc::scoped_refptr<FrameTransformerInterface> frame_transformer) override;
87 
88   // RtpReceiverInternal implementation.
89   void Stop() override;
90   void SetupMediaChannel(uint32_t ssrc) override;
91   void SetupUnsignaledMediaChannel() override;
92   uint32_t ssrc() const override;
93   void NotifyFirstPacketReceived() override;
94   void set_stream_ids(std::vector<std::string> stream_ids) override;
95   void set_transport(
96       rtc::scoped_refptr<DtlsTransportInterface> dtls_transport) override;
97   void SetStreams(const std::vector<rtc::scoped_refptr<MediaStreamInterface>>&
98                       streams) override;
99 
100   void SetObserver(RtpReceiverObserverInterface* observer) override;
101 
102   void SetJitterBufferMinimumDelay(
103       absl::optional<double> delay_seconds) override;
104 
105   void SetMediaChannel(cricket::MediaChannel* media_channel) override;
106 
AttachmentId()107   int AttachmentId() const override { return attachment_id_; }
108 
109   std::vector<RtpSource> GetSources() const override;
110 
111   // Combines SetMediaChannel, SetupMediaChannel and
112   // SetupUnsignaledMediaChannel.
113   void SetupMediaChannel(absl::optional<uint32_t> ssrc,
114                          cricket::MediaChannel* media_channel);
115 
116  private:
117   void RestartMediaChannel(absl::optional<uint32_t> ssrc)
118       RTC_RUN_ON(&signaling_thread_checker_);
119   void RestartMediaChannel_w(absl::optional<uint32_t> ssrc,
120                              MediaSourceInterface::SourceState state)
121       RTC_RUN_ON(worker_thread_);
122   void SetSink(rtc::VideoSinkInterface<VideoFrame>* sink)
123       RTC_RUN_ON(worker_thread_);
124   void SetMediaChannel_w(cricket::MediaChannel* media_channel)
125       RTC_RUN_ON(worker_thread_);
126 
127   // VideoRtpTrackSource::Callback
128   void OnGenerateKeyFrame();
129   void OnEncodedSinkEnabled(bool enable);
130 
131   void SetEncodedSinkEnabled(bool enable) RTC_RUN_ON(worker_thread_);
132 
133   class SourceCallback : public VideoRtpTrackSource::Callback {
134    public:
SourceCallback(VideoRtpReceiver * receiver)135     explicit SourceCallback(VideoRtpReceiver* receiver) : receiver_(receiver) {}
136     ~SourceCallback() override = default;
137 
138    private:
OnGenerateKeyFrame()139     void OnGenerateKeyFrame() override { receiver_->OnGenerateKeyFrame(); }
OnEncodedSinkEnabled(bool enable)140     void OnEncodedSinkEnabled(bool enable) override {
141       receiver_->OnEncodedSinkEnabled(enable);
142     }
143 
144     VideoRtpReceiver* const receiver_;
145   } source_callback_{this};
146 
147   RTC_NO_UNIQUE_ADDRESS SequenceChecker signaling_thread_checker_;
148   rtc::Thread* const worker_thread_;
149 
150   const std::string id_;
151   cricket::VideoMediaChannel* media_channel_ RTC_GUARDED_BY(worker_thread_) =
152       nullptr;
153   absl::optional<uint32_t> ssrc_ RTC_GUARDED_BY(worker_thread_);
154   // `source_` is held here to be able to change the state of the source when
155   // the VideoRtpReceiver is stopped.
156   const rtc::scoped_refptr<VideoRtpTrackSource> source_;
157   const rtc::scoped_refptr<VideoTrackProxyWithInternal<VideoTrack>> track_;
158   std::vector<rtc::scoped_refptr<MediaStreamInterface>> streams_
159       RTC_GUARDED_BY(&signaling_thread_checker_);
160   RtpReceiverObserverInterface* observer_
161       RTC_GUARDED_BY(&signaling_thread_checker_) = nullptr;
162   bool received_first_packet_ RTC_GUARDED_BY(&signaling_thread_checker_) =
163       false;
164   const int attachment_id_;
165   rtc::scoped_refptr<FrameDecryptorInterface> frame_decryptor_
166       RTC_GUARDED_BY(worker_thread_);
167   rtc::scoped_refptr<DtlsTransportInterface> dtls_transport_
168       RTC_GUARDED_BY(&signaling_thread_checker_);
169   rtc::scoped_refptr<FrameTransformerInterface> frame_transformer_
170       RTC_GUARDED_BY(worker_thread_);
171   // Stores the minimum jitter buffer delay. Handles caching cases
172   // if `SetJitterBufferMinimumDelay` is called before start.
173   JitterBufferDelay delay_ RTC_GUARDED_BY(worker_thread_);
174 
175   // Records if we should generate a keyframe when `media_channel_` gets set up
176   // or switched.
177   bool saved_generate_keyframe_ RTC_GUARDED_BY(worker_thread_) = false;
178   bool saved_encoded_sink_enabled_ RTC_GUARDED_BY(worker_thread_) = false;
179 };
180 
181 }  // namespace webrtc
182 
183 #endif  // PC_VIDEO_RTP_RECEIVER_H_
184