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.
15 #include "./vp9_rtcd.h"
16 #include "./vpx_dsp_rtcd.h"
17 #include "./vpx_scale_rtcd.h"
19 #include "vpx_mem/vpx_mem.h"
20 #include "vpx_ports/system_state.h"
21 #include "vpx_ports/vpx_once.h"
22 #include "vpx_ports/vpx_timer.h"
23 #include "vpx_scale/vpx_scale.h"
24 #include "vpx_util/vpx_thread.h"
26 #include "vp9/common/vp9_alloccommon.h"
27 #include "vp9/common/vp9_loopfilter.h"
28 #include "vp9/common/vp9_onyxc_int.h"
29 #if CONFIG_VP9_POSTPROC
30 #include "vp9/common/vp9_postproc.h"
32 #include "vp9/common/vp9_quant_common.h"
33 #include "vp9/common/vp9_reconintra.h"
35 #include "vp9/decoder/vp9_decodeframe.h"
36 #include "vp9/decoder/vp9_decoder.h"
37 #include "vp9/decoder/vp9_detokenize.h"
39 static void initialize_dec(void) {
40 static volatile int init_done = 0;
46 vp9_init_intra_predictors();
51 static void vp9_dec_setup_mi(VP9_COMMON *cm) {
52 cm->mi = cm->mip + cm->mi_stride + 1;
53 cm->mi_grid_visible = cm->mi_grid_base + cm->mi_stride + 1;
54 memset(cm->mi_grid_base, 0,
55 cm->mi_stride * (cm->mi_rows + 1) * sizeof(*cm->mi_grid_base));
58 static int vp9_dec_alloc_mi(VP9_COMMON *cm, int mi_size) {
59 cm->mip = vpx_calloc(mi_size, sizeof(*cm->mip));
62 cm->mi_alloc_size = mi_size;
63 cm->mi_grid_base = (MODE_INFO **)vpx_calloc(mi_size, sizeof(MODE_INFO*));
64 if (!cm->mi_grid_base)
69 static void vp9_dec_free_mi(VP9_COMMON *cm) {
72 vpx_free(cm->mi_grid_base);
73 cm->mi_grid_base = NULL;
76 VP9Decoder *vp9_decoder_create(BufferPool *const pool) {
77 VP9Decoder *volatile const pbi = vpx_memalign(32, sizeof(*pbi));
78 VP9_COMMON *volatile const cm = pbi ? &pbi->common : NULL;
85 if (setjmp(cm->error.jmp)) {
87 vp9_decoder_remove(pbi);
93 CHECK_MEM_ERROR(cm, cm->fc,
94 (FRAME_CONTEXT *)vpx_calloc(1, sizeof(*cm->fc)));
95 CHECK_MEM_ERROR(cm, cm->frame_contexts,
96 (FRAME_CONTEXT *)vpx_calloc(FRAME_CONTEXTS,
97 sizeof(*cm->frame_contexts)));
100 once(initialize_dec);
102 // Initialize the references to not point to any frame buffers.
103 memset(&cm->ref_frame_map, -1, sizeof(cm->ref_frame_map));
104 memset(&cm->next_ref_frame_map, -1, sizeof(cm->next_ref_frame_map));
106 cm->current_video_frame = 0;
107 pbi->ready_for_new_data = 1;
108 pbi->common.buffer_pool = pool;
110 cm->bit_depth = VPX_BITS_8;
111 cm->dequant_bit_depth = VPX_BITS_8;
113 cm->alloc_mi = vp9_dec_alloc_mi;
114 cm->free_mi = vp9_dec_free_mi;
115 cm->setup_mi = vp9_dec_setup_mi;
117 vp9_loop_filter_init(cm);
119 cm->error.setjmp = 0;
121 vpx_get_worker_interface()->init(&pbi->lf_worker);
126 void vp9_decoder_remove(VP9Decoder *pbi) {
129 vpx_get_worker_interface()->end(&pbi->lf_worker);
130 vpx_free(pbi->lf_worker.data1);
131 vpx_free(pbi->tile_data);
132 for (i = 0; i < pbi->num_tile_workers; ++i) {
133 VPxWorker *const worker = &pbi->tile_workers[i];
134 vpx_get_worker_interface()->end(worker);
136 vpx_free(pbi->tile_worker_data);
137 vpx_free(pbi->tile_worker_info);
138 vpx_free(pbi->tile_workers);
140 if (pbi->num_tile_workers > 0) {
141 vp9_loop_filter_dealloc(&pbi->lf_row_sync);
147 static int equal_dimensions(const YV12_BUFFER_CONFIG *a,
148 const YV12_BUFFER_CONFIG *b) {
149 return a->y_height == b->y_height && a->y_width == b->y_width &&
150 a->uv_height == b->uv_height && a->uv_width == b->uv_width;
153 vpx_codec_err_t vp9_copy_reference_dec(VP9Decoder *pbi,
154 VP9_REFFRAME ref_frame_flag,
155 YV12_BUFFER_CONFIG *sd) {
156 VP9_COMMON *cm = &pbi->common;
158 /* TODO(jkoleszar): The decoder doesn't have any real knowledge of what the
159 * encoder is using the frame buffers for. This is just a stub to keep the
160 * vpxenc --test-decode functionality working, and will be replaced in a
161 * later commit that adds VP9-specific controls for this functionality.
163 if (ref_frame_flag == VP9_LAST_FLAG) {
164 const YV12_BUFFER_CONFIG *const cfg = get_ref_frame(cm, 0);
166 vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
167 "No 'last' reference frame");
168 return VPX_CODEC_ERROR;
170 if (!equal_dimensions(cfg, sd))
171 vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
172 "Incorrect buffer dimensions");
174 vp8_yv12_copy_frame(cfg, sd);
176 vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
177 "Invalid reference frame");
180 return cm->error.error_code;
184 vpx_codec_err_t vp9_set_reference_dec(VP9_COMMON *cm,
185 VP9_REFFRAME ref_frame_flag,
186 YV12_BUFFER_CONFIG *sd) {
187 RefBuffer *ref_buf = NULL;
188 RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
190 // TODO(jkoleszar): The decoder doesn't have any real knowledge of what the
191 // encoder is using the frame buffers for. This is just a stub to keep the
192 // vpxenc --test-decode functionality working, and will be replaced in a
193 // later commit that adds VP9-specific controls for this functionality.
194 if (ref_frame_flag == VP9_LAST_FLAG) {
195 ref_buf = &cm->frame_refs[0];
196 } else if (ref_frame_flag == VP9_GOLD_FLAG) {
197 ref_buf = &cm->frame_refs[1];
198 } else if (ref_frame_flag == VP9_ALT_FLAG) {
199 ref_buf = &cm->frame_refs[2];
201 vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
202 "Invalid reference frame");
203 return cm->error.error_code;
206 if (!equal_dimensions(ref_buf->buf, sd)) {
207 vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
208 "Incorrect buffer dimensions");
210 int *ref_fb_ptr = &ref_buf->idx;
212 // Find an empty frame buffer.
213 const int free_fb = get_free_fb(cm);
214 if (cm->new_fb_idx == INVALID_IDX)
215 return VPX_CODEC_MEM_ERROR;
217 // Decrease ref_count since it will be increased again in
218 // ref_cnt_fb() below.
219 --frame_bufs[free_fb].ref_count;
221 // Manage the reference counters and copy image.
222 ref_cnt_fb(frame_bufs, ref_fb_ptr, free_fb);
223 ref_buf->buf = &frame_bufs[*ref_fb_ptr].buf;
224 vp8_yv12_copy_frame(sd, ref_buf->buf);
227 return cm->error.error_code;
230 /* If any buffer updating is signaled it should be done here. */
231 static void swap_frame_buffers(VP9Decoder *pbi) {
232 int ref_index = 0, mask;
233 VP9_COMMON *const cm = &pbi->common;
234 BufferPool *const pool = cm->buffer_pool;
235 RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
237 lock_buffer_pool(pool);
238 for (mask = pbi->refresh_frame_flags; mask; mask >>= 1) {
239 const int old_idx = cm->ref_frame_map[ref_index];
240 // Current thread releases the holding of reference frame.
241 decrease_ref_count(old_idx, frame_bufs, pool);
243 // Release the reference frame in reference map.
244 if ((mask & 1) && old_idx >= 0) {
245 decrease_ref_count(old_idx, frame_bufs, pool);
247 cm->ref_frame_map[ref_index] = cm->next_ref_frame_map[ref_index];
251 // Current thread releases the holding of reference frame.
252 for (; ref_index < REF_FRAMES && !cm->show_existing_frame; ++ref_index) {
253 const int old_idx = cm->ref_frame_map[ref_index];
254 decrease_ref_count(old_idx, frame_bufs, pool);
255 cm->ref_frame_map[ref_index] = cm->next_ref_frame_map[ref_index];
257 unlock_buffer_pool(pool);
258 pbi->hold_ref_buf = 0;
259 cm->frame_to_show = get_frame_new_buffer(cm);
261 if (!pbi->frame_parallel_decode || !cm->show_frame) {
262 lock_buffer_pool(pool);
263 --frame_bufs[cm->new_fb_idx].ref_count;
264 unlock_buffer_pool(pool);
267 // Invalidate these references until the next frame starts.
268 for (ref_index = 0; ref_index < 3; ref_index++)
269 cm->frame_refs[ref_index].idx = -1;
272 int vp9_receive_compressed_data(VP9Decoder *pbi,
273 size_t size, const uint8_t **psource) {
274 VP9_COMMON *volatile const cm = &pbi->common;
275 BufferPool *volatile const pool = cm->buffer_pool;
276 RefCntBuffer *volatile const frame_bufs = cm->buffer_pool->frame_bufs;
277 const uint8_t *source = *psource;
279 cm->error.error_code = VPX_CODEC_OK;
282 // This is used to signal that we are missing frames.
283 // We do not know if the missing frame(s) was supposed to update
284 // any of the reference buffers, but we act conservative and
285 // mark only the last buffer as corrupted.
287 // TODO(jkoleszar): Error concealment is undefined and non-normative
288 // at this point, but if it becomes so, [0] may not always be the correct
290 if (cm->frame_refs[0].idx > 0) {
291 assert(cm->frame_refs[0].buf != NULL);
292 cm->frame_refs[0].buf->corrupted = 1;
296 pbi->ready_for_new_data = 0;
298 // Check if the previous frame was a frame without any references to it.
299 // Release frame buffer if not decoding in frame parallel mode.
300 if (!pbi->frame_parallel_decode && cm->new_fb_idx >= 0
301 && frame_bufs[cm->new_fb_idx].ref_count == 0)
302 pool->release_fb_cb(pool->cb_priv,
303 &frame_bufs[cm->new_fb_idx].raw_frame_buffer);
304 // Find a free frame buffer. Return error if can not find any.
305 cm->new_fb_idx = get_free_fb(cm);
306 if (cm->new_fb_idx == INVALID_IDX)
307 return VPX_CODEC_MEM_ERROR;
309 // Assign a MV array to the frame buffer.
310 cm->cur_frame = &pool->frame_bufs[cm->new_fb_idx];
312 pbi->hold_ref_buf = 0;
313 if (pbi->frame_parallel_decode) {
314 VPxWorker *const worker = pbi->frame_worker_owner;
315 vp9_frameworker_lock_stats(worker);
316 frame_bufs[cm->new_fb_idx].frame_worker_owner = worker;
317 // Reset decoding progress.
318 pbi->cur_buf = &frame_bufs[cm->new_fb_idx];
319 pbi->cur_buf->row = -1;
320 pbi->cur_buf->col = -1;
321 vp9_frameworker_unlock_stats(worker);
323 pbi->cur_buf = &frame_bufs[cm->new_fb_idx];
327 if (setjmp(cm->error.jmp)) {
328 const VPxWorkerInterface *const winterface = vpx_get_worker_interface();
331 cm->error.setjmp = 0;
332 pbi->ready_for_new_data = 1;
334 // Synchronize all threads immediately as a subsequent decode call may
335 // cause a resize invalidating some allocations.
336 winterface->sync(&pbi->lf_worker);
337 for (i = 0; i < pbi->num_tile_workers; ++i) {
338 winterface->sync(&pbi->tile_workers[i]);
341 lock_buffer_pool(pool);
342 // Release all the reference buffers if worker thread is holding them.
343 if (pbi->hold_ref_buf == 1) {
344 int ref_index = 0, mask;
345 for (mask = pbi->refresh_frame_flags; mask; mask >>= 1) {
346 const int old_idx = cm->ref_frame_map[ref_index];
347 // Current thread releases the holding of reference frame.
348 decrease_ref_count(old_idx, frame_bufs, pool);
350 // Release the reference frame in reference map.
351 if ((mask & 1) && old_idx >= 0) {
352 decrease_ref_count(old_idx, frame_bufs, pool);
357 // Current thread releases the holding of reference frame.
358 for (; ref_index < REF_FRAMES && !cm->show_existing_frame; ++ref_index) {
359 const int old_idx = cm->ref_frame_map[ref_index];
360 decrease_ref_count(old_idx, frame_bufs, pool);
362 pbi->hold_ref_buf = 0;
364 // Release current frame.
365 decrease_ref_count(cm->new_fb_idx, frame_bufs, pool);
366 unlock_buffer_pool(pool);
368 vpx_clear_system_state();
372 cm->error.setjmp = 1;
373 vp9_decode_frame(pbi, source, source + size, psource);
375 swap_frame_buffers(pbi);
377 vpx_clear_system_state();
379 if (!cm->show_existing_frame) {
380 cm->last_show_frame = cm->show_frame;
381 cm->prev_frame = cm->cur_frame;
382 if (cm->seg.enabled && !pbi->frame_parallel_decode)
383 vp9_swap_current_and_last_seg_map(cm);
386 // Update progress in frame parallel decode.
387 if (pbi->frame_parallel_decode) {
388 // Need to lock the mutex here as another thread may
389 // be accessing this buffer.
390 VPxWorker *const worker = pbi->frame_worker_owner;
391 FrameWorkerData *const frame_worker_data = worker->data1;
392 vp9_frameworker_lock_stats(worker);
394 if (cm->show_frame) {
395 cm->current_video_frame++;
397 frame_worker_data->frame_decoded = 1;
398 frame_worker_data->frame_context_ready = 1;
399 vp9_frameworker_signal_stats(worker);
400 vp9_frameworker_unlock_stats(worker);
402 cm->last_width = cm->width;
403 cm->last_height = cm->height;
404 if (cm->show_frame) {
405 cm->current_video_frame++;
409 cm->error.setjmp = 0;
413 int vp9_get_raw_frame(VP9Decoder *pbi, YV12_BUFFER_CONFIG *sd,
414 vp9_ppflags_t *flags) {
415 VP9_COMMON *const cm = &pbi->common;
417 #if !CONFIG_VP9_POSTPROC
421 if (pbi->ready_for_new_data == 1)
424 pbi->ready_for_new_data = 1;
426 /* no raw frame to show!!! */
430 pbi->ready_for_new_data = 1;
432 #if CONFIG_VP9_POSTPROC
433 if (!cm->show_existing_frame) {
434 ret = vp9_post_proc_frame(cm, sd, flags);
436 *sd = *cm->frame_to_show;
440 *sd = *cm->frame_to_show;
442 #endif /*!CONFIG_POSTPROC*/
443 vpx_clear_system_state();
447 vpx_codec_err_t vp9_parse_superframe_index(const uint8_t *data,
449 uint32_t sizes[8], int *count,
450 vpx_decrypt_cb decrypt_cb,
451 void *decrypt_state) {
452 // A chunk ending with a byte matching 0xc0 is an invalid chunk unless
453 // it is a super frame index. If the last byte of real video compression
454 // data is 0xc0 the encoder must add a 0 byte. If we have the marker but
455 // not the associated matching marker byte at the front of the index we have
456 // an invalid bitstream and need to return an error.
461 marker = read_marker(decrypt_cb, decrypt_state, data + data_sz - 1);
464 if ((marker & 0xe0) == 0xc0) {
465 const uint32_t frames = (marker & 0x7) + 1;
466 const uint32_t mag = ((marker >> 3) & 0x3) + 1;
467 const size_t index_sz = 2 + mag * frames;
469 // This chunk is marked as having a superframe index but doesn't have
470 // enough data for it, thus it's an invalid superframe index.
471 if (data_sz < index_sz)
472 return VPX_CODEC_CORRUPT_FRAME;
475 const uint8_t marker2 = read_marker(decrypt_cb, decrypt_state,
476 data + data_sz - index_sz);
478 // This chunk is marked as having a superframe index but doesn't have
479 // the matching marker byte at the front of the index therefore it's an
481 if (marker != marker2)
482 return VPX_CODEC_CORRUPT_FRAME;
486 // Found a valid superframe index.
488 const uint8_t *x = &data[data_sz - index_sz + 1];
490 // Frames has a maximum of 8 and mag has a maximum of 4.
491 uint8_t clear_buffer[32];
492 assert(sizeof(clear_buffer) >= frames * mag);
494 decrypt_cb(decrypt_state, x, clear_buffer, frames * mag);
498 for (i = 0; i < frames; ++i) {
499 uint32_t this_sz = 0;
501 for (j = 0; j < mag; ++j)
502 this_sz |= (*x++) << (j * 8);