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 #endif
65 
66 // SDK 10.0 compile time feature checks
67 #if NVENCAPI_CHECK_VERSION(10, 0)
68 #define NVENC_HAVE_NEW_PRESETS
69 #define NVENC_HAVE_MULTIPASS
70 #define NVENC_HAVE_LDKFS
71 #define NVENC_HAVE_H264_LVL6
72 #define NVENC_HAVE_HEVC_CONSTRAINED_ENCODING
73 #endif
74 
75 // SDK 11.1 compile time feature checks
76 #if NVENCAPI_CHECK_VERSION(11, 1)
77 #define NVENC_HAVE_QP_CHROMA_OFFSETS
78 #define NVENC_HAVE_SINGLE_SLICE_INTRA_REFRESH
79 #endif
80 
81 // SDK 12.1 compile time feature checks
82 #if NVENCAPI_CHECK_VERSION(12, 1)
83 #define NVENC_NO_DEPRECATED_RC
84 #endif
85 
86 typedef struct NvencSurface
87 {
88  NV_ENC_INPUT_PTR input_surface;
90  int reg_idx;
91  int width;
92  int height;
93  int pitch;
94 
95  NV_ENC_OUTPUT_PTR output_surface;
96  NV_ENC_BUFFER_FORMAT format;
97 } NvencSurface;
98 
99 typedef struct NvencFrameData
100 {
101  int64_t duration;
102 
103 #if FF_API_REORDERED_OPAQUE
104  int64_t reordered_opaque;
105 #endif
106 
110 
111 typedef struct NvencDynLoadFunctions
112 {
113  CudaFunctions *cuda_dl;
114  NvencFunctions *nvenc_dl;
115 
116  NV_ENCODE_API_FUNCTION_LIST nvenc_funcs;
119 
120 enum {
133 #ifdef NVENC_HAVE_NEW_PRESETS
134  PRESET_P1,
135  PRESET_P2,
136  PRESET_P3,
137  PRESET_P4,
138  PRESET_P5,
139  PRESET_P6,
140  PRESET_P7,
141 #endif
142 };
143 
144 enum {
149 };
150 
151 enum {
155 };
156 
157 enum {
162 
164 };
165 
166 enum {
169 };
170 
171 enum {
175 };
176 
177 typedef struct NvencContext
178 {
180 
182 
183  NV_ENC_INITIALIZE_PARAMS init_encode_params;
184  NV_ENC_CONFIG encode_config;
185  CUcontext cu_context;
187  CUstream cu_stream;
189 
191 
194 
198 
203 
204  NV_ENC_SEI_PAYLOAD *sei_data;
206 
207  struct {
208  void *ptr;
210  NV_ENC_REGISTERED_PTR regptr;
211  int mapped;
212  NV_ENC_MAP_INPUT_RESOURCE in_map;
215 
216  /* the actual data pixel format, different from
217  * AVCodecContext.pix_fmt when using hwaccel frames on input */
219 
221 
222  void *nvencoder;
223 
224  int preset;
225  int profile;
226  int level;
227  int tier;
228  int rc;
229  int cbr;
232  int twopass;
233  int device;
234  int flags;
237  int aq;
240  int b_adapt;
243  int nonref_p;
246  float quality;
247  int aud;
252  int cqp;
256  int coder;
258  int a53_cc;
259  int s12m_tc;
260  int dpb_size;
263  int ldkfs;
268  int udu_sei;
272  int rgb_mode;
273 } NvencContext;
274 
276 
278 
280 
282 
283 extern const enum AVPixelFormat ff_nvenc_pix_fmts[];
284 extern const AVCodecHWConfigInternal *const ff_nvenc_hw_configs[];
285 
286 #endif /* AVCODEC_NVENC_H */
NvencContext::twopass
int twopass
Definition: nvenc.h:232
hwconfig.h
NvencContext::b_adapt
int b_adapt
Definition: nvenc.h:240
NvencContext::zerolatency
int zerolatency
Definition: nvenc.h:242
NvencContext::multipass
int multipass
Definition: nvenc.h:262
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
NvencContext::output_surface_ready_queue
AVFifo * output_surface_ready_queue
Definition: nvenc.h:201
NvencContext::extra_sei
int extra_sei
Definition: nvenc.h:264
NvencContext::highbitdepth
int highbitdepth
Definition: nvenc.h:270
opt.h
NV_ENC_H264_PROFILE_BASELINE
@ NV_ENC_H264_PROFILE_BASELINE
Definition: nvenc.h:145
ANY_DEVICE
@ ANY_DEVICE
Definition: nvenc.h:168
NvencContext::bluray_compat
int bluray_compat
Definition: nvenc.h:248
NvencContext::preset
int preset
Definition: nvenc.h:224
NV_ENC_H264_PROFILE_MAIN
@ NV_ENC_H264_PROFILE_MAIN
Definition: nvenc.h:146
NV_ENC_H264_PROFILE_HIGH
@ NV_ENC_H264_PROFILE_HIGH
Definition: nvenc.h:147
NVENC_RGB_MODE_420
@ NVENC_RGB_MODE_420
Definition: nvenc.h:173
NVENC_DEPRECATED_PRESET
@ NVENC_DEPRECATED_PRESET
Definition: nvenc.h:163
NvencContext
Definition: nvenc.h:177
NvencContext::frame_data_array_nb
int frame_data_array_nb
Definition: nvenc.h:196
NvencSurface::in_ref
AVFrame * in_ref
Definition: nvenc.h:89
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
NVENC_LOWLATENCY
@ NVENC_LOWLATENCY
Definition: nvenc.h:158
NV_ENC_HEVC_PROFILE_MAIN
@ NV_ENC_HEVC_PROFILE_MAIN
Definition: nvenc.h:152
NvencContext::nb_surfaces
int nb_surfaces
Definition: nvenc.h:192
PRESET_LOW_LATENCY_HP
@ PRESET_LOW_LATENCY_HP
Definition: nvenc.h:130
NvencContext::ptr_index
int ptr_index
Definition: nvenc.h:209
NvencContext::encode_config
NV_ENC_CONFIG encode_config
Definition: nvenc.h:184
NvencFrameData
Definition: nvenc.h:99
NvencContext::nvenc_dload_funcs
NvencDynLoadFunctions nvenc_dload_funcs
Definition: nvenc.h:181
NvencContext::rgb_mode
int rgb_mode
Definition: nvenc.h:272
NvencSurface
Definition: nvenc.h:86
NvencContext::profile
int profile
Definition: nvenc.h:225
PRESET_BD
@ PRESET_BD
Definition: nvenc.h:127
NVENC_RGB_MODE_DISABLED
@ NVENC_RGB_MODE_DISABLED
Definition: nvenc.h:172
NvencContext::regptr
NV_ENC_REGISTERED_PTR regptr
Definition: nvenc.h:210
NvencContext::tile_cols
int tile_cols
Definition: nvenc.h:231
NvencContext::no_scenecut
int no_scenecut
Definition: nvenc.h:238
NvencContext::cbr
int cbr
Definition: nvenc.h:229
NvencContext::single_slice_intra_refresh
int single_slice_intra_refresh
Definition: nvenc.h:266
NvencDynLoadFunctions::nvenc_device_count
int nvenc_device_count
Definition: nvenc.h:117
fifo.h
NvencContext::nvencoder
void * nvencoder
Definition: nvenc.h:222
NvencContext::temporal_aq
int temporal_aq
Definition: nvenc.h:241
NvencContext::sei_data_size
int sei_data_size
Definition: nvenc.h:205
PRESET_LOW_LATENCY_DEFAULT
@ PRESET_LOW_LATENCY_DEFAULT
Definition: nvenc.h:128
NvencSurface::format
NV_ENC_BUFFER_FORMAT format
Definition: nvenc.h:96
NvencContext::init_encode_params
NV_ENC_INITIALIZE_PARAMS init_encode_params
Definition: nvenc.h:183
NV_ENC_HEVC_PROFILE_REXT
@ NV_ENC_HEVC_PROFILE_REXT
Definition: nvenc.h:154
NvencContext::cu_stream
CUstream cu_stream
Definition: nvenc.h:187
NVENC_RGB_MODE_444
@ NVENC_RGB_MODE_444
Definition: nvenc.h:174
PRESET_SLOW
@ PRESET_SLOW
Definition: nvenc.h:122
PRESET_LOW_LATENCY_HQ
@ PRESET_LOW_LATENCY_HQ
Definition: nvenc.h:129
NvencContext::device
int device
Definition: nvenc.h:233
PRESET_HQ
@ PRESET_HQ
Definition: nvenc.h:126
pkt
AVPacket * pkt
Definition: movenc.c:59
NvencContext::surfaces
NvencSurface * surfaces
Definition: nvenc.h:193
NvencFrameData::frame_opaque
void * frame_opaque
Definition: nvenc.h:107
NvencContext::b_ref_mode
int b_ref_mode
Definition: nvenc.h:257
NvencContext::max_slice_size
int max_slice_size
Definition: nvenc.h:271
NvencContext::cu_context
CUcontext cu_context
Definition: nvenc.h:185
NvencDynLoadFunctions
Definition: nvenc.h:111
NvencContext::intra_refresh
int intra_refresh
Definition: nvenc.h:265
NvencContext::ldkfs
int ldkfs
Definition: nvenc.h:263
NvencFrameData::duration
int64_t duration
Definition: nvenc.h:101
NvencContext::dpb_size
int dpb_size
Definition: nvenc.h:260
NvencContext::cqp
int cqp
Definition: nvenc.h:252
NvencDynLoadFunctions::nvenc_dl
NvencFunctions * nvenc_dl
Definition: nvenc.h:114
NvencSurface::pitch
int pitch
Definition: nvenc.h:93
NvencSurface::input_surface
NV_ENC_INPUT_PTR input_surface
Definition: nvenc.h:88
NV_ENC_HEVC_PROFILE_MAIN_10
@ NV_ENC_HEVC_PROFILE_MAIN_10
Definition: nvenc.h:153
NvencContext::registered_frames
struct NvencContext::@131 registered_frames[MAX_REGISTERED_FRAMES]
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NvencFrameData::frame_opaque_ref
AVBufferRef * frame_opaque_ref
Definition: nvenc.h:108
NvencSurface::reg_idx
int reg_idx
Definition: nvenc.h:90
NvencContext::s12m_tc
int s12m_tc
Definition: nvenc.h:259
NvencContext::tile_rows
int tile_rows
Definition: nvenc.h:230
NvencDynLoadFunctions::cuda_dl
CudaFunctions * cuda_dl
Definition: nvenc.h:113
NvencContext::avclass
AVClass * avclass
Definition: nvenc.h:179
NvencContext::aq
int aq
Definition: nvenc.h:237
ff_nvenc_encode_init
int ff_nvenc_encode_init(AVCodecContext *avctx)
Definition: nvenc.c:1939
NV_ENC_H264_PROFILE_HIGH_444P
@ NV_ENC_H264_PROFILE_HIGH_444P
Definition: nvenc.h:148
NvencContext::constrained_encoding
int constrained_encoding
Definition: nvenc.h:267
NvencContext::in_map
NV_ENC_MAP_INPUT_RESOURCE in_map
Definition: nvenc.h:212
NvencContext::frame
AVFrame * frame
Definition: nvenc.h:190
NvencContext::qp_cb_offset
int qp_cb_offset
Definition: nvenc.h:253
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:250
NvencContext::data_pix_fmt
enum AVPixelFormat data_pix_fmt
Definition: nvenc.h:218
NvencContext::sei_data
NV_ENC_SEI_PAYLOAD * sei_data
Definition: nvenc.h:204
NvencContext::quality
float quality
Definition: nvenc.h:246
NvencContext::aq_strength
int aq_strength
Definition: nvenc.h:245
PRESET_FAST
@ PRESET_FAST
Definition: nvenc.h:124
AVCodecHWConfigInternal
Definition: hwconfig.h:25
NvencContext::flags
int flags
Definition: nvenc.h:234
buffer.h
NvencContext::output_surface_queue
AVFifo * output_surface_queue
Definition: nvenc.h:200
NvencContext::support_dyn_bitrate
int support_dyn_bitrate
Definition: nvenc.h:220
PRESET_LOSSLESS_DEFAULT
@ PRESET_LOSSLESS_DEFAULT
Definition: nvenc.h:131
NvencContext::init_qp_i
int init_qp_i
Definition: nvenc.h:251
NvencContext::a53_cc
int a53_cc
Definition: nvenc.h:258
ff_nvenc_encode_flush
void ff_nvenc_encode_flush(AVCodecContext *avctx)
Definition: nvenc.c:2802
NvencContext::qp_cr_offset
int qp_cr_offset
Definition: nvenc.h:254
NvencContext::ptr
void * ptr
Definition: nvenc.h:208
NvencContext::init_qp_p
int init_qp_p
Definition: nvenc.h:249
NvencContext::forced_idr
int forced_idr
Definition: nvenc.h:239
NvencContext::timestamp_list
AVFifo * timestamp_list
Definition: nvenc.h:202
NvencContext::rc
int rc
Definition: nvenc.h:228
NvencContext::frame_data_array
NvencFrameData * frame_data_array
Definition: nvenc.h:195
NvencContext::rc_lookahead
int rc_lookahead
Definition: nvenc.h:236
NvencContext::nonref_p
int nonref_p
Definition: nvenc.h:243
NvencSurface::width
int width
Definition: nvenc.h:91
avcodec.h
ff_nvenc_receive_packet
int ff_nvenc_receive_packet(AVCodecContext *avctx, AVPacket *pkt)
Definition: nvenc.c:2751
NvencContext::mapped
int mapped
Definition: nvenc.h:211
NvencContext::level
int level
Definition: nvenc.h:226
NvencContext::weighted_pred
int weighted_pred
Definition: nvenc.h:255
NvencContext::tuning_info
int tuning_info
Definition: nvenc.h:261
AVCodecContext
main external API structure.
Definition: avcodec.h:445
ff_nvenc_encode_close
int ff_nvenc_encode_close(AVCodecContext *avctx)
Definition: nvenc.c:1854
NvencSurface::height
int height
Definition: nvenc.h:92
NVENC_LOSSLESS
@ NVENC_LOSSLESS
Definition: nvenc.h:159
NvencContext::frame_data_array_pos
int frame_data_array_pos
Definition: nvenc.h:197
NvencSurface::output_surface
NV_ENC_OUTPUT_PTR output_surface
Definition: nvenc.h:95
NvencContext::async_depth
int async_depth
Definition: nvenc.h:235
PRESET_MEDIUM
@ PRESET_MEDIUM
Definition: nvenc.h:123
NvencDynLoadFunctions::nvenc_funcs
NV_ENCODE_API_FUNCTION_LIST nvenc_funcs
Definition: nvenc.h:116
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
PRESET_DEFAULT
@ PRESET_DEFAULT
Definition: nvenc.h:121
NvencContext::udu_sei
int udu_sei
Definition: nvenc.h:268
NvencContext::nb_registered_frames
int nb_registered_frames
Definition: nvenc.h:214
NvencContext::aud
int aud
Definition: nvenc.h:247
NVENC_TWO_PASSES
@ NVENC_TWO_PASSES
Definition: nvenc.h:161
NvencContext::coder
int coder
Definition: nvenc.h:256
AVPacket
This structure stores compressed data.
Definition: packet.h:499
NvencContext::tier
int tier
Definition: nvenc.h:227
LIST_DEVICES
@ LIST_DEVICES
Definition: nvenc.h:167
ff_nvenc_pix_fmts
enum AVPixelFormat ff_nvenc_pix_fmts[]
Definition: nvenc.c:56
PRESET_HP
@ PRESET_HP
Definition: nvenc.h:125
ID3D11Device
void ID3D11Device
Definition: nvenc.h:28
PRESET_LOSSLESS_HP
@ PRESET_LOSSLESS_HP
Definition: nvenc.h:132
NvencContext::unused_surface_queue
AVFifo * unused_surface_queue
Definition: nvenc.h:199
NvencContext::cu_context_internal
CUcontext cu_context_internal
Definition: nvenc.h:186
NvencContext::strict_gop
int strict_gop
Definition: nvenc.h:244
hwcontext_d3d11va.h
NvencContext::timing_info
int timing_info
Definition: nvenc.h:269
ff_nvenc_hw_configs
const AVCodecHWConfigInternal *const ff_nvenc_hw_configs[]
Definition: nvenc.c:78
NVENC_ONE_PASS
@ NVENC_ONE_PASS
Definition: nvenc.h:160
NvencContext::d3d11_device
ID3D11Device * d3d11_device
Definition: nvenc.h:188