hevc: move the SliceType enum to hevc.h
[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 Libav.
8  *
9  * Libav 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  * Libav 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 Libav; 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->width + (1 << s->ps.sps->log2_ctb_size) - 1) >>
62         s->ps.sps->log2_ctb_size;
63     int ctb_addr_ts  = s->ps.pps->ctb_addr_rs_to_ts[y_cb * pic_width_cb + x_cb];
64     return (RefPicList *)ref->rpl_tab[ctb_addr_ts];
65 }
66
67 void ff_hevc_clear_refs(HEVCContext *s)
68 {
69     int i;
70     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
71         ff_hevc_unref_frame(s, &s->DPB[i],
72                             HEVC_FRAME_FLAG_SHORT_REF |
73                             HEVC_FRAME_FLAG_LONG_REF);
74 }
75
76 void ff_hevc_flush_dpb(HEVCContext *s)
77 {
78     int i;
79     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
80         ff_hevc_unref_frame(s, &s->DPB[i], ~0);
81 }
82
83 static HEVCFrame *alloc_frame(HEVCContext *s)
84 {
85     int i, j, ret;
86     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
87         HEVCFrame *frame = &s->DPB[i];
88         if (frame->frame->buf[0])
89             continue;
90
91         ret = ff_thread_get_buffer(s->avctx, &frame->tf,
92                                    AV_GET_BUFFER_FLAG_REF);
93         if (ret < 0)
94             return NULL;
95
96         frame->rpl_buf = av_buffer_allocz(s->pkt.nb_nals * sizeof(RefPicListTab));
97         if (!frame->rpl_buf)
98             goto fail;
99
100         frame->tab_mvf_buf = av_buffer_pool_get(s->tab_mvf_pool);
101         if (!frame->tab_mvf_buf)
102             goto fail;
103         frame->tab_mvf = (MvField *)frame->tab_mvf_buf->data;
104
105         frame->rpl_tab_buf = av_buffer_pool_get(s->rpl_tab_pool);
106         if (!frame->rpl_tab_buf)
107             goto fail;
108         frame->rpl_tab   = (RefPicListTab **)frame->rpl_tab_buf->data;
109         frame->ctb_count = s->ps.sps->ctb_width * s->ps.sps->ctb_height;
110         for (j = 0; j < frame->ctb_count; j++)
111             frame->rpl_tab[j] = (RefPicListTab *)frame->rpl_buf->data;
112
113         if (s->avctx->hwaccel) {
114             const AVHWAccel *hwaccel = s->avctx->hwaccel;
115             av_assert0(!frame->hwaccel_picture_private);
116             if (hwaccel->frame_priv_data_size) {
117                 frame->hwaccel_priv_buf = av_buffer_allocz(hwaccel->frame_priv_data_size);
118                 if (!frame->hwaccel_priv_buf)
119                     goto fail;
120                 frame->hwaccel_picture_private = frame->hwaccel_priv_buf->data;
121             }
122         }
123
124         return frame;
125
126 fail:
127         ff_hevc_unref_frame(s, frame, ~0);
128         return NULL;
129     }
130     av_log(s->avctx, AV_LOG_ERROR, "Error allocating frame, DPB full.\n");
131     return NULL;
132 }
133
134 int ff_hevc_set_new_ref(HEVCContext *s, AVFrame **frame, int poc)
135 {
136     HEVCFrame *ref;
137     int i;
138
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];
142
143         if (frame->frame->buf[0] && frame->sequence == s->seq_decode &&
144             frame->poc == poc) {
145             av_log(s->avctx, AV_LOG_ERROR, "Duplicate POC in a sequence: %d.\n",
146                    poc);
147             return AVERROR_INVALIDDATA;
148         }
149     }
150
151     ref = alloc_frame(s);
152     if (!ref)
153         return AVERROR(ENOMEM);
154
155     *frame = ref->frame;
156     s->ref = ref;
157
158     if (s->sh.pic_output_flag)
159         ref->flags = HEVC_FRAME_FLAG_OUTPUT | HEVC_FRAME_FLAG_SHORT_REF;
160     else
161         ref->flags = HEVC_FRAME_FLAG_SHORT_REF;
162
163     ref->poc      = poc;
164     ref->sequence = s->seq_decode;
165     ref->window   = s->ps.sps->output_window;
166
167     return 0;
168 }
169
170 int ff_hevc_output_frame(HEVCContext *s, AVFrame *out, int flush)
171 {
172     do {
173         int nb_output = 0;
174         int min_poc   = INT_MAX;
175         int i, min_idx, ret;
176
177         for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
178             HEVCFrame *frame = &s->DPB[i];
179             if ((frame->flags & HEVC_FRAME_FLAG_OUTPUT) &&
180                 frame->sequence == s->seq_output) {
181                 nb_output++;
182                 if (frame->poc < min_poc) {
183                     min_poc = frame->poc;
184                     min_idx = i;
185                 }
186             }
187         }
188
189         /* wait for more frames before output */
190         if (!flush && s->seq_output == s->seq_decode && s->ps.sps &&
191             nb_output <= s->ps.sps->temporal_layer[s->ps.sps->max_sub_layers - 1].num_reorder_pics)
192             return 0;
193
194         if (nb_output) {
195             HEVCFrame *frame = &s->DPB[min_idx];
196             const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->frame->format);
197             int pixel_shift;
198
199             if (!desc)
200                 return AVERROR_BUG;
201
202             pixel_shift = desc->comp[0].depth > 8;
203
204             ret = av_frame_ref(out, frame->frame);
205             ff_hevc_unref_frame(s, frame, HEVC_FRAME_FLAG_OUTPUT);
206             if (ret < 0)
207                 return ret;
208
209             for (i = 0; i < 3; i++) {
210                 int hshift = (i > 0) ? desc->log2_chroma_w : 0;
211                 int vshift = (i > 0) ? desc->log2_chroma_h : 0;
212                 int off = ((frame->window.left_offset >> hshift) << pixel_shift) +
213                           (frame->window.top_offset   >> vshift) * out->linesize[i];
214                 out->data[i] += off;
215             }
216             av_log(s->avctx, AV_LOG_DEBUG,
217                    "Output frame with POC %d.\n", frame->poc);
218             return 1;
219         }
220
221         if (s->seq_output != s->seq_decode)
222             s->seq_output = (s->seq_output + 1) & 0xff;
223         else
224             break;
225     } while (1);
226
227     return 0;
228 }
229
230 static int init_slice_rpl(HEVCContext *s)
231 {
232     HEVCFrame *frame = s->ref;
233     int ctb_count    = frame->ctb_count;
234     int ctb_addr_ts  = s->ps.pps->ctb_addr_rs_to_ts[s->sh.slice_segment_addr];
235     int i;
236
237     if (s->slice_idx >= frame->rpl_buf->size / sizeof(RefPicListTab))
238         return AVERROR_INVALIDDATA;
239
240     for (i = ctb_addr_ts; i < ctb_count; i++)
241         frame->rpl_tab[i] = (RefPicListTab *)frame->rpl_buf->data + s->slice_idx;
242
243     frame->refPicList = (RefPicList *)frame->rpl_tab[ctb_addr_ts];
244
245     return 0;
246 }
247
248 int ff_hevc_slice_rpl(HEVCContext *s)
249 {
250     SliceHeader *sh = &s->sh;
251
252     uint8_t nb_list = sh->slice_type == HEVC_SLICE_B ? 2 : 1;
253     uint8_t list_idx;
254     int i, j, ret;
255
256     ret = init_slice_rpl(s);
257     if (ret < 0)
258         return ret;
259
260     if (!(s->rps[ST_CURR_BEF].nb_refs + s->rps[ST_CURR_AFT].nb_refs +
261           s->rps[LT_CURR].nb_refs)) {
262         av_log(s->avctx, AV_LOG_ERROR, "Zero refs in the frame RPS.\n");
263         return AVERROR_INVALIDDATA;
264     }
265
266     for (list_idx = 0; list_idx < nb_list; list_idx++) {
267         RefPicList  rpl_tmp = { { 0 } };
268         RefPicList *rpl     = &s->ref->refPicList[list_idx];
269
270         /* The order of the elements is
271          * ST_CURR_BEF - ST_CURR_AFT - LT_CURR for the L0 and
272          * ST_CURR_AFT - ST_CURR_BEF - LT_CURR for the L1 */
273         int cand_lists[3] = { list_idx ? ST_CURR_AFT : ST_CURR_BEF,
274                               list_idx ? ST_CURR_BEF : ST_CURR_AFT,
275                               LT_CURR };
276
277         /* concatenate the candidate lists for the current frame */
278         while (rpl_tmp.nb_refs < sh->nb_refs[list_idx]) {
279             for (i = 0; i < FF_ARRAY_ELEMS(cand_lists); i++) {
280                 RefPicList *rps = &s->rps[cand_lists[i]];
281                 for (j = 0; j < rps->nb_refs && rpl_tmp.nb_refs < HEVC_MAX_REFS; j++) {
282                     rpl_tmp.list[rpl_tmp.nb_refs]       = rps->list[j];
283                     rpl_tmp.ref[rpl_tmp.nb_refs]        = rps->ref[j];
284                     rpl_tmp.isLongTerm[rpl_tmp.nb_refs] = i == 2;
285                     rpl_tmp.nb_refs++;
286                 }
287             }
288         }
289
290         /* reorder the references if necessary */
291         if (sh->rpl_modification_flag[list_idx]) {
292             for (i = 0; i < sh->nb_refs[list_idx]; i++) {
293                 int idx = sh->list_entry_lx[list_idx][i];
294
295                 if (idx >= rpl_tmp.nb_refs) {
296                     av_log(s->avctx, AV_LOG_ERROR, "Invalid reference index.\n");
297                     return AVERROR_INVALIDDATA;
298                 }
299
300                 rpl->list[i]       = rpl_tmp.list[idx];
301                 rpl->ref[i]        = rpl_tmp.ref[idx];
302                 rpl->isLongTerm[i] = rpl_tmp.isLongTerm[idx];
303                 rpl->nb_refs++;
304             }
305         } else {
306             memcpy(rpl, &rpl_tmp, sizeof(*rpl));
307             rpl->nb_refs = FFMIN(rpl->nb_refs, sh->nb_refs[list_idx]);
308         }
309
310         if (sh->collocated_list == list_idx &&
311             sh->collocated_ref_idx < rpl->nb_refs)
312             s->ref->collocated_ref = rpl->ref[sh->collocated_ref_idx];
313     }
314
315     return 0;
316 }
317
318 static HEVCFrame *find_ref_idx(HEVCContext *s, int poc)
319 {
320     int i;
321     int LtMask = (1 << s->ps.sps->log2_max_poc_lsb) - 1;
322
323     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
324         HEVCFrame *ref = &s->DPB[i];
325         if (ref->frame->buf[0] && (ref->sequence == s->seq_decode)) {
326             if ((ref->poc & LtMask) == poc)
327                 return ref;
328         }
329     }
330
331     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
332         HEVCFrame *ref = &s->DPB[i];
333         if (ref->frame->buf[0] && ref->sequence == s->seq_decode) {
334             if (ref->poc == poc || (ref->poc & LtMask) == poc)
335                 return ref;
336         }
337     }
338
339     av_log(s->avctx, AV_LOG_ERROR,
340            "Could not find ref with POC %d\n", poc);
341     return NULL;
342 }
343
344 static void mark_ref(HEVCFrame *frame, int flag)
345 {
346     frame->flags &= ~(HEVC_FRAME_FLAG_LONG_REF | HEVC_FRAME_FLAG_SHORT_REF);
347     frame->flags |= flag;
348 }
349
350 static HEVCFrame *generate_missing_ref(HEVCContext *s, int poc)
351 {
352     HEVCFrame *frame;
353     int i, x, y;
354
355     frame = alloc_frame(s);
356     if (!frame)
357         return NULL;
358
359     if (!s->avctx->hwaccel) {
360         if (!s->ps.sps->pixel_shift) {
361             for (i = 0; frame->frame->buf[i]; i++)
362                 memset(frame->frame->buf[i]->data, 1 << (s->ps.sps->bit_depth - 1),
363                        frame->frame->buf[i]->size);
364         } else {
365             for (i = 0; frame->frame->data[i]; i++)
366                 for (y = 0; y < (s->ps.sps->height >> s->ps.sps->vshift[i]); y++)
367                     for (x = 0; x < (s->ps.sps->width >> s->ps.sps->hshift[i]); x++) {
368                         AV_WN16(frame->frame->data[i] + y * frame->frame->linesize[i] + 2 * x,
369                                 1 << (s->ps.sps->bit_depth - 1));
370                     }
371         }
372     }
373
374     frame->poc      = poc;
375     frame->sequence = s->seq_decode;
376     frame->flags    = 0;
377
378     ff_thread_report_progress(&frame->tf, INT_MAX, 0);
379
380     return frame;
381 }
382
383 /* add a reference with the given poc to the list and mark it as used in DPB */
384 static int add_candidate_ref(HEVCContext *s, RefPicList *list,
385                              int poc, int ref_flag)
386 {
387     HEVCFrame *ref = find_ref_idx(s, poc);
388
389     if (ref == s->ref)
390         return AVERROR_INVALIDDATA;
391
392     if (!ref) {
393         ref = generate_missing_ref(s, poc);
394         if (!ref)
395             return AVERROR(ENOMEM);
396     }
397
398     list->list[list->nb_refs] = ref->poc;
399     list->ref[list->nb_refs]  = ref;
400     list->nb_refs++;
401
402     mark_ref(ref, ref_flag);
403     return 0;
404 }
405
406 int ff_hevc_frame_rps(HEVCContext *s)
407 {
408     const ShortTermRPS *short_rps = s->sh.short_term_rps;
409     const LongTermRPS  *long_rps  = &s->sh.long_term_rps;
410     RefPicList               *rps = s->rps;
411     int i, ret = 0;
412
413     if (!short_rps) {
414         rps[0].nb_refs = rps[1].nb_refs = 0;
415         return 0;
416     }
417
418     /* clear the reference flags on all frames except the current one */
419     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++) {
420         HEVCFrame *frame = &s->DPB[i];
421
422         if (frame == s->ref)
423             continue;
424
425         mark_ref(frame, 0);
426     }
427
428     for (i = 0; i < NB_RPS_TYPE; i++)
429         rps[i].nb_refs = 0;
430
431     /* add the short refs */
432     for (i = 0; i < short_rps->num_delta_pocs; i++) {
433         int poc = s->poc + short_rps->delta_poc[i];
434         int list;
435
436         if (!short_rps->used[i])
437             list = ST_FOLL;
438         else if (i < short_rps->num_negative_pics)
439             list = ST_CURR_BEF;
440         else
441             list = ST_CURR_AFT;
442
443         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_SHORT_REF);
444         if (ret < 0)
445             goto fail;
446     }
447
448     /* add the long refs */
449     for (i = 0; i < long_rps->nb_refs; i++) {
450         int poc  = long_rps->poc[i];
451         int list = long_rps->used[i] ? LT_CURR : LT_FOLL;
452
453         ret = add_candidate_ref(s, &rps[list], poc, HEVC_FRAME_FLAG_LONG_REF);
454         if (ret < 0)
455             goto fail;
456     }
457
458 fail:
459     /* release any frames that are now unused */
460     for (i = 0; i < FF_ARRAY_ELEMS(s->DPB); i++)
461         ff_hevc_unref_frame(s, &s->DPB[i], 0);
462
463     return ret;
464 }
465
466 int ff_hevc_compute_poc(HEVCContext *s, int poc_lsb)
467 {
468     int max_poc_lsb  = 1 << s->ps.sps->log2_max_poc_lsb;
469     int prev_poc_lsb = s->pocTid0 % max_poc_lsb;
470     int prev_poc_msb = s->pocTid0 - prev_poc_lsb;
471     int poc_msb;
472
473     if (poc_lsb < prev_poc_lsb && prev_poc_lsb - poc_lsb >= max_poc_lsb / 2)
474         poc_msb = prev_poc_msb + max_poc_lsb;
475     else if (poc_lsb > prev_poc_lsb && poc_lsb - prev_poc_lsb > max_poc_lsb / 2)
476         poc_msb = prev_poc_msb - max_poc_lsb;
477     else
478         poc_msb = prev_poc_msb;
479
480     // For BLA picture types, POCmsb is set to 0.
481     if (s->nal_unit_type == HEVC_NAL_BLA_W_LP   ||
482         s->nal_unit_type == HEVC_NAL_BLA_W_RADL ||
483         s->nal_unit_type == HEVC_NAL_BLA_N_LP)
484         poc_msb = 0;
485
486     return poc_msb + poc_lsb;
487 }
488
489 int ff_hevc_frame_nb_refs(HEVCContext *s)
490 {
491     int ret = 0;
492     int i;
493     const ShortTermRPS *rps = s->sh.short_term_rps;
494     LongTermRPS *long_rps   = &s->sh.long_term_rps;
495
496     if (rps) {
497         for (i = 0; i < rps->num_negative_pics; i++)
498             ret += !!rps->used[i];
499         for (; i < rps->num_delta_pocs; i++)
500             ret += !!rps->used[i];
501     }
502
503     if (long_rps) {
504         for (i = 0; i < long_rps->nb_refs; i++)
505             ret += !!long_rps->used[i];
506     }
507     return ret;
508 }