1 /*
2  * Copyright 2020 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 "DisplayHardware/Hal.h"
20 #include "Fps.h"
21 #include "Scheduler/StrongTyping.h"
22 
23 #include <android-base/stringprintf.h>
24 #include <android/configuration.h>
25 #include <ui/DisplayMode.h>
26 #include <ui/Size.h>
27 #include <utils/Timers.h>
28 
29 #include <cstddef>
30 #include <memory>
31 #include <vector>
32 
33 namespace android {
34 
35 namespace hal = android::hardware::graphics::composer::hal;
36 
37 class DisplayMode;
38 using DisplayModePtr = std::shared_ptr<const DisplayMode>;
39 using DisplayModes = std::vector<DisplayModePtr>;
40 using DisplayModeId = StrongTyping<ui::DisplayModeId, struct DisplayModeIdTag, Compare, Hash>;
41 
42 class DisplayMode {
43 public:
44     class Builder {
45     public:
Builder(hal::HWConfigId id)46         explicit Builder(hal::HWConfigId id) : mDisplayMode(new DisplayMode(id)) {}
47 
build()48         DisplayModePtr build() {
49             return std::const_pointer_cast<const DisplayMode>(std::move(mDisplayMode));
50         }
51 
setId(DisplayModeId id)52         Builder& setId(DisplayModeId id) {
53             mDisplayMode->mId = id;
54             return *this;
55         }
56 
setWidth(int32_t width)57         Builder& setWidth(int32_t width) {
58             mDisplayMode->mWidth = width;
59             return *this;
60         }
61 
setHeight(int32_t height)62         Builder& setHeight(int32_t height) {
63             mDisplayMode->mHeight = height;
64             return *this;
65         }
66 
setVsyncPeriod(int32_t vsyncPeriod)67         Builder& setVsyncPeriod(int32_t vsyncPeriod) {
68             mDisplayMode->mFps = Fps::fromPeriodNsecs(vsyncPeriod);
69             return *this;
70         }
71 
setDpiX(int32_t dpiX)72         Builder& setDpiX(int32_t dpiX) {
73             if (dpiX == -1) {
74                 mDisplayMode->mDpiX = getDefaultDensity();
75             } else {
76                 mDisplayMode->mDpiX = dpiX / 1000.0f;
77             }
78             return *this;
79         }
80 
setDpiY(int32_t dpiY)81         Builder& setDpiY(int32_t dpiY) {
82             if (dpiY == -1) {
83                 mDisplayMode->mDpiY = getDefaultDensity();
84             } else {
85                 mDisplayMode->mDpiY = dpiY / 1000.0f;
86             }
87             return *this;
88         }
89 
setGroup(int32_t group)90         Builder& setGroup(int32_t group) {
91             mDisplayMode->mGroup = group;
92             return *this;
93         }
94 
95     private:
getDefaultDensity()96         float getDefaultDensity() {
97             // Default density is based on TVs: 1080p displays get XHIGH density, lower-
98             // resolution displays get TV density. Maybe eventually we'll need to update
99             // it for 4k displays, though hopefully those will just report accurate DPI
100             // information to begin with. This is also used for virtual displays and
101             // older HWC implementations, so be careful about orientation.
102 
103             auto longDimension = std::max(mDisplayMode->mWidth, mDisplayMode->mHeight);
104             if (longDimension >= 1080) {
105                 return ACONFIGURATION_DENSITY_XHIGH;
106             } else {
107                 return ACONFIGURATION_DENSITY_TV;
108             }
109         }
110         std::shared_ptr<DisplayMode> mDisplayMode;
111     };
112 
getId()113     DisplayModeId getId() const { return mId; }
getHwcId()114     hal::HWConfigId getHwcId() const { return mHwcId; }
115 
getWidth()116     int32_t getWidth() const { return mWidth; }
getHeight()117     int32_t getHeight() const { return mHeight; }
getSize()118     ui::Size getSize() const { return {mWidth, mHeight}; }
getFps()119     Fps getFps() const { return mFps; }
getVsyncPeriod()120     nsecs_t getVsyncPeriod() const { return mFps.getPeriodNsecs(); }
getDpiX()121     float getDpiX() const { return mDpiX; }
getDpiY()122     float getDpiY() const { return mDpiY; }
123 
124     // Switches between modes in the same group are seamless, i.e.
125     // without visual interruptions such as a black screen.
getGroup()126     int32_t getGroup() const { return mGroup; }
127 
equalsExceptDisplayModeId(const DisplayModePtr & other)128     bool equalsExceptDisplayModeId(const DisplayModePtr& other) const {
129         return mHwcId == other->mHwcId && mWidth == other->mWidth && mHeight == other->mHeight &&
130                 getVsyncPeriod() == other->getVsyncPeriod() && mDpiX == other->mDpiX &&
131                 mDpiY == other->mDpiY && mGroup == other->mGroup;
132     }
133 
134 private:
DisplayMode(hal::HWConfigId id)135     explicit DisplayMode(hal::HWConfigId id) : mHwcId(id) {}
136 
137     hal::HWConfigId mHwcId;
138     DisplayModeId mId;
139 
140     int32_t mWidth = -1;
141     int32_t mHeight = -1;
142     Fps mFps;
143     float mDpiX = -1;
144     float mDpiY = -1;
145     int32_t mGroup = -1;
146 };
147 
to_string(const DisplayMode & mode)148 inline std::string to_string(const DisplayMode& mode) {
149     return base::StringPrintf("{id=%d, hwcId=%d, width=%d, height=%d, refreshRate=%s, "
150                               "dpiX=%.2f, dpiY=%.2f, group=%d}",
151                               mode.getId().value(), mode.getHwcId(), mode.getWidth(),
152                               mode.getHeight(), to_string(mode.getFps()).c_str(), mode.getDpiX(),
153                               mode.getDpiY(), mode.getGroup());
154 }
155 
156 } // namespace android