Overlay interface for ozone.

ui/gfx/ozone/surface_factory_ozone.h

 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef UI_GFX_OZONE_SURFACE_LNUX_FACTORY_OZONE_H_
 #define UI_GFX_OZONE_SURFACE_LNUX_FACTORY_OZONE_H_
 
 #include "base/callback.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/native_library.h"
 #include "ui/gfx/geometry/point.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/gfx_export.h"
 #include "ui/gfx/native_widget_types.h"
+#include "ui/gfx/rect.h"
 
 class SkBitmap;
 class SkCanvas;
 
 namespace gfx {
 class VSyncProvider;
+class OverlayHALOzone;
 
 // The Ozone interface allows external implementations to hook into Chromium to
 // provide a system specific implementation. The Ozone interface supports two
 // drawing modes: 1) accelerated drawing through EGL and 2) software drawing
 // through Skia.
 //
 // The following functionality is specific to the drawing mode and may not have
 // any meaningful implementation in the other mode. An implementation must
 // provide functionality for at least one mode.
 //
@@ skipping 17 matching lines @@
 // modes (See comments bellow for descriptions).
 class GFX_EXPORT SurfaceFactoryOzone {
  public:
   // Describes the state of the hardware after initialization.
   enum HardwareState {
     UNINITIALIZED,
     INITIALIZED,
     FAILED,
   };
 
+  // Describes overlay buffer format.
+  enum BufferFormat {

[rjkroege, 2014/02/27 23:18:19]

I would imagine that we would add more here.

Is there an existing Chrome construct that encapsulates this? Like
SkBitmap::Config?

In a software compositing case with overlays, each overlay is a SkBitmap so this
is perhaps not so silly?

[alexst (slow to review), 2014/02/28 18:59:34]

We may have some new formats like multiplane YUV that are not yet defined
elsewhere, so I'd like to keep this here.

+    UNKNOWN,
+    RGBA,
+    RGB,
+  };
+
+  // Describes transformation to be applied to the buffer before presenting

[rjkroege, 2014/02/27 23:18:19]

do we anticipate that there will be more complex transformations?

[alexst (slow to review), 2014/02/28 18:59:34]

Possibly, but let's walk before we run. This exposes things in a way similar to
HWC, so for now it's a good approximation.

+  // to screen.
+  enum OverlayTransform {
+    NONE,
+    FLIP_HORIZONTAL,
+    FLIP_VERTICAL,
+    ROTATE_90,
+    ROTATE_180,
+    ROTATE_270,
+  };
+
   typedef void*(*GLGetProcAddressProc)(const char* name);
   typedef base::Callback<void(base::NativeLibrary)> AddGLLibraryCallback;
   typedef base::Callback<void(GLGetProcAddressProc)>
       SetGLGetProcAddressProcCallback;
 
   SurfaceFactoryOzone();
   virtual ~SurfaceFactoryOzone();
 
   // Returns the instance
   static SurfaceFactoryOzone* GetInstance();
@@ skipping 61 matching lines @@
   // terminated with EGL_NONE. Ownership of the array is not transferred to
   // caller. desired_list contains list of desired EGL properties and values.
   virtual const int32* GetEGLSurfaceProperties(const int32* desired_list);
 
   // Sets the cursor image to |image|.
   virtual void SetCursorImage(const SkBitmap& image);
 
   // Sets the cursor position to |location|.
   virtual void MoveCursorTo(const gfx::Point& location);
 
+  // Get the hal struct to check for overlay support.
+  virtual gfx::OverlayHALOzone* GetOverlayHAL();
+
+  // Sets the overlay plane to switch to at the next page flip.

[rjkroege, 2014/02/27 23:18:19]

the comment needs to specify what the args are for. in particular, is the
AcceleratedWidget realized or not? (and which processes are allowed to call the
entry points.)

[alexst (slow to review), 2014/02/28 18:59:34]

Done.

+  virtual void SetOverlayPlane(int plane_id,
+                               OverlayTransform plane_transform,
+                               gfx::AcceleratedWidget handle,
+                               const gfx::Rect& bounds);
+
+  // Cleate a single native buffer to be used for overlay planes.
+  virtual gfx::AcceleratedWidget CreateNativeBuffer(gfx::Size size,

[rjkroege, 2014/02/27 23:18:19]

The properties of bing an overlay plan end up being part of the
AcceleratedWidget yes? Maybe we should change that.

[alexst (slow to review), 2014/02/28 18:59:34]

Done.

+                                                    BufferFormat format);
+
  private:
   static SurfaceFactoryOzone* impl_; // not owned
 };
 
 }  // namespace gfx
 
 #endif  // UI_GFX_OZONE_SURFACE_LNUX_FACTORY_OZONE_H_