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