blob: c07fae9b8bb18ea58ad276688545223dd2685c2a [file] [log] [blame]
Niels Möller802506c2018-05-31 10:44:51 +02001/*
2 * Copyright (c) 2018 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_CODECS_VIDEO_CODEC_H_
12#define API_VIDEO_CODECS_VIDEO_CODEC_H_
13
Yves Gerey988cc082018-10-23 12:03:01 +020014#include <stddef.h>
15#include <stdint.h>
Jonas Olssona4d87372019-07-05 19:08:33 +020016
Niels Möllera46bd4b2018-06-08 14:03:44 +020017#include <string>
Niels Möller802506c2018-05-31 10:44:51 +020018
Artem Titov8525a802019-12-16 11:41:57 +010019#include "absl/types/optional.h"
Yves Gerey988cc082018-10-23 12:03:01 +020020#include "api/video/video_bitrate_allocation.h"
Niels Möller22b70ff2018-11-20 11:06:58 +010021#include "api/video/video_codec_type.h"
Jerome Jiang7f7fb832020-06-03 20:44:50 -070022#include "common_types.h" // NOLINT(build/include_directory)
Mirko Bonadei276827c2018-10-16 14:13:50 +020023#include "rtc_base/system/rtc_export.h"
Niels Möller802506c2018-05-31 10:44:51 +020024
Niels Möllera46bd4b2018-06-08 14:03:44 +020025namespace webrtc {
26
27// The VideoCodec class represents an old defacto-apis, which we're migrating
Niels Möller802506c2018-05-31 10:44:51 +020028// away from slowly.
29
Niels Möllera46bd4b2018-06-08 14:03:44 +020030// Video codec
Niels Möllere3cf3d02018-06-13 11:52:16 +020031enum class VideoCodecComplexity {
Niels Möllera46bd4b2018-06-08 14:03:44 +020032 kComplexityNormal = 0,
33 kComplexityHigh = 1,
34 kComplexityHigher = 2,
35 kComplexityMax = 3
36};
37
38// VP8 specific
39struct VideoCodecVP8 {
40 bool operator==(const VideoCodecVP8& other) const;
41 bool operator!=(const VideoCodecVP8& other) const {
42 return !(*this == other);
43 }
44 VideoCodecComplexity complexity;
45 unsigned char numberOfTemporalLayers;
46 bool denoisingOn;
47 bool automaticResizeOn;
48 bool frameDroppingOn;
49 int keyFrameInterval;
50};
51
Sergey Silkincf267052019-04-09 11:40:09 +020052enum class InterLayerPredMode : int {
53 kOff = 0, // Inter-layer prediction is disabled.
54 kOn = 1, // Inter-layer prediction is enabled.
55 kOnKeyPic = 2 // Inter-layer prediction is enabled but limited to key frames.
Niels Möllera46bd4b2018-06-08 14:03:44 +020056};
57
58// VP9 specific.
59struct VideoCodecVP9 {
60 bool operator==(const VideoCodecVP9& other) const;
61 bool operator!=(const VideoCodecVP9& other) const {
62 return !(*this == other);
63 }
64 VideoCodecComplexity complexity;
65 unsigned char numberOfTemporalLayers;
66 bool denoisingOn;
67 bool frameDroppingOn;
68 int keyFrameInterval;
69 bool adaptiveQpMode;
70 bool automaticResizeOn;
71 unsigned char numberOfSpatialLayers;
72 bool flexibleMode;
73 InterLayerPredMode interLayerPred;
74};
75
76// H264 specific.
77struct VideoCodecH264 {
78 bool operator==(const VideoCodecH264& other) const;
79 bool operator!=(const VideoCodecH264& other) const {
80 return !(*this == other);
81 }
82 bool frameDroppingOn;
83 int keyFrameInterval;
Johnny Lee1a1c52b2019-02-08 14:25:40 -050084 uint8_t numberOfTemporalLayers;
Niels Möllera46bd4b2018-06-08 14:03:44 +020085};
86
87// Translates from name of codec to codec type and vice versa.
Mirko Bonadeiac194142018-10-22 17:08:37 +020088RTC_EXPORT const char* CodecTypeToPayloadString(VideoCodecType type);
89RTC_EXPORT VideoCodecType PayloadStringToCodecType(const std::string& name);
Niels Möllera46bd4b2018-06-08 14:03:44 +020090
91union VideoCodecUnion {
92 VideoCodecVP8 VP8;
93 VideoCodecVP9 VP9;
94 VideoCodecH264 H264;
95};
96
Niels Möllere3cf3d02018-06-13 11:52:16 +020097enum class VideoCodecMode { kRealtimeVideo, kScreensharing };
Niels Möllera46bd4b2018-06-08 14:03:44 +020098
99// Common video codec properties
Mirko Bonadei276827c2018-10-16 14:13:50 +0200100class RTC_EXPORT VideoCodec {
Niels Möllera46bd4b2018-06-08 14:03:44 +0200101 public:
102 VideoCodec();
103
104 // Public variables. TODO(hta): Make them private with accessors.
105 VideoCodecType codecType;
106 unsigned char plType;
107
108 // TODO(nisse): Change to int, for consistency.
109 uint16_t width;
110 uint16_t height;
111
Jonas Olssona4d87372019-07-05 19:08:33 +0200112 unsigned int startBitrate; // kilobits/sec.
113 unsigned int maxBitrate; // kilobits/sec.
114 unsigned int minBitrate; // kilobits/sec.
Niels Möllera46bd4b2018-06-08 14:03:44 +0200115
116 uint32_t maxFramerate;
117
118 // This enables/disables encoding and sending when there aren't multiple
119 // simulcast streams,by allocating 0 bitrate if inactive.
120 bool active;
121
122 unsigned int qpMax;
123 unsigned char numberOfSimulcastStreams;
124 SimulcastStream simulcastStream[kMaxSimulcastStreams];
125 SpatialLayer spatialLayers[kMaxSpatialLayers];
126
127 VideoCodecMode mode;
128 bool expect_encode_from_texture;
129
Artem Titov8525a802019-12-16 11:41:57 +0100130 // The size of pool which is used to store video frame buffers inside decoder.
131 // If value isn't present some codec-default value will be used.
132 // If value is present and decoder doesn't have buffer pool the
133 // value will be ignored.
134 absl::optional<int> buffer_pool_size;
135
Niels Möllera46bd4b2018-06-08 14:03:44 +0200136 // Timing frames configuration. There is delay of delay_ms between two
137 // consequent timing frames, excluding outliers. Frame is always made a
138 // timing frame if it's at least outlier_ratio in percent of "ideal" average
139 // frame given bitrate and framerate, i.e. if it's bigger than
140 // |outlier_ratio / 100.0 * bitrate_bps / fps| in bits. This way, timing
141 // frames will not be sent too often usually. Yet large frames will always
142 // have timing information for debug purposes because they are more likely to
143 // cause extra delays.
144 struct TimingFrameTriggerThresholds {
145 int64_t delay_ms;
146 uint16_t outlier_ratio_percent;
147 } timing_frame_thresholds;
148
149 bool operator==(const VideoCodec& other) const = delete;
150 bool operator!=(const VideoCodec& other) const = delete;
151
152 // Accessors for codec specific information.
153 // There is a const version of each that returns a reference,
154 // and a non-const version that returns a pointer, in order
155 // to allow modification of the parameters.
156 VideoCodecVP8* VP8();
157 const VideoCodecVP8& VP8() const;
158 VideoCodecVP9* VP9();
159 const VideoCodecVP9& VP9() const;
160 VideoCodecH264* H264();
161 const VideoCodecH264& H264() const;
162
163 private:
164 // TODO(hta): Consider replacing the union with a pointer type.
165 // This will allow removing the VideoCodec* types from this file.
166 VideoCodecUnion codec_specific_;
167};
168
169} // namespace webrtc
Niels Möller802506c2018-05-31 10:44:51 +0200170#endif // API_VIDEO_CODECS_VIDEO_CODEC_H_