Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 1 | /* |
| 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 | */ |
| 16 | |
| 17 | #pragma once |
| 18 | |
Ady Abraham | e988303 | 2023-11-20 17:54:54 -0800 | [diff] [blame] | 19 | #include <deque> |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 20 | #include <mutex> |
| 21 | #include <unordered_map> |
| 22 | #include <vector> |
Dominik Laskowski | 62eff35 | 2021-12-06 09:59:41 -0800 | [diff] [blame] | 23 | |
| 24 | #include <android-base/thread_annotations.h> |
Leon Scroggins III | 6738862 | 2023-02-06 20:36:20 -0500 | [diff] [blame] | 25 | #include <ui/DisplayId.h> |
Dominik Laskowski | 62eff35 | 2021-12-06 09:59:41 -0800 | [diff] [blame] | 26 | |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 27 | #include "VSyncTracker.h" |
| 28 | |
| 29 | namespace android::scheduler { |
| 30 | |
| 31 | class VSyncPredictor : public VSyncTracker { |
| 32 | public: |
| 33 | /* |
Leon Scroggins III | 6738862 | 2023-02-06 20:36:20 -0500 | [diff] [blame] | 34 | * \param [in] PhysicalDisplayid The display this corresponds to. |
Ady Abraham | c585dba | 2023-11-15 18:41:35 -0800 | [diff] [blame] | 35 | * \param [in] modePtr The initial display mode |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 36 | * \param [in] historySize The internal amount of entries to store in the model. |
| 37 | * \param [in] minimumSamplesForPrediction The minimum number of samples to collect before |
| 38 | * predicting. \param [in] outlierTolerancePercent a number 0 to 100 that will be used to filter |
| 39 | * samples that fall outlierTolerancePercent from an anticipated vsync event. |
ramindani | d4354a9 | 2023-10-02 15:11:09 -0700 | [diff] [blame] | 40 | * \param [in] IVsyncTrackerCallback The callback for the VSyncTracker. |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 41 | */ |
Ady Abraham | c585dba | 2023-11-15 18:41:35 -0800 | [diff] [blame] | 42 | VSyncPredictor(ftl::NonNull<DisplayModePtr> modePtr, size_t historySize, |
ramindani | d4354a9 | 2023-10-02 15:11:09 -0700 | [diff] [blame] | 43 | size_t minimumSamplesForPrediction, uint32_t outlierTolerancePercent, |
| 44 | IVsyncTrackerCallback&); |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 45 | ~VSyncPredictor(); |
| 46 | |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 47 | bool addVsyncTimestamp(nsecs_t timestamp) final EXCLUDES(mMutex); |
Ady Abraham | 4335afd | 2023-12-18 19:10:47 -0800 | [diff] [blame] | 48 | nsecs_t nextAnticipatedVSyncTimeFrom(nsecs_t timePoint, |
| 49 | std::optional<nsecs_t> lastVsyncOpt = {}) const final |
| 50 | EXCLUDES(mMutex); |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 51 | nsecs_t currentPeriod() const final EXCLUDES(mMutex); |
Ady Abraham | 3db8a3c | 2023-11-20 17:53:47 -0800 | [diff] [blame] | 52 | Period minFramePeriod() const final EXCLUDES(mMutex); |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 53 | void resetModel() final EXCLUDES(mMutex); |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 54 | |
Kevin DuBois | b818bfa | 2020-07-10 14:29:36 -0700 | [diff] [blame] | 55 | /* Query if the model is in need of more samples to make a prediction. |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 56 | * \return True, if model would benefit from more samples, False if not. |
| 57 | */ |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 58 | bool needsMoreSamples() const final EXCLUDES(mMutex); |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 59 | |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 60 | struct Model { |
| 61 | nsecs_t slope; |
| 62 | nsecs_t intercept; |
| 63 | }; |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 64 | |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 65 | VSyncPredictor::Model getVSyncPredictionModel() const EXCLUDES(mMutex); |
| 66 | |
Ady Abraham | 5cc2e26 | 2021-03-25 13:09:17 -0700 | [diff] [blame] | 67 | bool isVSyncInPhase(nsecs_t timePoint, Fps frameRate) const final EXCLUDES(mMutex); |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 68 | |
Ady Abraham | c585dba | 2023-11-15 18:41:35 -0800 | [diff] [blame] | 69 | void setDisplayModePtr(ftl::NonNull<DisplayModePtr>) final EXCLUDES(mMutex); |
| 70 | |
| 71 | void setRenderRate(Fps) final EXCLUDES(mMutex); |
Ady Abraham | ace3d05 | 2022-11-17 16:25:05 -0800 | [diff] [blame] | 72 | |
Ady Abraham | e988303 | 2023-11-20 17:54:54 -0800 | [diff] [blame] | 73 | void onFrameBegin(TimePoint expectedPresentTime, TimePoint lastConfirmedPresentTime) final |
| 74 | EXCLUDES(mMutex); |
| 75 | void onFrameMissed(TimePoint expectedPresentTime) final EXCLUDES(mMutex); |
| 76 | |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 77 | void dump(std::string& result) const final EXCLUDES(mMutex); |
Ady Abraham | 5e7371c | 2020-03-24 14:47:24 -0700 | [diff] [blame] | 78 | |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 79 | private: |
| 80 | VSyncPredictor(VSyncPredictor const&) = delete; |
| 81 | VSyncPredictor& operator=(VSyncPredictor const&) = delete; |
Kevin DuBois | c3e9e8e | 2020-01-07 09:06:52 -0800 | [diff] [blame] | 82 | void clearTimestamps() REQUIRES(mMutex); |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 83 | |
Leon Scroggins III | 6738862 | 2023-02-06 20:36:20 -0500 | [diff] [blame] | 84 | const PhysicalDisplayId mId; |
| 85 | |
Kevin DuBois | ecb1f0d | 2019-12-12 10:47:41 -0800 | [diff] [blame] | 86 | inline void traceInt64If(const char* name, int64_t value) const; |
Ady Abraham | d9b9a04 | 2023-01-13 11:30:58 -0800 | [diff] [blame] | 87 | inline void traceInt64(const char* name, int64_t value) const; |
Kevin DuBois | ecb1f0d | 2019-12-12 10:47:41 -0800 | [diff] [blame] | 88 | |
Ady Abraham | f34a813 | 2023-02-13 20:49:48 -0800 | [diff] [blame] | 89 | size_t next(size_t i) const REQUIRES(mMutex); |
| 90 | bool validate(nsecs_t timestamp) const REQUIRES(mMutex); |
| 91 | Model getVSyncPredictionModelLocked() const REQUIRES(mMutex); |
Ady Abraham | 4335afd | 2023-12-18 19:10:47 -0800 | [diff] [blame] | 92 | nsecs_t snapToVsync(nsecs_t timePoint) const REQUIRES(mMutex); |
| 93 | nsecs_t snapToVsyncAlignedWithRenderRate(nsecs_t timePoint) const REQUIRES(mMutex); |
Ady Abraham | f34a813 | 2023-02-13 20:49:48 -0800 | [diff] [blame] | 94 | bool isVSyncInPhaseLocked(nsecs_t timePoint, unsigned divisor) const REQUIRES(mMutex); |
Ady Abraham | e988303 | 2023-11-20 17:54:54 -0800 | [diff] [blame] | 95 | Period minFramePeriodLocked() const REQUIRES(mMutex); |
| 96 | void ensureMinFrameDurationIsKept(TimePoint, TimePoint) REQUIRES(mMutex); |
Ady Abraham | f34a813 | 2023-02-13 20:49:48 -0800 | [diff] [blame] | 97 | |
| 98 | struct VsyncSequence { |
| 99 | nsecs_t vsyncTime; |
| 100 | int64_t seq; |
| 101 | }; |
| 102 | VsyncSequence getVsyncSequenceLocked(nsecs_t timestamp) const REQUIRES(mMutex); |
Ady Abraham | c585dba | 2023-11-15 18:41:35 -0800 | [diff] [blame] | 103 | nsecs_t idealPeriod() const REQUIRES(mMutex); |
Ady Abraham | f34a813 | 2023-02-13 20:49:48 -0800 | [diff] [blame] | 104 | |
| 105 | bool const mTraceOn; |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 106 | size_t const kHistorySize; |
| 107 | size_t const kMinimumSamplesForPrediction; |
| 108 | size_t const kOutlierTolerancePercent; |
ramindani | d4354a9 | 2023-10-02 15:11:09 -0700 | [diff] [blame] | 109 | IVsyncTrackerCallback& mVsyncTrackerCallback; |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 110 | std::mutex mutable mMutex; |
Ady Abraham | ace3d05 | 2022-11-17 16:25:05 -0800 | [diff] [blame] | 111 | |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 112 | std::optional<nsecs_t> mKnownTimestamp GUARDED_BY(mMutex); |
| 113 | |
Ady Abraham | 0bb6a47 | 2020-10-12 10:22:13 -0700 | [diff] [blame] | 114 | // Map between ideal vsync period and the calculated model |
| 115 | std::unordered_map<nsecs_t, Model> mutable mRateMap GUARDED_BY(mMutex); |
| 116 | |
Ady Abraham | 9c53ee7 | 2020-07-22 21:16:18 -0700 | [diff] [blame] | 117 | size_t mLastTimestampIndex GUARDED_BY(mMutex) = 0; |
Ady Abraham | 92fa2f4 | 2020-02-11 15:33:56 -0800 | [diff] [blame] | 118 | std::vector<nsecs_t> mTimestamps GUARDED_BY(mMutex); |
Ady Abraham | ace3d05 | 2022-11-17 16:25:05 -0800 | [diff] [blame] | 119 | |
Ady Abraham | c585dba | 2023-11-15 18:41:35 -0800 | [diff] [blame] | 120 | ftl::NonNull<DisplayModePtr> mDisplayModePtr GUARDED_BY(mMutex); |
| 121 | std::optional<Fps> mRenderRateOpt GUARDED_BY(mMutex); |
Ady Abraham | f34a813 | 2023-02-13 20:49:48 -0800 | [diff] [blame] | 122 | |
| 123 | mutable std::optional<VsyncSequence> mLastVsyncSequence GUARDED_BY(mMutex); |
Ady Abraham | e988303 | 2023-11-20 17:54:54 -0800 | [diff] [blame] | 124 | |
| 125 | std::deque<TimePoint> mPastExpectedPresentTimes GUARDED_BY(mMutex); |
Ady Abraham | 4335afd | 2023-12-18 19:10:47 -0800 | [diff] [blame] | 126 | |
| 127 | TimePoint mLastMissedVsync GUARDED_BY(mMutex); |
Kevin DuBois | 1678e2c | 2019-08-22 12:26:24 -0700 | [diff] [blame] | 128 | }; |
| 129 | |
| 130 | } // namespace android::scheduler |