1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
/*
* Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef MODULES_RTP_RTCP_SOURCE_RTP_PACKET_H_
#define MODULES_RTP_RTCP_SOURCE_RTP_PACKET_H_
#include <string>
#include <vector>
#include "absl/types/optional.h"
#include "api/array_view.h"
#include "modules/rtp_rtcp/include/rtp_header_extension_map.h"
#include "modules/rtp_rtcp/include/rtp_rtcp_defines.h"
#include "rtc_base/copy_on_write_buffer.h"
namespace webrtc {
class RtpPacket {
public:
using ExtensionType = RTPExtensionType;
using ExtensionManager = RtpHeaderExtensionMap;
// `extensions` required for SetExtension/ReserveExtension functions during
// packet creating and used if available in Parse function.
// Adding and getting extensions will fail until `extensions` is
// provided via constructor or IdentifyExtensions function.
// |*extensions| is only accessed during construction; the pointer is not
// stored.
RtpPacket();
explicit RtpPacket(const ExtensionManager* extensions);
RtpPacket(const ExtensionManager* extensions, size_t capacity);
RtpPacket(const RtpPacket&);
RtpPacket(RtpPacket&&);
RtpPacket& operator=(const RtpPacket&);
RtpPacket& operator=(RtpPacket&&);
~RtpPacket();
// Parse and copy given buffer into Packet.
// Does not require extension map to be registered (map is only required to
// read or allocate extensions in methods GetExtension, AllocateExtension,
// etc.)
bool Parse(const uint8_t* buffer, size_t size);
bool Parse(rtc::ArrayView<const uint8_t> packet);
// Parse and move given buffer into Packet.
bool Parse(rtc::CopyOnWriteBuffer packet);
// Maps extensions id to their types.
void IdentifyExtensions(ExtensionManager extensions);
// Returns the extension map used for identifying extensions in this packet.
const ExtensionManager& extension_manager() const { return extensions_; }
// Header.
bool Marker() const { return marker_; }
uint8_t PayloadType() const { return payload_type_; }
uint16_t SequenceNumber() const { return sequence_number_; }
uint32_t Timestamp() const { return timestamp_; }
uint32_t Ssrc() const { return ssrc_; }
std::vector<uint32_t> Csrcs() const;
size_t headers_size() const { return payload_offset_; }
// Payload.
size_t payload_size() const { return payload_size_; }
bool has_padding() const { return buffer_[0] & 0x20; }
size_t padding_size() const { return padding_size_; }
rtc::ArrayView<const uint8_t> payload() const {
return rtc::MakeArrayView(data() + payload_offset_, payload_size_);
}
rtc::CopyOnWriteBuffer PayloadBuffer() const {
return buffer_.Slice(payload_offset_, payload_size_);
}
// Buffer.
rtc::CopyOnWriteBuffer Buffer() const { return buffer_; }
size_t capacity() const { return buffer_.capacity(); }
size_t size() const {
return payload_offset_ + payload_size_ + padding_size_;
}
const uint8_t* data() const { return buffer_.cdata(); }
size_t FreeCapacity() const { return capacity() - size(); }
size_t MaxPayloadSize() const { return capacity() - headers_size(); }
// Reset fields and buffer.
void Clear();
// Header setters.
void CopyHeaderFrom(const RtpPacket& packet);
void SetMarker(bool marker_bit);
void SetPayloadType(uint8_t payload_type);
void SetSequenceNumber(uint16_t seq_no);
void SetTimestamp(uint32_t timestamp);
void SetSsrc(uint32_t ssrc);
// Fills with zeroes mutable extensions,
// which are modified after FEC protection is generated.
void ZeroMutableExtensions();
// Removes extension of given `type`, returns false is extension was not
// registered in packet's extension map or not present in the packet. Only
// extension that should be removed must be registered, other extensions may
// not be registered and will be preserved as is.
bool RemoveExtension(ExtensionType type);
// Writes csrc list. Assumes:
// a) There is enough room left in buffer.
// b) Extension headers, payload or padding data has not already been added.
void SetCsrcs(rtc::ArrayView<const uint32_t> csrcs);
// Header extensions.
template <typename Extension>
bool HasExtension() const;
bool HasExtension(ExtensionType type) const;
// Returns whether there is an associated id for the extension and thus it is
// possible to set the extension.
template <typename Extension>
bool IsRegistered() const;
template <typename Extension, typename FirstValue, typename... Values>
bool GetExtension(FirstValue, Values...) const;
template <typename Extension>
absl::optional<typename Extension::value_type> GetExtension() const;
// Returns view of the raw extension or empty view on failure.
template <typename Extension>
rtc::ArrayView<const uint8_t> GetRawExtension() const;
template <typename Extension, typename... Values>
bool SetExtension(const Values&...);
template <typename Extension>
bool SetRawExtension(rtc::ArrayView<const uint8_t> data);
template <typename Extension>
bool ReserveExtension();
// Find or allocate an extension `type`. Returns view of size `length`
// to write raw extension to or an empty view on failure.
rtc::ArrayView<uint8_t> AllocateExtension(ExtensionType type, size_t length);
// Find an extension `type`.
// Returns view of the raw extension or empty view on failure.
rtc::ArrayView<const uint8_t> FindExtension(ExtensionType type) const;
// Returns pointer to the payload of size at least `size_bytes`.
// Keeps original payload, if any. If `size_bytes` is larger than current
// `payload_size()`, remaining bytes are uninitialized.
uint8_t* SetPayloadSize(size_t size_bytes);
// Same as SetPayloadSize but doesn't guarantee to keep current payload.
uint8_t* AllocatePayload(size_t size_bytes);
bool SetPadding(size_t padding_size);
// Returns debug string of RTP packet (without detailed extension info).
std::string ToString() const;
private:
struct ExtensionInfo {
explicit ExtensionInfo(uint8_t id) : ExtensionInfo(id, 0, 0) {}
ExtensionInfo(uint8_t id, uint8_t length, uint16_t offset)
: id(id), length(length), offset(offset) {}
uint8_t id;
uint8_t length;
uint16_t offset;
};
// Helper function for Parse. Fill header fields using data in given buffer,
// but does not touch packet own buffer, leaving packet in invalid state.
bool ParseBuffer(const uint8_t* buffer, size_t size);
// Returns pointer to extension info for a given id. Returns nullptr if not
// found.
const ExtensionInfo* FindExtensionInfo(int id) const;
// Returns reference to extension info for a given id. Creates a new entry
// with the specified id if not found.
ExtensionInfo& FindOrCreateExtensionInfo(int id);
// Allocates and returns place to store rtp header extension.
// Returns empty arrayview on failure.
rtc::ArrayView<uint8_t> AllocateRawExtension(int id, size_t length);
// Promotes existing one-byte header extensions to two-byte header extensions
// by rewriting the data and updates the corresponding extension offsets.
void PromoteToTwoByteHeaderExtension();
uint16_t SetExtensionLengthMaybeAddZeroPadding(size_t extensions_offset);
uint8_t* WriteAt(size_t offset) { return buffer_.MutableData() + offset; }
void WriteAt(size_t offset, uint8_t byte) {
buffer_.MutableData()[offset] = byte;
}
const uint8_t* ReadAt(size_t offset) const { return buffer_.data() + offset; }
// Header.
bool marker_;
uint8_t payload_type_;
uint8_t padding_size_;
uint16_t sequence_number_;
uint32_t timestamp_;
uint32_t ssrc_;
size_t payload_offset_; // Match header size with csrcs and extensions.
size_t payload_size_;
ExtensionManager extensions_;
std::vector<ExtensionInfo> extension_entries_;
size_t extensions_size_ = 0; // Unaligned.
rtc::CopyOnWriteBuffer buffer_;
};
template <typename Extension>
bool RtpPacket::HasExtension() const {
return HasExtension(Extension::kId);
}
template <typename Extension>
bool RtpPacket::IsRegistered() const {
return extensions_.IsRegistered(Extension::kId);
}
template <typename Extension, typename FirstValue, typename... Values>
bool RtpPacket::GetExtension(FirstValue first, Values... values) const {
auto raw = FindExtension(Extension::kId);
if (raw.empty())
return false;
return Extension::Parse(raw, first, values...);
}
template <typename Extension>
absl::optional<typename Extension::value_type> RtpPacket::GetExtension() const {
absl::optional<typename Extension::value_type> result;
auto raw = FindExtension(Extension::kId);
if (raw.empty() || !Extension::Parse(raw, &result.emplace()))
result = absl::nullopt;
return result;
}
template <typename Extension>
rtc::ArrayView<const uint8_t> RtpPacket::GetRawExtension() const {
return FindExtension(Extension::kId);
}
template <typename Extension, typename... Values>
bool RtpPacket::SetExtension(const Values&... values) {
const size_t value_size = Extension::ValueSize(values...);
auto buffer = AllocateExtension(Extension::kId, value_size);
if (buffer.empty())
return false;
return Extension::Write(buffer, values...);
}
template <typename Extension>
bool RtpPacket::SetRawExtension(rtc::ArrayView<const uint8_t> data) {
rtc::ArrayView<uint8_t> buffer =
AllocateExtension(Extension::kId, data.size());
if (buffer.empty()) {
return false;
}
std::memcpy(buffer.data(), data.data(), data.size());
return true;
}
template <typename Extension>
bool RtpPacket::ReserveExtension() {
auto buffer = AllocateExtension(Extension::kId, Extension::kValueSizeBytes);
if (buffer.empty())
return false;
memset(buffer.data(), 0, Extension::kValueSizeBytes);
return true;
}
} // namespace webrtc
#endif // MODULES_RTP_RTCP_SOURCE_RTP_PACKET_H_
|