Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018 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 | |
| 19 | #include <utils/Errors.h> |
| 20 | |
| 21 | #include <mutex> |
| 22 | |
| 23 | using namespace android::surfaceflinger; |
| 24 | |
| 25 | namespace android { |
| 26 | |
| 27 | /* |
| 28 | * Modulates the vsync-offsets depending on current SurfaceFlinger state. |
| 29 | */ |
| 30 | class VSyncModulator { |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 31 | private: |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 32 | // Number of frames we'll keep the early phase offsets once they are activated. This acts as a |
| 33 | // low-pass filter in case the client isn't quick enough in sending new transactions. |
| 34 | const int MIN_EARLY_FRAME_COUNT = 2; |
| 35 | |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 36 | public: |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 37 | struct Offsets { |
| 38 | nsecs_t sf; |
| 39 | nsecs_t app; |
| 40 | }; |
| 41 | |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 42 | // Sets the phase offsets |
| 43 | // |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 44 | // sfEarly: The phase offset when waking up SF early, which happens when marking a transaction |
| 45 | // as early. May be the same as late, in which case we don't shift offsets. |
| 46 | // sfEarlyGl: Like sfEarly, but only if we used GL composition. If we use both GL composition |
| 47 | // and the transaction was marked as early, we'll use sfEarly. |
| 48 | // sfLate: The regular SF vsync phase offset. |
| 49 | // appEarly: Like sfEarly, but for the app-vsync |
| 50 | // appEarlyGl: Like sfEarlyGl, but for the app-vsync. |
| 51 | // appLate: The regular app vsync phase offset. |
| 52 | void setPhaseOffsets(Offsets early, Offsets earlyGl, Offsets late) { |
| 53 | mEarlyOffsets = early; |
| 54 | mEarlyGlOffsets = earlyGl; |
| 55 | mLateOffsets = late; |
| 56 | mOffsets = late; |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 57 | } |
| 58 | |
Ana Krulec | fefcb58 | 2018-08-07 14:22:37 -0700 | [diff] [blame] | 59 | Offsets getEarlyOffsets() const { return mEarlyOffsets; } |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 60 | |
Ana Krulec | fefcb58 | 2018-08-07 14:22:37 -0700 | [diff] [blame] | 61 | Offsets getEarlyGlOffsets() const { return mEarlyGlOffsets; } |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 62 | |
| 63 | void setEventThreads(EventThread* sfEventThread, EventThread* appEventThread) { |
| 64 | mSfEventThread = sfEventThread; |
| 65 | mAppEventThread = appEventThread; |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 66 | } |
| 67 | |
Ana Krulec | 12096d0 | 2018-09-07 14:54:14 -0700 | [diff] [blame] | 68 | void setSchedulerAndHandles(Scheduler* scheduler, |
| 69 | Scheduler::ConnectionHandle* appConnectionHandle, |
| 70 | Scheduler::ConnectionHandle* sfConnectionHandle) { |
| 71 | mScheduler = scheduler; |
| 72 | mAppConnectionHandle = appConnectionHandle; |
| 73 | mSfConnectionHandle = sfConnectionHandle; |
| 74 | } |
| 75 | |
Ana Krulec | 7ecce8c | 2018-10-12 13:44:41 -0700 | [diff] [blame^] | 76 | void setTransactionStart(Scheduler::TransactionStart transactionStart) { |
| 77 | if (transactionStart == Scheduler::TransactionStart::EARLY) { |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 78 | mRemainingEarlyFrameCount = MIN_EARLY_FRAME_COUNT; |
| 79 | } |
| 80 | |
Jorim Jaggi | f15c3be | 2018-04-12 12:56:58 +0100 | [diff] [blame] | 81 | // An early transaction stays an early transaction. |
Ana Krulec | 7ecce8c | 2018-10-12 13:44:41 -0700 | [diff] [blame^] | 82 | if (transactionStart == mTransactionStart || |
| 83 | mTransactionStart == Scheduler::TransactionStart::EARLY) { |
Jorim Jaggi | f15c3be | 2018-04-12 12:56:58 +0100 | [diff] [blame] | 84 | return; |
| 85 | } |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 86 | mTransactionStart = transactionStart; |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 87 | updateOffsets(); |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 88 | } |
| 89 | |
Jorim Jaggi | f15c3be | 2018-04-12 12:56:58 +0100 | [diff] [blame] | 90 | void onTransactionHandled() { |
Ana Krulec | 7ecce8c | 2018-10-12 13:44:41 -0700 | [diff] [blame^] | 91 | if (mTransactionStart == Scheduler::TransactionStart::NORMAL) return; |
| 92 | mTransactionStart = Scheduler::TransactionStart::NORMAL; |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 93 | updateOffsets(); |
Jorim Jaggi | f15c3be | 2018-04-12 12:56:58 +0100 | [diff] [blame] | 94 | } |
| 95 | |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 96 | void onRefreshed(bool usedRenderEngine) { |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 97 | bool updateOffsetsNeeded = false; |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 98 | if (mRemainingEarlyFrameCount > 0) { |
| 99 | mRemainingEarlyFrameCount--; |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 100 | updateOffsetsNeeded = true; |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 101 | } |
| 102 | if (usedRenderEngine != mLastFrameUsedRenderEngine) { |
| 103 | mLastFrameUsedRenderEngine = usedRenderEngine; |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 104 | updateOffsetsNeeded = true; |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 105 | } |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 106 | if (updateOffsetsNeeded) { |
| 107 | updateOffsets(); |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 108 | } |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 109 | } |
| 110 | |
| 111 | private: |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 112 | void updateOffsets() { |
| 113 | const Offsets desired = getOffsets(); |
| 114 | const Offsets current = mOffsets; |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 115 | |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 116 | bool changed = false; |
| 117 | if (desired.sf != current.sf) { |
Ana Krulec | 12096d0 | 2018-09-07 14:54:14 -0700 | [diff] [blame] | 118 | if (mSfConnectionHandle != nullptr) { |
| 119 | mScheduler->setPhaseOffset(mSfConnectionHandle, desired.sf); |
| 120 | } else { |
| 121 | mSfEventThread->setPhaseOffset(desired.sf); |
| 122 | } |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 123 | changed = true; |
| 124 | } |
| 125 | if (desired.app != current.app) { |
Ana Krulec | 12096d0 | 2018-09-07 14:54:14 -0700 | [diff] [blame] | 126 | if (mSfConnectionHandle != nullptr) { |
| 127 | mScheduler->setPhaseOffset(mAppConnectionHandle, desired.app); |
| 128 | } else { |
| 129 | mAppEventThread->setPhaseOffset(desired.app); |
| 130 | } |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 131 | changed = true; |
| 132 | } |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 133 | |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 134 | if (changed) { |
| 135 | mOffsets = desired; |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 136 | } |
| 137 | } |
| 138 | |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 139 | Offsets getOffsets() { |
Ana Krulec | 7ecce8c | 2018-10-12 13:44:41 -0700 | [diff] [blame^] | 140 | if (mTransactionStart == Scheduler::TransactionStart::EARLY || |
| 141 | mRemainingEarlyFrameCount > 0) { |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 142 | return mEarlyOffsets; |
| 143 | } else if (mLastFrameUsedRenderEngine) { |
| 144 | return mEarlyGlOffsets; |
| 145 | } else { |
| 146 | return mLateOffsets; |
| 147 | } |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 148 | } |
| 149 | |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 150 | Offsets mLateOffsets; |
| 151 | Offsets mEarlyOffsets; |
| 152 | Offsets mEarlyGlOffsets; |
| 153 | |
| 154 | EventThread* mSfEventThread = nullptr; |
| 155 | EventThread* mAppEventThread = nullptr; |
| 156 | |
Ana Krulec | 12096d0 | 2018-09-07 14:54:14 -0700 | [diff] [blame] | 157 | Scheduler* mScheduler = nullptr; |
| 158 | Scheduler::ConnectionHandle* mAppConnectionHandle = nullptr; |
| 159 | Scheduler::ConnectionHandle* mSfConnectionHandle = nullptr; |
| 160 | |
Jorim Jaggi | 22ec38b | 2018-06-19 15:57:08 +0200 | [diff] [blame] | 161 | std::atomic<Offsets> mOffsets; |
| 162 | |
Ana Krulec | 7ecce8c | 2018-10-12 13:44:41 -0700 | [diff] [blame^] | 163 | std::atomic<Scheduler::TransactionStart> mTransactionStart = |
| 164 | Scheduler::TransactionStart::NORMAL; |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 165 | std::atomic<bool> mLastFrameUsedRenderEngine = false; |
Jorim Jaggi | 9053521 | 2018-05-23 23:44:06 +0200 | [diff] [blame] | 166 | std::atomic<int> mRemainingEarlyFrameCount = 0; |
Dan Stoza | 2713c30 | 2018-03-28 17:07:36 -0700 | [diff] [blame] | 167 | }; |
| 168 | |
| 169 | } // namespace android |