blob: 4f50e4d9deadc7d68df5556cec150062d494eedf [file] [log] [blame]
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +00001/*
2 * Copyright (c) 2012 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
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#ifndef MODULES_AUDIO_CODING_NETEQ_PACKET_H_
12#define MODULES_AUDIO_CODING_NETEQ_PACKET_H_
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000013
Yves Gerey988cc082018-10-23 12:03:01 +020014#include <stdint.h>
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000015#include <list>
henrik.lundin84f8cd62016-04-26 07:45:16 -070016#include <memory>
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000017
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020018#include "api/audio_codecs/audio_decoder.h"
Chen Xing3e8ef942019-07-01 17:16:32 +020019#include "api/rtp_packet_info.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020020#include "modules/audio_coding/neteq/tick_timer.h"
21#include "rtc_base/buffer.h"
Yves Gerey988cc082018-10-23 12:03:01 +020022#include "rtc_base/checks.h"
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000023
24namespace webrtc {
25
26// Struct for holding RTP packets.
27struct Packet {
ossua70695a2016-09-22 02:06:28 -070028 struct Priority {
29 Priority() : codec_level(0), red_level(0) {}
30 Priority(int codec_level, int red_level)
31 : codec_level(codec_level), red_level(red_level) {
32 CheckInvariant();
33 }
34
35 int codec_level;
36 int red_level;
37
38 // Priorities are sorted low-to-high, first on the level the codec
39 // prioritizes it, then on the level of RED packet it is; i.e. if it is a
40 // primary or secondary payload of a RED packet. For example: with Opus, an
41 // Fec packet (which the decoder prioritizes lower than a regular packet)
42 // will not be used if there is _any_ RED payload for the same
43 // timeframe. The highest priority packet will have levels {0, 0}. Negative
44 // priorities are not allowed.
45 bool operator<(const Priority& b) const {
46 CheckInvariant();
47 b.CheckInvariant();
48 if (codec_level == b.codec_level)
49 return red_level < b.red_level;
50
51 return codec_level < b.codec_level;
52 }
53 bool operator==(const Priority& b) const {
54 CheckInvariant();
55 b.CheckInvariant();
56 return codec_level == b.codec_level && red_level == b.red_level;
57 }
58 bool operator!=(const Priority& b) const { return !(*this == b); }
59 bool operator>(const Priority& b) const { return b < *this; }
60 bool operator<=(const Priority& b) const { return !(b > *this); }
61 bool operator>=(const Priority& b) const { return !(b < *this); }
62
63 private:
64 void CheckInvariant() const {
65 RTC_DCHECK_GE(codec_level, 0);
66 RTC_DCHECK_GE(red_level, 0);
67 }
68 };
69
ossu7a377612016-10-18 04:06:13 -070070 uint32_t timestamp;
71 uint16_t sequence_number;
72 uint8_t payload_type;
henrik.lundin84f8cd62016-04-26 07:45:16 -070073 // Datagram excluding RTP header and header extension.
ossudc431ce2016-08-31 08:51:13 -070074 rtc::Buffer payload;
ossua70695a2016-09-22 02:06:28 -070075 Priority priority;
Chen Xing3e8ef942019-07-01 17:16:32 +020076 RtpPacketInfo packet_info;
henrik.lundin84f8cd62016-04-26 07:45:16 -070077 std::unique_ptr<TickTimer::Stopwatch> waiting_time;
ossu61a208b2016-09-20 01:38:00 -070078 std::unique_ptr<AudioDecoder::EncodedAudioFrame> frame;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000079
henrik.lundin84f8cd62016-04-26 07:45:16 -070080 Packet();
ossua73f6c92016-10-24 08:25:28 -070081 Packet(Packet&& b);
henrik.lundin84f8cd62016-04-26 07:45:16 -070082 ~Packet();
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000083
ossua73f6c92016-10-24 08:25:28 -070084 // Packets should generally be moved around but sometimes it's useful to make
85 // a copy, for example for testing purposes. NOTE: Will only work for
86 // un-parsed packets, i.e. |frame| must be unset. The payload will, however,
87 // be copied. |waiting_time| will also not be copied.
88 Packet Clone() const;
89
90 Packet& operator=(Packet&& b);
91
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000092 // Comparison operators. Establish a packet ordering based on (1) timestamp,
ossu17e3fa12016-09-08 04:52:55 -070093 // (2) sequence number and (3) redundancy.
turaj@webrtc.org7b75ac62013-09-26 00:27:56 +000094 // Timestamp and sequence numbers are compared taking wrap-around into
ossu17e3fa12016-09-08 04:52:55 -070095 // account. For two packets with the same sequence number and timestamp a
96 // primary payload is considered "smaller" than a secondary.
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000097 bool operator==(const Packet& rhs) const {
ossu7a377612016-10-18 04:06:13 -070098 return (this->timestamp == rhs.timestamp &&
99 this->sequence_number == rhs.sequence_number &&
ossua70695a2016-09-22 02:06:28 -0700100 this->priority == rhs.priority);
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000101 }
102 bool operator!=(const Packet& rhs) const { return !operator==(rhs); }
103 bool operator<(const Packet& rhs) const {
ossu7a377612016-10-18 04:06:13 -0700104 if (this->timestamp == rhs.timestamp) {
105 if (this->sequence_number == rhs.sequence_number) {
ossua70695a2016-09-22 02:06:28 -0700106 // Timestamp and sequence numbers are identical - deem the left hand
107 // side to be "smaller" (i.e., "earlier") if it has higher priority.
108 return this->priority < rhs.priority;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000109 }
ossu7a377612016-10-18 04:06:13 -0700110 return (static_cast<uint16_t>(rhs.sequence_number -
111 this->sequence_number) < 0xFFFF / 2);
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000112 }
ossu7a377612016-10-18 04:06:13 -0700113 return (static_cast<uint32_t>(rhs.timestamp - this->timestamp) <
114 0xFFFFFFFF / 2);
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000115 }
116 bool operator>(const Packet& rhs) const { return rhs.operator<(*this); }
117 bool operator<=(const Packet& rhs) const { return !operator>(rhs); }
118 bool operator>=(const Packet& rhs) const { return !operator<(rhs); }
ossu61a208b2016-09-20 01:38:00 -0700119
120 bool empty() const { return !frame && payload.empty(); }
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000121};
122
123// A list of packets.
ossua73f6c92016-10-24 08:25:28 -0700124typedef std::list<Packet> PacketList;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000125
126} // namespace webrtc
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200127#endif // MODULES_AUDIO_CODING_NETEQ_PACKET_H_