]> granicus.if.org Git - libvpx/blob - vp9/vp9_dx_iface.c
Merge "Improve readability: move return statements"
[libvpx] / 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   if (ctx->num_frame_workers > MAX_DECODE_THREADS)
367     ctx->num_frame_workers = MAX_DECODE_THREADS;
368   ctx->available_threads = ctx->num_frame_workers;
369   ctx->flushed = 0;
370
371   ctx->buffer_pool = (BufferPool *)vpx_calloc(1, sizeof(BufferPool));
372   if (ctx->buffer_pool == NULL)
373     return VPX_CODEC_MEM_ERROR;
374
375 #if CONFIG_MULTITHREAD
376     if (pthread_mutex_init(&ctx->buffer_pool->pool_mutex, NULL)) {
377       set_error_detail(ctx, "Failed to allocate buffer pool mutex");
378       return VPX_CODEC_MEM_ERROR;
379     }
380 #endif
381
382   ctx->frame_workers = (VP9Worker *)
383       vpx_malloc(ctx->num_frame_workers * sizeof(*ctx->frame_workers));
384   if (ctx->frame_workers == NULL) {
385     set_error_detail(ctx, "Failed to allocate frame_workers");
386     return VPX_CODEC_MEM_ERROR;
387   }
388
389   for (i = 0; i < ctx->num_frame_workers; ++i) {
390     VP9Worker *const worker = &ctx->frame_workers[i];
391     FrameWorkerData *frame_worker_data = NULL;
392     winterface->init(worker);
393     worker->data1 = vpx_memalign(32, sizeof(FrameWorkerData));
394     if (worker->data1 == NULL) {
395       set_error_detail(ctx, "Failed to allocate frame_worker_data");
396       return VPX_CODEC_MEM_ERROR;
397     }
398     frame_worker_data = (FrameWorkerData *)worker->data1;
399     frame_worker_data->pbi = vp9_decoder_create(ctx->buffer_pool);
400     if (frame_worker_data->pbi == NULL) {
401       set_error_detail(ctx, "Failed to allocate frame_worker_data");
402       return VPX_CODEC_MEM_ERROR;
403     }
404     frame_worker_data->pbi->frame_worker_owner = worker;
405     frame_worker_data->worker_id = i;
406     frame_worker_data->scratch_buffer = NULL;
407     frame_worker_data->scratch_buffer_size = 0;
408     frame_worker_data->frame_context_ready = 0;
409     frame_worker_data->received_frame = 0;
410 #if CONFIG_MULTITHREAD
411     if (pthread_mutex_init(&frame_worker_data->stats_mutex, NULL)) {
412       set_error_detail(ctx, "Failed to allocate frame_worker_data mutex");
413       return VPX_CODEC_MEM_ERROR;
414     }
415
416     if (pthread_cond_init(&frame_worker_data->stats_cond, NULL)) {
417       set_error_detail(ctx, "Failed to allocate frame_worker_data cond");
418       return VPX_CODEC_MEM_ERROR;
419     }
420 #endif
421     // If decoding in serial mode, FrameWorker thread could create tile worker
422     // thread or loopfilter thread.
423     frame_worker_data->pbi->max_threads =
424         (ctx->frame_parallel_decode == 0) ? ctx->cfg.threads : 0;
425
426     frame_worker_data->pbi->inv_tile_order = ctx->invert_tile_order;
427     frame_worker_data->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
428     frame_worker_data->pbi->common.frame_parallel_decode =
429         ctx->frame_parallel_decode;
430     worker->hook = (VP9WorkerHook)frame_worker_hook;
431     if (!winterface->reset(worker)) {
432       set_error_detail(ctx, "Frame Worker thread creation failed");
433       return VPX_CODEC_MEM_ERROR;
434     }
435   }
436
437   // If postprocessing was enabled by the application and a
438   // configuration has not been provided, default it.
439   if (!ctx->postproc_cfg_set &&
440       (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
441     set_default_ppflags(&ctx->postproc_cfg);
442
443   init_buffer_callbacks(ctx);
444
445   return VPX_CODEC_OK;
446 }
447
448 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
449                                   const uint8_t **data, unsigned int data_sz,
450                                   void *user_priv, int64_t deadline) {
451   vp9_ppflags_t flags = {0, 0, 0};
452   const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
453   (void)deadline;
454
455   // Determine the stream parameters. Note that we rely on peek_si to
456   // validate that we have a buffer that does not wrap around the top
457   // of the heap.
458   if (!ctx->si.h) {
459     int is_intra_only = 0;
460     const vpx_codec_err_t res =
461         decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
462                                  ctx->decrypt_cb, ctx->decrypt_state);
463     if (res != VPX_CODEC_OK)
464       return res;
465
466     if (!ctx->si.is_kf && !is_intra_only)
467       return VPX_CODEC_ERROR;
468   }
469
470   if (!ctx->frame_parallel_decode) {
471     VP9Worker *const worker = ctx->frame_workers;
472     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
473     frame_worker_data->data = *data;
474     frame_worker_data->data_size = data_sz;
475     frame_worker_data->user_priv = user_priv;
476
477     // Set these even if already initialized.  The caller may have changed the
478     // decrypt config between frames.
479     frame_worker_data->pbi->decrypt_cb = ctx->decrypt_cb;
480     frame_worker_data->pbi->decrypt_state = ctx->decrypt_state;
481
482     worker->had_error = 0;
483     winterface->execute(worker);
484
485     // Update data pointer after decode.
486     *data = frame_worker_data->data_end;
487
488     if (worker->had_error)
489       return update_error_state(ctx, &frame_worker_data->pbi->common.error);
490   } else {
491     const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
492     VP9Worker *const worker = &ctx->frame_workers[ctx->next_submit_worker_id];
493     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
494     // Copy context from last worker thread to next worker thread.
495     if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
496       vp9_frameworker_copy_context(
497           &ctx->frame_workers[ctx->next_submit_worker_id],
498           &ctx->frame_workers[ctx->last_submit_worker_id]);
499
500     frame_worker_data->pbi->ready_for_new_data = 0;
501     // Copy the compressed data into worker's internal buffer.
502     // TODO(hkuang): Will all the workers allocate the same size
503     // as the size of the first intra frame be better? This will
504     // avoid too many deallocate and allocate.
505     if (frame_worker_data->scratch_buffer_size < data_sz) {
506       frame_worker_data->scratch_buffer =
507           (uint8_t *)vpx_realloc(frame_worker_data->scratch_buffer, data_sz);
508       if (frame_worker_data->scratch_buffer == NULL) {
509         set_error_detail(ctx, "Failed to reallocate scratch buffer");
510         return VPX_CODEC_MEM_ERROR;
511       }
512       frame_worker_data->scratch_buffer_size = data_sz;
513     }
514     frame_worker_data->data_size = data_sz;
515     vpx_memcpy(frame_worker_data->scratch_buffer, *data, data_sz);
516
517     frame_worker_data->frame_decoded = 0;
518     frame_worker_data->frame_context_ready = 0;
519     frame_worker_data->received_frame = 1;
520     frame_worker_data->data = frame_worker_data->scratch_buffer;
521     frame_worker_data->user_priv = user_priv;
522
523     if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
524       ctx->last_submit_worker_id =
525           (ctx->last_submit_worker_id + 1) % ctx->num_frame_workers;
526
527     ctx->next_submit_worker_id =
528         (ctx->next_submit_worker_id + 1) % ctx->num_frame_workers;
529     --ctx->available_threads;
530     worker->had_error = 0;
531     winterface->launch(worker);
532   }
533
534   if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
535     set_ppflags(ctx, &flags);
536
537   return VPX_CODEC_OK;
538 }
539
540 static void wait_worker_and_cache_frame(vpx_codec_alg_priv_t *ctx) {
541   YV12_BUFFER_CONFIG sd;
542   vp9_ppflags_t flags = {0, 0, 0};
543   const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
544   VP9Worker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
545   FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
546   ctx->next_output_worker_id =
547       (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
548   // TODO(hkuang): Add worker error handling here.
549   winterface->sync(worker);
550   frame_worker_data->received_frame = 0;
551   ++ctx->available_threads;
552   if (vp9_get_raw_frame(frame_worker_data->pbi, &sd, &flags) == 0) {
553     VP9_COMMON *const cm = &frame_worker_data->pbi->common;
554     RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
555     ctx->frame_cache[ctx->frame_cache_write].fb_idx = cm->new_fb_idx;
556     yuvconfig2image(&ctx->frame_cache[ctx->frame_cache_write].img, &sd,
557                     frame_worker_data->user_priv);
558     ctx->frame_cache[ctx->frame_cache_write].img.fb_priv =
559         frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
560     ctx->frame_cache_write =
561         (ctx->frame_cache_write + 1) % FRAME_CACHE_SIZE;
562     ++ctx->num_cache_frames;
563   }
564 }
565
566 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
567                                       const uint8_t *data, unsigned int data_sz,
568                                       void *user_priv, long deadline) {
569   const uint8_t *data_start = data;
570   const uint8_t * const data_end = data + data_sz;
571   vpx_codec_err_t res;
572   uint32_t frame_sizes[8];
573   int frame_count;
574
575   if (data == NULL && data_sz == 0) {
576     ctx->flushed = 1;
577     return VPX_CODEC_OK;
578   }
579
580   // Reset flushed when receiving a valid frame.
581   ctx->flushed = 0;
582
583   // Initialize the decoder workers on the first frame.
584   if (ctx->frame_workers == NULL) {
585     const vpx_codec_err_t res = init_decoder(ctx);
586     if (res != VPX_CODEC_OK)
587       return res;
588   }
589
590   res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
591                                    ctx->decrypt_cb, ctx->decrypt_state);
592   if (res != VPX_CODEC_OK)
593     return res;
594
595   if (ctx->frame_parallel_decode) {
596     // Decode in frame parallel mode. When decoding in this mode, the frame
597     // passed to the decoder must be either a normal frame or a superframe with
598     // superframe index so the decoder could get each frame's start position
599     // in the superframe.
600     if (frame_count > 0) {
601       int i;
602
603       for (i = 0; i < frame_count; ++i) {
604         const uint8_t *data_start_copy = data_start;
605         const uint32_t frame_size = frame_sizes[i];
606         if (data_start < data
607             || frame_size > (uint32_t) (data_end - data_start)) {
608           set_error_detail(ctx, "Invalid frame size in index");
609           return VPX_CODEC_CORRUPT_FRAME;
610         }
611
612         if (ctx->available_threads == 0) {
613           // No more threads for decoding. Wait until the next output worker
614           // finishes decoding. Then copy the decoded frame into cache.
615           if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
616             wait_worker_and_cache_frame(ctx);
617           } else {
618             // TODO(hkuang): Add unit test to test this path.
619             set_error_detail(ctx, "Frame output cache is full.");
620             return VPX_CODEC_ERROR;
621           }
622         }
623
624         res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
625                          deadline);
626         if (res != VPX_CODEC_OK)
627           return res;
628         data_start += frame_size;
629       }
630     } else {
631       if (ctx->available_threads == 0) {
632         // No more threads for decoding. Wait until the next output worker
633         // finishes decoding. Then copy the decoded frame into cache.
634         if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
635           wait_worker_and_cache_frame(ctx);
636         } else {
637           // TODO(hkuang): Add unit test to test this path.
638           set_error_detail(ctx, "Frame output cache is full.");
639           return VPX_CODEC_ERROR;
640         }
641       }
642
643       res = decode_one(ctx, &data, data_sz, user_priv, deadline);
644       if (res != VPX_CODEC_OK)
645         return res;
646     }
647   } else {
648     // Decode in serial mode.
649     if (frame_count > 0) {
650       int i;
651
652       for (i = 0; i < frame_count; ++i) {
653         const uint8_t *data_start_copy = data_start;
654         const uint32_t frame_size = frame_sizes[i];
655         vpx_codec_err_t res;
656         if (data_start < data
657             || frame_size > (uint32_t) (data_end - data_start)) {
658           set_error_detail(ctx, "Invalid frame size in index");
659           return VPX_CODEC_CORRUPT_FRAME;
660         }
661
662         res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
663                          deadline);
664         if (res != VPX_CODEC_OK)
665           return res;
666
667         data_start += frame_size;
668       }
669     } else {
670       while (data_start < data_end) {
671         const uint32_t frame_size = (uint32_t) (data_end - data_start);
672         const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
673                                                user_priv, deadline);
674         if (res != VPX_CODEC_OK)
675           return res;
676
677         // Account for suboptimal termination by the encoder.
678         while (data_start < data_end) {
679           const uint8_t marker = read_marker(ctx->decrypt_cb,
680                                              ctx->decrypt_state, data_start);
681           if (marker)
682             break;
683           ++data_start;
684         }
685       }
686     }
687   }
688
689   return res;
690 }
691
692 static void release_last_output_frame(vpx_codec_alg_priv_t *ctx) {
693   RefCntBuffer *const frame_bufs = ctx->buffer_pool->frame_bufs;
694   // Decrease reference count of last output frame in frame parallel mode.
695   if (ctx->frame_parallel_decode && ctx->last_show_frame >= 0) {
696     BufferPool *const pool = ctx->buffer_pool;
697     lock_buffer_pool(pool);
698     decrease_ref_count(ctx->last_show_frame, frame_bufs, pool);
699     unlock_buffer_pool(pool);
700   }
701 }
702
703 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
704                                       vpx_codec_iter_t *iter) {
705   vpx_image_t *img = NULL;
706
707   // Only return frame when all the cpu are busy or
708   // application fluhsed the decoder in frame parallel decode.
709   if (ctx->frame_parallel_decode && ctx->available_threads > 0 &&
710       !ctx->flushed) {
711     return img;
712   }
713
714   // Output the frames in the cache first.
715   if (ctx->num_cache_frames > 0) {
716     release_last_output_frame(ctx);
717     ctx->last_show_frame  = ctx->frame_cache[ctx->frame_cache_read].fb_idx;
718     img = &ctx->frame_cache[ctx->frame_cache_read].img;
719     ctx->frame_cache_read = (ctx->frame_cache_read + 1) % FRAME_CACHE_SIZE;
720     --ctx->num_cache_frames;
721     return img;
722   }
723
724   // iter acts as a flip flop, so an image is only returned on the first
725   // call to get_frame.
726   if (*iter == NULL && ctx->frame_workers != NULL) {
727     do {
728       YV12_BUFFER_CONFIG sd;
729       vp9_ppflags_t flags = {0, 0, 0};
730       const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
731       VP9Worker *const worker =
732           &ctx->frame_workers[ctx->next_output_worker_id];
733       FrameWorkerData *const frame_worker_data =
734           (FrameWorkerData *)worker->data1;
735       ctx->next_output_worker_id =
736           (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
737       // Wait for the frame from worker thread.
738       if (winterface->sync(worker)) {
739         // Check if worker has received any frames.
740         if (frame_worker_data->received_frame == 1)
741           ++ctx->available_threads;
742         frame_worker_data->received_frame = 0;
743         if (vp9_get_raw_frame(frame_worker_data->pbi, &sd, &flags) == 0) {
744           VP9_COMMON *const cm = &frame_worker_data->pbi->common;
745           RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
746           release_last_output_frame(ctx);
747           ctx->last_show_frame = frame_worker_data->pbi->common.new_fb_idx;
748           yuvconfig2image(&ctx->img, &sd, frame_worker_data->user_priv);
749           ctx->img.fb_priv = frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
750           img = &ctx->img;
751           return img;
752         }
753       } else {
754         // Decoding failed. Release the worker thread.
755         frame_worker_data->received_frame = 0;
756         ++ctx->available_threads;
757         if (ctx->flushed != 1)
758           return img;
759       }
760     } while (ctx->next_output_worker_id != ctx->next_submit_worker_id);
761   }
762   return img;
763 }
764
765 static vpx_codec_err_t decoder_set_fb_fn(
766     vpx_codec_alg_priv_t *ctx,
767     vpx_get_frame_buffer_cb_fn_t cb_get,
768     vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
769   if (cb_get == NULL || cb_release == NULL) {
770     return VPX_CODEC_INVALID_PARAM;
771   } else if (ctx->frame_workers == NULL) {
772     // If the decoder has already been initialized, do not accept changes to
773     // the frame buffer functions.
774     ctx->get_ext_fb_cb = cb_get;
775     ctx->release_ext_fb_cb = cb_release;
776     ctx->ext_priv = cb_priv;
777     return VPX_CODEC_OK;
778   }
779
780   return VPX_CODEC_ERROR;
781 }
782
783 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
784                                           va_list args) {
785   vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
786
787   // Only support this function in serial decode.
788   if (ctx->frame_parallel_decode) {
789     set_error_detail(ctx, "Not supported in frame parallel decode");
790     return VPX_CODEC_INCAPABLE;
791   }
792
793   if (data) {
794     vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
795     YV12_BUFFER_CONFIG sd;
796     VP9Worker *const worker = ctx->frame_workers;
797     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
798     image2yuvconfig(&frame->img, &sd);
799     return vp9_set_reference_dec(&frame_worker_data->pbi->common,
800                                  (VP9_REFFRAME)frame->frame_type, &sd);
801   } else {
802     return VPX_CODEC_INVALID_PARAM;
803   }
804 }
805
806 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
807                                            va_list args) {
808   vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
809
810   // Only support this function in serial decode.
811   if (ctx->frame_parallel_decode) {
812     set_error_detail(ctx, "Not supported in frame parallel decode");
813     return VPX_CODEC_INCAPABLE;
814   }
815
816   if (data) {
817     vpx_ref_frame_t *frame = (vpx_ref_frame_t *) data;
818     YV12_BUFFER_CONFIG sd;
819     VP9Worker *const worker = ctx->frame_workers;
820     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
821     image2yuvconfig(&frame->img, &sd);
822     return vp9_copy_reference_dec(frame_worker_data->pbi,
823                                   (VP9_REFFRAME)frame->frame_type, &sd);
824   } else {
825     return VPX_CODEC_INVALID_PARAM;
826   }
827 }
828
829 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
830                                           va_list args) {
831   vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
832
833   // Only support this function in serial decode.
834   if (ctx->frame_parallel_decode) {
835     set_error_detail(ctx, "Not supported in frame parallel decode");
836     return VPX_CODEC_INCAPABLE;
837   }
838
839   if (data) {
840     YV12_BUFFER_CONFIG* fb;
841     VP9Worker *const worker = ctx->frame_workers;
842     FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
843     fb = get_ref_frame(&frame_worker_data->pbi->common, data->idx);
844     if (fb == NULL) return VPX_CODEC_ERROR;
845     yuvconfig2image(&data->img, fb, NULL);
846     return VPX_CODEC_OK;
847   } else {
848     return VPX_CODEC_INVALID_PARAM;
849   }
850 }
851
852 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
853                                          va_list args) {
854 #if CONFIG_VP9_POSTPROC
855   vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
856
857   if (data) {
858     ctx->postproc_cfg_set = 1;
859     ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
860     return VPX_CODEC_OK;
861   } else {
862     return VPX_CODEC_INVALID_PARAM;
863   }
864 #else
865   (void)ctx;
866   (void)args;
867   return VPX_CODEC_INCAPABLE;
868 #endif
869 }
870
871 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
872                                             va_list args) {
873   (void)ctx;
874   (void)args;
875   return VPX_CODEC_INCAPABLE;
876 }
877
878 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
879                                                  va_list args) {
880   int *const update_info = va_arg(args, int *);
881
882   // Only support this function in serial decode.
883   if (ctx->frame_parallel_decode) {
884     set_error_detail(ctx, "Not supported in frame parallel decode");
885     return VPX_CODEC_INCAPABLE;
886   }
887
888   if (update_info) {
889     if (ctx->frame_workers) {
890       VP9Worker *const worker = ctx->frame_workers;
891       FrameWorkerData *const frame_worker_data =
892           (FrameWorkerData *)worker->data1;
893       *update_info = frame_worker_data->pbi->refresh_frame_flags;
894       return VPX_CODEC_OK;
895     } else {
896       return VPX_CODEC_ERROR;
897     }
898   }
899
900   return VPX_CODEC_INVALID_PARAM;
901 }
902
903 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
904                                                 va_list args) {
905   int *corrupted = va_arg(args, int *);
906
907   if (corrupted) {
908     if (ctx->frame_workers) {
909       VP9Worker *const worker = ctx->frame_workers;
910       FrameWorkerData *const frame_worker_data =
911           (FrameWorkerData *)worker->data1;
912       RefCntBuffer *const frame_bufs =
913           frame_worker_data->pbi->common.buffer_pool->frame_bufs;
914       if (frame_worker_data->pbi->common.frame_to_show == NULL)
915         return VPX_CODEC_ERROR;
916       *corrupted = frame_bufs[ctx->last_show_frame].buf.corrupted;
917       return VPX_CODEC_OK;
918     } else {
919       return VPX_CODEC_ERROR;
920     }
921   }
922
923   return VPX_CODEC_INVALID_PARAM;
924 }
925
926 static vpx_codec_err_t ctrl_get_frame_size(vpx_codec_alg_priv_t *ctx,
927                                            va_list args) {
928   int *const frame_size = va_arg(args, int *);
929
930   // Only support this function in serial decode.
931   if (ctx->frame_parallel_decode) {
932     set_error_detail(ctx, "Not supported in frame parallel decode");
933     return VPX_CODEC_INCAPABLE;
934   }
935
936   if (frame_size) {
937     if (ctx->frame_workers) {
938       VP9Worker *const worker = ctx->frame_workers;
939       FrameWorkerData *const frame_worker_data =
940           (FrameWorkerData *)worker->data1;
941       const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
942       frame_size[0] = cm->width;
943       frame_size[1] = cm->height;
944       return VPX_CODEC_OK;
945     } else {
946       return VPX_CODEC_ERROR;
947     }
948   }
949
950   return VPX_CODEC_INVALID_PARAM;
951 }
952
953 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
954                                              va_list args) {
955   int *const display_size = va_arg(args, int *);
956
957   // Only support this function in serial decode.
958   if (ctx->frame_parallel_decode) {
959     set_error_detail(ctx, "Not supported in frame parallel decode");
960     return VPX_CODEC_INCAPABLE;
961   }
962
963   if (display_size) {
964     if (ctx->frame_workers) {
965       VP9Worker *const worker = ctx->frame_workers;
966       FrameWorkerData *const frame_worker_data =
967           (FrameWorkerData *)worker->data1;
968       const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
969       display_size[0] = cm->display_width;
970       display_size[1] = cm->display_height;
971       return VPX_CODEC_OK;
972     } else {
973       return VPX_CODEC_ERROR;
974     }
975   }
976
977   return VPX_CODEC_INVALID_PARAM;
978 }
979
980 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
981                                           va_list args) {
982   unsigned int *const bit_depth = va_arg(args, unsigned int *);
983   VP9Worker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
984
985   if (bit_depth) {
986     if (worker) {
987       FrameWorkerData *const frame_worker_data =
988           (FrameWorkerData *)worker->data1;
989       const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
990       *bit_depth = cm->bit_depth;
991       return VPX_CODEC_OK;
992     } else {
993       return VPX_CODEC_ERROR;
994     }
995   }
996
997   return VPX_CODEC_INVALID_PARAM;
998 }
999
1000 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
1001                                                   va_list args) {
1002   ctx->invert_tile_order = va_arg(args, int);
1003   return VPX_CODEC_OK;
1004 }
1005
1006 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
1007                                           va_list args) {
1008   vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
1009   ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
1010   ctx->decrypt_state = init ? init->decrypt_state : NULL;
1011   return VPX_CODEC_OK;
1012 }
1013
1014 static vpx_codec_err_t ctrl_set_byte_alignment(vpx_codec_alg_priv_t *ctx,
1015                                                va_list args) {
1016   const int legacy_byte_alignment = 0;
1017   const int min_byte_alignment = 32;
1018   const int max_byte_alignment = 1024;
1019   const int byte_alignment = va_arg(args, int);
1020
1021   if (byte_alignment != legacy_byte_alignment &&
1022       (byte_alignment < min_byte_alignment ||
1023        byte_alignment > max_byte_alignment ||
1024        (byte_alignment & (byte_alignment - 1)) != 0))
1025     return VPX_CODEC_INVALID_PARAM;
1026
1027   ctx->byte_alignment = byte_alignment;
1028   if (ctx->frame_workers) {
1029     VP9Worker *const worker = ctx->frame_workers;
1030     FrameWorkerData *const frame_worker_data =
1031         (FrameWorkerData *)worker->data1;
1032     frame_worker_data->pbi->common.byte_alignment = byte_alignment;
1033   }
1034   return VPX_CODEC_OK;
1035 }
1036
1037 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
1038   {VP8_COPY_REFERENCE,            ctrl_copy_reference},
1039
1040   // Setters
1041   {VP8_SET_REFERENCE,             ctrl_set_reference},
1042   {VP8_SET_POSTPROC,              ctrl_set_postproc},
1043   {VP8_SET_DBG_COLOR_REF_FRAME,   ctrl_set_dbg_options},
1044   {VP8_SET_DBG_COLOR_MB_MODES,    ctrl_set_dbg_options},
1045   {VP8_SET_DBG_COLOR_B_MODES,     ctrl_set_dbg_options},
1046   {VP8_SET_DBG_DISPLAY_MV,        ctrl_set_dbg_options},
1047   {VP9_INVERT_TILE_DECODE_ORDER,  ctrl_set_invert_tile_order},
1048   {VPXD_SET_DECRYPTOR,            ctrl_set_decryptor},
1049   {VP9_SET_BYTE_ALIGNMENT,        ctrl_set_byte_alignment},
1050
1051   // Getters
1052   {VP8D_GET_LAST_REF_UPDATES,     ctrl_get_last_ref_updates},
1053   {VP8D_GET_FRAME_CORRUPTED,      ctrl_get_frame_corrupted},
1054   {VP9_GET_REFERENCE,             ctrl_get_reference},
1055   {VP9D_GET_DISPLAY_SIZE,         ctrl_get_display_size},
1056   {VP9D_GET_BIT_DEPTH,            ctrl_get_bit_depth},
1057   {VP9D_GET_FRAME_SIZE,           ctrl_get_frame_size},
1058
1059   { -1, NULL},
1060 };
1061
1062 #ifndef VERSION_STRING
1063 #define VERSION_STRING
1064 #endif
1065 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
1066   "WebM Project VP9 Decoder" VERSION_STRING,
1067   VPX_CODEC_INTERNAL_ABI_VERSION,
1068   VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
1069       VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER,  // vpx_codec_caps_t
1070   decoder_init,       // vpx_codec_init_fn_t
1071   decoder_destroy,    // vpx_codec_destroy_fn_t
1072   decoder_ctrl_maps,  // vpx_codec_ctrl_fn_map_t
1073   { // NOLINT
1074     decoder_peek_si,    // vpx_codec_peek_si_fn_t
1075     decoder_get_si,     // vpx_codec_get_si_fn_t
1076     decoder_decode,     // vpx_codec_decode_fn_t
1077     decoder_get_frame,  // vpx_codec_frame_get_fn_t
1078     decoder_set_fb_fn,  // vpx_codec_set_fb_fn_t
1079   },
1080   { // NOLINT
1081     0,
1082     NULL,  // vpx_codec_enc_cfg_map_t
1083     NULL,  // vpx_codec_encode_fn_t
1084     NULL,  // vpx_codec_get_cx_data_fn_t
1085     NULL,  // vpx_codec_enc_config_set_fn_t
1086     NULL,  // vpx_codec_get_global_headers_fn_t
1087     NULL,  // vpx_codec_get_preview_frame_fn_t
1088     NULL   // vpx_codec_enc_mr_get_mem_loc_fn_t
1089   }
1090 };