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