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
|
/**
*
* @copyright Copyright (c) 2020, Daniel Calviño Sánchez (danxuliu@gmail.com)
*
* @license AGPL-3.0-or-later
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
import {
QUALITY,
VideoConstrainer,
} from './VideoConstrainer'
/**
* Helper to adjust the quality of the sent video based on the current call
* state.
*
* The properties of the local video (like resolution or frame rate) can be
* changed on the fly during a call with immediate effect, without having to
* reconnect to the call. This class uses that feature to dynamically reduce or
* increase the video quality depending on the call state. Basically the goal is
* to reduce the CPU usage when there are too many participants in a call.
*
* @param {object} localMediaModel the model for the local media.
* @param {object} callParticipantCollection the collection.
* that contains the models for the rest of the participants in the call.
*/
export default function SentVideoQualityThrottler(localMediaModel, callParticipantCollection) {
this._localMediaModel = localMediaModel
this._callParticipantCollection = callParticipantCollection
this._videoConstrainer = new VideoConstrainer(localMediaModel)
this._gracePeriodAfterSpeakingTimeout = null
this._speakingOrInGracePeriodAfterSpeaking = false
this._availableVideosThreshold = {}
this._availableVideosThreshold[QUALITY.THUMBNAIL] = 15
this._availableVideosThreshold[QUALITY.VERY_LOW] = 10
this._availableVideosThreshold[QUALITY.LOW] = 7
this._availableVideosThreshold[QUALITY.MEDIUM] = 4
// QUALITY.HIGH otherwise
this._availableAudiosThreshold = {}
this._availableAudiosThreshold[QUALITY.THUMBNAIL] = 40
this._availableAudiosThreshold[QUALITY.VERY_LOW] = 30
this._availableAudiosThreshold[QUALITY.LOW] = 20
this._availableAudiosThreshold[QUALITY.MEDIUM] = 10
// QUALITY.HIGH otherwise
this._handleLocalVideoAvailableChangeBound = this._handleLocalVideoAvailableChange.bind(this)
this._handleAddParticipantBound = this._handleAddParticipant.bind(this)
this._handleRemoveParticipantBound = this._handleRemoveParticipant.bind(this)
this._handleLocalAudioEnabledChangeBound = this._handleLocalAudioEnabledChange.bind(this)
this._handleLocalSpeakingChangeBound = this._handleLocalSpeakingChange.bind(this)
this._adjustVideoQualityIfNeededBound = this._adjustVideoQualityIfNeeded.bind(this)
this._localMediaModel.on('change:videoAvailable', this._handleLocalVideoAvailableChangeBound)
if (this._localMediaModel.get('videoAvailable')) {
this._startListeningToChanges()
}
}
SentVideoQualityThrottler.prototype = {
destroy() {
this._localMediaModel.off('change:videoAvailable', this._handleLocalVideoAvailableChangeBound)
this._stopListeningToChanges()
},
_handleLocalVideoAvailableChange(localMediaModel, videoAvailable) {
if (videoAvailable) {
this._startListeningToChanges()
} else {
this._stopListeningToChanges()
}
},
_startListeningToChanges() {
this._localMediaModel.on('change:videoEnabled', this._adjustVideoQualityIfNeededBound)
this._localMediaModel.on('change:audioEnabled', this._handleLocalAudioEnabledChangeBound)
this._localMediaModel.on('change:speaking', this._handleLocalSpeakingChangeBound)
this._callParticipantCollection.on('add', this._handleAddParticipantBound)
this._callParticipantCollection.on('remove', this._handleRemoveParticipantBound)
this._callParticipantCollection.callParticipantModels.forEach(callParticipantModel => {
callParticipantModel.on('change:videoAvailable', this._adjustVideoQualityIfNeededBound)
callParticipantModel.on('change:audioAvailable', this._adjustVideoQualityIfNeededBound)
})
this._handleLocalSpeakingChange()
this._handleLocalAudioEnabledChange()
this._adjustVideoQualityIfNeeded()
},
_stopListeningToChanges() {
this._localMediaModel.off('change:videoEnabled', this._adjustVideoQualityIfNeededBound)
this._localMediaModel.off('change:audioEnabled', this._handleLocalAudioEnabledChangeBound)
this._localMediaModel.off('change:speaking', this._handleLocalSpeakingChangeBound)
this._callParticipantCollection.off('add', this._handleAddParticipantBound)
this._callParticipantCollection.off('remove', this._handleRemoveParticipantBound)
this._callParticipantCollection.callParticipantModels.forEach(callParticipantModel => {
callParticipantModel.off('change:videoAvailable', this._adjustVideoQualityIfNeededBound)
callParticipantModel.off('change:audioAvailable', this._adjustVideoQualityIfNeededBound)
})
},
_handleAddParticipant(callParticipantCollection, callParticipantModel) {
callParticipantModel.on('change:videoAvailable', this._adjustVideoQualityIfNeededBound)
callParticipantModel.on('change:audioAvailable', this._adjustVideoQualityIfNeededBound)
this._adjustVideoQualityIfNeeded()
},
_handleRemoveParticipant(callParticipantCollection, callParticipantModel) {
callParticipantModel.off('change:videoAvailable', this._adjustVideoQualityIfNeededBound)
callParticipantModel.off('change:audioAvailable', this._adjustVideoQualityIfNeededBound)
this._adjustVideoQualityIfNeeded()
},
_handleLocalAudioEnabledChange() {
if (this._localMediaModel.get('audioEnabled')) {
return
}
window.clearTimeout
|