test/external_frame_buffer_test.cc

   1 /*
   2  *  Copyright (c) 2014 The WebM project authors. All Rights Reserved.
   3  *
   4  *  Use of this source code is governed by a BSD-style license
   5  *  that can be found in the LICENSE file in the root of the source
   6  *  tree. An additional intellectual property rights grant can be found
   7  *  in the file PATENTS.  All contributing project authors may
   8  *  be found in the AUTHORS file in the root of the source tree.
   9  */
  10
  11 #include <string>
  12
  13 #include "./vpx_config.h"
  14 #include "test/codec_factory.h"
  15 #include "test/decode_test_driver.h"
  16 #include "test/ivf_video_source.h"
  17 #include "test/md5_helper.h"
  18 #include "test/test_vectors.h"
  19 #include "test/util.h"
  20 #if CONFIG_WEBM_IO
  21 #include "test/webm_video_source.h"
  22 #endif
  23
  24 namespace {
  25
  26 const int kVideoNameParam = 1;
  27 const char kVP9TestFile[] = "vp90-2-02-size-lf-1920x1080.webm";
  28
  29 struct ExternalFrameBuffer {
  30   uint8_t *data;
  31   size_t size;
  32   int in_use;
  33 };
  34
  35 // Class to manipulate a list of external frame buffers.
  36 class ExternalFrameBufferList {
  37  public:
  38   ExternalFrameBufferList()
  39       : num_buffers_(0),
  40         ext_fb_list_(NULL) {}
  41
  42   virtual ~ExternalFrameBufferList() {
  43     for (int i = 0; i < num_buffers_; ++i) {
  44       delete [] ext_fb_list_[i].data;
  45     }
  46     delete [] ext_fb_list_;
  47   }
  48
  49   // Creates the list to hold the external buffers. Returns true on success.
  50   bool CreateBufferList(int num_buffers) {
  51     if (num_buffers < 0)
  52       return false;
  53
  54     num_buffers_ = num_buffers;
  55     ext_fb_list_ = new ExternalFrameBuffer[num_buffers_];
  56     EXPECT_TRUE(ext_fb_list_ != NULL);
  57     memset(ext_fb_list_, 0, sizeof(ext_fb_list_[0]) * num_buffers_);
  58     return true;
  59   }
  60
  61   // Searches the frame buffer list for a free frame buffer. Makes sure
  62   // that the frame buffer is at least |min_size| in bytes. Marks that the
  63   // frame buffer is in use by libvpx. Finally sets |fb| to point to the
  64   // external frame buffer. Returns < 0 on an error.
  65   int GetFreeFrameBuffer(size_t min_size, vpx_codec_frame_buffer_t *fb) {
  66     EXPECT_TRUE(fb != NULL);
  67     const int idx = FindFreeBufferIndex();
  68     if (idx == num_buffers_)
  69       return -1;
  70
  71     if (ext_fb_list_[idx].size < min_size) {
  72       delete [] ext_fb_list_[idx].data;
  73       ext_fb_list_[idx].data = new uint8_t[min_size];
  74       ext_fb_list_[idx].size = min_size;
  75     }
  76
  77     SetFrameBuffer(idx, fb);
  78     return 0;
  79   }
  80
  81   // Test function that will not allocate any data for the frame buffer.
  82   // Returns < 0 on an error.
  83   int GetZeroFrameBuffer(size_t min_size, vpx_codec_frame_buffer_t *fb) {
  84     EXPECT_TRUE(fb != NULL);
  85     const int idx = FindFreeBufferIndex();
  86     if (idx == num_buffers_)
  87       return -1;
  88
  89     if (ext_fb_list_[idx].size < min_size) {
  90       delete [] ext_fb_list_[idx].data;
  91       ext_fb_list_[idx].data = NULL;
  92       ext_fb_list_[idx].size = min_size;
  93     }
  94
  95     SetFrameBuffer(idx, fb);
  96     return 0;
  97   }
  98
  99   // Marks the external frame buffer that |fb| is pointing too as free.
 100   // Returns < 0 on an error.
 101   int ReturnFrameBuffer(vpx_codec_frame_buffer_t *fb) {
 102     EXPECT_TRUE(fb != NULL);
 103     ExternalFrameBuffer *const ext_fb =
 104         reinterpret_cast<ExternalFrameBuffer*>(fb->priv);
 105     EXPECT_TRUE(ext_fb != NULL);
 106     EXPECT_EQ(1, ext_fb->in_use);
 107     ext_fb->in_use = 0;
 108     return 0;
 109   }
 110
 111   // Checks that the ximage data is contained within the external frame buffer
 112   // private data passed back in the ximage.
 113   void CheckXImageFrameBuffer(const vpx_image_t *img) {
 114     if (img->fb_priv != NULL) {
 115       const struct ExternalFrameBuffer *const ext_fb =
 116           reinterpret_cast<ExternalFrameBuffer*>(img->fb_priv);
 117
 118       ASSERT_TRUE(img->planes[0] >= ext_fb->data &&
 119                   img->planes[0] < (ext_fb->data + ext_fb->size));
 120     }
 121   }
 122
 123  private:
 124   // Returns the index of the first free frame buffer. Returns |num_buffers_|
 125   // if there are no free frame buffers.
 126   int FindFreeBufferIndex() {
 127     int i;
 128     // Find a free frame buffer.
 129     for (i = 0; i < num_buffers_; ++i) {
 130       if (!ext_fb_list_[i].in_use)
 131         break;
 132     }
 133     return i;
 134   }
 135
 136   // Sets |fb| to an external frame buffer. idx is the index into the frame
 137   // buffer list.
 138   void SetFrameBuffer(int idx, vpx_codec_frame_buffer_t *fb) {
 139     ASSERT_TRUE(fb != NULL);
 140     fb->data = ext_fb_list_[idx].data;
 141     fb->size = ext_fb_list_[idx].size;
 142     ASSERT_EQ(0, ext_fb_list_[idx].in_use);
 143     ext_fb_list_[idx].in_use = 1;
 144     fb->priv = &ext_fb_list_[idx];
 145   }
 146
 147   int num_buffers_;
 148   ExternalFrameBuffer *ext_fb_list_;
 149 };
 150
 151 // Callback used by libvpx to request the application to return a frame
 152 // buffer of at least |min_size| in bytes.
 153 int get_vp9_frame_buffer(void *user_priv, size_t min_size,
 154                          vpx_codec_frame_buffer_t *fb) {
 155   ExternalFrameBufferList *const fb_list =
 156       reinterpret_cast<ExternalFrameBufferList*>(user_priv);
 157   return fb_list->GetFreeFrameBuffer(min_size, fb);
 158 }
 159
 160 // Callback used by libvpx to tell the application that |fb| is not needed
 161 // anymore.
 162 int release_vp9_frame_buffer(void *user_priv,
 163                              vpx_codec_frame_buffer_t *fb) {
 164   ExternalFrameBufferList *const fb_list =
 165       reinterpret_cast<ExternalFrameBufferList*>(user_priv);
 166   return fb_list->ReturnFrameBuffer(fb);
 167 }
 168
 169 // Callback will not allocate data for frame buffer.
 170 int get_vp9_zero_frame_buffer(void *user_priv, size_t min_size,
 171                               vpx_codec_frame_buffer_t *fb) {
 172   ExternalFrameBufferList *const fb_list =
 173       reinterpret_cast<ExternalFrameBufferList*>(user_priv);
 174   return fb_list->GetZeroFrameBuffer(min_size, fb);
 175 }
 176
 177 // Callback will allocate one less byte than |min_size|.
 178 int get_vp9_one_less_byte_frame_buffer(void *user_priv, size_t min_size,
 179                                        vpx_codec_frame_buffer_t *fb) {
 180   ExternalFrameBufferList *const fb_list =
 181       reinterpret_cast<ExternalFrameBufferList*>(user_priv);
 182   return fb_list->GetFreeFrameBuffer(min_size - 1, fb);
 183 }
 184
 185 // Callback will not release the external frame buffer.
 186 int do_not_release_vp9_frame_buffer(void *user_priv,
 187                                     vpx_codec_frame_buffer_t *fb) {
 188   (void)user_priv;
 189   (void)fb;
 190   return 0;
 191 }
 192
 193 // Class for testing passing in external frame buffers to libvpx.
 194 class ExternalFrameBufferMD5Test
 195     : public ::libvpx_test::DecoderTest,
 196       public ::libvpx_test::CodecTestWithParam<const char*> {
 197  protected:
 198   ExternalFrameBufferMD5Test()
 199       : DecoderTest(GET_PARAM(::libvpx_test::kCodecFactoryParam)),
 200         md5_file_(NULL),
 201         num_buffers_(0) {}
 202
 203   virtual ~ExternalFrameBufferMD5Test() {
 204     if (md5_file_ != NULL)
 205       fclose(md5_file_);
 206   }
 207
 208   virtual void PreDecodeFrameHook(
 209       const libvpx_test::CompressedVideoSource &video,
 210       libvpx_test::Decoder *decoder) {
 211     if (num_buffers_ > 0 && video.frame_number() == 0) {
 212       // Have libvpx use frame buffers we create.
 213       ASSERT_TRUE(fb_list_.CreateBufferList(num_buffers_));
 214       ASSERT_EQ(VPX_CODEC_OK,
 215                 decoder->SetFrameBufferFunctions(
 216                     GetVP9FrameBuffer, ReleaseVP9FrameBuffer, this));
 217     }
 218   }
 219
 220   void OpenMD5File(const std::string &md5_file_name_) {
 221     md5_file_ = libvpx_test::OpenTestDataFile(md5_file_name_);
 222     ASSERT_TRUE(md5_file_ != NULL) << "Md5 file open failed. Filename: "
 223         << md5_file_name_;
 224   }
 225
 226   virtual void DecompressedFrameHook(const vpx_image_t &img,
 227                                      const unsigned int frame_number) {
 228     ASSERT_TRUE(md5_file_ != NULL);
 229     char expected_md5[33];
 230     char junk[128];
 231
 232     // Read correct md5 checksums.
 233     const int res = fscanf(md5_file_, "%s  %s", expected_md5, junk);
 234     ASSERT_NE(EOF, res) << "Read md5 data failed";
 235     expected_md5[32] = '\0';
 236
 237     ::libvpx_test::MD5 md5_res;
 238     md5_res.Add(&img);
 239     const char *const actual_md5 = md5_res.Get();
 240
 241     // Check md5 match.
 242     ASSERT_STREQ(expected_md5, actual_md5)
 243         << "Md5 checksums don't match: frame number = " << frame_number;
 244   }
 245
 246   // Callback to get a free external frame buffer. Return value < 0 is an
 247   // error.
 248   static int GetVP9FrameBuffer(void *user_priv, size_t min_size,
 249                                vpx_codec_frame_buffer_t *fb) {
 250     ExternalFrameBufferMD5Test *const md5Test =
 251         reinterpret_cast<ExternalFrameBufferMD5Test*>(user_priv);
 252     return md5Test->fb_list_.GetFreeFrameBuffer(min_size, fb);
 253   }
 254
 255   // Callback to release an external frame buffer. Return value < 0 is an
 256   // error.
 257   static int ReleaseVP9FrameBuffer(void *user_priv,
 258                                    vpx_codec_frame_buffer_t *fb) {
 259     ExternalFrameBufferMD5Test *const md5Test =
 260         reinterpret_cast<ExternalFrameBufferMD5Test*>(user_priv);
 261     return md5Test->fb_list_.ReturnFrameBuffer(fb);
 262   }
 263
 264   void set_num_buffers(int num_buffers) { num_buffers_ = num_buffers; }
 265   int num_buffers() const { return num_buffers_; }
 266
 267  private:
 268   FILE *md5_file_;
 269   int num_buffers_;
 270   ExternalFrameBufferList fb_list_;
 271 };
 272
 273 #if CONFIG_WEBM_IO
 274 // Class for testing passing in external frame buffers to libvpx.
 275 class ExternalFrameBufferTest : public ::testing::Test {
 276  protected:
 277   ExternalFrameBufferTest()
 278       : video_(NULL),
 279         decoder_(NULL),
 280         num_buffers_(0) {}
 281
 282   virtual void SetUp() {
 283     video_ = new libvpx_test::WebMVideoSource(kVP9TestFile);
 284     ASSERT_TRUE(video_ != NULL);
 285     video_->Init();
 286     video_->Begin();
 287
 288     vpx_codec_dec_cfg_t cfg = {0};
 289     decoder_ = new libvpx_test::VP9Decoder(cfg, 0);
 290     ASSERT_TRUE(decoder_ != NULL);
 291   }
 292
 293   virtual void TearDown() {
 294     delete decoder_;
 295     delete video_;
 296   }
 297
 298   // Passes the external frame buffer information to libvpx.
 299   vpx_codec_err_t SetFrameBufferFunctions(
 300       int num_buffers,
 301       vpx_get_frame_buffer_cb_fn_t cb_get,
 302       vpx_release_frame_buffer_cb_fn_t cb_release) {
 303     if (num_buffers > 0) {
 304       num_buffers_ = num_buffers;
 305       EXPECT_TRUE(fb_list_.CreateBufferList(num_buffers_));
 306     }
 307
 308     return decoder_->SetFrameBufferFunctions(cb_get, cb_release, &fb_list_);
 309   }
 310
 311   vpx_codec_err_t DecodeOneFrame() {
 312     const vpx_codec_err_t res =
 313         decoder_->DecodeFrame(video_->cxdata(), video_->frame_size());
 314     CheckDecodedFrames();
 315     if (res == VPX_CODEC_OK)
 316       video_->Next();
 317     return res;
 318   }
 319
 320   vpx_codec_err_t DecodeRemainingFrames() {
 321     for (; video_->cxdata() != NULL; video_->Next()) {
 322       const vpx_codec_err_t res =
 323           decoder_->DecodeFrame(video_->cxdata(), video_->frame_size());
 324       if (res != VPX_CODEC_OK)
 325         return res;
 326       CheckDecodedFrames();
 327     }
 328     return VPX_CODEC_OK;
 329   }
 330
 331  private:
 332   void CheckDecodedFrames() {
 333     libvpx_test::DxDataIterator dec_iter = decoder_->GetDxData();
 334     const vpx_image_t *img = NULL;
 335
 336     // Get decompressed data
 337     while ((img = dec_iter.Next()) != NULL) {
 338       fb_list_.CheckXImageFrameBuffer(img);
 339     }
 340   }
 341
 342   libvpx_test::WebMVideoSource *video_;
 343   libvpx_test::VP9Decoder *decoder_;
 344   int num_buffers_;
 345   ExternalFrameBufferList fb_list_;
 346 };
 347 #endif  // CONFIG_WEBM_IO
 348
 349 // This test runs through the set of test vectors, and decodes them.
 350 // Libvpx will call into the application to allocate a frame buffer when
 351 // needed. The md5 checksums are computed for each frame in the video file.
 352 // If md5 checksums match the correct md5 data, then the test is passed.
 353 // Otherwise, the test failed.
 354 TEST_P(ExternalFrameBufferMD5Test, ExtFBMD5Match) {
 355   const std::string filename = GET_PARAM(kVideoNameParam);
 356   libvpx_test::CompressedVideoSource *video = NULL;
 357
 358   // Number of buffers equals #VP9_MAXIMUM_REF_BUFFERS +
 359   // #VPX_MAXIMUM_WORK_BUFFERS + four jitter buffers.
 360   const int jitter_buffers = 4;
 361   const int num_buffers =
 362       VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS + jitter_buffers;
 363   set_num_buffers(num_buffers);
 364
 365 #if CONFIG_VP8_DECODER
 366   // Tell compiler we are not using kVP8TestVectors.
 367   (void)libvpx_test::kVP8TestVectors;
 368 #endif
 369
 370   // Open compressed video file.
 371   if (filename.substr(filename.length() - 3, 3) == "ivf") {
 372     video = new libvpx_test::IVFVideoSource(filename);
 373   } else {
 374 #if CONFIG_WEBM_IO
 375     video = new libvpx_test::WebMVideoSource(filename);
 376 #else
 377     fprintf(stderr, "WebM IO is disabled, skipping test vector %s\n",
 378             filename.c_str());
 379     return;
 380 #endif
 381   }
 382   ASSERT_TRUE(video != NULL);
 383   video->Init();
 384
 385   // Construct md5 file name.
 386   const std::string md5_filename = filename + ".md5";
 387   OpenMD5File(md5_filename);
 388
 389   // Decode frame, and check the md5 matching.
 390   ASSERT_NO_FATAL_FAILURE(RunLoop(video));
 391   delete video;
 392 }
 393
 394 #if CONFIG_WEBM_IO
 395 TEST_F(ExternalFrameBufferTest, MinFrameBuffers) {
 396   // Minimum number of external frame buffers for VP9 is
 397   // #VP9_MAXIMUM_REF_BUFFERS + #VPX_MAXIMUM_WORK_BUFFERS.
 398   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 399   ASSERT_EQ(VPX_CODEC_OK,
 400             SetFrameBufferFunctions(
 401                 num_buffers, get_vp9_frame_buffer, release_vp9_frame_buffer));
 402   ASSERT_EQ(VPX_CODEC_OK, DecodeRemainingFrames());
 403 }
 404
 405 TEST_F(ExternalFrameBufferTest, EightJitterBuffers) {
 406   // Number of buffers equals #VP9_MAXIMUM_REF_BUFFERS +
 407   // #VPX_MAXIMUM_WORK_BUFFERS + eight jitter buffers.
 408   const int jitter_buffers = 8;
 409   const int num_buffers =
 410       VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS + jitter_buffers;
 411   ASSERT_EQ(VPX_CODEC_OK,
 412             SetFrameBufferFunctions(
 413                 num_buffers, get_vp9_frame_buffer, release_vp9_frame_buffer));
 414   ASSERT_EQ(VPX_CODEC_OK, DecodeRemainingFrames());
 415 }
 416
 417 TEST_F(ExternalFrameBufferTest, NotEnoughBuffers) {
 418   // Minimum number of external frame buffers for VP9 is
 419   // #VP9_MAXIMUM_REF_BUFFERS + #VPX_MAXIMUM_WORK_BUFFERS. Most files will
 420   // only use 5 frame buffers at one time.
 421   const int num_buffers = 2;
 422   ASSERT_EQ(VPX_CODEC_OK,
 423             SetFrameBufferFunctions(
 424                 num_buffers, get_vp9_frame_buffer, release_vp9_frame_buffer));
 425   ASSERT_EQ(VPX_CODEC_OK, DecodeOneFrame());
 426   ASSERT_EQ(VPX_CODEC_MEM_ERROR, DecodeRemainingFrames());
 427 }
 428
 429 TEST_F(ExternalFrameBufferTest, NoRelease) {
 430   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 431   ASSERT_EQ(VPX_CODEC_OK,
 432             SetFrameBufferFunctions(num_buffers, get_vp9_frame_buffer,
 433                                     do_not_release_vp9_frame_buffer));
 434   ASSERT_EQ(VPX_CODEC_OK, DecodeOneFrame());
 435   ASSERT_EQ(VPX_CODEC_MEM_ERROR, DecodeRemainingFrames());
 436 }
 437
 438 TEST_F(ExternalFrameBufferTest, NullRealloc) {
 439   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 440   ASSERT_EQ(VPX_CODEC_OK,
 441             SetFrameBufferFunctions(num_buffers, get_vp9_zero_frame_buffer,
 442                                     release_vp9_frame_buffer));
 443   ASSERT_EQ(VPX_CODEC_MEM_ERROR, DecodeOneFrame());
 444 }
 445
 446 TEST_F(ExternalFrameBufferTest, ReallocOneLessByte) {
 447   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 448   ASSERT_EQ(VPX_CODEC_OK,
 449             SetFrameBufferFunctions(
 450                 num_buffers, get_vp9_one_less_byte_frame_buffer,
 451                 release_vp9_frame_buffer));
 452   ASSERT_EQ(VPX_CODEC_MEM_ERROR, DecodeOneFrame());
 453 }
 454
 455 TEST_F(ExternalFrameBufferTest, NullGetFunction) {
 456   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 457   ASSERT_EQ(VPX_CODEC_INVALID_PARAM,
 458             SetFrameBufferFunctions(num_buffers, NULL,
 459                                     release_vp9_frame_buffer));
 460 }
 461
 462 TEST_F(ExternalFrameBufferTest, NullReleaseFunction) {
 463   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 464   ASSERT_EQ(VPX_CODEC_INVALID_PARAM,
 465             SetFrameBufferFunctions(num_buffers, get_vp9_frame_buffer, NULL));
 466 }
 467
 468 TEST_F(ExternalFrameBufferTest, SetAfterDecode) {
 469   const int num_buffers = VP9_MAXIMUM_REF_BUFFERS + VPX_MAXIMUM_WORK_BUFFERS;
 470   ASSERT_EQ(VPX_CODEC_OK, DecodeOneFrame());
 471   ASSERT_EQ(VPX_CODEC_ERROR,
 472             SetFrameBufferFunctions(
 473                 num_buffers, get_vp9_frame_buffer, release_vp9_frame_buffer));
 474 }
 475 #endif  // CONFIG_WEBM_IO
 476
 477 VP9_INSTANTIATE_TEST_CASE(ExternalFrameBufferMD5Test,
 478                           ::testing::ValuesIn(libvpx_test::kVP9TestVectors,
 479                                               libvpx_test::kVP9TestVectors +
 480                                               libvpx_test::kNumVP9TestVectors));
 481 }  // namespace