LogicalDisplay.java revision 92130f6407dc51c58b3b941d28a6daf4e04b8d62
1/* 2 * Copyright (C) 2012 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 17package com.android.server.display; 18 19import android.graphics.Rect; 20import android.view.Display; 21import android.view.DisplayInfo; 22import android.view.Surface; 23 24import java.io.PrintWriter; 25import java.util.List; 26 27import libcore.util.Objects; 28 29/** 30 * Describes how a logical display is configured. 31 * <p> 32 * At this time, we only support logical displays that are coupled to a particular 33 * primary display device from which the logical display derives its basic properties 34 * such as its size, density and refresh rate. 35 * </p><p> 36 * A logical display may be mirrored onto multiple display devices in addition to its 37 * primary display device. Note that the contents of a logical display may not 38 * always be visible, even on its primary display device, such as in the case where 39 * the primary display device is currently mirroring content from a different 40 * logical display. 41 * </p><p> 42 * This object is designed to encapsulate as much of the policy of logical 43 * displays as possible. The idea is to make it easy to implement new kinds of 44 * logical displays mostly by making local changes to this class. 45 * </p><p> 46 * Note: The display manager architecture does not actually require logical displays 47 * to be associated with any individual display device. Logical displays and 48 * display devices are orthogonal concepts. Some mapping will exist between 49 * logical displays and display devices but it can be many-to-many and 50 * and some might have no relation at all. 51 * </p><p> 52 * Logical displays are guarded by the {@link DisplayManagerService.SyncRoot} lock. 53 * </p> 54 */ 55final class LogicalDisplay { 56 private final DisplayInfo mBaseDisplayInfo = new DisplayInfo(); 57 58 // The layer stack we use when the display has been blanked to prevent any 59 // of its content from appearing. 60 private static final int BLANK_LAYER_STACK = -1; 61 62 private final int mDisplayId; 63 private final int mLayerStack; 64 private DisplayInfo mOverrideDisplayInfo; // set by the window manager 65 private DisplayInfo mInfo; 66 67 // The display device that this logical display is based on and which 68 // determines the base metrics that it uses. 69 private DisplayDevice mPrimaryDisplayDevice; 70 private DisplayDeviceInfo mPrimaryDisplayDeviceInfo; 71 72 // True if the logical display has unique content. 73 private boolean mHasContent; 74 75 // Temporary rectangle used when needed. 76 private final Rect mTempLayerStackRect = new Rect(); 77 private final Rect mTempDisplayRect = new Rect(); 78 79 public LogicalDisplay(int displayId, int layerStack, DisplayDevice primaryDisplayDevice) { 80 mDisplayId = displayId; 81 mLayerStack = layerStack; 82 mPrimaryDisplayDevice = primaryDisplayDevice; 83 } 84 85 /** 86 * Gets the logical display id of this logical display. 87 * 88 * @return The logical display id. 89 */ 90 public int getDisplayIdLocked() { 91 return mDisplayId; 92 } 93 94 /** 95 * Gets the primary display device associated with this logical display. 96 * 97 * @return The primary display device. 98 */ 99 public DisplayDevice getPrimaryDisplayDeviceLocked() { 100 return mPrimaryDisplayDevice; 101 } 102 103 /** 104 * Gets information about the logical display. 105 * 106 * @return The device info, which should be treated as immutable by the caller. 107 * The logical display should allocate a new display info object whenever 108 * the data changes. 109 */ 110 public DisplayInfo getDisplayInfoLocked() { 111 if (mInfo == null) { 112 mInfo = new DisplayInfo(); 113 if (mOverrideDisplayInfo != null) { 114 mInfo.copyFrom(mOverrideDisplayInfo); 115 mInfo.layerStack = mBaseDisplayInfo.layerStack; 116 mInfo.name = mBaseDisplayInfo.name; 117 } else { 118 mInfo.copyFrom(mBaseDisplayInfo); 119 } 120 } 121 return mInfo; 122 } 123 124 /** 125 * Sets overridden logical display information from the window manager. 126 * This method can be used to adjust application insets, rotation, and other 127 * properties that the window manager takes care of. 128 * 129 * @param info The logical display information, may be null. 130 */ 131 public void setDisplayInfoOverrideFromWindowManagerLocked(DisplayInfo info) { 132 if (info != null) { 133 if (mOverrideDisplayInfo == null) { 134 mOverrideDisplayInfo = new DisplayInfo(info); 135 mInfo = null; 136 } else if (!mOverrideDisplayInfo.equals(info)) { 137 mOverrideDisplayInfo.copyFrom(info); 138 mInfo = null; 139 } 140 } else if (mOverrideDisplayInfo != null) { 141 mOverrideDisplayInfo = null; 142 mInfo = null; 143 } 144 } 145 146 /** 147 * Returns true if the logical display is in a valid state. 148 * This method should be checked after calling {@link #updateLocked} to handle the 149 * case where a logical display should be removed because all of its associated 150 * display devices are gone or if it is otherwise no longer needed. 151 * 152 * @return True if the logical display is still valid. 153 */ 154 public boolean isValidLocked() { 155 return mPrimaryDisplayDevice != null; 156 } 157 158 /** 159 * Updates the state of the logical display based on the available display devices. 160 * The logical display might become invalid if it is attached to a display device 161 * that no longer exists. 162 * 163 * @param devices The list of all connected display devices. 164 */ 165 public void updateLocked(List<DisplayDevice> devices) { 166 // Nothing to update if already invalid. 167 if (mPrimaryDisplayDevice == null) { 168 return; 169 } 170 171 // Check whether logical display has become invalid. 172 if (!devices.contains(mPrimaryDisplayDevice)) { 173 mPrimaryDisplayDevice = null; 174 return; 175 } 176 177 // Bootstrap the logical display using its associated primary physical display. 178 // We might use more elaborate configurations later. It's possible that the 179 // configuration of several physical displays might be used to determine the 180 // logical display that they are sharing. (eg. Adjust size for pixel-perfect 181 // mirroring over HDMI.) 182 DisplayDeviceInfo deviceInfo = mPrimaryDisplayDevice.getDisplayDeviceInfoLocked(); 183 if (!Objects.equal(mPrimaryDisplayDeviceInfo, deviceInfo)) { 184 mBaseDisplayInfo.layerStack = mLayerStack; 185 mBaseDisplayInfo.flags = 0; 186 if ((deviceInfo.flags & DisplayDeviceInfo.FLAG_SUPPORTS_PROTECTED_BUFFERS) != 0) { 187 mBaseDisplayInfo.flags |= Display.FLAG_SUPPORTS_PROTECTED_BUFFERS; 188 } 189 if ((deviceInfo.flags & DisplayDeviceInfo.FLAG_SECURE) != 0) { 190 mBaseDisplayInfo.flags |= Display.FLAG_SECURE; 191 } 192 mBaseDisplayInfo.type = deviceInfo.type; 193 mBaseDisplayInfo.address = deviceInfo.address; 194 mBaseDisplayInfo.name = deviceInfo.name; 195 mBaseDisplayInfo.appWidth = deviceInfo.width; 196 mBaseDisplayInfo.appHeight = deviceInfo.height; 197 mBaseDisplayInfo.logicalWidth = deviceInfo.width; 198 mBaseDisplayInfo.logicalHeight = deviceInfo.height; 199 mBaseDisplayInfo.rotation = Surface.ROTATION_0; 200 mBaseDisplayInfo.refreshRate = deviceInfo.refreshRate; 201 mBaseDisplayInfo.logicalDensityDpi = deviceInfo.densityDpi; 202 mBaseDisplayInfo.physicalXDpi = deviceInfo.xDpi; 203 mBaseDisplayInfo.physicalYDpi = deviceInfo.yDpi; 204 mBaseDisplayInfo.smallestNominalAppWidth = deviceInfo.width; 205 mBaseDisplayInfo.smallestNominalAppHeight = deviceInfo.height; 206 mBaseDisplayInfo.largestNominalAppWidth = deviceInfo.width; 207 mBaseDisplayInfo.largestNominalAppHeight = deviceInfo.height; 208 209 mPrimaryDisplayDeviceInfo = deviceInfo; 210 mInfo = null; 211 } 212 } 213 214 /** 215 * Applies the layer stack and transformation to the given display device 216 * so that it shows the contents of this logical display. 217 * 218 * We know that the given display device is only ever showing the contents of 219 * a single logical display, so this method is expected to blow away all of its 220 * transformation properties to make it happen regardless of what the 221 * display device was previously showing. 222 * 223 * The caller must have an open Surface transaction. 224 * 225 * The display device may not be the primary display device, in the case 226 * where the display is being mirrored. 227 * 228 * @param device The display device to modify. 229 * @param isBlanked True if the device is being blanked. 230 */ 231 public void configureDisplayInTransactionLocked(DisplayDevice device, 232 boolean isBlanked) { 233 final DisplayInfo displayInfo = getDisplayInfoLocked(); 234 final DisplayDeviceInfo displayDeviceInfo = device.getDisplayDeviceInfoLocked(); 235 236 // Set the layer stack. 237 device.setLayerStackInTransactionLocked(isBlanked ? BLANK_LAYER_STACK : mLayerStack); 238 239 // Set the viewport. 240 // This is the area of the logical display that we intend to show on the 241 // display device. For now, it is always the full size of the logical display. 242 mTempLayerStackRect.set(0, 0, displayInfo.logicalWidth, displayInfo.logicalHeight); 243 244 // Set the orientation. 245 // The orientation specifies how the physical coordinate system of the display 246 // is rotated when the contents of the logical display are rendered. 247 int orientation = Surface.ROTATION_0; 248 if (device == mPrimaryDisplayDevice 249 && (displayDeviceInfo.flags & DisplayDeviceInfo.FLAG_ROTATES_WITH_CONTENT) != 0) { 250 orientation = displayInfo.rotation; 251 } 252 253 // Apply the physical rotation of the display device itself. 254 orientation = (orientation + displayDeviceInfo.rotation) % 4; 255 256 // Set the frame. 257 // The frame specifies the rotated physical coordinates into which the viewport 258 // is mapped. We need to take care to preserve the aspect ratio of the viewport. 259 // Currently we maximize the area to fill the display, but we could try to be 260 // more clever and match resolutions. 261 boolean rotated = (orientation == Surface.ROTATION_90 262 || orientation == Surface.ROTATION_270); 263 int physWidth = rotated ? displayDeviceInfo.height : displayDeviceInfo.width; 264 int physHeight = rotated ? displayDeviceInfo.width : displayDeviceInfo.height; 265 266 // Determine whether the width or height is more constrained to be scaled. 267 // physWidth / displayInfo.logicalWidth => letter box 268 // or physHeight / displayInfo.logicalHeight => pillar box 269 // 270 // We avoid a division (and possible floating point imprecision) here by 271 // multiplying the fractions by the product of their denominators before 272 // comparing them. 273 int displayRectWidth, displayRectHeight; 274 if (physWidth * displayInfo.logicalHeight 275 < physHeight * displayInfo.logicalWidth) { 276 // Letter box. 277 displayRectWidth = physWidth; 278 displayRectHeight = displayInfo.logicalHeight * physWidth / displayInfo.logicalWidth; 279 } else { 280 // Pillar box. 281 displayRectWidth = displayInfo.logicalWidth * physHeight / displayInfo.logicalHeight; 282 displayRectHeight = physHeight; 283 } 284 int displayRectTop = (physHeight - displayRectHeight) / 2; 285 int displayRectLeft = (physWidth - displayRectWidth) / 2; 286 mTempDisplayRect.set(displayRectLeft, displayRectTop, 287 displayRectLeft + displayRectWidth, displayRectTop + displayRectHeight); 288 289 device.setProjectionInTransactionLocked(orientation, mTempLayerStackRect, mTempDisplayRect); 290 } 291 292 /** 293 * Returns true if the logical display has unique content. 294 * <p> 295 * If the display has unique content then we will try to ensure that it is 296 * visible on at least its primary display device. Otherwise we will ignore the 297 * logical display and perhaps show mirrored content on the primary display device. 298 * </p> 299 * 300 * @return True if the display has unique content. 301 */ 302 public boolean hasContentLocked() { 303 return mHasContent; 304 } 305 306 /** 307 * Sets whether the logical display has unique content. 308 * 309 * @param hasContent True if the display has unique content. 310 */ 311 public void setHasContentLocked(boolean hasContent) { 312 mHasContent = hasContent; 313 } 314 315 public void dumpLocked(PrintWriter pw) { 316 pw.println("mDisplayId=" + mDisplayId); 317 pw.println("mLayerStack=" + mLayerStack); 318 pw.println("mHasContent=" + mHasContent); 319 pw.println("mPrimaryDisplayDevice=" + (mPrimaryDisplayDevice != null ? 320 mPrimaryDisplayDevice.getNameLocked() : "null")); 321 pw.println("mBaseDisplayInfo=" + mBaseDisplayInfo); 322 pw.println("mOverrideDisplayInfo=" + mOverrideDisplayInfo); 323 } 324}