2 * H.26L/H.264/AVC/JVT/14496-10/... reference picture handling
3 * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * H.264 / AVC / MPEG4 part10 reference picture handling.
25 * @author Michael Niedermayer <michaelni@gmx.at>
28 #include "libavutil/avassert.h"
39 static void pic_as_field(Picture *pic, const int parity){
41 for (i = 0; i < 4; ++i) {
42 if (parity == PICT_BOTTOM_FIELD)
43 pic->data[i] += pic->linesize[i];
44 pic->reference = parity;
45 pic->linesize[i] *= 2;
47 pic->poc= pic->field_poc[parity == PICT_BOTTOM_FIELD];
50 static int split_field_copy(Picture *dest, Picture *src,
51 int parity, int id_add){
52 int match = !!(src->reference & parity);
56 if(parity != PICT_FRAME){
57 pic_as_field(dest, parity);
59 dest->pic_id += id_add;
66 static int build_def_list(Picture *def, Picture **in, int len, int is_long, int sel){
70 while(i[0]<len || i[1]<len){
71 while(i[0]<len && !(in[ i[0] ] && (in[ i[0] ]->reference & sel)))
73 while(i[1]<len && !(in[ i[1] ] && (in[ i[1] ]->reference & (sel^3))))
76 in[ i[0] ]->pic_id= is_long ? i[0] : in[ i[0] ]->frame_num;
77 split_field_copy(&def[index++], in[ i[0]++ ], sel , 1);
80 in[ i[1] ]->pic_id= is_long ? i[1] : in[ i[1] ]->frame_num;
81 split_field_copy(&def[index++], in[ i[1]++ ], sel^3, 0);
88 static int add_sorted(Picture **sorted, Picture **src, int len, int limit, int dir){
93 best_poc= dir ? INT_MIN : INT_MAX;
96 const int poc= src[i]->poc;
97 if(((poc > limit) ^ dir) && ((poc < best_poc) ^ dir)){
99 sorted[out_i]= src[i];
102 if(best_poc == (dir ? INT_MIN : INT_MAX))
104 limit= sorted[out_i++]->poc - dir;
109 int ff_h264_fill_default_ref_list(H264Context *h){
110 MpegEncContext * const s = &h->s;
113 if(h->slice_type_nos==AV_PICTURE_TYPE_B){
119 cur_poc= s->current_picture_ptr->field_poc[ s->picture_structure == PICT_BOTTOM_FIELD ];
121 cur_poc= s->current_picture_ptr->poc;
123 for(list= 0; list<2; list++){
124 len= add_sorted(sorted , h->short_ref, h->short_ref_count, cur_poc, 1^list);
125 len+=add_sorted(sorted+len, h->short_ref, h->short_ref_count, cur_poc, 0^list);
127 len= build_def_list(h->default_ref_list[list] , sorted , len, 0, s->picture_structure);
128 len+=build_def_list(h->default_ref_list[list]+len, h->long_ref, 16 , 1, s->picture_structure);
131 if(len < h->ref_count[list])
132 memset(&h->default_ref_list[list][len], 0, sizeof(Picture)*(h->ref_count[list] - len));
136 if(lens[0] == lens[1] && lens[1] > 1){
137 for(i=0; h->default_ref_list[0][i].data[0] == h->default_ref_list[1][i].data[0] && i<lens[0]; i++);
139 FFSWAP(Picture, h->default_ref_list[1][0], h->default_ref_list[1][1]);
142 len = build_def_list(h->default_ref_list[0] , h->short_ref, h->short_ref_count, 0, s->picture_structure);
143 len+= build_def_list(h->default_ref_list[0]+len, h-> long_ref, 16 , 1, s->picture_structure);
145 if(len < h->ref_count[0])
146 memset(&h->default_ref_list[0][len], 0, sizeof(Picture)*(h->ref_count[0] - len));
149 for (i=0; i<h->ref_count[0]; i++) {
150 tprintf(h->s.avctx, "List0: %s fn:%d 0x%p\n", (h->default_ref_list[0][i].long_ref ? "LT" : "ST"), h->default_ref_list[0][i].pic_id, h->default_ref_list[0][i].data[0]);
152 if(h->slice_type_nos==AV_PICTURE_TYPE_B){
153 for (i=0; i<h->ref_count[1]; i++) {
154 tprintf(h->s.avctx, "List1: %s fn:%d 0x%p\n", (h->default_ref_list[1][i].long_ref ? "LT" : "ST"), h->default_ref_list[1][i].pic_id, h->default_ref_list[1][i].data[0]);
161 static void print_short_term(H264Context *h);
162 static void print_long_term(H264Context *h);
165 * Extract structure information about the picture described by pic_num in
166 * the current decoding context (frame or field). Note that pic_num is
167 * picture number without wrapping (so, 0<=pic_num<max_pic_num).
168 * @param pic_num picture number for which to extract structure information
169 * @param structure one of PICT_XXX describing structure of picture
171 * @return frame number (short term) or long term index of picture
172 * described by pic_num
174 static int pic_num_extract(H264Context *h, int pic_num, int *structure){
175 MpegEncContext * const s = &h->s;
177 *structure = s->picture_structure;
181 *structure ^= PICT_FRAME;
188 int ff_h264_decode_ref_pic_list_reordering(H264Context *h){
189 MpegEncContext * const s = &h->s;
190 int list, index, pic_structure;
195 for(list=0; list<h->list_count; list++){
196 memcpy(h->ref_list[list], h->default_ref_list[list], sizeof(Picture)*h->ref_count[list]);
198 if(get_bits1(&s->gb)){
199 int pred= h->curr_pic_num;
201 for(index=0; ; index++){
202 unsigned int reordering_of_pic_nums_idc= get_ue_golomb_31(&s->gb);
207 if(reordering_of_pic_nums_idc==3)
210 if(index >= h->ref_count[list]){
211 av_log(h->s.avctx, AV_LOG_ERROR, "reference count overflow\n");
215 if(reordering_of_pic_nums_idc<3){
216 if(reordering_of_pic_nums_idc<2){
217 const unsigned int abs_diff_pic_num= get_ue_golomb(&s->gb) + 1;
220 if(abs_diff_pic_num > h->max_pic_num){
221 av_log(h->s.avctx, AV_LOG_ERROR, "abs_diff_pic_num overflow\n");
225 if(reordering_of_pic_nums_idc == 0) pred-= abs_diff_pic_num;
226 else pred+= abs_diff_pic_num;
227 pred &= h->max_pic_num - 1;
229 frame_num = pic_num_extract(h, pred, &pic_structure);
231 for(i= h->short_ref_count-1; i>=0; i--){
232 ref = h->short_ref[i];
233 assert(ref->reference);
234 assert(!ref->long_ref);
236 ref->frame_num == frame_num &&
237 (ref->reference & pic_structure)
245 pic_id= get_ue_golomb(&s->gb); //long_term_pic_idx
247 long_idx= pic_num_extract(h, pic_id, &pic_structure);
250 av_log(h->s.avctx, AV_LOG_ERROR, "long_term_pic_idx overflow\n");
253 ref = h->long_ref[long_idx];
254 assert(!(ref && !ref->reference));
255 if(ref && (ref->reference & pic_structure)){
257 assert(ref->long_ref);
265 av_log(h->s.avctx, AV_LOG_ERROR, "reference picture missing during reorder\n");
266 memset(&h->ref_list[list][index], 0, sizeof(Picture)); //FIXME
268 for(i=index; i+1<h->ref_count[list]; i++){
269 if(ref->long_ref == h->ref_list[list][i].long_ref && ref->pic_id == h->ref_list[list][i].pic_id)
272 for(; i > index; i--){
273 h->ref_list[list][i]= h->ref_list[list][i-1];
275 h->ref_list[list][index]= *ref;
277 pic_as_field(&h->ref_list[list][index], pic_structure);
281 av_log(h->s.avctx, AV_LOG_ERROR, "illegal reordering_of_pic_nums_idc\n");
287 for(list=0; list<h->list_count; list++){
288 for(index= 0; index < h->ref_count[list]; index++){
289 if(!h->ref_list[list][index].data[0]){
290 av_log(h->s.avctx, AV_LOG_ERROR, "Missing reference picture\n");
291 if(h->default_ref_list[list][0].data[0])
292 h->ref_list[list][index]= h->default_ref_list[list][0];
302 void ff_h264_fill_mbaff_ref_list(H264Context *h){
304 for(list=0; list<2; list++){ //FIXME try list_count
305 for(i=0; i<h->ref_count[list]; i++){
306 Picture *frame = &h->ref_list[list][i];
307 Picture *field = &h->ref_list[list][16+2*i];
310 field[0].linesize[j] <<= 1;
311 field[0].reference = PICT_TOP_FIELD;
312 field[0].poc= field[0].field_poc[0];
315 field[1].data[j] += frame->linesize[j];
316 field[1].reference = PICT_BOTTOM_FIELD;
317 field[1].poc= field[1].field_poc[1];
319 h->luma_weight[16+2*i][list][0] = h->luma_weight[16+2*i+1][list][0] = h->luma_weight[i][list][0];
320 h->luma_weight[16+2*i][list][1] = h->luma_weight[16+2*i+1][list][1] = h->luma_weight[i][list][1];
322 h->chroma_weight[16+2*i][list][j][0] = h->chroma_weight[16+2*i+1][list][j][0] = h->chroma_weight[i][list][j][0];
323 h->chroma_weight[16+2*i][list][j][1] = h->chroma_weight[16+2*i+1][list][j][1] = h->chroma_weight[i][list][j][1];
330 * Mark a picture as no longer needed for reference. The refmask
331 * argument allows unreferencing of individual fields or the whole frame.
332 * If the picture becomes entirely unreferenced, but is being held for
333 * display purposes, it is marked as such.
334 * @param refmask mask of fields to unreference; the mask is bitwise
335 * anded with the reference marking of pic
336 * @return non-zero if pic becomes entirely unreferenced (except possibly
337 * for display purposes) zero if one of the fields remains in
340 static inline int unreference_pic(H264Context *h, Picture *pic, int refmask){
342 if (pic->reference &= refmask) {
345 for(i = 0; h->delayed_pic[i]; i++)
346 if(pic == h->delayed_pic[i]){
347 pic->reference=DELAYED_PIC_REF;
355 * Find a Picture in the short term reference list by frame number.
356 * @param frame_num frame number to search for
357 * @param idx the index into h->short_ref where returned picture is found
358 * undefined if no picture found.
359 * @return pointer to the found picture, or NULL if no pic with the provided
360 * frame number is found
362 static Picture * find_short(H264Context *h, int frame_num, int *idx){
363 MpegEncContext * const s = &h->s;
366 for(i=0; i<h->short_ref_count; i++){
367 Picture *pic= h->short_ref[i];
368 if(s->avctx->debug&FF_DEBUG_MMCO)
369 av_log(h->s.avctx, AV_LOG_DEBUG, "%d %d %p\n", i, pic->frame_num, pic);
370 if(pic->frame_num == frame_num) {
379 * Remove a picture from the short term reference list by its index in
380 * that list. This does no checking on the provided index; it is assumed
381 * to be valid. Other list entries are shifted down.
382 * @param i index into h->short_ref of picture to remove.
384 static void remove_short_at_index(H264Context *h, int i){
385 assert(i >= 0 && i < h->short_ref_count);
386 h->short_ref[i]= NULL;
387 if (--h->short_ref_count)
388 memmove(&h->short_ref[i], &h->short_ref[i+1], (h->short_ref_count - i)*sizeof(Picture*));
393 * @return the removed picture or NULL if an error occurs
395 static Picture * remove_short(H264Context *h, int frame_num, int ref_mask){
396 MpegEncContext * const s = &h->s;
400 if(s->avctx->debug&FF_DEBUG_MMCO)
401 av_log(h->s.avctx, AV_LOG_DEBUG, "remove short %d count %d\n", frame_num, h->short_ref_count);
403 pic = find_short(h, frame_num, &i);
405 if(unreference_pic(h, pic, ref_mask))
406 remove_short_at_index(h, i);
413 * Remove a picture from the long term reference list by its index in
415 * @return the removed picture or NULL if an error occurs
417 static Picture * remove_long(H264Context *h, int i, int ref_mask){
422 if(unreference_pic(h, pic, ref_mask)){
423 assert(h->long_ref[i]->long_ref == 1);
424 h->long_ref[i]->long_ref= 0;
425 h->long_ref[i]= NULL;
433 void ff_h264_remove_all_refs(H264Context *h){
437 remove_long(h, i, 0);
439 assert(h->long_ref_count==0);
441 for(i=0; i<h->short_ref_count; i++){
442 unreference_pic(h, h->short_ref[i], 0);
443 h->short_ref[i]= NULL;
445 h->short_ref_count=0;
449 * print short term list
451 static void print_short_term(H264Context *h) {
453 if(h->s.avctx->debug&FF_DEBUG_MMCO) {
454 av_log(h->s.avctx, AV_LOG_DEBUG, "short term list:\n");
455 for(i=0; i<h->short_ref_count; i++){
456 Picture *pic= h->short_ref[i];
457 av_log(h->s.avctx, AV_LOG_DEBUG, "%d fn:%d poc:%d %p\n", i, pic->frame_num, pic->poc, pic->data[0]);
463 * print long term list
465 static void print_long_term(H264Context *h) {
467 if(h->s.avctx->debug&FF_DEBUG_MMCO) {
468 av_log(h->s.avctx, AV_LOG_DEBUG, "long term list:\n");
469 for(i = 0; i < 16; i++){
470 Picture *pic= h->long_ref[i];
472 av_log(h->s.avctx, AV_LOG_DEBUG, "%d fn:%d poc:%d %p\n", i, pic->frame_num, pic->poc, pic->data[0]);
478 void ff_generate_sliding_window_mmcos(H264Context *h) {
479 MpegEncContext * const s = &h->s;
480 av_assert0(h->long_ref_count + h->short_ref_count <= h->sps.ref_frame_count);
483 if(h->short_ref_count && h->long_ref_count + h->short_ref_count == h->sps.ref_frame_count &&
484 !(FIELD_PICTURE && !s->first_field && s->current_picture_ptr->reference)) {
485 h->mmco[0].opcode= MMCO_SHORT2UNUSED;
486 h->mmco[0].short_pic_num= h->short_ref[ h->short_ref_count - 1 ]->frame_num;
489 h->mmco[0].short_pic_num *= 2;
490 h->mmco[1].opcode= MMCO_SHORT2UNUSED;
491 h->mmco[1].short_pic_num= h->mmco[0].short_pic_num + 1;
497 int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count){
498 MpegEncContext * const s = &h->s;
500 int current_ref_assigned=0;
501 Picture *av_uninit(pic);
503 if((s->avctx->debug&FF_DEBUG_MMCO) && mmco_count==0)
504 av_log(h->s.avctx, AV_LOG_DEBUG, "no mmco here\n");
506 for(i=0; i<mmco_count; i++){
507 int av_uninit(structure), av_uninit(frame_num);
508 if(s->avctx->debug&FF_DEBUG_MMCO)
509 av_log(h->s.avctx, AV_LOG_DEBUG, "mmco:%d %d %d\n", h->mmco[i].opcode, h->mmco[i].short_pic_num, h->mmco[i].long_arg);
511 if( mmco[i].opcode == MMCO_SHORT2UNUSED
512 || mmco[i].opcode == MMCO_SHORT2LONG){
513 frame_num = pic_num_extract(h, mmco[i].short_pic_num, &structure);
514 pic = find_short(h, frame_num, &j);
516 if(mmco[i].opcode != MMCO_SHORT2LONG || !h->long_ref[mmco[i].long_arg]
517 || h->long_ref[mmco[i].long_arg]->frame_num != frame_num)
518 av_log(h->s.avctx, AV_LOG_ERROR, "mmco: unref short failure\n");
523 switch(mmco[i].opcode){
524 case MMCO_SHORT2UNUSED:
525 if(s->avctx->debug&FF_DEBUG_MMCO)
526 av_log(h->s.avctx, AV_LOG_DEBUG, "mmco: unref short %d count %d\n", h->mmco[i].short_pic_num, h->short_ref_count);
527 remove_short(h, frame_num, structure ^ PICT_FRAME);
529 case MMCO_SHORT2LONG:
530 if (h->long_ref[mmco[i].long_arg] != pic)
531 remove_long(h, mmco[i].long_arg, 0);
533 remove_short_at_index(h, j);
534 h->long_ref[ mmco[i].long_arg ]= pic;
535 if (h->long_ref[ mmco[i].long_arg ]){
536 h->long_ref[ mmco[i].long_arg ]->long_ref=1;
540 case MMCO_LONG2UNUSED:
541 j = pic_num_extract(h, mmco[i].long_arg, &structure);
542 pic = h->long_ref[j];
544 remove_long(h, j, structure ^ PICT_FRAME);
545 } else if(s->avctx->debug&FF_DEBUG_MMCO)
546 av_log(h->s.avctx, AV_LOG_DEBUG, "mmco: unref long failure\n");
549 // Comment below left from previous code as it is an interresting note.
550 /* First field in pair is in short term list or
551 * at a different long term index.
552 * This is not allowed; see 7.4.3.3, notes 2 and 3.
553 * Report the problem and keep the pair where it is,
554 * and mark this field valid.
557 if (h->long_ref[mmco[i].long_arg] != s->current_picture_ptr) {
558 remove_long(h, mmco[i].long_arg, 0);
560 h->long_ref[ mmco[i].long_arg ]= s->current_picture_ptr;
561 h->long_ref[ mmco[i].long_arg ]->long_ref=1;
565 s->current_picture_ptr->reference |= s->picture_structure;
566 current_ref_assigned=1;
568 case MMCO_SET_MAX_LONG:
569 assert(mmco[i].long_arg <= 16);
570 // just remove the long term which index is greater than new max
571 for(j = mmco[i].long_arg; j<16; j++){
572 remove_long(h, j, 0);
576 while(h->short_ref_count){
577 remove_short(h, h->short_ref[0]->frame_num, 0);
579 for(j = 0; j < 16; j++) {
580 remove_long(h, j, 0);
582 s->current_picture_ptr->poc=
583 s->current_picture_ptr->field_poc[0]=
584 s->current_picture_ptr->field_poc[1]=
588 s->current_picture_ptr->frame_num= 0;
589 s->current_picture_ptr->mmco_reset=1;
595 if (!current_ref_assigned) {
596 /* Second field of complementary field pair; the first field of
597 * which is already referenced. If short referenced, it
598 * should be first entry in short_ref. If not, it must exist
599 * in long_ref; trying to put it on the short list here is an
600 * error in the encoded bit stream (ref: 7.4.3.3, NOTE 2 and 3).
602 if (h->short_ref_count && h->short_ref[0] == s->current_picture_ptr) {
603 /* Just mark the second field valid */
604 s->current_picture_ptr->reference = PICT_FRAME;
605 } else if (s->current_picture_ptr->long_ref) {
606 av_log(h->s.avctx, AV_LOG_ERROR, "illegal short term reference "
607 "assignment for second field "
608 "in complementary field pair "
609 "(first field is long term)\n");
611 pic= remove_short(h, s->current_picture_ptr->frame_num, 0);
613 av_log(h->s.avctx, AV_LOG_ERROR, "illegal short term buffer state detected\n");
616 if(h->short_ref_count)
617 memmove(&h->short_ref[1], &h->short_ref[0], h->short_ref_count*sizeof(Picture*));
619 h->short_ref[0]= s->current_picture_ptr;
620 h->short_ref_count++;
621 s->current_picture_ptr->reference |= s->picture_structure;
625 if (h->long_ref_count + h->short_ref_count > FFMAX(h->sps.ref_frame_count, 1)){
627 /* We have too many reference frames, probably due to corrupted
628 * stream. Need to discard one frame. Prevents overrun of the
629 * short_ref and long_ref buffers.
631 av_log(h->s.avctx, AV_LOG_ERROR,
632 "number of reference frames (%d+%d) exceeds max (%d; probably "
633 "corrupt input), discarding one\n",
634 h->long_ref_count, h->short_ref_count, h->sps.ref_frame_count);
636 if (h->long_ref_count && !h->short_ref_count) {
637 for (i = 0; i < 16; ++i)
642 remove_long(h, i, 0);
644 pic = h->short_ref[h->short_ref_count - 1];
645 remove_short(h, pic->frame_num, 0);
654 int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb){
655 MpegEncContext * const s = &h->s;
659 if(h->nal_unit_type == NAL_IDR_SLICE){ //FIXME fields
660 s->broken_link= get_bits1(gb) -1;
662 h->mmco[0].opcode= MMCO_LONG;
663 h->mmco[0].long_arg= 0;
667 if(get_bits1(gb)){ // adaptive_ref_pic_marking_mode_flag
668 for(i= 0; i<MAX_MMCO_COUNT; i++) {
669 MMCOOpcode opcode= get_ue_golomb_31(gb);
671 h->mmco[i].opcode= opcode;
672 if(opcode==MMCO_SHORT2UNUSED || opcode==MMCO_SHORT2LONG){
673 h->mmco[i].short_pic_num= (h->curr_pic_num - get_ue_golomb(gb) - 1) & (h->max_pic_num - 1);
674 /* if(h->mmco[i].short_pic_num >= h->short_ref_count || h->short_ref[ h->mmco[i].short_pic_num ] == NULL){
675 av_log(s->avctx, AV_LOG_ERROR, "illegal short ref in memory management control operation %d\n", mmco);
679 if(opcode==MMCO_SHORT2LONG || opcode==MMCO_LONG2UNUSED || opcode==MMCO_LONG || opcode==MMCO_SET_MAX_LONG){
680 unsigned int long_arg= get_ue_golomb_31(gb);
681 if(long_arg >= 32 || (long_arg >= 16 && !(opcode == MMCO_LONG2UNUSED && FIELD_PICTURE))){
682 av_log(h->s.avctx, AV_LOG_ERROR, "illegal long ref in memory management control operation %d\n", opcode);
685 h->mmco[i].long_arg= long_arg;
688 if(opcode > (unsigned)MMCO_LONG){
689 av_log(h->s.avctx, AV_LOG_ERROR, "illegal memory management control operation %d\n", opcode);
692 if(opcode == MMCO_END)
697 ff_generate_sliding_window_mmcos(h);