Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 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 API_RTP_PACKET_INFO_H_ |
| 12 | #define API_RTP_PACKET_INFO_H_ |
| 13 | |
| 14 | #include <cstdint> |
| 15 | #include <utility> |
| 16 | #include <vector> |
| 17 | |
| 18 | #include "absl/types/optional.h" |
| 19 | #include "api/rtp_headers.h" |
Johannes Kron | f7de74c | 2021-04-30 13:10:56 +0200 | [diff] [blame] | 20 | #include "api/units/timestamp.h" |
Johannes Kron | 0809e7e | 2020-01-21 11:54:21 +0100 | [diff] [blame] | 21 | #include "rtc_base/system/rtc_export.h" |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 22 | |
| 23 | namespace webrtc { |
| 24 | |
Chen Xing | 12d64de | 2019-06-13 20:36:12 +0200 | [diff] [blame] | 25 | // |
Artem Titov | 0e61fdd | 2021-07-25 21:50:14 +0200 | [diff] [blame] | 26 | // Structure to hold information about a received `RtpPacket`. It is primarily |
Chen Xing | 12d64de | 2019-06-13 20:36:12 +0200 | [diff] [blame] | 27 | // used to carry per-packet information from when a packet is received until |
Artem Titov | 0e61fdd | 2021-07-25 21:50:14 +0200 | [diff] [blame] | 28 | // the information is passed to `SourceTracker`. |
Chen Xing | 12d64de | 2019-06-13 20:36:12 +0200 | [diff] [blame] | 29 | // |
Johannes Kron | 0809e7e | 2020-01-21 11:54:21 +0100 | [diff] [blame] | 30 | class RTC_EXPORT RtpPacketInfo { |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 31 | public: |
| 32 | RtpPacketInfo(); |
| 33 | |
| 34 | RtpPacketInfo(uint32_t ssrc, |
| 35 | std::vector<uint32_t> csrcs, |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 36 | uint32_t rtp_timestamp, |
Alessio Bazzica | a1d0356 | 2022-09-19 18:05:29 +0200 | [diff] [blame] | 37 | Timestamp receive_time); |
| 38 | |
| 39 | // TODO(bugs.webrtc.org/12722): Deprecated, remove once downstream projects |
| 40 | // are updated. |
| 41 | RtpPacketInfo(uint32_t ssrc, |
| 42 | std::vector<uint32_t> csrcs, |
| 43 | uint32_t rtp_timestamp, |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 44 | absl::optional<uint8_t> audio_level, |
Chen Xing | e08648d | 2019-08-05 16:29:13 +0200 | [diff] [blame] | 45 | absl::optional<AbsoluteCaptureTime> absolute_capture_time, |
Johannes Kron | f7de74c | 2021-04-30 13:10:56 +0200 | [diff] [blame] | 46 | Timestamp receive_time); |
Chen Xing | e08648d | 2019-08-05 16:29:13 +0200 | [diff] [blame] | 47 | |
Johannes Kron | f7de74c | 2021-04-30 13:10:56 +0200 | [diff] [blame] | 48 | RtpPacketInfo(const RTPHeader& rtp_header, Timestamp receive_time); |
| 49 | |
| 50 | // TODO(bugs.webrtc.org/12722): Deprecated, remove once downstream projects |
| 51 | // are updated. |
| 52 | RtpPacketInfo(uint32_t ssrc, |
| 53 | std::vector<uint32_t> csrcs, |
| 54 | uint32_t rtp_timestamp, |
| 55 | absl::optional<uint8_t> audio_level, |
| 56 | absl::optional<AbsoluteCaptureTime> absolute_capture_time, |
| 57 | int64_t receive_time_ms); |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 58 | RtpPacketInfo(const RTPHeader& rtp_header, int64_t receive_time_ms); |
| 59 | |
| 60 | RtpPacketInfo(const RtpPacketInfo& other) = default; |
| 61 | RtpPacketInfo(RtpPacketInfo&& other) = default; |
| 62 | RtpPacketInfo& operator=(const RtpPacketInfo& other) = default; |
| 63 | RtpPacketInfo& operator=(RtpPacketInfo&& other) = default; |
| 64 | |
| 65 | uint32_t ssrc() const { return ssrc_; } |
| 66 | void set_ssrc(uint32_t value) { ssrc_ = value; } |
| 67 | |
| 68 | const std::vector<uint32_t>& csrcs() const { return csrcs_; } |
| 69 | void set_csrcs(std::vector<uint32_t> value) { csrcs_ = std::move(value); } |
| 70 | |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 71 | uint32_t rtp_timestamp() const { return rtp_timestamp_; } |
| 72 | void set_rtp_timestamp(uint32_t value) { rtp_timestamp_ = value; } |
| 73 | |
Johannes Kron | f7de74c | 2021-04-30 13:10:56 +0200 | [diff] [blame] | 74 | Timestamp receive_time() const { return receive_time_; } |
| 75 | void set_receive_time(Timestamp value) { receive_time_ = value; } |
| 76 | // TODO(bugs.webrtc.org/12722): Deprecated, remove once downstream projects |
| 77 | // are updated. |
| 78 | int64_t receive_time_ms() const { return receive_time_.ms(); } |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 79 | |
Alessio Bazzica | a1d0356 | 2022-09-19 18:05:29 +0200 | [diff] [blame] | 80 | absl::optional<uint8_t> audio_level() const { return audio_level_; } |
| 81 | RtpPacketInfo& set_audio_level(absl::optional<uint8_t> value) { |
| 82 | audio_level_ = value; |
| 83 | return *this; |
| 84 | } |
| 85 | |
| 86 | const absl::optional<AbsoluteCaptureTime>& absolute_capture_time() const { |
| 87 | return absolute_capture_time_; |
| 88 | } |
| 89 | RtpPacketInfo& set_absolute_capture_time( |
| 90 | const absl::optional<AbsoluteCaptureTime>& value) { |
| 91 | absolute_capture_time_ = value; |
| 92 | return *this; |
| 93 | } |
| 94 | |
| 95 | const absl::optional<int64_t>& local_capture_clock_offset() const { |
| 96 | return local_capture_clock_offset_; |
| 97 | } |
| 98 | RtpPacketInfo& set_local_capture_clock_offset( |
| 99 | const absl::optional<int64_t>& value) { |
| 100 | local_capture_clock_offset_ = value; |
| 101 | return *this; |
| 102 | } |
| 103 | |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 104 | private: |
| 105 | // Fields from the RTP header: |
| 106 | // https://tools.ietf.org/html/rfc3550#section-5.1 |
| 107 | uint32_t ssrc_; |
| 108 | std::vector<uint32_t> csrcs_; |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 109 | uint32_t rtp_timestamp_; |
| 110 | |
Alessio Bazzica | a1d0356 | 2022-09-19 18:05:29 +0200 | [diff] [blame] | 111 | // Local `webrtc::Clock`-based timestamp of when the packet was received. |
| 112 | Timestamp receive_time_; |
| 113 | |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 114 | // Fields from the Audio Level header extension: |
| 115 | // https://tools.ietf.org/html/rfc6464#section-3 |
| 116 | absl::optional<uint8_t> audio_level_; |
| 117 | |
Chen Xing | e08648d | 2019-08-05 16:29:13 +0200 | [diff] [blame] | 118 | // Fields from the Absolute Capture Time header extension: |
| 119 | // http://www.webrtc.org/experiments/rtp-hdrext/abs-capture-time |
Artem Titov | 0e61fdd | 2021-07-25 21:50:14 +0200 | [diff] [blame] | 120 | // To not be confused with `local_capture_clock_offset_`, the |
| 121 | // `estimated_capture_clock_offset` in `absolute_capture_time_` should |
Minyue Li | 63b3095 | 2021-05-19 14:38:25 +0200 | [diff] [blame] | 122 | // represent the clock offset between a remote sender and the capturer, and |
| 123 | // thus equals to the corresponding values in the received RTP packets, |
| 124 | // subjected to possible interpolations. |
Chen Xing | e08648d | 2019-08-05 16:29:13 +0200 | [diff] [blame] | 125 | absl::optional<AbsoluteCaptureTime> absolute_capture_time_; |
| 126 | |
Minyue Li | 63b3095 | 2021-05-19 14:38:25 +0200 | [diff] [blame] | 127 | // Clock offset against capturer's clock. Should be derived from the estimated |
| 128 | // capture clock offset defined in the Absolute Capture Time header extension. |
| 129 | absl::optional<int64_t> local_capture_clock_offset_; |
Chen Xing | d2a6686 | 2019-06-03 14:53:42 +0200 | [diff] [blame] | 130 | }; |
| 131 | |
| 132 | bool operator==(const RtpPacketInfo& lhs, const RtpPacketInfo& rhs); |
| 133 | |
| 134 | inline bool operator!=(const RtpPacketInfo& lhs, const RtpPacketInfo& rhs) { |
| 135 | return !(lhs == rhs); |
| 136 | } |
| 137 | |
| 138 | } // namespace webrtc |
| 139 | |
| 140 | #endif // API_RTP_PACKET_INFO_H_ |