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 "base/bind.h"
 #include "base/callback_helpers.h"
 #include "base/command_line.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/message_loop/message_loop_proxy.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/sys_byteorder.h"
 #include "media/base/bind_to_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 allowed to be used by libvpx for VP9
+// decoding.
+static const int kVP9MaxFrameBuffers = VP9_MAXIMUM_REF_BUFFERS +
+                                       VPX_MAXIMUM_WORK_BUFFERS +
+                                       limits::kMaxVideoFrames;
+
+class VpxVideoDecoder::MemoryPool
+    : public base::RefCountedThreadSafe<VpxVideoDecoder::MemoryPool> {
+ public:
+  MemoryPool(VpxVideoDecoder* decoder);
+  vpx_codec_frame_buffer* frame_buffers() { return frame_buffers_; }
+  size_t frame_buffers_size() const { return arraysize(frame_buffers_); }
+
+  // Callback that will be called by libvpx if the frame buffer size needs to
+  // increase. Parameters:
+  // user_priv  Data passed into libvpx (we pass NULL).
+  // new_size   Minimum size needed by libvpx to decompress the next frame.
+  // fb         Pointer to the frame buffer to update.
+  // Returns VPX_CODEC_OK on success. Returns < 0 on failure.
+  static int32 ReallocVP9FrameBuffer(void* user_priv, size_t new_size,
+                                     vpx_codec_frame_buffer* fb);
+
+  // Generates a "no_longer_needed" closure that holds a reference
+  // to this pool.
+  base::Closure frame_callback();
+
+  // Checks if it is safe to call libvpx. Since libvpx uses LRU to reuse frame
+  // buffers, it is not safe to call libvpx if the "oldest" frame according to
+  // libvpx is still in use by chromium.
+  bool IsSafeToCallDecoder();
+
+ private:
+  friend class base::RefCountedThreadSafe<VpxVideoDecoder::MemoryPool>;
+  ~MemoryPool();
+
+  // Method that gets called when a VideoFrame that references this pool gets
+  // destroyed.
+  void OnVideoFrameDestroyed(uint64 frame_id);
+
+  // Pointer to the VpxVideoDecoder object that has this object.
+  VpxVideoDecoder* decoder_;
+
+  // Incrementing counter of frames passed into libvpx.
+  uint64 next_frame_id_;
+
+  // List of frame ids currently in use by chromium.
+  std::set<uint64> frame_ids_in_use_;
+
+  vpx_codec_frame_buffer frame_buffers_[kVP9MaxFrameBuffers];
+  DISALLOW_COPY_AND_ASSIGN(MemoryPool);
+};
+
+VpxVideoDecoder::MemoryPool::MemoryPool(VpxVideoDecoder* decoder)
+    : decoder_(decoder),
+      next_frame_id_(0) {
+  memset(frame_buffers_, 0,
+         sizeof(vpx_codec_frame_buffer) * arraysize(frame_buffers_));

[acolwell GONE FROM CHROMIUM, 2013/12/20 17:26:44]

nit: I believe you should be able to just use sizeof(frame_buffers_) here.

[vignesh, 2013/12/20 19:59:40]

I tried that before i used this, it did not work.

+}
+
+VpxVideoDecoder::MemoryPool::~MemoryPool() {
+  for (size_t i = 0; i < arraysize(frame_buffers_); ++i)
+    delete[] frame_buffers_[i].data;
+}
+
+int32 VpxVideoDecoder::MemoryPool::ReallocVP9FrameBuffer(
+    void* user_priv, size_t new_size, vpx_codec_frame_buffer* fb) {
+    if (!fb)
+      return -1;
+    if (fb->data)
+      delete[] fb->data;
+    fb->data = new uint8[new_size];
+    if (!fb->data) {
+      fb->size = 0;
+      return -1;
+    }
+    fb->size = new_size;
+    return VPX_CODEC_OK;
+  }
+
+base::Closure VpxVideoDecoder::MemoryPool::frame_callback() {
+  frame_ids_in_use_.insert(next_frame_id_);
+  return BindToCurrentLoop(
+             base::Bind(&MemoryPool::OnVideoFrameDestroyed, this,
+                        next_frame_id_++));
+}
+
+void VpxVideoDecoder::MemoryPool::OnVideoFrameDestroyed(uint64 frame_id) {
+  frame_ids_in_use_.erase(frame_id);
+  if (decoder_->pending_buffer_ && IsSafeToCallDecoder()) {

[acolwell GONE FROM CHROMIUM, 2013/12/20 17:26:44]

You'll need a decoder_ null check and a way for the decoder to clear decoder_
when the decoder clears its reference to the pool (ie when it creates a new pool
or when the decoder destructor runs. If you don't you could run into
use-after-free issues when frames, that live longer than the decoder, get
destroyed.

[vignesh, 2013/12/20 19:59:40]

nice catch. Done.

+    decoder_->DecodeBuffer(decoder_->pending_buffer_);
+    decoder_->pending_buffer_ = NULL;
+  }
+}
+
+bool VpxVideoDecoder::MemoryPool::IsSafeToCallDecoder() {
+  return next_frame_id_ < limits::kMaxVideoFrames ||
+         frame_ids_in_use_.find(next_frame_id_ - limits::kMaxVideoFrames) ==
+         frame_ids_in_use_.end();
+}
+
 VpxVideoDecoder::VpxVideoDecoder(
     const scoped_refptr<base::MessageLoopProxy>& message_loop)
     : message_loop_(message_loop),
       weak_factory_(this),
       state_(kUninitialized),
       vpx_codec_(NULL),
-      vpx_codec_alpha_(NULL) {
+      vpx_codec_alpha_(NULL),
+      memory_pool_(NULL),
+      pending_buffer_(NULL) {
 }
 
 VpxVideoDecoder::~VpxVideoDecoder() {
   DCHECK_EQ(kUninitialized, state_);
   CloseDecoder();
 }
 
 void VpxVideoDecoder::Initialize(const VideoDecoderConfig& config,
                                  const PipelineStatusCB& status_cb) {
   DCHECK(message_loop_->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_frame_buffers(
+            vpx_codec_,
+            memory_pool_->frame_buffers(),
+            memory_pool_->frame_buffers_size(),
+            &MemoryPool::ReallocVP9FrameBuffer,
+            NULL)) {
+      LOG(ERROR) << "Failed to configure external buffers.";
+      return false;
+    }
+    if (vpx_codec_control(vpx_codec_, VP9D_SET_FRAME_BUFFER_LRU_CACHE, 1)) {
+      LOG(ERROR) << "Failed to set frame buffer lru cache.";
+      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;
+    memory_pool_ = NULL;

[acolwell GONE FROM CHROMIUM, 2013/12/20 17:26:44]

I think right before this line is where you need to call a method that clears
memory_pool_->decoder_

[vignesh, 2013/12/20 19:59:40]

Done.

+    pending_buffer_ = 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) {
   DCHECK(message_loop_->BelongsToCurrentThread());
   DCHECK(!decode_cb.is_null());
   CHECK_NE(state_, kUninitialized);
   CHECK(decode_cb_.is_null()) << "Overlapping decodes are not supported.";
 
   decode_cb_ = BindToCurrentLoop(decode_cb);
 
   if (state_ == kError) {
     base::ResetAndReturn(&decode_cb_).Run(kDecodeError, NULL);
     return;
   }
 
   // Return empty frames if decoding has finished.
   if (state_ == kDecodeFinished) {
     base::ResetAndReturn(&decode_cb_).Run(kOk, VideoFrame::CreateEOSFrame());
     return;
   }
 
+  // Check if it is safe to call libvpx.
+  if (memory_pool_ && !memory_pool_->IsSafeToCallDecoder()) {
+    pending_buffer_ = buffer;
+    return;
+  }
+
   DecodeBuffer(buffer);
 }
 
 void VpxVideoDecoder::Reset(const base::Closure& closure) {
   DCHECK(message_loop_->BelongsToCurrentThread());
   DCHECK(reset_cb_.is_null());
   reset_cb_ = BindToCurrentLoop(closure);
 
   // Defer the reset if a decode is pending.
   if (!decode_cb_.is_null())
@@ skipping 138 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());
+    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