FakeComposerClient.h revision a7de594782a5a7fcfd0300117f362f173631e1af 
1/*
2 * Copyright 2017 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 "ComposerClient.h"
20#include "RenderState.h"
21
22// Needed for display type/ID enums
23#include <hardware/hwcomposer_defs.h>
24
25#include <utils/Condition.h>
26
27#include <chrono>
28
29using namespace android::hardware::graphics::composer::V2_1;
30using namespace android::hardware::graphics::composer::V2_1::implementation;
31using namespace android::hardware;
32using namespace std::chrono_literals;
33
34namespace {
35class LayerImpl;
36class Frame;
37class DelayedEventGenerator;
38} // namespace
39
40namespace android {
41class SurfaceComposerClient;
42} // namespace android
43
44namespace sftest {
45
46// NOTE: The ID's need to be exactly these. VR composer and parts of
47// the SurfaceFlinger assume the display IDs to have these values
48// despite the enum being documented as a display type.
49// TODO: Reference to actual documentation
50constexpr Display PRIMARY_DISPLAY = static_cast<Display>(HWC_DISPLAY_PRIMARY);
51constexpr Display EXTERNAL_DISPLAY = static_cast<Display>(HWC_DISPLAY_EXTERNAL);
52
53class FakeComposerClient : public ComposerBase {
54public:
55    FakeComposerClient();
56    virtual ~FakeComposerClient();
57
58    void removeClient() override;
59    void enableCallback(bool enable) override;
60    uint32_t getMaxVirtualDisplayCount() override;
61    Error createVirtualDisplay(uint32_t width, uint32_t height, PixelFormat* format,
62                               Display* outDisplay) override;
63    Error destroyVirtualDisplay(Display display) override;
64    Error createLayer(Display display, Layer* outLayer) override;
65    Error destroyLayer(Display display, Layer layer) override;
66
67    Error getActiveConfig(Display display, Config* outConfig) override;
68    Error getClientTargetSupport(Display display, uint32_t width, uint32_t height,
69                                 PixelFormat format, Dataspace dataspace) override;
70    Error getColorModes(Display display, hidl_vec<ColorMode>* outModes) override;
71    Error getDisplayAttribute(Display display, Config config, IComposerClient::Attribute attribute,
72                              int32_t* outValue) override;
73    Error getDisplayConfigs(Display display, hidl_vec<Config>* outConfigs) override;
74    Error getDisplayName(Display display, hidl_string* outName) override;
75    Error getDisplayType(Display display, IComposerClient::DisplayType* outType) override;
76    Error getDozeSupport(Display display, bool* outSupport) override;
77    Error getHdrCapabilities(Display display, hidl_vec<Hdr>* outTypes, float* outMaxLuminance,
78                             float* outMaxAverageLuminance, float* outMinLuminance) override;
79
80    Error setActiveConfig(Display display, Config config) override;
81    Error setColorMode(Display display, ColorMode mode) override;
82    Error setPowerMode(Display display, IComposerClient::PowerMode mode) override;
83    Error setVsyncEnabled(Display display, IComposerClient::Vsync enabled) override;
84
85    Error setColorTransform(Display display, const float* matrix, int32_t hint) override;
86    Error setClientTarget(Display display, buffer_handle_t target, int32_t acquireFence,
87                          int32_t dataspace, const std::vector<hwc_rect_t>& damage) override;
88    Error setOutputBuffer(Display display, buffer_handle_t buffer, int32_t releaseFence) override;
89    Error validateDisplay(Display display, std::vector<Layer>* outChangedLayers,
90                          std::vector<IComposerClient::Composition>* outCompositionTypes,
91                          uint32_t* outDisplayRequestMask, std::vector<Layer>* outRequestedLayers,
92                          std::vector<uint32_t>* outRequestMasks) override;
93    Error acceptDisplayChanges(Display display) override;
94    Error presentDisplay(Display display, int32_t* outPresentFence, std::vector<Layer>* outLayers,
95                         std::vector<int32_t>* outReleaseFences) override;
96
97    Error setLayerCursorPosition(Display display, Layer layer, int32_t x, int32_t y) override;
98    Error setLayerBuffer(Display display, Layer layer, buffer_handle_t buffer,
99                         int32_t acquireFence) override;
100    Error setLayerSurfaceDamage(Display display, Layer layer,
101                                const std::vector<hwc_rect_t>& damage) override;
102    Error setLayerBlendMode(Display display, Layer layer, int32_t mode) override;
103    Error setLayerColor(Display display, Layer layer, IComposerClient::Color color) override;
104    Error setLayerCompositionType(Display display, Layer layer, int32_t type) override;
105    Error setLayerDataspace(Display display, Layer layer, int32_t dataspace) override;
106    Error setLayerDisplayFrame(Display display, Layer layer, const hwc_rect_t& frame) override;
107    Error setLayerPlaneAlpha(Display display, Layer layer, float alpha) override;
108    Error setLayerSidebandStream(Display display, Layer layer, buffer_handle_t stream) override;
109    Error setLayerSourceCrop(Display display, Layer layer, const hwc_frect_t& crop) override;
110    Error setLayerTransform(Display display, Layer layer, int32_t transform) override;
111    Error setLayerVisibleRegion(Display display, Layer layer,
112                                const std::vector<hwc_rect_t>& visible) override;
113    Error setLayerZOrder(Display display, Layer layer, uint32_t z) override;
114
115    void setClient(ComposerClient* client);
116
117    void requestVSync(uint64_t vsyncTime = 0);
118    // We don't want tests hanging, so always use a timeout. Remember
119    // to always check the number of frames with test ASSERT_!
120    // Wait until next frame is rendered after requesting vsync.
121    void runVSyncAndWait(std::chrono::nanoseconds maxWait = 100ms);
122    void runVSyncAfter(std::chrono::nanoseconds wait);
123
124    int getFrameCount() const;
125    // We don't want tests hanging, so always use a timeout. Remember
126    // to always check the number of frames with test ASSERT_!
127    void waitUntilFrame(int targetFrame, std::chrono::nanoseconds maxWait = 100ms) const;
128    std::vector<RenderState> getFrameRects(int frame) const;
129    std::vector<RenderState> getLatestFrame() const;
130    void clearFrames();
131
132    void onSurfaceFlingerStart();
133    void onSurfaceFlingerStop();
134
135    int getLayerCount() const;
136    Layer getLayer(size_t index) const;
137
138    void hotplugDisplay(Display display, IComposerCallback::Connection state);
139
140private:
141    LayerImpl& getLayerImpl(Layer handle);
142
143    bool mCallbacksOn;
144    ComposerClient* mClient;
145    Config mCurrentConfig;
146    bool mVsyncEnabled;
147    std::vector<std::unique_ptr<LayerImpl>> mLayers;
148    std::vector<std::unique_ptr<Frame>> mFrames;
149    // Using a pointer to hide the implementation into the CPP file.
150    std::unique_ptr<DelayedEventGenerator> mDelayedEventGenerator;
151    android::sp<android::SurfaceComposerClient> mSurfaceComposer; // For VSync injections
152    mutable android::Mutex mStateMutex;
153    mutable android::Condition mFramesAvailable;
154};
155
156} // namespace sftest
157