granicus.if.org Git - libvpx/blob - vp9/vp9_dx_iface.c

   1 /*
   2  *  Copyright (c) 2010 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 <stdlib.h>
  12 #include <string.h>
  13
  14 #include "./vpx_config.h"
  15 #include "./vpx_version.h"
  16
  17 #include "vpx/internal/vpx_codec_internal.h"
  18 #include "vpx/vp8dx.h"
  19 #include "vpx/vpx_decoder.h"
  20
  21 #include "vp9/common/vp9_alloccommon.h"
  22 #include "vp9/common/vp9_frame_buffers.h"
  23 #include "vp9/common/vp9_thread.h"
  24
  25 #include "vp9/decoder/vp9_decoder.h"
  26 #include "vp9/decoder/vp9_decodeframe.h"
  27 #include "vp9/decoder/vp9_read_bit_buffer.h"
  28
  29 #include "vp9/vp9_iface_common.h"
  30
  31 #define VP9_CAP_POSTPROC (CONFIG_VP9_POSTPROC ? VPX_CODEC_CAP_POSTPROC : 0)
  32
  33 typedef vpx_codec_stream_info_t vp9_stream_info_t;
  34
  35 // This limit is due to framebuffer numbers.
  36 // TODO(hkuang): Remove this limit after implementing ondemand framebuffers.
  37 #define FRAME_CACHE_SIZE 6   // Cache maximum 6 decoded frames.
  38
  39 typedef struct cache_frame {
  40   int fb_idx;
  41   vpx_image_t img;
  42 } cache_frame;
  43
  44 struct vpx_codec_alg_priv {
  45   vpx_codec_priv_t        base;
  46   vpx_codec_dec_cfg_t     cfg;
  47   vp9_stream_info_t       si;
  48   int                     postproc_cfg_set;
  49   vp8_postproc_cfg_t      postproc_cfg;
  50   vpx_decrypt_cb          decrypt_cb;
  51   void                    *decrypt_state;
  52   vpx_image_t             img;
  53   int                     img_avail;
  54   int                     flushed;
  55   int                     invert_tile_order;
  56   int                     last_show_frame;  // Index of last output frame.
  57
  58   // Frame parallel related.
  59   int                     frame_parallel_decode;  // frame-based threading.
  60   int                     byte_alignment;
  61   VP9Worker               *frame_workers;
  62   int                     num_frame_workers;
  63   int                     next_submit_worker_id;
  64   int                     last_submit_worker_id;
  65   int                     next_output_worker_id;
  66   int                     available_threads;
  67   cache_frame             frame_cache[FRAME_CACHE_SIZE];
  68   int                     frame_cache_write;
  69   int                     frame_cache_read;
  70   int                     num_cache_frames;
  71
  72   // BufferPool that holds all reference frames. Shared by all the FrameWorkers.
  73   BufferPool              *buffer_pool;
  74
  75   // External frame buffer info to save for VP9 common.
  76   void *ext_priv;  // Private data associated with the external frame buffers.
  77   vpx_get_frame_buffer_cb_fn_t get_ext_fb_cb;
  78   vpx_release_frame_buffer_cb_fn_t release_ext_fb_cb;
  79 };
  80
  81 static vpx_codec_err_t decoder_init(vpx_codec_ctx_t *ctx,
  82                                     vpx_codec_priv_enc_mr_cfg_t *data) {
  83   // This function only allocates space for the vpx_codec_alg_priv_t
  84   // structure. More memory may be required at the time the stream
  85   // information becomes known.
  86   (void)data;
  87
  88   if (!ctx->priv) {
  89     vpx_codec_alg_priv_t *const priv = vpx_calloc(1, sizeof(*priv));
  90     if (priv == NULL)
  91       return VPX_CODEC_MEM_ERROR;
  92
  93     ctx->priv = (vpx_codec_priv_t *)priv;
  94     ctx->priv->init_flags = ctx->init_flags;
  95     priv->si.sz = sizeof(priv->si);
  96     priv->flushed = 0;
  97     // Only do frame parallel decode when threads > 1.
  98     priv->frame_parallel_decode =
  99         (ctx->config.dec && (ctx->config.dec->threads > 1) &&
 100          (ctx->init_flags & VPX_CODEC_USE_FRAME_THREADING)) ? 1 : 0;
 101     if (ctx->config.dec) {
 102       priv->cfg = *ctx->config.dec;
 103       ctx->config.dec = &priv->cfg;
 104     }
 105   }
 106
 107   return VPX_CODEC_OK;
 108 }
 109
 110 static vpx_codec_err_t decoder_destroy(vpx_codec_alg_priv_t *ctx) {
 111   if (ctx->frame_workers != NULL) {
 112     int i;
 113     for (i = 0; i < ctx->num_frame_workers; ++i) {
 114       VP9Worker *const worker = &ctx->frame_workers[i];
 115       FrameWorkerData *const frame_worker_data =
 116           (FrameWorkerData *)worker->data1;
 117       vp9_get_worker_interface()->end(worker);
 118       vp9_remove_common(&frame_worker_data->pbi->common);
 119       vp9_decoder_remove(frame_worker_data->pbi);
 120       vpx_free(frame_worker_data->scratch_buffer);
 121 #if CONFIG_MULTITHREAD
 122       pthread_mutex_destroy(&frame_worker_data->stats_mutex);
 123       pthread_cond_destroy(&frame_worker_data->stats_cond);
 124 #endif
 125       vpx_free(frame_worker_data);
 126     }
 127 #if CONFIG_MULTITHREAD
 128     pthread_mutex_destroy(&ctx->buffer_pool->pool_mutex);
 129 #endif
 130   }
 131
 132   if (ctx->buffer_pool)
 133     vp9_free_internal_frame_buffers(&ctx->buffer_pool->int_frame_buffers);
 134
 135   vpx_free(ctx->frame_workers);
 136   vpx_free(ctx->buffer_pool);
 137   vpx_free(ctx);
 138   return VPX_CODEC_OK;
 139 }
 140
 141 static int parse_bitdepth_colorspace_sampling(
 142     BITSTREAM_PROFILE profile, struct vp9_read_bit_buffer *rb) {
 143   vpx_color_space_t color_space;
 144   if (profile >= PROFILE_2)
 145     rb->bit_offset += 1;  // Bit-depth 10 or 12.
 146   color_space = (vpx_color_space_t)vp9_rb_read_literal(rb, 3);
 147   if (color_space != VPX_CS_SRGB) {
 148     rb->bit_offset += 1;  // [16,235] (including xvycc) vs [0,255] range.
 149     if (profile == PROFILE_1 || profile == PROFILE_3) {
 150       rb->bit_offset += 2;  // subsampling x/y.
 151       rb->bit_offset += 1;  // unused.
 152     }
 153   } else {
 154     if (profile == PROFILE_1 || profile == PROFILE_3) {
 155       rb->bit_offset += 1;  // unused
 156     } else {
 157       // RGB is only available in version 1.
 158       return 0;
 159     }
 160   }
 161   return 1;
 162 }
 163
 164 static vpx_codec_err_t decoder_peek_si_internal(const uint8_t *data,
 165                                                 unsigned int data_sz,
 166                                                 vpx_codec_stream_info_t *si,
 167                                                 int *is_intra_only,
 168                                                 vpx_decrypt_cb decrypt_cb,
 169                                                 void *decrypt_state) {
 170   int intra_only_flag = 0;
 171   uint8_t clear_buffer[9];
 172
 173   if (data + data_sz <= data)
 174     return VPX_CODEC_INVALID_PARAM;
 175
 176   si->is_kf = 0;
 177   si->w = si->h = 0;
 178
 179   if (decrypt_cb) {
 180     data_sz = MIN(sizeof(clear_buffer), data_sz);
 181     decrypt_cb(decrypt_state, data, clear_buffer, data_sz);
 182     data = clear_buffer;
 183   }
 184
 185   {
 186     int show_frame;
 187     int error_resilient;
 188     struct vp9_read_bit_buffer rb = { data, data + data_sz, 0, NULL, NULL };
 189     const int frame_marker = vp9_rb_read_literal(&rb, 2);
 190     const BITSTREAM_PROFILE profile = vp9_read_profile(&rb);
 191
 192     if (frame_marker != VP9_FRAME_MARKER)
 193       return VPX_CODEC_UNSUP_BITSTREAM;
 194
 195     if (profile >= MAX_PROFILES)
 196       return VPX_CODEC_UNSUP_BITSTREAM;
 197
 198     if ((profile >= 2 && data_sz <= 1) || data_sz < 1)
 199       return VPX_CODEC_UNSUP_BITSTREAM;
 200
 201     if (vp9_rb_read_bit(&rb)) {  // show an existing frame
 202       vp9_rb_read_literal(&rb, 3);  // Frame buffer to show.
 203       return VPX_CODEC_OK;
 204     }
 205
 206     if (data_sz <= 8)
 207       return VPX_CODEC_UNSUP_BITSTREAM;
 208
 209     si->is_kf = !vp9_rb_read_bit(&rb);
 210     show_frame = vp9_rb_read_bit(&rb);
 211     error_resilient = vp9_rb_read_bit(&rb);
 212
 213     if (si->is_kf) {
 214       if (!vp9_read_sync_code(&rb))
 215         return VPX_CODEC_UNSUP_BITSTREAM;
 216
 217       if (!parse_bitdepth_colorspace_sampling(profile, &rb))
 218         return VPX_CODEC_UNSUP_BITSTREAM;
 219       vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
 220     } else {
 221       intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
 222
 223       rb.bit_offset += error_resilient ? 0 : 2;  // reset_frame_context
 224
 225       if (intra_only_flag) {
 226         if (!vp9_read_sync_code(&rb))
 227           return VPX_CODEC_UNSUP_BITSTREAM;
 228         if (profile > PROFILE_0) {
 229           if (!parse_bitdepth_colorspace_sampling(profile, &rb))
 230             return VPX_CODEC_UNSUP_BITSTREAM;
 231         }
 232         rb.bit_offset += REF_FRAMES;  // refresh_frame_flags
 233         vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
 234       }
 235     }
 236   }
 237   if (is_intra_only != NULL)
 238     *is_intra_only = intra_only_flag;
 239   return VPX_CODEC_OK;
 240 }
 241
 242 static vpx_codec_err_t decoder_peek_si(const uint8_t *data,
 243                                        unsigned int data_sz,
 244                                        vpx_codec_stream_info_t *si) {
 245   return decoder_peek_si_internal(data, data_sz, si, NULL, NULL, NULL);
 246 }
 247
 248 static vpx_codec_err_t decoder_get_si(vpx_codec_alg_priv_t *ctx,
 249                                       vpx_codec_stream_info_t *si) {
 250   const size_t sz = (si->sz >= sizeof(vp9_stream_info_t))
 251                        ? sizeof(vp9_stream_info_t)
 252                        : sizeof(vpx_codec_stream_info_t);
 253   memcpy(si, &ctx->si, sz);
 254   si->sz = (unsigned int)sz;
 255
 256   return VPX_CODEC_OK;
 257 }
 258
 259 static void set_error_detail(vpx_codec_alg_priv_t *ctx,
 260                              const char *const error) {
 261   ctx->base.err_detail = error;
 262 }
 263
 264 static vpx_codec_err_t update_error_state(vpx_codec_alg_priv_t *ctx,
 265                            const struct vpx_internal_error_info *error) {
 266   if (error->error_code)
 267     set_error_detail(ctx, error->has_detail ? error->detail : NULL);
 268
 269   return error->error_code;
 270 }
 271
 272 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
 273   int i;
 274
 275   for (i = 0; i < ctx->num_frame_workers; ++i) {
 276     VP9Worker *const worker = &ctx->frame_workers[i];
 277     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 278     VP9_COMMON *const cm = &frame_worker_data->pbi->common;
 279     BufferPool *const pool = cm->buffer_pool;
 280
 281     cm->new_fb_idx = -1;
 282     cm->byte_alignment = ctx->byte_alignment;
 283
 284     if (ctx->get_ext_fb_cb != NULL && ctx->release_ext_fb_cb != NULL) {
 285       pool->get_fb_cb = ctx->get_ext_fb_cb;
 286       pool->release_fb_cb = ctx->release_ext_fb_cb;
 287       pool->cb_priv = ctx->ext_priv;
 288     } else {
 289       pool->get_fb_cb = vp9_get_frame_buffer;
 290       pool->release_fb_cb = vp9_release_frame_buffer;
 291
 292       if (vp9_alloc_internal_frame_buffers(&pool->int_frame_buffers))
 293         vpx_internal_error(&cm->error, VPX_CODEC_MEM_ERROR,
 294                            "Failed to initialize internal frame buffers");
 295
 296       pool->cb_priv = &pool->int_frame_buffers;
 297     }
 298   }
 299 }
 300
 301 static void set_default_ppflags(vp8_postproc_cfg_t *cfg) {
 302   cfg->post_proc_flag = VP8_DEBLOCK | VP8_DEMACROBLOCK;
 303   cfg->deblocking_level = 4;
 304   cfg->noise_level = 0;
 305 }
 306
 307 static void set_ppflags(const vpx_codec_alg_priv_t *ctx,
 308                         vp9_ppflags_t *flags) {
 309   flags->post_proc_flag =
 310       ctx->postproc_cfg.post_proc_flag;
 311
 312   flags->deblocking_level = ctx->postproc_cfg.deblocking_level;
 313   flags->noise_level = ctx->postproc_cfg.noise_level;
 314 }
 315
 316 static int frame_worker_hook(void *arg1, void *arg2) {
 317   FrameWorkerData *const frame_worker_data = (FrameWorkerData *)arg1;
 318   const uint8_t *data = frame_worker_data->data;
 319   (void)arg2;
 320
 321   frame_worker_data->result =
 322       vp9_receive_compressed_data(frame_worker_data->pbi,
 323                                   frame_worker_data->data_size,
 324                                   &data);
 325   frame_worker_data->data_end = data;
 326
 327   if (frame_worker_data->pbi->frame_parallel_decode) {
 328     // In frame parallel decoding, a worker thread must successfully decode all
 329     // the compressed data.
 330     if (frame_worker_data->result != 0 ||
 331         frame_worker_data->data + frame_worker_data->data_size - 1 > data) {
 332       VP9Worker *const worker = frame_worker_data->pbi->frame_worker_owner;
 333       BufferPool *const pool = frame_worker_data->pbi->common.buffer_pool;
 334       // Signal all the other threads that are waiting for this frame.
 335       vp9_frameworker_lock_stats(worker);
 336       frame_worker_data->frame_context_ready = 1;
 337       lock_buffer_pool(pool);
 338       frame_worker_data->pbi->cur_buf->buf.corrupted = 1;
 339       unlock_buffer_pool(pool);
 340       frame_worker_data->pbi->need_resync = 1;
 341       vp9_frameworker_signal_stats(worker);
 342       vp9_frameworker_unlock_stats(worker);
 343       return 0;
 344     }
 345   } else if (frame_worker_data->result != 0) {
 346     // Check decode result in serial decode.
 347     frame_worker_data->pbi->cur_buf->buf.corrupted = 1;
 348     frame_worker_data->pbi->need_resync = 1;
 349   }
 350   return !frame_worker_data->result;
 351 }
 352
 353 static vpx_codec_err_t init_decoder(vpx_codec_alg_priv_t *ctx) {
 354   int i;
 355   const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
 356
 357   ctx->last_show_frame = -1;
 358   ctx->next_submit_worker_id = 0;
 359   ctx->last_submit_worker_id = 0;
 360   ctx->next_output_worker_id = 0;
 361   ctx->frame_cache_read = 0;
 362   ctx->frame_cache_write = 0;
 363   ctx->num_cache_frames = 0;
 364   ctx->num_frame_workers =
 365       (ctx->frame_parallel_decode == 1) ? ctx->cfg.threads: 1;
 366   ctx->available_threads = ctx->num_frame_workers;
 367   ctx->flushed = 0;
 368
 369   ctx->buffer_pool = (BufferPool *)vpx_calloc(1, sizeof(BufferPool));
 370   if (ctx->buffer_pool == NULL)
 371     return VPX_CODEC_MEM_ERROR;
 372
 373 #if CONFIG_MULTITHREAD
 374     if (pthread_mutex_init(&ctx->buffer_pool->pool_mutex, NULL)) {
 375       set_error_detail(ctx, "Failed to allocate buffer pool mutex");
 376       return VPX_CODEC_MEM_ERROR;
 377     }
 378 #endif
 379
 380   ctx->frame_workers = (VP9Worker *)
 381       vpx_malloc(ctx->num_frame_workers * sizeof(*ctx->frame_workers));
 382   if (ctx->frame_workers == NULL) {
 383     set_error_detail(ctx, "Failed to allocate frame_workers");
 384     return VPX_CODEC_MEM_ERROR;
 385   }
 386
 387   for (i = 0; i < ctx->num_frame_workers; ++i) {
 388     VP9Worker *const worker = &ctx->frame_workers[i];
 389     FrameWorkerData *frame_worker_data = NULL;
 390     winterface->init(worker);
 391     worker->data1 = vpx_memalign(32, sizeof(FrameWorkerData));
 392     if (worker->data1 == NULL) {
 393       set_error_detail(ctx, "Failed to allocate frame_worker_data");
 394       return VPX_CODEC_MEM_ERROR;
 395     }
 396     frame_worker_data = (FrameWorkerData *)worker->data1;
 397     frame_worker_data->pbi = vp9_decoder_create(ctx->buffer_pool);
 398     if (frame_worker_data->pbi == NULL) {
 399       set_error_detail(ctx, "Failed to allocate frame_worker_data");
 400       return VPX_CODEC_MEM_ERROR;
 401     }
 402     frame_worker_data->pbi->frame_worker_owner = worker;
 403     frame_worker_data->worker_id = i;
 404     frame_worker_data->scratch_buffer = NULL;
 405     frame_worker_data->scratch_buffer_size = 0;
 406     frame_worker_data->frame_context_ready = 0;
 407 #if CONFIG_MULTITHREAD
 408     if (pthread_mutex_init(&frame_worker_data->stats_mutex, NULL)) {
 409       set_error_detail(ctx, "Failed to allocate frame_worker_data mutex");
 410       return VPX_CODEC_MEM_ERROR;
 411     }
 412
 413     if (pthread_cond_init(&frame_worker_data->stats_cond, NULL)) {
 414       set_error_detail(ctx, "Failed to allocate frame_worker_data cond");
 415       return VPX_CODEC_MEM_ERROR;
 416     }
 417 #endif
 418     // If decoding in serial mode, FrameWorker thread could create tile worker
 419     // thread or loopfilter thread.
 420     frame_worker_data->pbi->max_threads =
 421         (ctx->frame_parallel_decode == 0) ? ctx->cfg.threads : 0;
 422
 423     frame_worker_data->pbi->inv_tile_order = ctx->invert_tile_order;
 424     frame_worker_data->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
 425     frame_worker_data->pbi->common.frame_parallel_decode =
 426         ctx->frame_parallel_decode;
 427     worker->hook = (VP9WorkerHook)frame_worker_hook;
 428     if (!winterface->reset(worker)) {
 429       set_error_detail(ctx, "Frame Worker thread creation failed");
 430       return VPX_CODEC_MEM_ERROR;
 431     }
 432   }
 433
 434   // If postprocessing was enabled by the application and a
 435   // configuration has not been provided, default it.
 436   if (!ctx->postproc_cfg_set &&
 437       (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
 438     set_default_ppflags(&ctx->postproc_cfg);
 439
 440   init_buffer_callbacks(ctx);
 441
 442   return VPX_CODEC_OK;
 443 }
 444
 445 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
 446                                   const uint8_t **data, unsigned int data_sz,
 447                                   void *user_priv, int64_t deadline) {
 448   vp9_ppflags_t flags = {0, 0, 0};
 449   const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
 450   (void)deadline;
 451
 452   // Determine the stream parameters. Note that we rely on peek_si to
 453   // validate that we have a buffer that does not wrap around the top
 454   // of the heap.
 455   if (!ctx->si.h) {
 456     int is_intra_only = 0;
 457     const vpx_codec_err_t res =
 458         decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
 459                                  ctx->decrypt_cb, ctx->decrypt_state);
 460     if (res != VPX_CODEC_OK)
 461       return res;
 462
 463     if (!ctx->si.is_kf && !is_intra_only)
 464       return VPX_CODEC_ERROR;
 465   }
 466
 467   if (!ctx->frame_parallel_decode) {
 468     VP9Worker *const worker = ctx->frame_workers;
 469     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 470     frame_worker_data->data = *data;
 471     frame_worker_data->data_size = data_sz;
 472     frame_worker_data->user_priv = user_priv;
 473
 474     // Set these even if already initialized.  The caller may have changed the
 475     // decrypt config between frames.
 476     frame_worker_data->pbi->decrypt_cb = ctx->decrypt_cb;
 477     frame_worker_data->pbi->decrypt_state = ctx->decrypt_state;
 478
 479     worker->had_error = 0;
 480     winterface->execute(worker);
 481
 482     // Update data pointer after decode.
 483     *data = frame_worker_data->data_end;
 484
 485     if (worker->had_error)
 486       return update_error_state(ctx, &frame_worker_data->pbi->common.error);
 487   } else {
 488     const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
 489     VP9Worker *const worker = &ctx->frame_workers[ctx->next_submit_worker_id];
 490     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 491     // Copy context from last worker thread to next worker thread.
 492     if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
 493       vp9_frameworker_copy_context(
 494           &ctx->frame_workers[ctx->next_submit_worker_id],
 495           &ctx->frame_workers[ctx->last_submit_worker_id]);
 496
 497     frame_worker_data->pbi->ready_for_new_data = 0;
 498     // Copy the compressed data into worker's internal buffer.
 499     // TODO(hkuang): Will all the workers allocate the same size
 500     // as the size of the first intra frame be better? This will
 501     // avoid too many deallocate and allocate.
 502     if (frame_worker_data->scratch_buffer_size < data_sz) {
 503       frame_worker_data->scratch_buffer =
 504           (uint8_t *)vpx_realloc(frame_worker_data->scratch_buffer, data_sz);
 505       if (frame_worker_data->scratch_buffer == NULL) {
 506         set_error_detail(ctx, "Failed to reallocate scratch buffer");
 507         return VPX_CODEC_MEM_ERROR;
 508       }
 509       frame_worker_data->scratch_buffer_size = data_sz;
 510     }
 511     frame_worker_data->data_size = data_sz;
 512     vpx_memcpy(frame_worker_data->scratch_buffer, *data, data_sz);
 513
 514     frame_worker_data->frame_decoded = 0;
 515     frame_worker_data->frame_context_ready = 0;
 516     frame_worker_data->data = frame_worker_data->scratch_buffer;
 517     frame_worker_data->user_priv = user_priv;
 518
 519     if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
 520       ctx->last_submit_worker_id =
 521           (ctx->last_submit_worker_id + 1) % ctx->num_frame_workers;
 522
 523     ctx->next_submit_worker_id =
 524         (ctx->next_submit_worker_id + 1) % ctx->num_frame_workers;
 525     --ctx->available_threads;
 526     worker->had_error = 0;
 527     winterface->launch(worker);
 528   }
 529
 530   if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
 531     set_ppflags(ctx, &flags);
 532
 533   return VPX_CODEC_OK;
 534 }
 535
 536 static void wait_worker_and_cache_frame(vpx_codec_alg_priv_t *ctx) {
 537   YV12_BUFFER_CONFIG sd;
 538   vp9_ppflags_t flags = {0, 0, 0};
 539   const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
 540   VP9Worker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
 541   FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 542   ctx->next_output_worker_id =
 543       (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
 544   winterface->sync(worker);
 545   ++ctx->available_threads;
 546   if (vp9_get_raw_frame(frame_worker_data->pbi, &sd, &flags) == 0) {
 547     VP9_COMMON *const cm = &frame_worker_data->pbi->common;
 548     RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
 549     ctx->frame_cache[ctx->frame_cache_write].fb_idx = cm->new_fb_idx;
 550     yuvconfig2image(&ctx->frame_cache[ctx->frame_cache_write].img, &sd,
 551                     frame_worker_data->user_priv);
 552     ctx->frame_cache[ctx->frame_cache_write].img.fb_priv =
 553         frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
 554     ctx->frame_cache_write =
 555         (ctx->frame_cache_write + 1) % FRAME_CACHE_SIZE;
 556     ++ctx->num_cache_frames;
 557   }
 558 }
 559
 560 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
 561                                       const uint8_t *data, unsigned int data_sz,
 562                                       void *user_priv, long deadline) {
 563   const uint8_t *data_start = data;
 564   const uint8_t * const data_end = data + data_sz;
 565   vpx_codec_err_t res;
 566   uint32_t frame_sizes[8];
 567   int frame_count;
 568
 569   if (data == NULL && data_sz == 0) {
 570     ctx->flushed = 1;
 571     return VPX_CODEC_OK;
 572   }
 573
 574   // Reset flushed when receiving a valid frame.
 575   ctx->flushed = 0;
 576
 577   // Initialize the decoder workers on the first frame.
 578   if (ctx->frame_workers == NULL) {
 579     const vpx_codec_err_t res = init_decoder(ctx);
 580     if (res != VPX_CODEC_OK)
 581       return res;
 582   }
 583
 584   res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
 585                                    ctx->decrypt_cb, ctx->decrypt_state);
 586   if (res != VPX_CODEC_OK)
 587     return res;
 588
 589   if (ctx->frame_parallel_decode) {
 590     // Decode in frame parallel mode. When decoding in this mode, the frame
 591     // passed to the decoder must be either a normal frame or a superframe with
 592     // superframe index so the decoder could get each frame's start position
 593     // in the superframe.
 594     if (frame_count > 0) {
 595       int i;
 596
 597       for (i = 0; i < frame_count; ++i) {
 598         const uint8_t *data_start_copy = data_start;
 599         const uint32_t frame_size = frame_sizes[i];
 600         if (data_start < data
 601             || frame_size > (uint32_t) (data_end - data_start)) {
 602           set_error_detail(ctx, "Invalid frame size in index");
 603           return VPX_CODEC_CORRUPT_FRAME;
 604         }
 605
 606         if (ctx->available_threads == 0) {
 607           // No more threads for decoding. Wait until the next output worker
 608           // finishes decoding. Then copy the decoded frame into cache.
 609           if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
 610             wait_worker_and_cache_frame(ctx);
 611           } else {
 612             // TODO(hkuang): Add unit test to test this path.
 613             set_error_detail(ctx, "Frame output cache is full.");
 614             return VPX_CODEC_ERROR;
 615           }
 616         }
 617
 618         res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
 619                          deadline);
 620         if (res != VPX_CODEC_OK)
 621           return res;
 622         data_start += frame_size;
 623       }
 624     } else {
 625       if (ctx->available_threads == 0) {
 626         // No more threads for decoding. Wait until the next output worker
 627         // finishes decoding. Then copy the decoded frame into cache.
 628         if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
 629           wait_worker_and_cache_frame(ctx);
 630         } else {
 631           // TODO(hkuang): Add unit test to test this path.
 632           set_error_detail(ctx, "Frame output cache is full.");
 633           return VPX_CODEC_ERROR;
 634         }
 635       }
 636
 637       res = decode_one(ctx, &data, data_sz, user_priv, deadline);
 638       if (res != VPX_CODEC_OK)
 639         return res;
 640     }
 641   } else {
 642     // Decode in serial mode.
 643     if (frame_count > 0) {
 644       int i;
 645
 646       for (i = 0; i < frame_count; ++i) {
 647         const uint8_t *data_start_copy = data_start;
 648         const uint32_t frame_size = frame_sizes[i];
 649         vpx_codec_err_t res;
 650         if (data_start < data
 651             || frame_size > (uint32_t) (data_end - data_start)) {
 652           set_error_detail(ctx, "Invalid frame size in index");
 653           return VPX_CODEC_CORRUPT_FRAME;
 654         }
 655
 656         res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
 657                          deadline);
 658         if (res != VPX_CODEC_OK)
 659           return res;
 660
 661         data_start += frame_size;
 662       }
 663     } else {
 664       while (data_start < data_end) {
 665         const uint32_t frame_size = (uint32_t) (data_end - data_start);
 666         const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
 667                                                user_priv, deadline);
 668         if (res != VPX_CODEC_OK)
 669           return res;
 670
 671         // Account for suboptimal termination by the encoder.
 672         while (data_start < data_end) {
 673           const uint8_t marker = read_marker(ctx->decrypt_cb,
 674                                              ctx->decrypt_state, data_start);
 675           if (marker)
 676             break;
 677           ++data_start;
 678         }
 679       }
 680     }
 681   }
 682
 683   return res;
 684 }
 685
 686 static void release_last_output_frame(vpx_codec_alg_priv_t *ctx) {
 687   RefCntBuffer *const frame_bufs = ctx->buffer_pool->frame_bufs;
 688   // Decrease reference count of last output frame in frame parallel mode.
 689   if (ctx->frame_parallel_decode && ctx->last_show_frame >= 0) {
 690     BufferPool *const pool = ctx->buffer_pool;
 691     lock_buffer_pool(pool);
 692     decrease_ref_count(ctx->last_show_frame, frame_bufs, pool);
 693     unlock_buffer_pool(pool);
 694   }
 695 }
 696
 697 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
 698                                       vpx_codec_iter_t *iter) {
 699   vpx_image_t *img = NULL;
 700
 701   // Only return frame when all the cpu are busy or
 702   // application fluhsed the decoder in frame parallel decode.
 703   if (ctx->frame_parallel_decode && ctx->available_threads > 0 &&
 704       !ctx->flushed) {
 705     return img;
 706   }
 707
 708   // Output the frames in the cache first.
 709   if (ctx->num_cache_frames > 0) {
 710     release_last_output_frame(ctx);
 711     ctx->last_show_frame  = ctx->frame_cache[ctx->frame_cache_read].fb_idx;
 712     img = &ctx->frame_cache[ctx->frame_cache_read].img;
 713     ctx->frame_cache_read = (ctx->frame_cache_read + 1) % FRAME_CACHE_SIZE;
 714     --ctx->num_cache_frames;
 715     return img;
 716   }
 717
 718   // iter acts as a flip flop, so an image is only returned on the first
 719   // call to get_frame.
 720   if (*iter == NULL && ctx->frame_workers != NULL) {
 721     do {
 722       YV12_BUFFER_CONFIG sd;
 723       vp9_ppflags_t flags = {0, 0, 0};
 724       const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
 725       VP9Worker *const worker =
 726           &ctx->frame_workers[ctx->next_output_worker_id];
 727       FrameWorkerData *const frame_worker_data =
 728           (FrameWorkerData *)worker->data1;
 729       ctx->next_output_worker_id =
 730           (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
 731       // Wait for the frame from worker thread.
 732       if (!winterface->sync(worker)) {
 733         // Decoding failed. Release the worker thread.
 734         ++ctx->available_threads;
 735         if (ctx->flushed != 1)
 736           return img;
 737       } else if (vp9_get_raw_frame(frame_worker_data->pbi, &sd, &flags) == 0) {
 738         VP9_COMMON *const cm = &frame_worker_data->pbi->common;
 739         RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
 740         ++ctx->available_threads;
 741         release_last_output_frame(ctx);
 742         ctx->last_show_frame = frame_worker_data->pbi->common.new_fb_idx;
 743         yuvconfig2image(&ctx->img, &sd, frame_worker_data->user_priv);
 744         ctx->img.fb_priv = frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
 745         img = &ctx->img;
 746         return img;
 747       }
 748     } while (ctx->next_output_worker_id != ctx->next_submit_worker_id);
 749   }
 750   return img;
 751 }
 752
 753 static vpx_codec_err_t decoder_set_fb_fn(
 754     vpx_codec_alg_priv_t *ctx,
 755     vpx_get_frame_buffer_cb_fn_t cb_get,
 756     vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
 757   if (cb_get == NULL || cb_release == NULL) {
 758     return VPX_CODEC_INVALID_PARAM;
 759   } else if (ctx->frame_workers == NULL) {
 760     // If the decoder has already been initialized, do not accept changes to
 761     // the frame buffer functions.
 762     ctx->get_ext_fb_cb = cb_get;
 763     ctx->release_ext_fb_cb = cb_release;
 764     ctx->ext_priv = cb_priv;
 765     return VPX_CODEC_OK;
 766   }
 767
 768   return VPX_CODEC_ERROR;
 769 }
 770
 771 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
 772                                           va_list args) {
 773   vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
 774
 775   // Only support this function in serial decode.
 776   if (ctx->frame_parallel_decode) {
 777     set_error_detail(ctx, "Not supported in frame parallel decode");
 778     return VPX_CODEC_INCAPABLE;
 779   }
 780
 781   if (data) {
 782     vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
 783     YV12_BUFFER_CONFIG sd;
 784     VP9Worker *const worker = ctx->frame_workers;
 785     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 786     image2yuvconfig(&frame->img, &sd);
 787     return vp9_set_reference_dec(&frame_worker_data->pbi->common,
 788                                  (VP9_REFFRAME)frame->frame_type, &sd);
 789   } else {
 790     return VPX_CODEC_INVALID_PARAM;
 791   }
 792 }
 793
 794 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
 795                                            va_list args) {
 796   vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
 797
 798   // Only support this function in serial decode.
 799   if (ctx->frame_parallel_decode) {
 800     set_error_detail(ctx, "Not supported in frame parallel decode");
 801     return VPX_CODEC_INCAPABLE;
 802   }
 803
 804   if (data) {
 805     vpx_ref_frame_t *frame = (vpx_ref_frame_t *) data;
 806     YV12_BUFFER_CONFIG sd;
 807     VP9Worker *const worker = ctx->frame_workers;
 808     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 809     image2yuvconfig(&frame->img, &sd);
 810     return vp9_copy_reference_dec(frame_worker_data->pbi,
 811                                   (VP9_REFFRAME)frame->frame_type, &sd);
 812   } else {
 813     return VPX_CODEC_INVALID_PARAM;
 814   }
 815 }
 816
 817 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
 818                                           va_list args) {
 819   vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
 820
 821   // Only support this function in serial decode.
 822   if (ctx->frame_parallel_decode) {
 823     set_error_detail(ctx, "Not supported in frame parallel decode");
 824     return VPX_CODEC_INCAPABLE;
 825   }
 826
 827   if (data) {
 828     YV12_BUFFER_CONFIG* fb;
 829     VP9Worker *const worker = ctx->frame_workers;
 830     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
 831     fb = get_ref_frame(&frame_worker_data->pbi->common, data->idx);
 832     if (fb == NULL) return VPX_CODEC_ERROR;
 833     yuvconfig2image(&data->img, fb, NULL);
 834     return VPX_CODEC_OK;
 835   } else {
 836     return VPX_CODEC_INVALID_PARAM;
 837   }
 838 }
 839
 840 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
 841                                          va_list args) {
 842 #if CONFIG_VP9_POSTPROC
 843   vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
 844
 845   if (data) {
 846     ctx->postproc_cfg_set = 1;
 847     ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
 848     return VPX_CODEC_OK;
 849   } else {
 850     return VPX_CODEC_INVALID_PARAM;
 851   }
 852 #else
 853   (void)ctx;
 854   (void)args;
 855   return VPX_CODEC_INCAPABLE;
 856 #endif
 857 }
 858
 859 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
 860                                             va_list args) {
 861   (void)ctx;
 862   (void)args;
 863   return VPX_CODEC_INCAPABLE;
 864 }
 865
 866 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
 867                                                  va_list args) {
 868   int *const update_info = va_arg(args, int *);
 869
 870   // Only support this function in serial decode.
 871   if (ctx->frame_parallel_decode) {
 872     set_error_detail(ctx, "Not supported in frame parallel decode");
 873     return VPX_CODEC_INCAPABLE;
 874   }
 875
 876   if (update_info) {
 877     if (ctx->frame_workers) {
 878       VP9Worker *const worker = ctx->frame_workers;
 879       FrameWorkerData *const frame_worker_data =
 880           (FrameWorkerData *)worker->data1;
 881       *update_info = frame_worker_data->pbi->refresh_frame_flags;
 882     } else {
 883       return VPX_CODEC_ERROR;
 884     }
 885     return VPX_CODEC_OK;
 886   } else {
 887     return VPX_CODEC_INVALID_PARAM;
 888   }
 889 }
 890
 891 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
 892                                                 va_list args) {
 893   int *corrupted = va_arg(args, int *);
 894
 895   if (corrupted) {
 896     if (ctx->frame_workers) {
 897       VP9Worker *const worker = ctx->frame_workers;
 898       FrameWorkerData *const frame_worker_data =
 899           (FrameWorkerData *)worker->data1;
 900       RefCntBuffer *const frame_bufs =
 901           frame_worker_data->pbi->common.buffer_pool->frame_bufs;
 902       if (frame_worker_data->pbi->common.frame_to_show == NULL)
 903         return VPX_CODEC_ERROR;
 904       *corrupted = frame_bufs[ctx->last_show_frame].buf.corrupted;
 905     } else {
 906       return VPX_CODEC_ERROR;
 907     }
 908     return VPX_CODEC_OK;
 909   } else {
 910     return VPX_CODEC_INVALID_PARAM;
 911   }
 912 }
 913
 914 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
 915                                              va_list args) {
 916   int *const display_size = va_arg(args, int *);
 917
 918   // Only support this function in serial decode.
 919   if (ctx->frame_parallel_decode) {
 920     set_error_detail(ctx, "Not supported in frame parallel decode");
 921     return VPX_CODEC_INCAPABLE;
 922   }
 923
 924   if (display_size) {
 925     if (ctx->frame_workers) {
 926       VP9Worker *const worker = ctx->frame_workers;
 927       FrameWorkerData *const frame_worker_data =
 928           (FrameWorkerData *)worker->data1;
 929       const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
 930       display_size[0] = cm->display_width;
 931       display_size[1] = cm->display_height;
 932     } else {
 933       return VPX_CODEC_ERROR;
 934     }
 935     return VPX_CODEC_OK;
 936   } else {
 937     return VPX_CODEC_INVALID_PARAM;
 938   }
 939 }
 940
 941 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
 942                                           va_list args) {
 943   unsigned int *const bit_depth = va_arg(args, unsigned int *);
 944   VP9Worker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
 945
 946   if (bit_depth) {
 947     if (worker) {
 948       FrameWorkerData *const frame_worker_data =
 949           (FrameWorkerData *)worker->data1;
 950       const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
 951       *bit_depth = cm->bit_depth;
 952       return VPX_CODEC_OK;
 953     } else {
 954       return VPX_CODEC_ERROR;
 955     }
 956   } else {
 957     return VPX_CODEC_INVALID_PARAM;
 958   }
 959 }
 960
 961 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
 962                                                   va_list args) {
 963   ctx->invert_tile_order = va_arg(args, int);
 964   return VPX_CODEC_OK;
 965 }
 966
 967 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
 968                                           va_list args) {
 969   vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
 970   ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
 971   ctx->decrypt_state = init ? init->decrypt_state : NULL;
 972   return VPX_CODEC_OK;
 973 }
 974
 975 static vpx_codec_err_t ctrl_set_byte_alignment(vpx_codec_alg_priv_t *ctx,
 976                                                va_list args) {
 977   const int legacy_byte_alignment = 0;
 978   const int min_byte_alignment = 32;
 979   const int max_byte_alignment = 1024;
 980   const int byte_alignment = va_arg(args, int);
 981
 982   if (byte_alignment != legacy_byte_alignment &&
 983       (byte_alignment < min_byte_alignment ||
 984        byte_alignment > max_byte_alignment ||
 985        (byte_alignment & (byte_alignment - 1)) != 0))
 986     return VPX_CODEC_INVALID_PARAM;
 987
 988   ctx->byte_alignment = byte_alignment;
 989   if (ctx->frame_workers) {
 990     VP9Worker *const worker = ctx->frame_workers;
 991     FrameWorkerData *const frame_worker_data =
 992         (FrameWorkerData *)worker->data1;
 993     frame_worker_data->pbi->common.byte_alignment = byte_alignment;
 994   }
 995   return VPX_CODEC_OK;
 996 }
 997
 998 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
 999   {VP8_COPY_REFERENCE,            ctrl_copy_reference},
1000
1001   // Setters
1002   {VP8_SET_REFERENCE,             ctrl_set_reference},
1003   {VP8_SET_POSTPROC,              ctrl_set_postproc},
1004   {VP8_SET_DBG_COLOR_REF_FRAME,   ctrl_set_dbg_options},
1005   {VP8_SET_DBG_COLOR_MB_MODES,    ctrl_set_dbg_options},
1006   {VP8_SET_DBG_COLOR_B_MODES,     ctrl_set_dbg_options},
1007   {VP8_SET_DBG_DISPLAY_MV,        ctrl_set_dbg_options},
1008   {VP9_INVERT_TILE_DECODE_ORDER,  ctrl_set_invert_tile_order},
1009   {VPXD_SET_DECRYPTOR,            ctrl_set_decryptor},
1010   {VP9_SET_BYTE_ALIGNMENT,        ctrl_set_byte_alignment},
1011
1012   // Getters
1013   {VP8D_GET_LAST_REF_UPDATES,     ctrl_get_last_ref_updates},
1014   {VP8D_GET_FRAME_CORRUPTED,      ctrl_get_frame_corrupted},
1015   {VP9_GET_REFERENCE,             ctrl_get_reference},
1016   {VP9D_GET_DISPLAY_SIZE,         ctrl_get_display_size},
1017   {VP9D_GET_BIT_DEPTH,            ctrl_get_bit_depth},
1018
1019   { -1, NULL},
1020 };
1021
1022 #ifndef VERSION_STRING
1023 #define VERSION_STRING
1024 #endif
1025 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
1026   "WebM Project VP9 Decoder" VERSION_STRING,
1027   VPX_CODEC_INTERNAL_ABI_VERSION,
1028   VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
1029       VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER,  // vpx_codec_caps_t
1030   decoder_init,       // vpx_codec_init_fn_t
1031   decoder_destroy,    // vpx_codec_destroy_fn_t
1032   decoder_ctrl_maps,  // vpx_codec_ctrl_fn_map_t
1033   { // NOLINT
1034     decoder_peek_si,    // vpx_codec_peek_si_fn_t
1035     decoder_get_si,     // vpx_codec_get_si_fn_t
1036     decoder_decode,     // vpx_codec_decode_fn_t
1037     decoder_get_frame,  // vpx_codec_frame_get_fn_t
1038     decoder_set_fb_fn,  // vpx_codec_set_fb_fn_t
1039   },
1040   { // NOLINT
1041     0,
1042     NULL,  // vpx_codec_enc_cfg_map_t
1043     NULL,  // vpx_codec_encode_fn_t
1044     NULL,  // vpx_codec_get_cx_data_fn_t
1045     NULL,  // vpx_codec_enc_config_set_fn_t
1046     NULL,  // vpx_codec_get_global_headers_fn_t
1047     NULL,  // vpx_codec_get_preview_frame_fn_t
1048     NULL   // vpx_codec_enc_mr_get_mem_loc_fn_t
1049   }
1050 };