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