1 /* 2 * Copyright (c) 2021 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 17 #ifndef VSYNC_VSYNC_GENERATOR_H 18 #define VSYNC_VSYNC_GENERATOR_H 19 20 #include <cstdint> 21 #include <refbase.h> 22 #include "graphic_common.h" 23 24 #include <mutex> 25 #include <vector> 26 #include <thread> 27 #include <condition_variable> 28 #include "vsync_type.h" 29 #include "vsync_system_ability_listener.h" 30 31 namespace OHOS { 32 namespace Rosen { 33 34 class VSyncDistributor; 35 36 class VSyncGenerator : public RefBase { 37 public: 38 class Callback : public RefBase { 39 public: 40 virtual void OnVSyncEvent(int64_t now, int64_t period, 41 uint32_t refreshRate, VSyncMode vsyncMode, uint32_t vsyncMaxRefreshRate) = 0; 42 virtual void OnPhaseOffsetChanged(int64_t phaseOffset) = 0; 43 /* std::pair<id, refresh rate> */ 44 virtual void OnConnsRefreshRateChanged(const std::vector<std::pair<uint64_t, uint32_t>> &refreshRates) = 0; 45 }; 46 struct ListenerRefreshRateData { 47 sptr<OHOS::Rosen::VSyncGenerator::Callback> cb = nullptr; 48 // id, refreshRate 49 std::vector<std::pair<uint64_t, uint32_t>> refreshRates; 50 }; 51 struct ListenerPhaseOffsetData { 52 sptr<OHOS::Rosen::VSyncGenerator::Callback> cb = nullptr; 53 int32_t phaseByPulseNum = 0; 54 }; 55 VSyncGenerator() = default; 56 virtual ~VSyncGenerator() noexcept = default; 57 virtual VsyncError UpdateMode(int64_t period, int64_t phase, int64_t referenceTime) = 0; 58 virtual VsyncError AddListener(int64_t phase, const sptr<Callback>& cb) = 0; 59 virtual VsyncError RemoveListener(const sptr<Callback>& cb) = 0; 60 virtual VsyncError ChangePhaseOffset(const sptr<Callback>& cb, int64_t offset) = 0; 61 virtual bool IsEnable() = 0; 62 virtual VsyncError ChangeGeneratorRefreshRateModel(const ListenerRefreshRateData &listenerRefreshRates, 63 const ListenerPhaseOffsetData &listenerPhaseOffset, 64 uint32_t generatorRefreshRate, 65 int64_t &rsVsyncCount, 66 int64_t expectNextVsyncTime = 0) = 0; 67 virtual int64_t GetVSyncPulse() = 0; 68 virtual VsyncError SetVSyncMode(VSyncMode vsyncMode) = 0; 69 virtual VSyncMode GetVSyncMode() = 0; 70 virtual VsyncError SetVSyncPhaseByPulseNum(int32_t phaseByPulseNum) = 0; 71 virtual uint32_t GetVSyncMaxRefreshRate() = 0; 72 virtual VsyncError SetVSyncMaxRefreshRate(uint32_t refreshRate) = 0; 73 virtual void Dump(std::string &result) = 0; 74 virtual bool GetFrameRateChaingStatus() = 0; 75 virtual VsyncError SetReferenceTimeOffset(int32_t phaseByPulseNum) = 0; 76 virtual VsyncError CheckAndUpdateReferenceTime(int64_t hardwareVsyncInterval, int64_t referenceTime) = 0; 77 virtual void SetPendingMode(int64_t period, int64_t timestamp) = 0; 78 virtual VsyncError StartRefresh() = 0; 79 80 virtual void SetRSDistributor(sptr<VSyncDistributor> &rsVSyncDistributor) = 0; 81 virtual void SetFrameRateChangingStatus(bool frameRateChanging) = 0; 82 virtual void SetAppDistributor(sptr<VSyncDistributor> &appVSyncDistributor) = 0; 83 virtual int64_t GetVSyncOffset() = 0; 84 // Start of DVSync 85 virtual int64_t SetCurrentRefreshRate(uint32_t currRefreshRate, uint32_t lastRefreshRate) = 0; 86 virtual void DVSyncRateChanged(uint32_t currRefreshRate, bool &frameRateChanged) = 0; 87 virtual VsyncError RemoveDVSyncListener(const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb) = 0; 88 virtual VsyncError AddDVSyncListener(int64_t phase, const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb) = 0; 89 // End of DVSync 90 virtual void PrintGeneratorStatus() = 0; 91 }; 92 93 sptr<VSyncGenerator> CreateVSyncGenerator(); 94 void DestroyVSyncGenerator(); 95 96 namespace impl { 97 uint32_t CalculateRefreshRate(int64_t period); 98 99 class VSyncGenerator : public OHOS::Rosen::VSyncGenerator { 100 public: 101 static sptr<OHOS::Rosen::VSyncGenerator> GetInstance() noexcept; 102 static void DeleteInstance() noexcept; 103 104 // nocopyable 105 VSyncGenerator(const VSyncGenerator &) = delete; 106 VSyncGenerator &operator=(const VSyncGenerator &) = delete; 107 VsyncError UpdateMode(int64_t period, int64_t phase, int64_t referenceTime) override; 108 VsyncError AddListener(int64_t phase, const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb) override; 109 VsyncError RemoveListener(const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb) override; 110 VsyncError ChangePhaseOffset(const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb, int64_t offset) override; 111 bool IsEnable() override; 112 VsyncError ChangeGeneratorRefreshRateModel(const ListenerRefreshRateData &listenerRefreshRates, 113 const ListenerPhaseOffsetData &listenerPhaseOffset, 114 uint32_t generatorRefreshRate, 115 int64_t &rsVsyncCount, 116 int64_t expectNextVsyncTime = 0) override; 117 int64_t GetVSyncPulse() override; 118 VsyncError SetVSyncMode(VSyncMode vsyncMode) override; 119 VSyncMode GetVSyncMode() override; 120 VsyncError SetVSyncPhaseByPulseNum(int32_t phaseByPulseNum) override; 121 uint32_t GetVSyncMaxRefreshRate() override; 122 VsyncError SetVSyncMaxRefreshRate(uint32_t refreshRate) override; 123 void Dump(std::string &result) override; 124 bool GetFrameRateChaingStatus() override; 125 VsyncError SetReferenceTimeOffset(int32_t phaseByPulseNum) override; 126 VsyncError CheckAndUpdateReferenceTime(int64_t hardwareVsyncInterval, int64_t referenceTime) override; 127 void SetPendingMode(int64_t period, int64_t timestamp) override; 128 VsyncError StartRefresh() override; 129 130 void SetRSDistributor(sptr<VSyncDistributor> &rsVSyncDistributor) override; 131 void SetFrameRateChangingStatus(bool frameRateChanging) override; 132 void SetAppDistributor(sptr<VSyncDistributor> &appVSyncDistributor) override; 133 int64_t GetVSyncOffset() override; 134 135 // Start of DVSync 136 int64_t SetCurrentRefreshRate(uint32_t currRefreshRate, uint32_t lastRefreshRate) override; 137 void DVSyncRateChanged(uint32_t currRefreshRate, bool &frameRateChanged) override; 138 VsyncError RemoveDVSyncListener(const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb) override; 139 VsyncError AddDVSyncListener(int64_t phase, const sptr<OHOS::Rosen::VSyncGenerator::Callback>& cb) override; 140 // End of DVSync 141 void PrintGeneratorStatus() override; 142 private: 143 friend class OHOS::Rosen::VSyncGenerator; 144 145 struct Listener { 146 int64_t phase_; 147 sptr<OHOS::Rosen::VSyncGenerator::Callback> callback_; 148 int64_t lastTime_; 149 }; 150 151 VSyncGenerator(); 152 ~VSyncGenerator() override; 153 154 int64_t ComputeNextVSyncTimeStamp(int64_t now, int64_t referenceTime); 155 std::vector<Listener> GetListenerTimeouted(int64_t now, int64_t occurTimestamp, int64_t referenceTime); 156 int64_t ComputeListenerNextVSyncTimeStamp(const Listener &listen, int64_t now, int64_t referenceTime); 157 void ThreadLoop(); 158 void WaitForTimeout(int64_t occurTimestamp, int64_t nextTimeStamp, int64_t occurReferenceTime); 159 void UpdateWakeupDelay(int64_t occurTimestamp, int64_t nextTimeStamp); 160 bool ChangeListenerOffsetInternal(); 161 bool ChangeListenerRefreshRatesInternal(); 162 uint32_t JudgeRefreshRateLocked(int64_t period); 163 bool CheckTimingCorrect(int64_t now, int64_t referenceTime, int64_t nextVSyncTime); 164 bool UpdateChangeDataLocked(int64_t now, int64_t referenceTime, int64_t nextVSyncTime); 165 void UpdateVSyncModeLocked(); 166 std::vector<Listener> GetListenerTimeoutedLTPO(int64_t now, int64_t referenceTime); 167 void ListenerVsyncEventCB(int64_t occurTimestamp, int64_t nextTimeStamp, 168 int64_t occurReferenceTime, bool isWakeup); 169 VsyncError UpdatePeriodLocked(int64_t period); 170 VsyncError UpdateReferenceTimeLocked(int64_t referenceTime); 171 #ifdef COMPOSER_SCHED_ENABLE 172 void SubScribeSystemAbility(); 173 #endif 174 void PeriodCheckLocked(int64_t hardwareVsyncInterval); 175 void UpdateChangeRefreshRatesLocked(const ListenerRefreshRateData &listenerRefreshRates); 176 VsyncError SetExpectNextVsyncTimeInternal(int64_t expectNextVsyncTime); 177 void ClearAllSamplesInternal(bool clearAllSamplesFlag); 178 void CalculateReferenceTimeOffsetPulseNumLocked(int64_t referenceTime); 179 void WaitForTimeoutConNotifyLocked(); 180 181 sptr<VSyncSystemAbilityListener> saStatusChangeListener_ = nullptr; 182 int64_t period_ = 0; 183 int64_t phase_ = 0; 184 int64_t referenceTime_ = 0; 185 int64_t wakeupDelay_ = 0; 186 187 std::vector<Listener> listeners_; 188 189 std::mutex mutex_; 190 std::condition_variable con_; 191 std::mutex waitForTimeoutMtx_; 192 std::condition_variable waitForTimeoutCon_; 193 std::thread thread_; 194 bool vsyncThreadRunning_; 195 static std::once_flag createFlag_; 196 static sptr<OHOS::Rosen::VSyncGenerator> instance_; 197 int64_t pulse_ = 0; // by ns 198 uint32_t currRefreshRate_ = 0; // by Hz 199 int32_t referenceTimeOffsetPulseNum_ = 0; 200 int32_t defaultReferenceTimeOffsetPulseNum_ = 0; 201 ListenerRefreshRateData changingRefreshRates_ = {}; 202 ListenerPhaseOffsetData changingPhaseOffset_ = {}; 203 uint32_t changingGeneratorRefreshRate_ = 0; 204 bool needChangeRefreshRates_ = false; 205 bool needChangePhaseOffset_ = false; 206 bool needChangeGeneratorRefreshRate_ = false; 207 VSyncMode vsyncMode_ = VSYNC_MODE_LTPS; //default LTPS 208 VSyncMode pendingVsyncMode_ = VSYNC_MODE_INVALID; 209 std::vector<Listener> listenersRecord_; 210 bool refreshRateIsChanged_ = false; 211 bool frameRateChanging_ = false; 212 int64_t pendingPeriod_ = 0; 213 int64_t pendingReferenceTime_ = 0; 214 bool startRefresh_ = false; 215 int64_t phaseRecord_ = 0; 216 int64_t periodRecord_ = 0; 217 sptr<VSyncDistributor> rsVSyncDistributor_; 218 int32_t periodCheckCounter_ = 0; 219 int64_t lastPeriod_ = 0; 220 sptr<VSyncDistributor> appVSyncDistributor_; 221 int64_t expectNextVsyncTime_ = 0; 222 bool expectTimeFlag_ = false; 223 int64_t targetPeriod_ = 0; 224 bool clearAllSamplesFlag_ = false; 225 uint32_t vsyncMaxRefreshRate_ = 360; // default max TE 226 int64_t vsyncOffset_ = 0; 227 int64_t nextTimeStamp_ = 0; 228 // Start of DVSync 229 int64_t ComputeDVSyncListenerNextVSyncTimeStamp(const Listener &listener, int64_t now, 230 int64_t referenceTime, int64_t period); 231 int64_t CollectDVSyncListener(const Listener &listener, int64_t now, std::vector<VSyncGenerator::Listener> &ret); 232 void ComputeDVSyncListenerTimeStamp(const Listener &listener, int64_t now, int64_t &nextVSyncTime); 233 bool isLtpoNeedChange_ = false; 234 int64_t occurDvsyncReferenceTime_ = 0; 235 int64_t dvsyncPeriodRecord_ = 0; 236 Listener dvsyncListener_ = {0, nullptr, 0}; 237 // End of DVSync 238 }; 239 } // impl 240 } // namespace Rosen 241 } // namespace OHOS 242 243 #endif 244