c7a02ff40f61685cfcdfead0f66578df0db022fa
[ffmpeg.git] / libavcodec / nvdec.c
1 /*
2  * HW decode acceleration through NVDEC
3  *
4  * Copyright (c) 2016 Anton Khirnov
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #include "config.h"
24
25 #include "libavutil/common.h"
26 #include "libavutil/error.h"
27 #include "libavutil/hwcontext.h"
28 #include "libavutil/hwcontext_cuda_internal.h"
29 #include "libavutil/pixdesc.h"
30 #include "libavutil/pixfmt.h"
31
32 #include "avcodec.h"
33 #include "decode.h"
34 #include "nvdec.h"
35 #include "internal.h"
36
37 typedef struct NVDECDecoder {
38     CUvideodecoder decoder;
39
40     AVBufferRef *hw_device_ref;
41     CUcontext    cuda_ctx;
42
43     CudaFunctions *cudl;
44     CuvidFunctions *cvdl;
45 } NVDECDecoder;
46
47 typedef struct NVDECFramePool {
48     unsigned int dpb_size;
49     unsigned int nb_allocated;
50 } NVDECFramePool;
51
52 static int map_avcodec_id(enum AVCodecID id)
53 {
54     switch (id) {
55     case AV_CODEC_ID_H264:       return cudaVideoCodec_H264;
56     case AV_CODEC_ID_HEVC:       return cudaVideoCodec_HEVC;
57     case AV_CODEC_ID_MPEG1VIDEO: return cudaVideoCodec_MPEG1;
58     case AV_CODEC_ID_MPEG2VIDEO: return cudaVideoCodec_MPEG2;
59     case AV_CODEC_ID_MPEG4:      return cudaVideoCodec_MPEG4;
60     case AV_CODEC_ID_VC1:        return cudaVideoCodec_VC1;
61     case AV_CODEC_ID_VP8:        return cudaVideoCodec_VP8;
62     case AV_CODEC_ID_VP9:        return cudaVideoCodec_VP9;
63     case AV_CODEC_ID_WMV3:       return cudaVideoCodec_VC1;
64     }
65     return -1;
66 }
67
68 static int map_chroma_format(enum AVPixelFormat pix_fmt)
69 {
70     int shift_h = 0, shift_v = 0;
71
72     av_pix_fmt_get_chroma_sub_sample(pix_fmt, &shift_h, &shift_v);
73
74     if (shift_h == 1 && shift_v == 1)
75         return cudaVideoChromaFormat_420;
76     else if (shift_h == 1 && shift_v == 0)
77         return cudaVideoChromaFormat_422;
78     else if (shift_h == 0 && shift_v == 0)
79         return cudaVideoChromaFormat_444;
80
81     return -1;
82 }
83
84 static int nvdec_test_capabilities(NVDECDecoder *decoder,
85                                    CUVIDDECODECREATEINFO *params, void *logctx)
86 {
87     CUresult err;
88     CUVIDDECODECAPS caps = { 0 };
89
90     caps.eCodecType      = params->CodecType;
91     caps.eChromaFormat   = params->ChromaFormat;
92     caps.nBitDepthMinus8 = params->bitDepthMinus8;
93
94     err = decoder->cvdl->cuvidGetDecoderCaps(&caps);
95     if (err != CUDA_SUCCESS) {
96         av_log(logctx, AV_LOG_ERROR, "Failed querying decoder capabilities\n");
97         return AVERROR_UNKNOWN;
98     }
99
100     av_log(logctx, AV_LOG_VERBOSE, "NVDEC capabilities:\n");
101     av_log(logctx, AV_LOG_VERBOSE, "format supported: %s, max_mb_count: %d\n",
102            caps.bIsSupported ? "yes" : "no", caps.nMaxMBCount);
103     av_log(logctx, AV_LOG_VERBOSE, "min_width: %d, max_width: %d\n",
104            caps.nMinWidth, caps.nMaxWidth);
105     av_log(logctx, AV_LOG_VERBOSE, "min_height: %d, max_height: %d\n",
106            caps.nMinHeight, caps.nMaxHeight);
107
108     if (!caps.bIsSupported) {
109         av_log(logctx, AV_LOG_ERROR, "Hardware is lacking required capabilities\n");
110         return AVERROR(EINVAL);
111     }
112
113     if (params->ulWidth > caps.nMaxWidth || params->ulWidth < caps.nMinWidth) {
114         av_log(logctx, AV_LOG_ERROR, "Video width %d not within range from %d to %d\n",
115                (int)params->ulWidth, caps.nMinWidth, caps.nMaxWidth);
116         return AVERROR(EINVAL);
117     }
118
119     if (params->ulHeight > caps.nMaxHeight || params->ulHeight < caps.nMinHeight) {
120         av_log(logctx, AV_LOG_ERROR, "Video height %d not within range from %d to %d\n",
121                (int)params->ulHeight, caps.nMinHeight, caps.nMaxHeight);
122         return AVERROR(EINVAL);
123     }
124
125     if ((params->ulWidth * params->ulHeight) / 256 > caps.nMaxMBCount) {
126         av_log(logctx, AV_LOG_ERROR, "Video macroblock count %d exceeds maximum of %d\n",
127                (int)(params->ulWidth * params->ulHeight) / 256, caps.nMaxMBCount);
128         return AVERROR(EINVAL);
129     }
130
131     return 0;
132 }
133
134 static void nvdec_decoder_free(void *opaque, uint8_t *data)
135 {
136     NVDECDecoder *decoder = (NVDECDecoder*)data;
137
138     if (decoder->decoder)
139         decoder->cvdl->cuvidDestroyDecoder(decoder->decoder);
140
141     av_buffer_unref(&decoder->hw_device_ref);
142
143     cuvid_free_functions(&decoder->cvdl);
144
145     av_freep(&decoder);
146 }
147
148 static int nvdec_decoder_create(AVBufferRef **out, AVBufferRef *hw_device_ref,
149                                 CUVIDDECODECREATEINFO *params, void *logctx)
150 {
151     AVHWDeviceContext  *hw_device_ctx = (AVHWDeviceContext*)hw_device_ref->data;
152     AVCUDADeviceContext *device_hwctx = hw_device_ctx->hwctx;
153
154     AVBufferRef *decoder_ref;
155     NVDECDecoder *decoder;
156
157     CUcontext dummy;
158     CUresult err;
159     int ret;
160
161     decoder = av_mallocz(sizeof(*decoder));
162     if (!decoder)
163         return AVERROR(ENOMEM);
164
165     decoder_ref = av_buffer_create((uint8_t*)decoder, sizeof(*decoder),
166                                    nvdec_decoder_free, NULL, AV_BUFFER_FLAG_READONLY);
167     if (!decoder_ref) {
168         av_freep(&decoder);
169         return AVERROR(ENOMEM);
170     }
171
172     decoder->hw_device_ref = av_buffer_ref(hw_device_ref);
173     if (!decoder->hw_device_ref) {
174         ret = AVERROR(ENOMEM);
175         goto fail;
176     }
177     decoder->cuda_ctx = device_hwctx->cuda_ctx;
178     decoder->cudl = device_hwctx->internal->cuda_dl;
179
180     ret = cuvid_load_functions(&decoder->cvdl, logctx);
181     if (ret < 0) {
182         av_log(logctx, AV_LOG_ERROR, "Failed loading nvcuvid.\n");
183         goto fail;
184     }
185
186     err = decoder->cudl->cuCtxPushCurrent(decoder->cuda_ctx);
187     if (err != CUDA_SUCCESS) {
188         ret = AVERROR_UNKNOWN;
189         goto fail;
190     }
191
192     ret = nvdec_test_capabilities(decoder, params, logctx);
193     if (ret < 0) {
194         decoder->cudl->cuCtxPopCurrent(&dummy);
195         goto fail;
196     }
197
198     err = decoder->cvdl->cuvidCreateDecoder(&decoder->decoder, params);
199
200     decoder->cudl->cuCtxPopCurrent(&dummy);
201
202     if (err != CUDA_SUCCESS) {
203         av_log(logctx, AV_LOG_ERROR, "Error creating a NVDEC decoder: %d\n", err);
204         ret = AVERROR_UNKNOWN;
205         goto fail;
206     }
207
208     *out = decoder_ref;
209
210     return 0;
211 fail:
212     av_buffer_unref(&decoder_ref);
213     return ret;
214 }
215
216 static AVBufferRef *nvdec_decoder_frame_alloc(void *opaque, int size)
217 {
218     NVDECFramePool *pool = opaque;
219     AVBufferRef *ret;
220
221     if (pool->nb_allocated >= pool->dpb_size)
222         return NULL;
223
224     ret = av_buffer_alloc(sizeof(unsigned int));
225     if (!ret)
226         return NULL;
227
228     *(unsigned int*)ret->data = pool->nb_allocated++;
229
230     return ret;
231 }
232
233 int ff_nvdec_decode_uninit(AVCodecContext *avctx)
234 {
235     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
236
237     av_freep(&ctx->bitstream);
238     ctx->bitstream_len       = 0;
239     ctx->bitstream_allocated = 0;
240
241     av_freep(&ctx->slice_offsets);
242     ctx->nb_slices               = 0;
243     ctx->slice_offsets_allocated = 0;
244
245     av_buffer_unref(&ctx->decoder_ref);
246     av_buffer_pool_uninit(&ctx->decoder_pool);
247
248     return 0;
249 }
250
251 int ff_nvdec_decode_init(AVCodecContext *avctx)
252 {
253     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
254
255     NVDECFramePool      *pool;
256     AVHWFramesContext   *frames_ctx;
257     const AVPixFmtDescriptor *sw_desc;
258
259     CUVIDDECODECREATEINFO params = { 0 };
260
261     int cuvid_codec_type, cuvid_chroma_format;
262     int ret = 0;
263
264     sw_desc = av_pix_fmt_desc_get(avctx->sw_pix_fmt);
265     if (!sw_desc)
266         return AVERROR_BUG;
267
268     cuvid_codec_type = map_avcodec_id(avctx->codec_id);
269     if (cuvid_codec_type < 0) {
270         av_log(avctx, AV_LOG_ERROR, "Unsupported codec ID\n");
271         return AVERROR_BUG;
272     }
273
274     cuvid_chroma_format = map_chroma_format(avctx->sw_pix_fmt);
275     if (cuvid_chroma_format < 0) {
276         av_log(avctx, AV_LOG_ERROR, "Unsupported chroma format\n");
277         return AVERROR(ENOSYS);
278     }
279
280     if (!avctx->hw_frames_ctx) {
281         ret = ff_decode_get_hw_frames_ctx(avctx, AV_HWDEVICE_TYPE_CUDA);
282         if (ret < 0)
283             return ret;
284     }
285
286     frames_ctx = (AVHWFramesContext*)avctx->hw_frames_ctx->data;
287
288     params.ulWidth             = avctx->coded_width;
289     params.ulHeight            = avctx->coded_height;
290     params.ulTargetWidth       = avctx->coded_width;
291     params.ulTargetHeight      = avctx->coded_height;
292     params.bitDepthMinus8      = sw_desc->comp[0].depth - 8;
293     params.OutputFormat        = params.bitDepthMinus8 ?
294                                  cudaVideoSurfaceFormat_P016 : cudaVideoSurfaceFormat_NV12;
295     params.CodecType           = cuvid_codec_type;
296     params.ChromaFormat        = cuvid_chroma_format;
297     params.ulNumDecodeSurfaces = frames_ctx->initial_pool_size;
298     params.ulNumOutputSurfaces = 1;
299
300     ret = nvdec_decoder_create(&ctx->decoder_ref, frames_ctx->device_ref, &params, avctx);
301     if (ret < 0) {
302         if (params.ulNumDecodeSurfaces > 32) {
303             av_log(avctx, AV_LOG_WARNING, "Using more than 32 (%d) decode surfaces might cause nvdec to fail.\n",
304                    (int)params.ulNumDecodeSurfaces);
305             av_log(avctx, AV_LOG_WARNING, "Try lowering the amount of threads. Using %d right now.\n",
306                    avctx->thread_count);
307         }
308         return ret;
309     }
310
311     pool = av_mallocz(sizeof(*pool));
312     if (!pool) {
313         ret = AVERROR(ENOMEM);
314         goto fail;
315     }
316     pool->dpb_size = frames_ctx->initial_pool_size;
317
318     ctx->decoder_pool = av_buffer_pool_init2(sizeof(int), pool,
319                                              nvdec_decoder_frame_alloc, av_free);
320     if (!ctx->decoder_pool) {
321         ret = AVERROR(ENOMEM);
322         goto fail;
323     }
324
325     return 0;
326 fail:
327     ff_nvdec_decode_uninit(avctx);
328     return ret;
329 }
330
331 static void nvdec_fdd_priv_free(void *priv)
332 {
333     NVDECFrame *cf = priv;
334
335     if (!cf)
336         return;
337
338     av_buffer_unref(&cf->idx_ref);
339     av_buffer_unref(&cf->decoder_ref);
340
341     av_freep(&priv);
342 }
343
344 static int nvdec_retrieve_data(void *logctx, AVFrame *frame)
345 {
346     FrameDecodeData  *fdd = (FrameDecodeData*)frame->private_ref->data;
347     NVDECFrame        *cf = (NVDECFrame*)fdd->hwaccel_priv;
348     NVDECDecoder *decoder = (NVDECDecoder*)cf->decoder_ref->data;
349
350     CUVIDPROCPARAMS vpp = { .progressive_frame = 1 };
351
352     CUresult err;
353     CUcontext dummy;
354     CUdeviceptr devptr;
355
356     unsigned int pitch, i;
357     unsigned int offset = 0;
358     int ret = 0;
359
360     err = decoder->cudl->cuCtxPushCurrent(decoder->cuda_ctx);
361     if (err != CUDA_SUCCESS)
362         return AVERROR_UNKNOWN;
363
364     err = decoder->cvdl->cuvidMapVideoFrame(decoder->decoder, cf->idx, &devptr,
365                                             &pitch, &vpp);
366     if (err != CUDA_SUCCESS) {
367         av_log(logctx, AV_LOG_ERROR, "Error mapping a picture with CUVID: %d\n",
368                err);
369         ret = AVERROR_UNKNOWN;
370         goto finish;
371     }
372
373     for (i = 0; frame->data[i]; i++) {
374         CUDA_MEMCPY2D cpy = {
375             .srcMemoryType = CU_MEMORYTYPE_DEVICE,
376             .dstMemoryType = CU_MEMORYTYPE_DEVICE,
377             .srcDevice     = devptr,
378             .dstDevice     = (CUdeviceptr)frame->data[i],
379             .srcPitch      = pitch,
380             .dstPitch      = frame->linesize[i],
381             .srcY          = offset,
382             .WidthInBytes  = FFMIN(pitch, frame->linesize[i]),
383             .Height        = frame->height >> (i ? 1 : 0),
384         };
385
386         err = decoder->cudl->cuMemcpy2D(&cpy);
387         if (err != CUDA_SUCCESS) {
388             av_log(logctx, AV_LOG_ERROR, "Error copying decoded frame: %d\n",
389                    err);
390             ret = AVERROR_UNKNOWN;
391             goto copy_fail;
392         }
393
394         offset += cpy.Height;
395     }
396
397 copy_fail:
398     decoder->cvdl->cuvidUnmapVideoFrame(decoder->decoder, devptr);
399
400 finish:
401     decoder->cudl->cuCtxPopCurrent(&dummy);
402     return ret;
403 }
404
405 int ff_nvdec_start_frame(AVCodecContext *avctx, AVFrame *frame)
406 {
407     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
408     FrameDecodeData *fdd = (FrameDecodeData*)frame->private_ref->data;
409     NVDECFrame *cf = NULL;
410     int ret;
411
412     ctx->bitstream_len = 0;
413     ctx->nb_slices     = 0;
414
415     if (fdd->hwaccel_priv)
416         return 0;
417
418     cf = av_mallocz(sizeof(*cf));
419     if (!cf)
420         return AVERROR(ENOMEM);
421
422     cf->decoder_ref = av_buffer_ref(ctx->decoder_ref);
423     if (!cf->decoder_ref) {
424         ret = AVERROR(ENOMEM);
425         goto fail;
426     }
427
428     cf->idx_ref = av_buffer_pool_get(ctx->decoder_pool);
429     if (!cf->idx_ref) {
430         av_log(avctx, AV_LOG_ERROR, "No decoder surfaces left\n");
431         ret = AVERROR(ENOMEM);
432         goto fail;
433     }
434     cf->idx = *(unsigned int*)cf->idx_ref->data;
435
436     fdd->hwaccel_priv      = cf;
437     fdd->hwaccel_priv_free = nvdec_fdd_priv_free;
438     fdd->post_process      = nvdec_retrieve_data;
439
440     return 0;
441 fail:
442     nvdec_fdd_priv_free(cf);
443     return ret;
444
445 }
446
447 int ff_nvdec_end_frame(AVCodecContext *avctx)
448 {
449     NVDECContext     *ctx = avctx->internal->hwaccel_priv_data;
450     NVDECDecoder *decoder = (NVDECDecoder*)ctx->decoder_ref->data;
451     CUVIDPICPARAMS    *pp = &ctx->pic_params;
452
453     CUresult err;
454     CUcontext dummy;
455
456     int ret = 0;
457
458     pp->nBitstreamDataLen = ctx->bitstream_len;
459     pp->pBitstreamData    = ctx->bitstream;
460     pp->nNumSlices        = ctx->nb_slices;
461     pp->pSliceDataOffsets = ctx->slice_offsets;
462
463     err = decoder->cudl->cuCtxPushCurrent(decoder->cuda_ctx);
464     if (err != CUDA_SUCCESS)
465         return AVERROR_UNKNOWN;
466
467     err = decoder->cvdl->cuvidDecodePicture(decoder->decoder, &ctx->pic_params);
468     if (err != CUDA_SUCCESS) {
469         av_log(avctx, AV_LOG_ERROR, "Error decoding a picture with NVDEC: %d\n",
470                err);
471         ret = AVERROR_UNKNOWN;
472         goto finish;
473     }
474
475 finish:
476     decoder->cudl->cuCtxPopCurrent(&dummy);
477
478     return ret;
479 }
480
481 int ff_nvdec_simple_end_frame(AVCodecContext *avctx)
482 {
483     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
484     int ret = ff_nvdec_end_frame(avctx);
485     ctx->bitstream = NULL;
486     return ret;
487 }
488
489 int ff_nvdec_simple_decode_slice(AVCodecContext *avctx, const uint8_t *buffer,
490                                  uint32_t size)
491 {
492     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
493     void *tmp;
494
495     tmp = av_fast_realloc(ctx->slice_offsets, &ctx->slice_offsets_allocated,
496                           (ctx->nb_slices + 1) * sizeof(*ctx->slice_offsets));
497     if (!tmp)
498         return AVERROR(ENOMEM);
499     ctx->slice_offsets = tmp;
500
501     if (!ctx->bitstream)
502         ctx->bitstream = (uint8_t*)buffer;
503
504     ctx->slice_offsets[ctx->nb_slices] = buffer - ctx->bitstream;
505     ctx->bitstream_len += size;
506     ctx->nb_slices++;
507
508     return 0;
509 }
510
511 int ff_nvdec_frame_params(AVCodecContext *avctx,
512                           AVBufferRef *hw_frames_ctx,
513                           int dpb_size)
514 {
515     AVHWFramesContext *frames_ctx = (AVHWFramesContext*)hw_frames_ctx->data;
516     const AVPixFmtDescriptor *sw_desc;
517     int cuvid_codec_type, cuvid_chroma_format;
518
519     sw_desc = av_pix_fmt_desc_get(avctx->sw_pix_fmt);
520     if (!sw_desc)
521         return AVERROR_BUG;
522
523     cuvid_codec_type = map_avcodec_id(avctx->codec_id);
524     if (cuvid_codec_type < 0) {
525         av_log(avctx, AV_LOG_ERROR, "Unsupported codec ID\n");
526         return AVERROR_BUG;
527     }
528
529     cuvid_chroma_format = map_chroma_format(avctx->sw_pix_fmt);
530     if (cuvid_chroma_format < 0) {
531         av_log(avctx, AV_LOG_VERBOSE, "Unsupported chroma format\n");
532         return AVERROR(EINVAL);
533     }
534
535     frames_ctx->format            = AV_PIX_FMT_CUDA;
536     frames_ctx->width             = (avctx->coded_width + 1) & ~1;
537     frames_ctx->height            = (avctx->coded_height + 1) & ~1;
538     frames_ctx->initial_pool_size = dpb_size;
539
540     switch (sw_desc->comp[0].depth) {
541     case 8:
542         frames_ctx->sw_format = AV_PIX_FMT_NV12;
543         break;
544     case 10:
545         frames_ctx->sw_format = AV_PIX_FMT_P010;
546         break;
547     case 12:
548         frames_ctx->sw_format = AV_PIX_FMT_P016;
549         break;
550     default:
551         return AVERROR(EINVAL);
552     }
553
554     return 0;
555 }
556
557 int ff_nvdec_get_ref_idx(AVFrame *frame)
558 {
559     FrameDecodeData *fdd;
560     NVDECFrame *cf;
561
562     if (!frame || !frame->private_ref)
563         return -1;
564
565     fdd = (FrameDecodeData*)frame->private_ref->data;
566     cf  = (NVDECFrame*)fdd->hwaccel_priv;
567     if (!cf)
568         return -1;
569
570     return cf->idx;
571 }