avcodec/hevc: fix outputted AVFrame.key_frame
[ffmpeg.git] / libavcodec / hevc_refs.c
1 /*
2  * HEVC video decoder
3  *
4  * Copyright (C) 2012 - 2013 Guillaume Martres
5  * Copyright (C) 2012 - 2013 Gildas Cocherel
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 #include "libavutil/pixdesc.h"
25
26 #include "internal.h"
27 #include "thread.h"
28 #include "hevc.h"
29
30 void ff_hevc_unref_frame(HEVCContext *s, HEVCFrame *frame, int flags)
31 {
32     /* frame->frame can be NULL if context init failed */
33     if (!frame->frame || !frame->frame->buf[0])
34         return;
35
36     frame->flags &= ~flags;
37     if (!frame->flags) {
38         ff_thread_release_buffer(s->avctx, &frame->tf);
39
40         av_buffer_unref(&frame->tab_mvf_buf);
41         frame->tab_mvf = NULL;
42
43         av_buffer_unref(&frame->rpl_buf);
44         av_buffer_unref(&frame->rpl_tab_buf);
45         frame->rpl_tab    = NULL;
46         frame->refPicList = NULL;
47
48         frame->collocated_ref = NULL;
49     }
50 }
51
52 RefPicList *ff_hevc_get_ref_list(HEVCContext *s, HEVCFrame *ref, int x0, int y0)
53 {
54     if (x0 < 0 || y0 < 0) {
55         return s->ref->refPicList;
56     } else {
57         int x_cb         = x0 >> s->sps->log2_ctb_size;
58         int y_cb         = y0 >> s->sps->log2_ctb_size;
59         int pic_width_cb = (s->sps->width + (1 << s->sps->log2_ctb_size) - 1) >>
60                            s->sps->log2_ctb_size;
61         int ctb_addr_ts  = s->pps->ctb_addr_rs_to_ts[y_cb * pic_width_cb + x_cb];
62         return (RefPicList *)ref->rpl_tab[ctb_addr_ts];
63     }
64 }
65
66 void ff_hevc_clear_refs(HEVCContext *s)
67 {
68     int i;
69     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
70         ff_hevc_unref_frame(s, &s->DPB[i],
71                             HEVC_FRAME_FLAG_SHORT_REF |
72                             HEVC_FRAME_FLAG_LONG_REF);
73 }
74
75 void ff_hevc_flush_dpb(HEVCContext *s)
76 {
77     int i;
78     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
79         ff_hevc_unref_frame(s, &s->DPB[i], ~0);
80 }
81
82 static HEVCFrame *alloc_frame(HEVCContext *s)
83 {
84     int i, j, ret;
85     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
86         HEVCFrame *frame = &s->DPB[i];
87         if (frame->frame->buf[0])
88             continue;
89
90         ret = ff_thread_get_buffer(s->avctx, &frame->tf,
91                                    AV_GET_BUFFER_FLAG_REF);
92         if (ret < 0)
93             return NULL;
94
95         frame->rpl_buf = av_buffer_allocz(s->nb_nals * sizeof(RefPicListTab));
96         if (!frame->rpl_buf)
97             goto fail;
98
99         frame->tab_mvf_buf = av_buffer_pool_get(s->tab_mvf_pool);
100         if (!frame->tab_mvf_buf)
101             goto fail;
102         frame->tab_mvf = (MvField *)frame->tab_mvf_buf->data;
103
104         frame->rpl_tab_buf = av_buffer_pool_get(s->rpl_tab_pool);
105         if (!frame->rpl_tab_buf)
106             goto fail;
107         frame->rpl_tab   = (RefPicListTab **)frame->rpl_tab_buf->data;
108         frame->ctb_count = s->sps->ctb_width * s->sps->ctb_height;
109         for (j = 0; j < frame->ctb_count; j++)
110             frame->rpl_tab[j] = (RefPicListTab *)frame->rpl_buf->data;
111
112         frame->frame->top_field_first  = s->picture_struct == AV_PICTURE_STRUCTURE_TOP_FIELD;
113         frame->frame->interlaced_frame = (s->picture_struct == AV_PICTURE_STRUCTURE_TOP_FIELD) || (s->picture_struct == AV_PICTURE_STRUCTURE_BOTTOM_FIELD);
114         return frame;
115 fail:
116         ff_hevc_unref_frame(s, frame, ~0);
117         return NULL;
118     }
119     av_log(s->avctx, AV_LOG_ERROR, "Error allocating frame, DPB full.\n");
120     return NULL;
121 }
122
123 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc)
124 {
125     HEVCFrame *ref;
126     int i;
127
128     /* check that this POC doesn't already exist */
129     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
130         HEVCFrame *frame = &s->DPB[i];
131
132         if (frame->frame->buf[0] && frame->sequence == s->seq_decode &&
133             frame->poc == poc) {
134             av_log(s->avctx, AV_LOG_ERROR, "Duplicate POC in a sequence: %d.\n",
135                    poc);
136             return AVERROR_INVALIDDATA;
137         }
138     }
139
140     ref = alloc_frame(s);
141     if (!ref)
142         return AVERROR(ENOMEM);
143
144     *frame = ref->frame;
145     s->ref = ref;
146
147     ref->poc      = poc;
148     ref->flags    = HEVC_FRAME_FLAG_OUTPUT | HEVC_FRAME_FLAG_SHORT_REF;
149     if (s->sh.pic_output_flag == 0)
150         ref->flags &= ~(HEVC_FRAME_FLAG_OUTPUT);
151     ref->sequence = s->seq_decode;
152     ref->window   = s->sps->output_window;
153
154     return 0;
155 }
156
157 int ff_hevc_output_frame(HEVCContext *s, AVFrame *out, int flush)
158 {
159     do {
160         int nb_output = 0;
161         int min_poc   = INT_MAX;
162         int i, min_idx, ret;
163
164         if (s->sh.no_output_of_prior_pics_flag == 1) {
165             for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
166                 HEVCFrame *frame = &s->DPB[i];
167                 if ((frame->flags & HEVC_FRAME_FLAG_OUTPUT) && frame->poc != s->poc &&
168                         frame->sequence == s->seq_output) {
169                     frame->flags &= ~(HEVC_FRAME_FLAG_OUTPUT);
170                 }
171             }
172         }
173
174         for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
175             HEVCFrame *frame = &s->DPB[i];
176             if ((frame->flags & HEVC_FRAME_FLAG_OUTPUT) &&
177                 frame->sequence == s->seq_output) {
178                 nb_output++;
179                 if (frame->poc < min_poc) {
180                     min_poc = frame->poc;
181                     min_idx = i;
182                 }
183             }
184         }
185
186         /* wait for more frames before output */
187         if (!flush && s->seq_output == s->seq_decode && s->sps &&
188             nb_output <= s->sps->temporal_layer[s->sps->max_sub_layers - 1].num_reorder_pics)
189             return 0;
190
191         if (nb_output) {
192             HEVCFrame *frame = &s->DPB[min_idx];
193             AVFrame *dst = out;
194             AVFrame *src = frame->frame;
195             const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(src->format);
196             int pixel_shift = !!(desc->comp[0].depth_minus1 > 7);
197
198             ret = av_frame_ref(out, src);
199             ff_hevc_unref_frame(s, frame, HEVC_FRAME_FLAG_OUTPUT);
200             if (ret < 0)
201                 return ret;
202
203             for (i = 0; i < 3; i++) {
204                 int hshift = (i > 0) ? desc->log2_chroma_w : 0;
205                 int vshift = (i > 0) ? desc->log2_chroma_h : 0;
206                 int off = ((frame->window.left_offset >> hshift) << pixel_shift) +
207                           (frame->window.top_offset   >> vshift) * dst->linesize[i];
208                 dst->data[i] += off;
209             }
210
211             out->key_frame = out->pict_type == AV_PICTURE_TYPE_I;
212
213             av_log(s->avctx, AV_LOG_DEBUG,
214                    "Output frame with POC %d.\n", frame->poc);
215             return 1;
216         }
217
218         if (s->seq_output != s->seq_decode)
219             s->seq_output = (s->seq_output + 1) & 0xff;
220         else
221             break;
222     } while (1);
223
224     return 0;
225 }
226
227 static int init_slice_rpl(HEVCContext *s)
228 {
229     HEVCFrame *frame = s->ref;
230     int ctb_count    = frame->ctb_count;
231     int ctb_addr_ts  = s->pps->ctb_addr_rs_to_ts[s->sh.slice_segment_addr];
232     int i;
233
234     if (s->slice_idx >= frame->rpl_buf->size / sizeof(RefPicListTab))
235         return AVERROR_INVALIDDATA;
236
237     for (i = ctb_addr_ts; i < ctb_count; i++)
238         frame->rpl_tab[i] = (RefPicListTab *)frame->rpl_buf->data + s->slice_idx;
239
240     frame->refPicList = (RefPicList *)frame->rpl_tab[ctb_addr_ts];
241
242     return 0;
243 }
244
245 int ff_hevc_slice_rpl(HEVCContext *s)
246 {
247     SliceHeader *sh = &s->sh;
248
249     uint8_t nb_list = sh->slice_type == B_SLICE ? 2 : 1;
250     uint8_t list_idx;
251     int i, j, ret;
252
253     ret = init_slice_rpl(s);
254     if (ret < 0)
255         return ret;
256
257     if (!(s->rps[ST_CURR_BEF].nb_refs + s->rps[ST_CURR_AFT].nb_refs +
258           s->rps[LT_CURR].nb_refs)) {
259         av_log(s->avctx, AV_LOG_ERROR, "Zero refs in the frame RPS.\n");
260         return AVERROR_INVALIDDATA;
261     }
262
263     for (list_idx = 0; list_idx < nb_list; list_idx++) {
264         RefPicList  rpl_tmp = { { 0 } };
265         RefPicList *rpl     = &s->ref->refPicList[list_idx];
266
267         /* The order of the elements is
268          * ST_CURR_BEF - ST_CURR_AFT - LT_CURR for the L0 and
269          * ST_CURR_AFT - ST_CURR_BEF - LT_CURR for the L1 */
270         int cand_lists[3] = { list_idx ? ST_CURR_AFT : ST_CURR_BEF,
271                               list_idx ? ST_CURR_BEF : ST_CURR_AFT,
272                               LT_CURR };
273
274         /* concatenate the candidate lists for the current frame */
275         while (rpl_tmp.nb_refs < sh->nb_refs[list_idx]) {
276             for (i = 0; i < FF_ARRAY_ELEMS(cand_lists); i++) {
277                 RefPicList *rps = &s->rps[cand_lists[i]];
278                 for (j = 0; j < rps->nb_refs && rpl_tmp.nb_refs < MAX_REFS; j++) {
279                     rpl_tmp.list[rpl_tmp.nb_refs]       = rps->list[j];
280                     rpl_tmp.ref[rpl_tmp.nb_refs]        = rps->ref[j];
281                     rpl_tmp.isLongTerm[rpl_tmp.nb_refs] = i == 2;
282                     rpl_tmp.nb_refs++;
283                 }
284             }
285         }
286
287         /* reorder the references if necessary */
288         if (sh->rpl_modification_flag[list_idx]) {
289             for (i = 0; i < sh->nb_refs[list_idx]; i++) {
290                 int idx = sh->list_entry_lx[list_idx][i];
291
292                 if (idx >= rpl_tmp.nb_refs) {
293                     av_log(s->avctx, AV_LOG_ERROR, "Invalid reference index.\n");
294                     return AVERROR_INVALIDDATA;
295                 }
296
297                 rpl->list[i]       = rpl_tmp.list[idx];
298                 rpl->ref[i]        = rpl_tmp.ref[idx];
299                 rpl->isLongTerm[i] = rpl_tmp.isLongTerm[idx];
300                 rpl->nb_refs++;
301             }
302         } else {
303             memcpy(rpl, &rpl_tmp, sizeof(*rpl));
304             rpl->nb_refs = FFMIN(rpl->nb_refs, sh->nb_refs[list_idx]);
305         }
306
307         if (sh->collocated_list == list_idx &&
308             sh->collocated_ref_idx < rpl->nb_refs)
309             s->ref->collocated_ref = rpl->ref[sh->collocated_ref_idx];
310     }
311
312     return 0;
313 }
314
315 static HEVCFrame *find_ref_idx(HEVCContext *s, int poc)
316 {
317     int i;
318     int LtMask = (1 << s->sps->log2_max_poc_lsb) - 1;
319
320     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
321         HEVCFrame *ref = &s->DPB[i];
322         if (ref->frame->buf[0] && (ref->sequence == s->seq_decode)) {
323             if ((ref->poc & LtMask) == poc)
324                 return ref;
325         }
326     }
327
328     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
329         HEVCFrame *ref = &s->DPB[i];
330         if (ref->frame->buf[0] && ref->sequence == s->seq_decode) {
331             if (ref->poc == poc || (ref->poc & LtMask) == poc)
332                 return ref;
333         }
334     }
335
336     av_log(s->avctx, AV_LOG_ERROR,
337            "Could not find ref with POC %d\n", poc);
338     return NULL;
339 }
340
341 static void mark_ref(HEVCFrame *frame, int flag)
342 {
343     frame->flags &= ~(HEVC_FRAME_FLAG_LONG_REF | HEVC_FRAME_FLAG_SHORT_REF);
344     frame->flags |= flag;
345 }
346
347 static HEVCFrame *generate_missing_ref(HEVCContext *s, int poc)
348 {
349     HEVCFrame *frame;
350     int i, x, y;
351
352     frame = alloc_frame(s);
353     if (!frame)
354         return NULL;
355
356     if (!s->sps->pixel_shift) {
357         for (i = 0; frame->frame->buf[i]; i++)
358             memset(frame->frame->buf[i]->data, 1 << (s->sps->bit_depth - 1),
359                    frame->frame->buf[i]->size);
360     } else {
361         for (i = 0; frame->frame->data[i]; i++)
362             for (y = 0; y < (s->sps->height >> s->sps->vshift[i]); y++)
363                 for (x = 0; x < (s->sps->width >> s->sps->hshift[i]); x++) {
364                     AV_WN16(frame->frame->data[i] + y * frame->frame->linesize[i] + 2 * x,
365                             1 << (s->sps->bit_depth - 1));
366                 }
367     }
368
369     frame->poc      = poc;
370     frame->sequence = s->seq_decode;
371     frame->flags    = 0;
372
373     if (s->threads_type == FF_THREAD_FRAME)
374         ff_thread_report_progress(&frame->tf, INT_MAX, 0);
375
376     return frame;
377 }
378
379 /* add a reference with the given poc to the list and mark it as used in DPB */
380 static int add_candidate_ref(HEVCContext *s, RefPicList *list,
381                              int poc, int ref_flag)
382 {
383     HEVCFrame *ref = find_ref_idx(s, poc);
384
385     if (ref == s->ref)
386         return AVERROR_INVALIDDATA;
387
388     if (!ref) {
389         ref = generate_missing_ref(s, poc);
390         if (!ref)
391             return AVERROR(ENOMEM);
392     }
393
394     list->list[list->nb_refs] = ref->poc;
395     list->ref[list->nb_refs]  = ref;
396     list->nb_refs++;
397
398     mark_ref(ref, ref_flag);
399     return 0;
400 }
401
402 int ff_hevc_frame_rps(HEVCContext *s)
403 {
404     const ShortTermRPS *short_rps = s->sh.short_term_rps;
405     const LongTermRPS  *long_rps  = &s->sh.long_term_rps;
406     RefPicList               *rps = s->rps;
407     int i, ret;
408
409     if (!short_rps) {
410         rps[0].nb_refs = rps[1].nb_refs = 0;
411         return 0;
412     }
413
414     /* clear the reference flags on all frames except the current one */
415     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
416         HEVCFrame *frame = &s->DPB[i];
417
418         if (frame == s->ref)
419             continue;
420
421         mark_ref(frame, 0);
422     }
423
424     for (i = 0; i < NB_RPS_TYPE; i++)
425         rps[i].nb_refs = 0;
426
427     /* add the short refs */
428     for (i = 0; i < short_rps->num_delta_pocs; i++) {
429         int poc = s->poc + short_rps->delta_poc[i];
430         int list;
431
432         if (!short_rps->used[i])
433             list = ST_FOLL;
434         else if (i < short_rps->num_negative_pics)
435             list = ST_CURR_BEF;
436         else
437             list = ST_CURR_AFT;
438
439         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_SHORT_REF);
440         if (ret < 0)
441             return ret;
442     }
443
444     /* add the long refs */
445     for (i = 0; i < long_rps->nb_refs; i++) {
446         int poc  = long_rps->poc[i];
447         int list = long_rps->used[i] ? LT_CURR : LT_FOLL;
448
449         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_LONG_REF);
450         if (ret < 0)
451             return ret;
452     }
453
454     /* release any frames that are now unused */
455     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
456         ff_hevc_unref_frame(s, &s->DPB[i], 0);
457
458     return 0;
459 }
460
461 int ff_hevc_compute_poc(HEVCContext *s, int poc_lsb)
462 {
463     int max_poc_lsb  = 1 << s->sps->log2_max_poc_lsb;
464     int prev_poc_lsb = s->pocTid0 % max_poc_lsb;
465     int prev_poc_msb = s->pocTid0 - prev_poc_lsb;
466     int poc_msb;
467
468     if (poc_lsb < prev_poc_lsb && prev_poc_lsb - poc_lsb >= max_poc_lsb / 2)
469         poc_msb = prev_poc_msb + max_poc_lsb;
470     else if (poc_lsb > prev_poc_lsb && poc_lsb - prev_poc_lsb > max_poc_lsb / 2)
471         poc_msb = prev_poc_msb - max_poc_lsb;
472     else
473         poc_msb = prev_poc_msb;
474
475     // For BLA picture types, POCmsb is set to 0.
476     if (s->nal_unit_type == NAL_BLA_W_LP   ||
477         s->nal_unit_type == NAL_BLA_W_RADL ||
478         s->nal_unit_type == NAL_BLA_N_LP)
479         poc_msb = 0;
480
481     return poc_msb + poc_lsb;
482 }
483
484 int ff_hevc_frame_nb_refs(HEVCContext *s)
485 {
486     int ret = 0;
487     int i;
488     const ShortTermRPS *rps = s->sh.short_term_rps;
489     LongTermRPS *long_rps   = &s->sh.long_term_rps;
490
491     if (rps) {
492         for (i = 0; i < rps->num_negative_pics; i++)
493             ret += !!rps->used[i];
494         for (; i < rps->num_delta_pocs; i++)
495             ret += !!rps->used[i];
496     }
497
498     if (long_rps) {
499         for (i = 0; i < long_rps->nb_refs; i++)
500             ret += !!long_rps->used[i];
501     }
502     return ret;
503 }