24d55d15bec14a2bda0c3f784fc993a93715165b
[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             av_log(s->avctx, AV_LOG_DEBUG,
211                    "Output frame with POC %d.\n", frame->poc);
212             return 1;
213         }
214
215         if (s->seq_output != s->seq_decode)
216             s->seq_output = (s->seq_output + 1) & 0xff;
217         else
218             break;
219     } while (1);
220
221     return 0;
222 }
223
224 static int init_slice_rpl(HEVCContext *s)
225 {
226     HEVCFrame *frame = s->ref;
227     int ctb_count    = frame->ctb_count;
228     int ctb_addr_ts  = s->pps->ctb_addr_rs_to_ts[s->sh.slice_segment_addr];
229     int i;
230
231     if (s->slice_idx >= frame->rpl_buf->size / sizeof(RefPicListTab))
232         return AVERROR_INVALIDDATA;
233
234     for (i = ctb_addr_ts; i < ctb_count; i++)
235         frame->rpl_tab[i] = (RefPicListTab *)frame->rpl_buf->data + s->slice_idx;
236
237     frame->refPicList = (RefPicList *)frame->rpl_tab[ctb_addr_ts];
238
239     return 0;
240 }
241
242 int ff_hevc_slice_rpl(HEVCContext *s)
243 {
244     SliceHeader *sh = &s->sh;
245
246     uint8_t nb_list = sh->slice_type == B_SLICE ? 2 : 1;
247     uint8_t list_idx;
248     int i, j, ret;
249
250     ret = init_slice_rpl(s);
251     if (ret < 0)
252         return ret;
253
254     if (!(s->rps[ST_CURR_BEF].nb_refs + s->rps[ST_CURR_AFT].nb_refs +
255           s->rps[LT_CURR].nb_refs)) {
256         av_log(s->avctx, AV_LOG_ERROR, "Zero refs in the frame RPS.\n");
257         return AVERROR_INVALIDDATA;
258     }
259
260     for (list_idx = 0; list_idx < nb_list; list_idx++) {
261         RefPicList  rpl_tmp = { { 0 } };
262         RefPicList *rpl     = &s->ref->refPicList[list_idx];
263
264         /* The order of the elements is
265          * ST_CURR_BEF - ST_CURR_AFT - LT_CURR for the L0 and
266          * ST_CURR_AFT - ST_CURR_BEF - LT_CURR for the L1 */
267         int cand_lists[3] = { list_idx ? ST_CURR_AFT : ST_CURR_BEF,
268                               list_idx ? ST_CURR_BEF : ST_CURR_AFT,
269                               LT_CURR };
270
271         /* concatenate the candidate lists for the current frame */
272         while (rpl_tmp.nb_refs < sh->nb_refs[list_idx]) {
273             for (i = 0; i < FF_ARRAY_ELEMS(cand_lists); i++) {
274                 RefPicList *rps = &s->rps[cand_lists[i]];
275                 for (j = 0; j < rps->nb_refs && rpl_tmp.nb_refs < MAX_REFS; j++) {
276                     rpl_tmp.list[rpl_tmp.nb_refs]       = rps->list[j];
277                     rpl_tmp.ref[rpl_tmp.nb_refs]        = rps->ref[j];
278                     rpl_tmp.isLongTerm[rpl_tmp.nb_refs] = i == 2;
279                     rpl_tmp.nb_refs++;
280                 }
281             }
282         }
283
284         /* reorder the references if necessary */
285         if (sh->rpl_modification_flag[list_idx]) {
286             for (i = 0; i < sh->nb_refs[list_idx]; i++) {
287                 int idx = sh->list_entry_lx[list_idx][i];
288
289                 if (idx >= rpl_tmp.nb_refs) {
290                     av_log(s->avctx, AV_LOG_ERROR, "Invalid reference index.\n");
291                     return AVERROR_INVALIDDATA;
292                 }
293
294                 rpl->list[i]       = rpl_tmp.list[idx];
295                 rpl->ref[i]        = rpl_tmp.ref[idx];
296                 rpl->isLongTerm[i] = rpl_tmp.isLongTerm[idx];
297                 rpl->nb_refs++;
298             }
299         } else {
300             memcpy(rpl, &rpl_tmp, sizeof(*rpl));
301             rpl->nb_refs = FFMIN(rpl->nb_refs, sh->nb_refs[list_idx]);
302         }
303
304         if (sh->collocated_list == list_idx &&
305             sh->collocated_ref_idx < rpl->nb_refs)
306             s->ref->collocated_ref = rpl->ref[sh->collocated_ref_idx];
307     }
308
309     return 0;
310 }
311
312 static HEVCFrame *find_ref_idx(HEVCContext *s, int poc)
313 {
314     int i;
315     int LtMask = (1 << s->sps->log2_max_poc_lsb) - 1;
316
317     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
318         HEVCFrame *ref = &s->DPB[i];
319         if (ref->frame->buf[0] && (ref->sequence == s->seq_decode)) {
320             if ((ref->poc & LtMask) == poc)
321                 return ref;
322         }
323     }
324
325     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
326         HEVCFrame *ref = &s->DPB[i];
327         if (ref->frame->buf[0] && ref->sequence == s->seq_decode) {
328             if (ref->poc == poc || (ref->poc & LtMask) == poc)
329                 return ref;
330         }
331     }
332
333     av_log(s->avctx, AV_LOG_ERROR,
334            "Could not find ref with POC %d\n", poc);
335     return NULL;
336 }
337
338 static void mark_ref(HEVCFrame *frame, int flag)
339 {
340     frame->flags &= ~(HEVC_FRAME_FLAG_LONG_REF | HEVC_FRAME_FLAG_SHORT_REF);
341     frame->flags |= flag;
342 }
343
344 static HEVCFrame *generate_missing_ref(HEVCContext *s, int poc)
345 {
346     HEVCFrame *frame;
347     int i, x, y;
348
349     frame = alloc_frame(s);
350     if (!frame)
351         return NULL;
352
353     if (!s->sps->pixel_shift) {
354         for (i = 0; frame->frame->buf[i]; i++)
355             memset(frame->frame->buf[i]->data, 1 << (s->sps->bit_depth - 1),
356                    frame->frame->buf[i]->size);
357     } else {
358         for (i = 0; frame->frame->data[i]; i++)
359             for (y = 0; y < (s->sps->height >> s->sps->vshift[i]); y++)
360                 for (x = 0; x < (s->sps->width >> s->sps->hshift[i]); x++) {
361                     AV_WN16(frame->frame->data[i] + y * frame->frame->linesize[i] + 2 * x,
362                             1 << (s->sps->bit_depth - 1));
363                 }
364     }
365
366     frame->poc      = poc;
367     frame->sequence = s->seq_decode;
368     frame->flags    = 0;
369
370     if (s->threads_type == FF_THREAD_FRAME)
371         ff_thread_report_progress(&frame->tf, INT_MAX, 0);
372
373     return frame;
374 }
375
376 /* add a reference with the given poc to the list and mark it as used in DPB */
377 static int add_candidate_ref(HEVCContext *s, RefPicList *list,
378                              int poc, int ref_flag)
379 {
380     HEVCFrame *ref = find_ref_idx(s, poc);
381
382     if (ref == s->ref)
383         return AVERROR_INVALIDDATA;
384
385     if (!ref) {
386         ref = generate_missing_ref(s, poc);
387         if (!ref)
388             return AVERROR(ENOMEM);
389     }
390
391     list->list[list->nb_refs] = ref->poc;
392     list->ref[list->nb_refs]  = ref;
393     list->nb_refs++;
394
395     mark_ref(ref, ref_flag);
396     return 0;
397 }
398
399 int ff_hevc_frame_rps(HEVCContext *s)
400 {
401     const ShortTermRPS *short_rps = s->sh.short_term_rps;
402     const LongTermRPS  *long_rps  = &s->sh.long_term_rps;
403     RefPicList               *rps = s->rps;
404     int i, ret;
405
406     if (!short_rps) {
407         rps[0].nb_refs = rps[1].nb_refs = 0;
408         return 0;
409     }
410
411     /* clear the reference flags on all frames except the current one */
412     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
413         HEVCFrame *frame = &s->DPB[i];
414
415         if (frame == s->ref)
416             continue;
417
418         mark_ref(frame, 0);
419     }
420
421     for (i = 0; i < NB_RPS_TYPE; i++)
422         rps[i].nb_refs = 0;
423
424     /* add the short refs */
425     for (i = 0; i < short_rps->num_delta_pocs; i++) {
426         int poc = s->poc + short_rps->delta_poc[i];
427         int list;
428
429         if (!short_rps->used[i])
430             list = ST_FOLL;
431         else if (i < short_rps->num_negative_pics)
432             list = ST_CURR_BEF;
433         else
434             list = ST_CURR_AFT;
435
436         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_SHORT_REF);
437         if (ret < 0)
438             return ret;
439     }
440
441     /* add the long refs */
442     for (i = 0; i < long_rps->nb_refs; i++) {
443         int poc  = long_rps->poc[i];
444         int list = long_rps->used[i] ? LT_CURR : LT_FOLL;
445
446         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_LONG_REF);
447         if (ret < 0)
448             return ret;
449     }
450
451     /* release any frames that are now unused */
452     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
453         ff_hevc_unref_frame(s, &s->DPB[i], 0);
454
455     return 0;
456 }
457
458 int ff_hevc_compute_poc(HEVCContext *s, int poc_lsb)
459 {
460     int max_poc_lsb  = 1 << s->sps->log2_max_poc_lsb;
461     int prev_poc_lsb = s->pocTid0 % max_poc_lsb;
462     int prev_poc_msb = s->pocTid0 - prev_poc_lsb;
463     int poc_msb;
464
465     if (poc_lsb < prev_poc_lsb && prev_poc_lsb - poc_lsb >= max_poc_lsb / 2)
466         poc_msb = prev_poc_msb + max_poc_lsb;
467     else if (poc_lsb > prev_poc_lsb && poc_lsb - prev_poc_lsb > max_poc_lsb / 2)
468         poc_msb = prev_poc_msb - max_poc_lsb;
469     else
470         poc_msb = prev_poc_msb;
471
472     // For BLA picture types, POCmsb is set to 0.
473     if (s->nal_unit_type == NAL_BLA_W_LP   ||
474         s->nal_unit_type == NAL_BLA_W_RADL ||
475         s->nal_unit_type == NAL_BLA_N_LP)
476         poc_msb = 0;
477
478     return poc_msb + poc_lsb;
479 }
480
481 int ff_hevc_frame_nb_refs(HEVCContext *s)
482 {
483     int ret = 0;
484     int i;
485     const ShortTermRPS *rps = s->sh.short_term_rps;
486     LongTermRPS *long_rps   = &s->sh.long_term_rps;
487
488     if (rps) {
489         for (i = 0; i < rps->num_negative_pics; i++)
490             ret += !!rps->used[i];
491         for (; i < rps->num_delta_pocs; i++)
492             ret += !!rps->used[i];
493     }
494
495     if (long_rps) {
496         for (i = 0; i < long_rps->nb_refs; i++)
497             ret += !!long_rps->used[i];
498     }
499     return ret;
500 }