ozone: Move the factory interfaces into a common target.

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/overlay_transform.h"
-#include "ui/gfx/rect.h"
-
-class SkBitmap;
-class SkCanvas;
-
-namespace gfx {
-class VSyncProvider;
-class OverlayCandidatesOzone;
-class SurfaceOzoneCanvas;
-class SurfaceOzoneEGL;
-typedef intptr_t NativeBufferOzone;
-
-// 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.
-//
-// If you want to paint on a window with ozone, you need to create a
-// SurfaceOzoneEGL or SurfaceOzoneCanvas for that window. The platform can
-// support software, EGL, or both for painting on the window.
-// 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.
-//
-// 1) Accelerated Drawing (EGL path):
-//
-// The following functions are specific to EGL:
-//  - GetNativeDisplay
-//  - LoadEGLGLES2Bindings
-//  - GetEGLSurfaceProperties (optional if the properties match the default
-//  Chromium ones).
-//  - CreateEGLSurfaceForWidget
-//
-// 2) Software Drawing (Skia):
-//
-// The following function is specific to the software path:
-//  - CreateCanvasForWidget
-//
-// The accelerated path can optionally provide support for the software drawing
-// path.
-//
-// The remaining functions are not covered since they are needed in both drawing
-// 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.
-  // TODO: this is a placeholder for now and will be populated with more
-  // formats once we know what sorts of content, video, etc. we can support.
-  enum BufferFormat {
-    UNKNOWN,
-    RGBA_8888,
-    RGB_888,
-  };
-
-  typedef void*(*GLGetProcAddressProc)(const char* name);
-  typedef base::Callback<void(base::NativeLibrary)> AddGLLibraryCallback;
-  typedef base::Callback<void(GLGetProcAddressProc)>
-      SetGLGetProcAddressProcCallback;
-
-  SurfaceFactoryOzone();
-  virtual ~SurfaceFactoryOzone();
-
-  // Returns the singleton instance.
-  static SurfaceFactoryOzone* GetInstance();
-
-  // Configures the display hardware. Must be called from within the GPU
-  // process before the sandbox has been activated.
-  virtual HardwareState InitializeHardware() = 0;
-
-  // Cleans up display hardware state. Call this from within the GPU process.
-  // This method must be safe to run inside of the sandbox.
-  virtual void ShutdownHardware() = 0;
-
-  // Returns native platform display handle. This is used to obtain the EGL
-  // display connection for the native display.
-  virtual intptr_t GetNativeDisplay();
-
-  // Obtains an AcceleratedWidget backed by a native Linux framebuffer.
-  // The  returned AcceleratedWidget is an opaque token that must realized
-  // before it can be used to create a GL surface.
-  virtual gfx::AcceleratedWidget GetAcceleratedWidget() = 0;
-
-  // Create SurfaceOzoneEGL for the specified gfx::AcceleratedWidget.
-  //
-  // Note: When used from content, this is called in the GPU process. The
-  // platform must support creation of SurfaceOzoneEGL from the GPU process
-  // using only the handle contained in gfx::AcceleratedWidget.
-  virtual scoped_ptr<SurfaceOzoneEGL> CreateEGLSurfaceForWidget(
-        gfx::AcceleratedWidget widget);
-
-  // Create SurfaceOzoneCanvas for the specified gfx::AcceleratedWidget.
-  //
-  // Note: The platform must support creation of SurfaceOzoneCanvas from the
-  // Browser Process using only the handle contained in gfx::AcceleratedWidget.
-  virtual scoped_ptr<SurfaceOzoneCanvas> CreateCanvasForWidget(
-        gfx::AcceleratedWidget widget);
-
-  // Sets up GL bindings for the native surface. Takes two callback parameters
-  // that allow Ozone to register the GL bindings.
-  virtual bool LoadEGLGLES2Bindings(
-      AddGLLibraryCallback add_gl_library,
-      SetGLGetProcAddressProcCallback set_gl_get_proc_address) = 0;
-
-  // Returns an array of EGL properties, which can be used in any EGL function
-  // used to select a display configuration. Note that all properties should be
-  // immediately followed by the corresponding desired value and array should be
-  // 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);
-
-  // Get the hal struct to check for overlay support.
-  virtual gfx::OverlayCandidatesOzone* GetOverlayCandidates(
-      gfx::AcceleratedWidget w);
-
-  // Sets the overlay plane to switch to at the next page flip.
-  // |plane_z_order| specifies the stacking order of the plane relative to the
-  // main framebuffer located at index 0.
-  // |plane_transform| specifies how the buffer is to be transformed during.
-  // composition.
-  // |buffer| to be presented by the overlay.
-  // |display_bounds| specify where it is supposed to be on the screen.
-  // |crop_rect| specifies the region within the buffer to be placed inside
-  // |display_bounds|.
-  virtual void ScheduleOverlayPlane(gfx::AcceleratedWidget w,
-                                    int plane_z_order,
-                                    gfx::OverlayTransform plane_transform,
-                                    gfx::NativeBufferOzone buffer,
-                                    const gfx::Rect& display_bounds,
-                                    gfx::RectF crop_rect);
-
-  // Cleate a single native buffer to be used for overlay planes.
-  virtual gfx::NativeBufferOzone CreateNativeBuffer(gfx::Size size,
-                                                    BufferFormat format);
-
- private:
-  static SurfaceFactoryOzone* impl_; // not owned
-};
-
-}  // namespace gfx
-
-#endif  // UI_GFX_OZONE_SURFACE_LNUX_FACTORY_OZONE_H_