blob: 8661b6ee0aabbebf49721bf5b49115ce0408236a [file] [log] [blame]
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -08001/*
2 * Copyright 2019 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Ady Abraham2139f732019-11-13 18:56:40 -080016
Ady Abraham8a82ba62020-01-17 12:43:17 -080017// #define LOG_NDEBUG 0
18#define ATRACE_TAG ATRACE_TAG_GRAPHICS
19
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080020#include "RefreshRateConfigs.h"
Ady Abraham8a82ba62020-01-17 12:43:17 -080021#include <android-base/stringprintf.h>
22#include <utils/Trace.h>
23#include <chrono>
24#include <cmath>
25
Ady Abraham5b8afb5a2020-03-06 14:57:26 -080026#undef LOG_TAG
27#define LOG_TAG "RefreshRateConfigs"
28
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080029namespace android::scheduler {
Ady Abraham2139f732019-11-13 18:56:40 -080030
31using AllRefreshRatesMapType = RefreshRateConfigs::AllRefreshRatesMapType;
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080032using RefreshRate = RefreshRateConfigs::RefreshRate;
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080033
Ady Abrahama6b676e2020-05-27 14:29:09 -070034std::string RefreshRateConfigs::layerVoteTypeString(LayerVoteType vote) {
35 switch (vote) {
36 case LayerVoteType::NoVote:
37 return "NoVote";
38 case LayerVoteType::Min:
39 return "Min";
40 case LayerVoteType::Max:
41 return "Max";
42 case LayerVoteType::Heuristic:
43 return "Heuristic";
44 case LayerVoteType::ExplicitDefault:
45 return "ExplicitDefault";
46 case LayerVoteType::ExplicitExactOrMultiple:
47 return "ExplicitExactOrMultiple";
48 }
49}
50
Ady Abraham8a82ba62020-01-17 12:43:17 -080051const RefreshRate& RefreshRateConfigs::getRefreshRateForContent(
52 const std::vector<LayerRequirement>& layers) const {
Ady Abraham2139f732019-11-13 18:56:40 -080053 std::lock_guard lock(mLock);
Ady Abrahamdec1a412020-01-24 10:23:50 -080054 int contentFramerate = 0;
55 int explicitContentFramerate = 0;
Ady Abraham8a82ba62020-01-17 12:43:17 -080056 for (const auto& layer : layers) {
Ady Abrahamdec1a412020-01-24 10:23:50 -080057 const auto desiredRefreshRateRound = round<int>(layer.desiredRefreshRate);
Ady Abraham71c437d2020-01-31 15:56:57 -080058 if (layer.vote == LayerVoteType::ExplicitDefault ||
59 layer.vote == LayerVoteType::ExplicitExactOrMultiple) {
Ady Abrahamdec1a412020-01-24 10:23:50 -080060 if (desiredRefreshRateRound > explicitContentFramerate) {
61 explicitContentFramerate = desiredRefreshRateRound;
Ady Abraham8a82ba62020-01-17 12:43:17 -080062 }
63 } else {
Ady Abrahamdec1a412020-01-24 10:23:50 -080064 if (desiredRefreshRateRound > contentFramerate) {
65 contentFramerate = desiredRefreshRateRound;
Ady Abraham8a82ba62020-01-17 12:43:17 -080066 }
67 }
68 }
69
Ady Abrahamdec1a412020-01-24 10:23:50 -080070 if (explicitContentFramerate != 0) {
Ady Abraham8a82ba62020-01-17 12:43:17 -080071 contentFramerate = explicitContentFramerate;
Ady Abrahamdec1a412020-01-24 10:23:50 -080072 } else if (contentFramerate == 0) {
Ady Abrahamabc27602020-04-08 17:20:29 -070073 contentFramerate = round<int>(mMaxSupportedRefreshRate->getFps());
Ady Abraham8a82ba62020-01-17 12:43:17 -080074 }
Ady Abraham8a82ba62020-01-17 12:43:17 -080075 ATRACE_INT("ContentFPS", contentFramerate);
76
Ady Abraham2139f732019-11-13 18:56:40 -080077 // Find the appropriate refresh rate with minimal error
Steven Thomasf734df42020-04-13 21:09:28 -070078 auto iter = min_element(mPrimaryRefreshRates.cbegin(), mPrimaryRefreshRates.cend(),
Ady Abraham2139f732019-11-13 18:56:40 -080079 [contentFramerate](const auto& lhs, const auto& rhs) -> bool {
80 return std::abs(lhs->fps - contentFramerate) <
81 std::abs(rhs->fps - contentFramerate);
82 });
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080083
Ady Abraham2139f732019-11-13 18:56:40 -080084 // Some content aligns better on higher refresh rate. For example for 45fps we should choose
85 // 90Hz config. However we should still prefer a lower refresh rate if the content doesn't
86 // align well with both
87 const RefreshRate* bestSoFar = *iter;
88 constexpr float MARGIN = 0.05f;
89 float ratio = (*iter)->fps / contentFramerate;
90 if (std::abs(std::round(ratio) - ratio) > MARGIN) {
Steven Thomasf734df42020-04-13 21:09:28 -070091 while (iter != mPrimaryRefreshRates.cend()) {
Ady Abraham2139f732019-11-13 18:56:40 -080092 ratio = (*iter)->fps / contentFramerate;
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080093
Ady Abraham2139f732019-11-13 18:56:40 -080094 if (std::abs(std::round(ratio) - ratio) <= MARGIN) {
95 bestSoFar = *iter;
96 break;
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080097 }
Ady Abraham2139f732019-11-13 18:56:40 -080098 ++iter;
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -080099 }
100 }
101
Ady Abraham2139f732019-11-13 18:56:40 -0800102 return *bestSoFar;
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -0800103}
104
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800105std::pair<nsecs_t, nsecs_t> RefreshRateConfigs::getDisplayFrames(nsecs_t layerPeriod,
106 nsecs_t displayPeriod) const {
107 auto [displayFramesQuot, displayFramesRem] = std::div(layerPeriod, displayPeriod);
108 if (displayFramesRem <= MARGIN_FOR_PERIOD_CALCULATION ||
109 std::abs(displayFramesRem - displayPeriod) <= MARGIN_FOR_PERIOD_CALCULATION) {
110 displayFramesQuot++;
111 displayFramesRem = 0;
112 }
113
114 return {displayFramesQuot, displayFramesRem};
115}
116
Steven Thomasbb374322020-04-28 22:47:16 -0700117const RefreshRate& RefreshRateConfigs::getBestRefreshRate(
Ady Abrahamdfd62162020-06-10 16:11:56 -0700118 const std::vector<LayerRequirement>& layers, const GlobalSignals& globalSignals,
119 GlobalSignals* outSignalsConsidered) const {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800120 ATRACE_CALL();
121 ALOGV("getRefreshRateForContent %zu layers", layers.size());
122
Ady Abrahamdfd62162020-06-10 16:11:56 -0700123 if (outSignalsConsidered) *outSignalsConsidered = {};
124 const auto setTouchConsidered = [&] {
125 if (outSignalsConsidered) {
126 outSignalsConsidered->touch = true;
127 }
128 };
129
130 const auto setIdleConsidered = [&] {
131 if (outSignalsConsidered) {
132 outSignalsConsidered->idle = true;
133 }
134 };
135
Ady Abraham8a82ba62020-01-17 12:43:17 -0800136 std::lock_guard lock(mLock);
137
138 int noVoteLayers = 0;
139 int minVoteLayers = 0;
140 int maxVoteLayers = 0;
Ady Abraham71c437d2020-01-31 15:56:57 -0800141 int explicitDefaultVoteLayers = 0;
142 int explicitExactOrMultipleVoteLayers = 0;
Ady Abraham6fb599b2020-03-05 13:48:22 -0800143 float maxExplicitWeight = 0;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800144 for (const auto& layer : layers) {
Ady Abraham6fb599b2020-03-05 13:48:22 -0800145 if (layer.vote == LayerVoteType::NoVote) {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800146 noVoteLayers++;
Ady Abraham6fb599b2020-03-05 13:48:22 -0800147 } else if (layer.vote == LayerVoteType::Min) {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800148 minVoteLayers++;
Ady Abraham6fb599b2020-03-05 13:48:22 -0800149 } else if (layer.vote == LayerVoteType::Max) {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800150 maxVoteLayers++;
Ady Abraham6fb599b2020-03-05 13:48:22 -0800151 } else if (layer.vote == LayerVoteType::ExplicitDefault) {
Ady Abraham71c437d2020-01-31 15:56:57 -0800152 explicitDefaultVoteLayers++;
Ady Abraham6fb599b2020-03-05 13:48:22 -0800153 maxExplicitWeight = std::max(maxExplicitWeight, layer.weight);
154 } else if (layer.vote == LayerVoteType::ExplicitExactOrMultiple) {
Ady Abraham71c437d2020-01-31 15:56:57 -0800155 explicitExactOrMultipleVoteLayers++;
Ady Abraham6fb599b2020-03-05 13:48:22 -0800156 maxExplicitWeight = std::max(maxExplicitWeight, layer.weight);
157 }
158 }
159
Alec Mouri11232a22020-05-14 18:06:25 -0700160 const bool hasExplicitVoteLayers =
161 explicitDefaultVoteLayers > 0 || explicitExactOrMultipleVoteLayers > 0;
162
Steven Thomasf734df42020-04-13 21:09:28 -0700163 // Consider the touch event if there are no Explicit* layers. Otherwise wait until after we've
164 // selected a refresh rate to see if we should apply touch boost.
Ady Abrahamdfd62162020-06-10 16:11:56 -0700165 if (globalSignals.touch && !hasExplicitVoteLayers) {
Ady Abrahama6b676e2020-05-27 14:29:09 -0700166 ALOGV("TouchBoost - choose %s", getMaxRefreshRateByPolicyLocked().getName().c_str());
Ady Abrahamdfd62162020-06-10 16:11:56 -0700167 setTouchConsidered();
Steven Thomasf734df42020-04-13 21:09:28 -0700168 return getMaxRefreshRateByPolicyLocked();
Ady Abraham8a82ba62020-01-17 12:43:17 -0800169 }
170
Alec Mouri11232a22020-05-14 18:06:25 -0700171 // If the primary range consists of a single refresh rate then we can only
172 // move out the of range if layers explicitly request a different refresh
173 // rate.
174 const Policy* policy = getCurrentPolicyLocked();
175 const bool primaryRangeIsSingleRate = policy->primaryRange.min == policy->primaryRange.max;
176
Ady Abrahamdfd62162020-06-10 16:11:56 -0700177 if (!globalSignals.touch && globalSignals.idle &&
178 !(primaryRangeIsSingleRate && hasExplicitVoteLayers)) {
Ady Abrahama6b676e2020-05-27 14:29:09 -0700179 ALOGV("Idle - choose %s", getMinRefreshRateByPolicyLocked().getName().c_str());
Ady Abrahamdfd62162020-06-10 16:11:56 -0700180 setIdleConsidered();
Steven Thomasbb374322020-04-28 22:47:16 -0700181 return getMinRefreshRateByPolicyLocked();
182 }
183
Steven Thomasdebafed2020-05-18 17:30:35 -0700184 if (layers.empty() || noVoteLayers == layers.size()) {
185 return getMaxRefreshRateByPolicyLocked();
Steven Thomasbb374322020-04-28 22:47:16 -0700186 }
187
Ady Abraham8a82ba62020-01-17 12:43:17 -0800188 // Only if all layers want Min we should return Min
189 if (noVoteLayers + minVoteLayers == layers.size()) {
Ady Abrahama6b676e2020-05-27 14:29:09 -0700190 ALOGV("all layers Min - choose %s", getMinRefreshRateByPolicyLocked().getName().c_str());
Steven Thomasf734df42020-04-13 21:09:28 -0700191 return getMinRefreshRateByPolicyLocked();
Ady Abraham8a82ba62020-01-17 12:43:17 -0800192 }
193
Ady Abraham8a82ba62020-01-17 12:43:17 -0800194 // Find the best refresh rate based on score
195 std::vector<std::pair<const RefreshRate*, float>> scores;
Steven Thomasf734df42020-04-13 21:09:28 -0700196 scores.reserve(mAppRequestRefreshRates.size());
Ady Abraham8a82ba62020-01-17 12:43:17 -0800197
Steven Thomasf734df42020-04-13 21:09:28 -0700198 for (const auto refreshRate : mAppRequestRefreshRates) {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800199 scores.emplace_back(refreshRate, 0.0f);
200 }
201
202 for (const auto& layer : layers) {
Ady Abrahama6b676e2020-05-27 14:29:09 -0700203 ALOGV("Calculating score for %s (%s, weight %.2f)", layer.name.c_str(),
204 layerVoteTypeString(layer.vote).c_str(), layer.weight);
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800205 if (layer.vote == LayerVoteType::NoVote || layer.vote == LayerVoteType::Min) {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800206 continue;
207 }
208
Ady Abraham71c437d2020-01-31 15:56:57 -0800209 auto weight = layer.weight;
Ady Abraham71c437d2020-01-31 15:56:57 -0800210
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800211 for (auto i = 0u; i < scores.size(); i++) {
Steven Thomasf734df42020-04-13 21:09:28 -0700212 bool inPrimaryRange =
213 scores[i].first->inPolicy(policy->primaryRange.min, policy->primaryRange.max);
Alec Mouri11232a22020-05-14 18:06:25 -0700214 if ((primaryRangeIsSingleRate || !inPrimaryRange) &&
Ady Abraham20c029c2020-07-06 12:58:05 -0700215 !(layer.focused && layer.vote == LayerVoteType::ExplicitDefault)) {
216 // Only focused layers with ExplicitDefault frame rate settings are allowed to score
Ady Abrahamaae5ed52020-06-26 09:32:43 -0700217 // refresh rates outside the primary range.
Steven Thomasf734df42020-04-13 21:09:28 -0700218 continue;
219 }
220
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800221 // If the layer wants Max, give higher score to the higher refresh rate
222 if (layer.vote == LayerVoteType::Max) {
223 const auto ratio = scores[i].first->fps / scores.back().first->fps;
224 // use ratio^2 to get a lower score the more we get further from peak
225 const auto layerScore = ratio * ratio;
226 ALOGV("%s (Max, weight %.2f) gives %s score of %.2f", layer.name.c_str(), weight,
227 scores[i].first->name.c_str(), layerScore);
228 scores[i].second += weight * layerScore;
229 continue;
Ady Abraham71c437d2020-01-31 15:56:57 -0800230 }
Ady Abraham8a82ba62020-01-17 12:43:17 -0800231
Ady Abrahamabc27602020-04-08 17:20:29 -0700232 const auto displayPeriod = scores[i].first->hwcConfig->getVsyncPeriod();
Ady Abrahamdec1a412020-01-24 10:23:50 -0800233 const auto layerPeriod = round<nsecs_t>(1e9f / layer.desiredRefreshRate);
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800234 if (layer.vote == LayerVoteType::ExplicitDefault) {
235 const auto layerScore = [&]() {
Ady Abraham5b8afb5a2020-03-06 14:57:26 -0800236 // Find the actual rate the layer will render, assuming
237 // that layerPeriod is the minimal time to render a frame
238 auto actualLayerPeriod = displayPeriod;
239 int multiplier = 1;
240 while (layerPeriod > actualLayerPeriod + MARGIN_FOR_PERIOD_CALCULATION) {
241 multiplier++;
242 actualLayerPeriod = displayPeriod * multiplier;
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800243 }
Ady Abraham5b8afb5a2020-03-06 14:57:26 -0800244 return std::min(1.0f,
245 static_cast<float>(layerPeriod) /
246 static_cast<float>(actualLayerPeriod));
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800247 }();
248
249 ALOGV("%s (ExplicitDefault, weight %.2f) %.2fHz gives %s score of %.2f",
250 layer.name.c_str(), weight, 1e9f / layerPeriod, scores[i].first->name.c_str(),
251 layerScore);
252 scores[i].second += weight * layerScore;
253 continue;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800254 }
255
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800256 if (layer.vote == LayerVoteType::ExplicitExactOrMultiple ||
257 layer.vote == LayerVoteType::Heuristic) {
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700258 const auto layerScore = [&] {
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800259 // Calculate how many display vsyncs we need to present a single frame for this
260 // layer
261 const auto [displayFramesQuot, displayFramesRem] =
262 getDisplayFrames(layerPeriod, displayPeriod);
263 static constexpr size_t MAX_FRAMES_TO_FIT =
264 10; // Stop calculating when score < 0.1
265 if (displayFramesRem == 0) {
266 // Layer desired refresh rate matches the display rate.
267 return 1.0f;
268 }
Ady Abraham8a82ba62020-01-17 12:43:17 -0800269
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800270 if (displayFramesQuot == 0) {
271 // Layer desired refresh rate is higher the display rate.
272 return (static_cast<float>(layerPeriod) /
273 static_cast<float>(displayPeriod)) *
274 (1.0f / (MAX_FRAMES_TO_FIT + 1));
275 }
276
277 // Layer desired refresh rate is lower the display rate. Check how well it fits
278 // the cadence
279 auto diff = std::abs(displayFramesRem - (displayPeriod - displayFramesRem));
280 int iter = 2;
281 while (diff > MARGIN_FOR_PERIOD_CALCULATION && iter < MAX_FRAMES_TO_FIT) {
282 diff = diff - (displayPeriod - diff);
283 iter++;
284 }
285
286 return 1.0f / iter;
287 }();
Ady Abrahama6b676e2020-05-27 14:29:09 -0700288 ALOGV("%s (%s, weight %.2f) %.2fHz gives %s score of %.2f", layer.name.c_str(),
289 layerVoteTypeString(layer.vote).c_str(), weight, 1e9f / layerPeriod,
290 scores[i].first->name.c_str(), layerScore);
Ady Abraham4ccdcb42020-02-11 17:34:34 -0800291 scores[i].second += weight * layerScore;
292 continue;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800293 }
Ady Abraham8a82ba62020-01-17 12:43:17 -0800294 }
295 }
296
Ady Abraham34702102020-02-10 14:12:05 -0800297 // Now that we scored all the refresh rates we need to pick the one that got the highest score.
298 // In case of a tie we will pick the higher refresh rate if any of the layers wanted Max,
299 // or the lower otherwise.
300 const RefreshRate* bestRefreshRate = maxVoteLayers > 0
301 ? getBestRefreshRate(scores.rbegin(), scores.rend())
302 : getBestRefreshRate(scores.begin(), scores.end());
303
Alec Mouri11232a22020-05-14 18:06:25 -0700304 if (primaryRangeIsSingleRate) {
305 // If we never scored any layers, then choose the rate from the primary
306 // range instead of picking a random score from the app range.
307 if (std::all_of(scores.begin(), scores.end(),
308 [](std::pair<const RefreshRate*, float> p) { return p.second == 0; })) {
Ady Abrahama6b676e2020-05-27 14:29:09 -0700309 ALOGV("layers not scored - choose %s",
310 getMaxRefreshRateByPolicyLocked().getName().c_str());
Alec Mouri11232a22020-05-14 18:06:25 -0700311 return getMaxRefreshRateByPolicyLocked();
312 } else {
313 return *bestRefreshRate;
314 }
315 }
316
Steven Thomasf734df42020-04-13 21:09:28 -0700317 // Consider the touch event if there are no ExplicitDefault layers. ExplicitDefault are mostly
318 // interactive (as opposed to ExplicitExactOrMultiple) and therefore if those posted an explicit
319 // vote we should not change it if we get a touch event. Only apply touch boost if it will
320 // actually increase the refresh rate over the normal selection.
321 const RefreshRate& touchRefreshRate = getMaxRefreshRateByPolicyLocked();
Alec Mouri11232a22020-05-14 18:06:25 -0700322
Ady Abrahamdfd62162020-06-10 16:11:56 -0700323 if (globalSignals.touch && explicitDefaultVoteLayers == 0 &&
Steven Thomasf734df42020-04-13 21:09:28 -0700324 bestRefreshRate->fps < touchRefreshRate.fps) {
Ady Abrahamdfd62162020-06-10 16:11:56 -0700325 setTouchConsidered();
Ady Abrahama6b676e2020-05-27 14:29:09 -0700326 ALOGV("TouchBoost - choose %s", touchRefreshRate.getName().c_str());
Steven Thomasf734df42020-04-13 21:09:28 -0700327 return touchRefreshRate;
328 }
329
Ady Abrahamde7156e2020-02-28 17:29:39 -0800330 return *bestRefreshRate;
Ady Abraham34702102020-02-10 14:12:05 -0800331}
332
333template <typename Iter>
334const RefreshRate* RefreshRateConfigs::getBestRefreshRate(Iter begin, Iter end) const {
Ady Abraham5b8afb5a2020-03-06 14:57:26 -0800335 constexpr auto EPSILON = 0.001f;
Ady Abrahamde7156e2020-02-28 17:29:39 -0800336 const RefreshRate* bestRefreshRate = begin->first;
337 float max = begin->second;
Ady Abraham34702102020-02-10 14:12:05 -0800338 for (auto i = begin; i != end; ++i) {
339 const auto [refreshRate, score] = *i;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800340 ALOGV("%s scores %.2f", refreshRate->name.c_str(), score);
341
Ady Abrahamdec1a412020-01-24 10:23:50 -0800342 ATRACE_INT(refreshRate->name.c_str(), round<int>(score * 100));
Ady Abraham8a82ba62020-01-17 12:43:17 -0800343
Ady Abraham5b8afb5a2020-03-06 14:57:26 -0800344 if (score > max * (1 + EPSILON)) {
Ady Abraham8a82ba62020-01-17 12:43:17 -0800345 max = score;
346 bestRefreshRate = refreshRate;
347 }
348 }
349
Ady Abraham34702102020-02-10 14:12:05 -0800350 return bestRefreshRate;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800351}
352
Ady Abraham2139f732019-11-13 18:56:40 -0800353const AllRefreshRatesMapType& RefreshRateConfigs::getAllRefreshRates() const {
354 return mRefreshRates;
355}
356
357const RefreshRate& RefreshRateConfigs::getMinRefreshRateByPolicy() const {
358 std::lock_guard lock(mLock);
Steven Thomasf734df42020-04-13 21:09:28 -0700359 return getMinRefreshRateByPolicyLocked();
360}
361
362const RefreshRate& RefreshRateConfigs::getMinRefreshRateByPolicyLocked() const {
363 return *mPrimaryRefreshRates.front();
Ady Abraham2139f732019-11-13 18:56:40 -0800364}
365
366const RefreshRate& RefreshRateConfigs::getMaxRefreshRateByPolicy() const {
367 std::lock_guard lock(mLock);
Steven Thomasf734df42020-04-13 21:09:28 -0700368 return getMaxRefreshRateByPolicyLocked();
369}
370
371const RefreshRate& RefreshRateConfigs::getMaxRefreshRateByPolicyLocked() const {
372 return *mPrimaryRefreshRates.back();
Ady Abraham2139f732019-11-13 18:56:40 -0800373}
374
375const RefreshRate& RefreshRateConfigs::getCurrentRefreshRate() const {
376 std::lock_guard lock(mLock);
377 return *mCurrentRefreshRate;
378}
379
Ana Krulec5d477912020-02-07 12:02:38 -0800380const RefreshRate& RefreshRateConfigs::getCurrentRefreshRateByPolicy() const {
381 std::lock_guard lock(mLock);
Ana Krulec3d367c82020-02-25 15:02:01 -0800382 return getCurrentRefreshRateByPolicyLocked();
383}
384
385const RefreshRate& RefreshRateConfigs::getCurrentRefreshRateByPolicyLocked() const {
Steven Thomasf734df42020-04-13 21:09:28 -0700386 if (std::find(mAppRequestRefreshRates.begin(), mAppRequestRefreshRates.end(),
387 mCurrentRefreshRate) != mAppRequestRefreshRates.end()) {
Ana Krulec5d477912020-02-07 12:02:38 -0800388 return *mCurrentRefreshRate;
389 }
Steven Thomasd4071902020-03-24 16:02:53 -0700390 return *mRefreshRates.at(getCurrentPolicyLocked()->defaultConfig);
Ana Krulec5d477912020-02-07 12:02:38 -0800391}
392
Ady Abraham2139f732019-11-13 18:56:40 -0800393void RefreshRateConfigs::setCurrentConfigId(HwcConfigIndexType configId) {
394 std::lock_guard lock(mLock);
Ady Abraham2e1dd892020-03-05 13:48:36 -0800395 mCurrentRefreshRate = mRefreshRates.at(configId).get();
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -0800396}
397
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -0800398RefreshRateConfigs::RefreshRateConfigs(
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -0800399 const std::vector<std::shared_ptr<const HWC2::Display::Config>>& configs,
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700400 HwcConfigIndexType currentConfigId)
401 : mKnownFrameRates(constructKnownFrameRates(configs)) {
Ady Abrahamabc27602020-04-08 17:20:29 -0700402 LOG_ALWAYS_FATAL_IF(configs.empty());
403 LOG_ALWAYS_FATAL_IF(currentConfigId.value() >= configs.size());
404
405 for (auto configId = HwcConfigIndexType(0); configId.value() < configs.size(); configId++) {
406 const auto& config = configs.at(static_cast<size_t>(configId.value()));
407 const float fps = 1e9f / config->getVsyncPeriod();
408 mRefreshRates.emplace(configId,
409 std::make_unique<RefreshRate>(configId, config,
Steven Thomasf734df42020-04-13 21:09:28 -0700410 base::StringPrintf("%.0ffps", fps), fps,
Ady Abrahamabc27602020-04-08 17:20:29 -0700411 RefreshRate::ConstructorTag(0)));
412 if (configId == currentConfigId) {
413 mCurrentRefreshRate = mRefreshRates.at(configId).get();
414 }
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -0800415 }
Ady Abrahamabc27602020-04-08 17:20:29 -0700416
417 std::vector<const RefreshRate*> sortedConfigs;
418 getSortedRefreshRateList([](const RefreshRate&) { return true; }, &sortedConfigs);
419 mDisplayManagerPolicy.defaultConfig = currentConfigId;
420 mMinSupportedRefreshRate = sortedConfigs.front();
421 mMaxSupportedRefreshRate = sortedConfigs.back();
422 constructAvailableRefreshRates();
Ady Abrahamb4b1e0a2019-11-20 18:25:35 -0800423}
424
Steven Thomasd4071902020-03-24 16:02:53 -0700425bool RefreshRateConfigs::isPolicyValid(const Policy& policy) {
426 // defaultConfig must be a valid config, and within the given refresh rate range.
427 auto iter = mRefreshRates.find(policy.defaultConfig);
428 if (iter == mRefreshRates.end()) {
429 return false;
430 }
431 const RefreshRate& refreshRate = *iter->second;
Steven Thomasf734df42020-04-13 21:09:28 -0700432 if (!refreshRate.inPolicy(policy.primaryRange.min, policy.primaryRange.max)) {
Steven Thomasd4071902020-03-24 16:02:53 -0700433 return false;
434 }
Steven Thomasf734df42020-04-13 21:09:28 -0700435 return policy.appRequestRange.min <= policy.primaryRange.min &&
436 policy.appRequestRange.max >= policy.primaryRange.max;
Steven Thomasd4071902020-03-24 16:02:53 -0700437}
438
439status_t RefreshRateConfigs::setDisplayManagerPolicy(const Policy& policy) {
Ady Abraham2139f732019-11-13 18:56:40 -0800440 std::lock_guard lock(mLock);
Steven Thomasd4071902020-03-24 16:02:53 -0700441 if (!isPolicyValid(policy)) {
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100442 return BAD_VALUE;
443 }
Steven Thomasd4071902020-03-24 16:02:53 -0700444 Policy previousPolicy = *getCurrentPolicyLocked();
445 mDisplayManagerPolicy = policy;
446 if (*getCurrentPolicyLocked() == previousPolicy) {
447 return CURRENT_POLICY_UNCHANGED;
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100448 }
Ady Abraham2139f732019-11-13 18:56:40 -0800449 constructAvailableRefreshRates();
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100450 return NO_ERROR;
451}
452
Steven Thomasd4071902020-03-24 16:02:53 -0700453status_t RefreshRateConfigs::setOverridePolicy(const std::optional<Policy>& policy) {
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100454 std::lock_guard lock(mLock);
Steven Thomasd4071902020-03-24 16:02:53 -0700455 if (policy && !isPolicyValid(*policy)) {
456 return BAD_VALUE;
457 }
458 Policy previousPolicy = *getCurrentPolicyLocked();
459 mOverridePolicy = policy;
460 if (*getCurrentPolicyLocked() == previousPolicy) {
461 return CURRENT_POLICY_UNCHANGED;
462 }
463 constructAvailableRefreshRates();
464 return NO_ERROR;
465}
466
467const RefreshRateConfigs::Policy* RefreshRateConfigs::getCurrentPolicyLocked() const {
468 return mOverridePolicy ? &mOverridePolicy.value() : &mDisplayManagerPolicy;
469}
470
471RefreshRateConfigs::Policy RefreshRateConfigs::getCurrentPolicy() const {
472 std::lock_guard lock(mLock);
473 return *getCurrentPolicyLocked();
474}
475
476RefreshRateConfigs::Policy RefreshRateConfigs::getDisplayManagerPolicy() const {
477 std::lock_guard lock(mLock);
478 return mDisplayManagerPolicy;
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100479}
480
481bool RefreshRateConfigs::isConfigAllowed(HwcConfigIndexType config) const {
482 std::lock_guard lock(mLock);
Steven Thomasf734df42020-04-13 21:09:28 -0700483 for (const RefreshRate* refreshRate : mAppRequestRefreshRates) {
Ana Kruleced3a8cc2019-11-14 00:55:07 +0100484 if (refreshRate->configId == config) {
485 return true;
486 }
487 }
488 return false;
Ady Abraham2139f732019-11-13 18:56:40 -0800489}
490
491void RefreshRateConfigs::getSortedRefreshRateList(
492 const std::function<bool(const RefreshRate&)>& shouldAddRefreshRate,
493 std::vector<const RefreshRate*>* outRefreshRates) {
494 outRefreshRates->clear();
495 outRefreshRates->reserve(mRefreshRates.size());
496 for (const auto& [type, refreshRate] : mRefreshRates) {
Ady Abraham2e1dd892020-03-05 13:48:36 -0800497 if (shouldAddRefreshRate(*refreshRate)) {
Ady Abraham2139f732019-11-13 18:56:40 -0800498 ALOGV("getSortedRefreshRateList: config %d added to list policy",
Ady Abraham2e1dd892020-03-05 13:48:36 -0800499 refreshRate->configId.value());
500 outRefreshRates->push_back(refreshRate.get());
Ady Abraham2139f732019-11-13 18:56:40 -0800501 }
502 }
503
504 std::sort(outRefreshRates->begin(), outRefreshRates->end(),
505 [](const auto refreshRate1, const auto refreshRate2) {
Ady Abrahamabc27602020-04-08 17:20:29 -0700506 if (refreshRate1->hwcConfig->getVsyncPeriod() !=
507 refreshRate2->hwcConfig->getVsyncPeriod()) {
508 return refreshRate1->hwcConfig->getVsyncPeriod() >
509 refreshRate2->hwcConfig->getVsyncPeriod();
Steven Thomasd4071902020-03-24 16:02:53 -0700510 } else {
Ady Abrahamabc27602020-04-08 17:20:29 -0700511 return refreshRate1->hwcConfig->getConfigGroup() >
512 refreshRate2->hwcConfig->getConfigGroup();
Steven Thomasd4071902020-03-24 16:02:53 -0700513 }
Ady Abraham2139f732019-11-13 18:56:40 -0800514 });
515}
516
517void RefreshRateConfigs::constructAvailableRefreshRates() {
518 // Filter configs based on current policy and sort based on vsync period
Steven Thomasd4071902020-03-24 16:02:53 -0700519 const Policy* policy = getCurrentPolicyLocked();
Ady Abrahamabc27602020-04-08 17:20:29 -0700520 const auto& defaultConfig = mRefreshRates.at(policy->defaultConfig)->hwcConfig;
Steven Thomasf734df42020-04-13 21:09:28 -0700521 ALOGV("constructAvailableRefreshRates: default %d group %d primaryRange=[%.2f %.2f]"
522 " appRequestRange=[%.2f %.2f]",
523 policy->defaultConfig.value(), defaultConfig->getConfigGroup(), policy->primaryRange.min,
524 policy->primaryRange.max, policy->appRequestRange.min, policy->appRequestRange.max);
Ady Abrahamabc27602020-04-08 17:20:29 -0700525
Steven Thomasf734df42020-04-13 21:09:28 -0700526 auto filterRefreshRates = [&](float min, float max, const char* listName,
527 std::vector<const RefreshRate*>* outRefreshRates) {
528 getSortedRefreshRateList(
529 [&](const RefreshRate& refreshRate) REQUIRES(mLock) {
530 const auto& hwcConfig = refreshRate.hwcConfig;
Ady Abraham8a82ba62020-01-17 12:43:17 -0800531
Steven Thomasf734df42020-04-13 21:09:28 -0700532 return hwcConfig->getHeight() == defaultConfig->getHeight() &&
533 hwcConfig->getWidth() == defaultConfig->getWidth() &&
534 hwcConfig->getDpiX() == defaultConfig->getDpiX() &&
535 hwcConfig->getDpiY() == defaultConfig->getDpiY() &&
536 (policy->allowGroupSwitching ||
537 hwcConfig->getConfigGroup() == defaultConfig->getConfigGroup()) &&
538 refreshRate.inPolicy(min, max);
539 },
540 outRefreshRates);
Ady Abraham8a82ba62020-01-17 12:43:17 -0800541
Steven Thomasf734df42020-04-13 21:09:28 -0700542 LOG_ALWAYS_FATAL_IF(outRefreshRates->empty(),
543 "No matching configs for %s range: min=%.0f max=%.0f", listName, min,
544 max);
545 auto stringifyRefreshRates = [&]() -> std::string {
546 std::string str;
547 for (auto refreshRate : *outRefreshRates) {
548 base::StringAppendF(&str, "%s ", refreshRate->name.c_str());
549 }
550 return str;
551 };
552 ALOGV("%s refresh rates: %s", listName, stringifyRefreshRates().c_str());
553 };
554
555 filterRefreshRates(policy->primaryRange.min, policy->primaryRange.max, "primary",
556 &mPrimaryRefreshRates);
557 filterRefreshRates(policy->appRequestRange.min, policy->appRequestRange.max, "app request",
558 &mAppRequestRefreshRates);
Ady Abraham2139f732019-11-13 18:56:40 -0800559}
560
Ady Abrahamb1b9d412020-06-01 19:53:52 -0700561std::vector<float> RefreshRateConfigs::constructKnownFrameRates(
562 const std::vector<std::shared_ptr<const HWC2::Display::Config>>& configs) {
563 std::vector<float> knownFrameRates = {24.0f, 30.0f, 45.0f, 60.0f, 72.0f};
564 knownFrameRates.reserve(knownFrameRates.size() + configs.size());
565
566 // Add all supported refresh rates to the set
567 for (const auto& config : configs) {
568 const auto refreshRate = 1e9f / config->getVsyncPeriod();
569 knownFrameRates.emplace_back(refreshRate);
570 }
571
572 // Sort and remove duplicates
573 const auto frameRatesEqual = [](float a, float b) { return std::abs(a - b) <= 0.01f; };
574 std::sort(knownFrameRates.begin(), knownFrameRates.end());
575 knownFrameRates.erase(std::unique(knownFrameRates.begin(), knownFrameRates.end(),
576 frameRatesEqual),
577 knownFrameRates.end());
578 return knownFrameRates;
579}
580
581float RefreshRateConfigs::findClosestKnownFrameRate(float frameRate) const {
582 if (frameRate <= *mKnownFrameRates.begin()) {
583 return *mKnownFrameRates.begin();
584 }
585
586 if (frameRate >= *std::prev(mKnownFrameRates.end())) {
587 return *std::prev(mKnownFrameRates.end());
588 }
589
590 auto lowerBound = std::lower_bound(mKnownFrameRates.begin(), mKnownFrameRates.end(), frameRate);
591
592 const auto distance1 = std::abs(frameRate - *lowerBound);
593 const auto distance2 = std::abs(frameRate - *std::prev(lowerBound));
594 return distance1 < distance2 ? *lowerBound : *std::prev(lowerBound);
595}
596
Ana Krulecb9afd792020-06-11 13:16:15 -0700597RefreshRateConfigs::KernelIdleTimerAction RefreshRateConfigs::getIdleTimerAction() const {
598 std::lock_guard lock(mLock);
599 const auto& deviceMin = getMinRefreshRate();
600 const auto& minByPolicy = getMinRefreshRateByPolicyLocked();
601 const auto& maxByPolicy = getMaxRefreshRateByPolicyLocked();
602
603 // Kernel idle timer will set the refresh rate to the device min. If DisplayManager says that
604 // the min allowed refresh rate is higher than the device min, we do not want to enable the
605 // timer.
606 if (deviceMin < minByPolicy) {
607 return RefreshRateConfigs::KernelIdleTimerAction::TurnOff;
608 }
609 if (minByPolicy == maxByPolicy) {
610 // Do not sent the call to toggle off kernel idle timer if the device min and policy min and
611 // max are all the same. This saves us extra unnecessary calls to sysprop.
612 if (deviceMin == minByPolicy) {
613 return RefreshRateConfigs::KernelIdleTimerAction::NoChange;
614 }
615 return RefreshRateConfigs::KernelIdleTimerAction::TurnOff;
616 }
617 // Turn on the timer in all other cases.
618 return RefreshRateConfigs::KernelIdleTimerAction::TurnOn;
619}
620
Ady Abraham2139f732019-11-13 18:56:40 -0800621} // namespace android::scheduler