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/fifo.h"
35 #include "libavutil/opt.h"
36 #include "hwconfig.h"
37 
38 #include "avcodec.h"
39 
40 #define MAX_REGISTERED_FRAMES 64
41 #define RC_MODE_DEPRECATED 0x800000
42 #define RCD(rc_mode) ((rc_mode) | RC_MODE_DEPRECATED)
43 
44 #define NVENCAPI_CHECK_VERSION(major, minor) \
45  ((major) < NVENCAPI_MAJOR_VERSION || ((major) == NVENCAPI_MAJOR_VERSION && (minor) <= NVENCAPI_MINOR_VERSION))
46 
47 // SDK 8.1 compile time feature checks
48 #if NVENCAPI_CHECK_VERSION(8, 1)
49 #define NVENC_HAVE_BFRAME_REF_MODE
50 #define NVENC_HAVE_QP_MAP_MODE
51 #endif
52 
53 // SDK 9.0 compile time feature checks
54 #if NVENCAPI_CHECK_VERSION(9, 0)
55 #define NVENC_HAVE_HEVC_BFRAME_REF_MODE
56 #endif
57 
58 // SDK 9.1 compile time feature checks
59 #if NVENCAPI_CHECK_VERSION(9, 1)
60 #define NVENC_HAVE_MULTIPLE_REF_FRAMES
61 #define NVENC_HAVE_CUSTREAM_PTR
62 #define NVENC_HAVE_GETLASTERRORSTRING
63 #endif
64 
65 // SDK 10.0 compile time feature checks
66 #if NVENCAPI_CHECK_VERSION(10, 0)
67 #define NVENC_HAVE_NEW_PRESETS
68 #define NVENC_HAVE_MULTIPASS
69 #define NVENC_HAVE_LDKFS
70 #define NVENC_HAVE_H264_LVL6
71 #define NVENC_HAVE_HEVC_CONSTRAINED_ENCODING
72 #endif
73 
74 // SDK 11.1 compile time feature checks
75 #if NVENCAPI_CHECK_VERSION(11, 1)
76 #define NVENC_HAVE_QP_CHROMA_OFFSETS
77 #define NVENC_HAVE_SINGLE_SLICE_INTRA_REFRESH
78 #endif
79 
80 typedef struct NvencSurface
81 {
82  NV_ENC_INPUT_PTR input_surface;
84  int reg_idx;
85  int width;
86  int height;
87  int pitch;
88 
89  NV_ENC_OUTPUT_PTR output_surface;
90  NV_ENC_BUFFER_FORMAT format;
91 } NvencSurface;
92 
93 typedef struct NvencDynLoadFunctions
94 {
95  CudaFunctions *cuda_dl;
96  NvencFunctions *nvenc_dl;
97 
98  NV_ENCODE_API_FUNCTION_LIST nvenc_funcs;
101 
102 enum {
115 #ifdef NVENC_HAVE_NEW_PRESETS
116  PRESET_P1,
117  PRESET_P2,
118  PRESET_P3,
119  PRESET_P4,
120  PRESET_P5,
121  PRESET_P6,
122  PRESET_P7,
123 #endif
124 };
125 
126 enum {
131 };
132 
133 enum {
137 };
138 
139 enum {
144 
146 };
147 
148 enum {
151 };
152 
153 typedef struct NvencContext
154 {
156 
158 
159  NV_ENC_INITIALIZE_PARAMS init_encode_params;
160  NV_ENC_CONFIG encode_config;
161  CUcontext cu_context;
163  CUstream cu_stream;
165 
167 
170 
175 
176  NV_ENC_SEI_PAYLOAD *sei_data;
178 
179  struct {
180  void *ptr;
182  NV_ENC_REGISTERED_PTR regptr;
183  int mapped;
184  NV_ENC_MAP_INPUT_RESOURCE in_map;
187 
188  /* the actual data pixel format, different from
189  * AVCodecContext.pix_fmt when using hwaccel frames on input */
191 
193 
194  void *nvencoder;
195 
196  int preset;
197  int profile;
198  int level;
199  int tier;
200  int rc;
201  int cbr;
202  int twopass;
203  int device;
204  int flags;
207  int aq;
210  int b_adapt;
213  int nonref_p;
216  float quality;
217  int aud;
222  int cqp;
226  int coder;
228  int a53_cc;
229  int s12m_tc;
230  int dpb_size;
233  int ldkfs;
238 } NvencContext;
239 
241 
243 
245 
247 
248 extern const enum AVPixelFormat ff_nvenc_pix_fmts[];
249 extern const AVCodecHWConfigInternal *const ff_nvenc_hw_configs[];
250 
251 #endif /* AVCODEC_NVENC_H */
NvencContext::twopass
int twopass
Definition: nvenc.h:202
hwconfig.h
NvencContext::b_adapt
int b_adapt
Definition: nvenc.h:210
NvencContext::zerolatency
int zerolatency
Definition: nvenc.h:212
NvencContext::multipass
int multipass
Definition: nvenc.h:232
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
NvencContext::extra_sei
int extra_sei
Definition: nvenc.h:234
NvencContext::output_surface_ready_queue
AVFifoBuffer * output_surface_ready_queue
Definition: nvenc.h:173
opt.h
NvencContext::bluray_compat
int bluray_compat
Definition: nvenc.h:218
NvencContext::preset
int preset
Definition: nvenc.h:196
PRESET_LOSSLESS_HP
@ PRESET_LOSSLESS_HP
Definition: nvenc.h:114
NvencContext
Definition: nvenc.h:153
NvencSurface::in_ref
AVFrame * in_ref
Definition: nvenc.h:83
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
NvencContext::nb_surfaces
int nb_surfaces
Definition: nvenc.h:168
NvencContext::ptr_index
int ptr_index
Definition: nvenc.h:181
NvencContext::encode_config
NV_ENC_CONFIG encode_config
Definition: nvenc.h:160
NvencContext::nvenc_dload_funcs
NvencDynLoadFunctions nvenc_dload_funcs
Definition: nvenc.h:157
NV_ENC_H264_PROFILE_BASELINE
@ NV_ENC_H264_PROFILE_BASELINE
Definition: nvenc.h:127
NvencSurface
Definition: nvenc.h:80
NvencContext::profile
int profile
Definition: nvenc.h:197
PRESET_SLOW
@ PRESET_SLOW
Definition: nvenc.h:104
NvencContext::regptr
NV_ENC_REGISTERED_PTR regptr
Definition: nvenc.h:182
NV_ENC_H264_PROFILE_HIGH_444P
@ NV_ENC_H264_PROFILE_HIGH_444P
Definition: nvenc.h:130
NV_ENC_H264_PROFILE_MAIN
@ NV_ENC_H264_PROFILE_MAIN
Definition: nvenc.h:128
AVFifoBuffer
Definition: fifo.h:31
NvencContext::no_scenecut
int no_scenecut
Definition: nvenc.h:208
NvencContext::cbr
int cbr
Definition: nvenc.h:201
NVENC_TWO_PASSES
@ NVENC_TWO_PASSES
Definition: nvenc.h:143
NvencContext::single_slice_intra_refresh
int single_slice_intra_refresh
Definition: nvenc.h:236
NvencDynLoadFunctions::nvenc_device_count
int nvenc_device_count
Definition: nvenc.h:99
fifo.h
NvencContext::nvencoder
void * nvencoder
Definition: nvenc.h:194
NvencContext::temporal_aq
int temporal_aq
Definition: nvenc.h:211
PRESET_LOW_LATENCY_HP
@ PRESET_LOW_LATENCY_HP
Definition: nvenc.h:112
NvencContext::sei_data_size
int sei_data_size
Definition: nvenc.h:177
NvencSurface::format
NV_ENC_BUFFER_FORMAT format
Definition: nvenc.h:90
NvencContext::init_encode_params
NV_ENC_INITIALIZE_PARAMS init_encode_params
Definition: nvenc.h:159
NvencContext::cu_stream
CUstream cu_stream
Definition: nvenc.h:163
NvencContext::device
int device
Definition: nvenc.h:203
pkt
AVPacket * pkt
Definition: movenc.c:59
NvencContext::surfaces
NvencSurface * surfaces
Definition: nvenc.h:169
PRESET_BD
@ PRESET_BD
Definition: nvenc.h:109
NvencContext::b_ref_mode
int b_ref_mode
Definition: nvenc.h:227
NvencContext::cu_context
CUcontext cu_context
Definition: nvenc.h:161
PRESET_LOSSLESS_DEFAULT
@ PRESET_LOSSLESS_DEFAULT
Definition: nvenc.h:113
PRESET_LOW_LATENCY_DEFAULT
@ PRESET_LOW_LATENCY_DEFAULT
Definition: nvenc.h:110
NvencDynLoadFunctions
Definition: nvenc.h:93
NvencContext::intra_refresh
int intra_refresh
Definition: nvenc.h:235
NvencContext::ldkfs
int ldkfs
Definition: nvenc.h:233
NV_ENC_H264_PROFILE_HIGH
@ NV_ENC_H264_PROFILE_HIGH
Definition: nvenc.h:129
NvencContext::dpb_size
int dpb_size
Definition: nvenc.h:230
NvencContext::cqp
int cqp
Definition: nvenc.h:222
NvencDynLoadFunctions::nvenc_dl
NvencFunctions * nvenc_dl
Definition: nvenc.h:96
PRESET_DEFAULT
@ PRESET_DEFAULT
Definition: nvenc.h:103
NvencSurface::pitch
int pitch
Definition: nvenc.h:87
NvencSurface::input_surface
NV_ENC_INPUT_PTR input_surface
Definition: nvenc.h:82
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NvencSurface::reg_idx
int reg_idx
Definition: nvenc.h:84
NV_ENC_HEVC_PROFILE_MAIN_10
@ NV_ENC_HEVC_PROFILE_MAIN_10
Definition: nvenc.h:135
NvencContext::s12m_tc
int s12m_tc
Definition: nvenc.h:229
NVENC_LOWLATENCY
@ NVENC_LOWLATENCY
Definition: nvenc.h:140
NvencDynLoadFunctions::cuda_dl
CudaFunctions * cuda_dl
Definition: nvenc.h:95
NvencContext::avclass
AVClass * avclass
Definition: nvenc.h:155
PRESET_HP
@ PRESET_HP
Definition: nvenc.h:107
NvencContext::aq
int aq
Definition: nvenc.h:207
ff_nvenc_encode_init
int ff_nvenc_encode_init(AVCodecContext *avctx)
Definition: nvenc.c:1729
PRESET_HQ
@ PRESET_HQ
Definition: nvenc.h:108
NvencContext::constrained_encoding
int constrained_encoding
Definition: nvenc.h:237
NvencContext::in_map
NV_ENC_MAP_INPUT_RESOURCE in_map
Definition: nvenc.h:184
NvencContext::frame
AVFrame * frame
Definition: nvenc.h:166
NvencContext::qp_cb_offset
int qp_cb_offset
Definition: nvenc.h:223
NvencContext::timestamp_list
AVFifoBuffer * timestamp_list
Definition: nvenc.h:174
MAX_REGISTERED_FRAMES
#define MAX_REGISTERED_FRAMES
Definition: nvenc.h:40
NvencContext::init_qp_b
int init_qp_b
Definition: nvenc.h:220
NvencContext::data_pix_fmt
enum AVPixelFormat data_pix_fmt
Definition: nvenc.h:190
NvencContext::sei_data
NV_ENC_SEI_PAYLOAD * sei_data
Definition: nvenc.h:176
NvencContext::quality
float quality
Definition: nvenc.h:216
NvencContext::aq_strength
int aq_strength
Definition: nvenc.h:215
LIST_DEVICES
@ LIST_DEVICES
Definition: nvenc.h:149
AVCodecHWConfigInternal
Definition: hwconfig.h:29
NvencContext::flags
int flags
Definition: nvenc.h:204
NVENC_ONE_PASS
@ NVENC_ONE_PASS
Definition: nvenc.h:142
NvencContext::support_dyn_bitrate
int support_dyn_bitrate
Definition: nvenc.h:192
NvencContext::init_qp_i
int init_qp_i
Definition: nvenc.h:221
NvencContext::a53_cc
int a53_cc
Definition: nvenc.h:228
PRESET_MEDIUM
@ PRESET_MEDIUM
Definition: nvenc.h:105
ff_nvenc_encode_flush
void ff_nvenc_encode_flush(AVCodecContext *avctx)
Definition: nvenc.c:2508
NvencContext::qp_cr_offset
int qp_cr_offset
Definition: nvenc.h:224
NvencContext::ptr
void * ptr
Definition: nvenc.h:180
NvencContext::init_qp_p
int init_qp_p
Definition: nvenc.h:219
NvencContext::forced_idr
int forced_idr
Definition: nvenc.h:209
NvencContext::rc
int rc
Definition: nvenc.h:200
NvencContext::rc_lookahead
int rc_lookahead
Definition: nvenc.h:206
NvencContext::nonref_p
int nonref_p
Definition: nvenc.h:213
NvencContext::unused_surface_queue
AVFifoBuffer * unused_surface_queue
Definition: nvenc.h:171
NV_ENC_HEVC_PROFILE_REXT
@ NV_ENC_HEVC_PROFILE_REXT
Definition: nvenc.h:136
NVENC_LOSSLESS
@ NVENC_LOSSLESS
Definition: nvenc.h:141
ANY_DEVICE
@ ANY_DEVICE
Definition: nvenc.h:150
NvencSurface::width
int width
Definition: nvenc.h:85
avcodec.h
ff_nvenc_receive_packet
int ff_nvenc_receive_packet(AVCodecContext *avctx, AVPacket *pkt)
Definition: nvenc.c:2457
NvencContext::mapped
int mapped
Definition: nvenc.h:183
NvencContext::level
int level
Definition: nvenc.h:198
NVENC_DEPRECATED_PRESET
@ NVENC_DEPRECATED_PRESET
Definition: nvenc.h:145
NvencContext::weighted_pred
int weighted_pred
Definition: nvenc.h:225
NvencContext::tuning_info
int tuning_info
Definition: nvenc.h:231
AVCodecContext
main external API structure.
Definition: avcodec.h:383
ff_nvenc_encode_close
int ff_nvenc_encode_close(AVCodecContext *avctx)
Definition: nvenc.c:1650
PRESET_LOW_LATENCY_HQ
@ PRESET_LOW_LATENCY_HQ
Definition: nvenc.h:111
NvencSurface::height
int height
Definition: nvenc.h:86
NV_ENC_HEVC_PROFILE_MAIN
@ NV_ENC_HEVC_PROFILE_MAIN
Definition: nvenc.h:134
NvencSurface::output_surface
NV_ENC_OUTPUT_PTR output_surface
Definition: nvenc.h:89
NvencContext::async_depth
int async_depth
Definition: nvenc.h:205
NvencContext::registered_frames
struct NvencContext::@104 registered_frames[MAX_REGISTERED_FRAMES]
NvencDynLoadFunctions::nvenc_funcs
NV_ENCODE_API_FUNCTION_LIST nvenc_funcs
Definition: nvenc.h:98
NvencContext::nb_registered_frames
int nb_registered_frames
Definition: nvenc.h:186
NvencContext::aud
int aud
Definition: nvenc.h:217
NvencContext::coder
int coder
Definition: nvenc.h:226
AVPacket
This structure stores compressed data.
Definition: packet.h:350
NvencContext::tier
int tier
Definition: nvenc.h:199
ff_nvenc_pix_fmts
enum AVPixelFormat ff_nvenc_pix_fmts[]
Definition: nvenc.c:45
ID3D11Device
void ID3D11Device
Definition: nvenc.h:28
NvencContext::cu_context_internal
CUcontext cu_context_internal
Definition: nvenc.h:162
NvencContext::strict_gop
int strict_gop
Definition: nvenc.h:214
PRESET_FAST
@ PRESET_FAST
Definition: nvenc.h:106
hwcontext_d3d11va.h
ff_nvenc_hw_configs
const AVCodecHWConfigInternal *const ff_nvenc_hw_configs[]
Definition: nvenc.c:63
NvencContext::output_surface_queue
AVFifoBuffer * output_surface_queue
Definition: nvenc.h:172
NvencContext::d3d11_device
ID3D11Device * d3d11_device
Definition: nvenc.h:164