ui/gl/android/surface_texture.h

   1 // Copyright 2013 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 UI_GL_ANDROID_SURFACE_TEXTURE_H_
   6 #define UI_GL_ANDROID_SURFACE_TEXTURE_H_
   7
   8 #include <jni.h>
   9
  10 #include "base/android/scoped_java_ref.h"
  11 #include "base/callback.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "ui/gl/gl_export.h"
  14
  15 struct ANativeWindow;
  16
  17 namespace gfx {
  18
  19 // This class serves as a bridge for native code to call java functions inside
  20 // android SurfaceTexture class.
  21 class GL_EXPORT SurfaceTexture
  22     : public base::RefCountedThreadSafe<SurfaceTexture>{
  23  public:
  24   static scoped_refptr<SurfaceTexture> Create(int texture_id);
  25
  26   static scoped_refptr<SurfaceTexture> CreateSingleBuffered(int texture_id);
  27
  28   // Set the listener callback, which will be invoked on the same thread that
  29   // is being called from here for registration.
  30   // Note: Since callbacks come in from Java objects that might outlive objects
  31   // being referenced from the callback, the only robust way here is to create
  32   // the callback from a weak pointer to your object.
  33   void SetFrameAvailableCallback(const base::Closure& callback);
  34
  35   // Update the texture image to the most recent frame from the image stream.
  36   void UpdateTexImage();
  37
  38   // Release the texture content. This is needed only in single buffered mode
  39   // to allow the image content producer to take ownership
  40   // of the image buffer.
  41   // This is *only* supported on SurfaceTexture instantiated via
  42   // |CreateSingleBuffered(...)|.
  43   void ReleaseTexImage();
  44
  45   // Retrieve the 4x4 texture coordinate transform matrix associated with the
  46   // texture image set by the most recent call to updateTexImage.
  47   void GetTransformMatrix(float mtx[16]);
  48
  49   // Attach the SurfaceTexture to the texture currently bound to
  50   // GL_TEXTURE_EXTERNAL_OES.
  51   void AttachToGLContext();
  52
  53   // Detaches the SurfaceTexture from the context that owns its current GL
  54   // texture. Must be called with that context current on the calling thread.
  55   void DetachFromGLContext();
  56
  57   // Creates a native render surface for this surface texture.
  58   // The caller must release the underlying reference when done with the handle
  59   // by calling ANativeWindow_release().
  60   ANativeWindow* CreateSurface();
  61
  62   const base::android::JavaRef<jobject>& j_surface_texture() const {
  63     return j_surface_texture_;
  64   }
  65
  66   // This should only be used to guard the SurfaceTexture instantiated via
  67   // |CreateSingleBuffered(...)|
  68   static bool IsSingleBufferModeSupported();
  69
  70   static bool RegisterSurfaceTexture(JNIEnv* env);
  71
  72  protected:
  73   explicit SurfaceTexture(
  74       const base::android::ScopedJavaLocalRef<jobject>& j_surface_texture);
  75
  76  private:
  77   friend class base::RefCountedThreadSafe<SurfaceTexture>;
  78   ~SurfaceTexture();
  79
  80   // Java SurfaceTexture instance.
  81   base::android::ScopedJavaGlobalRef<jobject> j_surface_texture_;
  82
  83   DISALLOW_COPY_AND_ASSIGN(SurfaceTexture);
  84 };
  85
  86 }  // namespace gfx
  87
  88 #endif  // UI_GL_ANDROID_SURFACE_TEXTURE_H_