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