avcodec/hevcdec: remove HEVCContext usage from ff_hevc_compute_poc()
[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/avassert.h"
25 #include "libavutil/pixdesc.h"
26
27 #include "internal.h"
28 #include "thread.h"
29 #include "hevc.h"
30 #include "hevcdec.h"
31
32 void ff_hevc_unref_frame(HEVCContext *s, HEVCFrame *frame, int flags)
33 {
34     /* frame->frame can be NULL if context init failed */
35     if (!frame->frame || !frame->frame->buf[0])
36         return;
37
38     frame->flags &= ~flags;
39     if (!frame->flags) {
40         ff_thread_release_buffer(s->avctx, &frame->tf);
41
42         av_buffer_unref(&frame->tab_mvf_buf);
43         frame->tab_mvf = NULL;
44
45         av_buffer_unref(&frame->rpl_buf);
46         av_buffer_unref(&frame->rpl_tab_buf);
47         frame->rpl_tab    = NULL;
48         frame->refPicList = NULL;
49
50         frame->collocated_ref = NULL;
51
52         av_buffer_unref(&frame->hwaccel_priv_buf);
53         frame->hwaccel_picture_private = NULL;
54     }
55 }
56
57 RefPicList *ff_hevc_get_ref_list(HEVCContext *s, HEVCFrame *ref, int x0, int y0)
58 {
59     int x_cb         = x0 >> s->ps.sps->log2_ctb_size;
60     int y_cb         = y0 >> s->ps.sps->log2_ctb_size;
61     int pic_width_cb = s->ps.sps->ctb_width;
62     int ctb_addr_ts  = s->ps.pps->ctb_addr_rs_to_ts[y_cb * pic_width_cb + x_cb];
63     return (RefPicList *)ref->rpl_tab[ctb_addr_ts];
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->pkt.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->ps.sps->ctb_width * s->ps.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->sei.picture_timing.picture_struct == AV_PICTURE_STRUCTURE_TOP_FIELD;
113         frame->frame->interlaced_frame = (s->sei.picture_timing.picture_struct == AV_PICTURE_STRUCTURE_TOP_FIELD) || (s->sei.picture_timing.picture_struct == AV_PICTURE_STRUCTURE_BOTTOM_FIELD);
114
115         if (s->avctx->hwaccel) {
116             const AVHWAccel *hwaccel = s->avctx->hwaccel;
117             av_assert0(!frame->hwaccel_picture_private);
118             if (hwaccel->frame_priv_data_size) {
119                 frame->hwaccel_priv_buf = av_buffer_allocz(hwaccel->frame_priv_data_size);
120                 if (!frame->hwaccel_priv_buf)
121                     goto fail;
122                 frame->hwaccel_picture_private = frame->hwaccel_priv_buf->data;
123             }
124         }
125
126         return frame;
127 fail:
128         ff_hevc_unref_frame(s, frame, ~0);
129         return NULL;
130     }
131     av_log(s->avctx, AV_LOG_ERROR, "Error allocating frame, DPB full.\n");
132     return NULL;
133 }
134
135 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc)
136 {
137     HEVCFrame *ref;
138     int i;
139
140     /* check that this POC doesn't already exist */
141     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
142         HEVCFrame *frame = &s->DPB[i];
143
144         if (frame->frame->buf[0] && frame->sequence == s->seq_decode &&
145             frame->poc == poc) {
146             av_log(s->avctx, AV_LOG_ERROR, "Duplicate POC in a sequence: %d.\n",
147                    poc);
148             return AVERROR_INVALIDDATA;
149         }
150     }
151
152     ref = alloc_frame(s);
153     if (!ref)
154         return AVERROR(ENOMEM);
155
156     *frame = ref->frame;
157     s->ref = ref;
158
159     if (s->sh.pic_output_flag)
160         ref->flags = HEVC_FRAME_FLAG_OUTPUT | HEVC_FRAME_FLAG_SHORT_REF;
161     else
162         ref->flags = HEVC_FRAME_FLAG_SHORT_REF;
163
164     ref->poc      = poc;
165     ref->sequence = s->seq_decode;
166     ref->window   = s->ps.sps->output_window;
167
168     return 0;
169 }
170
171 int ff_hevc_output_frame(HEVCContext *s, AVFrame *out, int flush)
172 {
173     do {
174         int nb_output = 0;
175         int min_poc   = INT_MAX;
176         int i, min_idx, ret;
177
178         if (s->sh.no_output_of_prior_pics_flag == 1 && s->no_rasl_output_flag == 1) {
179             for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
180                 HEVCFrame *frame = &s->DPB[i];
181                 if (!(frame->flags & HEVC_FRAME_FLAG_BUMPING) && frame->poc != s->poc &&
182                         frame->sequence == s->seq_output) {
183                     ff_hevc_unref_frame(s, frame, HEVC_FRAME_FLAG_OUTPUT);
184                 }
185             }
186         }
187
188         for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
189             HEVCFrame *frame = &s->DPB[i];
190             if ((frame->flags & HEVC_FRAME_FLAG_OUTPUT) &&
191                 frame->sequence == s->seq_output) {
192                 nb_output++;
193                 if (frame->poc < min_poc || nb_output == 1) {
194                     min_poc = frame->poc;
195                     min_idx = i;
196                 }
197             }
198         }
199
200         /* wait for more frames before output */
201         if (!flush && s->seq_output == s->seq_decode && s->ps.sps &&
202             nb_output <= s->ps.sps->temporal_layer[s->ps.sps->max_sub_layers - 1].num_reorder_pics)
203             return 0;
204
205         if (nb_output) {
206             HEVCFrame *frame = &s->DPB[min_idx];
207             AVFrame *dst = out;
208             AVFrame *src = frame->frame;
209             const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(src->format);
210             int pixel_shift = !!(desc->comp[0].depth > 8);
211
212             ret = av_frame_ref(out, src);
213             if (frame->flags & HEVC_FRAME_FLAG_BUMPING)
214                 ff_hevc_unref_frame(s, frame, HEVC_FRAME_FLAG_OUTPUT | HEVC_FRAME_FLAG_BUMPING);
215             else
216                 ff_hevc_unref_frame(s, frame, HEVC_FRAME_FLAG_OUTPUT);
217             if (ret < 0)
218                 return ret;
219
220             for (i = 0; i < 3; i++) {
221                 int hshift = (i > 0) ? desc->log2_chroma_w : 0;
222                 int vshift = (i > 0) ? desc->log2_chroma_h : 0;
223                 int off = ((frame->window.left_offset >> hshift) << pixel_shift) +
224                           (frame->window.top_offset   >> vshift) * dst->linesize[i];
225                 dst->data[i] += off;
226             }
227             av_log(s->avctx, AV_LOG_DEBUG,
228                    "Output frame with POC %d.\n", frame->poc);
229             return 1;
230         }
231
232         if (s->seq_output != s->seq_decode)
233             s->seq_output = (s->seq_output + 1) & 0xff;
234         else
235             break;
236     } while (1);
237
238     return 0;
239 }
240
241 void ff_hevc_bump_frame(HEVCContext *s)
242 {
243     int dpb = 0;
244     int min_poc = INT_MAX;
245     int i;
246
247     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
248         HEVCFrame *frame = &s->DPB[i];
249         if ((frame->flags) &&
250             frame->sequence == s->seq_output &&
251             frame->poc != s->poc) {
252             dpb++;
253         }
254     }
255
256     if (s->ps.sps && dpb >= s->ps.sps->temporal_layer[s->ps.sps->max_sub_layers - 1].max_dec_pic_buffering) {
257         for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
258             HEVCFrame *frame = &s->DPB[i];
259             if ((frame->flags) &&
260                 frame->sequence == s->seq_output &&
261                 frame->poc != s->poc) {
262                 if (frame->flags == HEVC_FRAME_FLAG_OUTPUT && frame->poc < min_poc) {
263                     min_poc = frame->poc;
264                 }
265             }
266         }
267
268         for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
269             HEVCFrame *frame = &s->DPB[i];
270             if (frame->flags & HEVC_FRAME_FLAG_OUTPUT &&
271                 frame->sequence == s->seq_output &&
272                 frame->poc <= min_poc) {
273                 frame->flags |= HEVC_FRAME_FLAG_BUMPING;
274             }
275         }
276
277         dpb--;
278     }
279 }
280
281 static int init_slice_rpl(HEVCContext *s)
282 {
283     HEVCFrame *frame = s->ref;
284     int ctb_count    = frame->ctb_count;
285     int ctb_addr_ts  = s->ps.pps->ctb_addr_rs_to_ts[s->sh.slice_segment_addr];
286     int i;
287
288     if (s->slice_idx >= frame->rpl_buf->size / sizeof(RefPicListTab))
289         return AVERROR_INVALIDDATA;
290
291     for (i = ctb_addr_ts; i < ctb_count; i++)
292         frame->rpl_tab[i] = (RefPicListTab *)frame->rpl_buf->data + s->slice_idx;
293
294     frame->refPicList = (RefPicList *)frame->rpl_tab[ctb_addr_ts];
295
296     return 0;
297 }
298
299 int ff_hevc_slice_rpl(HEVCContext *s)
300 {
301     SliceHeader *sh = &s->sh;
302
303     uint8_t nb_list = sh->slice_type == HEVC_SLICE_B ? 2 : 1;
304     uint8_t list_idx;
305     int i, j, ret;
306
307     ret = init_slice_rpl(s);
308     if (ret < 0)
309         return ret;
310
311     if (!(s->rps[ST_CURR_BEF].nb_refs + s->rps[ST_CURR_AFT].nb_refs +
312           s->rps[LT_CURR].nb_refs)) {
313         av_log(s->avctx, AV_LOG_ERROR, "Zero refs in the frame RPS.\n");
314         return AVERROR_INVALIDDATA;
315     }
316
317     for (list_idx = 0; list_idx < nb_list; list_idx++) {
318         RefPicList  rpl_tmp = { { 0 } };
319         RefPicList *rpl     = &s->ref->refPicList[list_idx];
320
321         /* The order of the elements is
322          * ST_CURR_BEF - ST_CURR_AFT - LT_CURR for the L0 and
323          * ST_CURR_AFT - ST_CURR_BEF - LT_CURR for the L1 */
324         int cand_lists[3] = { list_idx ? ST_CURR_AFT : ST_CURR_BEF,
325                               list_idx ? ST_CURR_BEF : ST_CURR_AFT,
326                               LT_CURR };
327
328         /* concatenate the candidate lists for the current frame */
329         while (rpl_tmp.nb_refs < sh->nb_refs[list_idx]) {
330             for (i = 0; i < FF_ARRAY_ELEMS(cand_lists); i++) {
331                 RefPicList *rps = &s->rps[cand_lists[i]];
332                 for (j = 0; j < rps->nb_refs && rpl_tmp.nb_refs < HEVC_MAX_REFS; j++) {
333                     rpl_tmp.list[rpl_tmp.nb_refs]       = rps->list[j];
334                     rpl_tmp.ref[rpl_tmp.nb_refs]        = rps->ref[j];
335                     rpl_tmp.isLongTerm[rpl_tmp.nb_refs] = i == 2;
336                     rpl_tmp.nb_refs++;
337                 }
338             }
339         }
340
341         /* reorder the references if necessary */
342         if (sh->rpl_modification_flag[list_idx]) {
343             for (i = 0; i < sh->nb_refs[list_idx]; i++) {
344                 int idx = sh->list_entry_lx[list_idx][i];
345
346                 if (idx >= rpl_tmp.nb_refs) {
347                     av_log(s->avctx, AV_LOG_ERROR, "Invalid reference index.\n");
348                     return AVERROR_INVALIDDATA;
349                 }
350
351                 rpl->list[i]       = rpl_tmp.list[idx];
352                 rpl->ref[i]        = rpl_tmp.ref[idx];
353                 rpl->isLongTerm[i] = rpl_tmp.isLongTerm[idx];
354                 rpl->nb_refs++;
355             }
356         } else {
357             memcpy(rpl, &rpl_tmp, sizeof(*rpl));
358             rpl->nb_refs = FFMIN(rpl->nb_refs, sh->nb_refs[list_idx]);
359         }
360
361         if (sh->collocated_list == list_idx &&
362             sh->collocated_ref_idx < rpl->nb_refs)
363             s->ref->collocated_ref = rpl->ref[sh->collocated_ref_idx];
364     }
365
366     return 0;
367 }
368
369 static HEVCFrame *find_ref_idx(HEVCContext *s, int poc)
370 {
371     int i;
372     int LtMask = (1 << s->ps.sps->log2_max_poc_lsb) - 1;
373
374     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
375         HEVCFrame *ref = &s->DPB[i];
376         if (ref->frame->buf[0] && (ref->sequence == s->seq_decode)) {
377             if ((ref->poc & LtMask) == poc)
378                 return ref;
379         }
380     }
381
382     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
383         HEVCFrame *ref = &s->DPB[i];
384         if (ref->frame->buf[0] && ref->sequence == s->seq_decode) {
385             if (ref->poc == poc || (ref->poc & LtMask) == poc)
386                 return ref;
387         }
388     }
389
390     if (s->nal_unit_type != HEVC_NAL_CRA_NUT && !IS_BLA(s))
391         av_log(s->avctx, AV_LOG_ERROR,
392                "Could not find ref with POC %d\n", poc);
393     return NULL;
394 }
395
396 static void mark_ref(HEVCFrame *frame, int flag)
397 {
398     frame->flags &= ~(HEVC_FRAME_FLAG_LONG_REF | HEVC_FRAME_FLAG_SHORT_REF);
399     frame->flags |= flag;
400 }
401
402 static HEVCFrame *generate_missing_ref(HEVCContext *s, int poc)
403 {
404     HEVCFrame *frame;
405     int i, x, y;
406
407     frame = alloc_frame(s);
408     if (!frame)
409         return NULL;
410
411     if (!s->avctx->hwaccel) {
412         if (!s->ps.sps->pixel_shift) {
413             for (i = 0; frame->frame->buf[i]; i++)
414                 memset(frame->frame->buf[i]->data, 1 << (s->ps.sps->bit_depth - 1),
415                        frame->frame->buf[i]->size);
416         } else {
417             for (i = 0; frame->frame->data[i]; i++)
418                 for (y = 0; y < (s->ps.sps->height >> s->ps.sps->vshift[i]); y++)
419                     for (x = 0; x < (s->ps.sps->width >> s->ps.sps->hshift[i]); x++) {
420                         AV_WN16(frame->frame->data[i] + y * frame->frame->linesize[i] + 2 * x,
421                                 1 << (s->ps.sps->bit_depth - 1));
422                     }
423         }
424     }
425
426     frame->poc      = poc;
427     frame->sequence = s->seq_decode;
428     frame->flags    = 0;
429
430     if (s->threads_type == FF_THREAD_FRAME)
431         ff_thread_report_progress(&frame->tf, INT_MAX, 0);
432
433     return frame;
434 }
435
436 /* add a reference with the given poc to the list and mark it as used in DPB */
437 static int add_candidate_ref(HEVCContext *s, RefPicList *list,
438                              int poc, int ref_flag)
439 {
440     HEVCFrame *ref = find_ref_idx(s, poc);
441
442     if (ref == s->ref)
443         return AVERROR_INVALIDDATA;
444
445     if (!ref) {
446         ref = generate_missing_ref(s, poc);
447         if (!ref)
448             return AVERROR(ENOMEM);
449     }
450
451     list->list[list->nb_refs] = ref->poc;
452     list->ref[list->nb_refs]  = ref;
453     list->nb_refs++;
454
455     mark_ref(ref, ref_flag);
456     return 0;
457 }
458
459 int ff_hevc_frame_rps(HEVCContext *s)
460 {
461     const ShortTermRPS *short_rps = s->sh.short_term_rps;
462     const LongTermRPS  *long_rps  = &s->sh.long_term_rps;
463     RefPicList               *rps = s->rps;
464     int i, ret = 0;
465
466     if (!short_rps) {
467         rps[0].nb_refs = rps[1].nb_refs = 0;
468         return 0;
469     }
470
471     /* clear the reference flags on all frames except the current one */
472     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
473         HEVCFrame *frame = &s->DPB[i];
474
475         if (frame == s->ref)
476             continue;
477
478         mark_ref(frame, 0);
479     }
480
481     for (i = 0; i < NB_RPS_TYPE; i++)
482         rps[i].nb_refs = 0;
483
484     /* add the short refs */
485     for (i = 0; i < short_rps->num_delta_pocs; i++) {
486         int poc = s->poc + short_rps->delta_poc[i];
487         int list;
488
489         if (!short_rps->used[i])
490             list = ST_FOLL;
491         else if (i < short_rps->num_negative_pics)
492             list = ST_CURR_BEF;
493         else
494             list = ST_CURR_AFT;
495
496         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_SHORT_REF);
497         if (ret < 0)
498             goto fail;
499     }
500
501     /* add the long refs */
502     for (i = 0; i < long_rps->nb_refs; i++) {
503         int poc  = long_rps->poc[i];
504         int list = long_rps->used[i] ? LT_CURR : LT_FOLL;
505
506         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_LONG_REF);
507         if (ret < 0)
508             goto fail;
509     }
510
511 fail:
512     /* release any frames that are now unused */
513     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
514         ff_hevc_unref_frame(s, &s->DPB[i], 0);
515
516     return ret;
517 }
518
519 int ff_hevc_frame_nb_refs(HEVCContext *s)
520 {
521     int ret = 0;
522     int i;
523     const ShortTermRPS *rps = s->sh.short_term_rps;
524     LongTermRPS *long_rps   = &s->sh.long_term_rps;
525
526     if (rps) {
527         for (i = 0; i < rps->num_negative_pics; i++)
528             ret += !!rps->used[i];
529         for (; i < rps->num_delta_pocs; i++)
530             ret += !!rps->used[i];
531     }
532
533     if (long_rps) {
534         for (i = 0; i < long_rps->nb_refs; i++)
535             ret += !!long_rps->used[i];
536     }
537     return ret;
538 }