av1_dx_iface.c 45.2 KB
Newer Older
Jingning Han's avatar
Jingning Han committed
1
/*
Yaowu Xu's avatar
Yaowu Xu committed
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
Jingning Han's avatar
Jingning Han committed
3
 *
Yaowu Xu's avatar
Yaowu Xu committed
4 5 6 7 8 9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
Jingning Han's avatar
Jingning Han committed
10 11 12 13 14
 */

#include <stdlib.h>
#include <string.h>

Yaowu Xu's avatar
Yaowu Xu committed
15 16
#include "./aom_config.h"
#include "./aom_version.h"
Jingning Han's avatar
Jingning Han committed
17

Yaowu Xu's avatar
Yaowu Xu committed
18 19 20
#include "aom/internal/aom_codec_internal.h"
#include "aom/aomdx.h"
#include "aom/aom_decoder.h"
21
#include "aom_dsp/bitreader_buffer.h"
Yaowu Xu's avatar
Yaowu Xu committed
22 23
#include "aom_dsp/aom_dsp_common.h"
#include "aom_util/aom_thread.h"
Jingning Han's avatar
Jingning Han committed
24

25 26 27
#include "av1/common/alloccommon.h"
#include "av1/common/frame_buffers.h"
#include "av1/common/enums.h"
Jingning Han's avatar
Jingning Han committed
28

29 30
#include "av1/decoder/decoder.h"
#include "av1/decoder/decodeframe.h"
Jingning Han's avatar
Jingning Han committed
31

Yaowu Xu's avatar
Yaowu Xu committed
32
#include "av1/av1_iface_common.h"
Jingning Han's avatar
Jingning Han committed
33 34 35

// This limit is due to framebuffer numbers.
// TODO(hkuang): Remove this limit after implementing ondemand framebuffers.
36
#define FRAME_CACHE_SIZE 6  // Cache maximum 6 decoded frames.
Jingning Han's avatar
Jingning Han committed
37 38 39

typedef struct cache_frame {
  int fb_idx;
Yaowu Xu's avatar
Yaowu Xu committed
40
  aom_image_t img;
Jingning Han's avatar
Jingning Han committed
41 42
} cache_frame;

Yaowu Xu's avatar
Yaowu Xu committed
43 44 45
struct aom_codec_alg_priv {
  aom_codec_priv_t base;
  aom_codec_dec_cfg_t cfg;
46
  aom_codec_stream_info_t si;
47
  int postproc_cfg_set;
Yaowu Xu's avatar
Yaowu Xu committed
48 49
  aom_postproc_cfg_t postproc_cfg;
  aom_image_t img;
50 51 52 53 54 55 56 57
  int img_avail;
  int flushed;
  int invert_tile_order;
  int last_show_frame;  // Index of last output frame.
  int byte_alignment;
  int skip_loop_filter;
  int decode_tile_row;
  int decode_tile_col;
Jingning Han's avatar
Jingning Han committed
58 59

  // Frame parallel related.
60
  int frame_parallel_decode;  // frame-based threading.
Yaowu Xu's avatar
Yaowu Xu committed
61
  AVxWorker *frame_workers;
62 63 64 65 66 67 68 69 70 71
  int num_frame_workers;
  int next_submit_worker_id;
  int last_submit_worker_id;
  int next_output_worker_id;
  int available_threads;
  cache_frame frame_cache[FRAME_CACHE_SIZE];
  int frame_cache_write;
  int frame_cache_read;
  int num_cache_frames;
  int need_resync;  // wait for key/intra-only frame
Jingning Han's avatar
Jingning Han committed
72
  // BufferPool that holds all reference frames. Shared by all the FrameWorkers.
73
  BufferPool *buffer_pool;
Jingning Han's avatar
Jingning Han committed
74

Yaowu Xu's avatar
Yaowu Xu committed
75
  // External frame buffer info to save for AV1 common.
Jingning Han's avatar
Jingning Han committed
76
  void *ext_priv;  // Private data associated with the external frame buffers.
Yaowu Xu's avatar
Yaowu Xu committed
77 78
  aom_get_frame_buffer_cb_fn_t get_ext_fb_cb;
  aom_release_frame_buffer_cb_fn_t release_ext_fb_cb;
79 80 81 82 83

#if CONFIG_INSPECTION
  aom_inspect_cb inspect_cb;
  void *inspect_ctx;
#endif
Jingning Han's avatar
Jingning Han committed
84 85
};

Yaowu Xu's avatar
Yaowu Xu committed
86 87 88
static aom_codec_err_t decoder_init(aom_codec_ctx_t *ctx,
                                    aom_codec_priv_enc_mr_cfg_t *data) {
  // This function only allocates space for the aom_codec_alg_priv_t
Jingning Han's avatar
Jingning Han committed
89 90 91 92 93
  // structure. More memory may be required at the time the stream
  // information becomes known.
  (void)data;

  if (!ctx->priv) {
Yaowu Xu's avatar
Yaowu Xu committed
94 95 96
    aom_codec_alg_priv_t *const priv =
        (aom_codec_alg_priv_t *)aom_calloc(1, sizeof(*priv));
    if (priv == NULL) return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
97

Yaowu Xu's avatar
Yaowu Xu committed
98
    ctx->priv = (aom_codec_priv_t *)priv;
Jingning Han's avatar
Jingning Han committed
99 100 101 102 103
    ctx->priv->init_flags = ctx->init_flags;
    priv->flushed = 0;
    // Only do frame parallel decode when threads > 1.
    priv->frame_parallel_decode =
        (ctx->config.dec && (ctx->config.dec->threads > 1) &&
Yaowu Xu's avatar
Yaowu Xu committed
104
         (ctx->init_flags & AOM_CODEC_USE_FRAME_THREADING))
105 106
            ? 1
            : 0;
107 108
    // TODO(tdaede): this should not be exposed to the API
    priv->cfg.allow_lowbitdepth = CONFIG_LOWBITDEPTH;
Jingning Han's avatar
Jingning Han committed
109 110 111 112 113 114
    if (ctx->config.dec) {
      priv->cfg = *ctx->config.dec;
      ctx->config.dec = &priv->cfg;
    }
  }

Yaowu Xu's avatar
Yaowu Xu committed
115
  return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
116 117
}

Yaowu Xu's avatar
Yaowu Xu committed
118
static aom_codec_err_t decoder_destroy(aom_codec_alg_priv_t *ctx) {
Jingning Han's avatar
Jingning Han committed
119 120 121
  if (ctx->frame_workers != NULL) {
    int i;
    for (i = 0; i < ctx->num_frame_workers; ++i) {
Yaowu Xu's avatar
Yaowu Xu committed
122
      AVxWorker *const worker = &ctx->frame_workers[i];
Jingning Han's avatar
Jingning Han committed
123 124
      FrameWorkerData *const frame_worker_data =
          (FrameWorkerData *)worker->data1;
Yaowu Xu's avatar
Yaowu Xu committed
125
      aom_get_worker_interface()->end(worker);
Yaowu Xu's avatar
Yaowu Xu committed
126 127 128 129
#if CONFIG_MFMV
      aom_free(frame_worker_data->pbi->common.tpl_mvs);
      frame_worker_data->pbi->common.tpl_mvs = NULL;
#endif
Yaowu Xu's avatar
Yaowu Xu committed
130
      av1_remove_common(&frame_worker_data->pbi->common);
Debargha Mukherjee's avatar
Debargha Mukherjee committed
131
#if CONFIG_LOOP_RESTORATION
Yaowu Xu's avatar
Yaowu Xu committed
132
      av1_free_restoration_buffers(&frame_worker_data->pbi->common);
Debargha Mukherjee's avatar
Debargha Mukherjee committed
133
#endif  // CONFIG_LOOP_RESTORATION
Yaowu Xu's avatar
Yaowu Xu committed
134 135
      av1_decoder_remove(frame_worker_data->pbi);
      aom_free(frame_worker_data->scratch_buffer);
Jingning Han's avatar
Jingning Han committed
136 137 138 139
#if CONFIG_MULTITHREAD
      pthread_mutex_destroy(&frame_worker_data->stats_mutex);
      pthread_cond_destroy(&frame_worker_data->stats_cond);
#endif
Yaowu Xu's avatar
Yaowu Xu committed
140
      aom_free(frame_worker_data);
Jingning Han's avatar
Jingning Han committed
141 142 143 144 145 146 147
    }
#if CONFIG_MULTITHREAD
    pthread_mutex_destroy(&ctx->buffer_pool->pool_mutex);
#endif
  }

  if (ctx->buffer_pool) {
Yaowu Xu's avatar
Yaowu Xu committed
148 149
    av1_free_ref_frame_buffers(ctx->buffer_pool);
    av1_free_internal_frame_buffers(&ctx->buffer_pool->int_frame_buffers);
Jingning Han's avatar
Jingning Han committed
150 151
  }

Yaowu Xu's avatar
Yaowu Xu committed
152 153 154 155
  aom_free(ctx->frame_workers);
  aom_free(ctx->buffer_pool);
  aom_free(ctx);
  return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
156 157
}

158
#if !CONFIG_OBU
159
static int parse_bitdepth_colorspace_sampling(BITSTREAM_PROFILE profile,
Yaowu Xu's avatar
Yaowu Xu committed
160
                                              struct aom_read_bit_buffer *rb) {
Andrey Norkin's avatar
Andrey Norkin committed
161 162 163 164 165
#if CONFIG_CICP
  aom_color_primaries_t color_primaries;
  aom_transfer_characteristics_t transfer_characteristics;
  aom_matrix_coefficients_t matrix_coefficients;
#else
Yaowu Xu's avatar
Yaowu Xu committed
166
  aom_color_space_t color_space;
Andrey Norkin's avatar
Andrey Norkin committed
167
#endif
168 169 170 171 172
#if CONFIG_COLORSPACE_HEADERS
  int subsampling_x = 0;
  int subsampling_y = 0;
#endif

173
  if (profile >= PROFILE_2) rb->bit_offset += 1;  // Bit-depth 10 or 12.
Andrey Norkin's avatar
Andrey Norkin committed
174 175 176 177 178 179 180 181 182 183 184 185 186
#if CONFIG_CICP
  int color_description_present_flag = aom_rb_read_bit(rb);
  if (color_description_present_flag) {
    color_primaries = (aom_color_primaries_t)aom_rb_read_literal(rb, 8);
    transfer_characteristics =
        (aom_transfer_characteristics_t)aom_rb_read_literal(rb, 8);
    matrix_coefficients = (aom_matrix_coefficients_t)aom_rb_read_literal(rb, 8);
  } else {
    color_primaries = AOM_CICP_CP_UNSPECIFIED;
    transfer_characteristics = AOM_CICP_TC_UNSPECIFIED;
    matrix_coefficients = AOM_CICP_MC_UNSPECIFIED;
  }
#else
187 188 189 190
#if CONFIG_COLORSPACE_HEADERS
  color_space = (aom_color_space_t)aom_rb_read_literal(rb, 5);
  rb->bit_offset += 5;  // Transfer function
#else
191 192
  color_space =
      (aom_color_space_t)aom_rb_read_literal(rb, 3 + CONFIG_MONO_VIDEO);
193
#endif
Andrey Norkin's avatar
Andrey Norkin committed
194 195 196 197 198 199 200 201
#endif
#if CONFIG_CICP
  if (color_primaries == AOM_CICP_CP_BT_709 &&
      transfer_characteristics == AOM_CICP_TC_SRGB &&
      matrix_coefficients == AOM_CICP_MC_IDENTITY) {  // it would be better to
                                                      // remove this dependency
                                                      // too
#else
202
  if (color_space == AOM_CS_SRGB) {
Andrey Norkin's avatar
Andrey Norkin committed
203
#endif
204 205 206 207 208 209
    if (profile == PROFILE_1 || profile == PROFILE_3) {
      rb->bit_offset += 1;  // unused
    } else {
      // RGB is only available in version 1.
      return 0;
    }
Andrey Norkin's avatar
Andrey Norkin committed
210
#if CONFIG_MONO_VIDEO && !CONFIG_CICP
211 212 213 214
  } else if (color_space == AOM_CS_MONOCHROME) {
    return 1;
#endif  // CONFIG_MONO_VIDEO
  } else {
Jingning Han's avatar
Jingning Han committed
215
    rb->bit_offset += 1;  // [16,235] (including xvycc) vs [0,255] range.
216

Jingning Han's avatar
Jingning Han committed
217
    if (profile == PROFILE_1 || profile == PROFILE_3) {
218 219 220 221
#if CONFIG_COLORSPACE_HEADERS
      subsampling_x = aom_rb_read_bit(rb);
      subsampling_y = aom_rb_read_bit(rb);
#else
Jingning Han's avatar
Jingning Han committed
222
      rb->bit_offset += 2;  // subsampling x/y.
223
#endif
Jingning Han's avatar
Jingning Han committed
224
      rb->bit_offset += 1;  // unused.
225 226 227 228 229 230 231
#if CONFIG_COLORSPACE_HEADERS
    } else {
      subsampling_x = 1;
      subsampling_y = 1;
    }
    if (subsampling_x == 1 && subsampling_y == 1) {
      rb->bit_offset += 2;
Jingning Han's avatar
Jingning Han committed
232
    }
233 234 235
#else
    }
#endif
Jingning Han's avatar
Jingning Han committed
236 237 238
  }
  return 1;
}
239
#endif
Jingning Han's avatar
Jingning Han committed
240

241 242 243 244
static aom_codec_err_t decoder_peek_si_internal(const uint8_t *data,
                                                unsigned int data_sz,
                                                aom_codec_stream_info_t *si,
                                                int *is_intra_only) {
Jingning Han's avatar
Jingning Han committed
245 246
  int intra_only_flag = 0;

Yaowu Xu's avatar
Yaowu Xu committed
247
  if (data + data_sz <= data) return AOM_CODEC_INVALID_PARAM;
Jingning Han's avatar
Jingning Han committed
248 249 250 251

  si->is_kf = 0;
  si->w = si->h = 0;

Sebastien Alaiwan's avatar
Sebastien Alaiwan committed
252 253 254 255 256
  // skip a potential superframe index
  {
    uint32_t frame_sizes[8];
    int frame_count;
    int index_size = 0;
257 258
    aom_codec_err_t res = av1_parse_superframe_index(data, data_sz, frame_sizes,
                                                     &frame_count, &index_size);
Sebastien Alaiwan's avatar
Sebastien Alaiwan committed
259 260 261 262
    if (res != AOM_CODEC_OK) return res;

    data += index_size;
    data_sz -= index_size;
263 264 265
#if CONFIG_OBU
    if (data + data_sz <= data) return AOM_CODEC_INVALID_PARAM;
#endif
Sebastien Alaiwan's avatar
Sebastien Alaiwan committed
266 267
  }

Jingning Han's avatar
Jingning Han committed
268
  {
269 270 271 272 273 274
#if CONFIG_OBU
    // Proper fix needed
    si->is_kf = 1;
    intra_only_flag = 1;
    si->h = 1;
#else
Jingning Han's avatar
Jingning Han committed
275 276
    int show_frame;
    int error_resilient;
Yaowu Xu's avatar
Yaowu Xu committed
277 278 279
    struct aom_read_bit_buffer rb = { data, data + data_sz, 0, NULL, NULL };
    const int frame_marker = aom_rb_read_literal(&rb, 2);
    const BITSTREAM_PROFILE profile = av1_read_profile(&rb);
280 281 282
#if CONFIG_EXT_TILE
    unsigned int large_scale_tile;
#endif  // CONFIG_EXT_TILE
Jingning Han's avatar
Jingning Han committed
283

Yaowu Xu's avatar
Yaowu Xu committed
284
    if (frame_marker != AOM_FRAME_MARKER) return AOM_CODEC_UNSUP_BITSTREAM;
Jingning Han's avatar
Jingning Han committed
285

Yaowu Xu's avatar
Yaowu Xu committed
286
    if (profile >= MAX_PROFILES) return AOM_CODEC_UNSUP_BITSTREAM;
Jingning Han's avatar
Jingning Han committed
287 288

    if ((profile >= 2 && data_sz <= 1) || data_sz < 1)
Yaowu Xu's avatar
Yaowu Xu committed
289
      return AOM_CODEC_UNSUP_BITSTREAM;
Jingning Han's avatar
Jingning Han committed
290

291 292 293 294
#if CONFIG_EXT_TILE
    large_scale_tile = aom_rb_read_literal(&rb, 1);
#endif  // CONFIG_EXT_TILE

Yaowu Xu's avatar
Yaowu Xu committed
295 296 297
    if (aom_rb_read_bit(&rb)) {     // show an existing frame
      aom_rb_read_literal(&rb, 3);  // Frame buffer to show.
      return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
298 299
    }

Yaowu Xu's avatar
Yaowu Xu committed
300
    if (data_sz <= 8) return AOM_CODEC_UNSUP_BITSTREAM;
Jingning Han's avatar
Jingning Han committed
301

Yaowu Xu's avatar
Yaowu Xu committed
302 303
    si->is_kf = !aom_rb_read_bit(&rb);
    show_frame = aom_rb_read_bit(&rb);
304 305 306
    if (!si->is_kf) {
      if (!show_frame) intra_only_flag = show_frame ? 0 : aom_rb_read_bit(&rb);
    }
Yaowu Xu's avatar
Yaowu Xu committed
307
    error_resilient = aom_rb_read_bit(&rb);
308
#if CONFIG_REFERENCE_BUFFER
309 310
    SequenceHeader seq_params;
    memset(&seq_params, 0, sizeof(seq_params));
311
    if (si->is_kf) {
312
      /* TODO: Move outside frame loop or inside key-frame branch */
313
      read_sequence_header(&seq_params, &rb);
314
#if CONFIG_EXT_TILE
315
      if (large_scale_tile) seq_params.frame_id_numbers_present_flag = 0;
316
#endif  // CONFIG_EXT_TILE
317 318
    }
#endif  // CONFIG_REFERENCE_BUFFER
319

320
#if CONFIG_REFERENCE_BUFFER
321
    if (seq_params.frame_id_numbers_present_flag) {
322
      aom_rb_read_literal(&rb, seq_params.frame_id_length);
323
    }
324
#endif  // CONFIG_REFERENCE_BUFFER
325 326 327 328 329

#if CONFIG_FRAME_SIZE
    int frame_size_override_flag = aom_rb_read_bit(&rb);
#endif

Jingning Han's avatar
Jingning Han committed
330 331
    if (si->is_kf) {
      if (!parse_bitdepth_colorspace_sampling(profile, &rb))
Yaowu Xu's avatar
Yaowu Xu committed
332
        return AOM_CODEC_UNSUP_BITSTREAM;
333 334 335 336 337 338 339 340 341 342 343
#if CONFIG_FRAME_SIZE
      if (frame_size_override_flag) {
        int num_bits_width = seq_params.num_bits_width;
        int num_bits_height = seq_params.num_bits_height;
        av1_read_frame_size(&rb, num_bits_width, num_bits_height, (int *)&si->w,
                            (int *)&si->h);
      } else {
        si->w = seq_params.max_frame_width;
        si->h = seq_params.max_frame_height;
      }
#else
Yaowu Xu's avatar
Yaowu Xu committed
344
      av1_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
345
#endif
Jingning Han's avatar
Jingning Han committed
346 347 348 349 350 351
    } else {
      rb.bit_offset += error_resilient ? 0 : 2;  // reset_frame_context

      if (intra_only_flag) {
        if (profile > PROFILE_0) {
          if (!parse_bitdepth_colorspace_sampling(profile, &rb))
Yaowu Xu's avatar
Yaowu Xu committed
352
            return AOM_CODEC_UNSUP_BITSTREAM;
Jingning Han's avatar
Jingning Han committed
353 354
        }
        rb.bit_offset += REF_FRAMES;  // refresh_frame_flags
355 356 357 358 359 360 361 362 363 364 365
#if CONFIG_FRAME_SIZE
        if (frame_size_override_flag) {
          int num_bits_width = seq_params.num_bits_width;
          int num_bits_height = seq_params.num_bits_height;
          av1_read_frame_size(&rb, num_bits_width, num_bits_height,
                              (int *)&si->w, (int *)&si->h);
        } else {
          si->w = seq_params.max_frame_width;
          si->h = seq_params.max_frame_height;
        }
#else
Yaowu Xu's avatar
Yaowu Xu committed
366
        av1_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
367
#endif
Jingning Han's avatar
Jingning Han committed
368 369
      }
    }
370
#endif  // CONFIG_OBU
Jingning Han's avatar
Jingning Han committed
371
  }
372
  if (is_intra_only != NULL) *is_intra_only = intra_only_flag;
Yaowu Xu's avatar
Yaowu Xu committed
373
  return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
374 375
}

Yaowu Xu's avatar
Yaowu Xu committed
376
static aom_codec_err_t decoder_peek_si(const uint8_t *data,
Jingning Han's avatar
Jingning Han committed
377
                                       unsigned int data_sz,
Yaowu Xu's avatar
Yaowu Xu committed
378
                                       aom_codec_stream_info_t *si) {
379
  return decoder_peek_si_internal(data, data_sz, si, NULL);
Jingning Han's avatar
Jingning Han committed
380 381
}

Yaowu Xu's avatar
Yaowu Xu committed
382 383
static aom_codec_err_t decoder_get_si(aom_codec_alg_priv_t *ctx,
                                      aom_codec_stream_info_t *si) {
384
  memcpy(si, &ctx->si, sizeof(*si));
Jingning Han's avatar
Jingning Han committed
385

Yaowu Xu's avatar
Yaowu Xu committed
386
  return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
387 388
}

Yaowu Xu's avatar
Yaowu Xu committed
389
static void set_error_detail(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
390 391 392 393
                             const char *const error) {
  ctx->base.err_detail = error;
}

Yaowu Xu's avatar
Yaowu Xu committed
394 395
static aom_codec_err_t update_error_state(
    aom_codec_alg_priv_t *ctx, const struct aom_internal_error_info *error) {
Jingning Han's avatar
Jingning Han committed
396 397 398 399 400 401
  if (error->error_code)
    set_error_detail(ctx, error->has_detail ? error->detail : NULL);

  return error->error_code;
}

Yaowu Xu's avatar
Yaowu Xu committed
402
static void init_buffer_callbacks(aom_codec_alg_priv_t *ctx) {
Jingning Han's avatar
Jingning Han committed
403 404 405
  int i;

  for (i = 0; i < ctx->num_frame_workers; ++i) {
Yaowu Xu's avatar
Yaowu Xu committed
406
    AVxWorker *const worker = &ctx->frame_workers[i];
Jingning Han's avatar
Jingning Han committed
407
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
Yaowu Xu's avatar
Yaowu Xu committed
408
    AV1_COMMON *const cm = &frame_worker_data->pbi->common;
Jingning Han's avatar
Jingning Han committed
409 410 411 412 413 414 415 416 417 418 419
    BufferPool *const pool = cm->buffer_pool;

    cm->new_fb_idx = INVALID_IDX;
    cm->byte_alignment = ctx->byte_alignment;
    cm->skip_loop_filter = ctx->skip_loop_filter;

    if (ctx->get_ext_fb_cb != NULL && ctx->release_ext_fb_cb != NULL) {
      pool->get_fb_cb = ctx->get_ext_fb_cb;
      pool->release_fb_cb = ctx->release_ext_fb_cb;
      pool->cb_priv = ctx->ext_priv;
    } else {
Yaowu Xu's avatar
Yaowu Xu committed
420 421
      pool->get_fb_cb = av1_get_frame_buffer;
      pool->release_fb_cb = av1_release_frame_buffer;
Jingning Han's avatar
Jingning Han committed
422

Yaowu Xu's avatar
Yaowu Xu committed
423 424
      if (av1_alloc_internal_frame_buffers(&pool->int_frame_buffers))
        aom_internal_error(&cm->error, AOM_CODEC_MEM_ERROR,
Jingning Han's avatar
Jingning Han committed
425 426 427 428 429 430 431
                           "Failed to initialize internal frame buffers");

      pool->cb_priv = &pool->int_frame_buffers;
    }
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
432 433
static void set_default_ppflags(aom_postproc_cfg_t *cfg) {
  cfg->post_proc_flag = AOM_DEBLOCK | AOM_DEMACROBLOCK;
Jingning Han's avatar
Jingning Han committed
434 435 436 437 438 439 440 441 442
  cfg->deblocking_level = 4;
  cfg->noise_level = 0;
}

static int frame_worker_hook(void *arg1, void *arg2) {
  FrameWorkerData *const frame_worker_data = (FrameWorkerData *)arg1;
  const uint8_t *data = frame_worker_data->data;
  (void)arg2;

Yaowu Xu's avatar
Yaowu Xu committed
443
  frame_worker_data->result = av1_receive_compressed_data(
444
      frame_worker_data->pbi, frame_worker_data->data_size, &data);
Jingning Han's avatar
Jingning Han committed
445 446
  frame_worker_data->data_end = data;

447
  if (frame_worker_data->pbi->common.frame_parallel_decode) {
Jingning Han's avatar
Jingning Han committed
448 449 450 451
    // In frame parallel decoding, a worker thread must successfully decode all
    // the compressed data.
    if (frame_worker_data->result != 0 ||
        frame_worker_data->data + frame_worker_data->data_size - 1 > data) {
Yaowu Xu's avatar
Yaowu Xu committed
452
      AVxWorker *const worker = frame_worker_data->pbi->frame_worker_owner;
Jingning Han's avatar
Jingning Han committed
453 454
      BufferPool *const pool = frame_worker_data->pbi->common.buffer_pool;
      // Signal all the other threads that are waiting for this frame.
Yaowu Xu's avatar
Yaowu Xu committed
455
      av1_frameworker_lock_stats(worker);
Jingning Han's avatar
Jingning Han committed
456 457 458 459 460
      frame_worker_data->frame_context_ready = 1;
      lock_buffer_pool(pool);
      frame_worker_data->pbi->cur_buf->buf.corrupted = 1;
      unlock_buffer_pool(pool);
      frame_worker_data->pbi->need_resync = 1;
Yaowu Xu's avatar
Yaowu Xu committed
461 462
      av1_frameworker_signal_stats(worker);
      av1_frameworker_unlock_stats(worker);
Jingning Han's avatar
Jingning Han committed
463 464 465 466 467 468 469 470 471 472
      return 0;
    }
  } else if (frame_worker_data->result != 0) {
    // Check decode result in serial decode.
    frame_worker_data->pbi->cur_buf->buf.corrupted = 1;
    frame_worker_data->pbi->need_resync = 1;
  }
  return !frame_worker_data->result;
}

Yaowu Xu's avatar
Yaowu Xu committed
473
static aom_codec_err_t init_decoder(aom_codec_alg_priv_t *ctx) {
Jingning Han's avatar
Jingning Han committed
474
  int i;
Yaowu Xu's avatar
Yaowu Xu committed
475
  const AVxWorkerInterface *const winterface = aom_get_worker_interface();
Jingning Han's avatar
Jingning Han committed
476 477 478 479 480 481 482 483 484 485

  ctx->last_show_frame = -1;
  ctx->next_submit_worker_id = 0;
  ctx->last_submit_worker_id = 0;
  ctx->next_output_worker_id = 0;
  ctx->frame_cache_read = 0;
  ctx->frame_cache_write = 0;
  ctx->num_cache_frames = 0;
  ctx->need_resync = 1;
  ctx->num_frame_workers =
486
      (ctx->frame_parallel_decode == 1) ? ctx->cfg.threads : 1;
Jingning Han's avatar
Jingning Han committed
487 488 489 490 491
  if (ctx->num_frame_workers > MAX_DECODE_THREADS)
    ctx->num_frame_workers = MAX_DECODE_THREADS;
  ctx->available_threads = ctx->num_frame_workers;
  ctx->flushed = 0;

Yaowu Xu's avatar
Yaowu Xu committed
492 493
  ctx->buffer_pool = (BufferPool *)aom_calloc(1, sizeof(BufferPool));
  if (ctx->buffer_pool == NULL) return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
494 495

#if CONFIG_MULTITHREAD
496 497
  if (pthread_mutex_init(&ctx->buffer_pool->pool_mutex, NULL)) {
    set_error_detail(ctx, "Failed to allocate buffer pool mutex");
Yaowu Xu's avatar
Yaowu Xu committed
498
    return AOM_CODEC_MEM_ERROR;
499
  }
Jingning Han's avatar
Jingning Han committed
500 501
#endif

Yaowu Xu's avatar
Yaowu Xu committed
502
  ctx->frame_workers = (AVxWorker *)aom_malloc(ctx->num_frame_workers *
503
                                               sizeof(*ctx->frame_workers));
Jingning Han's avatar
Jingning Han committed
504 505
  if (ctx->frame_workers == NULL) {
    set_error_detail(ctx, "Failed to allocate frame_workers");
Yaowu Xu's avatar
Yaowu Xu committed
506
    return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
507 508 509
  }

  for (i = 0; i < ctx->num_frame_workers; ++i) {
Yaowu Xu's avatar
Yaowu Xu committed
510
    AVxWorker *const worker = &ctx->frame_workers[i];
Jingning Han's avatar
Jingning Han committed
511 512
    FrameWorkerData *frame_worker_data = NULL;
    winterface->init(worker);
Yaowu Xu's avatar
Yaowu Xu committed
513
    worker->data1 = aom_memalign(32, sizeof(FrameWorkerData));
Jingning Han's avatar
Jingning Han committed
514 515
    if (worker->data1 == NULL) {
      set_error_detail(ctx, "Failed to allocate frame_worker_data");
Yaowu Xu's avatar
Yaowu Xu committed
516
      return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
517 518
    }
    frame_worker_data = (FrameWorkerData *)worker->data1;
Yaowu Xu's avatar
Yaowu Xu committed
519
    frame_worker_data->pbi = av1_decoder_create(ctx->buffer_pool);
Jingning Han's avatar
Jingning Han committed
520 521
    if (frame_worker_data->pbi == NULL) {
      set_error_detail(ctx, "Failed to allocate frame_worker_data");
Yaowu Xu's avatar
Yaowu Xu committed
522
      return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
523 524 525 526 527 528 529 530 531 532
    }
    frame_worker_data->pbi->frame_worker_owner = worker;
    frame_worker_data->worker_id = i;
    frame_worker_data->scratch_buffer = NULL;
    frame_worker_data->scratch_buffer_size = 0;
    frame_worker_data->frame_context_ready = 0;
    frame_worker_data->received_frame = 0;
#if CONFIG_MULTITHREAD
    if (pthread_mutex_init(&frame_worker_data->stats_mutex, NULL)) {
      set_error_detail(ctx, "Failed to allocate frame_worker_data mutex");
Yaowu Xu's avatar
Yaowu Xu committed
533
      return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
534 535 536 537
    }

    if (pthread_cond_init(&frame_worker_data->stats_cond, NULL)) {
      set_error_detail(ctx, "Failed to allocate frame_worker_data cond");
Yaowu Xu's avatar
Yaowu Xu committed
538
      return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
539 540
    }
#endif
541 542
    frame_worker_data->pbi->allow_lowbitdepth = ctx->cfg.allow_lowbitdepth;

Jingning Han's avatar
Jingning Han committed
543 544 545 546 547 548 549 550
    // If decoding in serial mode, FrameWorker thread could create tile worker
    // thread or loopfilter thread.
    frame_worker_data->pbi->max_threads =
        (ctx->frame_parallel_decode == 0) ? ctx->cfg.threads : 0;

    frame_worker_data->pbi->inv_tile_order = ctx->invert_tile_order;
    frame_worker_data->pbi->common.frame_parallel_decode =
        ctx->frame_parallel_decode;
Yaowu Xu's avatar
Yaowu Xu committed
551
    worker->hook = (AVxWorkerHook)frame_worker_hook;
Jingning Han's avatar
Jingning Han committed
552 553
    if (!winterface->reset(worker)) {
      set_error_detail(ctx, "Frame Worker thread creation failed");
Yaowu Xu's avatar
Yaowu Xu committed
554
      return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
555 556 557 558 559
    }
  }

  // If postprocessing was enabled by the application and a
  // configuration has not been provided, default it.
Yaowu Xu's avatar
Yaowu Xu committed
560
  if (!ctx->postproc_cfg_set && (ctx->base.init_flags & AOM_CODEC_USE_POSTPROC))
Jingning Han's avatar
Jingning Han committed
561 562 563 564
    set_default_ppflags(&ctx->postproc_cfg);

  init_buffer_callbacks(ctx);

Yaowu Xu's avatar
Yaowu Xu committed
565
  return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
566 567
}

Yaowu Xu's avatar
Yaowu Xu committed
568 569
static INLINE void check_resync(aom_codec_alg_priv_t *const ctx,
                                const AV1Decoder *const pbi) {
Jingning Han's avatar
Jingning Han committed
570 571 572 573 574 575
  // Clear resync flag if worker got a key frame or intra only frame.
  if (ctx->need_resync == 1 && pbi->need_resync == 0 &&
      (pbi->common.intra_only || pbi->common.frame_type == KEY_FRAME))
    ctx->need_resync = 0;
}

Yaowu Xu's avatar
Yaowu Xu committed
576
static aom_codec_err_t decode_one(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
577 578
                                  const uint8_t **data, unsigned int data_sz,
                                  void *user_priv, int64_t deadline) {
Yaowu Xu's avatar
Yaowu Xu committed
579
  const AVxWorkerInterface *const winterface = aom_get_worker_interface();
Jingning Han's avatar
Jingning Han committed
580 581 582 583 584 585 586
  (void)deadline;

  // Determine the stream parameters. Note that we rely on peek_si to
  // validate that we have a buffer that does not wrap around the top
  // of the heap.
  if (!ctx->si.h) {
    int is_intra_only = 0;
Yaowu Xu's avatar
Yaowu Xu committed
587
    const aom_codec_err_t res =
588
        decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only);
Yaowu Xu's avatar
Yaowu Xu committed
589
    if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
590

Yaowu Xu's avatar
Yaowu Xu committed
591
    if (!ctx->si.is_kf && !is_intra_only) return AOM_CODEC_ERROR;
Jingning Han's avatar
Jingning Han committed
592 593 594
  }

  if (!ctx->frame_parallel_decode) {
Yaowu Xu's avatar
Yaowu Xu committed
595
    AVxWorker *const worker = ctx->frame_workers;
Jingning Han's avatar
Jingning Han committed
596 597 598 599 600 601
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
    frame_worker_data->data = *data;
    frame_worker_data->data_size = data_sz;
    frame_worker_data->user_priv = user_priv;
    frame_worker_data->received_frame = 1;

602 603 604 605
#if CONFIG_INSPECTION
    frame_worker_data->pbi->inspect_cb = ctx->inspect_cb;
    frame_worker_data->pbi->inspect_ctx = ctx->inspect_ctx;
#endif
Jingning Han's avatar
Jingning Han committed
606

607
#if CONFIG_EXT_TILE
608 609
    frame_worker_data->pbi->dec_tile_row = ctx->decode_tile_row;
    frame_worker_data->pbi->dec_tile_col = ctx->decode_tile_col;
610 611
#endif  // CONFIG_EXT_TILE

Jingning Han's avatar
Jingning Han committed
612 613 614 615 616 617 618 619 620 621 622
    worker->had_error = 0;
    winterface->execute(worker);

    // Update data pointer after decode.
    *data = frame_worker_data->data_end;

    if (worker->had_error)
      return update_error_state(ctx, &frame_worker_data->pbi->common.error);

    check_resync(ctx, frame_worker_data->pbi);
  } else {
Yaowu Xu's avatar
Yaowu Xu committed
623
    AVxWorker *const worker = &ctx->frame_workers[ctx->next_submit_worker_id];
Jingning Han's avatar
Jingning Han committed
624 625 626
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
    // Copy context from last worker thread to next worker thread.
    if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
Yaowu Xu's avatar
Yaowu Xu committed
627
      av1_frameworker_copy_context(
Jingning Han's avatar
Jingning Han committed
628 629 630 631 632 633 634 635 636
          &ctx->frame_workers[ctx->next_submit_worker_id],
          &ctx->frame_workers[ctx->last_submit_worker_id]);

    frame_worker_data->pbi->ready_for_new_data = 0;
    // Copy the compressed data into worker's internal buffer.
    // TODO(hkuang): Will all the workers allocate the same size
    // as the size of the first intra frame be better? This will
    // avoid too many deallocate and allocate.
    if (frame_worker_data->scratch_buffer_size < data_sz) {
Alex Converse's avatar
Alex Converse committed
637 638
      aom_free(frame_worker_data->scratch_buffer);
      frame_worker_data->scratch_buffer = (uint8_t *)aom_malloc(data_sz);
Jingning Han's avatar
Jingning Han committed
639 640
      if (frame_worker_data->scratch_buffer == NULL) {
        set_error_detail(ctx, "Failed to reallocate scratch buffer");
Yaowu Xu's avatar
Yaowu Xu committed
641
        return AOM_CODEC_MEM_ERROR;
Jingning Han's avatar
Jingning Han committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
      }
      frame_worker_data->scratch_buffer_size = data_sz;
    }
    frame_worker_data->data_size = data_sz;
    memcpy(frame_worker_data->scratch_buffer, *data, data_sz);

    frame_worker_data->frame_decoded = 0;
    frame_worker_data->frame_context_ready = 0;
    frame_worker_data->received_frame = 1;
    frame_worker_data->data = frame_worker_data->scratch_buffer;
    frame_worker_data->user_priv = user_priv;

    if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
      ctx->last_submit_worker_id =
          (ctx->last_submit_worker_id + 1) % ctx->num_frame_workers;

    ctx->next_submit_worker_id =
        (ctx->next_submit_worker_id + 1) % ctx->num_frame_workers;
    --ctx->available_threads;
    worker->had_error = 0;
    winterface->launch(worker);
  }

Yaowu Xu's avatar
Yaowu Xu committed
665
  return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
666 667
}

Yaowu Xu's avatar
Yaowu Xu committed
668
static void wait_worker_and_cache_frame(aom_codec_alg_priv_t *ctx) {
Jingning Han's avatar
Jingning Han committed
669
  YV12_BUFFER_CONFIG sd;
Yaowu Xu's avatar
Yaowu Xu committed
670 671
  const AVxWorkerInterface *const winterface = aom_get_worker_interface();
  AVxWorker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
Jingning Han's avatar
Jingning Han committed
672 673 674 675 676 677 678 679 680 681
  FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
  ctx->next_output_worker_id =
      (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
  // TODO(hkuang): Add worker error handling here.
  winterface->sync(worker);
  frame_worker_data->received_frame = 0;
  ++ctx->available_threads;

  check_resync(ctx, frame_worker_data->pbi);

Yaowu Xu's avatar
Yaowu Xu committed
682 683
  if (av1_get_raw_frame(frame_worker_data->pbi, &sd) == 0) {
    AV1_COMMON *const cm = &frame_worker_data->pbi->common;
Jingning Han's avatar
Jingning Han committed
684 685 686 687 688 689
    RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
    ctx->frame_cache[ctx->frame_cache_write].fb_idx = cm->new_fb_idx;
    yuvconfig2image(&ctx->frame_cache[ctx->frame_cache_write].img, &sd,
                    frame_worker_data->user_priv);
    ctx->frame_cache[ctx->frame_cache_write].img.fb_priv =
        frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
690
    ctx->frame_cache_write = (ctx->frame_cache_write + 1) % FRAME_CACHE_SIZE;
Jingning Han's avatar
Jingning Han committed
691 692 693 694
    ++ctx->num_cache_frames;
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
695
static aom_codec_err_t decoder_decode(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
696 697 698
                                      const uint8_t *data, unsigned int data_sz,
                                      void *user_priv, long deadline) {
  const uint8_t *data_start = data;
699
  const uint8_t *const data_end = data + data_sz;
Yaowu Xu's avatar
Yaowu Xu committed
700
  aom_codec_err_t res = AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
701
  uint32_t frame_sizes[8];
702
  int frame_count = 0;
Jingning Han's avatar
Jingning Han committed
703 704 705

  if (data == NULL && data_sz == 0) {
    ctx->flushed = 1;
Yaowu Xu's avatar
Yaowu Xu committed
706
    return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
707 708 709 710 711 712 713
  }

  // Reset flushed when receiving a valid frame.
  ctx->flushed = 0;

  // Initialize the decoder workers on the first frame.
  if (ctx->frame_workers == NULL) {
714
    res = init_decoder(ctx);
Yaowu Xu's avatar
Yaowu Xu committed
715
    if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
716
  }
717
#if !CONFIG_OBU
718
  int index_size = 0;
Yaowu Xu's avatar
Yaowu Xu committed
719
  res = av1_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
720
                                   &index_size);
Yaowu Xu's avatar
Yaowu Xu committed
721
  if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
722

723
  data_start += index_size;
724
#endif
Jingning Han's avatar
Jingning Han committed
725 726 727 728 729 730 731 732 733 734 735
  if (ctx->frame_parallel_decode) {
    // Decode in frame parallel mode. When decoding in this mode, the frame
    // passed to the decoder must be either a normal frame or a superframe with
    // superframe index so the decoder could get each frame's start position
    // in the superframe.
    if (frame_count > 0) {
      int i;

      for (i = 0; i < frame_count; ++i) {
        const uint8_t *data_start_copy = data_start;
        const uint32_t frame_size = frame_sizes[i];
736 737
        if (data_start < data ||
            frame_size > (uint32_t)(data_end - data_start)) {
Jingning Han's avatar
Jingning Han committed
738
          set_error_detail(ctx, "Invalid frame size in index");
Yaowu Xu's avatar
Yaowu Xu committed
739
          return AOM_CODEC_CORRUPT_FRAME;
Jingning Han's avatar
Jingning Han committed
740 741 742 743 744 745 746 747 748 749
        }

        if (ctx->available_threads == 0) {
          // No more threads for decoding. Wait until the next output worker
          // finishes decoding. Then copy the decoded frame into cache.
          if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
            wait_worker_and_cache_frame(ctx);
          } else {
            // TODO(hkuang): Add unit test to test this path.
            set_error_detail(ctx, "Frame output cache is full.");
Yaowu Xu's avatar
Yaowu Xu committed
750
            return AOM_CODEC_ERROR;
Jingning Han's avatar
Jingning Han committed
751 752 753
          }
        }

754 755
        res =
            decode_one(ctx, &data_start_copy, frame_size, user_priv, deadline);
Yaowu Xu's avatar
Yaowu Xu committed
756
        if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
757 758 759 760 761 762 763 764 765 766 767
        data_start += frame_size;
      }
    } else {
      if (ctx->available_threads == 0) {
        // No more threads for decoding. Wait until the next output worker
        // finishes decoding. Then copy the decoded frame into cache.
        if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
          wait_worker_and_cache_frame(ctx);
        } else {
          // TODO(hkuang): Add unit test to test this path.
          set_error_detail(ctx, "Frame output cache is full.");
Yaowu Xu's avatar
Yaowu Xu committed
768
          return AOM_CODEC_ERROR;
Jingning Han's avatar
Jingning Han committed
769 770 771 772
        }
      }

      res = decode_one(ctx, &data, data_sz, user_priv, deadline);
Yaowu Xu's avatar
Yaowu Xu committed
773
      if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
774 775 776 777 778 779 780 781 782
    }
  } else {
    // Decode in serial mode.
    if (frame_count > 0) {
      int i;

      for (i = 0; i < frame_count; ++i) {
        const uint8_t *data_start_copy = data_start;
        const uint32_t frame_size = frame_sizes[i];
783 784
        if (data_start < data ||
            frame_size > (uint32_t)(data_end - data_start)) {
Jingning Han's avatar
Jingning Han committed
785
          set_error_detail(ctx, "Invalid frame size in index");
Yaowu Xu's avatar
Yaowu Xu committed
786
          return AOM_CODEC_CORRUPT_FRAME;
Jingning Han's avatar
Jingning Han committed
787 788
        }

789 790
        res =
            decode_one(ctx, &data_start_copy, frame_size, user_priv, deadline);
Yaowu Xu's avatar
Yaowu Xu committed
791
        if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
792 793 794 795 796

        data_start += frame_size;
      }
    } else {
      while (data_start < data_end) {
797
        const uint32_t frame_size = (uint32_t)(data_end - data_start);
798
        res = decode_one(ctx, &data_start, frame_size, user_priv, deadline);
Yaowu Xu's avatar
Yaowu Xu committed
799
        if (res != AOM_CODEC_OK) return res;
Jingning Han's avatar
Jingning Han committed
800 801 802

        // Account for suboptimal termination by the encoder.
        while (data_start < data_end) {
803
          const uint8_t marker = data_start[0];
804
          if (marker) break;
Jingning Han's avatar
Jingning Han committed
805 806 807 808 809 810 811 812 813
          ++data_start;
        }
      }
    }
  }

  return res;
}

Yaowu Xu's avatar
Yaowu Xu committed
814
static void release_last_output_frame(aom_codec_alg_priv_t *ctx) {
Jingning Han's avatar
Jingning Han committed
815 816 817 818 819 820 821 822 823 824
  RefCntBuffer *const frame_bufs = ctx->buffer_pool->frame_bufs;
  // Decrease reference count of last output frame in frame parallel mode.
  if (ctx->frame_parallel_decode && ctx->last_show_frame >= 0) {
    BufferPool *const pool = ctx->buffer_pool;
    lock_buffer_pool(pool);
    decrease_ref_count(ctx->last_show_frame, frame_bufs, pool);
    unlock_buffer_pool(pool);
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
825 826 827
static aom_image_t *decoder_get_frame(aom_codec_alg_priv_t *ctx,
                                      aom_codec_iter_t *iter) {
  aom_image_t *img = NULL;
Jingning Han's avatar
Jingning Han committed
828 829 830 831 832 833 834 835 836 837 838

  // Only return frame when all the cpu are busy or
  // application fluhsed the decoder in frame parallel decode.
  if (ctx->frame_parallel_decode && ctx->available_threads > 0 &&
      !ctx->flushed) {
    return NULL;
  }

  // Output the frames in the cache first.
  if (ctx->num_cache_frames > 0) {
    release_last_output_frame(ctx);
839 840
    ctx->last_show_frame = ctx->frame_cache[ctx->frame_cache_read].fb_idx;
    if (ctx->need_resync) return NULL;
Jingning Han's avatar
Jingning Han committed
841 842 843 844 845 846 847 848 849 850 851
    img = &ctx->frame_cache[ctx->frame_cache_read].img;
    ctx->frame_cache_read = (ctx->frame_cache_read + 1) % FRAME_CACHE_SIZE;
    --ctx->num_cache_frames;
    return img;
  }

  // iter acts as a flip flop, so an image is only returned on the first
  // call to get_frame.
  if (*iter == NULL && ctx->frame_workers != NULL) {
    do {
      YV12_BUFFER_CONFIG sd;
Yaowu Xu's avatar
Yaowu Xu committed
852 853
      const AVxWorkerInterface *const winterface = aom_get_worker_interface();
      AVxWorker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
Jingning Han's avatar
Jingning Han committed
854 855 856 857 858 859 860 861 862 863 864 865
      FrameWorkerData *const frame_worker_data =
          (FrameWorkerData *)worker->data1;
      ctx->next_output_worker_id =
          (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
      // Wait for the frame from worker thread.
      if (winterface->sync(worker)) {
        // Check if worker has received any frames.
        if (frame_worker_data->received_frame == 1) {
          ++ctx->available_threads;
          frame_worker_data->received_frame = 0;
          check_resync(ctx, frame_worker_data->pbi);
        }
Yaowu Xu's avatar
Yaowu Xu committed
866 867
        if (av1_get_raw_frame(frame_worker_data->pbi, &sd) == 0) {
          AV1_COMMON *const cm = &frame_worker_data->pbi->common;
Jingning Han's avatar
Jingning Han committed
868 869 870
          RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
          release_last_output_frame(ctx);
          ctx->last_show_frame = frame_worker_data->pbi->common.new_fb_idx;
871
          if (ctx->need_resync) return NULL;
Jingning Han's avatar
Jingning Han committed
872
          yuvconfig2image(&ctx->img, &sd, frame_worker_data->user_priv);
873 874

#if CONFIG_EXT_TILE
875
          if (cm->single_tile_decoding &&
876
              frame_worker_data->pbi->dec_tile_row >= 0) {
877
            const int tile_row =
Yaowu Xu's avatar
Yaowu Xu committed
878
                AOMMIN(frame_worker_data->pbi->dec_tile_row, cm->tile_rows - 1);
879 880 881 882 883
            const int mi_row = tile_row * cm->tile_height;
            const int ssy = ctx->img.y_chroma_shift;
            int plane;
            ctx->img.planes[0] += mi_row * MI_SIZE * ctx->img.stride[0];
            for (plane = 1; plane < MAX_MB_PLANE; ++plane) {
884 885
              ctx->img.planes[plane] +=
                  mi_row * (MI_SIZE >> ssy) * ctx->img.stride[plane];
886
            }
887
            ctx->img.d_h =
Yaowu Xu's avatar
Yaowu Xu committed
888
                AOMMIN(cm->tile_height, cm->mi_rows - mi_row) * MI_SIZE;
889 890
          }

891
          if (cm->single_tile_decoding &&
892
              frame_worker_data->pbi->dec_tile_col >= 0) {
893
            const int tile_col =
Yaowu Xu's avatar
Yaowu Xu committed
894
                AOMMIN(frame_worker_data->pbi->dec_tile_col, cm->tile_cols - 1);
895 896 897 898 899 900 901
            const int mi_col = tile_col * cm->tile_width;
            const int ssx = ctx->img.x_chroma_shift;
            int plane;
            ctx->img.planes[0] += mi_col * MI_SIZE;
            for (plane = 1; plane < MAX_MB_PLANE; ++plane) {
              ctx->img.planes[plane] += mi_col * (MI_SIZE >> ssx);
            }
902
            ctx->img.d_w =
Yaowu Xu's avatar
Yaowu Xu committed
903
                AOMMIN(cm->tile_width, cm->mi_cols - mi_col) * MI_SIZE;
904 905 906
          }
#endif  // CONFIG_EXT_TILE

Jingning Han's avatar
Jingning Han committed
907 908 909 910 911 912 913 914 915
          ctx->img.fb_priv = frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
          img = &ctx->img;
          return img;
        }
      } else {
        // Decoding failed. Release the worker thread.
        frame_worker_data->received_frame = 0;
        ++ctx->available_threads;
        ctx->need_resync = 1;
916
        if (ctx->flushed != 1) return NULL;
Jingning Han's avatar
Jingning Han committed
917 918 919 920 921 922
      }
    } while (ctx->next_output_worker_id != ctx->next_submit_worker_id);
  }
  return NULL;
}

Yaowu Xu's avatar
Yaowu Xu committed
923 924 925
static aom_codec_err_t decoder_set_fb_fn(
    aom_codec_alg_priv_t *ctx, aom_get_frame_buffer_cb_fn_t cb_get,
    aom_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
Jingning Han's avatar
Jingning Han committed
926
  if (cb_get == NULL || cb_release == NULL) {
Yaowu Xu's avatar
Yaowu Xu committed
927
    return AOM_CODEC_INVALID_PARAM;
Jingning Han's avatar
Jingning Han committed
928 929 930 931 932 933
  } else if (ctx->frame_workers == NULL) {
    // If the decoder has already been initialized, do not accept changes to
    // the frame buffer functions.
    ctx->get_ext_fb_cb = cb_get;
    ctx->release_ext_fb_cb = cb_release;
    ctx->ext_priv = cb_priv;
Yaowu Xu's avatar
Yaowu Xu committed
934
    return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
935 936
  }

Yaowu Xu's avatar
Yaowu Xu committed
937
  return AOM_CODEC_ERROR;
Jingning Han's avatar
Jingning Han committed
938 939
}

Yaowu Xu's avatar
Yaowu Xu committed
940
static aom_codec_err_t ctrl_set_reference(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
941
                                          va_list args) {
942
  av1_ref_frame_t *const data = va_arg(args, av1_ref_frame_t *);
Jingning Han's avatar
Jingning Han committed
943 944 945 946

  // Only support this function in serial decode.
  if (ctx->frame_parallel_decode) {
    set_error_detail(ctx, "Not supported in frame parallel decode");
Yaowu Xu's avatar
Yaowu Xu committed
947
    return AOM_CODEC_INCAPABLE;
Jingning Han's avatar
Jingning Han committed
948 949 950
  }

  if (data) {
951
    av1_ref_frame_t *const frame = data;
Jingning Han's avatar
Jingning Han committed
952
    YV12_BUFFER_CONFIG sd;
Yaowu Xu's avatar
Yaowu Xu committed
953
    AVxWorker *const worker = ctx->frame_workers;
Jingning Han's avatar
Jingning Han committed
954 955
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
    image2yuvconfig(&frame->img, &sd);
956
    return av1_set_reference_dec(&frame_worker_data->pbi->common, frame->idx,
Yaowu Xu's avatar
Yaowu Xu committed
957
                                 &sd);
Jingning Han's avatar
Jingning Han committed
958
  } else {
Yaowu Xu's avatar
Yaowu Xu committed
959
    return AOM_CODEC_INVALID_PARAM;
Jingning Han's avatar
Jingning Han committed
960 961 962
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
963
static aom_codec_err_t ctrl_copy_reference(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
964
                                           va_list args) {
965
  const av1_ref_frame_t *const frame = va_arg(args, av1_ref_frame_t *);
Jingning Han's avatar
Jingning Han committed
966 967 968 969

  // Only support this function in serial decode.
  if (ctx->frame_parallel_decode) {
    set_error_detail(ctx, "Not supported in frame parallel decode");
Yaowu Xu's avatar
Yaowu Xu committed
970
    return AOM_CODEC_INCAPABLE;
Jingning Han's avatar
Jingning Han committed
971 972
  }

Urvang Joshi's avatar
Urvang Joshi committed
973
  if (frame) {
Jingning Han's avatar
Jingning Han committed
974
    YV12_BUFFER_CONFIG sd;
Yaowu Xu's avatar
Yaowu Xu committed
975
    AVxWorker *const worker = ctx->frame_workers;
Jingning Han's avatar
Jingning Han committed
976 977
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
    image2yuvconfig(&frame->img, &sd);
978
    return av1_copy_reference_dec(frame_worker_data->pbi, frame->idx, &sd);
Jingning Han's avatar
Jingning Han committed
979
  } else {
Yaowu Xu's avatar
Yaowu Xu committed
980
    return AOM_CODEC_INVALID_PARAM;
Jingning Han's avatar
Jingning Han committed
981 982 983
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
984
static aom_codec_err_t ctrl_get_reference(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
985
                                          va_list args) {
Yaowu Xu's avatar
Yaowu Xu committed
986
  av1_ref_frame_t *data = va_arg(args, av1_ref_frame_t *);
Jingning Han's avatar
Jingning Han committed
987 988 989 990

  // Only support this function in serial decode.
  if (ctx->frame_parallel_decode) {
    set_error_detail(ctx, "Not supported in frame parallel decode");
Yaowu Xu's avatar
Yaowu Xu committed
991
    return AOM_CODEC_INCAPABLE;
Jingning Han's avatar
Jingning Han committed
992 993 994
  }

  if (data) {
995
    YV12_BUFFER_CONFIG *fb;
Yaowu Xu's avatar
Yaowu Xu committed
996
    AVxWorker *const worker = ctx->frame_workers;
Jingning Han's avatar
Jingning Han committed
997 998
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
    fb = get_ref_frame(&frame_worker_data->pbi->common, data->idx);
Yaowu Xu's avatar
Yaowu Xu committed
999
    if (fb == NULL) return AOM_CODEC_ERROR;
Jingning Han's avatar
Jingning Han committed
1000
    yuvconfig2image(&data->img, fb, NULL);
Yaowu Xu's avatar
Yaowu Xu committed
1001
    return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
1002
  } else {
Yaowu Xu's avatar
Yaowu Xu committed
1003
    return AOM_CODEC_INVALID_PARAM;
Jingning Han's avatar
Jingning Han committed
1004 1005 1006
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
1007
static aom_codec_err_t ctrl_get_new_frame_image(aom_codec_alg_priv_t *ctx,
1008
                                                va_list args) {
Yaowu Xu's avatar
Yaowu Xu committed
1009
  aom_image_t *new_img = va_arg(args, aom_image_t *);
1010 1011 1012 1013

  // Only support this function in serial decode.
  if (ctx->frame_parallel_decode) {
    set_error_detail(ctx, "Not supported in frame parallel decode");
Yaowu Xu's avatar
Yaowu Xu committed
1014
    return AOM_CODEC_INCAPABLE;
1015 1016 1017 1018
  }

  if (new_img) {
    YV12_BUFFER_CONFIG new_frame;
Yaowu Xu's avatar
Yaowu Xu committed
1019
    AVxWorker *const worker = ctx->frame_workers;
1020 1021
    FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;

Yaowu Xu's avatar
Yaowu Xu committed
1022
    if (av1_get_frame_to_show(frame_worker_data->pbi, &new_frame) == 0) {
1023
      yuvconfig2image(new_img, &new_frame, NULL);
Yaowu Xu's avatar
Yaowu Xu committed
1024
      return AOM_CODEC_OK;
1025
    } else {
Yaowu Xu's avatar
Yaowu Xu committed
1026
      return AOM_CODEC_ERROR;
1027 1028
    }
  } else {
Yaowu Xu's avatar
Yaowu Xu committed
1029
    return AOM_CODEC_INVALID_PARAM;
1030 1031 1032
  }
}

Yaowu Xu's avatar
Yaowu Xu committed
1033
static aom_codec_err_t ctrl_set_postproc(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
1034 1035 1036
                                         va_list args) {
  (void)ctx;
  (void)args;
Yaowu Xu's avatar
Yaowu Xu committed
1037
  return AOM_CODEC_INCAPABLE;
Jingning Han's avatar
Jingning Han committed
1038 1039
}

Yaowu Xu's avatar
Yaowu Xu committed
1040
static aom_codec_err_t ctrl_set_dbg_options(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
1041 1042 1043
                                            va_list args) {
  (void)ctx;
  (void)args;
Yaowu Xu's avatar
Yaowu Xu committed
1044
  return AOM_CODEC_INCAPABLE;
Jingning Han's avatar
Jingning Han committed
1045 1046
}

Yaowu Xu's avatar
Yaowu Xu committed
1047
static aom_codec_err_t ctrl_get_last_ref_updates(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
1048 1049 1050 1051 1052 1053
                                                 va_list args) {
  int *const update_info = va_arg(args, int *);

  // Only support this function in serial decode.
  if (ctx->frame_parallel_decode) {
    set_error_detail(ctx, "Not supported in frame parallel decode");
Yaowu Xu's avatar
Yaowu Xu committed
1054
    return AOM_CODEC_INCAPABLE;
Jingning Han's avatar
Jingning Han committed
1055 1056 1057 1058
  }

  if (update_info) {
    if (ctx->frame_workers) {
Yaowu Xu's avatar
Yaowu Xu committed
1059
      AVxWorker *const worker = ctx->frame_workers;
Jingning Han's avatar
Jingning Han committed
1060 1061 1062
      FrameWorkerData *const frame_worker_data =
          (FrameWorkerData *)worker->data1;
      *update_info = frame_worker_data->pbi->refresh_frame_flags;
Yaowu Xu's avatar
Yaowu Xu committed
1063
      return AOM_CODEC_OK;
Jingning Han's avatar
Jingning Han committed
1064
    } else {
Yaowu Xu's avatar
Yaowu Xu committed
1065
      return AOM_CODEC_ERROR;
Jingning Han's avatar
Jingning Han committed
1066 1067 1068
    }
  }

Yaowu Xu's avatar
Yaowu Xu committed
1069
  return AOM_CODEC_INVALID_PARAM;
Jingning Han's avatar
Jingning Han committed
1070 1071
}

1072 1073 1074 1075 1076 1077 1078 1079 1080
static aom_codec_err_t ctrl_get_last_quantizer(aom_codec_alg_priv_t *ctx,
                                               va_list args) {
  int *const arg = va_arg(args, int *);
  if (arg == NULL) return AOM_CODEC_INVALID_PARAM;
  *arg =
      ((FrameWorkerData *)ctx->frame_workers[0].data1)->pbi->common.base_qindex;
  return AOM_CODEC_OK;
}

Yaowu Xu's avatar
Yaowu Xu committed
1081
static aom_codec_err_t ctrl_get_frame_corrupted(aom_codec_alg_priv_t *ctx,
Jingning Han's avatar
Jingning Han committed
1082 1083 1084 1085 1086
                                                va_list args) {
  int *corrupted = va_arg(args, int *);

  if (corrupted) {
    if (ctx->frame_workers) {
Yaowu Xu's avatar
Yaowu Xu committed