FFmpeg
nvenc.h
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 #ifndef AVCODEC_NVENC_H
20 #define AVCODEC_NVENC_H
21 
22 #include "config.h"
23 
24 #if CONFIG_D3D11VA
25 #define COBJMACROS
27 #else
28 typedef void ID3D11Device;
29 #endif
30 
31 #include <ffnvcodec/nvEncodeAPI.h>
32 
34 #include "libavutil/buffer.h"
35 #include "libavutil/fifo.h"
36 #include "libavutil/opt.h"
37 #include "hwconfig.h"
38 
39 #include "avcodec.h"
40 
41 #define MAX_REGISTERED_FRAMES 64
42 #define RC_MODE_DEPRECATED 0x800000
43 #define RCD(rc_mode) ((rc_mode) | RC_MODE_DEPRECATED)
44 
45 #define NVENCAPI_CHECK_VERSION(major, minor) \
46  ((major) < NVENCAPI_MAJOR_VERSION || ((major) == NVENCAPI_MAJOR_VERSION && (minor) <= NVENCAPI_MINOR_VERSION))
47 
48 // SDK 8.1 compile time feature checks
49 #if NVENCAPI_CHECK_VERSION(8, 1)
50 #define NVENC_HAVE_BFRAME_REF_MODE
51 #define NVENC_HAVE_QP_MAP_MODE
52 #endif
53 
54 // SDK 9.0 compile time feature checks
55 #if NVENCAPI_CHECK_VERSION(9, 0)
56 #define NVENC_HAVE_HEVC_BFRAME_REF_MODE
57 #endif
58 
59 // SDK 9.1 compile time feature checks
60 #if NVENCAPI_CHECK_VERSION(9, 1)
61 #define NVENC_HAVE_MULTIPLE_REF_FRAMES
62 #define NVENC_HAVE_CUSTREAM_PTR
63 #define NVENC_HAVE_GETLASTERRORSTRING
64 #define NVENC_HAVE_FILLER_DATA
65 #endif
66 
67 // SDK 10.0 compile time feature checks
68 #if NVENCAPI_CHECK_VERSION(10, 0)
69 #define NVENC_HAVE_NEW_PRESETS
70 #define NVENC_HAVE_MULTIPASS
71 #define NVENC_HAVE_LDKFS
72 #define NVENC_HAVE_H264_LVL6
73 #define NVENC_HAVE_HEVC_CONSTRAINED_ENCODING
74 #endif
75 
76 // SDK 11.1 compile time feature checks
77 #if NVENCAPI_CHECK_VERSION(11, 1)
78 #define NVENC_HAVE_QP_CHROMA_OFFSETS
79 #define NVENC_HAVE_SINGLE_SLICE_INTRA_REFRESH
80 #endif
81 
82 // SDK 12.0 compile time feature checks
83 #if NVENCAPI_CHECK_VERSION(12, 0)
84 #define NVENC_HAVE_HEVC_OUTPUT_RECOVERY_POINT_SEI
85 #endif
86 
87 // SDK 12.1 compile time feature checks
88 #if NVENCAPI_CHECK_VERSION(12, 1)
89 #define NVENC_NO_DEPRECATED_RC
90 #define NVENC_HAVE_SPLIT_FRAME_ENCODING
91 #endif
92 
93 // SDK 12.2 compile time feature checks
94 #if NVENCAPI_CHECK_VERSION(12, 2)
95 #define NVENC_HAVE_NEW_BIT_DEPTH_API
96 #define NVENC_HAVE_TEMPORAL_FILTER
97 #define NVENC_HAVE_LOOKAHEAD_LEVEL
98 #define NVENC_HAVE_UHQ_TUNING
99 #define NVENC_HAVE_UNIDIR_B
100 #define NVENC_HAVE_TIME_CODE // added in 12.0, but incomplete until 12.2
101 #endif
102 
103 // SDK 13.0 compile time feature checks
104 #if NVENCAPI_CHECK_VERSION(13, 0)
105 #define NVENC_HAVE_H264_10BIT_SUPPORT
106 #define NVENC_HAVE_422_SUPPORT
107 #define NVENC_HAVE_AV1_UHQ_TUNING
108 #define NVENC_HAVE_H264_AND_AV1_TEMPORAL_FILTER
109 #define NVENC_HAVE_HEVC_AND_AV1_MASTERING_METADATA
110 #define NVENC_HAVE_MVHEVC
111 #endif
112 
113 typedef struct NvencSurface
114 {
115  NV_ENC_INPUT_PTR input_surface;
117  int reg_idx;
118  int width;
119  int height;
120  int pitch;
121 
122  NV_ENC_OUTPUT_PTR output_surface;
123  NV_ENC_BUFFER_FORMAT format;
124 } NvencSurface;
125 
126 typedef struct NvencFrameData
127 {
129 
133 
134 typedef struct NvencDynLoadFunctions
135 {
136  CudaFunctions *cuda_dl;
137  NvencFunctions *nvenc_dl;
138 
139  NV_ENCODE_API_FUNCTION_LIST nvenc_funcs;
142 
143 enum {
156 #ifdef NVENC_HAVE_NEW_PRESETS
157  PRESET_P1,
158  PRESET_P2,
159  PRESET_P3,
160  PRESET_P4,
161  PRESET_P5,
162  PRESET_P6,
163  PRESET_P7,
164 #endif
165 };
166 
167 enum {
171 #ifdef NVENC_HAVE_H264_10BIT_SUPPORT
172  NV_ENC_H264_PROFILE_HIGH_10,
173 #endif
174 #ifdef NVENC_HAVE_422_SUPPORT
175  NV_ENC_H264_PROFILE_HIGH_422,
176 #endif
178 };
179 
180 enum {
184 #ifdef NVENC_HAVE_MVHEVC
185  NV_ENC_HEVC_PROFILE_MULTIVIEW_MAIN,
186 #endif
187 
189 };
190 
191 enum {
196 
198 };
199 
200 enum {
203 };
204 
205 enum {
209 };
210 
211 typedef struct NvencContext
212 {
214 
216 
217  NV_ENC_INITIALIZE_PARAMS init_encode_params;
218  NV_ENC_CONFIG encode_config;
219  CUcontext cu_context;
221  CUstream cu_stream;
223 
225 
228 
232 
237  // This is for DTS calculating, reset after flush
240 
241  NV_ENC_SEI_PAYLOAD *sei_data;
243 
244  struct {
245  void *ptr;
247  NV_ENC_REGISTERED_PTR regptr;
248  int mapped;
249  NV_ENC_MAP_INPUT_RESOURCE in_map;
252 
253  /* the actual data pixel format, different from
254  * AVCodecContext.pix_fmt when using hwaccel frames on input */
256 
258 
259  void *nvencoder;
260 
262  uint32_t next_view_id;
263 
264  int preset;
265  int profile;
266  int level;
267  int tier;
268  int rc;
269  int cbr;
272  int twopass;
273  int device;
274  int flags;
277  int aq;
280  int b_adapt;
283  int nonref_p;
286  float quality;
287  int aud;
289  int qmin;
290  int qmax;
294  int cqp;
298  int coder;
300  int a53_cc;
301  int s12m_tc;
302  int dpb_size;
305  int ldkfs;
310  int udu_sei;
314  int rgb_mode;
315  int tf_level;
317  int unidir_b;
319  int mdm, cll;
323 } NvencContext;
324 
326 
328 
330 
332 
333 extern const enum AVPixelFormat ff_nvenc_pix_fmts[];
334 extern const AVCodecHWConfigInternal *const ff_nvenc_hw_configs[];
335 
336 #endif /* AVCODEC_NVENC_H */
ANY_DEVICE
@ ANY_DEVICE
Definition: nvenc.h:202
NvencContext::twopass
int twopass
Definition: nvenc.h:272
PRESET_SLOW
@ PRESET_SLOW
Definition: nvenc.h:145
hwconfig.h
NvencContext::b_adapt
int b_adapt
Definition: nvenc.h:280
NvencContext::multiview
int multiview
Definition: nvenc.h:321
PRESET_LOSSLESS_DEFAULT
@ PRESET_LOSSLESS_DEFAULT
Definition: nvenc.h:154
NvencContext::zerolatency
int zerolatency
Definition: nvenc.h:282
NvencContext::multipass
int multipass
Definition: nvenc.h:304
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
NvencContext::output_surface_ready_queue
AVFifo * output_surface_ready_queue
Definition: nvenc.h:235
NvencContext::extra_sei
int extra_sei
Definition: nvenc.h:306
NvencContext::highbitdepth
int highbitdepth
Definition: nvenc.h:312
opt.h
NV_ENC_H264_PROFILE_MAIN
@ NV_ENC_H264_PROFILE_MAIN
Definition: nvenc.h:169
NvencContext::bluray_compat
int bluray_compat
Definition: nvenc.h:288
NvencContext::preset
int preset
Definition: nvenc.h:264
NVENC_RGB_MODE_444
@ NVENC_RGB_MODE_444
Definition: nvenc.h:208
NvencContext::cll
int cll
Definition: nvenc.h:319
NvencContext::mdm
int mdm
Definition: nvenc.h:319
NvencContext
Definition: nvenc.h:211
int64_t
long long int64_t
Definition: coverity.c:34
NVENC_RGB_MODE_DISABLED
@ NVENC_RGB_MODE_DISABLED
Definition: nvenc.h:206
NvencContext::frame_data_array_nb
int frame_data_array_nb
Definition: nvenc.h:230
NvencSurface::in_ref
AVFrame * in_ref
Definition: nvenc.h:116
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:421
NvencContext::nb_surfaces
int nb_surfaces
Definition: nvenc.h:226
NVENC_TWO_PASSES
@ NVENC_TWO_PASSES
Definition: nvenc.h:195
NvencContext::ptr_index
int ptr_index
Definition: nvenc.h:246
NvencContext::encode_config
NV_ENC_CONFIG encode_config
Definition: nvenc.h:218
NvencFrameData
Definition: nvenc.h:126
NvencContext::nvenc_dload_funcs
NvencDynLoadFunctions nvenc_dload_funcs
Definition: nvenc.h:215
NvencContext::rgb_mode
int rgb_mode
Definition: nvenc.h:314
NvencSurface
Definition: nvenc.h:113
NvencContext::profile
int profile
Definition: nvenc.h:265
NvencContext::output_frame_num
uint64_t output_frame_num
Definition: nvenc.h:238
NVENC_RGB_MODE_420
@ NVENC_RGB_MODE_420
Definition: nvenc.h:207
NvencContext::next_view_id
uint32_t next_view_id
Definition: nvenc.h:262
NvencContext::regptr
NV_ENC_REGISTERED_PTR regptr
Definition: nvenc.h:247
NvencContext::tile_cols
int tile_cols
Definition: nvenc.h:271
NvencContext::no_scenecut
int no_scenecut
Definition: nvenc.h:278
NvencContext::qmax
int qmax
Definition: nvenc.h:290
NvencContext::cbr
int cbr
Definition: nvenc.h:269
NvencContext::single_slice_intra_refresh
int single_slice_intra_refresh
Definition: nvenc.h:308
NvencDynLoadFunctions::nvenc_device_count
int nvenc_device_count
Definition: nvenc.h:140
fifo.h
NvencContext::frame_idx_counter
uint32_t frame_idx_counter
Definition: nvenc.h:261
NvencContext::nvencoder
void * nvencoder
Definition: nvenc.h:259
NvencContext::temporal_aq
int temporal_aq
Definition: nvenc.h:281
LIST_DEVICES
@ LIST_DEVICES
Definition: nvenc.h:201
NvencContext::sei_data_size
int sei_data_size
Definition: nvenc.h:242
PRESET_HP
@ PRESET_HP
Definition: nvenc.h:148
NvencSurface::format
NV_ENC_BUFFER_FORMAT format
Definition: nvenc.h:123
NvencContext::init_encode_params
NV_ENC_INITIALIZE_PARAMS init_encode_params
Definition: nvenc.h:217
NV_ENC_HEVC_PROFILE_MAIN_10
@ NV_ENC_HEVC_PROFILE_MAIN_10
Definition: nvenc.h:182
NV_ENC_H264_PROFILE_HIGH
@ NV_ENC_H264_PROFILE_HIGH
Definition: nvenc.h:170
NvencContext::cu_stream
CUstream cu_stream
Definition: nvenc.h:221
NV_ENC_HEVC_PROFILE_COUNT
@ NV_ENC_HEVC_PROFILE_COUNT
Definition: nvenc.h:188
NV_ENC_H264_PROFILE_HIGH_444P
@ NV_ENC_H264_PROFILE_HIGH_444P
Definition: nvenc.h:177
NvencContext::device
int device
Definition: nvenc.h:273
NvencContext::cbr_padding
int cbr_padding
Definition: nvenc.h:320
NVENC_LOSSLESS
@ NVENC_LOSSLESS
Definition: nvenc.h:193
pkt
AVPacket * pkt
Definition: movenc.c:60
NvencContext::surfaces
NvencSurface * surfaces
Definition: nvenc.h:227
NvencFrameData::frame_opaque
void * frame_opaque
Definition: nvenc.h:130
NvencContext::b_ref_mode
int b_ref_mode
Definition: nvenc.h:299
NvencContext::lookahead_level
int lookahead_level
Definition: nvenc.h:316
NvencContext::max_slice_size
int max_slice_size
Definition: nvenc.h:313
NvencContext::cu_context
CUcontext cu_context
Definition: nvenc.h:219
NvencDynLoadFunctions
Definition: nvenc.h:134
NvencContext::intra_refresh
int intra_refresh
Definition: nvenc.h:307
NvencContext::ldkfs
int ldkfs
Definition: nvenc.h:305
NvencFrameData::duration
int64_t duration
Definition: nvenc.h:128
NV_ENC_HEVC_PROFILE_REXT
@ NV_ENC_HEVC_PROFILE_REXT
Definition: nvenc.h:183
NvencContext::display_sei_sent
int display_sei_sent
Definition: nvenc.h:322
PRESET_LOW_LATENCY_DEFAULT
@ PRESET_LOW_LATENCY_DEFAULT
Definition: nvenc.h:151
NvencContext::dpb_size
int dpb_size
Definition: nvenc.h:302
NvencContext::cqp
int cqp
Definition: nvenc.h:294
NvencDynLoadFunctions::nvenc_dl
NvencFunctions * nvenc_dl
Definition: nvenc.h:137
NvencSurface::pitch
int pitch
Definition: nvenc.h:120
NvencSurface::input_surface
NV_ENC_INPUT_PTR input_surface
Definition: nvenc.h:115
NvencContext::split_encode_mode
int split_encode_mode
Definition: nvenc.h:318
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:76
NvencFrameData::frame_opaque_ref
AVBufferRef * frame_opaque_ref
Definition: nvenc.h:131
NvencSurface::reg_idx
int reg_idx
Definition: nvenc.h:117
NvencContext::s12m_tc
int s12m_tc
Definition: nvenc.h:301
NvencContext::tile_rows
int tile_rows
Definition: nvenc.h:270
NvencContext::initial_delay_time
int64_t initial_delay_time
Definition: nvenc.h:239
NVENC_LOWLATENCY
@ NVENC_LOWLATENCY
Definition: nvenc.h:192
NV_ENC_H264_PROFILE_BASELINE
@ NV_ENC_H264_PROFILE_BASELINE
Definition: nvenc.h:168
NvencDynLoadFunctions::cuda_dl
CudaFunctions * cuda_dl
Definition: nvenc.h:136
PRESET_FAST
@ PRESET_FAST
Definition: nvenc.h:147
NvencContext::avclass
AVClass * avclass
Definition: nvenc.h:213
NvencContext::aq
int aq
Definition: nvenc.h:277
ff_nvenc_encode_init
int ff_nvenc_encode_init(AVCodecContext *avctx)
Definition: nvenc.c:2248
NV_ENC_HEVC_PROFILE_MAIN
@ NV_ENC_HEVC_PROFILE_MAIN
Definition: nvenc.h:181
PRESET_MEDIUM
@ PRESET_MEDIUM
Definition: nvenc.h:146
NvencContext::constrained_encoding
int constrained_encoding
Definition: nvenc.h:309
NvencContext::in_map
NV_ENC_MAP_INPUT_RESOURCE in_map
Definition: nvenc.h:249
PRESET_LOW_LATENCY_HQ
@ PRESET_LOW_LATENCY_HQ
Definition: nvenc.h:152
NvencContext::frame
AVFrame * frame
Definition: nvenc.h:224
NvencContext::qp_cb_offset
int qp_cb_offset
Definition: nvenc.h:295
AVFifo
Definition: fifo.c:35
MAX_REGISTERED_FRAMES
#define MAX_REGISTERED_FRAMES
Definition: nvenc.h:41
NvencContext::init_qp_b
int init_qp_b
Definition: nvenc.h:292
NvencContext::data_pix_fmt
enum AVPixelFormat data_pix_fmt
Definition: nvenc.h:255
NvencContext::sei_data
NV_ENC_SEI_PAYLOAD * sei_data
Definition: nvenc.h:241
NvencContext::quality
float quality
Definition: nvenc.h:286
NvencContext::aq_strength
int aq_strength
Definition: nvenc.h:285
AVCodecHWConfigInternal
Definition: hwconfig.h:25
NvencContext::flags
int flags
Definition: nvenc.h:274
buffer.h
NvencContext::output_surface_queue
AVFifo * output_surface_queue
Definition: nvenc.h:234
NVENC_DEPRECATED_PRESET
@ NVENC_DEPRECATED_PRESET
Definition: nvenc.h:197
NvencContext::support_dyn_bitrate
int support_dyn_bitrate
Definition: nvenc.h:257
NvencContext::registered_frames
struct NvencContext::@220 registered_frames[MAX_REGISTERED_FRAMES]
PRESET_LOSSLESS_HP
@ PRESET_LOSSLESS_HP
Definition: nvenc.h:155
NvencContext::init_qp_i
int init_qp_i
Definition: nvenc.h:293
NvencContext::a53_cc
int a53_cc
Definition: nvenc.h:300
NvencContext::unidir_b
int unidir_b
Definition: nvenc.h:317
ff_nvenc_encode_flush
void ff_nvenc_encode_flush(AVCodecContext *avctx)
Definition: nvenc.c:3324
NvencContext::qp_cr_offset
int qp_cr_offset
Definition: nvenc.h:296
NvencContext::ptr
void * ptr
Definition: nvenc.h:245
PRESET_DEFAULT
@ PRESET_DEFAULT
Definition: nvenc.h:144
NvencContext::init_qp_p
int init_qp_p
Definition: nvenc.h:291
NvencContext::forced_idr
int forced_idr
Definition: nvenc.h:279
NvencContext::timestamp_list
AVFifo * timestamp_list
Definition: nvenc.h:236
NvencContext::rc
int rc
Definition: nvenc.h:268
NvencContext::frame_data_array
NvencFrameData * frame_data_array
Definition: nvenc.h:229
NvencContext::rc_lookahead
int rc_lookahead
Definition: nvenc.h:276
NvencContext::nonref_p
int nonref_p
Definition: nvenc.h:283
NVENC_ONE_PASS
@ NVENC_ONE_PASS
Definition: nvenc.h:194
PRESET_BD
@ PRESET_BD
Definition: nvenc.h:150
NvencSurface::width
int width
Definition: nvenc.h:118
avcodec.h
ff_nvenc_receive_packet
int ff_nvenc_receive_packet(AVCodecContext *avctx, AVPacket *pkt)
Definition: nvenc.c:3273
NvencContext::mapped
int mapped
Definition: nvenc.h:248
NvencContext::level
int level
Definition: nvenc.h:266
PRESET_LOW_LATENCY_HP
@ PRESET_LOW_LATENCY_HP
Definition: nvenc.h:153
PRESET_HQ
@ PRESET_HQ
Definition: nvenc.h:149
NvencContext::qmin
int qmin
Definition: nvenc.h:289
NvencContext::weighted_pred
int weighted_pred
Definition: nvenc.h:297
NvencContext::tuning_info
int tuning_info
Definition: nvenc.h:303
AVCodecContext
main external API structure.
Definition: avcodec.h:431
ff_nvenc_encode_close
int ff_nvenc_encode_close(AVCodecContext *avctx)
Definition: nvenc.c:2163
NvencSurface::height
int height
Definition: nvenc.h:119
NvencContext::frame_data_array_pos
int frame_data_array_pos
Definition: nvenc.h:231
NvencSurface::output_surface
NV_ENC_OUTPUT_PTR output_surface
Definition: nvenc.h:122
NvencContext::async_depth
int async_depth
Definition: nvenc.h:275
NvencContext::tf_level
int tf_level
Definition: nvenc.h:315
NvencDynLoadFunctions::nvenc_funcs
NV_ENCODE_API_FUNCTION_LIST nvenc_funcs
Definition: nvenc.h:139
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
NvencContext::udu_sei
int udu_sei
Definition: nvenc.h:310
NvencContext::nb_registered_frames
int nb_registered_frames
Definition: nvenc.h:251
NvencContext::aud
int aud
Definition: nvenc.h:287
NvencContext::coder
int coder
Definition: nvenc.h:298
AVPacket
This structure stores compressed data.
Definition: packet.h:529
NvencContext::multiview_supported
int multiview_supported
Definition: nvenc.h:321
NvencContext::tier
int tier
Definition: nvenc.h:267
ff_nvenc_pix_fmts
enum AVPixelFormat ff_nvenc_pix_fmts[]
Definition: nvenc.c:60
ID3D11Device
void ID3D11Device
Definition: nvenc.h:28
NvencContext::unused_surface_queue
AVFifo * unused_surface_queue
Definition: nvenc.h:233
NvencContext::cu_context_internal
CUcontext cu_context_internal
Definition: nvenc.h:220
NvencContext::strict_gop
int strict_gop
Definition: nvenc.h:284
hwcontext_d3d11va.h
NvencContext::timing_info
int timing_info
Definition: nvenc.h:311
ff_nvenc_hw_configs
const AVCodecHWConfigInternal *const ff_nvenc_hw_configs[]
Definition: nvenc.c:89
NvencContext::d3d11_device
ID3D11Device * d3d11_device
Definition: nvenc.h:222