Position overlays in AVDACodecImage

media/gpu/avda_picture_buffer_manager.h

 // Copyright 2015 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 MEDIA_GPU_AVDA_PICTURE_BUFFER_MANAGER_H_
 #define MEDIA_GPU_AVDA_PICTURE_BUFFER_MANAGER_H_
 
 #include <stdint.h>
 #include <vector>
 
 #include "base/macros.h"
 #include "media/gpu/avda_state_provider.h"
+#include "media/gpu/avda_surface_bundle.h"
 #include "media/gpu/media_gpu_export.h"
 #include "media/gpu/surface_texture_gl_owner.h"
 
 namespace gpu {
 namespace gles2 {
 class GLStreamTextureImage;
 }
 }
 
-namespace gl {
-class ScopedJavaSurface;
-class SurfaceTexture;
-}
-
 namespace media {
 class AVDACodecImage;
 class AVDASharedState;
 class MediaCodecBridge;
 
 // AVDAPictureBufferManager is used by AVDA to associate its PictureBuffers with
 // MediaCodec output buffers. It attaches AVDACodecImages to the PictureBuffer
 // textures so that when they're used to draw the AVDACodecImage can release the
 // MediaCodec buffer to the backing Surface. If the Surface is a SurfaceTexture,
 // the front buffer can then be used to draw without needing to copy the pixels.
 // If the Surface is a SurfaceView, the release causes the frame to be displayed
 // immediately.
 class MEDIA_GPU_EXPORT AVDAPictureBufferManager {
  public:
   using PictureBufferMap = std::map<int32_t, PictureBuffer>;
 
   explicit AVDAPictureBufferManager(AVDAStateProvider* state_provider);
   virtual ~AVDAPictureBufferManager();
 
-  // Call either InitializeForOverlay or InitializeForSurfaceTexture before
-  // anything else.  InitializeForOverlay will set us up to render codec buffers
-  // at the approrpriate time for display, but will assume that consuming the
-  // resulting buffers is handled elsewhere (e.g., SurfaceFlinger).
+  // Call Initialize, providing the surface bundle that holds the surface that
+  // will back the frames.  If an overlay is present in the bundle, then this
+  // will set us up to render codec buffers at the appropriate time for display,
+  // but will assume that consuming the resulting buffers is handled elsewhere
+  // (e.g., SurfaceFlinger).  We will ensure that any reference to the bundle
+  // is dropped if the overlay sends OnSurfaceDestroyed.
   //
-  // InitializeForSurfaceTexture will create a SurfaceTexture and return the
-  // surface for it.  We will arrange to consume the buffers at the right time,
-  // in addition to releasing codec buffers for rendering.
+  // Without an overlay, we will create a SurfaceTexture and add it (and its
+  // surface) to |surface_bundle|.  We will arrange to consume the buffers at
+  // the right time, in addition to releasing the codec buffers for rendering.
   //
   // One may call these multiple times to change between overlay and ST.
   //
   // Picture buffers will be updated to reflect the new surface during the call
   // to UseCodecBufferForPicture().
-  void InitializeForOverlay();
-  gl::ScopedJavaSurface InitializeForSurfaceTexture();
+  //
+  // Returns true on success, false otherwise.

[watk, 2017/05/17 19:45:14]

nit: Reminds me of this from the styleguide :P

However, do not be unnecessarily verbose or state the completely obvious. Notice
below that it is not necessary to say "returns false otherwise" because this is
implied.

// Returns true if the table cannot hold any more entries.
bool IsTableFull();

[liberato (no reviews please), 2017/05/17 20:19:32]

done, though i'm not sure that i agree with the style guide's use of the word
"implied".

+  bool Initialize(scoped_refptr<AVDASurfaceBundle> surface_bundle);
 
   void Destroy(const PictureBufferMap& buffers);
 
   // Sets up |picture_buffer| so that its texture will refer to the image that
   // is represented by the decoded output buffer at codec_buffer_index.
   void UseCodecBufferForPictureBuffer(int32_t codec_buffer_index,
                                       const PictureBuffer& picture_buffer);
 
   // Assigns a picture buffer and attaches an image to its texture.
   void AssignOnePictureBuffer(const PictureBuffer& picture_buffer,
@@ skipping 12 matching lines @@
   // MediaCodec is being destroyed. Previously provided codecs should no longer
   // be referenced.
   void CodecChanged(MediaCodecBridge* codec);
 
   // Whether the pictures buffers are overlayable.
   bool ArePicturesOverlayable();
 
   // Are there any unrendered picture buffers oustanding?
   bool HasUnrenderedPictures() const;
 
-  scoped_refptr<gl::SurfaceTexture> surface_texture() {
-    return surface_texture_;
-  }
-
   // Returns the GL texture target that the PictureBuffer textures use.
   // Always use OES textures even though this will cause flickering in dev tools
   // when inspecting a fullscreen video.  See http://crbug.com/592798
   static constexpr GLenum kTextureTarget = GL_TEXTURE_EXTERNAL_OES;
 
  private:
   // Release any codec buffer that is associated with the given picture buffer
   // back to the codec.  It is okay if there is no such buffer.
   void ReleaseCodecBufferForPicture(const PictureBuffer& picture_buffer);
 
@@ skipping 21 matching lines @@
 
   // Maps a picture buffer id to a AVDACodecImage.
   std::map<int, scoped_refptr<AVDACodecImage>> codec_images_;
 
   DISALLOW_COPY_AND_ASSIGN(AVDAPictureBufferManager);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_GPU_AVDA_PICTURE_BUFFER_MANAGER_H_