2 * H.264 hardware encoding using nvidia nvenc
3 * Copyright (c) 2014 Timo Rothenpieler <timo@rothenpieler.org>
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <nvEncodeAPI.h>
30 #include "libavutil/internal.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/avassert.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/mem.h"
40 #define CUDAAPI __stdcall
46 #define LOAD_FUNC(l, s) GetProcAddress(l, s)
47 #define DL_CLOSE_FUNC(l) FreeLibrary(l)
49 #define LOAD_FUNC(l, s) dlsym(l, s)
50 #define DL_CLOSE_FUNC(l) dlclose(l)
53 typedef enum cudaError_enum {
57 typedef void* CUcontext;
59 typedef CUresult(CUDAAPI *PCUINIT)(unsigned int Flags);
60 typedef CUresult(CUDAAPI *PCUDEVICEGETCOUNT)(int *count);
61 typedef CUresult(CUDAAPI *PCUDEVICEGET)(CUdevice *device, int ordinal);
62 typedef CUresult(CUDAAPI *PCUDEVICEGETNAME)(char *name, int len, CUdevice dev);
63 typedef CUresult(CUDAAPI *PCUDEVICECOMPUTECAPABILITY)(int *major, int *minor, CUdevice dev);
64 typedef CUresult(CUDAAPI *PCUCTXCREATE)(CUcontext *pctx, unsigned int flags, CUdevice dev);
65 typedef CUresult(CUDAAPI *PCUCTXPOPCURRENT)(CUcontext *pctx);
66 typedef CUresult(CUDAAPI *PCUCTXDESTROY)(CUcontext ctx);
68 typedef NVENCSTATUS (NVENCAPI* PNVENCODEAPICREATEINSTANCE)(NV_ENCODE_API_FUNCTION_LIST *functionList);
70 #if NVENCAPI_MAJOR_VERSION < 5
71 static const GUID dummy_license = { 0x0, 0x0, 0x0, { 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } };
74 typedef struct NvencInputSurface
76 NV_ENC_INPUT_PTR input_surface;
82 NV_ENC_BUFFER_FORMAT format;
85 typedef struct NvencOutputSurface
87 NV_ENC_OUTPUT_PTR output_surface;
90 NvencInputSurface* input_surface;
95 typedef struct NvencData
99 NvencOutputSurface *surface;
103 typedef struct NvencDataList
112 typedef struct NvencDynLoadFunctions
115 PCUDEVICEGETCOUNT cu_device_get_count;
116 PCUDEVICEGET cu_device_get;
117 PCUDEVICEGETNAME cu_device_get_name;
118 PCUDEVICECOMPUTECAPABILITY cu_device_compute_capability;
119 PCUCTXCREATE cu_ctx_create;
120 PCUCTXPOPCURRENT cu_ctx_pop_current;
121 PCUCTXDESTROY cu_ctx_destroy;
123 NV_ENCODE_API_FUNCTION_LIST nvenc_funcs;
124 int nvenc_device_count;
125 CUdevice nvenc_devices[16];
134 } NvencDynLoadFunctions;
136 typedef struct NvencContext
140 NvencDynLoadFunctions nvenc_dload_funcs;
142 NV_ENC_INITIALIZE_PARAMS init_encode_params;
143 NV_ENC_CONFIG encode_config;
144 CUcontext cu_context;
146 int max_surface_count;
147 NvencInputSurface *input_surfaces;
148 NvencOutputSurface *output_surfaces;
150 NvencDataList output_surface_queue;
151 NvencDataList output_surface_ready_queue;
152 NvencDataList timestamp_list;
163 static NvencData* data_queue_dequeue(NvencDataList* queue)
169 av_assert0(queue->size);
170 av_assert0(queue->data);
175 /* Size always is a multiple of two */
176 mask = queue->size - 1;
177 read_pos = (queue->pos - queue->count) & mask;
180 return &queue->data[read_pos];
183 static int data_queue_enqueue(NvencDataList* queue, NvencData *data)
185 NvencDataList new_queue;
190 /* size always has to be a multiple of two */
195 queue->data = av_malloc(queue->size * sizeof(*(queue->data)));
199 return AVERROR(ENOMEM);
203 if (queue->count == queue->size) {
204 new_queue.size = queue->size << 1;
207 new_queue.data = av_malloc(new_queue.size * sizeof(*(queue->data)));
210 return AVERROR(ENOMEM);
212 while (tmp_data = data_queue_dequeue(queue))
213 data_queue_enqueue(&new_queue, tmp_data);
215 av_free(queue->data);
219 mask = queue->size - 1;
221 queue->data[queue->pos] = *data;
222 queue->pos = (queue->pos + 1) & mask;
228 static int out_surf_queue_enqueue(NvencDataList* queue, NvencOutputSurface* surface)
231 data.surface = surface;
233 return data_queue_enqueue(queue, &data);
236 static NvencOutputSurface* out_surf_queue_dequeue(NvencDataList* queue)
238 NvencData* res = data_queue_dequeue(queue);
246 static int timestamp_queue_enqueue(NvencDataList* queue, int64_t timestamp)
249 data.timestamp = timestamp;
251 return data_queue_enqueue(queue, &data);
254 static int64_t timestamp_queue_dequeue(NvencDataList* queue)
256 NvencData* res = data_queue_dequeue(queue);
259 return AV_NOPTS_VALUE;
261 return res->timestamp;
264 #define CHECK_LOAD_FUNC(t, f, s) \
266 (f) = (t)LOAD_FUNC(dl_fn->cuda_lib, s); \
268 av_log(avctx, AV_LOG_FATAL, "Failed loading %s from CUDA library\n", s); \
273 static av_cold int nvenc_dyload_cuda(AVCodecContext *avctx)
275 NvencContext *ctx = avctx->priv_data;
276 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
282 dl_fn->cuda_lib = LoadLibrary(TEXT("nvcuda.dll"));
284 dl_fn->cuda_lib = dlopen("libcuda.so", RTLD_LAZY);
287 if (!dl_fn->cuda_lib) {
288 av_log(avctx, AV_LOG_FATAL, "Failed loading CUDA library\n");
292 CHECK_LOAD_FUNC(PCUINIT, dl_fn->cu_init, "cuInit");
293 CHECK_LOAD_FUNC(PCUDEVICEGETCOUNT, dl_fn->cu_device_get_count, "cuDeviceGetCount");
294 CHECK_LOAD_FUNC(PCUDEVICEGET, dl_fn->cu_device_get, "cuDeviceGet");
295 CHECK_LOAD_FUNC(PCUDEVICEGETNAME, dl_fn->cu_device_get_name, "cuDeviceGetName");
296 CHECK_LOAD_FUNC(PCUDEVICECOMPUTECAPABILITY, dl_fn->cu_device_compute_capability, "cuDeviceComputeCapability");
297 CHECK_LOAD_FUNC(PCUCTXCREATE, dl_fn->cu_ctx_create, "cuCtxCreate_v2");
298 CHECK_LOAD_FUNC(PCUCTXPOPCURRENT, dl_fn->cu_ctx_pop_current, "cuCtxPopCurrent_v2");
299 CHECK_LOAD_FUNC(PCUCTXDESTROY, dl_fn->cu_ctx_destroy, "cuCtxDestroy_v2");
306 DL_CLOSE_FUNC(dl_fn->cuda_lib);
308 dl_fn->cuda_lib = NULL;
313 static av_cold int check_cuda_errors(AVCodecContext *avctx, CUresult err, const char *func)
315 if (err != CUDA_SUCCESS) {
316 av_log(avctx, AV_LOG_FATAL, ">> %s - failed with error code 0x%x\n", func, err);
321 #define check_cuda_errors(f) if (!check_cuda_errors(avctx, f, #f)) goto error
323 static av_cold int nvenc_check_cuda(AVCodecContext *avctx)
325 int device_count = 0;
326 CUdevice cu_device = 0;
328 int smminor = 0, smmajor = 0;
331 NvencContext *ctx = avctx->priv_data;
332 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
334 if (!nvenc_dyload_cuda(avctx))
337 if (dl_fn->nvenc_device_count > 0)
340 check_cuda_errors(dl_fn->cu_init(0));
342 check_cuda_errors(dl_fn->cu_device_get_count(&device_count));
345 av_log(avctx, AV_LOG_FATAL, "No CUDA capable devices found\n");
349 av_log(avctx, AV_LOG_VERBOSE, "%d CUDA capable devices found\n", device_count);
351 dl_fn->nvenc_device_count = 0;
353 for (i = 0; i < device_count; ++i) {
354 check_cuda_errors(dl_fn->cu_device_get(&cu_device, i));
355 check_cuda_errors(dl_fn->cu_device_get_name(gpu_name, sizeof(gpu_name), cu_device));
356 check_cuda_errors(dl_fn->cu_device_compute_capability(&smmajor, &smminor, cu_device));
358 smver = (smmajor << 4) | smminor;
360 av_log(avctx, AV_LOG_VERBOSE, "[ GPU #%d - < %s > has Compute SM %d.%d, NVENC %s ]\n", i, gpu_name, smmajor, smminor, (smver >= 0x30) ? "Available" : "Not Available");
363 dl_fn->nvenc_devices[dl_fn->nvenc_device_count++] = cu_device;
366 if (!dl_fn->nvenc_device_count) {
367 av_log(avctx, AV_LOG_FATAL, "No NVENC capable devices found\n");
375 dl_fn->nvenc_device_count = 0;
380 static av_cold int nvenc_dyload_nvenc(AVCodecContext *avctx)
382 PNVENCODEAPICREATEINSTANCE nvEncodeAPICreateInstance = 0;
383 NVENCSTATUS nvstatus;
385 NvencContext *ctx = avctx->priv_data;
386 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
388 if (!nvenc_check_cuda(avctx))
391 if (dl_fn->nvenc_lib)
395 if (sizeof(void*) == 8) {
396 dl_fn->nvenc_lib = LoadLibrary(TEXT("nvEncodeAPI64.dll"));
398 dl_fn->nvenc_lib = LoadLibrary(TEXT("nvEncodeAPI.dll"));
401 dl_fn->nvenc_lib = dlopen("libnvidia-encode.so.1", RTLD_LAZY);
404 if (!dl_fn->nvenc_lib) {
405 av_log(avctx, AV_LOG_FATAL, "Failed loading the nvenc library\n");
409 nvEncodeAPICreateInstance = (PNVENCODEAPICREATEINSTANCE)LOAD_FUNC(dl_fn->nvenc_lib, "NvEncodeAPICreateInstance");
411 if (!nvEncodeAPICreateInstance) {
412 av_log(avctx, AV_LOG_FATAL, "Failed to load nvenc entrypoint\n");
416 dl_fn->nvenc_funcs.version = NV_ENCODE_API_FUNCTION_LIST_VER;
418 nvstatus = nvEncodeAPICreateInstance(&dl_fn->nvenc_funcs);
420 if (nvstatus != NV_ENC_SUCCESS) {
421 av_log(avctx, AV_LOG_FATAL, "Failed to create nvenc instance\n");
425 av_log(avctx, AV_LOG_VERBOSE, "Nvenc initialized successfully\n");
430 if (dl_fn->nvenc_lib)
431 DL_CLOSE_FUNC(dl_fn->nvenc_lib);
433 dl_fn->nvenc_lib = NULL;
438 static av_cold void nvenc_unload_nvenc(AVCodecContext *avctx)
440 NvencContext *ctx = avctx->priv_data;
441 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
443 DL_CLOSE_FUNC(dl_fn->nvenc_lib);
444 dl_fn->nvenc_lib = NULL;
446 dl_fn->nvenc_device_count = 0;
448 DL_CLOSE_FUNC(dl_fn->cuda_lib);
449 dl_fn->cuda_lib = NULL;
451 dl_fn->cu_init = NULL;
452 dl_fn->cu_device_get_count = NULL;
453 dl_fn->cu_device_get = NULL;
454 dl_fn->cu_device_get_name = NULL;
455 dl_fn->cu_device_compute_capability = NULL;
456 dl_fn->cu_ctx_create = NULL;
457 dl_fn->cu_ctx_pop_current = NULL;
458 dl_fn->cu_ctx_destroy = NULL;
460 av_log(avctx, AV_LOG_VERBOSE, "Nvenc unloaded\n");
463 static av_cold int nvenc_encode_init(AVCodecContext *avctx)
465 NV_ENC_OPEN_ENCODE_SESSION_EX_PARAMS encode_session_params = { 0 };
466 NV_ENC_PRESET_CONFIG preset_config = { 0 };
467 CUcontext cu_context_curr;
469 GUID encoder_preset = NV_ENC_PRESET_HQ_GUID;
470 NVENCSTATUS nv_status = NV_ENC_SUCCESS;
471 int surfaceCount = 0;
476 #if NVENCAPI_MAJOR_VERSION < 5
477 GUID license = dummy_license;
480 NvencContext *ctx = avctx->priv_data;
481 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
482 NV_ENCODE_API_FUNCTION_LIST *p_nvenc = &dl_fn->nvenc_funcs;
484 if (!nvenc_dyload_nvenc(avctx))
485 return AVERROR_EXTERNAL;
487 avctx->coded_frame = av_frame_alloc();
488 if (!avctx->coded_frame) {
489 res = AVERROR(ENOMEM);
493 ctx->last_dts = AV_NOPTS_VALUE;
495 ctx->encode_config.version = NV_ENC_CONFIG_VER;
496 ctx->init_encode_params.version = NV_ENC_INITIALIZE_PARAMS_VER;
497 preset_config.version = NV_ENC_PRESET_CONFIG_VER;
498 preset_config.presetCfg.version = NV_ENC_CONFIG_VER;
499 encode_session_params.version = NV_ENC_OPEN_ENCODE_SESSION_EX_PARAMS_VER;
500 encode_session_params.apiVersion = NVENCAPI_VERSION;
502 #if NVENCAPI_MAJOR_VERSION < 5
503 encode_session_params.clientKeyPtr = &license;
506 if (ctx->gpu >= dl_fn->nvenc_device_count) {
507 av_log(avctx, AV_LOG_FATAL, "Requested GPU %d, but only %d GPUs are available!\n", ctx->gpu, dl_fn->nvenc_device_count);
508 res = AVERROR(EINVAL);
512 ctx->cu_context = NULL;
513 cu_res = dl_fn->cu_ctx_create(&ctx->cu_context, 0, dl_fn->nvenc_devices[ctx->gpu]);
515 if (cu_res != CUDA_SUCCESS) {
516 av_log(avctx, AV_LOG_FATAL, "Failed creating CUDA context for NVENC: 0x%x\n", (int)cu_res);
517 res = AVERROR_EXTERNAL;
521 cu_res = dl_fn->cu_ctx_pop_current(&cu_context_curr);
523 if (cu_res != CUDA_SUCCESS) {
524 av_log(avctx, AV_LOG_FATAL, "Failed popping CUDA context: 0x%x\n", (int)cu_res);
525 res = AVERROR_EXTERNAL;
529 encode_session_params.device = ctx->cu_context;
530 encode_session_params.deviceType = NV_ENC_DEVICE_TYPE_CUDA;
532 nv_status = p_nvenc->nvEncOpenEncodeSessionEx(&encode_session_params, &ctx->nvencoder);
533 if (nv_status != NV_ENC_SUCCESS) {
534 ctx->nvencoder = NULL;
535 av_log(avctx, AV_LOG_FATAL, "OpenEncodeSessionEx failed: 0x%x - invalid license key?\n", (int)nv_status);
536 res = AVERROR_EXTERNAL;
541 if (!strcmp(ctx->preset, "hp")) {
542 encoder_preset = NV_ENC_PRESET_HP_GUID;
543 } else if (!strcmp(ctx->preset, "hq")) {
544 encoder_preset = NV_ENC_PRESET_HQ_GUID;
545 } else if (!strcmp(ctx->preset, "bd")) {
546 encoder_preset = NV_ENC_PRESET_BD_GUID;
547 } else if (!strcmp(ctx->preset, "ll")) {
548 encoder_preset = NV_ENC_PRESET_LOW_LATENCY_DEFAULT_GUID;
550 } else if (!strcmp(ctx->preset, "llhp")) {
551 encoder_preset = NV_ENC_PRESET_LOW_LATENCY_HP_GUID;
553 } else if (!strcmp(ctx->preset, "llhq")) {
554 encoder_preset = NV_ENC_PRESET_LOW_LATENCY_HQ_GUID;
556 } else if (!strcmp(ctx->preset, "default")) {
557 encoder_preset = NV_ENC_PRESET_DEFAULT_GUID;
559 av_log(avctx, AV_LOG_FATAL, "Preset \"%s\" is unknown! Supported presets: hp, hq, bd, ll, llhp, llhq, default\n", ctx->preset);
560 res = AVERROR(EINVAL);
565 nv_status = p_nvenc->nvEncGetEncodePresetConfig(ctx->nvencoder, NV_ENC_CODEC_H264_GUID, encoder_preset, &preset_config);
566 if (nv_status != NV_ENC_SUCCESS) {
567 av_log(avctx, AV_LOG_FATAL, "GetEncodePresetConfig failed: 0x%x\n", (int)nv_status);
568 res = AVERROR_EXTERNAL;
572 ctx->init_encode_params.encodeGUID = NV_ENC_CODEC_H264_GUID;
573 ctx->init_encode_params.encodeHeight = avctx->height;
574 ctx->init_encode_params.encodeWidth = avctx->width;
575 ctx->init_encode_params.darHeight = avctx->height;
576 ctx->init_encode_params.darWidth = avctx->width;
577 ctx->init_encode_params.frameRateNum = avctx->time_base.den;
578 ctx->init_encode_params.frameRateDen = avctx->time_base.num * avctx->ticks_per_frame;
580 num_mbs = ((avctx->width + 15) >> 4) * ((avctx->height + 15) >> 4);
581 ctx->max_surface_count = (num_mbs >= 8160) ? 32 : 48;
583 ctx->init_encode_params.enableEncodeAsync = 0;
584 ctx->init_encode_params.enablePTD = 1;
586 ctx->init_encode_params.presetGUID = encoder_preset;
588 ctx->init_encode_params.encodeConfig = &ctx->encode_config;
589 memcpy(&ctx->encode_config, &preset_config.presetCfg, sizeof(ctx->encode_config));
590 ctx->encode_config.version = NV_ENC_CONFIG_VER;
592 if (avctx->refs >= 0) {
593 /* 0 means "let the hardware decide" */
594 ctx->encode_config.encodeCodecConfig.h264Config.maxNumRefFrames = avctx->refs;
597 if (avctx->gop_size > 0) {
598 if (avctx->max_b_frames >= 0) {
599 /* 0 is intra-only, 1 is I/P only, 2 is one B Frame, 3 two B frames, and so on. */
600 ctx->encode_config.frameIntervalP = avctx->max_b_frames + 1;
603 ctx->encode_config.gopLength = avctx->gop_size;
604 ctx->encode_config.encodeCodecConfig.h264Config.idrPeriod = avctx->gop_size;
605 } else if (avctx->gop_size == 0) {
606 ctx->encode_config.frameIntervalP = 0;
607 ctx->encode_config.gopLength = 1;
608 ctx->encode_config.encodeCodecConfig.h264Config.idrPeriod = 1;
611 /* when there're b frames, set dts offset */
612 if (ctx->encode_config.frameIntervalP >= 2)
615 if (avctx->bit_rate > 0)
616 ctx->encode_config.rcParams.averageBitRate = avctx->bit_rate;
618 if (avctx->rc_max_rate > 0)
619 ctx->encode_config.rcParams.maxBitRate = avctx->rc_max_rate;
623 ctx->encode_config.rcParams.rateControlMode = NV_ENC_PARAMS_RC_CBR;
624 } else if (ctx->twopass == 1 || isLL) {
625 ctx->encode_config.rcParams.rateControlMode = NV_ENC_PARAMS_RC_2_PASS_QUALITY;
627 ctx->encode_config.encodeCodecConfig.h264Config.adaptiveTransformMode = NV_ENC_H264_ADAPTIVE_TRANSFORM_ENABLE;
628 ctx->encode_config.encodeCodecConfig.h264Config.fmoMode = NV_ENC_H264_FMO_DISABLE;
631 av_log(avctx, AV_LOG_WARNING, "Twopass mode is only known to work with low latency (ll, llhq, llhp) presets.\n");
633 ctx->encode_config.rcParams.rateControlMode = NV_ENC_PARAMS_RC_CBR;
635 } else if (avctx->global_quality > 0) {
636 ctx->encode_config.rcParams.rateControlMode = NV_ENC_PARAMS_RC_CONSTQP;
637 ctx->encode_config.rcParams.constQP.qpInterB = avctx->global_quality;
638 ctx->encode_config.rcParams.constQP.qpInterP = avctx->global_quality;
639 ctx->encode_config.rcParams.constQP.qpIntra = avctx->global_quality;
643 } else if (avctx->qmin >= 0 && avctx->qmax >= 0) {
644 ctx->encode_config.rcParams.rateControlMode = NV_ENC_PARAMS_RC_VBR;
646 ctx->encode_config.rcParams.enableMinQP = 1;
647 ctx->encode_config.rcParams.enableMaxQP = 1;
649 ctx->encode_config.rcParams.minQP.qpInterB = avctx->qmin;
650 ctx->encode_config.rcParams.minQP.qpInterP = avctx->qmin;
651 ctx->encode_config.rcParams.minQP.qpIntra = avctx->qmin;
653 ctx->encode_config.rcParams.maxQP.qpInterB = avctx->qmax;
654 ctx->encode_config.rcParams.maxQP.qpInterP = avctx->qmax;
655 ctx->encode_config.rcParams.maxQP.qpIntra = avctx->qmax;
658 if (avctx->rc_buffer_size > 0)
659 ctx->encode_config.rcParams.vbvBufferSize = avctx->rc_buffer_size;
661 if (avctx->flags & CODEC_FLAG_INTERLACED_DCT) {
662 ctx->encode_config.frameFieldMode = NV_ENC_PARAMS_FRAME_FIELD_MODE_FIELD;
664 ctx->encode_config.frameFieldMode = NV_ENC_PARAMS_FRAME_FIELD_MODE_FRAME;
667 switch (avctx->profile) {
668 case FF_PROFILE_H264_BASELINE:
669 ctx->encode_config.profileGUID = NV_ENC_H264_PROFILE_BASELINE_GUID;
671 case FF_PROFILE_H264_MAIN:
672 ctx->encode_config.profileGUID = NV_ENC_H264_PROFILE_MAIN_GUID;
674 case FF_PROFILE_H264_HIGH:
675 case FF_PROFILE_UNKNOWN:
676 ctx->encode_config.profileGUID = NV_ENC_H264_PROFILE_HIGH_GUID;
679 av_log(avctx, AV_LOG_WARNING, "Unsupported h264 profile requested, falling back to high\n");
680 ctx->encode_config.profileGUID = NV_ENC_H264_PROFILE_HIGH_GUID;
684 ctx->encode_config.encodeCodecConfig.h264Config.h264VUIParameters.colourDescriptionPresentFlag = 1;
685 ctx->encode_config.encodeCodecConfig.h264Config.h264VUIParameters.videoSignalTypePresentFlag = 1;
687 ctx->encode_config.encodeCodecConfig.h264Config.h264VUIParameters.colourMatrix = avctx->colorspace;
688 ctx->encode_config.encodeCodecConfig.h264Config.h264VUIParameters.colourPrimaries = avctx->color_primaries;
689 ctx->encode_config.encodeCodecConfig.h264Config.h264VUIParameters.transferCharacteristics = avctx->color_trc;
691 ctx->encode_config.encodeCodecConfig.h264Config.h264VUIParameters.videoFullRangeFlag = avctx->color_range == AVCOL_RANGE_JPEG;
693 ctx->encode_config.encodeCodecConfig.h264Config.disableSPSPPS = (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) ? 1 : 0;
694 ctx->encode_config.encodeCodecConfig.h264Config.repeatSPSPPS = (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) ? 0 : 1;
696 nv_status = p_nvenc->nvEncInitializeEncoder(ctx->nvencoder, &ctx->init_encode_params);
697 if (nv_status != NV_ENC_SUCCESS) {
698 av_log(avctx, AV_LOG_FATAL, "InitializeEncoder failed: 0x%x\n", (int)nv_status);
699 res = AVERROR_EXTERNAL;
703 ctx->input_surfaces = av_malloc(ctx->max_surface_count * sizeof(*ctx->input_surfaces));
705 if (!ctx->input_surfaces) {
706 res = AVERROR(ENOMEM);
710 ctx->output_surfaces = av_malloc(ctx->max_surface_count * sizeof(*ctx->output_surfaces));
712 if (!ctx->output_surfaces) {
713 res = AVERROR(ENOMEM);
717 for (surfaceCount = 0; surfaceCount < ctx->max_surface_count; ++surfaceCount) {
718 NV_ENC_CREATE_INPUT_BUFFER allocSurf = { 0 };
719 NV_ENC_CREATE_BITSTREAM_BUFFER allocOut = { 0 };
720 allocSurf.version = NV_ENC_CREATE_INPUT_BUFFER_VER;
721 allocOut.version = NV_ENC_CREATE_BITSTREAM_BUFFER_VER;
723 allocSurf.width = (avctx->width + 31) & ~31;
724 allocSurf.height = (avctx->height + 31) & ~31;
726 allocSurf.memoryHeap = NV_ENC_MEMORY_HEAP_SYSMEM_CACHED;
728 switch (avctx->pix_fmt) {
729 case AV_PIX_FMT_YUV420P:
730 allocSurf.bufferFmt = NV_ENC_BUFFER_FORMAT_YV12_PL;
733 case AV_PIX_FMT_NV12:
734 allocSurf.bufferFmt = NV_ENC_BUFFER_FORMAT_NV12_PL;
737 case AV_PIX_FMT_YUV444P:
738 allocSurf.bufferFmt = NV_ENC_BUFFER_FORMAT_YUV444_PL;
742 av_log(avctx, AV_LOG_FATAL, "Invalid input pixel format\n");
743 res = AVERROR(EINVAL);
747 nv_status = p_nvenc->nvEncCreateInputBuffer(ctx->nvencoder, &allocSurf);
748 if (nv_status = NV_ENC_SUCCESS){
749 av_log(avctx, AV_LOG_FATAL, "CreateInputBuffer failed\n");
750 res = AVERROR_EXTERNAL;
754 ctx->input_surfaces[surfaceCount].lockCount = 0;
755 ctx->input_surfaces[surfaceCount].input_surface = allocSurf.inputBuffer;
756 ctx->input_surfaces[surfaceCount].format = allocSurf.bufferFmt;
757 ctx->input_surfaces[surfaceCount].width = allocSurf.width;
758 ctx->input_surfaces[surfaceCount].height = allocSurf.height;
760 /* 1MB is large enough to hold most output frames. NVENC increases this automaticaly if it's not enough. */
761 allocOut.size = 1024 * 1024;
763 allocOut.memoryHeap = NV_ENC_MEMORY_HEAP_SYSMEM_CACHED;
765 nv_status = p_nvenc->nvEncCreateBitstreamBuffer(ctx->nvencoder, &allocOut);
766 if (nv_status = NV_ENC_SUCCESS) {
767 av_log(avctx, AV_LOG_FATAL, "CreateBitstreamBuffer failed\n");
768 ctx->output_surfaces[surfaceCount++].output_surface = NULL;
769 res = AVERROR_EXTERNAL;
773 ctx->output_surfaces[surfaceCount].output_surface = allocOut.bitstreamBuffer;
774 ctx->output_surfaces[surfaceCount].size = allocOut.size;
775 ctx->output_surfaces[surfaceCount].busy = 0;
778 if (avctx->flags & CODEC_FLAG_GLOBAL_HEADER) {
779 uint32_t outSize = 0;
781 NV_ENC_SEQUENCE_PARAM_PAYLOAD payload = { 0 };
782 payload.version = NV_ENC_SEQUENCE_PARAM_PAYLOAD_VER;
784 payload.spsppsBuffer = tmpHeader;
785 payload.inBufferSize = sizeof(tmpHeader);
786 payload.outSPSPPSPayloadSize = &outSize;
788 nv_status = p_nvenc->nvEncGetSequenceParams(ctx->nvencoder, &payload);
789 if (nv_status != NV_ENC_SUCCESS) {
790 av_log(avctx, AV_LOG_FATAL, "GetSequenceParams failed\n");
794 avctx->extradata_size = outSize;
795 avctx->extradata = av_mallocz(outSize + FF_INPUT_BUFFER_PADDING_SIZE);
797 if (!avctx->extradata) {
798 res = AVERROR(ENOMEM);
802 memcpy(avctx->extradata, tmpHeader, outSize);
805 if (ctx->encode_config.frameIntervalP > 1)
806 avctx->has_b_frames = 2;
808 if (ctx->encode_config.rcParams.averageBitRate > 0)
809 avctx->bit_rate = ctx->encode_config.rcParams.averageBitRate;
815 for (i = 0; i < surfaceCount; ++i) {
816 p_nvenc->nvEncDestroyInputBuffer(ctx->nvencoder, ctx->input_surfaces[i].input_surface);
817 if (ctx->output_surfaces[i].output_surface)
818 p_nvenc->nvEncDestroyBitstreamBuffer(ctx->nvencoder, ctx->output_surfaces[i].output_surface);
822 p_nvenc->nvEncDestroyEncoder(ctx->nvencoder);
825 dl_fn->cu_ctx_destroy(ctx->cu_context);
827 av_frame_free(&avctx->coded_frame);
829 nvenc_unload_nvenc(avctx);
831 ctx->nvencoder = NULL;
832 ctx->cu_context = NULL;
837 static av_cold int nvenc_encode_close(AVCodecContext *avctx)
839 NvencContext *ctx = avctx->priv_data;
840 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
841 NV_ENCODE_API_FUNCTION_LIST *p_nvenc = &dl_fn->nvenc_funcs;
844 av_freep(&ctx->timestamp_list.data);
845 av_freep(&ctx->output_surface_ready_queue.data);
846 av_freep(&ctx->output_surface_queue.data);
848 for (i = 0; i < ctx->max_surface_count; ++i) {
849 p_nvenc->nvEncDestroyInputBuffer(ctx->nvencoder, ctx->input_surfaces[i].input_surface);
850 p_nvenc->nvEncDestroyBitstreamBuffer(ctx->nvencoder, ctx->output_surfaces[i].output_surface);
852 ctx->max_surface_count = 0;
854 p_nvenc->nvEncDestroyEncoder(ctx->nvencoder);
855 ctx->nvencoder = NULL;
857 dl_fn->cu_ctx_destroy(ctx->cu_context);
858 ctx->cu_context = NULL;
860 nvenc_unload_nvenc(avctx);
862 av_frame_free(&avctx->coded_frame);
867 static int process_output_surface(AVCodecContext *avctx, AVPacket *pkt, AVFrame *coded_frame, NvencOutputSurface *tmpoutsurf)
869 NvencContext *ctx = avctx->priv_data;
870 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
871 NV_ENCODE_API_FUNCTION_LIST *p_nvenc = &dl_fn->nvenc_funcs;
873 uint32_t *slice_offsets = av_mallocz(ctx->encode_config.encodeCodecConfig.h264Config.sliceModeData * sizeof(*slice_offsets));
874 NV_ENC_LOCK_BITSTREAM lock_params = { 0 };
875 NVENCSTATUS nv_status;
879 return AVERROR(ENOMEM);
881 lock_params.version = NV_ENC_LOCK_BITSTREAM_VER;
883 lock_params.doNotWait = 0;
884 lock_params.outputBitstream = tmpoutsurf->output_surface;
885 lock_params.sliceOffsets = slice_offsets;
887 nv_status = p_nvenc->nvEncLockBitstream(ctx->nvencoder, &lock_params);
888 if (nv_status != NV_ENC_SUCCESS) {
889 av_log(avctx, AV_LOG_ERROR, "Failed locking bitstream buffer\n");
890 res = AVERROR_EXTERNAL;
894 if (res = ff_alloc_packet2(avctx, pkt, lock_params.bitstreamSizeInBytes)) {
895 p_nvenc->nvEncUnlockBitstream(ctx->nvencoder, tmpoutsurf->output_surface);
899 memcpy(pkt->data, lock_params.bitstreamBufferPtr, lock_params.bitstreamSizeInBytes);
901 nv_status = p_nvenc->nvEncUnlockBitstream(ctx->nvencoder, tmpoutsurf->output_surface);
902 if (nv_status != NV_ENC_SUCCESS)
903 av_log(avctx, AV_LOG_ERROR, "Failed unlocking bitstream buffer, expect the gates of mordor to open\n");
905 switch (lock_params.pictureType) {
906 case NV_ENC_PIC_TYPE_IDR:
907 pkt->flags |= AV_PKT_FLAG_KEY;
908 case NV_ENC_PIC_TYPE_I:
909 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
911 case NV_ENC_PIC_TYPE_P:
912 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_P;
914 case NV_ENC_PIC_TYPE_B:
915 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_B;
917 case NV_ENC_PIC_TYPE_BI:
918 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_BI;
921 av_log(avctx, AV_LOG_ERROR, "Unknown picture type encountered, expect the output to be broken.\n");
922 av_log(avctx, AV_LOG_ERROR, "Please report this error and include as much information on how to reproduce it as possible.\n");
923 res = AVERROR_EXTERNAL;
927 pkt->pts = lock_params.outputTimeStamp;
928 pkt->dts = timestamp_queue_dequeue(&ctx->timestamp_list);
930 /* when there're b frame(s), set dts offset */
931 if (ctx->encode_config.frameIntervalP >= 2)
934 if (pkt->dts > pkt->pts)
937 if (ctx->last_dts != AV_NOPTS_VALUE && pkt->dts <= ctx->last_dts)
938 pkt->dts = ctx->last_dts + 1;
940 ctx->last_dts = pkt->dts;
942 av_free(slice_offsets);
948 av_free(slice_offsets);
949 timestamp_queue_dequeue(&ctx->timestamp_list);
954 static int nvenc_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
955 const AVFrame *frame, int *got_packet)
957 NVENCSTATUS nv_status;
958 NvencOutputSurface *tmpoutsurf;
961 NvencContext *ctx = avctx->priv_data;
962 NvencDynLoadFunctions *dl_fn = &ctx->nvenc_dload_funcs;
963 NV_ENCODE_API_FUNCTION_LIST *p_nvenc = &dl_fn->nvenc_funcs;
965 NV_ENC_PIC_PARAMS pic_params = { 0 };
966 pic_params.version = NV_ENC_PIC_PARAMS_VER;
969 NV_ENC_LOCK_INPUT_BUFFER lockBufferParams = { 0 };
970 NvencInputSurface *inSurf = NULL;
972 for (i = 0; i < ctx->max_surface_count; ++i) {
973 if (!ctx->input_surfaces[i].lockCount) {
974 inSurf = &ctx->input_surfaces[i];
981 inSurf->lockCount = 1;
983 lockBufferParams.version = NV_ENC_LOCK_INPUT_BUFFER_VER;
984 lockBufferParams.inputBuffer = inSurf->input_surface;
986 nv_status = p_nvenc->nvEncLockInputBuffer(ctx->nvencoder, &lockBufferParams);
987 if (nv_status != NV_ENC_SUCCESS) {
988 av_log(avctx, AV_LOG_ERROR, "Failed locking nvenc input buffer\n");
992 if (avctx->pix_fmt == AV_PIX_FMT_YUV420P) {
993 uint8_t *buf = lockBufferParams.bufferDataPtr;
995 av_image_copy_plane(buf, lockBufferParams.pitch,
996 frame->data[0], frame->linesize[0],
997 avctx->width, avctx->height);
999 buf += inSurf->height * lockBufferParams.pitch;
1001 av_image_copy_plane(buf, lockBufferParams.pitch >> 1,
1002 frame->data[2], frame->linesize[2],
1003 avctx->width >> 1, avctx->height >> 1);
1005 buf += (inSurf->height * lockBufferParams.pitch) >> 2;
1007 av_image_copy_plane(buf, lockBufferParams.pitch >> 1,
1008 frame->data[1], frame->linesize[1],
1009 avctx->width >> 1, avctx->height >> 1);
1010 } else if (avctx->pix_fmt == AV_PIX_FMT_NV12) {
1011 uint8_t *buf = lockBufferParams.bufferDataPtr;
1013 av_image_copy_plane(buf, lockBufferParams.pitch,
1014 frame->data[0], frame->linesize[0],
1015 avctx->width, avctx->height);
1017 buf += inSurf->height * lockBufferParams.pitch;
1019 av_image_copy_plane(buf, lockBufferParams.pitch,
1020 frame->data[1], frame->linesize[1],
1021 avctx->width, avctx->height >> 1);
1022 } else if (avctx->pix_fmt == AV_PIX_FMT_YUV444P) {
1023 uint8_t *buf = lockBufferParams.bufferDataPtr;
1025 av_image_copy_plane(buf, lockBufferParams.pitch,
1026 frame->data[0], frame->linesize[0],
1027 avctx->width, avctx->height);
1029 buf += inSurf->height * lockBufferParams.pitch;
1031 av_image_copy_plane(buf, lockBufferParams.pitch,
1032 frame->data[1], frame->linesize[1],
1033 avctx->width, avctx->height);
1035 buf += inSurf->height * lockBufferParams.pitch;
1037 av_image_copy_plane(buf, lockBufferParams.pitch,
1038 frame->data[2], frame->linesize[2],
1039 avctx->width, avctx->height);
1041 av_log(avctx, AV_LOG_FATAL, "Invalid pixel format!\n");
1042 return AVERROR(EINVAL);
1045 nv_status = p_nvenc->nvEncUnlockInputBuffer(ctx->nvencoder, inSurf->input_surface);
1046 if (nv_status != NV_ENC_SUCCESS) {
1047 av_log(avctx, AV_LOG_FATAL, "Failed unlocking input buffer!\n");
1048 return AVERROR_EXTERNAL;
1051 for (i = 0; i < ctx->max_surface_count; ++i)
1052 if (!ctx->output_surfaces[i].busy)
1055 if (i == ctx->max_surface_count) {
1056 inSurf->lockCount = 0;
1057 av_log(avctx, AV_LOG_FATAL, "No free output surface found!\n");
1058 return AVERROR_EXTERNAL;
1061 ctx->output_surfaces[i].input_surface = inSurf;
1063 pic_params.inputBuffer = inSurf->input_surface;
1064 pic_params.bufferFmt = inSurf->format;
1065 pic_params.inputWidth = avctx->width;
1066 pic_params.inputHeight = avctx->height;
1067 pic_params.outputBitstream = ctx->output_surfaces[i].output_surface;
1068 pic_params.completionEvent = 0;
1070 if (avctx->flags & CODEC_FLAG_INTERLACED_DCT) {
1071 if (frame->top_field_first) {
1072 pic_params.pictureStruct = NV_ENC_PIC_STRUCT_FIELD_TOP_BOTTOM;
1074 pic_params.pictureStruct = NV_ENC_PIC_STRUCT_FIELD_BOTTOM_TOP;
1077 pic_params.pictureStruct = NV_ENC_PIC_STRUCT_FRAME;
1080 pic_params.encodePicFlags = 0;
1081 pic_params.inputTimeStamp = frame->pts;
1082 pic_params.inputDuration = 0;
1083 pic_params.codecPicParams.h264PicParams.sliceMode = ctx->encode_config.encodeCodecConfig.h264Config.sliceMode;
1084 pic_params.codecPicParams.h264PicParams.sliceModeData = ctx->encode_config.encodeCodecConfig.h264Config.sliceModeData;
1086 #if NVENCAPI_MAJOR_VERSION < 5
1087 memcpy(&pic_params.rcParams, &ctx->encode_config.rcParams, sizeof(NV_ENC_RC_PARAMS));
1090 res = timestamp_queue_enqueue(&ctx->timestamp_list, frame->pts);
1095 pic_params.encodePicFlags = NV_ENC_PIC_FLAG_EOS;
1098 nv_status = p_nvenc->nvEncEncodePicture(ctx->nvencoder, &pic_params);
1100 if (frame && nv_status == NV_ENC_ERR_NEED_MORE_INPUT) {
1101 res = out_surf_queue_enqueue(&ctx->output_surface_queue, &ctx->output_surfaces[i]);
1106 ctx->output_surfaces[i].busy = 1;
1109 if (nv_status != NV_ENC_SUCCESS && nv_status != NV_ENC_ERR_NEED_MORE_INPUT) {
1110 av_log(avctx, AV_LOG_ERROR, "EncodePicture failed!\n");
1111 return AVERROR_EXTERNAL;
1114 if (nv_status != NV_ENC_ERR_NEED_MORE_INPUT) {
1115 while (ctx->output_surface_queue.count) {
1116 tmpoutsurf = out_surf_queue_dequeue(&ctx->output_surface_queue);
1117 res = out_surf_queue_enqueue(&ctx->output_surface_ready_queue, tmpoutsurf);
1124 res = out_surf_queue_enqueue(&ctx->output_surface_ready_queue, &ctx->output_surfaces[i]);
1129 ctx->output_surfaces[i].busy = 1;
1133 if (ctx->output_surface_ready_queue.count) {
1134 tmpoutsurf = out_surf_queue_dequeue(&ctx->output_surface_ready_queue);
1136 res = process_output_surface(avctx, pkt, avctx->coded_frame, tmpoutsurf);
1141 tmpoutsurf->busy = 0;
1142 av_assert0(tmpoutsurf->input_surface->lockCount);
1143 tmpoutsurf->input_surface->lockCount--;
1153 static enum AVPixelFormat pix_fmts_nvenc[] = {
1158 #define OFFSET(x) offsetof(NvencContext, x)
1159 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
1160 static const AVOption options[] = {
1161 { "preset", "Set the encoding preset (one of hq, hp, bd, ll, llhq, llhp, default)", OFFSET(preset), AV_OPT_TYPE_STRING, { .str = "hq" }, 0, 0, VE },
1162 { "cbr", "Use cbr encoding mode", OFFSET(cbr), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, VE },
1163 { "2pass", "Use 2pass cbr encoding mode (low latency mode only)", OFFSET(twopass), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 1, VE },
1164 { "gpu", "Selects which NVENC capable GPU to use. First GPU is 0, second is 1, and so on.", OFFSET(gpu), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VE },
1168 static const AVClass nvenc_class = {
1169 .class_name = "nvenc",
1170 .item_name = av_default_item_name,
1172 .version = LIBAVUTIL_VERSION_INT,
1175 static const AVCodecDefault nvenc_defaults[] = {
1185 AVCodec ff_nvenc_encoder = {
1187 .long_name = NULL_IF_CONFIG_SMALL("Nvidia NVENC h264 encoder"),
1188 .type = AVMEDIA_TYPE_VIDEO,
1189 .id = AV_CODEC_ID_H264,
1190 .priv_data_size = sizeof(NvencContext),
1191 .init = nvenc_encode_init,
1192 .encode2 = nvenc_encode_frame,
1193 .close = nvenc_encode_close,
1194 .capabilities = CODEC_CAP_DELAY,
1195 .priv_class = &nvenc_class,
1196 .defaults = nvenc_defaults,
1197 .pix_fmts = pix_fmts_nvenc,