e9e6ea0f8b9d03c8bdde9aa376a329ae491e6003
[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     if (!decoder->cvdl->cuvidGetDecoderCaps) {
95         av_log(logctx, AV_LOG_WARNING, "Used Nvidia driver is too old to perform a capability check.\n");
96         av_log(logctx, AV_LOG_WARNING, "The minimum required version is "
97 #if defined(_WIN32) || defined(__CYGWIN__)
98             "378.66"
99 #else
100             "378.13"
101 #endif
102             ". Continuing blind.\n");
103         return 0;
104     }
105
106     err = decoder->cvdl->cuvidGetDecoderCaps(&caps);
107     if (err != CUDA_SUCCESS) {
108         av_log(logctx, AV_LOG_ERROR, "Failed querying decoder capabilities\n");
109         return AVERROR_UNKNOWN;
110     }
111
112     av_log(logctx, AV_LOG_VERBOSE, "NVDEC capabilities:\n");
113     av_log(logctx, AV_LOG_VERBOSE, "format supported: %s, max_mb_count: %d\n",
114            caps.bIsSupported ? "yes" : "no", caps.nMaxMBCount);
115     av_log(logctx, AV_LOG_VERBOSE, "min_width: %d, max_width: %d\n",
116            caps.nMinWidth, caps.nMaxWidth);
117     av_log(logctx, AV_LOG_VERBOSE, "min_height: %d, max_height: %d\n",
118            caps.nMinHeight, caps.nMaxHeight);
119
120     if (!caps.bIsSupported) {
121         av_log(logctx, AV_LOG_ERROR, "Hardware is lacking required capabilities\n");
122         return AVERROR(EINVAL);
123     }
124
125     if (params->ulWidth > caps.nMaxWidth || params->ulWidth < caps.nMinWidth) {
126         av_log(logctx, AV_LOG_ERROR, "Video width %d not within range from %d to %d\n",
127                (int)params->ulWidth, caps.nMinWidth, caps.nMaxWidth);
128         return AVERROR(EINVAL);
129     }
130
131     if (params->ulHeight > caps.nMaxHeight || params->ulHeight < caps.nMinHeight) {
132         av_log(logctx, AV_LOG_ERROR, "Video height %d not within range from %d to %d\n",
133                (int)params->ulHeight, caps.nMinHeight, caps.nMaxHeight);
134         return AVERROR(EINVAL);
135     }
136
137     if ((params->ulWidth * params->ulHeight) / 256 > caps.nMaxMBCount) {
138         av_log(logctx, AV_LOG_ERROR, "Video macroblock count %d exceeds maximum of %d\n",
139                (int)(params->ulWidth * params->ulHeight) / 256, caps.nMaxMBCount);
140         return AVERROR(EINVAL);
141     }
142
143     return 0;
144 }
145
146 static void nvdec_decoder_free(void *opaque, uint8_t *data)
147 {
148     NVDECDecoder *decoder = (NVDECDecoder*)data;
149
150     if (decoder->decoder)
151         decoder->cvdl->cuvidDestroyDecoder(decoder->decoder);
152
153     av_buffer_unref(&decoder->hw_device_ref);
154
155     cuvid_free_functions(&decoder->cvdl);
156
157     av_freep(&decoder);
158 }
159
160 static int nvdec_decoder_create(AVBufferRef **out, AVBufferRef *hw_device_ref,
161                                 CUVIDDECODECREATEINFO *params, void *logctx)
162 {
163     AVHWDeviceContext  *hw_device_ctx = (AVHWDeviceContext*)hw_device_ref->data;
164     AVCUDADeviceContext *device_hwctx = hw_device_ctx->hwctx;
165
166     AVBufferRef *decoder_ref;
167     NVDECDecoder *decoder;
168
169     CUcontext dummy;
170     CUresult err;
171     int ret;
172
173     decoder = av_mallocz(sizeof(*decoder));
174     if (!decoder)
175         return AVERROR(ENOMEM);
176
177     decoder_ref = av_buffer_create((uint8_t*)decoder, sizeof(*decoder),
178                                    nvdec_decoder_free, NULL, AV_BUFFER_FLAG_READONLY);
179     if (!decoder_ref) {
180         av_freep(&decoder);
181         return AVERROR(ENOMEM);
182     }
183
184     decoder->hw_device_ref = av_buffer_ref(hw_device_ref);
185     if (!decoder->hw_device_ref) {
186         ret = AVERROR(ENOMEM);
187         goto fail;
188     }
189     decoder->cuda_ctx = device_hwctx->cuda_ctx;
190     decoder->cudl = device_hwctx->internal->cuda_dl;
191
192     ret = cuvid_load_functions(&decoder->cvdl, logctx);
193     if (ret < 0) {
194         av_log(logctx, AV_LOG_ERROR, "Failed loading nvcuvid.\n");
195         goto fail;
196     }
197
198     err = decoder->cudl->cuCtxPushCurrent(decoder->cuda_ctx);
199     if (err != CUDA_SUCCESS) {
200         ret = AVERROR_UNKNOWN;
201         goto fail;
202     }
203
204     ret = nvdec_test_capabilities(decoder, params, logctx);
205     if (ret < 0) {
206         decoder->cudl->cuCtxPopCurrent(&dummy);
207         goto fail;
208     }
209
210     err = decoder->cvdl->cuvidCreateDecoder(&decoder->decoder, params);
211
212     decoder->cudl->cuCtxPopCurrent(&dummy);
213
214     if (err != CUDA_SUCCESS) {
215         av_log(logctx, AV_LOG_ERROR, "Error creating a NVDEC decoder: %d\n", err);
216         ret = AVERROR_UNKNOWN;
217         goto fail;
218     }
219
220     *out = decoder_ref;
221
222     return 0;
223 fail:
224     av_buffer_unref(&decoder_ref);
225     return ret;
226 }
227
228 static AVBufferRef *nvdec_decoder_frame_alloc(void *opaque, int size)
229 {
230     NVDECFramePool *pool = opaque;
231     AVBufferRef *ret;
232
233     if (pool->nb_allocated >= pool->dpb_size)
234         return NULL;
235
236     ret = av_buffer_alloc(sizeof(unsigned int));
237     if (!ret)
238         return NULL;
239
240     *(unsigned int*)ret->data = pool->nb_allocated++;
241
242     return ret;
243 }
244
245 int ff_nvdec_decode_uninit(AVCodecContext *avctx)
246 {
247     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
248
249     av_freep(&ctx->bitstream);
250     ctx->bitstream_len       = 0;
251     ctx->bitstream_allocated = 0;
252
253     av_freep(&ctx->slice_offsets);
254     ctx->nb_slices               = 0;
255     ctx->slice_offsets_allocated = 0;
256
257     av_buffer_unref(&ctx->decoder_ref);
258     av_buffer_pool_uninit(&ctx->decoder_pool);
259
260     return 0;
261 }
262
263 int ff_nvdec_decode_init(AVCodecContext *avctx)
264 {
265     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
266
267     NVDECFramePool      *pool;
268     AVHWFramesContext   *frames_ctx;
269     const AVPixFmtDescriptor *sw_desc;
270
271     CUVIDDECODECREATEINFO params = { 0 };
272
273     int cuvid_codec_type, cuvid_chroma_format;
274     int ret = 0;
275
276     sw_desc = av_pix_fmt_desc_get(avctx->sw_pix_fmt);
277     if (!sw_desc)
278         return AVERROR_BUG;
279
280     cuvid_codec_type = map_avcodec_id(avctx->codec_id);
281     if (cuvid_codec_type < 0) {
282         av_log(avctx, AV_LOG_ERROR, "Unsupported codec ID\n");
283         return AVERROR_BUG;
284     }
285
286     cuvid_chroma_format = map_chroma_format(avctx->sw_pix_fmt);
287     if (cuvid_chroma_format < 0) {
288         av_log(avctx, AV_LOG_ERROR, "Unsupported chroma format\n");
289         return AVERROR(ENOSYS);
290     }
291
292     if (!avctx->hw_frames_ctx) {
293         ret = ff_decode_get_hw_frames_ctx(avctx, AV_HWDEVICE_TYPE_CUDA);
294         if (ret < 0)
295             return ret;
296     }
297
298     frames_ctx = (AVHWFramesContext*)avctx->hw_frames_ctx->data;
299
300     params.ulWidth             = avctx->coded_width;
301     params.ulHeight            = avctx->coded_height;
302     params.ulTargetWidth       = avctx->coded_width;
303     params.ulTargetHeight      = avctx->coded_height;
304     params.bitDepthMinus8      = sw_desc->comp[0].depth - 8;
305     params.OutputFormat        = params.bitDepthMinus8 ?
306                                  cudaVideoSurfaceFormat_P016 : cudaVideoSurfaceFormat_NV12;
307     params.CodecType           = cuvid_codec_type;
308     params.ChromaFormat        = cuvid_chroma_format;
309     params.ulNumDecodeSurfaces = frames_ctx->initial_pool_size;
310     params.ulNumOutputSurfaces = 1;
311
312     ret = nvdec_decoder_create(&ctx->decoder_ref, frames_ctx->device_ref, &params, avctx);
313     if (ret < 0) {
314         if (params.ulNumDecodeSurfaces > 32) {
315             av_log(avctx, AV_LOG_WARNING, "Using more than 32 (%d) decode surfaces might cause nvdec to fail.\n",
316                    (int)params.ulNumDecodeSurfaces);
317             av_log(avctx, AV_LOG_WARNING, "Try lowering the amount of threads. Using %d right now.\n",
318                    avctx->thread_count);
319         }
320         return ret;
321     }
322
323     pool = av_mallocz(sizeof(*pool));
324     if (!pool) {
325         ret = AVERROR(ENOMEM);
326         goto fail;
327     }
328     pool->dpb_size = frames_ctx->initial_pool_size;
329
330     ctx->decoder_pool = av_buffer_pool_init2(sizeof(int), pool,
331                                              nvdec_decoder_frame_alloc, av_free);
332     if (!ctx->decoder_pool) {
333         ret = AVERROR(ENOMEM);
334         goto fail;
335     }
336
337     return 0;
338 fail:
339     ff_nvdec_decode_uninit(avctx);
340     return ret;
341 }
342
343 static void nvdec_fdd_priv_free(void *priv)
344 {
345     NVDECFrame *cf = priv;
346
347     if (!cf)
348         return;
349
350     av_buffer_unref(&cf->idx_ref);
351     av_buffer_unref(&cf->decoder_ref);
352
353     av_freep(&priv);
354 }
355
356 static int nvdec_retrieve_data(void *logctx, AVFrame *frame)
357 {
358     FrameDecodeData  *fdd = (FrameDecodeData*)frame->private_ref->data;
359     NVDECFrame        *cf = (NVDECFrame*)fdd->hwaccel_priv;
360     NVDECDecoder *decoder = (NVDECDecoder*)cf->decoder_ref->data;
361
362     CUVIDPROCPARAMS vpp = { .progressive_frame = 1 };
363
364     CUresult err;
365     CUcontext dummy;
366     CUdeviceptr devptr;
367
368     unsigned int pitch, i;
369     unsigned int offset = 0;
370     int ret = 0;
371
372     err = decoder->cudl->cuCtxPushCurrent(decoder->cuda_ctx);
373     if (err != CUDA_SUCCESS)
374         return AVERROR_UNKNOWN;
375
376     err = decoder->cvdl->cuvidMapVideoFrame(decoder->decoder, cf->idx, &devptr,
377                                             &pitch, &vpp);
378     if (err != CUDA_SUCCESS) {
379         av_log(logctx, AV_LOG_ERROR, "Error mapping a picture with CUVID: %d\n",
380                err);
381         ret = AVERROR_UNKNOWN;
382         goto finish;
383     }
384
385     for (i = 0; frame->data[i]; i++) {
386         CUDA_MEMCPY2D cpy = {
387             .srcMemoryType = CU_MEMORYTYPE_DEVICE,
388             .dstMemoryType = CU_MEMORYTYPE_DEVICE,
389             .srcDevice     = devptr,
390             .dstDevice     = (CUdeviceptr)frame->data[i],
391             .srcPitch      = pitch,
392             .dstPitch      = frame->linesize[i],
393             .srcY          = offset,
394             .WidthInBytes  = FFMIN(pitch, frame->linesize[i]),
395             .Height        = frame->height >> (i ? 1 : 0),
396         };
397
398         err = decoder->cudl->cuMemcpy2D(&cpy);
399         if (err != CUDA_SUCCESS) {
400             av_log(logctx, AV_LOG_ERROR, "Error copying decoded frame: %d\n",
401                    err);
402             ret = AVERROR_UNKNOWN;
403             goto copy_fail;
404         }
405
406         offset += cpy.Height;
407     }
408
409 copy_fail:
410     decoder->cvdl->cuvidUnmapVideoFrame(decoder->decoder, devptr);
411
412 finish:
413     decoder->cudl->cuCtxPopCurrent(&dummy);
414     return ret;
415 }
416
417 int ff_nvdec_start_frame(AVCodecContext *avctx, AVFrame *frame)
418 {
419     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
420     FrameDecodeData *fdd = (FrameDecodeData*)frame->private_ref->data;
421     NVDECFrame *cf = NULL;
422     int ret;
423
424     ctx->bitstream_len = 0;
425     ctx->nb_slices     = 0;
426
427     if (fdd->hwaccel_priv)
428         return 0;
429
430     cf = av_mallocz(sizeof(*cf));
431     if (!cf)
432         return AVERROR(ENOMEM);
433
434     cf->decoder_ref = av_buffer_ref(ctx->decoder_ref);
435     if (!cf->decoder_ref) {
436         ret = AVERROR(ENOMEM);
437         goto fail;
438     }
439
440     cf->idx_ref = av_buffer_pool_get(ctx->decoder_pool);
441     if (!cf->idx_ref) {
442         av_log(avctx, AV_LOG_ERROR, "No decoder surfaces left\n");
443         ret = AVERROR(ENOMEM);
444         goto fail;
445     }
446     cf->idx = *(unsigned int*)cf->idx_ref->data;
447
448     fdd->hwaccel_priv      = cf;
449     fdd->hwaccel_priv_free = nvdec_fdd_priv_free;
450     fdd->post_process      = nvdec_retrieve_data;
451
452     return 0;
453 fail:
454     nvdec_fdd_priv_free(cf);
455     return ret;
456
457 }
458
459 int ff_nvdec_end_frame(AVCodecContext *avctx)
460 {
461     NVDECContext     *ctx = avctx->internal->hwaccel_priv_data;
462     NVDECDecoder *decoder = (NVDECDecoder*)ctx->decoder_ref->data;
463     CUVIDPICPARAMS    *pp = &ctx->pic_params;
464
465     CUresult err;
466     CUcontext dummy;
467
468     int ret = 0;
469
470     pp->nBitstreamDataLen = ctx->bitstream_len;
471     pp->pBitstreamData    = ctx->bitstream;
472     pp->nNumSlices        = ctx->nb_slices;
473     pp->pSliceDataOffsets = ctx->slice_offsets;
474
475     err = decoder->cudl->cuCtxPushCurrent(decoder->cuda_ctx);
476     if (err != CUDA_SUCCESS)
477         return AVERROR_UNKNOWN;
478
479     err = decoder->cvdl->cuvidDecodePicture(decoder->decoder, &ctx->pic_params);
480     if (err != CUDA_SUCCESS) {
481         av_log(avctx, AV_LOG_ERROR, "Error decoding a picture with NVDEC: %d\n",
482                err);
483         ret = AVERROR_UNKNOWN;
484         goto finish;
485     }
486
487 finish:
488     decoder->cudl->cuCtxPopCurrent(&dummy);
489
490     return ret;
491 }
492
493 int ff_nvdec_simple_end_frame(AVCodecContext *avctx)
494 {
495     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
496     int ret = ff_nvdec_end_frame(avctx);
497     ctx->bitstream = NULL;
498     return ret;
499 }
500
501 int ff_nvdec_simple_decode_slice(AVCodecContext *avctx, const uint8_t *buffer,
502                                  uint32_t size)
503 {
504     NVDECContext *ctx = avctx->internal->hwaccel_priv_data;
505     void *tmp;
506
507     tmp = av_fast_realloc(ctx->slice_offsets, &ctx->slice_offsets_allocated,
508                           (ctx->nb_slices + 1) * sizeof(*ctx->slice_offsets));
509     if (!tmp)
510         return AVERROR(ENOMEM);
511     ctx->slice_offsets = tmp;
512
513     if (!ctx->bitstream)
514         ctx->bitstream = (uint8_t*)buffer;
515
516     ctx->slice_offsets[ctx->nb_slices] = buffer - ctx->bitstream;
517     ctx->bitstream_len += size;
518     ctx->nb_slices++;
519
520     return 0;
521 }
522
523 int ff_nvdec_frame_params(AVCodecContext *avctx,
524                           AVBufferRef *hw_frames_ctx,
525                           int dpb_size)
526 {
527     AVHWFramesContext *frames_ctx = (AVHWFramesContext*)hw_frames_ctx->data;
528     const AVPixFmtDescriptor *sw_desc;
529     int cuvid_codec_type, cuvid_chroma_format;
530
531     sw_desc = av_pix_fmt_desc_get(avctx->sw_pix_fmt);
532     if (!sw_desc)
533         return AVERROR_BUG;
534
535     cuvid_codec_type = map_avcodec_id(avctx->codec_id);
536     if (cuvid_codec_type < 0) {
537         av_log(avctx, AV_LOG_ERROR, "Unsupported codec ID\n");
538         return AVERROR_BUG;
539     }
540
541     cuvid_chroma_format = map_chroma_format(avctx->sw_pix_fmt);
542     if (cuvid_chroma_format < 0) {
543         av_log(avctx, AV_LOG_VERBOSE, "Unsupported chroma format\n");
544         return AVERROR(EINVAL);
545     }
546
547     frames_ctx->format            = AV_PIX_FMT_CUDA;
548     frames_ctx->width             = (avctx->coded_width + 1) & ~1;
549     frames_ctx->height            = (avctx->coded_height + 1) & ~1;
550     frames_ctx->initial_pool_size = dpb_size;
551
552     switch (sw_desc->comp[0].depth) {
553     case 8:
554         frames_ctx->sw_format = AV_PIX_FMT_NV12;
555         break;
556     case 10:
557         frames_ctx->sw_format = AV_PIX_FMT_P010;
558         break;
559     case 12:
560         frames_ctx->sw_format = AV_PIX_FMT_P016;
561         break;
562     default:
563         return AVERROR(EINVAL);
564     }
565
566     return 0;
567 }
568
569 int ff_nvdec_get_ref_idx(AVFrame *frame)
570 {
571     FrameDecodeData *fdd;
572     NVDECFrame *cf;
573
574     if (!frame || !frame->private_ref)
575         return -1;
576
577     fdd = (FrameDecodeData*)frame->private_ref->data;
578     cf  = (NVDECFrame*)fdd->hwaccel_priv;
579     if (!cf)
580         return -1;
581
582     return cf->idx;
583 }