• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 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 "BufferLayer.h"
20 #include "Layer.h"
21 
22 #include <renderengine/Image.h>
23 #include <renderengine/RenderEngine.h>
24 #include <system/window.h>
25 #include <utils/String8.h>
26 
27 #include <stack>
28 
29 namespace android {
30 
31 class SlotGenerationTest;
32 
33 class BufferStateLayer : public BufferLayer {
34 public:
35     explicit BufferStateLayer(const LayerCreationArgs&);
36 
37     ~BufferStateLayer() override;
38 
39     // -----------------------------------------------------------------------
40     // Interface implementation for Layer
41     // -----------------------------------------------------------------------
getType()42     const char* getType() const override { return "BufferStateLayer"; }
43 
44     void onLayerDisplayed(const sp<Fence>& releaseFence) override;
45     void releasePendingBuffer(nsecs_t dequeueReadyTime) override;
46 
47     void finalizeFrameEventHistory(const std::shared_ptr<FenceTime>& glDoneFence,
48                                    const CompositorTiming& compositorTiming) override;
49 
50     bool shouldPresentNow(nsecs_t expectedPresentTime) const override;
51 
doTransactionResize(uint32_t flags,Layer::State *)52     uint32_t doTransactionResize(uint32_t flags, Layer::State* /*stateToCommit*/) override {
53         return flags;
54     }
55     /*TODO:vhau return to using BufferStateLayer override once WM
56      * has removed deferred transactions!
57     void pushPendingState() override;*/
58     bool applyPendingStates(Layer::State* stateToCommit) override;
59 
getActiveWidth(const Layer::State & s)60     uint32_t getActiveWidth(const Layer::State& s) const override { return s.active.w; }
getActiveHeight(const Layer::State & s)61     uint32_t getActiveHeight(const Layer::State& s) const override { return s.active.h; }
getActiveTransform(const Layer::State & s)62     ui::Transform getActiveTransform(const Layer::State& s) const override {
63         return s.active.transform;
64     }
getActiveTransparentRegion(const Layer::State & s)65     Region getActiveTransparentRegion(const Layer::State& s) const override {
66         return s.transparentRegionHint;
67     }
68     Rect getCrop(const Layer::State& s) const;
69 
70     bool setTransform(uint32_t transform) override;
71     bool setTransformToDisplayInverse(bool transformToDisplayInverse) override;
72     bool setCrop(const Rect& crop) override;
73     bool setFrame(const Rect& frame) override;
74     bool setBuffer(const sp<GraphicBuffer>& buffer, const sp<Fence>& acquireFence, nsecs_t postTime,
75                    nsecs_t desiredPresentTime, const client_cache_t& clientCacheId) override;
76     bool setAcquireFence(const sp<Fence>& fence) override;
77     bool setDataspace(ui::Dataspace dataspace) override;
78     bool setHdrMetadata(const HdrMetadata& hdrMetadata) override;
79     bool setSurfaceDamageRegion(const Region& surfaceDamage) override;
80     bool setApi(int32_t api) override;
81     bool setSidebandStream(const sp<NativeHandle>& sidebandStream) override;
82     bool setTransactionCompletedListeners(const std::vector<sp<CallbackHandle>>& handles) override;
83     void forceSendCallbacks() override;
84     bool addFrameEvent(const sp<Fence>& acquireFence, nsecs_t postedTime,
85                        nsecs_t requestedPresentTime) override;
86 
87     // Override to ignore legacy layer state properties that are not used by BufferStateLayer
setSize(uint32_t,uint32_t)88     bool setSize(uint32_t /*w*/, uint32_t /*h*/) override { return false; }
setPosition(float,float)89     bool setPosition(float /*x*/, float /*y*/) override { return false; }
90     bool setTransparentRegionHint(const Region& transparent) override;
setMatrix(const layer_state_t::matrix22_t &,bool)91     bool setMatrix(const layer_state_t::matrix22_t& /*matrix*/,
92                    bool /*allowNonRectPreservingTransforms*/) override {
93         return false;
94     }
setCrop_legacy(const Rect &)95     bool setCrop_legacy(const Rect& /*crop*/) override { return false; }
setOverrideScalingMode(int32_t)96     bool setOverrideScalingMode(int32_t /*overrideScalingMode*/) override { return false; }
deferTransactionUntil_legacy(const sp<IBinder> &,uint64_t)97     void deferTransactionUntil_legacy(const sp<IBinder>& /*barrierHandle*/,
98                                       uint64_t /*frameNumber*/) override {}
deferTransactionUntil_legacy(const sp<Layer> &,uint64_t)99     void deferTransactionUntil_legacy(const sp<Layer>& /*barrierLayer*/,
100                                       uint64_t /*frameNumber*/) override {}
101 
102     Rect getBufferSize(const State& s) const override;
103     FloatRect computeSourceBounds(const FloatRect& parentBounds) const override;
104     Layer::RoundedCornerState getRoundedCornerState() const override;
105 
106     // -----------------------------------------------------------------------
107 
108     // -----------------------------------------------------------------------
109     // Interface implementation for BufferLayer
110     // -----------------------------------------------------------------------
111     bool fenceHasSignaled() const override;
112     bool framePresentTimeIsCurrent(nsecs_t expectedPresentTime) const override;
113     bool onPreComposition(nsecs_t refreshStartTime) override;
114 
115 protected:
116     void gatherBufferInfo() override;
117     uint64_t getHeadFrameNumber(nsecs_t expectedPresentTime) const;
118 
119 private:
120     bool updateFrameEventHistory(const sp<Fence>& acquireFence, nsecs_t postedTime,
121                                  nsecs_t requestedPresentTime);
122 
123     uint64_t getFrameNumber(nsecs_t expectedPresentTime) const override;
124 
125     bool getAutoRefresh() const override;
126     bool getSidebandStreamChanged() const override;
127 
128     bool latchSidebandStream(bool& recomputeVisibleRegions) override;
129 
130     bool hasFrameUpdate() const override;
131 
132     status_t bindTextureImage() override;
133     status_t updateTexImage(bool& recomputeVisibleRegions, nsecs_t latchTime,
134                             nsecs_t expectedPresentTime) override;
135 
136     status_t updateActiveBuffer() override;
137     status_t updateFrameNumber(nsecs_t latchTime) override;
138 
139     sp<Layer> createClone() override;
140 
141     // Crop that applies to the buffer
142     Rect computeCrop(const State& s);
143 
144 private:
145     friend class SlotGenerationTest;
146     bool willPresentCurrentTransaction() const;
147 
148     static const std::array<float, 16> IDENTITY_MATRIX;
149 
150     std::unique_ptr<renderengine::Image> mTextureImage;
151 
152     std::atomic<bool> mSidebandStreamChanged{false};
153 
154     mutable uint64_t mFrameNumber{0};
155     uint64_t mFrameCounter{0};
156 
157     sp<Fence> mPreviousReleaseFence;
158     uint64_t mPreviousBufferId = 0;
159     uint64_t mPreviousReleasedFrameNumber = 0;
160 
161     mutable bool mCurrentStateModified = false;
162     bool mReleasePreviousBuffer = false;
163     nsecs_t mCallbackHandleAcquireTime = -1;
164 
165     // TODO(marissaw): support sticky transform for LEGACY camera mode
166 
167     class HwcSlotGenerator : public ClientCache::ErasedRecipient {
168     public:
HwcSlotGenerator()169         HwcSlotGenerator() {
170             for (uint32_t i = 0; i < BufferQueue::NUM_BUFFER_SLOTS; i++) {
171                 mFreeHwcCacheSlots.push(i);
172             }
173         }
174 
175         void bufferErased(const client_cache_t& clientCacheId);
176 
177         uint32_t getHwcCacheSlot(const client_cache_t& clientCacheId);
178 
179     private:
180         friend class SlotGenerationTest;
181         uint32_t addCachedBuffer(const client_cache_t& clientCacheId) REQUIRES(mMutex);
182         uint32_t getFreeHwcCacheSlot() REQUIRES(mMutex);
183         void evictLeastRecentlyUsed() REQUIRES(mMutex);
184         void eraseBufferLocked(const client_cache_t& clientCacheId) REQUIRES(mMutex);
185 
186         struct CachedBufferHash {
operatorCachedBufferHash187             std::size_t operator()(const client_cache_t& clientCacheId) const {
188                 return std::hash<uint64_t>{}(clientCacheId.id);
189             }
190         };
191 
192         std::mutex mMutex;
193 
194         std::unordered_map<client_cache_t,
195                            std::pair<uint32_t /*HwcCacheSlot*/, uint32_t /*counter*/>,
196                            CachedBufferHash>
197                 mCachedBuffers GUARDED_BY(mMutex);
198         std::stack<uint32_t /*HwcCacheSlot*/> mFreeHwcCacheSlots GUARDED_BY(mMutex);
199 
200         // The cache increments this counter value when a slot is updated or used.
201         // Used to track the least recently-used buffer
202         uint64_t mCounter = 0;
203     };
204 
205     sp<HwcSlotGenerator> mHwcSlotGenerator;
206 };
207 
208 } // namespace android
209