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