h264: improve behaviour with invalid reference lists
[ffmpeg.git] / libavcodec / h264_refs.c
1 /*
2  * H.26L/H.264/AVC/JVT/14496-10/... reference picture handling
3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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.
11  *
12  * Libav 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.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * H.264 / AVC / MPEG4 part10  reference picture handling.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #include <inttypes.h>
29
30 #include "internal.h"
31 #include "avcodec.h"
32 #include "h264.h"
33 #include "golomb.h"
34 #include "mpegutils.h"
35
36 #include <assert.h>
37
38 static void pic_as_field(H264Ref *pic, const int parity)
39 {
40     int i;
41     for (i = 0; i < FF_ARRAY_ELEMS(pic->data); ++i) {
42         if (parity == PICT_BOTTOM_FIELD)
43             pic->data[i]   += pic->linesize[i];
44         pic->reference      = parity;
45         pic->linesize[i] *= 2;
46     }
47     pic->poc = pic->parent->field_poc[parity == PICT_BOTTOM_FIELD];
48 }
49
50 static void ref_from_h264pic(H264Ref *dst, H264Picture *src)
51 {
52     memcpy(dst->data,     src->f->data,     sizeof(dst->data));
53     memcpy(dst->linesize, src->f->linesize, sizeof(dst->linesize));
54     dst->reference = src->reference;
55     dst->poc       = src->poc;
56     dst->pic_id    = src->pic_id;
57     dst->parent = src;
58 }
59
60 static int split_field_copy(H264Ref *dest, H264Picture *src, int parity, int id_add)
61 {
62     int match = !!(src->reference & parity);
63
64     if (match) {
65         ref_from_h264pic(dest, src);
66         if (parity != PICT_FRAME) {
67             pic_as_field(dest, parity);
68             dest->pic_id *= 2;
69             dest->pic_id += id_add;
70         }
71     }
72
73     return match;
74 }
75
76 static int build_def_list(H264Ref *def, int def_len,
77                           H264Picture **in, int len, int is_long, int sel)
78 {
79     int  i[2] = { 0 };
80     int index = 0;
81
82     while ((i[0] < len || i[1] < len) && index < def_len) {
83         while (i[0] < len && !(in[i[0]] && (in[i[0]]->reference & sel)))
84             i[0]++;
85         while (i[1] < len && !(in[i[1]] && (in[i[1]]->reference & (sel ^ 3))))
86             i[1]++;
87         if (i[0] < len && index < def_len) {
88             in[i[0]]->pic_id = is_long ? i[0] : in[i[0]]->frame_num;
89             split_field_copy(&def[index++], in[i[0]++], sel, 1);
90         }
91         if (i[1] < len && index < def_len) {
92             in[i[1]]->pic_id = is_long ? i[1] : in[i[1]]->frame_num;
93             split_field_copy(&def[index++], in[i[1]++], sel ^ 3, 0);
94         }
95     }
96
97     return index;
98 }
99
100 static int add_sorted(H264Picture **sorted, H264Picture **src, int len, int limit, int dir)
101 {
102     int i, best_poc;
103     int out_i = 0;
104
105     for (;;) {
106         best_poc = dir ? INT_MIN : INT_MAX;
107
108         for (i = 0; i < len; i++) {
109             const int poc = src[i]->poc;
110             if (((poc > limit) ^ dir) && ((poc < best_poc) ^ dir)) {
111                 best_poc      = poc;
112                 sorted[out_i] = src[i];
113             }
114         }
115         if (best_poc == (dir ? INT_MIN : INT_MAX))
116             break;
117         limit = sorted[out_i++]->poc - dir;
118     }
119     return out_i;
120 }
121
122 static void h264_initialise_ref_list(H264Context *h, H264SliceContext *sl)
123 {
124     int i, len;
125
126     if (sl->slice_type_nos == AV_PICTURE_TYPE_B) {
127         H264Picture *sorted[32];
128         int cur_poc, list;
129         int lens[2];
130
131         if (FIELD_PICTURE(h))
132             cur_poc = h->cur_pic_ptr->field_poc[h->picture_structure == PICT_BOTTOM_FIELD];
133         else
134             cur_poc = h->cur_pic_ptr->poc;
135
136         for (list = 0; list < 2; list++) {
137             len  = add_sorted(sorted,       h->short_ref, h->short_ref_count, cur_poc, 1 ^ list);
138             len += add_sorted(sorted + len, h->short_ref, h->short_ref_count, cur_poc, 0 ^ list);
139             assert(len <= 32);
140
141             len  = build_def_list(sl->ref_list[list], FF_ARRAY_ELEMS(sl->ref_list[0]),
142                                   sorted, len, 0, h->picture_structure);
143             len += build_def_list(sl->ref_list[list] + len,
144                                   FF_ARRAY_ELEMS(sl->ref_list[0]) - len,
145                                   h->long_ref, 16, 1, h->picture_structure);
146
147             if (len < sl->ref_count[list])
148                 memset(&sl->ref_list[list][len], 0, sizeof(H264Ref) * (sl->ref_count[list] - len));
149             lens[list] = len;
150         }
151
152         if (lens[0] == lens[1] && lens[1] > 1) {
153             for (i = 0; i < lens[0] &&
154                         sl->ref_list[0][i].parent->f->buf[0]->buffer ==
155                         sl->ref_list[1][i].parent->f->buf[0]->buffer; i++);
156             if (i == lens[0]) {
157                 FFSWAP(H264Ref, sl->ref_list[1][0], sl->ref_list[1][1]);
158             }
159         }
160     } else {
161         len  = build_def_list(sl->ref_list[0], FF_ARRAY_ELEMS(sl->ref_list[0]),
162                               h->short_ref, h->short_ref_count, 0, h->picture_structure);
163         len += build_def_list(sl->ref_list[0] + len,
164                               FF_ARRAY_ELEMS(sl->ref_list[0]) - len,
165                               h-> long_ref, 16, 1, h->picture_structure);
166
167         if (len < sl->ref_count[0])
168             memset(&sl->ref_list[0][len], 0, sizeof(H264Ref) * (sl->ref_count[0] - len));
169     }
170 #ifdef TRACE
171     for (i = 0; i < sl->ref_count[0]; i++) {
172         ff_tlog(h->avctx, "List0: %s fn:%d 0x%p\n",
173                 (sl->ref_list[0][i].long_ref ? "LT" : "ST"),
174                 sl->ref_list[0][i].pic_id,
175                 sl->ref_list[0][i].f->data[0]);
176     }
177     if (sl->slice_type_nos == AV_PICTURE_TYPE_B) {
178         for (i = 0; i < sl->ref_count[1]; i++) {
179             ff_tlog(h->avctx, "List1: %s fn:%d 0x%p\n",
180                     (sl->ref_list[1][i].long_ref ? "LT" : "ST"),
181                     sl->ref_list[1][i].pic_id,
182                     sl->ref_list[1][i].f->data[0]);
183         }
184     }
185 #endif
186 }
187
188 static void print_short_term(H264Context *h);
189 static void print_long_term(H264Context *h);
190
191 /**
192  * Extract structure information about the picture described by pic_num in
193  * the current decoding context (frame or field). Note that pic_num is
194  * picture number without wrapping (so, 0<=pic_num<max_pic_num).
195  * @param pic_num picture number for which to extract structure information
196  * @param structure one of PICT_XXX describing structure of picture
197  *                      with pic_num
198  * @return frame number (short term) or long term index of picture
199  *         described by pic_num
200  */
201 static int pic_num_extract(H264Context *h, int pic_num, int *structure)
202 {
203     *structure = h->picture_structure;
204     if (FIELD_PICTURE(h)) {
205         if (!(pic_num & 1))
206             /* opposite field */
207             *structure ^= PICT_FRAME;
208         pic_num >>= 1;
209     }
210
211     return pic_num;
212 }
213
214 int ff_h264_decode_ref_pic_list_reordering(H264Context *h, H264SliceContext *sl)
215 {
216     int list, index, pic_structure;
217
218     print_short_term(h);
219     print_long_term(h);
220
221     h264_initialise_ref_list(h, sl);
222
223     for (list = 0; list < sl->list_count; list++) {
224         if (get_bits1(&sl->gb)) {    // ref_pic_list_modification_flag_l[01]
225             int pred = h->curr_pic_num;
226
227             for (index = 0; ; index++) {
228                 unsigned int modification_of_pic_nums_idc = get_ue_golomb_31(&sl->gb);
229                 unsigned int pic_id;
230                 int i;
231                 H264Picture *ref = NULL;
232
233                 if (modification_of_pic_nums_idc == 3)
234                     break;
235
236                 if (index >= sl->ref_count[list]) {
237                     av_log(h->avctx, AV_LOG_ERROR, "reference count overflow\n");
238                     return -1;
239                 }
240
241                 switch (modification_of_pic_nums_idc) {
242                 case 0:
243                 case 1: {
244                     const unsigned int abs_diff_pic_num = get_ue_golomb(&sl->gb) + 1;
245                     int frame_num;
246
247                     if (abs_diff_pic_num > h->max_pic_num) {
248                         av_log(h->avctx, AV_LOG_ERROR,
249                                "abs_diff_pic_num overflow\n");
250                         return AVERROR_INVALIDDATA;
251                     }
252
253                     if (modification_of_pic_nums_idc == 0)
254                         pred -= abs_diff_pic_num;
255                     else
256                         pred += abs_diff_pic_num;
257                     pred &= h->max_pic_num - 1;
258
259                     frame_num = pic_num_extract(h, pred, &pic_structure);
260
261                     for (i = h->short_ref_count - 1; i >= 0; i--) {
262                         ref = h->short_ref[i];
263                         assert(ref->reference);
264                         assert(!ref->long_ref);
265                         if (ref->frame_num == frame_num &&
266                             (ref->reference & pic_structure))
267                             break;
268                     }
269                     if (i >= 0)
270                         ref->pic_id = pred;
271                     break;
272                 }
273                 case 2: {
274                     int long_idx;
275                     pic_id = get_ue_golomb(&sl->gb); // long_term_pic_idx
276
277                     long_idx = pic_num_extract(h, pic_id, &pic_structure);
278
279                     if (long_idx > 31) {
280                         av_log(h->avctx, AV_LOG_ERROR,
281                                "long_term_pic_idx overflow\n");
282                         return AVERROR_INVALIDDATA;
283                     }
284                     ref = h->long_ref[long_idx];
285                     assert(!(ref && !ref->reference));
286                     if (ref && (ref->reference & pic_structure)) {
287                         ref->pic_id = pic_id;
288                         assert(ref->long_ref);
289                         i = 0;
290                     } else {
291                         i = -1;
292                     }
293                     break;
294                 }
295                 default:
296                     av_log(h->avctx, AV_LOG_ERROR,
297                            "illegal modification_of_pic_nums_idc %u\n",
298                            modification_of_pic_nums_idc);
299                     return AVERROR_INVALIDDATA;
300                 }
301
302                 if (i < 0) {
303                     av_log(h->avctx, AV_LOG_ERROR,
304                            "reference picture missing during reorder\n");
305                     memset(&sl->ref_list[list][index], 0, sizeof(sl->ref_list[0][0])); // FIXME
306                 } else {
307                     for (i = index; i + 1 < sl->ref_count[list]; i++) {
308                         if (sl->ref_list[list][i].parent &&
309                             ref->long_ref == sl->ref_list[list][i].parent->long_ref &&
310                             ref->pic_id   == sl->ref_list[list][i].pic_id)
311                             break;
312                     }
313                     for (; i > index; i--) {
314                         sl->ref_list[list][i] = sl->ref_list[list][i - 1];
315                     }
316                     ref_from_h264pic(&sl->ref_list[list][index], ref);
317                     if (FIELD_PICTURE(h)) {
318                         pic_as_field(&sl->ref_list[list][index], pic_structure);
319                     }
320                 }
321             }
322         }
323     }
324     for (list = 0; list < sl->list_count; list++) {
325         for (index = 0; index < sl->ref_count[list]; index++) {
326             if (!sl->ref_list[list][index].parent) {
327                 av_log(h->avctx, AV_LOG_ERROR, "Missing reference picture\n");
328                 if (index == 0 || h->avctx->err_recognition & AV_EF_EXPLODE)
329                     return AVERROR_INVALIDDATA;
330                 else
331                     sl->ref_list[list][index] = sl->ref_list[list][index - 1];
332             }
333         }
334     }
335
336     return 0;
337 }
338
339 void ff_h264_fill_mbaff_ref_list(H264Context *h, H264SliceContext *sl)
340 {
341     int list, i, j;
342     for (list = 0; list < sl->list_count; list++) { //FIXME try list_count
343         for (i = 0; i < sl->ref_count[list]; i++) {
344             H264Ref *frame = &sl->ref_list[list][i];
345             H264Ref *field = &sl->ref_list[list][16 + 2 * i];
346
347             field[0] = *frame;
348
349             for (j = 0; j < 3; j++)
350                 field[0].linesize[j] <<= 1;
351             field[0].reference = PICT_TOP_FIELD;
352             field[0].poc       = field[0].parent->field_poc[0];
353
354             field[1] = field[0];
355
356             for (j = 0; j < 3; j++)
357                 field[1].data[j] += frame->parent->f->linesize[j];
358             field[1].reference = PICT_BOTTOM_FIELD;
359             field[1].poc       = field[1].parent->field_poc[1];
360
361             sl->luma_weight[16 + 2 * i][list][0] = sl->luma_weight[16 + 2 * i + 1][list][0] = sl->luma_weight[i][list][0];
362             sl->luma_weight[16 + 2 * i][list][1] = sl->luma_weight[16 + 2 * i + 1][list][1] = sl->luma_weight[i][list][1];
363             for (j = 0; j < 2; j++) {
364                 sl->chroma_weight[16 + 2 * i][list][j][0] = sl->chroma_weight[16 + 2 * i + 1][list][j][0] = sl->chroma_weight[i][list][j][0];
365                 sl->chroma_weight[16 + 2 * i][list][j][1] = sl->chroma_weight[16 + 2 * i + 1][list][j][1] = sl->chroma_weight[i][list][j][1];
366             }
367         }
368     }
369 }
370
371 /**
372  * Mark a picture as no longer needed for reference. The refmask
373  * argument allows unreferencing of individual fields or the whole frame.
374  * If the picture becomes entirely unreferenced, but is being held for
375  * display purposes, it is marked as such.
376  * @param refmask mask of fields to unreference; the mask is bitwise
377  *                anded with the reference marking of pic
378  * @return non-zero if pic becomes entirely unreferenced (except possibly
379  *         for display purposes) zero if one of the fields remains in
380  *         reference
381  */
382 static inline int unreference_pic(H264Context *h, H264Picture *pic, int refmask)
383 {
384     int i;
385     if (pic->reference &= refmask) {
386         return 0;
387     } else {
388         for(i = 0; h->delayed_pic[i]; i++)
389             if(pic == h->delayed_pic[i]){
390                 pic->reference = DELAYED_PIC_REF;
391                 break;
392             }
393         return 1;
394     }
395 }
396
397 /**
398  * Find a H264Picture in the short term reference list by frame number.
399  * @param frame_num frame number to search for
400  * @param idx the index into h->short_ref where returned picture is found
401  *            undefined if no picture found.
402  * @return pointer to the found picture, or NULL if no pic with the provided
403  *                 frame number is found
404  */
405 static H264Picture *find_short(H264Context *h, int frame_num, int *idx)
406 {
407     int i;
408
409     for (i = 0; i < h->short_ref_count; i++) {
410         H264Picture *pic = h->short_ref[i];
411         if (h->avctx->debug & FF_DEBUG_MMCO)
412             av_log(h->avctx, AV_LOG_DEBUG, "%d %d %p\n", i, pic->frame_num, pic);
413         if (pic->frame_num == frame_num) {
414             *idx = i;
415             return pic;
416         }
417     }
418     return NULL;
419 }
420
421 /**
422  * Remove a picture from the short term reference list by its index in
423  * that list.  This does no checking on the provided index; it is assumed
424  * to be valid. Other list entries are shifted down.
425  * @param i index into h->short_ref of picture to remove.
426  */
427 static void remove_short_at_index(H264Context *h, int i)
428 {
429     assert(i >= 0 && i < h->short_ref_count);
430     h->short_ref[i] = NULL;
431     if (--h->short_ref_count)
432         memmove(&h->short_ref[i], &h->short_ref[i + 1],
433                 (h->short_ref_count - i) * sizeof(H264Picture*));
434 }
435
436 /**
437  *
438  * @return the removed picture or NULL if an error occurs
439  */
440 static H264Picture *remove_short(H264Context *h, int frame_num, int ref_mask)
441 {
442     H264Picture *pic;
443     int i;
444
445     if (h->avctx->debug & FF_DEBUG_MMCO)
446         av_log(h->avctx, AV_LOG_DEBUG, "remove short %d count %d\n", frame_num, h->short_ref_count);
447
448     pic = find_short(h, frame_num, &i);
449     if (pic) {
450         if (unreference_pic(h, pic, ref_mask))
451             remove_short_at_index(h, i);
452     }
453
454     return pic;
455 }
456
457 /**
458  * Remove a picture from the long term reference list by its index in
459  * that list.
460  * @return the removed picture or NULL if an error occurs
461  */
462 static H264Picture *remove_long(H264Context *h, int i, int ref_mask)
463 {
464     H264Picture *pic;
465
466     pic = h->long_ref[i];
467     if (pic) {
468         if (unreference_pic(h, pic, ref_mask)) {
469             assert(h->long_ref[i]->long_ref == 1);
470             h->long_ref[i]->long_ref = 0;
471             h->long_ref[i]           = NULL;
472             h->long_ref_count--;
473         }
474     }
475
476     return pic;
477 }
478
479 void ff_h264_remove_all_refs(H264Context *h)
480 {
481     int i;
482
483     for (i = 0; i < 16; i++) {
484         remove_long(h, i, 0);
485     }
486     assert(h->long_ref_count == 0);
487
488     for (i = 0; i < h->short_ref_count; i++) {
489         unreference_pic(h, h->short_ref[i], 0);
490         h->short_ref[i] = NULL;
491     }
492     h->short_ref_count = 0;
493 }
494
495 /**
496  * print short term list
497  */
498 static void print_short_term(H264Context *h)
499 {
500     uint32_t i;
501     if (h->avctx->debug & FF_DEBUG_MMCO) {
502         av_log(h->avctx, AV_LOG_DEBUG, "short term list:\n");
503         for (i = 0; i < h->short_ref_count; i++) {
504             H264Picture *pic = h->short_ref[i];
505             av_log(h->avctx, AV_LOG_DEBUG, "%"PRIu32" fn:%d poc:%d %p\n",
506                    i, pic->frame_num, pic->poc, pic->f->data[0]);
507         }
508     }
509 }
510
511 /**
512  * print long term list
513  */
514 static void print_long_term(H264Context *h)
515 {
516     uint32_t i;
517     if (h->avctx->debug & FF_DEBUG_MMCO) {
518         av_log(h->avctx, AV_LOG_DEBUG, "long term list:\n");
519         for (i = 0; i < 16; i++) {
520             H264Picture *pic = h->long_ref[i];
521             if (pic) {
522                 av_log(h->avctx, AV_LOG_DEBUG, "%"PRIu32" fn:%d poc:%d %p\n",
523                        i, pic->frame_num, pic->poc, pic->f->data[0]);
524             }
525         }
526     }
527 }
528
529 static int check_opcodes(MMCO *mmco1, MMCO *mmco2, int n_mmcos)
530 {
531     int i;
532
533     for (i = 0; i < n_mmcos; i++) {
534         if (mmco1[i].opcode != mmco2[i].opcode)
535             return -1;
536     }
537
538     return 0;
539 }
540
541 int ff_generate_sliding_window_mmcos(H264Context *h, int first_slice)
542 {
543     MMCO mmco_temp[MAX_MMCO_COUNT], *mmco = first_slice ? h->mmco : mmco_temp;
544     int mmco_index = 0, i = 0;
545
546     assert(h->long_ref_count + h->short_ref_count <= h->sps.ref_frame_count);
547
548     if (h->short_ref_count &&
549         h->long_ref_count + h->short_ref_count == h->sps.ref_frame_count &&
550         !(FIELD_PICTURE(h) && !h->first_field && h->cur_pic_ptr->reference)) {
551         mmco[0].opcode        = MMCO_SHORT2UNUSED;
552         mmco[0].short_pic_num = h->short_ref[h->short_ref_count - 1]->frame_num;
553         mmco_index            = 1;
554         if (FIELD_PICTURE(h)) {
555             mmco[0].short_pic_num *= 2;
556             mmco[1].opcode         = MMCO_SHORT2UNUSED;
557             mmco[1].short_pic_num  = mmco[0].short_pic_num + 1;
558             mmco_index             = 2;
559         }
560     }
561
562     if (first_slice) {
563         h->mmco_index = mmco_index;
564     } else if (!first_slice && mmco_index >= 0 &&
565                (mmco_index != h->mmco_index ||
566                 (i = check_opcodes(h->mmco, mmco_temp, mmco_index)))) {
567         av_log(h->avctx, AV_LOG_ERROR,
568                "Inconsistent MMCO state between slices [%d, %d, %d]\n",
569                mmco_index, h->mmco_index, i);
570         return AVERROR_INVALIDDATA;
571     }
572     return 0;
573 }
574
575 int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count)
576 {
577     int i, av_uninit(j);
578     int current_ref_assigned = 0, err = 0;
579     H264Picture *av_uninit(pic);
580
581     if ((h->avctx->debug & FF_DEBUG_MMCO) && mmco_count == 0)
582         av_log(h->avctx, AV_LOG_DEBUG, "no mmco here\n");
583
584     for (i = 0; i < mmco_count; i++) {
585         int av_uninit(structure), av_uninit(frame_num);
586         if (h->avctx->debug & FF_DEBUG_MMCO)
587             av_log(h->avctx, AV_LOG_DEBUG, "mmco:%d %d %d\n", h->mmco[i].opcode,
588                    h->mmco[i].short_pic_num, h->mmco[i].long_arg);
589
590         if (mmco[i].opcode == MMCO_SHORT2UNUSED ||
591             mmco[i].opcode == MMCO_SHORT2LONG) {
592             frame_num = pic_num_extract(h, mmco[i].short_pic_num, &structure);
593             pic       = find_short(h, frame_num, &j);
594             if (!pic) {
595                 if (mmco[i].opcode != MMCO_SHORT2LONG ||
596                     !h->long_ref[mmco[i].long_arg]    ||
597                     h->long_ref[mmco[i].long_arg]->frame_num != frame_num) {
598                     av_log(h->avctx, AV_LOG_ERROR, "mmco: unref short failure\n");
599                     err = AVERROR_INVALIDDATA;
600                 }
601                 continue;
602             }
603         }
604
605         switch (mmco[i].opcode) {
606         case MMCO_SHORT2UNUSED:
607             if (h->avctx->debug & FF_DEBUG_MMCO)
608                 av_log(h->avctx, AV_LOG_DEBUG, "mmco: unref short %d count %d\n",
609                        h->mmco[i].short_pic_num, h->short_ref_count);
610             remove_short(h, frame_num, structure ^ PICT_FRAME);
611             break;
612         case MMCO_SHORT2LONG:
613                 if (h->long_ref[mmco[i].long_arg] != pic)
614                     remove_long(h, mmco[i].long_arg, 0);
615
616                 remove_short_at_index(h, j);
617                 h->long_ref[ mmco[i].long_arg ] = pic;
618                 if (h->long_ref[mmco[i].long_arg]) {
619                     h->long_ref[mmco[i].long_arg]->long_ref = 1;
620                     h->long_ref_count++;
621                 }
622             break;
623         case MMCO_LONG2UNUSED:
624             j   = pic_num_extract(h, mmco[i].long_arg, &structure);
625             pic = h->long_ref[j];
626             if (pic) {
627                 remove_long(h, j, structure ^ PICT_FRAME);
628             } else if (h->avctx->debug & FF_DEBUG_MMCO)
629                 av_log(h->avctx, AV_LOG_DEBUG, "mmco: unref long failure\n");
630             break;
631         case MMCO_LONG:
632                     // Comment below left from previous code as it is an interresting note.
633                     /* First field in pair is in short term list or
634                      * at a different long term index.
635                      * This is not allowed; see 7.4.3.3, notes 2 and 3.
636                      * Report the problem and keep the pair where it is,
637                      * and mark this field valid.
638                      */
639             if (h->short_ref[0] == h->cur_pic_ptr)
640                 remove_short_at_index(h, 0);
641
642             /* make sure the current picture is not already assigned as a long ref */
643             if (h->cur_pic_ptr->long_ref) {
644                 for (j = 0; j < FF_ARRAY_ELEMS(h->long_ref); j++) {
645                     if (h->long_ref[j] == h->cur_pic_ptr)
646                         remove_long(h, j, 0);
647                 }
648             }
649
650
651             if (h->long_ref[mmco[i].long_arg] != h->cur_pic_ptr) {
652                 remove_long(h, mmco[i].long_arg, 0);
653
654                 h->long_ref[mmco[i].long_arg]           = h->cur_pic_ptr;
655                 h->long_ref[mmco[i].long_arg]->long_ref = 1;
656                 h->long_ref_count++;
657             }
658
659             h->cur_pic_ptr->reference |= h->picture_structure;
660             current_ref_assigned = 1;
661             break;
662         case MMCO_SET_MAX_LONG:
663             assert(mmco[i].long_arg <= 16);
664             // just remove the long term which index is greater than new max
665             for (j = mmco[i].long_arg; j < 16; j++) {
666                 remove_long(h, j, 0);
667             }
668             break;
669         case MMCO_RESET:
670             while (h->short_ref_count) {
671                 remove_short(h, h->short_ref[0]->frame_num, 0);
672             }
673             for (j = 0; j < 16; j++) {
674                 remove_long(h, j, 0);
675             }
676             h->frame_num  = h->cur_pic_ptr->frame_num = 0;
677             h->mmco_reset = 1;
678             h->cur_pic_ptr->mmco_reset = 1;
679             break;
680         default: assert(0);
681         }
682     }
683
684     if (!current_ref_assigned) {
685         /* Second field of complementary field pair; the first field of
686          * which is already referenced. If short referenced, it
687          * should be first entry in short_ref. If not, it must exist
688          * in long_ref; trying to put it on the short list here is an
689          * error in the encoded bit stream (ref: 7.4.3.3, NOTE 2 and 3).
690          */
691         if (h->short_ref_count && h->short_ref[0] == h->cur_pic_ptr) {
692             /* Just mark the second field valid */
693             h->cur_pic_ptr->reference = PICT_FRAME;
694         } else if (h->cur_pic_ptr->long_ref) {
695             av_log(h->avctx, AV_LOG_ERROR, "illegal short term reference "
696                                            "assignment for second field "
697                                            "in complementary field pair "
698                                            "(first field is long term)\n");
699             err = AVERROR_INVALIDDATA;
700         } else {
701             pic = remove_short(h, h->cur_pic_ptr->frame_num, 0);
702             if (pic) {
703                 av_log(h->avctx, AV_LOG_ERROR, "illegal short term buffer state detected\n");
704                 err = AVERROR_INVALIDDATA;
705             }
706
707             if (h->short_ref_count)
708                 memmove(&h->short_ref[1], &h->short_ref[0],
709                         h->short_ref_count * sizeof(H264Picture*));
710
711             h->short_ref[0] = h->cur_pic_ptr;
712             h->short_ref_count++;
713             h->cur_pic_ptr->reference |= h->picture_structure;
714         }
715     }
716
717     if (h->long_ref_count + h->short_ref_count -
718         (h->short_ref[0] == h->cur_pic_ptr) > h->sps.ref_frame_count) {
719
720         /* We have too many reference frames, probably due to corrupted
721          * stream. Need to discard one frame. Prevents overrun of the
722          * short_ref and long_ref buffers.
723          */
724         av_log(h->avctx, AV_LOG_ERROR,
725                "number of reference frames (%d+%d) exceeds max (%d; probably "
726                "corrupt input), discarding one\n",
727                h->long_ref_count, h->short_ref_count, h->sps.ref_frame_count);
728         err = AVERROR_INVALIDDATA;
729
730         if (h->long_ref_count && !h->short_ref_count) {
731             for (i = 0; i < 16; ++i)
732                 if (h->long_ref[i])
733                     break;
734
735             assert(i < 16);
736             remove_long(h, i, 0);
737         } else {
738             pic = h->short_ref[h->short_ref_count - 1];
739             remove_short(h, pic->frame_num, 0);
740         }
741     }
742
743     print_short_term(h);
744     print_long_term(h);
745     return (h->avctx->err_recognition & AV_EF_EXPLODE) ? err : 0;
746 }
747
748 int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb,
749                                    int first_slice)
750 {
751     int i, ret;
752     MMCO mmco_temp[MAX_MMCO_COUNT], *mmco = first_slice ? h->mmco : mmco_temp;
753     int mmco_index = 0;
754
755     if (h->nal_unit_type == NAL_IDR_SLICE) { // FIXME fields
756         skip_bits1(gb); // broken_link
757         if (get_bits1(gb)) {
758             mmco[0].opcode   = MMCO_LONG;
759             mmco[0].long_arg = 0;
760             mmco_index       = 1;
761         }
762     } else {
763         if (get_bits1(gb)) { // adaptive_ref_pic_marking_mode_flag
764             for (i = 0; i < MAX_MMCO_COUNT; i++) {
765                 MMCOOpcode opcode = get_ue_golomb_31(gb);
766
767                 mmco[i].opcode = opcode;
768                 if (opcode == MMCO_SHORT2UNUSED || opcode == MMCO_SHORT2LONG) {
769                     mmco[i].short_pic_num =
770                         (h->curr_pic_num - get_ue_golomb(gb) - 1) &
771                             (h->max_pic_num - 1);
772 #if 0
773                     if (mmco[i].short_pic_num >= h->short_ref_count ||
774                         !h->short_ref[mmco[i].short_pic_num]) {
775                         av_log(s->avctx, AV_LOG_ERROR,
776                                "illegal short ref in memory management control "
777                                "operation %d\n", mmco);
778                         return -1;
779                     }
780 #endif
781                 }
782                 if (opcode == MMCO_SHORT2LONG || opcode == MMCO_LONG2UNUSED ||
783                     opcode == MMCO_LONG || opcode == MMCO_SET_MAX_LONG) {
784                     unsigned int long_arg = get_ue_golomb_31(gb);
785                     if (long_arg >= 32 ||
786                         (long_arg >= 16 && !(opcode == MMCO_SET_MAX_LONG &&
787                                              long_arg == 16) &&
788                          !(opcode == MMCO_LONG2UNUSED && FIELD_PICTURE(h)))) {
789                         av_log(h->avctx, AV_LOG_ERROR,
790                                "illegal long ref in memory management control "
791                                "operation %d\n", opcode);
792                         return -1;
793                     }
794                     mmco[i].long_arg = long_arg;
795                 }
796
797                 if (opcode > (unsigned) MMCO_LONG) {
798                     av_log(h->avctx, AV_LOG_ERROR,
799                            "illegal memory management control operation %d\n",
800                            opcode);
801                     return -1;
802                 }
803                 if (opcode == MMCO_END)
804                     break;
805             }
806             mmco_index = i;
807         } else {
808             if (first_slice) {
809                 ret = ff_generate_sliding_window_mmcos(h, first_slice);
810                 if (ret < 0 && h->avctx->err_recognition & AV_EF_EXPLODE)
811                     return ret;
812             }
813             mmco_index = -1;
814         }
815     }
816
817     if (first_slice && mmco_index != -1) {
818         h->mmco_index = mmco_index;
819     } else if (!first_slice && mmco_index >= 0 &&
820                (mmco_index != h->mmco_index ||
821                 check_opcodes(h->mmco, mmco_temp, mmco_index))) {
822         av_log(h->avctx, AV_LOG_ERROR,
823                "Inconsistent MMCO state between slices [%d, %d]\n",
824                mmco_index, h->mmco_index);
825         return AVERROR_INVALIDDATA;
826     }
827
828     return 0;
829 }