media: Enabling direct rendering for VP9

media/filters/vpx_video_decoder.cc

 // Copyright (c) 2012 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.
 
 #include "media/filters/vpx_video_decoder.h"
 
 #include <algorithm>
 #include <string>
+#include <vector>
 
 #include "base/bind.h"
 #include "base/callback_helpers.h"
 #include "base/command_line.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/single_thread_task_runner.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/sys_byteorder.h"
 #include "media/base/bind_to_current_loop.h"
 #include "media/base/decoder_buffer.h"
 #include "media/base/demuxer_stream.h"
+#include "media/base/limits.h"
 #include "media/base/media_switches.h"
 #include "media/base/pipeline.h"
 #include "media/base/video_decoder_config.h"
 #include "media/base/video_frame.h"
 #include "media/base/video_util.h"
 
 // Include libvpx header files.
 // VPX_CODEC_DISABLE_COMPAT excludes parts of the libvpx API that provide
 // backwards compatibility for legacy applications using the library.
 #define VPX_CODEC_DISABLE_COMPAT 1
 extern "C" {
 #include "third_party/libvpx/source/libvpx/vpx/vpx_decoder.h"
+#include "third_party/libvpx/source/libvpx/vpx/vpx_external_frame_buffer.h"
 #include "third_party/libvpx/source/libvpx/vpx/vp8dx.h"
 }
 
 namespace media {
 
 // Always try to use three threads for video decoding.  There is little reason
 // not to since current day CPUs tend to be multi-core and we measured
 // performance benefits on older machines such as P4s with hyperthreading.
 static const int kDecodeThreads = 2;
 static const int kMaxDecodeThreads = 16;
@@ skipping 17 matching lines @@
     }
 
     return decode_threads;
   }
 
   decode_threads = std::max(decode_threads, 0);
   decode_threads = std::min(decode_threads, kMaxDecodeThreads);
   return decode_threads;
 }
 
+// Maximum number of frame buffers that can be used (by both chromium and libvpx
+// combined) for VP9 Decoding.
+// TODO(vigneshv): Investigate if this can be relaxed to a higher number.
+static const int kVP9MaxFrameBuffers = VP9_MAXIMUM_REF_BUFFERS +
+                                       VPX_MAXIMUM_WORK_BUFFERS +
+                                       limits::kMaxVideoFrames;
+
+// Reference counted frame buffers used for VP9 decoding. Reference counting is
+// done manually because both chromium and libvpx has to release this before a
+// buffer can be re-used.
+struct VP9FrameBuffer {

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: Make this decl private inside the MemoryPool since nothing outside the pool
really needs to be aware of it.

[vignesh, 2014/02/04 01:38:10]

Done.

+  uint8* data;
+  uint64 size;
+  uint32 ref_cnt;
+};
+
+class VpxVideoDecoder::MemoryPool
+    : public base::RefCountedThreadSafe<VpxVideoDecoder::MemoryPool> {
+ public:
+  MemoryPool(VpxVideoDecoder* decoder);
+
+  // Callback that will be called by libvpx when it needs a frame buffer.
+  // Parameters:
+  // |user_priv|  Private data passed to libvpx (pointer to memory pool).
+  // |min_size|   Minimum size needed by libvpx to decompress the next frame.
+  // |fb|         Pointer to the frame buffer to update.
+  // Returns 0 on success. Returns < 0 on failure.
+  static int32 GetVP9FrameBuffer(void* user_priv, size_t min_size,
+                                 vpx_codec_frame_buffer* fb);
+
+  // Callback that will be called by libvpx when the frame buffer is no more

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: s/more/longer/

[vignesh, 2014/02/04 01:38:10]

Done.

+  // being used by libvpx. Parameters:
+  // |user_priv|  Private data passed to libvpx (pointer to memory pool).
+  // |fb|         Pointer to the frame buffer that's being released.
+  static int32 ReleaseVP9FrameBuffer(void *user_priv,
+                                     vpx_codec_frame_buffer *fb);
+
+  // Generates a "no_longer_needed" closure that holds a reference
+  // to this pool.
+  base::Closure frame_callback(VP9FrameBuffer* frame_buffer);
+
+  // Sets |decoder_| to NULL.
+  void ClearDecoder();
+
+ private:
+  friend class base::RefCountedThreadSafe<VpxVideoDecoder::MemoryPool>;
+  ~MemoryPool();
+
+  // Method that gets called when a VideoFrame that references this pool gets
+  // destroyed.
+  void OnVideoFrameDestroyed(VP9FrameBuffer* frame_buffer);
+
+  // Pointer to the VpxVideoDecoder object that has this object.
+  VpxVideoDecoder* decoder_;
+
+  // Frame buffers to be used by libvpx for VP9 Decoding.
+  std::vector<VP9FrameBuffer*> frame_buffers_;
+
+  DISALLOW_COPY_AND_ASSIGN(MemoryPool);
+};
+
+VpxVideoDecoder::MemoryPool::MemoryPool(VpxVideoDecoder* decoder)
+    : decoder_(decoder) {
+}
+
+VpxVideoDecoder::MemoryPool::~MemoryPool() {
+  for (size_t i = 0; i < frame_buffers_.size(); ++i) {
+    delete[] frame_buffers_[i]->data;
+    delete frame_buffers_[i];
+  }
+}
+
+int32 VpxVideoDecoder::MemoryPool::GetVP9FrameBuffer(
+    void* user_priv, size_t min_size, vpx_codec_frame_buffer* fb) {
+  if (user_priv == NULL || fb == NULL)

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: These look like they should be DCHECKs since I think it's likely a bug in
libvpx if these are NULL.

[vignesh, 2014/02/04 01:38:10]

Done.

+    return -1;
+
+  VpxVideoDecoder::MemoryPool* memory_pool =
+      static_cast<VpxVideoDecoder::MemoryPool*>(user_priv);
+

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

Put the rest of this method in a private method and just call that method here
so you can get rid of all the memory_pool references.

[vignesh, 2014/02/04 01:38:10]

Done.

+  // Check if a free frame buffer exists.
+  int i = 0;
+  for (i = 0; i < memory_pool->frame_buffers_.size(); ++i) {

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: s/i = 0// since you initialize it on the line above.

[vignesh, 2014/02/04 01:38:10]

Done.

+    if (memory_pool->frame_buffers_[i]->ref_cnt == 0)
+      break;
+  }
+
+  if (i == memory_pool->frame_buffers_.size()) {
+    // Maximum number of frame buffers reached.
+    if (i == kVP9MaxFrameBuffers)
+      return -1;
+
+    // Create a new frame buffer.
+    memory_pool->frame_buffers_.push_back(new VP9FrameBuffer());
+  }
+
+  // Reallocate the frame buffer if necessary.
+  if (memory_pool->frame_buffers_[i]->size < min_size) {
+    delete[] memory_pool->frame_buffers_[i]->data;

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

Just use std::vector<uint8> for data so you can replace this and the 4 lines
below with frame_buffers_[i]->resize(min_size).

[vignesh, 2014/02/04 01:38:10]

Done.

+    memory_pool->frame_buffers_[i]->data = new uint8[min_size];
+    if (!memory_pool->frame_buffers_[i]->data)
+      return -1;
+    memory_pool->frame_buffers_[i]->size = min_size;
+  }
+
+  fb->data = memory_pool->frame_buffers_[i]->data;
+  fb->size = memory_pool->frame_buffers_[i]->size;
+  ++memory_pool->frame_buffers_[i]->ref_cnt;
+
+  // Set the frame buffer's private data to point at the external frame buffer.
+  fb->frame_priv = static_cast<void*>(memory_pool->frame_buffers_[i]);
+  return 0;
+}
+
+int32 VpxVideoDecoder::MemoryPool::ReleaseVP9FrameBuffer(
+    void *user_priv, vpx_codec_frame_buffer *fb) {
+  VP9FrameBuffer* frame_buffer = static_cast<VP9FrameBuffer*>(fb->frame_priv);
+  --frame_buffer->ref_cnt;

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

Is this method and GetVP9FrameBuffer() ALWAYS called on the same thread as
vpx_codec_decode()? If not, then this isn't thread-safe.

[vignesh, 2014/02/04 01:38:10]

yes, both the methods are always called on the same thread as vpx_codec_decode.

+  return 0;
+}
+
+base::Closure VpxVideoDecoder::MemoryPool::frame_callback(

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: This isn't a trivial accessor so it should have a CamelCase name like
CreateFrameCallback().

[vignesh, 2014/02/04 01:38:10]

Done.

+    VP9FrameBuffer* frame_buffer) {
+  ++frame_buffer->ref_cnt;
+  return BindToCurrentLoop(
+             base::Bind(&MemoryPool::OnVideoFrameDestroyed, this,
+                        frame_buffer));
+}
+
+void VpxVideoDecoder::MemoryPool::OnVideoFrameDestroyed(
+    VP9FrameBuffer* frame_buffer) {
+  --frame_buffer->ref_cnt;
+}
+
+void VpxVideoDecoder::MemoryPool::ClearDecoder() {
+  decoder_ = NULL;
+}
+
 VpxVideoDecoder::VpxVideoDecoder(
     const scoped_refptr<base::SingleThreadTaskRunner>& task_runner)
     : task_runner_(task_runner),
       weak_factory_(this),
       state_(kUninitialized),
       vpx_codec_(NULL),
-      vpx_codec_alpha_(NULL) {
+      vpx_codec_alpha_(NULL),
+      memory_pool_(NULL) {

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: You don't need this for a scoped_refptr. It is already initialized to null.

[vignesh, 2014/02/04 01:38:10]

Done.

 }
 
 VpxVideoDecoder::~VpxVideoDecoder() {
   DCHECK_EQ(kUninitialized, state_);
   CloseDecoder();
 }
 
 void VpxVideoDecoder::Initialize(const VideoDecoderConfig& config,
                                  const PipelineStatusCB& status_cb) {
   DCHECK(task_runner_->BelongsToCurrentThread());
@@ skipping 48 matching lines @@
   }
   if (!can_handle)
     return false;
 
   CloseDecoder();
 
   vpx_codec_ = InitializeVpxContext(vpx_codec_, config);
   if (!vpx_codec_)
     return false;
 
+  // We use our own buffers for VP9 so that there is no need to copy data after
+  // decoding.
+  if (config.codec() == kCodecVP9) {
+    memory_pool_ = new MemoryPool(this);
+    if (vpx_codec_set_external_frame_buffer_functions(
+            vpx_codec_,
+            &MemoryPool::GetVP9FrameBuffer,
+            &MemoryPool::ReleaseVP9FrameBuffer,
+            memory_pool_)) {
+      LOG(ERROR) << "Failed to configure external buffers.";
+      return false;
+    }
+  }
+
   if (config.format() == VideoFrame::YV12A) {
     vpx_codec_alpha_ = InitializeVpxContext(vpx_codec_alpha_, config);
     if (!vpx_codec_alpha_)
       return false;
   }
 
   return true;
 }
 
 void VpxVideoDecoder::CloseDecoder() {
   if (vpx_codec_) {
     vpx_codec_destroy(vpx_codec_);
     delete vpx_codec_;
     vpx_codec_ = NULL;
+    if (memory_pool_) {
+      memory_pool_->ClearDecoder();
+      memory_pool_ = NULL;
+    }
   }
   if (vpx_codec_alpha_) {
     vpx_codec_destroy(vpx_codec_alpha_);
     delete vpx_codec_alpha_;
     vpx_codec_alpha_ = NULL;
   }
 }
 
 void VpxVideoDecoder::Decode(const scoped_refptr<DecoderBuffer>& buffer,
                              const DecodeCB& decode_cb) {
@@ skipping 166 matching lines @@
 
 void VpxVideoDecoder::CopyVpxImageTo(const vpx_image* vpx_image,
                                      const struct vpx_image* vpx_image_alpha,
                                      scoped_refptr<VideoFrame>* video_frame) {
   CHECK(vpx_image);
   CHECK(vpx_image->fmt == VPX_IMG_FMT_I420 ||
         vpx_image->fmt == VPX_IMG_FMT_YV12);
 
   gfx::Size size(vpx_image->d_w, vpx_image->d_h);
 
+  if (!vpx_codec_alpha_ && memory_pool_) {
+    *video_frame = VideoFrame::WrapExternalYuvData(
+                       VideoFrame::YV12,
+                       size, gfx::Rect(size), config_.natural_size(),
+                       vpx_image->stride[VPX_PLANE_Y],
+                       vpx_image->stride[VPX_PLANE_U],
+                       vpx_image->stride[VPX_PLANE_V],
+                       vpx_image->planes[VPX_PLANE_Y],
+                       vpx_image->planes[VPX_PLANE_U],
+                       vpx_image->planes[VPX_PLANE_V],
+                       kNoTimestamp(),
+                       memory_pool_->frame_callback(

[acolwell GONE FROM CHROMIUM, 2014/02/04 00:48:35]

nit: Change the signature of this method so you don't need the cast here. It's a
little cleaner to have the cast inside the method since the MemoryPool is really
the one that "knows" this is a VP9FrameBuffer*.

[vignesh, 2014/02/04 01:38:10]

Done.

+                           static_cast<VP9FrameBuffer*>(
+                               vpx_image->ext_fb_priv)));
+    return;
+  }
+
   *video_frame = frame_pool_.CreateFrame(
       vpx_codec_alpha_ ? VideoFrame::YV12A : VideoFrame::YV12,
       size,
       gfx::Rect(size),
       config_.natural_size(),
       kNoTimestamp());
 
   CopyYPlane(vpx_image->planes[VPX_PLANE_Y],
              vpx_image->stride[VPX_PLANE_Y],
              vpx_image->d_h,
@@ skipping 13 matching lines @@
         vpx_image->stride[VPX_PLANE_Y], vpx_image->d_h, video_frame->get());
     return;
   }
   CopyAPlane(vpx_image_alpha->planes[VPX_PLANE_Y],
              vpx_image->stride[VPX_PLANE_Y],
              vpx_image->d_h,
              video_frame->get());
 }
 
 }  // namespace media