LocalVideoTrackOptions.kt
6.2 KB
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
/*
* Copyright 2023-2025 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.android.room.track
import livekit.org.webrtc.RtpParameters
data class LocalVideoTrackOptions(
val isScreencast: Boolean = false,
/**
* Preferred deviceId to capture from. If not set or found,
* will prefer a camera according to [position]
*/
val deviceId: String? = null,
/**
* The camera position to use.
*/
val position: CameraPosition? = CameraPosition.FRONT,
/**
* Video capture options such as resolution and framerate.
*
* See [VideoPreset169] or [VideoPreset43] for preset parameters for common resolutions.
*/
val captureParams: VideoCaptureParameter = VideoPreset169.H720.capture,
)
data class VideoCaptureParameter
@JvmOverloads
constructor(
/**
* Desired width.
*/
val width: Int,
/**
* Desired height.
*/
val height: Int,
/**
* Capture frame rate.
*/
val maxFps: Int,
/**
* Sometimes the capturer may not support the exact desired dimensions requested.
* If this is enabled, it will scale down and crop the captured frames to the
* same aspect ratio as [width]:[height].
*/
val adaptOutputToDimensions: Boolean = true,
)
data class VideoEncoding(
val maxBitrate: Int,
val maxFps: Int,
) {
fun toRtpEncoding(
rid: String? = null,
scaleDownBy: Double = 1.0,
): RtpParameters.Encoding {
return RtpParameters.Encoding(rid, true, scaleDownBy).apply {
numTemporalLayers = 1
maxBitrateBps = maxBitrate
maxFramerate = maxFps
// only set on the full track
if (scaleDownBy == 1.0) {
networkPriority = 3 // high, from priority.h in webrtc
bitratePriority = 4.0
} else {
networkPriority = 1 // low, from priority.h in webrtc
bitratePriority = 1.0
}
}
}
}
enum class VideoCodec(val codecName: String) {
VP8("vp8"),
H264("h264"),
VP9("vp9"),
AV1("av1"),
H265("h265"),
;
companion object {
fun fromCodecName(codecName: String): VideoCodec {
return entries.first { it.codecName.equals(codecName, ignoreCase = true) }
}
}
}
enum class CameraPosition {
FRONT,
BACK,
}
interface VideoPreset {
val capture: VideoCaptureParameter
val encoding: VideoEncoding
}
/**
* 16:9 Video presets along with suggested bitrates
*/
enum class VideoPreset169(
override val capture: VideoCaptureParameter,
override val encoding: VideoEncoding,
) : VideoPreset {
H90(
VideoCaptureParameter(160, 90, 15),
VideoEncoding(90_000, 15),
),
H180(
VideoCaptureParameter(320, 180, 15),
VideoEncoding(160_000, 15),
),
H216(
VideoCaptureParameter(384, 216, 15),
VideoEncoding(180_000, 15),
),
H360(
VideoCaptureParameter(640, 360, 30),
VideoEncoding(450_000, 30),
),
H540(
VideoCaptureParameter(960, 540, 30),
VideoEncoding(800_000, 30),
),
H720(
VideoCaptureParameter(1280, 720, 30),
VideoEncoding(1_700_000, 30),
),
H1080(
VideoCaptureParameter(1920, 1080, 30),
VideoEncoding(3_000_000, 30),
),
H1440(
VideoCaptureParameter(2560, 1440, 30),
VideoEncoding(5_000_000, 30),
),
H2160(
VideoCaptureParameter(3840, 2160, 30),
VideoEncoding(8_000_000, 30),
),
}
/**
* 4:3 Video presets along with suggested bitrates
*/
enum class VideoPreset43(
override val capture: VideoCaptureParameter,
override val encoding: VideoEncoding,
) : VideoPreset {
H120(
VideoCaptureParameter(160, 120, 15),
VideoEncoding(70_000, 15),
),
H180(
VideoCaptureParameter(240, 180, 15),
VideoEncoding(125_000, 15),
),
H240(
VideoCaptureParameter(320, 240, 15),
VideoEncoding(140_000, 15),
),
H360(
VideoCaptureParameter(480, 360, 30),
VideoEncoding(330_000, 30),
),
H480(
VideoCaptureParameter(640, 480, 30),
VideoEncoding(500_000, 30),
),
H540(
VideoCaptureParameter(720, 540, 30),
VideoEncoding(600_000, 30),
),
H720(
VideoCaptureParameter(960, 720, 30),
VideoEncoding(1_300_000, 30),
),
H1080(
VideoCaptureParameter(1440, 1080, 30),
VideoEncoding(2_300_000, 30),
),
H1440(
VideoCaptureParameter(1920, 1440, 30),
VideoEncoding(3_800_000, 30),
),
}
/**
* 16:9 Video presets along with suggested bitrates.
*/
enum class ScreenSharePresets(
override val capture: VideoCaptureParameter,
override val encoding: VideoEncoding,
) : VideoPreset {
H360_FPS3(
VideoCaptureParameter(640, 360, 3),
VideoEncoding(200_000, 3),
),
H360_FPS15(
VideoCaptureParameter(640, 360, 15),
VideoEncoding(400_000, 15),
),
H720_FPS5(
VideoCaptureParameter(1280, 720, 5),
VideoEncoding(800_000, 5),
),
H720_FPS15(
VideoCaptureParameter(1280, 720, 15),
VideoEncoding(1_500_000, 15),
),
H720_FPS30(
VideoCaptureParameter(1280, 720, 30),
VideoEncoding(2_000_000, 30),
),
H1080_FPS15(
VideoCaptureParameter(1920, 1080, 15),
VideoEncoding(2_500_000, 15),
),
H1080_FPS30(
VideoCaptureParameter(1920, 1080, 30),
VideoEncoding(5_000_000, 30),
),
/**
* Uses the original resolution without resizing.
*/
ORIGINAL(
VideoCaptureParameter(0, 0, 30, adaptOutputToDimensions = false),
VideoEncoding(7_000_000, 30),
)
}