display_manager.h revision 6e8cce623b6e4fe0c9e4af605d675dd9d0338c38
1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef ASH_DISPLAY_DISPLAY_MANAGER_H_ 6#define ASH_DISPLAY_DISPLAY_MANAGER_H_ 7 8#include <string> 9#include <vector> 10 11#include "ash/ash_export.h" 12#include "ash/display/display_info.h" 13#include "ash/display/display_layout.h" 14#include "base/compiler_specific.h" 15#include "base/gtest_prod_util.h" 16#include "base/memory/scoped_ptr.h" 17#include "ui/gfx/display.h" 18 19#if defined(OS_CHROMEOS) 20#include "ui/display/chromeos/display_configurator.h" 21#endif 22 23namespace gfx { 24class Display; 25class Insets; 26class Rect; 27class Screen; 28} 29 30namespace ash { 31class AcceleratorControllerTest; 32class DisplayController; 33class DisplayLayoutStore; 34class ScreenAsh; 35 36namespace test { 37class DisplayManagerTestApi; 38class SystemGestureEventFilterTest; 39} 40 41// DisplayManager maintains the current display configurations, 42// and notifies observers when configuration changes. 43// 44// TODO(oshima): Make this non internal. 45class ASH_EXPORT DisplayManager 46#if defined(OS_CHROMEOS) 47 : public ui::DisplayConfigurator::SoftwareMirroringController 48#endif 49 { 50 public: 51 class ASH_EXPORT Delegate { 52 public: 53 virtual ~Delegate() {} 54 55 // Create or updates the non desktop window with |display_info|. 56 virtual void CreateOrUpdateNonDesktopDisplay( 57 const DisplayInfo& display_info) = 0; 58 59 // Closes the mirror window if exists. 60 virtual void CloseNonDesktopDisplay() = 0; 61 62 // Called before and after the display configuration changes. 63 // When |clear_focus| is true, the implementation should 64 // deactivate the active window and set the focus window to NULL. 65 virtual void PreDisplayConfigurationChange(bool clear_focus) = 0; 66 virtual void PostDisplayConfigurationChange() = 0; 67 }; 68 69 // How the second display will be used. 70 // 1) EXTENDED mode extends the desktop to the second dislpay. 71 // 2) MIRRORING mode copies the content of the primary display to 72 // the 2nd display. (Software Mirroring). 73 // 3) In VIRTUAL_KEYBOARD mode, the 2nd display is used as a 74 // dedicated display for virtual keyboard, and it is not 75 // recognized as a part of desktop. 76 enum SecondDisplayMode { 77 EXTENDED, 78 MIRRORING, 79 VIRTUAL_KEYBOARD 80 }; 81 82 // Returns the list of possible UI scales for the display. 83 static std::vector<float> GetScalesForDisplay(const DisplayInfo& info); 84 85 // Returns next valid UI scale. 86 static float GetNextUIScale(const DisplayInfo& info, bool up); 87 88 // Updates the bounds of the display given by |secondary_display_id| 89 // according to |layout|. 90 static void UpdateDisplayBoundsForLayoutById( 91 const DisplayLayout& layout, 92 const gfx::Display& primary_display, 93 int64 secondary_display_id); 94 95 DisplayManager(); 96 virtual ~DisplayManager(); 97 98 DisplayLayoutStore* layout_store() { 99 return layout_store_.get(); 100 } 101 102 gfx::Screen* screen() { 103 return screen_; 104 } 105 106 void set_delegate(Delegate* delegate) { delegate_ = delegate; } 107 108 // When set to true, the MonitorManager calls OnDisplayMetricsChanged 109 // even if the display's bounds didn't change. Used to swap primary 110 // display. 111 void set_force_bounds_changed(bool force_bounds_changed) { 112 force_bounds_changed_ = force_bounds_changed; 113 } 114 115 // Returns the display id of the first display in the outupt list. 116 int64 first_display_id() const { return first_display_id_; } 117 118 // Initializes displays using command line flag. Returns false 119 // if no command line flag was provided. 120 bool InitFromCommandLine(); 121 122 // Initialize default display. 123 void InitDefaultDisplay(); 124 125 // True if the given |display| is currently connected. 126 bool IsActiveDisplay(const gfx::Display& display) const; 127 128 // True if there is an internal display. 129 bool HasInternalDisplay() const; 130 131 bool IsInternalDisplayId(int64 id) const; 132 133 // Returns the display layout used for current displays. 134 DisplayLayout GetCurrentDisplayLayout(); 135 136 // Returns the current display pair. 137 DisplayIdPair GetCurrentDisplayIdPair() const; 138 139 // Sets the layout for the current display pair. The |layout| specifies 140 // the locaion of the secondary display relative to the primary. 141 void SetLayoutForCurrentDisplays( 142 const DisplayLayout& layout_relative_to_primary); 143 144 // Returns display for given |id|; 145 const gfx::Display& GetDisplayForId(int64 id) const; 146 147 // Finds the display that contains |point| in screeen coordinates. 148 // Returns invalid display if there is no display that can satisfy 149 // the condition. 150 const gfx::Display& FindDisplayContainingPoint( 151 const gfx::Point& point_in_screen) const; 152 153 // Sets the work area's |insets| to the display given by |display_id|. 154 bool UpdateWorkAreaOfDisplay(int64 display_id, const gfx::Insets& insets); 155 156 // Registers the overscan insets for the display of the specified ID. Note 157 // that the insets size should be specified in DIP size. It also triggers the 158 // display's bounds change. 159 void SetOverscanInsets(int64 display_id, const gfx::Insets& insets_in_dip); 160 161 // Sets the display's rotation. 162 void SetDisplayRotation(int64 display_id, gfx::Display::Rotation rotation); 163 164 // Sets the display's ui scale. 165 // TODO(mukai): remove this and merge into SetDisplayMode. 166 void SetDisplayUIScale(int64 display_id, float ui_scale); 167 168 // Sets the display's resolution. 169 // TODO(mukai): remove this and merge into SetDisplayMode. 170 void SetDisplayResolution(int64 display_id, const gfx::Size& resolution); 171 172 // Sets the external display's configuration, including resolution change, 173 // ui-scale change, and device scale factor change. Returns true if it changes 174 // the display resolution so that the caller needs to show a notification in 175 // case the new resolution actually doesn't work. 176 bool SetDisplayMode(int64 display_id, const DisplayMode& display_mode); 177 178 // Register per display properties. |overscan_insets| is NULL if 179 // the display has no custom overscan insets. 180 void RegisterDisplayProperty(int64 display_id, 181 gfx::Display::Rotation rotation, 182 float ui_scale, 183 const gfx::Insets* overscan_insets, 184 const gfx::Size& resolution_in_pixels, 185 float device_scale_factor, 186 ui::ColorCalibrationProfile color_profile); 187 188 // Returns the display mode of |display_id| which is currently used. 189 DisplayMode GetActiveModeForDisplayId(int64 display_id) const; 190 191 // Returns the display's selected mode. This returns false and doesn't 192 // set |mode_out| if the display mode is in default. 193 bool GetSelectedModeForDisplayId(int64 display_id, 194 DisplayMode* mode_out) const; 195 196 // Tells if the virtual resolution feature is enabled. 197 bool IsDisplayUIScalingEnabled() const; 198 199 // Returns the current overscan insets for the specified |display_id|. 200 // Returns an empty insets (0, 0, 0, 0) if no insets are specified for 201 // the display. 202 gfx::Insets GetOverscanInsets(int64 display_id) const; 203 204 // Sets the color calibration of the display to |profile|. 205 void SetColorCalibrationProfile(int64 display_id, 206 ui::ColorCalibrationProfile profile); 207 208 // Called when display configuration has changed. The new display 209 // configurations is passed as a vector of Display object, which 210 // contains each display's new infomration. 211 void OnNativeDisplaysChanged( 212 const std::vector<DisplayInfo>& display_info_list); 213 214 // Updates the internal display data and notifies observers about the changes. 215 void UpdateDisplays(const std::vector<DisplayInfo>& display_info_list); 216 217 // Updates current displays using current |display_info_|. 218 void UpdateDisplays(); 219 220 // Returns the display at |index|. The display at 0 is 221 // no longer considered "primary". 222 const gfx::Display& GetDisplayAt(size_t index) const; 223 224 const gfx::Display& GetPrimaryDisplayCandidate() const; 225 226 // Returns the logical number of displays. This returns 1 227 // when displays are mirrored. 228 size_t GetNumDisplays() const; 229 230 const std::vector<gfx::Display>& displays() const { return displays_; } 231 232 // Returns the number of connected displays. This returns 2 233 // when displays are mirrored. 234 size_t num_connected_displays() const { return num_connected_displays_; } 235 236 // Returns the mirroring status. 237 bool IsMirrored() const; 238 int64 mirrored_display_id() const { return mirrored_display_id_; } 239 240 // Returns the display object that is not a part of desktop. 241 const gfx::Display& non_desktop_display() const { 242 return non_desktop_display_; 243 } 244 245 // Retuns the display info associated with |display_id|. 246 const DisplayInfo& GetDisplayInfo(int64 display_id) const; 247 248 // Returns the human-readable name for the display |id|. 249 std::string GetDisplayNameForId(int64 id); 250 251 // Returns the display id that is capable of UI scaling. On device, 252 // this returns internal display's ID if its device scale factor is 2, 253 // or invalid ID if such internal display doesn't exist. On linux 254 // desktop, this returns the first display ID. 255 int64 GetDisplayIdForUIScaling() const; 256 257 // Change the mirror mode. 258 void SetMirrorMode(bool mirrored); 259 260 // Used to emulate display change when run in a desktop environment instead 261 // of on a device. 262 void AddRemoveDisplay(); 263 void ToggleDisplayScaleFactor(); 264 265 // SoftwareMirroringController override: 266#if defined(OS_CHROMEOS) 267 virtual void SetSoftwareMirroring(bool enabled) OVERRIDE; 268 virtual bool SoftwareMirroringEnabled() const OVERRIDE; 269#endif 270 bool software_mirroring_enabled() const { 271 return second_display_mode_ == MIRRORING; 272 }; 273 274 bool virtual_keyboard_root_window_enabled() const { 275 return second_display_mode_ == VIRTUAL_KEYBOARD; 276 }; 277 278 // Sets/gets second display mode. 279 void SetSecondDisplayMode(SecondDisplayMode mode); 280 SecondDisplayMode second_display_mode() const { 281 return second_display_mode_; 282 } 283 284 // Update the bounds of the display given by |display_id|. 285 bool UpdateDisplayBounds(int64 display_id, 286 const gfx::Rect& new_bounds); 287 288 // Creates mirror window if the software mirror mode is enabled. 289 // This is used only for bootstrap. 290 void CreateMirrorWindowIfAny(); 291 292 // Create a screen instance to be used during shutdown. 293 void CreateScreenForShutdown() const; 294 295private: 296 FRIEND_TEST_ALL_PREFIXES(ExtendedDesktopTest, ConvertPoint); 297 FRIEND_TEST_ALL_PREFIXES(DisplayManagerTest, TestNativeDisplaysChanged); 298 FRIEND_TEST_ALL_PREFIXES(DisplayManagerTest, 299 NativeDisplaysChangedAfterPrimaryChange); 300 FRIEND_TEST_ALL_PREFIXES(DisplayManagerTest, AutomaticOverscanInsets); 301 friend class ash::AcceleratorControllerTest; 302 friend class test::DisplayManagerTestApi; 303 friend class test::SystemGestureEventFilterTest; 304 friend class DisplayManagerTest; 305 306 typedef std::vector<gfx::Display> DisplayList; 307 308 void set_change_display_upon_host_resize(bool value) { 309 change_display_upon_host_resize_ = value; 310 } 311 312 gfx::Display* FindDisplayForId(int64 id); 313 314 // Add the mirror display's display info if the software based 315 // mirroring is in use. 316 void AddMirrorDisplayInfoIfAny(std::vector<DisplayInfo>* display_info_list); 317 318 // Inserts and update the DisplayInfo according to the overscan 319 // state. Note that The DisplayInfo stored in the |internal_display_info_| 320 // can be different from |new_info| (due to overscan state), so 321 // you must use |GetDisplayInfo| to get the correct DisplayInfo for 322 // a display. 323 void InsertAndUpdateDisplayInfo(const DisplayInfo& new_info); 324 325 // Called when the display info is updated through InsertAndUpdateDisplayInfo. 326 void OnDisplayInfoUpdated(const DisplayInfo& display_info); 327 328 // Creates a display object from the DisplayInfo for |display_id|. 329 gfx::Display CreateDisplayFromDisplayInfoById(int64 display_id); 330 331 // Updates the bounds of the secondary display in |display_list| 332 // using the layout registered for the display pair and set the 333 // index of display updated to |updated_index|. Returns true 334 // if the secondary display's bounds has been changed from current 335 // value, or false otherwise. 336 bool UpdateSecondaryDisplayBoundsForLayout(DisplayList* display_list, 337 size_t* updated_index) const; 338 339 static void UpdateDisplayBoundsForLayout( 340 const DisplayLayout& layout, 341 const gfx::Display& primary_display, 342 gfx::Display* secondary_display); 343 344 Delegate* delegate_; // not owned. 345 346 scoped_ptr<ScreenAsh> screen_ash_; 347 // This is to have an accessor without ScreenAsh definition. 348 gfx::Screen* screen_; 349 350 scoped_ptr<DisplayLayoutStore> layout_store_; 351 352 int64 first_display_id_; 353 354 // List of current active displays. 355 DisplayList displays_; 356 357 int num_connected_displays_; 358 359 bool force_bounds_changed_; 360 361 // The mapping from the display ID to its internal data. 362 std::map<int64, DisplayInfo> display_info_; 363 364 // Selected display modes for displays. Key is the displays' ID. 365 std::map<int64, DisplayMode> display_modes_; 366 367 // When set to true, the host window's resize event updates 368 // the display's size. This is set to true when running on 369 // desktop environment (for debugging) so that resizing the host 370 // window will update the display properly. This is set to false 371 // on device as well as during the unit tests. 372 bool change_display_upon_host_resize_; 373 374 SecondDisplayMode second_display_mode_; 375 int64 mirrored_display_id_; 376 gfx::Display non_desktop_display_; 377 378 DISALLOW_COPY_AND_ASSIGN(DisplayManager); 379}; 380 381} // namespace ash 382 383#endif // ASH_DISPLAY_DISPLAY_MANAGER_H_ 384