4 * Copyright (C) 2012 - 2013 Guillaume Martres
5 * Copyright (C) 2012 - 2013 Gildas Cocherel
7 * This file is part of FFmpeg.
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.
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.
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
24 #include "libavutil/avassert.h"
30 #include "refstruct.h"
31 #include "threadframe.h"
33 void ff_hevc_unref_frame(HEVCFrame *frame, int flags)
35 /* frame->frame can be NULL if context init failed */
36 if (!frame->frame || !frame->frame->buf[0])
39 frame->flags &= ~flags;
41 ff_thread_release_ext_buffer(&frame->tf);
42 av_frame_unref(frame->frame_grain);
45 av_buffer_unref(&frame->tab_mvf_buf);
46 frame->tab_mvf = NULL;
48 ff_refstruct_unref(&frame->rpl);
49 frame->nb_rpl_elems = 0;
50 av_buffer_unref(&frame->rpl_tab_buf);
51 frame->rpl_tab = NULL;
52 frame->refPicList = NULL;
54 ff_refstruct_unref(&frame->hwaccel_picture_private);
58 const RefPicList *ff_hevc_get_ref_list(const HEVCContext *s,
59 const HEVCFrame *ref, int x0, int y0)
61 int x_cb = x0 >> s->ps.sps->log2_ctb_size;
62 int y_cb = y0 >> s->ps.sps->log2_ctb_size;
63 int pic_width_cb = s->ps.sps->ctb_width;
64 int ctb_addr_ts = s->ps.pps->ctb_addr_rs_to_ts[y_cb * pic_width_cb + x_cb];
65 return &ref->rpl_tab[ctb_addr_ts]->refPicList[0];
68 void ff_hevc_clear_refs(HEVCContext *s)
71 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
72 ff_hevc_unref_frame(&s->DPB[i],
73 HEVC_FRAME_FLAG_SHORT_REF |
74 HEVC_FRAME_FLAG_LONG_REF);
77 void ff_hevc_flush_dpb(HEVCContext *s)
80 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
81 ff_hevc_unref_frame(&s->DPB[i], ~0);
84 static HEVCFrame *alloc_frame(HEVCContext *s)
87 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
88 HEVCFrame *frame = &s->DPB[i];
89 if (frame->frame->buf[0])
92 ret = ff_thread_get_ext_buffer(s->avctx, &frame->tf,
93 AV_GET_BUFFER_FLAG_REF);
97 frame->rpl = ff_refstruct_allocz(s->pkt.nb_nals * sizeof(*frame->rpl));
100 frame->nb_rpl_elems = s->pkt.nb_nals;
102 frame->tab_mvf_buf = av_buffer_pool_get(s->tab_mvf_pool);
103 if (!frame->tab_mvf_buf)
105 frame->tab_mvf = (MvField *)frame->tab_mvf_buf->data;
107 frame->rpl_tab_buf = av_buffer_pool_get(s->rpl_tab_pool);
108 if (!frame->rpl_tab_buf)
110 frame->rpl_tab = (RefPicListTab **)frame->rpl_tab_buf->data;
111 frame->ctb_count = s->ps.sps->ctb_width * s->ps.sps->ctb_height;
112 for (j = 0; j < frame->ctb_count; j++)
113 frame->rpl_tab[j] = frame->rpl;
115 if (s->sei.picture_timing.picture_struct == AV_PICTURE_STRUCTURE_TOP_FIELD)
116 frame->frame->flags |= AV_FRAME_FLAG_TOP_FIELD_FIRST;
117 if ((s->sei.picture_timing.picture_struct == AV_PICTURE_STRUCTURE_TOP_FIELD) ||
118 (s->sei.picture_timing.picture_struct == AV_PICTURE_STRUCTURE_BOTTOM_FIELD))
119 frame->frame->flags |= AV_FRAME_FLAG_INTERLACED;
121 ret = ff_hwaccel_frame_priv_alloc(s->avctx, &frame->hwaccel_picture_private);
127 ff_hevc_unref_frame(frame, ~0);
130 av_log(s->avctx, AV_LOG_ERROR, "Error allocating frame, DPB full.\n");
134 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc)
139 /* check that this POC doesn't already exist */
140 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
141 HEVCFrame *frame = &s->DPB[i];
143 if (frame->frame->buf[0] && frame->sequence == s->seq_decode &&
145 av_log(s->avctx, AV_LOG_ERROR, "Duplicate POC in a sequence: %d.\n",
147 return AVERROR_INVALIDDATA;
151 ref = alloc_frame(s);
153 return AVERROR(ENOMEM);
157 s->collocated_ref = NULL;
159 if (s->sh.pic_output_flag)
160 ref->flags = HEVC_FRAME_FLAG_OUTPUT | HEVC_FRAME_FLAG_SHORT_REF;
162 ref->flags = HEVC_FRAME_FLAG_SHORT_REF;
165 ref->sequence = s->seq_decode;
166 ref->frame->crop_left = s->ps.sps->output_window.left_offset;
167 ref->frame->crop_right = s->ps.sps->output_window.right_offset;
168 ref->frame->crop_top = s->ps.sps->output_window.top_offset;
169 ref->frame->crop_bottom = s->ps.sps->output_window.bottom_offset;
174 static void unref_missing_refs(HEVCContext *s)
176 for (int i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
177 HEVCFrame *frame = &s->DPB[i];
178 if (frame->sequence == HEVC_SEQUENCE_COUNTER_INVALID) {
179 ff_hevc_unref_frame(frame, ~0);
184 int ff_hevc_output_frame(HEVCContext *s, AVFrame *out, int flush)
186 if (IS_IRAP(s) && s->no_rasl_output_flag == 1) {
187 const static int mask = HEVC_FRAME_FLAG_BUMPING | HEVC_FRAME_FLAG_OUTPUT;
188 for (int i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
189 HEVCFrame *frame = &s->DPB[i];
190 if ((frame->flags & mask) == HEVC_FRAME_FLAG_OUTPUT &&
191 frame->sequence != s->seq_decode) {
192 if (s->sh.no_output_of_prior_pics_flag == 1)
193 ff_hevc_unref_frame(frame, HEVC_FRAME_FLAG_OUTPUT);
195 frame->flags |= HEVC_FRAME_FLAG_BUMPING;
201 int min_poc = INT_MAX;
204 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
205 HEVCFrame *frame = &s->DPB[i];
206 if ((frame->flags & HEVC_FRAME_FLAG_OUTPUT) &&
207 frame->sequence == s->seq_output) {
209 if (frame->poc < min_poc || nb_output == 1) {
210 min_poc = frame->poc;
216 /* wait for more frames before output */
217 if (!flush && s->seq_output == s->seq_decode && s->ps.sps &&
218 nb_output <= s->ps.sps->temporal_layer[s->ps.sps->max_sub_layers - 1].num_reorder_pics)
222 HEVCFrame *frame = &s->DPB[min_idx];
224 ret = av_frame_ref(out, frame->needs_fg ? frame->frame_grain : frame->frame);
225 if (frame->flags & HEVC_FRAME_FLAG_BUMPING)
226 ff_hevc_unref_frame(frame, HEVC_FRAME_FLAG_OUTPUT | HEVC_FRAME_FLAG_BUMPING);
228 ff_hevc_unref_frame(frame, HEVC_FRAME_FLAG_OUTPUT);
232 if (frame->needs_fg && (ret = av_frame_copy_props(out, frame->frame)) < 0)
235 if (!(s->avctx->export_side_data & AV_CODEC_EXPORT_DATA_FILM_GRAIN))
236 av_frame_remove_side_data(out, AV_FRAME_DATA_FILM_GRAIN_PARAMS);
238 av_log(s->avctx, AV_LOG_DEBUG,
239 "Output frame with POC %d.\n", frame->poc);
243 if (s->seq_output != s->seq_decode)
244 s->seq_output = (s->seq_output + 1) & HEVC_SEQUENCE_COUNTER_MASK;
252 void ff_hevc_bump_frame(HEVCContext *s)
255 int min_poc = INT_MAX;
258 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
259 HEVCFrame *frame = &s->DPB[i];
260 if ((frame->flags) &&
261 frame->sequence == s->seq_output &&
262 frame->poc != s->poc) {
267 if (s->ps.sps && dpb >= s->ps.sps->temporal_layer[s->ps.sps->max_sub_layers - 1].max_dec_pic_buffering) {
268 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
269 HEVCFrame *frame = &s->DPB[i];
270 if ((frame->flags) &&
271 frame->sequence == s->seq_output &&
272 frame->poc != s->poc) {
273 if (frame->flags == HEVC_FRAME_FLAG_OUTPUT && frame->poc < min_poc) {
274 min_poc = frame->poc;
279 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
280 HEVCFrame *frame = &s->DPB[i];
281 if (frame->flags & HEVC_FRAME_FLAG_OUTPUT &&
282 frame->sequence == s->seq_output &&
283 frame->poc <= min_poc) {
284 frame->flags |= HEVC_FRAME_FLAG_BUMPING;
292 static int init_slice_rpl(HEVCContext *s)
294 HEVCFrame *frame = s->ref;
295 int ctb_count = frame->ctb_count;
296 int ctb_addr_ts = s->ps.pps->ctb_addr_rs_to_ts[s->sh.slice_segment_addr];
299 if (s->slice_idx >= frame->nb_rpl_elems)
300 return AVERROR_INVALIDDATA;
302 for (i = ctb_addr_ts; i < ctb_count; i++)
303 frame->rpl_tab[i] = frame->rpl + s->slice_idx;
305 frame->refPicList = (RefPicList *)frame->rpl_tab[ctb_addr_ts];
310 int ff_hevc_slice_rpl(HEVCContext *s)
312 SliceHeader *sh = &s->sh;
314 uint8_t nb_list = sh->slice_type == HEVC_SLICE_B ? 2 : 1;
318 ret = init_slice_rpl(s);
322 if (!(s->rps[ST_CURR_BEF].nb_refs + s->rps[ST_CURR_AFT].nb_refs +
323 s->rps[LT_CURR].nb_refs) && !s->ps.pps->pps_curr_pic_ref_enabled_flag) {
324 av_log(s->avctx, AV_LOG_ERROR, "Zero refs in the frame RPS.\n");
325 return AVERROR_INVALIDDATA;
328 for (list_idx = 0; list_idx < nb_list; list_idx++) {
329 RefPicList rpl_tmp = { { 0 } };
330 RefPicList *rpl = &s->ref->refPicList[list_idx];
332 /* The order of the elements is
333 * ST_CURR_BEF - ST_CURR_AFT - LT_CURR for the L0 and
334 * ST_CURR_AFT - ST_CURR_BEF - LT_CURR for the L1 */
335 int cand_lists[3] = { list_idx ? ST_CURR_AFT : ST_CURR_BEF,
336 list_idx ? ST_CURR_BEF : ST_CURR_AFT,
339 /* concatenate the candidate lists for the current frame */
340 while (rpl_tmp.nb_refs < sh->nb_refs[list_idx]) {
341 for (i = 0; i < FF_ARRAY_ELEMS(cand_lists); i++) {
342 RefPicList *rps = &s->rps[cand_lists[i]];
343 for (j = 0; j < rps->nb_refs && rpl_tmp.nb_refs < HEVC_MAX_REFS; j++) {
344 rpl_tmp.list[rpl_tmp.nb_refs] = rps->list[j];
345 rpl_tmp.ref[rpl_tmp.nb_refs] = rps->ref[j];
346 rpl_tmp.isLongTerm[rpl_tmp.nb_refs] = i == 2;
350 // Construct RefPicList0, RefPicList1 (8-8, 8-10)
351 if (s->ps.pps->pps_curr_pic_ref_enabled_flag && rpl_tmp.nb_refs < HEVC_MAX_REFS) {
352 rpl_tmp.list[rpl_tmp.nb_refs] = s->ref->poc;
353 rpl_tmp.ref[rpl_tmp.nb_refs] = s->ref;
354 rpl_tmp.isLongTerm[rpl_tmp.nb_refs] = 1;
359 /* reorder the references if necessary */
360 if (sh->rpl_modification_flag[list_idx]) {
361 for (i = 0; i < sh->nb_refs[list_idx]; i++) {
362 int idx = sh->list_entry_lx[list_idx][i];
364 if (idx >= rpl_tmp.nb_refs) {
365 av_log(s->avctx, AV_LOG_ERROR, "Invalid reference index.\n");
366 return AVERROR_INVALIDDATA;
369 rpl->list[i] = rpl_tmp.list[idx];
370 rpl->ref[i] = rpl_tmp.ref[idx];
371 rpl->isLongTerm[i] = rpl_tmp.isLongTerm[idx];
375 memcpy(rpl, &rpl_tmp, sizeof(*rpl));
376 rpl->nb_refs = FFMIN(rpl->nb_refs, sh->nb_refs[list_idx]);
380 if (s->ps.pps->pps_curr_pic_ref_enabled_flag &&
381 !sh->rpl_modification_flag[list_idx] &&
382 rpl_tmp.nb_refs > sh->nb_refs[L0]) {
383 rpl->list[sh->nb_refs[L0] - 1] = s->ref->poc;
384 rpl->ref[sh->nb_refs[L0] - 1] = s->ref;
387 if (sh->collocated_list == list_idx &&
388 sh->collocated_ref_idx < rpl->nb_refs)
389 s->collocated_ref = rpl->ref[sh->collocated_ref_idx];
395 static HEVCFrame *find_ref_idx(HEVCContext *s, int poc, uint8_t use_msb)
397 int mask = use_msb ? ~0 : (1 << s->ps.sps->log2_max_poc_lsb) - 1;
400 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
401 HEVCFrame *ref = &s->DPB[i];
402 if (ref->frame->buf[0] && ref->sequence == s->seq_decode) {
403 if ((ref->poc & mask) == poc && (use_msb || ref->poc != s->poc))
408 if (s->nal_unit_type != HEVC_NAL_CRA_NUT && !IS_BLA(s))
409 av_log(s->avctx, AV_LOG_ERROR,
410 "Could not find ref with POC %d\n", poc);
414 static void mark_ref(HEVCFrame *frame, int flag)
416 frame->flags &= ~(HEVC_FRAME_FLAG_LONG_REF | HEVC_FRAME_FLAG_SHORT_REF);
417 frame->flags |= flag;
420 static HEVCFrame *generate_missing_ref(HEVCContext *s, int poc)
425 frame = alloc_frame(s);
429 if (!s->avctx->hwaccel) {
430 if (!s->ps.sps->pixel_shift) {
431 for (i = 0; frame->frame->data[i]; i++)
432 memset(frame->frame->data[i], 1 << (s->ps.sps->bit_depth - 1),
433 frame->frame->linesize[i] * AV_CEIL_RSHIFT(s->ps.sps->height, s->ps.sps->vshift[i]));
435 for (i = 0; frame->frame->data[i]; i++)
436 for (y = 0; y < (s->ps.sps->height >> s->ps.sps->vshift[i]); y++) {
437 uint8_t *dst = frame->frame->data[i] + y * frame->frame->linesize[i];
438 AV_WN16(dst, 1 << (s->ps.sps->bit_depth - 1));
439 av_memcpy_backptr(dst + 2, 2, 2*(s->ps.sps->width >> s->ps.sps->hshift[i]) - 2);
445 frame->sequence = HEVC_SEQUENCE_COUNTER_INVALID;
448 if (s->threads_type == FF_THREAD_FRAME)
449 ff_thread_report_progress(&frame->tf, INT_MAX, 0);
454 /* add a reference with the given poc to the list and mark it as used in DPB */
455 static int add_candidate_ref(HEVCContext *s, RefPicList *list,
456 int poc, int ref_flag, uint8_t use_msb)
458 HEVCFrame *ref = find_ref_idx(s, poc, use_msb);
460 if (ref == s->ref || list->nb_refs >= HEVC_MAX_REFS)
461 return AVERROR_INVALIDDATA;
464 ref = generate_missing_ref(s, poc);
466 return AVERROR(ENOMEM);
469 list->list[list->nb_refs] = ref->poc;
470 list->ref[list->nb_refs] = ref;
473 mark_ref(ref, ref_flag);
477 int ff_hevc_frame_rps(HEVCContext *s)
479 const ShortTermRPS *short_rps = s->sh.short_term_rps;
480 const LongTermRPS *long_rps = &s->sh.long_term_rps;
481 RefPicList *rps = s->rps;
485 rps[0].nb_refs = rps[1].nb_refs = 0;
489 unref_missing_refs(s);
491 /* clear the reference flags on all frames except the current one */
492 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
493 HEVCFrame *frame = &s->DPB[i];
501 for (i = 0; i < NB_RPS_TYPE; i++)
504 /* add the short refs */
505 for (i = 0; i < short_rps->num_delta_pocs; i++) {
506 int poc = s->poc + short_rps->delta_poc[i];
509 if (!short_rps->used[i])
511 else if (i < short_rps->num_negative_pics)
516 ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_SHORT_REF, 1);
521 /* add the long refs */
522 for (i = 0; i < long_rps->nb_refs; i++) {
523 int poc = long_rps->poc[i];
524 int list = long_rps->used[i] ? LT_CURR : LT_FOLL;
526 ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_LONG_REF, long_rps->poc_msb_present[i]);
532 /* release any frames that are now unused */
533 for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
534 ff_hevc_unref_frame(&s->DPB[i], 0);
539 int ff_hevc_frame_nb_refs(const HEVCContext *s)
543 const ShortTermRPS *rps = s->sh.short_term_rps;
544 const LongTermRPS *long_rps = &s->sh.long_term_rps;
547 for (i = 0; i < rps->num_negative_pics; i++)
548 ret += !!rps->used[i];
549 for (; i < rps->num_delta_pocs; i++)
550 ret += !!rps->used[i];
554 for (i = 0; i < long_rps->nb_refs; i++)
555 ret += !!long_rps->used[i];
558 if (s->ps.pps->pps_curr_pic_ref_enabled_flag)