FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvenc_h264.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "libavutil/internal.h"
20 
21 #include "avcodec.h"
22 #include "internal.h"
23 
24 #include "nvenc.h"
25 
26 #define OFFSET(x) offsetof(NvencContext, x)
27 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
28 static const AVOption options[] = {
29  { "preset", "Set the encoding preset", OFFSET(preset), AV_OPT_TYPE_INT, { .i64 = PRESET_MEDIUM }, PRESET_DEFAULT, PRESET_LOSSLESS_HP, VE, "preset" },
30  { "default", "", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_DEFAULT }, 0, 0, VE, "preset" },
31  { "slow", "hq 2 passes", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_SLOW }, 0, 0, VE, "preset" },
32  { "medium", "hq 1 pass", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_MEDIUM }, 0, 0, VE, "preset" },
33  { "fast", "hp 1 pass", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_FAST }, 0, 0, VE, "preset" },
34  { "hp", "", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_HP }, 0, 0, VE, "preset" },
35  { "hq", "", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_HQ }, 0, 0, VE, "preset" },
36  { "bd", "", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_BD }, 0, 0, VE, "preset" },
37  { "ll", "low latency", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_LOW_LATENCY_DEFAULT }, 0, 0, VE, "preset" },
38  { "llhq", "low latency hq", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_LOW_LATENCY_HQ }, 0, 0, VE, "preset" },
39  { "llhp", "low latency hp", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_LOW_LATENCY_HP }, 0, 0, VE, "preset" },
40  { "lossless", "", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_LOSSLESS_DEFAULT }, 0, 0, VE, "preset" },
41  { "losslesshp", "", 0, AV_OPT_TYPE_CONST, { .i64 = PRESET_LOSSLESS_HP }, 0, 0, VE, "preset" },
42  { "profile", "Set the encoding profile", OFFSET(profile), AV_OPT_TYPE_INT, { .i64 = NV_ENC_H264_PROFILE_MAIN }, NV_ENC_H264_PROFILE_BASELINE, NV_ENC_H264_PROFILE_HIGH_444P, VE, "profile" },
43  { "baseline", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_H264_PROFILE_BASELINE }, 0, 0, VE, "profile" },
44  { "main", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_H264_PROFILE_MAIN }, 0, 0, VE, "profile" },
45  { "high", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_H264_PROFILE_HIGH }, 0, 0, VE, "profile" },
46  { "high444p", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_H264_PROFILE_HIGH_444P }, 0, 0, VE, "profile" },
47  { "level", "Set the encoding level restriction", OFFSET(level), AV_OPT_TYPE_INT, { .i64 = NV_ENC_LEVEL_AUTOSELECT }, NV_ENC_LEVEL_AUTOSELECT, NV_ENC_LEVEL_H264_51, VE, "level" },
48  { "auto", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_AUTOSELECT }, 0, 0, VE, "level" },
49  { "1", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_1 }, 0, 0, VE, "level" },
50  { "1.0", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_1 }, 0, 0, VE, "level" },
51  { "1b", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_1b }, 0, 0, VE, "level" },
52  { "1.0b", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_1b }, 0, 0, VE, "level" },
53  { "1.1", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_11 }, 0, 0, VE, "level" },
54  { "1.2", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_12 }, 0, 0, VE, "level" },
55  { "1.3", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_13 }, 0, 0, VE, "level" },
56  { "2", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_2 }, 0, 0, VE, "level" },
57  { "2.0", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_2 }, 0, 0, VE, "level" },
58  { "2.1", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_21 }, 0, 0, VE, "level" },
59  { "2.2", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_22 }, 0, 0, VE, "level" },
60  { "3", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_3 }, 0, 0, VE, "level" },
61  { "3.0", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_3 }, 0, 0, VE, "level" },
62  { "3.1", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_31 }, 0, 0, VE, "level" },
63  { "3.2", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_32 }, 0, 0, VE, "level" },
64  { "4", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_4 }, 0, 0, VE, "level" },
65  { "4.0", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_4 }, 0, 0, VE, "level" },
66  { "4.1", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_41 }, 0, 0, VE, "level" },
67  { "4.2", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_42 }, 0, 0, VE, "level" },
68  { "5", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_5 }, 0, 0, VE, "level" },
69  { "5.0", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_5 }, 0, 0, VE, "level" },
70  { "5.1", "", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_LEVEL_H264_51 }, 0, 0, VE, "level" },
71  { "rc", "Override the preset rate-control", OFFSET(rc), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, VE, "rc" },
72  { "constqp", "Constant QP mode", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_CONSTQP }, 0, 0, VE, "rc" },
73  { "vbr", "Variable bitrate mode", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_VBR }, 0, 0, VE, "rc" },
74  { "cbr", "Constant bitrate mode", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_CBR }, 0, 0, VE, "rc" },
75  { "vbr_minqp", "Variable bitrate mode with MinQP", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_VBR_MINQP }, 0, 0, VE, "rc" },
76  { "ll_2pass_quality", "Multi-pass optimized for image quality (only for low-latency presets)",
77  0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_2_PASS_QUALITY }, 0, 0, VE, "rc" },
78  { "ll_2pass_size", "Multi-pass optimized for constant frame size (only for low-latency presets)",
79  0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_2_PASS_FRAMESIZE_CAP }, 0, 0, VE, "rc" },
80  { "vbr_2pass", "Multi-pass variable bitrate mode", 0, AV_OPT_TYPE_CONST, { .i64 = NV_ENC_PARAMS_RC_2_PASS_VBR }, 0, 0, VE, "rc" },
81  { "rc-lookahead", "Number of frames to look ahead for rate-control",
82  OFFSET(rc_lookahead), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, INT_MAX, VE },
83  { "surfaces", "Number of concurrent surfaces", OFFSET(nb_surfaces), AV_OPT_TYPE_INT, { .i64 = 32 }, 0, MAX_REGISTERED_FRAMES, VE },
84  { "cbr", "Use cbr encoding mode", OFFSET(cbr), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
85  { "2pass", "Use 2pass encoding mode", OFFSET(twopass), AV_OPT_TYPE_BOOL, { .i64 = -1 }, -1, 1, VE },
86  { "gpu", "Selects which NVENC capable GPU to use. First GPU is 0, second is 1, and so on.",
87  OFFSET(device), AV_OPT_TYPE_INT, { .i64 = ANY_DEVICE }, -2, INT_MAX, VE, "gpu" },
88  { "any", "Pick the first device available", 0, AV_OPT_TYPE_CONST, { .i64 = ANY_DEVICE }, 0, 0, VE, "gpu" },
89  { "list", "List the available devices", 0, AV_OPT_TYPE_CONST, { .i64 = LIST_DEVICES }, 0, 0, VE, "gpu" },
90  { "delay", "Delay frame output by the given amount of frames",
91  OFFSET(async_depth), AV_OPT_TYPE_INT, { .i64 = INT_MAX }, 0, INT_MAX, VE },
92  { "no-scenecut", "When lookahead is enabled, set this to 1 to disable adaptive I-frame insertion at scene cuts",
93  OFFSET(no_scenecut), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
94  { "forced-idr", "If forcing keyframes, force them as IDR frames.",
95  OFFSET(forced_idr), AV_OPT_TYPE_BOOL, { .i64 = 0 }, -1, 1, VE },
96  { "b_adapt", "When lookahead is enabled, set this to 0 to disable adaptive B-frame decision",
97  OFFSET(b_adapt), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, VE },
98  { "spatial-aq", "set to 1 to enable Spatial AQ", OFFSET(aq), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
99  { "temporal-aq", "set to 1 to enable Temporal AQ", OFFSET(temporal_aq), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
100  { "zerolatency", "Set 1 to indicate zero latency operation (no reordering delay)",
101  OFFSET(zerolatency), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
102  { "nonref_p", "Set this to 1 to enable automatic insertion of non-reference P-frames",
103  OFFSET(nonref_p), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
104  { "strict_gop", "Set 1 to minimize GOP-to-GOP rate fluctuations",
105  OFFSET(strict_gop), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
106  { "aq-strength", "When Spatial AQ is enabled, this field is used to specify AQ strength. AQ strength scale is from 1 (low) - 15 (aggressive)",
107  OFFSET(aq_strength), AV_OPT_TYPE_INT, { .i64 = 8 }, 1, 15, VE },
108  { "cq", "Set target quality level (0 to 51, 0 means automatic) for constant quality mode in VBR rate control",
109  OFFSET(quality), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 51, VE },
110  { "aud", "Use access unit delimiters", OFFSET(aud), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
111  { "bluray-compat", "Bluray compatibility workarounds", OFFSET(bluray_compat),AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, VE },
112  { "init_qpP", "Initial QP value for P frame", OFFSET(init_qp_p), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 51, VE },
113  { "init_qpB", "Initial QP value for B frame", OFFSET(init_qp_b), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 51, VE },
114  { "init_qpI", "Initial QP value for I frame", OFFSET(init_qp_i), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 51, VE },
115  { "qp", "Constant quantization parameter rate control method",
116  OFFSET(cqp), AV_OPT_TYPE_INT, { .i64 = -1 }, -1, 51, VE },
117  { NULL }
118 };
119 
120 static const AVCodecDefault defaults[] = {
121  { "b", "2M" },
122  { "qmin", "-1" },
123  { "qmax", "-1" },
124  { "qdiff", "-1" },
125  { "qblur", "-1" },
126  { "qcomp", "-1" },
127  { "g", "250" },
128  { "bf", "0" },
129  { NULL },
130 };
131 
132 #if FF_API_NVENC_OLD_NAME
133 
135 {
136  av_log(avctx, AV_LOG_WARNING, "This encoder is deprecated, use 'h264_nvenc' instead\n");
137  return ff_nvenc_encode_init(avctx);
138 }
139 
140 #if CONFIG_NVENC_ENCODER
141 static const AVClass nvenc_class = {
142  .class_name = "nvenc",
143  .item_name = av_default_item_name,
144  .option = options,
145  .version = LIBAVUTIL_VERSION_INT,
146 };
147 
148 AVCodec ff_nvenc_encoder = {
149  .name = "nvenc",
150  .long_name = NULL_IF_CONFIG_SMALL("NVIDIA NVENC H.264 encoder"),
151  .type = AVMEDIA_TYPE_VIDEO,
152  .id = AV_CODEC_ID_H264,
153  .init = nvenc_old_init,
154  .encode2 = ff_nvenc_encode_frame,
155  .close = ff_nvenc_encode_close,
156  .priv_data_size = sizeof(NvencContext),
157  .priv_class = &nvenc_class,
158  .defaults = defaults,
159  .capabilities = AV_CODEC_CAP_DELAY,
160  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
162 };
163 #endif
164 
165 /* Add an alias for nvenc_h264 */
166 #if CONFIG_NVENC_H264_ENCODER
167 static const AVClass nvenc_h264_class = {
168  .class_name = "nvenc_h264",
169  .item_name = av_default_item_name,
170  .option = options,
171  .version = LIBAVUTIL_VERSION_INT,
172 };
173 
174 AVCodec ff_nvenc_h264_encoder = {
175  .name = "nvenc_h264",
176  .long_name = NULL_IF_CONFIG_SMALL("NVIDIA NVENC H.264 encoder"),
177  .type = AVMEDIA_TYPE_VIDEO,
178  .id = AV_CODEC_ID_H264,
179  .init = nvenc_old_init,
180  .encode2 = ff_nvenc_encode_frame,
181  .close = ff_nvenc_encode_close,
182  .priv_data_size = sizeof(NvencContext),
183  .priv_class = &nvenc_h264_class,
184  .defaults = defaults,
185  .capabilities = AV_CODEC_CAP_DELAY,
186  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
188 };
189 #endif
190 
191 #endif
192 
193 static const AVClass h264_nvenc_class = {
194  .class_name = "h264_nvenc",
195  .item_name = av_default_item_name,
196  .option = options,
197  .version = LIBAVUTIL_VERSION_INT,
198 };
199 
201  .name = "h264_nvenc",
202  .long_name = NULL_IF_CONFIG_SMALL("NVIDIA NVENC H.264 encoder"),
203  .type = AVMEDIA_TYPE_VIDEO,
204  .id = AV_CODEC_ID_H264,
205  .init = ff_nvenc_encode_init,
206  .encode2 = ff_nvenc_encode_frame,
207  .close = ff_nvenc_encode_close,
208  .priv_data_size = sizeof(NvencContext),
209  .priv_class = &h264_nvenc_class,
210  .defaults = defaults,
211  .capabilities = AV_CODEC_CAP_DELAY,
212  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
214 };
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
#define NULL
Definition: coverity.c:32
av_cold int ff_nvenc_encode_close(AVCodecContext *avctx)
Definition: nvenc.c:1256
static av_cold int nvenc_old_init(AVCodecContext *avctx)
Definition: nvenc_h264.c:134
AVOption.
Definition: opt.h:246
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
static const AVClass h264_nvenc_class
Definition: nvenc_h264.c:193
AVCodec.
Definition: avcodec.h:3681
static const AVCodecDefault defaults[]
Definition: nvenc_h264.c:120
Constant QP mode.
Definition: nvEncodeAPI.h:255
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: avcodec.h:1019
#define av_cold
Definition: attributes.h:82
enum AVPixelFormat ff_nvenc_pix_fmts[]
Definition: nvenc.c:39
#define VE
Definition: nvenc_h264.c:27
#define MAX_REGISTERED_FRAMES
Definition: nvenc.h:32
Variable bitrate mode.
Definition: nvEncodeAPI.h:256
#define av_log(a,...)
AVCodec ff_h264_nvenc_encoder
Definition: nvenc_h264.c:200
av_default_item_name
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:179
Multi pass encoding optimized for maintaining frame size and works only with low latency mode...
Definition: nvEncodeAPI.h:260
const char * name
Name of the codec implementation.
Definition: avcodec.h:3688
common internal API header
av_cold int ff_nvenc_encode_init(AVCodecContext *avctx)
Definition: nvenc.c:1332
int ff_nvenc_encode_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: nvenc.c:1741
Multi pass encoding optimized for image quality and works only with low latency mode.
Definition: nvEncodeAPI.h:259
Constant bitrate mode.
Definition: nvEncodeAPI.h:257
Variable bitrate mode with MinQP.
Definition: nvEncodeAPI.h:258
Libavcodec external API header.
main external API structure.
Definition: avcodec.h:1732
Describe the class of an AVClass context structure.
Definition: log.h:67
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:262
mfxU16 profile
Definition: qsvenc.c:44
uint8_t level
Definition: svq3.c:207
preset
Definition: vf_curves.c:46
common internal api header.
#define OFFSET(x)
Definition: nvenc_h264.c:26
static const AVOption options[]
Definition: nvenc_h264.c:28