vp9/decoder/vp9_decoder.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 <assert.h>
  12 #include <limits.h>
  13 #include <stdio.h>
  14
  15 #include "./vp9_rtcd.h"
  16 #include "./vpx_dsp_rtcd.h"
  17 #include "./vpx_scale_rtcd.h"
  18
  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"
  25
  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"
  31 #endif
  32 #include "vp9/common/vp9_quant_common.h"
  33 #include "vp9/common/vp9_reconintra.h"
  34
  35 #include "vp9/decoder/vp9_decodeframe.h"
  36 #include "vp9/decoder/vp9_decoder.h"
  37 #include "vp9/decoder/vp9_detokenize.h"
  38
  39 static void initialize_dec(void) {
  40   static volatile int init_done = 0;
  41
  42   if (!init_done) {
  43     vp9_rtcd();
  44     vpx_dsp_rtcd();
  45     vpx_scale_rtcd();
  46     vp9_init_intra_predictors();
  47     init_done = 1;
  48   }
  49 }
  50
  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));
  56 }
  57
  58 static int vp9_dec_alloc_mi(VP9_COMMON *cm, int mi_size) {
  59   cm->mip = vpx_calloc(mi_size, sizeof(*cm->mip));
  60   if (!cm->mip)
  61     return 1;
  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)
  65     return 1;
  66   return 0;
  67 }
  68
  69 static void vp9_dec_free_mi(VP9_COMMON *cm) {
  70   vpx_free(cm->mip);
  71   cm->mip = NULL;
  72   vpx_free(cm->mi_grid_base);
  73   cm->mi_grid_base = NULL;
  74 }
  75
  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;
  79
  80   if (!cm)
  81     return NULL;
  82
  83   vp9_zero(*pbi);
  84
  85   if (setjmp(cm->error.jmp)) {
  86     cm->error.setjmp = 0;
  87     vp9_decoder_remove(pbi);
  88     return NULL;
  89   }
  90
  91   cm->error.setjmp = 1;
  92
  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)));
  98
  99   pbi->need_resync = 1;
 100   once(initialize_dec);
 101
 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));
 105
 106   cm->current_video_frame = 0;
 107   pbi->ready_for_new_data = 1;
 108   pbi->common.buffer_pool = pool;
 109
 110   cm->bit_depth = VPX_BITS_8;
 111   cm->dequant_bit_depth = VPX_BITS_8;
 112
 113   cm->alloc_mi = vp9_dec_alloc_mi;
 114   cm->free_mi = vp9_dec_free_mi;
 115   cm->setup_mi = vp9_dec_setup_mi;
 116
 117   vp9_loop_filter_init(cm);
 118
 119   cm->error.setjmp = 0;
 120
 121   vpx_get_worker_interface()->init(&pbi->lf_worker);
 122
 123   return pbi;
 124 }
 125
 126 void vp9_decoder_remove(VP9Decoder *pbi) {
 127   int i;
 128
 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);
 135   }
 136   vpx_free(pbi->tile_worker_data);
 137   vpx_free(pbi->tile_workers);
 138
 139   if (pbi->num_tile_workers > 0) {
 140     vp9_loop_filter_dealloc(&pbi->lf_row_sync);
 141   }
 142
 143   vpx_free(pbi);
 144 }
 145
 146 static int equal_dimensions(const YV12_BUFFER_CONFIG *a,
 147                             const YV12_BUFFER_CONFIG *b) {
 148     return a->y_height == b->y_height && a->y_width == b->y_width &&
 149            a->uv_height == b->uv_height && a->uv_width == b->uv_width;
 150 }
 151
 152 vpx_codec_err_t vp9_copy_reference_dec(VP9Decoder *pbi,
 153                                        VP9_REFFRAME ref_frame_flag,
 154                                        YV12_BUFFER_CONFIG *sd) {
 155   VP9_COMMON *cm = &pbi->common;
 156
 157   /* TODO(jkoleszar): The decoder doesn't have any real knowledge of what the
 158    * encoder is using the frame buffers for. This is just a stub to keep the
 159    * vpxenc --test-decode functionality working, and will be replaced in a
 160    * later commit that adds VP9-specific controls for this functionality.
 161    */
 162   if (ref_frame_flag == VP9_LAST_FLAG) {
 163     const YV12_BUFFER_CONFIG *const cfg = get_ref_frame(cm, 0);
 164     if (cfg == NULL) {
 165       vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
 166                          "No 'last' reference frame");
 167       return VPX_CODEC_ERROR;
 168     }
 169     if (!equal_dimensions(cfg, sd))
 170       vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
 171                          "Incorrect buffer dimensions");
 172     else
 173       vp8_yv12_copy_frame(cfg, sd);
 174   } else {
 175     vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
 176                        "Invalid reference frame");
 177   }
 178
 179   return cm->error.error_code;
 180 }
 181
 182
 183 vpx_codec_err_t vp9_set_reference_dec(VP9_COMMON *cm,
 184                                       VP9_REFFRAME ref_frame_flag,
 185                                       YV12_BUFFER_CONFIG *sd) {
 186   RefBuffer *ref_buf = NULL;
 187   RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
 188
 189   // TODO(jkoleszar): The decoder doesn't have any real knowledge of what the
 190   // encoder is using the frame buffers for. This is just a stub to keep the
 191   // vpxenc --test-decode functionality working, and will be replaced in a
 192   // later commit that adds VP9-specific controls for this functionality.
 193   if (ref_frame_flag == VP9_LAST_FLAG) {
 194     ref_buf = &cm->frame_refs[0];
 195   } else if (ref_frame_flag == VP9_GOLD_FLAG) {
 196     ref_buf = &cm->frame_refs[1];
 197   } else if (ref_frame_flag == VP9_ALT_FLAG) {
 198     ref_buf = &cm->frame_refs[2];
 199   } else {
 200     vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
 201                        "Invalid reference frame");
 202     return cm->error.error_code;
 203   }
 204
 205   if (!equal_dimensions(ref_buf->buf, sd)) {
 206     vpx_internal_error(&cm->error, VPX_CODEC_ERROR,
 207                        "Incorrect buffer dimensions");
 208   } else {
 209     int *ref_fb_ptr = &ref_buf->idx;
 210
 211     // Find an empty frame buffer.
 212     const int free_fb = get_free_fb(cm);
 213     if (cm->new_fb_idx == INVALID_IDX)
 214       return VPX_CODEC_MEM_ERROR;
 215
 216     // Decrease ref_count since it will be increased again in
 217     // ref_cnt_fb() below.
 218     --frame_bufs[free_fb].ref_count;
 219
 220     // Manage the reference counters and copy image.
 221     ref_cnt_fb(frame_bufs, ref_fb_ptr, free_fb);
 222     ref_buf->buf = &frame_bufs[*ref_fb_ptr].buf;
 223     vp8_yv12_copy_frame(sd, ref_buf->buf);
 224   }
 225
 226   return cm->error.error_code;
 227 }
 228
 229 /* If any buffer updating is signaled it should be done here. */
 230 static void swap_frame_buffers(VP9Decoder *pbi) {
 231   int ref_index = 0, mask;
 232   VP9_COMMON *const cm = &pbi->common;
 233   BufferPool *const pool = cm->buffer_pool;
 234   RefCntBuffer *const frame_bufs = cm->buffer_pool->frame_bufs;
 235
 236   lock_buffer_pool(pool);
 237   for (mask = pbi->refresh_frame_flags; mask; mask >>= 1) {
 238     const int old_idx = cm->ref_frame_map[ref_index];
 239     // Current thread releases the holding of reference frame.
 240     decrease_ref_count(old_idx, frame_bufs, pool);
 241
 242     // Release the reference frame in reference map.
 243     if ((mask & 1) && old_idx >= 0) {
 244       decrease_ref_count(old_idx, frame_bufs, pool);
 245     }
 246     cm->ref_frame_map[ref_index] = cm->next_ref_frame_map[ref_index];
 247     ++ref_index;
 248   }
 249
 250   // Current thread releases the holding of reference frame.
 251   for (; ref_index < REF_FRAMES && !cm->show_existing_frame; ++ref_index) {
 252     const int old_idx = cm->ref_frame_map[ref_index];
 253     decrease_ref_count(old_idx, frame_bufs, pool);
 254     cm->ref_frame_map[ref_index] = cm->next_ref_frame_map[ref_index];
 255   }
 256   unlock_buffer_pool(pool);
 257   pbi->hold_ref_buf = 0;
 258   cm->frame_to_show = get_frame_new_buffer(cm);
 259
 260   if (!pbi->frame_parallel_decode || !cm->show_frame) {
 261     lock_buffer_pool(pool);
 262     --frame_bufs[cm->new_fb_idx].ref_count;
 263     unlock_buffer_pool(pool);
 264   }
 265
 266   // Invalidate these references until the next frame starts.
 267   for (ref_index = 0; ref_index < 3; ref_index++)
 268     cm->frame_refs[ref_index].idx = -1;
 269 }
 270
 271 int vp9_receive_compressed_data(VP9Decoder *pbi,
 272                                 size_t size, const uint8_t **psource) {
 273   VP9_COMMON *volatile const cm = &pbi->common;
 274   BufferPool *volatile const pool = cm->buffer_pool;
 275   RefCntBuffer *volatile const frame_bufs = cm->buffer_pool->frame_bufs;
 276   const uint8_t *source = *psource;
 277   int retcode = 0;
 278   cm->error.error_code = VPX_CODEC_OK;
 279
 280   if (size == 0) {
 281     // This is used to signal that we are missing frames.
 282     // We do not know if the missing frame(s) was supposed to update
 283     // any of the reference buffers, but we act conservative and
 284     // mark only the last buffer as corrupted.
 285     //
 286     // TODO(jkoleszar): Error concealment is undefined and non-normative
 287     // at this point, but if it becomes so, [0] may not always be the correct
 288     // thing to do here.
 289     if (cm->frame_refs[0].idx > 0) {
 290       assert(cm->frame_refs[0].buf != NULL);
 291       cm->frame_refs[0].buf->corrupted = 1;
 292     }
 293   }
 294
 295   pbi->ready_for_new_data = 0;
 296
 297   // Check if the previous frame was a frame without any references to it.
 298   // Release frame buffer if not decoding in frame parallel mode.
 299   if (!pbi->frame_parallel_decode && cm->new_fb_idx >= 0
 300       && frame_bufs[cm->new_fb_idx].ref_count == 0)
 301     pool->release_fb_cb(pool->cb_priv,
 302                         &frame_bufs[cm->new_fb_idx].raw_frame_buffer);
 303   // Find a free frame buffer. Return error if can not find any.
 304   cm->new_fb_idx = get_free_fb(cm);
 305   if (cm->new_fb_idx == INVALID_IDX)
 306     return VPX_CODEC_MEM_ERROR;
 307
 308   // Assign a MV array to the frame buffer.
 309   cm->cur_frame = &pool->frame_bufs[cm->new_fb_idx];
 310
 311   pbi->hold_ref_buf = 0;
 312   if (pbi->frame_parallel_decode) {
 313     VPxWorker *const worker = pbi->frame_worker_owner;
 314     vp9_frameworker_lock_stats(worker);
 315     frame_bufs[cm->new_fb_idx].frame_worker_owner = worker;
 316     // Reset decoding progress.
 317     pbi->cur_buf = &frame_bufs[cm->new_fb_idx];
 318     pbi->cur_buf->row = -1;
 319     pbi->cur_buf->col = -1;
 320     vp9_frameworker_unlock_stats(worker);
 321   } else {
 322     pbi->cur_buf = &frame_bufs[cm->new_fb_idx];
 323   }
 324
 325
 326   if (setjmp(cm->error.jmp)) {
 327     const VPxWorkerInterface *const winterface = vpx_get_worker_interface();
 328     int i;
 329
 330     cm->error.setjmp = 0;
 331     pbi->ready_for_new_data = 1;
 332
 333     // Synchronize all threads immediately as a subsequent decode call may
 334     // cause a resize invalidating some allocations.
 335     winterface->sync(&pbi->lf_worker);
 336     for (i = 0; i < pbi->num_tile_workers; ++i) {
 337       winterface->sync(&pbi->tile_workers[i]);
 338     }
 339
 340     lock_buffer_pool(pool);
 341     // Release all the reference buffers if worker thread is holding them.
 342     if (pbi->hold_ref_buf == 1) {
 343       int ref_index = 0, mask;
 344       for (mask = pbi->refresh_frame_flags; mask; mask >>= 1) {
 345         const int old_idx = cm->ref_frame_map[ref_index];
 346         // Current thread releases the holding of reference frame.
 347         decrease_ref_count(old_idx, frame_bufs, pool);
 348
 349         // Release the reference frame in reference map.
 350         if ((mask & 1) && old_idx >= 0) {
 351           decrease_ref_count(old_idx, frame_bufs, pool);
 352         }
 353         ++ref_index;
 354       }
 355
 356       // Current thread releases the holding of reference frame.
 357       for (; ref_index < REF_FRAMES && !cm->show_existing_frame; ++ref_index) {
 358         const int old_idx = cm->ref_frame_map[ref_index];
 359         decrease_ref_count(old_idx, frame_bufs, pool);
 360       }
 361       pbi->hold_ref_buf = 0;
 362     }
 363     // Release current frame.
 364     decrease_ref_count(cm->new_fb_idx, frame_bufs, pool);
 365     unlock_buffer_pool(pool);
 366
 367     vpx_clear_system_state();
 368     return -1;
 369   }
 370
 371   cm->error.setjmp = 1;
 372   vp9_decode_frame(pbi, source, source + size, psource);
 373
 374   swap_frame_buffers(pbi);
 375
 376   vpx_clear_system_state();
 377
 378   if (!cm->show_existing_frame) {
 379     cm->last_show_frame = cm->show_frame;
 380     cm->prev_frame = cm->cur_frame;
 381     if (cm->seg.enabled && !pbi->frame_parallel_decode)
 382       vp9_swap_current_and_last_seg_map(cm);
 383   }
 384
 385   // Update progress in frame parallel decode.
 386   if (pbi->frame_parallel_decode) {
 387     // Need to lock the mutex here as another thread may
 388     // be accessing this buffer.
 389     VPxWorker *const worker = pbi->frame_worker_owner;
 390     FrameWorkerData *const frame_worker_data = worker->data1;
 391     vp9_frameworker_lock_stats(worker);
 392
 393     if (cm->show_frame) {
 394       cm->current_video_frame++;
 395     }
 396     frame_worker_data->frame_decoded = 1;
 397     frame_worker_data->frame_context_ready = 1;
 398     vp9_frameworker_signal_stats(worker);
 399     vp9_frameworker_unlock_stats(worker);
 400   } else {
 401     cm->last_width = cm->width;
 402     cm->last_height = cm->height;
 403     if (cm->show_frame) {
 404       cm->current_video_frame++;
 405     }
 406   }
 407
 408   cm->error.setjmp = 0;
 409   return retcode;
 410 }
 411
 412 int vp9_get_raw_frame(VP9Decoder *pbi, YV12_BUFFER_CONFIG *sd,
 413                       vp9_ppflags_t *flags) {
 414   VP9_COMMON *const cm = &pbi->common;
 415   int ret = -1;
 416 #if !CONFIG_VP9_POSTPROC
 417   (void)*flags;
 418 #endif
 419
 420   if (pbi->ready_for_new_data == 1)
 421     return ret;
 422
 423   pbi->ready_for_new_data = 1;
 424
 425   /* no raw frame to show!!! */
 426   if (!cm->show_frame)
 427     return ret;
 428
 429   pbi->ready_for_new_data = 1;
 430
 431 #if CONFIG_VP9_POSTPROC
 432   if (!cm->show_existing_frame) {
 433     ret = vp9_post_proc_frame(cm, sd, flags);
 434   } else {
 435     *sd = *cm->frame_to_show;
 436     ret = 0;
 437   }
 438 #else
 439   *sd = *cm->frame_to_show;
 440   ret = 0;
 441 #endif /*!CONFIG_POSTPROC*/
 442   vpx_clear_system_state();
 443   return ret;
 444 }
 445
 446 vpx_codec_err_t vp9_parse_superframe_index(const uint8_t *data,
 447                                            size_t data_sz,
 448                                            uint32_t sizes[8], int *count,
 449                                            vpx_decrypt_cb decrypt_cb,
 450                                            void *decrypt_state) {
 451   // A chunk ending with a byte matching 0xc0 is an invalid chunk unless
 452   // it is a super frame index. If the last byte of real video compression
 453   // data is 0xc0 the encoder must add a 0 byte. If we have the marker but
 454   // not the associated matching marker byte at the front of the index we have
 455   // an invalid bitstream and need to return an error.
 456
 457   uint8_t marker;
 458
 459   assert(data_sz);
 460   marker = read_marker(decrypt_cb, decrypt_state, data + data_sz - 1);
 461   *count = 0;
 462
 463   if ((marker & 0xe0) == 0xc0) {
 464     const uint32_t frames = (marker & 0x7) + 1;
 465     const uint32_t mag = ((marker >> 3) & 0x3) + 1;
 466     const size_t index_sz = 2 + mag * frames;
 467
 468     // This chunk is marked as having a superframe index but doesn't have
 469     // enough data for it, thus it's an invalid superframe index.
 470     if (data_sz < index_sz)
 471       return VPX_CODEC_CORRUPT_FRAME;
 472
 473     {
 474       const uint8_t marker2 = read_marker(decrypt_cb, decrypt_state,
 475                                           data + data_sz - index_sz);
 476
 477       // This chunk is marked as having a superframe index but doesn't have
 478       // the matching marker byte at the front of the index therefore it's an
 479       // invalid chunk.
 480       if (marker != marker2)
 481         return VPX_CODEC_CORRUPT_FRAME;
 482     }
 483
 484     {
 485       // Found a valid superframe index.
 486       uint32_t i, j;
 487       const uint8_t *x = &data[data_sz - index_sz + 1];
 488
 489       // Frames has a maximum of 8 and mag has a maximum of 4.
 490       uint8_t clear_buffer[32];
 491       assert(sizeof(clear_buffer) >= frames * mag);
 492       if (decrypt_cb) {
 493         decrypt_cb(decrypt_state, x, clear_buffer, frames * mag);
 494         x = clear_buffer;
 495       }
 496
 497       for (i = 0; i < frames; ++i) {
 498         uint32_t this_sz = 0;
 499
 500         for (j = 0; j < mag; ++j)
 501           this_sz |= (*x++) << (j * 8);
 502         sizes[i] = this_sz;
 503       }
 504       *count = frames;
 505     }
 506   }
 507   return VPX_CODEC_OK;
 508 }