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