blob: 4828b0273315c70f31fdb06a7f171eca4f5c280c [file] [log] [blame]
Niels Möller4dc66c52018-10-05 14:17:58 +02001/*
2 * Copyright (c) 2014 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_VIDEO_ENCODED_IMAGE_H_
12#define API_VIDEO_ENCODED_IMAGE_H_
13
Yves Gerey988cc082018-10-23 12:03:01 +020014#include <stdint.h>
15
Niels Möller4dc66c52018-10-05 14:17:58 +020016#include "absl/types/optional.h"
Johannes Kron4749e4e2018-11-21 10:18:18 +010017#include "api/video/color_space.h"
Yves Gerey988cc082018-10-23 12:03:01 +020018#include "api/video/video_bitrate_allocation.h"
Niels Möller22b70ff2018-11-20 11:06:58 +010019#include "api/video/video_codec_type.h"
Niels Möller4dc66c52018-10-05 14:17:58 +020020#include "api/video/video_content_type.h"
21#include "api/video/video_rotation.h"
22#include "api/video/video_timing.h"
23#include "common_types.h" // NOLINT(build/include)
Yves Gerey988cc082018-10-23 12:03:01 +020024#include "rtc_base/checks.h"
Mirko Bonadeiac194142018-10-22 17:08:37 +020025#include "rtc_base/system/rtc_export.h"
Niels Möller4dc66c52018-10-05 14:17:58 +020026
27namespace webrtc {
28
29// TODO(bug.webrtc.org/9378): This is a legacy api class, which is slowly being
30// cleaned up. Direct use of its members is strongly discouraged.
Mirko Bonadeiac194142018-10-22 17:08:37 +020031class RTC_EXPORT EncodedImage {
Niels Möller4dc66c52018-10-05 14:17:58 +020032 public:
33 static const size_t kBufferPaddingBytesH264;
34
35 // Some decoders require encoded image buffers to be padded with a small
36 // number of additional bytes (due to over-reading byte readers).
37 static size_t GetBufferPaddingBytes(VideoCodecType codec_type);
38
39 EncodedImage();
40 EncodedImage(const EncodedImage&);
Niels Möllera6fd5e42018-12-10 09:07:28 +010041 EncodedImage(uint8_t* buffer, size_t length, size_t capacity);
Niels Möller4dc66c52018-10-05 14:17:58 +020042
43 // TODO(nisse): Change style to timestamp(), set_timestamp(), for consistency
44 // with the VideoFrame class.
45 // Set frame timestamp (90kHz).
46 void SetTimestamp(uint32_t timestamp) { timestamp_rtp_ = timestamp; }
47
48 // Get frame timestamp (90kHz).
49 uint32_t Timestamp() const { return timestamp_rtp_; }
50
51 void SetEncodeTime(int64_t encode_start_ms, int64_t encode_finish_ms);
52
53 absl::optional<int> SpatialIndex() const {
Niels Möller4dc66c52018-10-05 14:17:58 +020054 return spatial_index_;
55 }
56 void SetSpatialIndex(absl::optional<int> spatial_index) {
57 RTC_DCHECK_GE(spatial_index.value_or(0), 0);
58 RTC_DCHECK_LT(spatial_index.value_or(0), kMaxSpatialLayers);
Johannes Kron9973fa82018-11-07 14:39:26 +010059 spatial_index_ = spatial_index;
60 }
61
Johannes Kron4749e4e2018-11-21 10:18:18 +010062 const webrtc::ColorSpace* ColorSpace() const {
63 return color_space_ ? &*color_space_ : nullptr;
Johannes Kron9973fa82018-11-07 14:39:26 +010064 }
Johannes Kron4749e4e2018-11-21 10:18:18 +010065 void SetColorSpace(const webrtc::ColorSpace* color_space) {
66 color_space_ =
67 color_space ? absl::make_optional(*color_space) : absl::nullopt;
Niels Möller4dc66c52018-10-05 14:17:58 +020068 }
69
Niels Möller77536a22019-01-15 08:50:01 +010070 size_t size() const { return size_; }
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +010071 void set_size(size_t new_size) {
Niels Möllera6fd5e42018-12-10 09:07:28 +010072 RTC_DCHECK_LE(new_size, capacity_);
Niels Möller77536a22019-01-15 08:50:01 +010073 size_ = new_size;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +010074 }
Niels Möllera6fd5e42018-12-10 09:07:28 +010075 size_t capacity() const { return capacity_; }
Niels Möllerf0eee002018-11-28 16:31:29 +010076
Niels Möller77894cc2018-12-04 15:38:15 +010077 void set_buffer(uint8_t* buffer, size_t capacity) {
78 _buffer = buffer;
Niels Möllera6fd5e42018-12-10 09:07:28 +010079 capacity_ = capacity;
Niels Möller77894cc2018-12-04 15:38:15 +010080 }
81
Niels Möllera8f58f02019-01-10 15:12:49 +010082 uint8_t* data() { return _buffer; }
83 const uint8_t* data() const { return _buffer; }
84
Niels Möller4dc66c52018-10-05 14:17:58 +020085 uint32_t _encodedWidth = 0;
86 uint32_t _encodedHeight = 0;
87 // NTP time of the capture time in local timebase in milliseconds.
88 int64_t ntp_time_ms_ = 0;
89 int64_t capture_time_ms_ = 0;
90 FrameType _frameType = kVideoFrameDelta;
91 uint8_t* _buffer;
Niels Möller4dc66c52018-10-05 14:17:58 +020092 VideoRotation rotation_ = kVideoRotation_0;
93 VideoContentType content_type_ = VideoContentType::UNSPECIFIED;
94 bool _completeFrame = false;
95 int qp_ = -1; // Quantizer value.
96
97 // When an application indicates non-zero values here, it is taken as an
98 // indication that all future frames will be constrained with those limits
99 // until the application indicates a change again.
100 PlayoutDelay playout_delay_ = {-1, -1};
101
102 struct Timing {
103 uint8_t flags = VideoSendTiming::kInvalid;
104 int64_t encode_start_ms = 0;
105 int64_t encode_finish_ms = 0;
106 int64_t packetization_finish_ms = 0;
107 int64_t pacer_exit_ms = 0;
108 int64_t network_timestamp_ms = 0;
109 int64_t network2_timestamp_ms = 0;
110 int64_t receive_start_ms = 0;
111 int64_t receive_finish_ms = 0;
112 } timing_;
113
114 private:
Niels Möller77536a22019-01-15 08:50:01 +0100115 size_t size_; // Size of encoded frame data.
Niels Möllera6fd5e42018-12-10 09:07:28 +0100116 size_t capacity_; // Allocated size of _buffer.
Niels Möller4dc66c52018-10-05 14:17:58 +0200117 uint32_t timestamp_rtp_ = 0;
Johannes Kron9973fa82018-11-07 14:39:26 +0100118 absl::optional<int> spatial_index_;
Johannes Kron4749e4e2018-11-21 10:18:18 +0100119 absl::optional<webrtc::ColorSpace> color_space_;
Niels Möller4dc66c52018-10-05 14:17:58 +0200120};
121
122} // namespace webrtc
123
124#endif // API_VIDEO_ENCODED_IMAGE_H_