blob: fc9488c4abd640c507f5fce439f37b8b3e55bbea [file] [log] [blame]
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +01001/*
2 * Copyright (c) 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 MODULES_RTP_RTCP_SOURCE_RTCP_TRANSCEIVER_H_
12#define MODULES_RTP_RTCP_SOURCE_RTCP_TRANSCEIVER_H_
13
14#include <memory>
15#include <string>
16#include <vector>
17
18#include "modules/rtp_rtcp/source/rtcp_transceiver_config.h"
19#include "modules/rtp_rtcp/source/rtcp_transceiver_impl.h"
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010020#include "rtc_base/copyonwritebuffer.h"
21#include "rtc_base/task_queue.h"
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010022
23namespace webrtc {
24//
25// Manage incoming and outgoing rtcp messages for multiple BUNDLED streams.
26//
27// This class is thread-safe wrapper of RtcpTransceiverImpl
Danil Chapovaloveb0edd82017-12-14 16:02:31 +010028class RtcpTransceiver : public RtcpFeedbackSenderInterface {
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010029 public:
30 explicit RtcpTransceiver(const RtcpTransceiverConfig& config);
Danil Chapovalov067818f2018-09-10 09:59:51 +020031 RtcpTransceiver(const RtcpTransceiver&) = delete;
32 RtcpTransceiver& operator=(const RtcpTransceiver&) = delete;
Danil Chapovalov792df6b2018-09-07 13:03:32 +020033 // Note that interfaces provided in constructor still might be used after the
34 // destructor. However they can only be used on the confic.task_queue.
35 // Use Stop function to get notified when they are no longer used or
36 // ensure those objects outlive the task queue.
Danil Chapovaloveb0edd82017-12-14 16:02:31 +010037 ~RtcpTransceiver() override;
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010038
Danil Chapovalovf0076d32018-09-05 16:46:40 +020039 // Start asynchronious destruction of the RtcpTransceiver.
40 // It is safe to call destructor right after Stop exits.
41 // No other methods can be called.
Danil Chapovalov792df6b2018-09-07 13:03:32 +020042 // Note that interfaces provided in constructor or registered with AddObserver
43 // still might be used by the transceiver on the task queue
44 // until |on_destroyed| runs.
Danil Chapovalovf0076d32018-09-05 16:46:40 +020045 void Stop(std::unique_ptr<rtc::QueuedTask> on_destroyed);
46
Danil Chapovalova32d7102017-12-14 17:28:27 +010047 // Registers observer to be notified about incoming rtcp packets.
48 // Calls to observer will be done on the |config.task_queue|.
49 void AddMediaReceiverRtcpObserver(uint32_t remote_ssrc,
50 MediaReceiverRtcpObserver* observer);
51 // Deregisters the observer. Might return before observer is deregistered.
52 // Posts |on_removed| task when observer is deregistered.
53 void RemoveMediaReceiverRtcpObserver(
54 uint32_t remote_ssrc,
55 MediaReceiverRtcpObserver* observer,
56 std::unique_ptr<rtc::QueuedTask> on_removed);
57
Danil Chapovalove3927c52018-03-06 14:33:20 +010058 // Enables/disables sending rtcp packets eventually.
59 // Packets may be sent after the SetReadyToSend(false) returns, but no new
60 // packets will be scheduled.
61 void SetReadyToSend(bool ready);
62
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010063 // Handles incoming rtcp packets.
64 void ReceivePacket(rtc::CopyOnWriteBuffer packet);
65
66 // Sends RTCP packets starting with a sender or receiver report.
67 void SendCompoundPacket();
68
69 // (REMB) Receiver Estimated Max Bitrate.
70 // Includes REMB in following compound packets.
Danil Chapovaloveb0edd82017-12-14 16:02:31 +010071 void SetRemb(int64_t bitrate_bps, std::vector<uint32_t> ssrcs) override;
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010072 // Stops sending REMB in following compound packets.
Danil Chapovaloveb0edd82017-12-14 16:02:31 +010073 void UnsetRemb() override;
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010074
Danil Chapovalovd5cae4d2017-12-14 11:14:35 +010075 // TODO(bugs.webrtc.org/8239): Remove SendFeedbackPacket and SSRC functions
76 // and move generating of the TransportFeedback message inside
77 // RtcpTransceiverImpl when there is one RtcpTransceiver per rtp transport.
78
79 // Returns ssrc to put as sender ssrc into rtcp::TransportFeedback.
Danil Chapovaloveb0edd82017-12-14 16:02:31 +010080 uint32_t SSRC() const override;
81 bool SendFeedbackPacket(const rtcp::TransportFeedback& packet) override;
Danil Chapovalovd5cae4d2017-12-14 11:14:35 +010082
Danil Chapovalov327c43c2017-11-27 17:23:04 +010083 // Reports missing packets, https://tools.ietf.org/html/rfc4585#section-6.2.1
84 void SendNack(uint32_t ssrc, std::vector<uint16_t> sequence_numbers);
85
86 // Requests new key frame.
Danil Chapovalov2ddf98d2017-11-22 14:00:41 +010087 // using PLI, https://tools.ietf.org/html/rfc4585#section-6.3.1.1
Danil Chapovalov8d19e032017-11-28 19:53:33 +010088 void SendPictureLossIndication(uint32_t ssrc);
Danil Chapovalov2ddf98d2017-11-22 14:00:41 +010089 // using FIR, https://tools.ietf.org/html/rfc5104#section-4.3.1.2
90 void SendFullIntraRequest(std::vector<uint32_t> ssrcs);
Danil Chapovalova7e418c2017-11-21 11:08:53 +010091
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010092 private:
93 rtc::TaskQueue* const task_queue_;
94 std::unique_ptr<RtcpTransceiverImpl> rtcp_transceiver_;
Danil Chapovalovc0fd5f92017-11-16 14:35:32 +010095};
96
97} // namespace webrtc
98
99#endif // MODULES_RTP_RTCP_SOURCE_RTCP_TRANSCEIVER_H_