2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
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.
14 #include "./vpx_config.h"
15 #include "./vpx_version.h"
17 #include "vpx/internal/vpx_codec_internal.h"
18 #include "vpx/vp8dx.h"
19 #include "vpx/vpx_decoder.h"
21 #include "vp9/common/vp9_alloccommon.h"
22 #include "vp9/common/vp9_frame_buffers.h"
23 #include "vp9/common/vp9_thread.h"
25 #include "vp9/decoder/vp9_decoder.h"
26 #include "vp9/decoder/vp9_decodeframe.h"
27 #include "vp9/decoder/vp9_read_bit_buffer.h"
29 #include "vp9/vp9_iface_common.h"
31 #define VP9_CAP_POSTPROC (CONFIG_VP9_POSTPROC ? VPX_CODEC_CAP_POSTPROC : 0)
33 typedef vpx_codec_stream_info_t vp9_stream_info_t;
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.
39 typedef struct cache_frame {
44 struct vpx_codec_alg_priv {
45 vpx_codec_priv_t base;
46 vpx_codec_dec_cfg_t cfg;
49 vp8_postproc_cfg_t postproc_cfg;
50 vpx_decrypt_cb decrypt_cb;
55 int invert_tile_order;
56 int last_show_frame; // Index of last output frame.
59 // Frame parallel related.
60 int frame_parallel_decode; // frame-based threading.
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;
71 int need_resync; // wait for key/intra-only frame
72 // BufferPool that holds all reference frames. Shared by all the FrameWorkers.
73 BufferPool *buffer_pool;
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;
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.
89 vpx_codec_alg_priv_t *const priv = vpx_calloc(1, sizeof(*priv));
91 return VPX_CODEC_MEM_ERROR;
93 ctx->priv = (vpx_codec_priv_t *)priv;
94 ctx->priv->init_flags = ctx->init_flags;
95 priv->si.sz = sizeof(priv->si);
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;
110 static vpx_codec_err_t decoder_destroy(vpx_codec_alg_priv_t *ctx) {
111 if (ctx->frame_workers != NULL) {
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);
125 vpx_free(frame_worker_data);
127 #if CONFIG_MULTITHREAD
128 pthread_mutex_destroy(&ctx->buffer_pool->pool_mutex);
132 if (ctx->buffer_pool)
133 vp9_free_internal_frame_buffers(&ctx->buffer_pool->int_frame_buffers);
135 vpx_free(ctx->frame_workers);
136 vpx_free(ctx->buffer_pool);
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.
154 if (profile == PROFILE_1 || profile == PROFILE_3) {
155 rb->bit_offset += 1; // unused
157 // RGB is only available in version 1.
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,
168 vpx_decrypt_cb decrypt_cb,
169 void *decrypt_state) {
170 int intra_only_flag = 0;
171 uint8_t clear_buffer[9];
173 if (data + data_sz <= data)
174 return VPX_CODEC_INVALID_PARAM;
180 data_sz = MIN(sizeof(clear_buffer), data_sz);
181 decrypt_cb(decrypt_state, data, clear_buffer, data_sz);
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);
192 if (frame_marker != VP9_FRAME_MARKER)
193 return VPX_CODEC_UNSUP_BITSTREAM;
195 if (profile >= MAX_PROFILES)
196 return VPX_CODEC_UNSUP_BITSTREAM;
198 if ((profile >= 2 && data_sz <= 1) || data_sz < 1)
199 return VPX_CODEC_UNSUP_BITSTREAM;
201 if (vp9_rb_read_bit(&rb)) { // show an existing frame
202 vp9_rb_read_literal(&rb, 3); // Frame buffer to show.
207 return VPX_CODEC_UNSUP_BITSTREAM;
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);
214 if (!vp9_read_sync_code(&rb))
215 return VPX_CODEC_UNSUP_BITSTREAM;
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);
221 intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
223 rb.bit_offset += error_resilient ? 0 : 2; // reset_frame_context
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;
232 rb.bit_offset += REF_FRAMES; // refresh_frame_flags
233 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
237 if (is_intra_only != NULL)
238 *is_intra_only = intra_only_flag;
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);
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;
259 static void set_error_detail(vpx_codec_alg_priv_t *ctx,
260 const char *const error) {
261 ctx->base.err_detail = error;
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);
269 return error->error_code;
272 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
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;
282 cm->byte_alignment = ctx->byte_alignment;
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;
289 pool->get_fb_cb = vp9_get_frame_buffer;
290 pool->release_fb_cb = vp9_release_frame_buffer;
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");
296 pool->cb_priv = &pool->int_frame_buffers;
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;
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;
312 flags->deblocking_level = ctx->postproc_cfg.deblocking_level;
313 flags->noise_level = ctx->postproc_cfg.noise_level;
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;
321 frame_worker_data->result =
322 vp9_receive_compressed_data(frame_worker_data->pbi,
323 frame_worker_data->data_size,
325 frame_worker_data->data_end = data;
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);
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;
350 return !frame_worker_data->result;
353 static vpx_codec_err_t init_decoder(vpx_codec_alg_priv_t *ctx) {
355 const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
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->need_resync = 1;
365 ctx->num_frame_workers =
366 (ctx->frame_parallel_decode == 1) ? ctx->cfg.threads: 1;
367 if (ctx->num_frame_workers > MAX_DECODE_THREADS)
368 ctx->num_frame_workers = MAX_DECODE_THREADS;
369 ctx->available_threads = ctx->num_frame_workers;
372 ctx->buffer_pool = (BufferPool *)vpx_calloc(1, sizeof(BufferPool));
373 if (ctx->buffer_pool == NULL)
374 return VPX_CODEC_MEM_ERROR;
376 #if CONFIG_MULTITHREAD
377 if (pthread_mutex_init(&ctx->buffer_pool->pool_mutex, NULL)) {
378 set_error_detail(ctx, "Failed to allocate buffer pool mutex");
379 return VPX_CODEC_MEM_ERROR;
383 ctx->frame_workers = (VP9Worker *)
384 vpx_malloc(ctx->num_frame_workers * sizeof(*ctx->frame_workers));
385 if (ctx->frame_workers == NULL) {
386 set_error_detail(ctx, "Failed to allocate frame_workers");
387 return VPX_CODEC_MEM_ERROR;
390 for (i = 0; i < ctx->num_frame_workers; ++i) {
391 VP9Worker *const worker = &ctx->frame_workers[i];
392 FrameWorkerData *frame_worker_data = NULL;
393 winterface->init(worker);
394 worker->data1 = vpx_memalign(32, sizeof(FrameWorkerData));
395 if (worker->data1 == NULL) {
396 set_error_detail(ctx, "Failed to allocate frame_worker_data");
397 return VPX_CODEC_MEM_ERROR;
399 frame_worker_data = (FrameWorkerData *)worker->data1;
400 frame_worker_data->pbi = vp9_decoder_create(ctx->buffer_pool);
401 if (frame_worker_data->pbi == NULL) {
402 set_error_detail(ctx, "Failed to allocate frame_worker_data");
403 return VPX_CODEC_MEM_ERROR;
405 frame_worker_data->pbi->frame_worker_owner = worker;
406 frame_worker_data->worker_id = i;
407 frame_worker_data->scratch_buffer = NULL;
408 frame_worker_data->scratch_buffer_size = 0;
409 frame_worker_data->frame_context_ready = 0;
410 frame_worker_data->received_frame = 0;
411 #if CONFIG_MULTITHREAD
412 if (pthread_mutex_init(&frame_worker_data->stats_mutex, NULL)) {
413 set_error_detail(ctx, "Failed to allocate frame_worker_data mutex");
414 return VPX_CODEC_MEM_ERROR;
417 if (pthread_cond_init(&frame_worker_data->stats_cond, NULL)) {
418 set_error_detail(ctx, "Failed to allocate frame_worker_data cond");
419 return VPX_CODEC_MEM_ERROR;
422 // If decoding in serial mode, FrameWorker thread could create tile worker
423 // thread or loopfilter thread.
424 frame_worker_data->pbi->max_threads =
425 (ctx->frame_parallel_decode == 0) ? ctx->cfg.threads : 0;
427 frame_worker_data->pbi->inv_tile_order = ctx->invert_tile_order;
428 frame_worker_data->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
429 frame_worker_data->pbi->common.frame_parallel_decode =
430 ctx->frame_parallel_decode;
431 worker->hook = (VP9WorkerHook)frame_worker_hook;
432 if (!winterface->reset(worker)) {
433 set_error_detail(ctx, "Frame Worker thread creation failed");
434 return VPX_CODEC_MEM_ERROR;
438 // If postprocessing was enabled by the application and a
439 // configuration has not been provided, default it.
440 if (!ctx->postproc_cfg_set &&
441 (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
442 set_default_ppflags(&ctx->postproc_cfg);
444 init_buffer_callbacks(ctx);
449 static INLINE void check_resync(vpx_codec_alg_priv_t *const ctx,
450 const VP9Decoder *const pbi) {
451 // Clear resync flag if worker got a key frame or intra only frame.
452 if (ctx->need_resync == 1 && pbi->need_resync == 0 &&
453 (pbi->common.intra_only || pbi->common.frame_type == KEY_FRAME))
454 ctx->need_resync = 0;
457 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
458 const uint8_t **data, unsigned int data_sz,
459 void *user_priv, int64_t deadline) {
460 vp9_ppflags_t flags = {0, 0, 0};
461 const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
464 // Determine the stream parameters. Note that we rely on peek_si to
465 // validate that we have a buffer that does not wrap around the top
468 int is_intra_only = 0;
469 const vpx_codec_err_t res =
470 decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
471 ctx->decrypt_cb, ctx->decrypt_state);
472 if (res != VPX_CODEC_OK)
475 if (!ctx->si.is_kf && !is_intra_only)
476 return VPX_CODEC_ERROR;
479 if (!ctx->frame_parallel_decode) {
480 VP9Worker *const worker = ctx->frame_workers;
481 FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
482 frame_worker_data->data = *data;
483 frame_worker_data->data_size = data_sz;
484 frame_worker_data->user_priv = user_priv;
485 frame_worker_data->received_frame = 1;
487 // Set these even if already initialized. The caller may have changed the
488 // decrypt config between frames.
489 frame_worker_data->pbi->decrypt_cb = ctx->decrypt_cb;
490 frame_worker_data->pbi->decrypt_state = ctx->decrypt_state;
492 worker->had_error = 0;
493 winterface->execute(worker);
495 // Update data pointer after decode.
496 *data = frame_worker_data->data_end;
498 if (worker->had_error)
499 return update_error_state(ctx, &frame_worker_data->pbi->common.error);
501 check_resync(ctx, frame_worker_data->pbi);
503 const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
504 VP9Worker *const worker = &ctx->frame_workers[ctx->next_submit_worker_id];
505 FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
506 // Copy context from last worker thread to next worker thread.
507 if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
508 vp9_frameworker_copy_context(
509 &ctx->frame_workers[ctx->next_submit_worker_id],
510 &ctx->frame_workers[ctx->last_submit_worker_id]);
512 frame_worker_data->pbi->ready_for_new_data = 0;
513 // Copy the compressed data into worker's internal buffer.
514 // TODO(hkuang): Will all the workers allocate the same size
515 // as the size of the first intra frame be better? This will
516 // avoid too many deallocate and allocate.
517 if (frame_worker_data->scratch_buffer_size < data_sz) {
518 frame_worker_data->scratch_buffer =
519 (uint8_t *)vpx_realloc(frame_worker_data->scratch_buffer, data_sz);
520 if (frame_worker_data->scratch_buffer == NULL) {
521 set_error_detail(ctx, "Failed to reallocate scratch buffer");
522 return VPX_CODEC_MEM_ERROR;
524 frame_worker_data->scratch_buffer_size = data_sz;
526 frame_worker_data->data_size = data_sz;
527 vpx_memcpy(frame_worker_data->scratch_buffer, *data, data_sz);
529 frame_worker_data->frame_decoded = 0;
530 frame_worker_data->frame_context_ready = 0;
531 frame_worker_data->received_frame = 1;
532 frame_worker_data->data = frame_worker_data->scratch_buffer;
533 frame_worker_data->user_priv = user_priv;
535 if (ctx->next_submit_worker_id != ctx->last_submit_worker_id)
536 ctx->last_submit_worker_id =
537 (ctx->last_submit_worker_id + 1) % ctx->num_frame_workers;
539 ctx->next_submit_worker_id =
540 (ctx->next_submit_worker_id + 1) % ctx->num_frame_workers;
541 --ctx->available_threads;
542 worker->had_error = 0;
543 winterface->launch(worker);
546 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
547 set_ppflags(ctx, &flags);
552 static void wait_worker_and_cache_frame(vpx_codec_alg_priv_t *ctx) {
553 YV12_BUFFER_CONFIG sd;
554 vp9_ppflags_t flags = {0, 0, 0};
555 const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
556 VP9Worker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
557 FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
558 ctx->next_output_worker_id =
559 (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
560 // TODO(hkuang): Add worker error handling here.
561 winterface->sync(worker);
562 frame_worker_data->received_frame = 0;
563 ++ctx->available_threads;
565 check_resync(ctx, frame_worker_data->pbi);
567 if (vp9_get_raw_frame(frame_worker_data->pbi, &sd, &flags) == 0) {
568 VP9_COMMON *const cm = &frame_worker_data->pbi->common;
569 RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
570 ctx->frame_cache[ctx->frame_cache_write].fb_idx = cm->new_fb_idx;
571 yuvconfig2image(&ctx->frame_cache[ctx->frame_cache_write].img, &sd,
572 frame_worker_data->user_priv);
573 ctx->frame_cache[ctx->frame_cache_write].img.fb_priv =
574 frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
575 ctx->frame_cache_write =
576 (ctx->frame_cache_write + 1) % FRAME_CACHE_SIZE;
577 ++ctx->num_cache_frames;
581 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
582 const uint8_t *data, unsigned int data_sz,
583 void *user_priv, long deadline) {
584 const uint8_t *data_start = data;
585 const uint8_t * const data_end = data + data_sz;
587 uint32_t frame_sizes[8];
590 if (data == NULL && data_sz == 0) {
595 // Reset flushed when receiving a valid frame.
598 // Initialize the decoder workers on the first frame.
599 if (ctx->frame_workers == NULL) {
600 const vpx_codec_err_t res = init_decoder(ctx);
601 if (res != VPX_CODEC_OK)
605 res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
606 ctx->decrypt_cb, ctx->decrypt_state);
607 if (res != VPX_CODEC_OK)
610 if (ctx->frame_parallel_decode) {
611 // Decode in frame parallel mode. When decoding in this mode, the frame
612 // passed to the decoder must be either a normal frame or a superframe with
613 // superframe index so the decoder could get each frame's start position
614 // in the superframe.
615 if (frame_count > 0) {
618 for (i = 0; i < frame_count; ++i) {
619 const uint8_t *data_start_copy = data_start;
620 const uint32_t frame_size = frame_sizes[i];
621 if (data_start < data
622 || frame_size > (uint32_t) (data_end - data_start)) {
623 set_error_detail(ctx, "Invalid frame size in index");
624 return VPX_CODEC_CORRUPT_FRAME;
627 if (ctx->available_threads == 0) {
628 // No more threads for decoding. Wait until the next output worker
629 // finishes decoding. Then copy the decoded frame into cache.
630 if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
631 wait_worker_and_cache_frame(ctx);
633 // TODO(hkuang): Add unit test to test this path.
634 set_error_detail(ctx, "Frame output cache is full.");
635 return VPX_CODEC_ERROR;
639 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
641 if (res != VPX_CODEC_OK)
643 data_start += frame_size;
646 if (ctx->available_threads == 0) {
647 // No more threads for decoding. Wait until the next output worker
648 // finishes decoding. Then copy the decoded frame into cache.
649 if (ctx->num_cache_frames < FRAME_CACHE_SIZE) {
650 wait_worker_and_cache_frame(ctx);
652 // TODO(hkuang): Add unit test to test this path.
653 set_error_detail(ctx, "Frame output cache is full.");
654 return VPX_CODEC_ERROR;
658 res = decode_one(ctx, &data, data_sz, user_priv, deadline);
659 if (res != VPX_CODEC_OK)
663 // Decode in serial mode.
664 if (frame_count > 0) {
667 for (i = 0; i < frame_count; ++i) {
668 const uint8_t *data_start_copy = data_start;
669 const uint32_t frame_size = frame_sizes[i];
671 if (data_start < data
672 || frame_size > (uint32_t) (data_end - data_start)) {
673 set_error_detail(ctx, "Invalid frame size in index");
674 return VPX_CODEC_CORRUPT_FRAME;
677 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
679 if (res != VPX_CODEC_OK)
682 data_start += frame_size;
685 while (data_start < data_end) {
686 const uint32_t frame_size = (uint32_t) (data_end - data_start);
687 const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
688 user_priv, deadline);
689 if (res != VPX_CODEC_OK)
692 // Account for suboptimal termination by the encoder.
693 while (data_start < data_end) {
694 const uint8_t marker = read_marker(ctx->decrypt_cb,
695 ctx->decrypt_state, data_start);
707 static void release_last_output_frame(vpx_codec_alg_priv_t *ctx) {
708 RefCntBuffer *const frame_bufs = ctx->buffer_pool->frame_bufs;
709 // Decrease reference count of last output frame in frame parallel mode.
710 if (ctx->frame_parallel_decode && ctx->last_show_frame >= 0) {
711 BufferPool *const pool = ctx->buffer_pool;
712 lock_buffer_pool(pool);
713 decrease_ref_count(ctx->last_show_frame, frame_bufs, pool);
714 unlock_buffer_pool(pool);
718 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
719 vpx_codec_iter_t *iter) {
720 vpx_image_t *img = NULL;
722 // Only return frame when all the cpu are busy or
723 // application fluhsed the decoder in frame parallel decode.
724 if (ctx->frame_parallel_decode && ctx->available_threads > 0 &&
729 // Output the frames in the cache first.
730 if (ctx->num_cache_frames > 0) {
731 release_last_output_frame(ctx);
732 ctx->last_show_frame = ctx->frame_cache[ctx->frame_cache_read].fb_idx;
733 if (ctx->need_resync)
735 img = &ctx->frame_cache[ctx->frame_cache_read].img;
736 ctx->frame_cache_read = (ctx->frame_cache_read + 1) % FRAME_CACHE_SIZE;
737 --ctx->num_cache_frames;
741 // iter acts as a flip flop, so an image is only returned on the first
742 // call to get_frame.
743 if (*iter == NULL && ctx->frame_workers != NULL) {
745 YV12_BUFFER_CONFIG sd;
746 vp9_ppflags_t flags = {0, 0, 0};
747 const VP9WorkerInterface *const winterface = vp9_get_worker_interface();
748 VP9Worker *const worker =
749 &ctx->frame_workers[ctx->next_output_worker_id];
750 FrameWorkerData *const frame_worker_data =
751 (FrameWorkerData *)worker->data1;
752 ctx->next_output_worker_id =
753 (ctx->next_output_worker_id + 1) % ctx->num_frame_workers;
754 // Wait for the frame from worker thread.
755 if (winterface->sync(worker)) {
756 // Check if worker has received any frames.
757 if (frame_worker_data->received_frame == 1) {
758 ++ctx->available_threads;
759 frame_worker_data->received_frame = 0;
760 check_resync(ctx, frame_worker_data->pbi);
762 if (vp9_get_raw_frame(frame_worker_data->pbi, &sd, &flags) == 0) {
763 VP9_COMMON *const cm = &frame_worker_data->pbi->common;
764 RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
765 release_last_output_frame(ctx);
766 ctx->last_show_frame = frame_worker_data->pbi->common.new_fb_idx;
767 if (ctx->need_resync)
769 yuvconfig2image(&ctx->img, &sd, frame_worker_data->user_priv);
770 ctx->img.fb_priv = frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
775 // Decoding failed. Release the worker thread.
776 frame_worker_data->received_frame = 0;
777 ++ctx->available_threads;
778 ctx->need_resync = 1;
779 if (ctx->flushed != 1)
782 } while (ctx->next_output_worker_id != ctx->next_submit_worker_id);
787 static vpx_codec_err_t decoder_set_fb_fn(
788 vpx_codec_alg_priv_t *ctx,
789 vpx_get_frame_buffer_cb_fn_t cb_get,
790 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
791 if (cb_get == NULL || cb_release == NULL) {
792 return VPX_CODEC_INVALID_PARAM;
793 } else if (ctx->frame_workers == NULL) {
794 // If the decoder has already been initialized, do not accept changes to
795 // the frame buffer functions.
796 ctx->get_ext_fb_cb = cb_get;
797 ctx->release_ext_fb_cb = cb_release;
798 ctx->ext_priv = cb_priv;
802 return VPX_CODEC_ERROR;
805 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
807 vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
809 // Only support this function in serial decode.
810 if (ctx->frame_parallel_decode) {
811 set_error_detail(ctx, "Not supported in frame parallel decode");
812 return VPX_CODEC_INCAPABLE;
816 vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
817 YV12_BUFFER_CONFIG sd;
818 VP9Worker *const worker = ctx->frame_workers;
819 FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
820 image2yuvconfig(&frame->img, &sd);
821 return vp9_set_reference_dec(&frame_worker_data->pbi->common,
822 (VP9_REFFRAME)frame->frame_type, &sd);
824 return VPX_CODEC_INVALID_PARAM;
828 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
830 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
832 // Only support this function in serial decode.
833 if (ctx->frame_parallel_decode) {
834 set_error_detail(ctx, "Not supported in frame parallel decode");
835 return VPX_CODEC_INCAPABLE;
839 vpx_ref_frame_t *frame = (vpx_ref_frame_t *) data;
840 YV12_BUFFER_CONFIG sd;
841 VP9Worker *const worker = ctx->frame_workers;
842 FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
843 image2yuvconfig(&frame->img, &sd);
844 return vp9_copy_reference_dec(frame_worker_data->pbi,
845 (VP9_REFFRAME)frame->frame_type, &sd);
847 return VPX_CODEC_INVALID_PARAM;
851 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
853 vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
855 // Only support this function in serial decode.
856 if (ctx->frame_parallel_decode) {
857 set_error_detail(ctx, "Not supported in frame parallel decode");
858 return VPX_CODEC_INCAPABLE;
862 YV12_BUFFER_CONFIG* fb;
863 VP9Worker *const worker = ctx->frame_workers;
864 FrameWorkerData *const frame_worker_data = (FrameWorkerData *)worker->data1;
865 fb = get_ref_frame(&frame_worker_data->pbi->common, data->idx);
866 if (fb == NULL) return VPX_CODEC_ERROR;
867 yuvconfig2image(&data->img, fb, NULL);
870 return VPX_CODEC_INVALID_PARAM;
874 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
876 #if CONFIG_VP9_POSTPROC
877 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
880 ctx->postproc_cfg_set = 1;
881 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
884 return VPX_CODEC_INVALID_PARAM;
889 return VPX_CODEC_INCAPABLE;
893 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
897 return VPX_CODEC_INCAPABLE;
900 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
902 int *const update_info = va_arg(args, int *);
904 // Only support this function in serial decode.
905 if (ctx->frame_parallel_decode) {
906 set_error_detail(ctx, "Not supported in frame parallel decode");
907 return VPX_CODEC_INCAPABLE;
911 if (ctx->frame_workers) {
912 VP9Worker *const worker = ctx->frame_workers;
913 FrameWorkerData *const frame_worker_data =
914 (FrameWorkerData *)worker->data1;
915 *update_info = frame_worker_data->pbi->refresh_frame_flags;
918 return VPX_CODEC_ERROR;
922 return VPX_CODEC_INVALID_PARAM;
925 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
927 int *corrupted = va_arg(args, int *);
930 if (ctx->frame_workers) {
931 VP9Worker *const worker = ctx->frame_workers;
932 FrameWorkerData *const frame_worker_data =
933 (FrameWorkerData *)worker->data1;
934 RefCntBuffer *const frame_bufs =
935 frame_worker_data->pbi->common.buffer_pool->frame_bufs;
936 if (frame_worker_data->pbi->common.frame_to_show == NULL)
937 return VPX_CODEC_ERROR;
938 *corrupted = frame_bufs[ctx->last_show_frame].buf.corrupted;
941 return VPX_CODEC_ERROR;
945 return VPX_CODEC_INVALID_PARAM;
948 static vpx_codec_err_t ctrl_get_frame_size(vpx_codec_alg_priv_t *ctx,
950 int *const frame_size = va_arg(args, int *);
952 // Only support this function in serial decode.
953 if (ctx->frame_parallel_decode) {
954 set_error_detail(ctx, "Not supported in frame parallel decode");
955 return VPX_CODEC_INCAPABLE;
959 if (ctx->frame_workers) {
960 VP9Worker *const worker = ctx->frame_workers;
961 FrameWorkerData *const frame_worker_data =
962 (FrameWorkerData *)worker->data1;
963 const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
964 frame_size[0] = cm->width;
965 frame_size[1] = cm->height;
968 return VPX_CODEC_ERROR;
972 return VPX_CODEC_INVALID_PARAM;
975 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
977 int *const display_size = va_arg(args, int *);
979 // Only support this function in serial decode.
980 if (ctx->frame_parallel_decode) {
981 set_error_detail(ctx, "Not supported in frame parallel decode");
982 return VPX_CODEC_INCAPABLE;
986 if (ctx->frame_workers) {
987 VP9Worker *const worker = ctx->frame_workers;
988 FrameWorkerData *const frame_worker_data =
989 (FrameWorkerData *)worker->data1;
990 const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
991 display_size[0] = cm->display_width;
992 display_size[1] = cm->display_height;
995 return VPX_CODEC_ERROR;
999 return VPX_CODEC_INVALID_PARAM;
1002 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
1004 unsigned int *const bit_depth = va_arg(args, unsigned int *);
1005 VP9Worker *const worker = &ctx->frame_workers[ctx->next_output_worker_id];
1009 FrameWorkerData *const frame_worker_data =
1010 (FrameWorkerData *)worker->data1;
1011 const VP9_COMMON *const cm = &frame_worker_data->pbi->common;
1012 *bit_depth = cm->bit_depth;
1013 return VPX_CODEC_OK;
1015 return VPX_CODEC_ERROR;
1019 return VPX_CODEC_INVALID_PARAM;
1022 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
1024 ctx->invert_tile_order = va_arg(args, int);
1025 return VPX_CODEC_OK;
1028 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
1030 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
1031 ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
1032 ctx->decrypt_state = init ? init->decrypt_state : NULL;
1033 return VPX_CODEC_OK;
1036 static vpx_codec_err_t ctrl_set_byte_alignment(vpx_codec_alg_priv_t *ctx,
1038 const int legacy_byte_alignment = 0;
1039 const int min_byte_alignment = 32;
1040 const int max_byte_alignment = 1024;
1041 const int byte_alignment = va_arg(args, int);
1043 if (byte_alignment != legacy_byte_alignment &&
1044 (byte_alignment < min_byte_alignment ||
1045 byte_alignment > max_byte_alignment ||
1046 (byte_alignment & (byte_alignment - 1)) != 0))
1047 return VPX_CODEC_INVALID_PARAM;
1049 ctx->byte_alignment = byte_alignment;
1050 if (ctx->frame_workers) {
1051 VP9Worker *const worker = ctx->frame_workers;
1052 FrameWorkerData *const frame_worker_data =
1053 (FrameWorkerData *)worker->data1;
1054 frame_worker_data->pbi->common.byte_alignment = byte_alignment;
1056 return VPX_CODEC_OK;
1059 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
1060 {VP8_COPY_REFERENCE, ctrl_copy_reference},
1063 {VP8_SET_REFERENCE, ctrl_set_reference},
1064 {VP8_SET_POSTPROC, ctrl_set_postproc},
1065 {VP8_SET_DBG_COLOR_REF_FRAME, ctrl_set_dbg_options},
1066 {VP8_SET_DBG_COLOR_MB_MODES, ctrl_set_dbg_options},
1067 {VP8_SET_DBG_COLOR_B_MODES, ctrl_set_dbg_options},
1068 {VP8_SET_DBG_DISPLAY_MV, ctrl_set_dbg_options},
1069 {VP9_INVERT_TILE_DECODE_ORDER, ctrl_set_invert_tile_order},
1070 {VPXD_SET_DECRYPTOR, ctrl_set_decryptor},
1071 {VP9_SET_BYTE_ALIGNMENT, ctrl_set_byte_alignment},
1074 {VP8D_GET_LAST_REF_UPDATES, ctrl_get_last_ref_updates},
1075 {VP8D_GET_FRAME_CORRUPTED, ctrl_get_frame_corrupted},
1076 {VP9_GET_REFERENCE, ctrl_get_reference},
1077 {VP9D_GET_DISPLAY_SIZE, ctrl_get_display_size},
1078 {VP9D_GET_BIT_DEPTH, ctrl_get_bit_depth},
1079 {VP9D_GET_FRAME_SIZE, ctrl_get_frame_size},
1084 #ifndef VERSION_STRING
1085 #define VERSION_STRING
1087 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
1088 "WebM Project VP9 Decoder" VERSION_STRING,
1089 VPX_CODEC_INTERNAL_ABI_VERSION,
1090 VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
1091 VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER, // vpx_codec_caps_t
1092 decoder_init, // vpx_codec_init_fn_t
1093 decoder_destroy, // vpx_codec_destroy_fn_t
1094 decoder_ctrl_maps, // vpx_codec_ctrl_fn_map_t
1096 decoder_peek_si, // vpx_codec_peek_si_fn_t
1097 decoder_get_si, // vpx_codec_get_si_fn_t
1098 decoder_decode, // vpx_codec_decode_fn_t
1099 decoder_get_frame, // vpx_codec_frame_get_fn_t
1100 decoder_set_fb_fn, // vpx_codec_set_fb_fn_t
1104 NULL, // vpx_codec_enc_cfg_map_t
1105 NULL, // vpx_codec_encode_fn_t
1106 NULL, // vpx_codec_get_cx_data_fn_t
1107 NULL, // vpx_codec_enc_config_set_fn_t
1108 NULL, // vpx_codec_get_global_headers_fn_t
1109 NULL, // vpx_codec_get_preview_frame_fn_t
1110 NULL // vpx_codec_enc_mr_get_mem_loc_fn_t