FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
qsvenc_hevc.c
Go to the documentation of this file.
1 /*
2  * Intel MediaSDK QSV based HEVC encoder
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 
22 #include <stdint.h>
23 #include <sys/types.h>
24 
25 #include <mfx/mfxvideo.h>
26 
27 #include "libavutil/common.h"
28 #include "libavutil/opt.h"
29 
30 #include "avcodec.h"
31 #include "bytestream.h"
32 #include "get_bits.h"
33 #include "hevc.h"
34 #include "hevcdec.h"
35 #include "h2645_parse.h"
36 #include "internal.h"
37 #include "qsv.h"
38 #include "qsv_internal.h"
39 #include "qsvenc.h"
40 
41 enum LoadPlugin {
45 };
46 
47 typedef struct QSVHEVCEncContext {
48  AVClass *class;
52 
54 {
55  GetByteContext gbc;
56  PutByteContext pbc;
57 
58  GetBitContext gb;
59  H2645RBSP sps_rbsp = { NULL };
60  H2645NAL sps_nal = { NULL };
61  HEVCSPS sps = { 0 };
62  HEVCVPS vps = { 0 };
63  uint8_t vps_buf[128], vps_rbsp_buf[128];
64  uint8_t *new_extradata;
65  unsigned int sps_id;
66  int ret, i, type, vps_size;
67 
68  if (!avctx->extradata_size) {
69  av_log(avctx, AV_LOG_ERROR, "No extradata returned from libmfx\n");
70  return AVERROR_UNKNOWN;
71  }
72 
74  if (!sps_rbsp.rbsp_buffer)
75  return AVERROR(ENOMEM);
76 
77  /* parse the SPS */
78  ret = ff_h2645_extract_rbsp(avctx->extradata + 4, avctx->extradata_size - 4, &sps_rbsp, &sps_nal, 1);
79  if (ret < 0) {
80  av_log(avctx, AV_LOG_ERROR, "Error unescaping the SPS buffer\n");
81  return ret;
82  }
83 
84  ret = init_get_bits8(&gb, sps_nal.data, sps_nal.size);
85  if (ret < 0) {
86  av_freep(&sps_rbsp.rbsp_buffer);
87  return ret;
88  }
89 
90  get_bits(&gb, 1);
91  type = get_bits(&gb, 6);
92  if (type != HEVC_NAL_SPS) {
93  av_log(avctx, AV_LOG_ERROR, "Unexpected NAL type in the extradata: %d\n",
94  type);
95  av_freep(&sps_rbsp.rbsp_buffer);
96  return AVERROR_INVALIDDATA;
97  }
98  get_bits(&gb, 9);
99 
100  ret = ff_hevc_parse_sps(&sps, &gb, &sps_id, 0, NULL, avctx);
101  av_freep(&sps_rbsp.rbsp_buffer);
102  if (ret < 0) {
103  av_log(avctx, AV_LOG_ERROR, "Error parsing the SPS\n");
104  return ret;
105  }
106 
107  /* generate the VPS */
108  vps.vps_max_layers = 1;
110  memcpy(&vps.ptl, &sps.ptl, sizeof(vps.ptl));
112  for (i = 0; i < HEVC_MAX_SUB_LAYERS; i++) {
116  }
117 
118  vps.vps_num_layer_sets = 1;
124 
125  /* generate the encoded RBSP form of the VPS */
126  ret = ff_hevc_encode_nal_vps(&vps, sps.vps_id, vps_rbsp_buf, sizeof(vps_rbsp_buf));
127  if (ret < 0) {
128  av_log(avctx, AV_LOG_ERROR, "Error writing the VPS\n");
129  return ret;
130  }
131 
132  /* escape and add the startcode */
133  bytestream2_init(&gbc, vps_rbsp_buf, ret);
134  bytestream2_init_writer(&pbc, vps_buf, sizeof(vps_buf));
135 
136  bytestream2_put_be32(&pbc, 1); // startcode
137  bytestream2_put_byte(&pbc, HEVC_NAL_VPS << 1); // NAL
138  bytestream2_put_byte(&pbc, 1); // header
139 
140  while (bytestream2_get_bytes_left(&gbc)) {
141  uint32_t b = bytestream2_peek_be24(&gbc);
142  if (b <= 3) {
143  bytestream2_put_be24(&pbc, 3);
144  bytestream2_skip(&gbc, 2);
145  } else
146  bytestream2_put_byte(&pbc, bytestream2_get_byte(&gbc));
147  }
148 
149  vps_size = bytestream2_tell_p(&pbc);
150  new_extradata = av_mallocz(vps_size + avctx->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
151  if (!new_extradata)
152  return AVERROR(ENOMEM);
153  memcpy(new_extradata, vps_buf, vps_size);
154  memcpy(new_extradata + vps_size, avctx->extradata, avctx->extradata_size);
155 
156  av_freep(&avctx->extradata);
157  avctx->extradata = new_extradata;
158  avctx->extradata_size += vps_size;
159 
160  return 0;
161 }
162 
164 {
165  QSVHEVCEncContext *q = avctx->priv_data;
166  int ret;
167 
168  if (q->load_plugin != LOAD_PLUGIN_NONE) {
169  static const char * const uid_hevcenc_sw = "2fca99749fdb49aeb121a5b63ef568f7";
170  static const char * const uid_hevcenc_hw = "6fadc791a0c2eb479ab6dcd5ea9da347";
171 
172  if (q->qsv.load_plugins[0]) {
173  av_log(avctx, AV_LOG_WARNING,
174  "load_plugins is not empty, but load_plugin is not set to 'none'."
175  "The load_plugin value will be ignored.\n");
176  } else {
178 
180  q->qsv.load_plugins = av_strdup(uid_hevcenc_sw);
181  else
182  q->qsv.load_plugins = av_strdup(uid_hevcenc_hw);
183 
184  if (!q->qsv.load_plugins)
185  return AVERROR(ENOMEM);
186  }
187  }
188 
189  // HEVC and H264 meaning of the value is shifted by 1, make it consistent
190  q->qsv.idr_interval++;
191 
192  ret = ff_qsv_enc_init(avctx, &q->qsv);
193  if (ret < 0)
194  return ret;
195 
196  ret = generate_fake_vps(&q->qsv, avctx);
197  if (ret < 0) {
198  ff_qsv_enc_close(avctx, &q->qsv);
199  return ret;
200  }
201 
202  return 0;
203 }
204 
206  const AVFrame *frame, int *got_packet)
207 {
208  QSVHEVCEncContext *q = avctx->priv_data;
209 
210  return ff_qsv_encode(avctx, &q->qsv, pkt, frame, got_packet);
211 }
212 
214 {
215  QSVHEVCEncContext *q = avctx->priv_data;
216 
217  return ff_qsv_enc_close(avctx, &q->qsv);
218 }
219 
220 #if defined(_WIN32)
221 #define LOAD_PLUGIN_DEFAULT LOAD_PLUGIN_HEVC_SW
222 #else
223 #define LOAD_PLUGIN_DEFAULT LOAD_PLUGIN_HEVC_HW
224 #endif
225 
226 #define OFFSET(x) offsetof(QSVHEVCEncContext, x)
227 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
228 static const AVOption options[] = {
230 
231  { "idr_interval", "Distance (in I-frames) between IDR frames", OFFSET(qsv.idr_interval), AV_OPT_TYPE_INT, { .i64 = 0 }, -1, INT_MAX, VE, "idr_interval" },
232  { "begin_only", "Output an IDR-frame only at the beginning of the stream", 0, AV_OPT_TYPE_CONST, { .i64 = -1 }, 0, 0, VE, "idr_interval" },
233  { "load_plugin", "A user plugin to load in an internal session", OFFSET(load_plugin), AV_OPT_TYPE_INT, { .i64 = LOAD_PLUGIN_DEFAULT }, LOAD_PLUGIN_NONE, LOAD_PLUGIN_HEVC_HW, VE, "load_plugin" },
234  { "none", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = LOAD_PLUGIN_NONE }, 0, 0, VE, "load_plugin" },
235  { "hevc_sw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = LOAD_PLUGIN_HEVC_SW }, 0, 0, VE, "load_plugin" },
236  { "hevc_hw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = LOAD_PLUGIN_HEVC_HW }, 0, 0, VE, "load_plugin" },
237 
238  { "load_plugins", "A :-separate list of hexadecimal plugin UIDs to load in an internal session",
239  OFFSET(qsv.load_plugins), AV_OPT_TYPE_STRING, { .str = "" }, 0, 0, VE },
240 
241  { "profile", NULL, OFFSET(qsv.profile), AV_OPT_TYPE_INT, { .i64 = MFX_PROFILE_UNKNOWN }, 0, INT_MAX, VE, "profile" },
242  { "unknown", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_PROFILE_UNKNOWN }, INT_MIN, INT_MAX, VE, "profile" },
243  { "main", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_PROFILE_HEVC_MAIN }, INT_MIN, INT_MAX, VE, "profile" },
244  { "main10", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_PROFILE_HEVC_MAIN10 }, INT_MIN, INT_MAX, VE, "profile" },
245  { "mainsp", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = MFX_PROFILE_HEVC_MAINSP }, INT_MIN, INT_MAX, VE, "profile" },
246 
247  { NULL },
248 };
249 
250 static const AVClass class = {
251  .class_name = "hevc_qsv encoder",
252  .item_name = av_default_item_name,
253  .option = options,
255 };
256 
258  { "b", "1M" },
259  { "refs", "0" },
260  // same as the x264 default
261  { "g", "248" },
262  { "bf", "8" },
263 
264  { "flags", "+cgop" },
265 #if FF_API_PRIVATE_OPT
266  { "b_strategy", "-1" },
267 #endif
268  { NULL },
269 };
270 
272  .name = "hevc_qsv",
273  .long_name = NULL_IF_CONFIG_SMALL("HEVC (Intel Quick Sync Video acceleration)"),
274  .priv_data_size = sizeof(QSVHEVCEncContext),
276  .id = AV_CODEC_ID_HEVC,
277  .init = qsv_enc_init,
278  .encode2 = qsv_enc_frame,
279  .close = qsv_enc_close,
280  .capabilities = AV_CODEC_CAP_DELAY | AV_CODEC_CAP_HYBRID,
281  .pix_fmts = (const enum AVPixelFormat[]){ AV_PIX_FMT_NV12,
284  AV_PIX_FMT_NONE },
285  .priv_class = &class,
286  .defaults = qsv_enc_defaults,
287  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
288  .wrapper_name = "qsv",
289 };
#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
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
AVCodec ff_hevc_qsv_encoder
Definition: qsvenc_hevc.c:271
This structure describes decoded (raw) audio or video data.
Definition: frame.h:201
AVOption.
Definition: opt.h:246
int size
Definition: h2645_parse.h:34
int vui_num_ticks_poc_diff_one_minus1
Definition: hevc_ps.h:161
int max_dec_pic_buffering
Definition: hevc_ps.h:244
static unsigned int get_bits(GetBitContext *s, int n)
Read 1-25 bits.
Definition: get_bits.h:261
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int vps_num_ticks_poc_diff_one
vps_num_ticks_poc_diff_one_minus1 + 1
Definition: hevc_ps.h:211
unsigned int vps_max_latency_increase[HEVC_MAX_SUB_LAYERS]
Definition: hevc_ps.h:204
VUI vui
Definition: hevc_ps.h:250
const char * b
Definition: vf_curves.c:113
static av_always_inline void bytestream2_init_writer(PutByteContext *p, uint8_t *buf, int buf_size)
Definition: bytestream.h:143
uint32_t vui_time_scale
Definition: hevc_ps.h:159
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:193
int ff_hevc_encode_nal_vps(HEVCVPS *vps, unsigned int id, uint8_t *buf, int buf_size)
Definition: hevc_ps_enc.c:66
static int generate_fake_vps(QSVEncContext *q, AVCodecContext *avctx)
Definition: qsvenc_hevc.c:53
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:133
unsigned int vps_max_dec_pic_buffering[HEVC_MAX_SUB_LAYERS]
Definition: hevc_ps.h:202
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
Definition: utils.c:123
int max_latency_increase
Definition: hevc_ps.h:246
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:236
static AVPacket pkt
AVCodec.
Definition: avcodec.h:3365
static int qsv_enc_frame(AVCodecContext *avctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: qsvenc_hevc.c:205
#define AV_PIX_FMT_P010
Definition: pixfmt.h:413
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:981
int ff_qsv_encode(AVCodecContext *avctx, QSVEncContext *q, AVPacket *pkt, const AVFrame *frame, int *got_packet)
Definition: qsvenc.c:1163
uint8_t
#define av_cold
Definition: attributes.h:82
AVOptions.
uint8_t vps_timing_info_present_flag
Definition: hevc_ps.h:207
int ff_hevc_parse_sps(HEVCSPS *sps, GetBitContext *gb, unsigned int *sps_id, int apply_defdispwin, AVBufferRef **vps_list, AVCodecContext *avctx)
Parse the SPS from the bitstream into the provided HEVCSPS struct.
Definition: hevc_ps.c:866
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1602
int vps_max_sub_layers
vps_max_temporal_layers_minus1 + 1
Definition: hevc_ps.h:198
static AVFrame * frame
#define OFFSET(x)
Definition: qsvenc_hevc.c:226
#define QSV_COMMON_OPTS
Definition: qsvenc.h:65
bitstream reader API header.
int ff_qsv_enc_close(AVCodecContext *avctx, QSVEncContext *q)
Definition: qsvenc.c:1232
#define av_log(a,...)
QSVEncContext qsv
Definition: qsvenc_hevc.c:49
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int vps_max_layers
Definition: hevc_ps.h:197
#define AVERROR(e)
Definition: error.h:43
static av_always_inline void bytestream2_skip(GetByteContext *g, unsigned int size)
Definition: bytestream.h:164
int vui_timing_info_present_flag
Definition: hevc_ps.h:157
char * load_plugins
Definition: qsvenc.h:157
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
#define LOAD_PLUGIN_DEFAULT
Definition: qsvenc_hevc.c:223
static av_always_inline unsigned int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:154
planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (firs...
Definition: pixfmt.h:85
const char * name
Name of the codec implementation.
Definition: avcodec.h:3372
int vui_poc_proportional_to_timing_flag
Definition: hevc_ps.h:160
static av_always_inline int bytestream2_tell_p(PutByteContext *p)
Definition: bytestream.h:193
uint32_t vps_num_units_in_tick
Definition: hevc_ps.h:208
int vps_num_layer_sets
vps_num_layer_sets_minus1 + 1
Definition: hevc_ps.h:206
int idr_interval
Definition: qsvenc.h:125
static const AVCodecDefault qsv_enc_defaults[]
Definition: qsvenc_hevc.c:257
uint8_t vps_poc_proportional_to_timing_flag
Definition: hevc_ps.h:210
unsigned int vps_num_reorder_pics[HEVC_MAX_SUB_LAYERS]
Definition: hevc_ps.h:203
unsigned vps_id
Definition: hevc_ps.h:226
PTL ptl
Definition: hevc_ps.h:200
struct HEVCSPS::@83 temporal_layer[HEVC_MAX_SUB_LAYERS]
uint32_t vps_time_scale
Definition: hevc_ps.h:209
static av_cold int qsv_enc_close(AVCodecContext *avctx)
Definition: qsvenc_hevc.c:213
char * av_strdup(const char *s)
Duplicate a string.
Definition: mem.c:251
Libavcodec external API header.
PTL ptl
Definition: hevc_ps.h:251
int max_sub_layers
Definition: hevc_ps.h:242
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
Definition: get_bits.h:456
main external API structure.
Definition: avcodec.h:1502
const uint8_t * data
Definition: h2645_parse.h:35
uint32_t vui_num_units_in_tick
Definition: hevc_ps.h:158
GLint GLenum type
Definition: opengl_enc.c:105
int extradata_size
Definition: avcodec.h:1603
#define AV_CODEC_CAP_HYBRID
Codec is potentially backed by a hardware implementation, but not necessarily.
Definition: avcodec.h:1060
int rbsp_buffer_alloc_size
Definition: h2645_parse.h:69
Describe the class of an AVClass context structure.
Definition: log.h:67
int ff_qsv_enc_init(AVCodecContext *avctx, QSVEncContext *q)
Definition: qsvenc.c:806
uint8_t * rbsp_buffer
Definition: h2645_parse.h:68
HW acceleration through QSV, data[3] contains a pointer to the mfxFrameSurface1 structure.
Definition: pixfmt.h:218
static int FUNC() sps(CodedBitstreamContext *ctx, RWContext *rw, H264RawSPS *current)
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:266
static int FUNC() vps(CodedBitstreamContext *ctx, RWContext *rw, H265RawVPS *current)
common internal api header.
common internal and external API header
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:71
#define AV_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:770
void * priv_data
Definition: avcodec.h:1529
static av_cold int qsv_enc_init(AVCodecContext *avctx)
Definition: qsvenc_hevc.c:163
#define VE
Definition: qsvenc_hevc.c:227
#define av_freep(p)
int num_reorder_pics
Definition: hevc_ps.h:245
int ff_h2645_extract_rbsp(const uint8_t *src, int length, H2645RBSP *rbsp, H2645NAL *nal, int small_padding)
Extract the raw (unescaped) bitstream.
Definition: h2645_parse.c:33
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1391
LoadPlugin
Definition: qsvdec_h2645.c:40
int vps_sub_layer_ordering_info_present_flag
Definition: hevc_ps.h:201
static const AVOption options[]
Definition: qsvenc_hevc.c:228