2 * Intel MediaSDK QSV encoder/decoder shared code
4 * This file is part of FFmpeg.
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.
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.
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
21 #include <mfx/mfxvideo.h>
22 #include <mfx/mfxplugin.h>
23 #include <mfx/mfxjpeg.h>
28 #include "libavutil/avstring.h"
29 #include "libavutil/common.h"
30 #include "libavutil/error.h"
31 #include "libavutil/hwcontext.h"
32 #include "libavutil/hwcontext_qsv.h"
33 #include "libavutil/imgutils.h"
36 #include "qsv_internal.h"
38 #if QSV_VERSION_ATLEAST(1, 12)
39 #include "mfx/mfxvp8.h"
42 int ff_qsv_codec_id_to_mfx(enum AVCodecID codec_id)
45 case AV_CODEC_ID_H264:
47 #if QSV_VERSION_ATLEAST(1, 8)
48 case AV_CODEC_ID_HEVC:
49 return MFX_CODEC_HEVC;
51 case AV_CODEC_ID_MPEG1VIDEO:
52 case AV_CODEC_ID_MPEG2VIDEO:
53 return MFX_CODEC_MPEG2;
56 #if QSV_VERSION_ATLEAST(1, 12)
60 case AV_CODEC_ID_MJPEG:
61 return MFX_CODEC_JPEG;
66 return AVERROR(ENOSYS);
69 int ff_qsv_profile_to_mfx(enum AVCodecID codec_id, int profile)
71 if (profile == FF_PROFILE_UNKNOWN)
72 return MFX_PROFILE_UNKNOWN;
74 case AV_CODEC_ID_H264:
75 case AV_CODEC_ID_HEVC:
78 return 4 * profile + 1;
79 case AV_CODEC_ID_MPEG2VIDEO:
80 return 0x10 * profile;
82 return MFX_PROFILE_UNKNOWN;
90 { MFX_ERR_NONE, 0, "success" },
91 { MFX_ERR_UNKNOWN, AVERROR_UNKNOWN, "unknown error" },
92 { MFX_ERR_NULL_PTR, AVERROR(EINVAL), "NULL pointer" },
93 { MFX_ERR_UNSUPPORTED, AVERROR(ENOSYS), "unsupported" },
94 { MFX_ERR_MEMORY_ALLOC, AVERROR(ENOMEM), "failed to allocate memory" },
95 { MFX_ERR_NOT_ENOUGH_BUFFER, AVERROR(ENOMEM), "insufficient input/output buffer" },
96 { MFX_ERR_INVALID_HANDLE, AVERROR(EINVAL), "invalid handle" },
97 { MFX_ERR_LOCK_MEMORY, AVERROR(EIO), "failed to lock the memory block" },
98 { MFX_ERR_NOT_INITIALIZED, AVERROR_BUG, "not initialized" },
99 { MFX_ERR_NOT_FOUND, AVERROR(ENOSYS), "specified object was not found" },
100 /* the following 3 errors should always be handled explicitly, so those "mappings"
101 * are for completeness only */
102 { MFX_ERR_MORE_DATA, AVERROR_UNKNOWN, "expect more data at input" },
103 { MFX_ERR_MORE_SURFACE, AVERROR_UNKNOWN, "expect more surface at output" },
104 { MFX_ERR_MORE_BITSTREAM, AVERROR_UNKNOWN, "expect more bitstream at output" },
105 { MFX_ERR_ABORTED, AVERROR_UNKNOWN, "operation aborted" },
106 { MFX_ERR_DEVICE_LOST, AVERROR(EIO), "device lost" },
107 { MFX_ERR_INCOMPATIBLE_VIDEO_PARAM, AVERROR(EINVAL), "incompatible video parameters" },
108 { MFX_ERR_INVALID_VIDEO_PARAM, AVERROR(EINVAL), "invalid video parameters" },
109 { MFX_ERR_UNDEFINED_BEHAVIOR, AVERROR_BUG, "undefined behavior" },
110 { MFX_ERR_DEVICE_FAILED, AVERROR(EIO), "device failed" },
111 { MFX_ERR_INCOMPATIBLE_AUDIO_PARAM, AVERROR(EINVAL), "incompatible audio parameters" },
112 { MFX_ERR_INVALID_AUDIO_PARAM, AVERROR(EINVAL), "invalid audio parameters" },
114 { MFX_WRN_IN_EXECUTION, 0, "operation in execution" },
115 { MFX_WRN_DEVICE_BUSY, 0, "device busy" },
116 { MFX_WRN_VIDEO_PARAM_CHANGED, 0, "video parameters changed" },
117 { MFX_WRN_PARTIAL_ACCELERATION, 0, "partial acceleration" },
118 { MFX_WRN_INCOMPATIBLE_VIDEO_PARAM, 0, "incompatible video parameters" },
119 { MFX_WRN_VALUE_NOT_CHANGED, 0, "value is saturated" },
120 { MFX_WRN_OUT_OF_RANGE, 0, "value out of range" },
121 { MFX_WRN_FILTER_SKIPPED, 0, "filter skipped" },
122 { MFX_WRN_INCOMPATIBLE_AUDIO_PARAM, 0, "incompatible audio parameters" },
125 int ff_qsv_map_error(mfxStatus mfx_err, const char **desc)
128 for (i = 0; i < FF_ARRAY_ELEMS(qsv_errors); i++) {
129 if (qsv_errors[i].mfxerr == mfx_err) {
131 *desc = qsv_errors[i].desc;
132 return qsv_errors[i].averr;
136 *desc = "unknown error";
137 return AVERROR_UNKNOWN;
140 int ff_qsv_print_error(void *log_ctx, mfxStatus err,
141 const char *error_string)
145 ret = ff_qsv_map_error(err, &desc);
146 av_log(log_ctx, AV_LOG_ERROR, "%s: %s (%d)\n", error_string, desc, err);
150 int ff_qsv_print_warning(void *log_ctx, mfxStatus err,
151 const char *warning_string)
155 ret = ff_qsv_map_error(err, &desc);
156 av_log(log_ctx, AV_LOG_WARNING, "%s: %s (%d)\n", warning_string, desc, err);
160 static enum AVPixelFormat qsv_map_fourcc(uint32_t fourcc)
163 case MFX_FOURCC_NV12: return AV_PIX_FMT_NV12;
164 case MFX_FOURCC_P010: return AV_PIX_FMT_P010;
165 case MFX_FOURCC_P8: return AV_PIX_FMT_PAL8;
167 return AV_PIX_FMT_NONE;
170 int ff_qsv_map_pixfmt(enum AVPixelFormat format, uint32_t *fourcc)
173 case AV_PIX_FMT_YUV420P:
174 case AV_PIX_FMT_YUVJ420P:
175 case AV_PIX_FMT_NV12:
176 *fourcc = MFX_FOURCC_NV12;
177 return AV_PIX_FMT_NV12;
178 case AV_PIX_FMT_YUV420P10:
179 case AV_PIX_FMT_P010:
180 *fourcc = MFX_FOURCC_P010;
181 return AV_PIX_FMT_P010;
183 return AVERROR(ENOSYS);
187 int ff_qsv_find_surface_idx(QSVFramesContext *ctx, QSVFrame *frame)
190 for (i = 0; i < ctx->nb_mids; i++) {
191 QSVMid *mid = &ctx->mids[i];
192 if (mid->handle == frame->surface.Data.MemId)
198 enum AVPictureType ff_qsv_map_pictype(int mfx_pic_type)
200 enum AVPictureType type;
201 switch (mfx_pic_type & 0x7) {
202 case MFX_FRAMETYPE_I:
203 if (mfx_pic_type & MFX_FRAMETYPE_S)
204 type = AV_PICTURE_TYPE_SI;
206 type = AV_PICTURE_TYPE_I;
208 case MFX_FRAMETYPE_B:
209 type = AV_PICTURE_TYPE_B;
211 case MFX_FRAMETYPE_P:
212 if (mfx_pic_type & MFX_FRAMETYPE_S)
213 type = AV_PICTURE_TYPE_SP;
215 type = AV_PICTURE_TYPE_P;
222 static int qsv_load_plugins(mfxSession session, const char *load_plugins,
225 if (!load_plugins || !*load_plugins)
228 while (*load_plugins) {
233 char *plugin = av_get_token(&load_plugins, ":");
235 return AVERROR(ENOMEM);
236 if (strlen(plugin) != 2 * sizeof(uid.Data)) {
237 av_log(logctx, AV_LOG_ERROR, "Invalid plugin UID length\n");
238 err = AVERROR(EINVAL);
239 goto load_plugin_fail;
242 for (i = 0; i < sizeof(uid.Data); i++) {
243 err = sscanf(plugin + 2 * i, "%2hhx", uid.Data + i);
245 av_log(logctx, AV_LOG_ERROR, "Invalid plugin UID\n");
246 err = AVERROR(EINVAL);
247 goto load_plugin_fail;
252 ret = MFXVideoUSER_Load(session, &uid, 1);
255 snprintf(errorbuf, sizeof(errorbuf),
256 "Could not load the requested plugin '%s'", plugin);
257 err = ff_qsv_print_error(logctx, ret, errorbuf);
258 goto load_plugin_fail;
273 int ff_qsv_init_internal_session(AVCodecContext *avctx, mfxSession *session,
274 const char *load_plugins)
276 mfxIMPL impl = MFX_IMPL_AUTO_ANY;
277 mfxVersion ver = { { QSV_VERSION_MINOR, QSV_VERSION_MAJOR } };
282 ret = MFXInit(impl, &ver, session);
284 return ff_qsv_print_error(avctx, ret,
285 "Error initializing an internal MFX session");
287 ret = qsv_load_plugins(*session, load_plugins, avctx);
289 av_log(avctx, AV_LOG_ERROR, "Error loading plugins\n");
293 MFXQueryIMPL(*session, &impl);
295 switch (MFX_IMPL_BASETYPE(impl)) {
296 case MFX_IMPL_SOFTWARE:
299 case MFX_IMPL_HARDWARE:
300 case MFX_IMPL_HARDWARE2:
301 case MFX_IMPL_HARDWARE3:
302 case MFX_IMPL_HARDWARE4:
303 desc = "hardware accelerated";
309 av_log(avctx, AV_LOG_VERBOSE,
310 "Initialized an internal MFX session using %s implementation\n",
316 static void mids_buf_free(void *opaque, uint8_t *data)
318 AVBufferRef *hw_frames_ref = opaque;
319 av_buffer_unref(&hw_frames_ref);
323 static AVBufferRef *qsv_create_mids(AVBufferRef *hw_frames_ref)
325 AVHWFramesContext *frames_ctx = (AVHWFramesContext*)hw_frames_ref->data;
326 AVQSVFramesContext *frames_hwctx = frames_ctx->hwctx;
327 int nb_surfaces = frames_hwctx->nb_surfaces;
329 AVBufferRef *mids_buf, *hw_frames_ref1;
333 hw_frames_ref1 = av_buffer_ref(hw_frames_ref);
337 mids = av_mallocz_array(nb_surfaces, sizeof(*mids));
339 av_buffer_unref(&hw_frames_ref1);
343 mids_buf = av_buffer_create((uint8_t*)mids, nb_surfaces * sizeof(*mids),
344 mids_buf_free, hw_frames_ref1, 0);
346 av_buffer_unref(&hw_frames_ref1);
351 for (i = 0; i < nb_surfaces; i++) {
352 QSVMid *mid = &mids[i];
353 mid->handle = frames_hwctx->surfaces[i].Data.MemId;
354 mid->hw_frames_ref = hw_frames_ref1;
360 static int qsv_setup_mids(mfxFrameAllocResponse *resp, AVBufferRef *hw_frames_ref,
361 AVBufferRef *mids_buf)
363 AVHWFramesContext *frames_ctx = (AVHWFramesContext*)hw_frames_ref->data;
364 AVQSVFramesContext *frames_hwctx = frames_ctx->hwctx;
365 QSVMid *mids = (QSVMid*)mids_buf->data;
366 int nb_surfaces = frames_hwctx->nb_surfaces;
369 // the allocated size of the array is two larger than the number of
370 // surfaces, we store the references to the frames context and the
371 // QSVMid array there
372 resp->mids = av_mallocz_array(nb_surfaces + 2, sizeof(*resp->mids));
374 return AVERROR(ENOMEM);
376 for (i = 0; i < nb_surfaces; i++)
377 resp->mids[i] = &mids[i];
378 resp->NumFrameActual = nb_surfaces;
380 resp->mids[resp->NumFrameActual] = (mfxMemId)av_buffer_ref(hw_frames_ref);
381 if (!resp->mids[resp->NumFrameActual]) {
382 av_freep(&resp->mids);
383 return AVERROR(ENOMEM);
386 resp->mids[resp->NumFrameActual + 1] = av_buffer_ref(mids_buf);
387 if (!resp->mids[resp->NumFrameActual + 1]) {
388 av_buffer_unref((AVBufferRef**)&resp->mids[resp->NumFrameActual]);
389 av_freep(&resp->mids);
390 return AVERROR(ENOMEM);
396 static mfxStatus qsv_frame_alloc(mfxHDL pthis, mfxFrameAllocRequest *req,
397 mfxFrameAllocResponse *resp)
399 QSVFramesContext *ctx = pthis;
402 /* this should only be called from an encoder or decoder and
403 * only allocates video memory frames */
404 if (!(req->Type & (MFX_MEMTYPE_VIDEO_MEMORY_DECODER_TARGET |
405 MFX_MEMTYPE_VIDEO_MEMORY_PROCESSOR_TARGET)) ||
406 !(req->Type & (MFX_MEMTYPE_FROM_DECODE | MFX_MEMTYPE_FROM_ENCODE)))
407 return MFX_ERR_UNSUPPORTED;
409 if (req->Type & MFX_MEMTYPE_EXTERNAL_FRAME) {
410 /* external frames -- fill from the caller-supplied frames context */
411 AVHWFramesContext *frames_ctx = (AVHWFramesContext*)ctx->hw_frames_ctx->data;
412 AVQSVFramesContext *frames_hwctx = frames_ctx->hwctx;
413 mfxFrameInfo *i = &req->Info;
414 mfxFrameInfo *i1 = &frames_hwctx->surfaces[0].Info;
416 if (i->Width > i1->Width || i->Height > i1->Height ||
417 i->FourCC != i1->FourCC || i->ChromaFormat != i1->ChromaFormat) {
418 av_log(ctx->logctx, AV_LOG_ERROR, "Mismatching surface properties in an "
419 "allocation request: %dx%d %d %d vs %dx%d %d %d\n",
420 i->Width, i->Height, i->FourCC, i->ChromaFormat,
421 i1->Width, i1->Height, i1->FourCC, i1->ChromaFormat);
422 return MFX_ERR_UNSUPPORTED;
425 ret = qsv_setup_mids(resp, ctx->hw_frames_ctx, ctx->mids_buf);
427 av_log(ctx->logctx, AV_LOG_ERROR,
428 "Error filling an external frame allocation request\n");
429 return MFX_ERR_MEMORY_ALLOC;
431 } else if (req->Type & MFX_MEMTYPE_INTERNAL_FRAME) {
432 /* internal frames -- allocate a new hw frames context */
433 AVHWFramesContext *ext_frames_ctx = (AVHWFramesContext*)ctx->hw_frames_ctx->data;
434 mfxFrameInfo *i = &req->Info;
436 AVBufferRef *frames_ref, *mids_buf;
437 AVHWFramesContext *frames_ctx;
438 AVQSVFramesContext *frames_hwctx;
440 frames_ref = av_hwframe_ctx_alloc(ext_frames_ctx->device_ref);
442 return MFX_ERR_MEMORY_ALLOC;
444 frames_ctx = (AVHWFramesContext*)frames_ref->data;
445 frames_hwctx = frames_ctx->hwctx;
447 frames_ctx->format = AV_PIX_FMT_QSV;
448 frames_ctx->sw_format = qsv_map_fourcc(i->FourCC);
449 frames_ctx->width = i->Width;
450 frames_ctx->height = i->Height;
451 frames_ctx->initial_pool_size = req->NumFrameSuggested;
453 frames_hwctx->frame_type = req->Type;
455 ret = av_hwframe_ctx_init(frames_ref);
457 av_log(ctx->logctx, AV_LOG_ERROR,
458 "Error initializing a frames context for an internal frame "
459 "allocation request\n");
460 av_buffer_unref(&frames_ref);
461 return MFX_ERR_MEMORY_ALLOC;
464 mids_buf = qsv_create_mids(frames_ref);
466 av_buffer_unref(&frames_ref);
467 return MFX_ERR_MEMORY_ALLOC;
470 ret = qsv_setup_mids(resp, frames_ref, mids_buf);
471 av_buffer_unref(&mids_buf);
472 av_buffer_unref(&frames_ref);
474 av_log(ctx->logctx, AV_LOG_ERROR,
475 "Error filling an internal frame allocation request\n");
476 return MFX_ERR_MEMORY_ALLOC;
479 return MFX_ERR_UNSUPPORTED;
485 static mfxStatus qsv_frame_free(mfxHDL pthis, mfxFrameAllocResponse *resp)
487 av_buffer_unref((AVBufferRef**)&resp->mids[resp->NumFrameActual]);
488 av_buffer_unref((AVBufferRef**)&resp->mids[resp->NumFrameActual + 1]);
489 av_freep(&resp->mids);
493 static mfxStatus qsv_frame_lock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
495 QSVMid *qsv_mid = mid;
496 AVHWFramesContext *hw_frames_ctx = (AVHWFramesContext*)qsv_mid->hw_frames_ref->data;
497 AVQSVFramesContext *hw_frames_hwctx = hw_frames_ctx->hwctx;
500 if (qsv_mid->locked_frame)
501 return MFX_ERR_UNDEFINED_BEHAVIOR;
503 /* Allocate a system memory frame that will hold the mapped data. */
504 qsv_mid->locked_frame = av_frame_alloc();
505 if (!qsv_mid->locked_frame)
506 return MFX_ERR_MEMORY_ALLOC;
507 qsv_mid->locked_frame->format = hw_frames_ctx->sw_format;
509 /* wrap the provided handle in a hwaccel AVFrame */
510 qsv_mid->hw_frame = av_frame_alloc();
511 if (!qsv_mid->hw_frame)
514 qsv_mid->hw_frame->data[3] = (uint8_t*)&qsv_mid->surf;
515 qsv_mid->hw_frame->format = AV_PIX_FMT_QSV;
517 // doesn't really matter what buffer is used here
518 qsv_mid->hw_frame->buf[0] = av_buffer_alloc(1);
519 if (!qsv_mid->hw_frame->buf[0])
522 qsv_mid->hw_frame->width = hw_frames_ctx->width;
523 qsv_mid->hw_frame->height = hw_frames_ctx->height;
525 qsv_mid->hw_frame->hw_frames_ctx = av_buffer_ref(qsv_mid->hw_frames_ref);
526 if (!qsv_mid->hw_frame->hw_frames_ctx)
529 qsv_mid->surf.Info = hw_frames_hwctx->surfaces[0].Info;
530 qsv_mid->surf.Data.MemId = qsv_mid->handle;
532 /* map the data to the system memory */
533 ret = av_hwframe_map(qsv_mid->locked_frame, qsv_mid->hw_frame,
534 AV_HWFRAME_MAP_DIRECT);
538 ptr->Pitch = qsv_mid->locked_frame->linesize[0];
539 ptr->Y = qsv_mid->locked_frame->data[0];
540 ptr->U = qsv_mid->locked_frame->data[1];
541 ptr->V = qsv_mid->locked_frame->data[1] + 1;
545 av_frame_free(&qsv_mid->hw_frame);
546 av_frame_free(&qsv_mid->locked_frame);
547 return MFX_ERR_MEMORY_ALLOC;
550 static mfxStatus qsv_frame_unlock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
552 QSVMid *qsv_mid = mid;
554 av_frame_free(&qsv_mid->locked_frame);
555 av_frame_free(&qsv_mid->hw_frame);
560 static mfxStatus qsv_frame_get_hdl(mfxHDL pthis, mfxMemId mid, mfxHDL *hdl)
562 QSVMid *qsv_mid = (QSVMid*)mid;
563 *hdl = qsv_mid->handle;
567 int ff_qsv_init_session_device(AVCodecContext *avctx, mfxSession *psession,
568 AVBufferRef *device_ref, const char *load_plugins)
570 static const mfxHandleType handle_types[] = {
571 MFX_HANDLE_VA_DISPLAY,
572 MFX_HANDLE_D3D9_DEVICE_MANAGER,
573 MFX_HANDLE_D3D11_DEVICE,
575 AVHWDeviceContext *device_ctx = (AVHWDeviceContext*)device_ref->data;
576 AVQSVDeviceContext *device_hwctx = device_ctx->hwctx;
577 mfxSession parent_session = device_hwctx->session;
582 mfxHDL handle = NULL;
583 mfxHandleType handle_type;
588 err = MFXQueryIMPL(parent_session, &impl);
589 if (err == MFX_ERR_NONE)
590 err = MFXQueryVersion(parent_session, &ver);
591 if (err != MFX_ERR_NONE)
592 return ff_qsv_print_error(avctx, err,
593 "Error querying the session attributes");
595 for (i = 0; i < FF_ARRAY_ELEMS(handle_types); i++) {
596 err = MFXVideoCORE_GetHandle(parent_session, handle_types[i], &handle);
597 if (err == MFX_ERR_NONE) {
598 handle_type = handle_types[i];
604 av_log(avctx, AV_LOG_VERBOSE, "No supported hw handle could be retrieved "
605 "from the session\n");
608 err = MFXInit(impl, &ver, &session);
609 if (err != MFX_ERR_NONE)
610 return ff_qsv_print_error(avctx, err,
611 "Error initializing a child MFX session");
614 err = MFXVideoCORE_SetHandle(session, handle_type, handle);
615 if (err != MFX_ERR_NONE)
616 return ff_qsv_print_error(avctx, err,
617 "Error setting a HW handle");
620 if (QSV_RUNTIME_VERSION_ATLEAST(ver, 1, 25)) {
621 err = MFXJoinSession(parent_session, session);
622 if (err != MFX_ERR_NONE)
623 return ff_qsv_print_error(avctx, err,
624 "Error joining session");
627 ret = qsv_load_plugins(session, load_plugins, avctx);
629 av_log(avctx, AV_LOG_ERROR, "Error loading plugins\n");
637 int ff_qsv_init_session_frames(AVCodecContext *avctx, mfxSession *psession,
638 QSVFramesContext *qsv_frames_ctx,
639 const char *load_plugins, int opaque)
641 mfxFrameAllocator frame_allocator = {
642 .pthis = qsv_frames_ctx,
643 .Alloc = qsv_frame_alloc,
644 .Lock = qsv_frame_lock,
645 .Unlock = qsv_frame_unlock,
646 .GetHDL = qsv_frame_get_hdl,
647 .Free = qsv_frame_free,
650 AVHWFramesContext *frames_ctx = (AVHWFramesContext*)qsv_frames_ctx->hw_frames_ctx->data;
651 AVQSVFramesContext *frames_hwctx = frames_ctx->hwctx;
658 ret = ff_qsv_init_session_device(avctx, &session,
659 frames_ctx->device_ref, load_plugins);
664 qsv_frames_ctx->logctx = avctx;
666 /* allocate the memory ids for the external frames */
667 av_buffer_unref(&qsv_frames_ctx->mids_buf);
668 qsv_frames_ctx->mids_buf = qsv_create_mids(qsv_frames_ctx->hw_frames_ctx);
669 if (!qsv_frames_ctx->mids_buf)
670 return AVERROR(ENOMEM);
671 qsv_frames_ctx->mids = (QSVMid*)qsv_frames_ctx->mids_buf->data;
672 qsv_frames_ctx->nb_mids = frames_hwctx->nb_surfaces;
674 err = MFXVideoCORE_SetFrameAllocator(session, &frame_allocator);
675 if (err != MFX_ERR_NONE)
676 return ff_qsv_print_error(avctx, err,
677 "Error setting a frame allocator");