2 * This file is part of FFmpeg.
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.
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.
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
21 * deinterlace video filter - QSV
24 #include <mfx/mfxvideo.h>
29 #include "libavutil/avstring.h"
30 #include "libavutil/common.h"
31 #include "libavutil/hwcontext.h"
32 #include "libavutil/hwcontext_qsv.h"
33 #include "libavutil/internal.h"
34 #include "libavutil/mathematics.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/pixdesc.h"
37 #include "libavutil/time.h"
38 #include "libavfilter/qsvvpp.h"
46 QSVDEINT_MORE_OUTPUT = 1,
50 typedef struct QSVFrame {
52 mfxFrameSurface1 surface;
55 struct QSVFrame *next;
58 typedef struct QSVDeintContext {
61 AVBufferRef *hw_frames_ctx;
62 /* a clone of the main session, used internally for deinterlacing */
68 mfxFrameSurface1 **surface_ptrs;
71 mfxExtOpaqueSurfaceAlloc opaque_alloc;
72 mfxExtVPPDeinterlacing deint_conf;
73 mfxExtBuffer *ext_buffers[2];
76 QSVFrame *work_frames;
82 /* option for Deinterlacing algorithm to be used */
86 static void qsvdeint_uninit(AVFilterContext *ctx)
88 QSVDeintContext *s = ctx->priv;
95 av_buffer_unref(&s->hw_frames_ctx);
99 s->work_frames = cur->next;
100 av_frame_free(&cur->frame);
102 cur = s->work_frames;
105 av_freep(&s->mem_ids);
108 av_freep(&s->surface_ptrs);
109 s->nb_surface_ptrs = 0;
112 static int qsvdeint_query_formats(AVFilterContext *ctx)
114 static const enum AVPixelFormat pixel_formats[] = {
115 AV_PIX_FMT_QSV, AV_PIX_FMT_NONE,
117 AVFilterFormats *pix_fmts = ff_make_format_list(pixel_formats);
120 if ((ret = ff_set_common_formats(ctx, pix_fmts)) < 0)
126 static mfxStatus frame_alloc(mfxHDL pthis, mfxFrameAllocRequest *req,
127 mfxFrameAllocResponse *resp)
129 AVFilterContext *ctx = pthis;
130 QSVDeintContext *s = ctx->priv;
132 if (!(req->Type & MFX_MEMTYPE_VIDEO_MEMORY_PROCESSOR_TARGET) ||
133 !(req->Type & (MFX_MEMTYPE_FROM_VPPIN | MFX_MEMTYPE_FROM_VPPOUT)) ||
134 !(req->Type & MFX_MEMTYPE_EXTERNAL_FRAME))
135 return MFX_ERR_UNSUPPORTED;
137 resp->mids = s->mem_ids;
138 resp->NumFrameActual = s->nb_mem_ids;
143 static mfxStatus frame_free(mfxHDL pthis, mfxFrameAllocResponse *resp)
148 static mfxStatus frame_lock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
150 return MFX_ERR_UNSUPPORTED;
153 static mfxStatus frame_unlock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
155 return MFX_ERR_UNSUPPORTED;
158 static mfxStatus frame_get_hdl(mfxHDL pthis, mfxMemId mid, mfxHDL *hdl)
164 static const mfxHandleType handle_types[] = {
165 MFX_HANDLE_VA_DISPLAY,
166 MFX_HANDLE_D3D9_DEVICE_MANAGER,
167 MFX_HANDLE_D3D11_DEVICE,
170 static int init_out_session(AVFilterContext *ctx)
173 QSVDeintContext *s = ctx->priv;
174 AVHWFramesContext *hw_frames_ctx = (AVHWFramesContext*)s->hw_frames_ctx->data;
175 AVQSVFramesContext *hw_frames_hwctx = hw_frames_ctx->hwctx;
176 AVQSVDeviceContext *device_hwctx = hw_frames_ctx->device_ctx->hwctx;
178 int opaque = !!(hw_frames_hwctx->frame_type & MFX_MEMTYPE_OPAQUE_FRAME);
180 mfxHDL handle = NULL;
181 mfxHandleType handle_type;
188 /* extract the properties of the "master" session given to us */
189 err = MFXQueryIMPL(device_hwctx->session, &impl);
190 if (err == MFX_ERR_NONE)
191 err = MFXQueryVersion(device_hwctx->session, &ver);
192 if (err != MFX_ERR_NONE) {
193 av_log(ctx, AV_LOG_ERROR, "Error querying the session attributes\n");
194 return AVERROR_UNKNOWN;
197 for (i = 0; i < FF_ARRAY_ELEMS(handle_types); i++) {
198 err = MFXVideoCORE_GetHandle(device_hwctx->session, handle_types[i], &handle);
199 if (err == MFX_ERR_NONE) {
200 handle_type = handle_types[i];
205 /* create a "slave" session with those same properties, to be used for
206 * actual deinterlacing */
207 err = MFXInit(impl, &ver, &s->session);
208 if (err != MFX_ERR_NONE) {
209 av_log(ctx, AV_LOG_ERROR, "Error initializing a session for deinterlacing\n");
210 return AVERROR_UNKNOWN;
214 err = MFXVideoCORE_SetHandle(s->session, handle_type, handle);
215 if (err != MFX_ERR_NONE)
216 return AVERROR_UNKNOWN;
219 if (QSV_RUNTIME_VERSION_ATLEAST(ver, 1, 25)) {
220 err = MFXJoinSession(device_hwctx->session, s->session);
221 if (err != MFX_ERR_NONE)
222 return AVERROR_UNKNOWN;
225 memset(&par, 0, sizeof(par));
227 s->deint_conf.Header.BufferId = MFX_EXTBUFF_VPP_DEINTERLACING;
228 s->deint_conf.Header.BufferSz = sizeof(s->deint_conf);
229 s->deint_conf.Mode = s->mode;
231 s->ext_buffers[s->num_ext_buffers++] = (mfxExtBuffer *)&s->deint_conf;
234 s->surface_ptrs = av_mallocz_array(hw_frames_hwctx->nb_surfaces,
235 sizeof(*s->surface_ptrs));
236 if (!s->surface_ptrs)
237 return AVERROR(ENOMEM);
238 for (i = 0; i < hw_frames_hwctx->nb_surfaces; i++)
239 s->surface_ptrs[i] = hw_frames_hwctx->surfaces + i;
240 s->nb_surface_ptrs = hw_frames_hwctx->nb_surfaces;
242 s->opaque_alloc.In.Surfaces = s->surface_ptrs;
243 s->opaque_alloc.In.NumSurface = s->nb_surface_ptrs;
244 s->opaque_alloc.In.Type = hw_frames_hwctx->frame_type;
246 s->opaque_alloc.Out = s->opaque_alloc.In;
248 s->opaque_alloc.Header.BufferId = MFX_EXTBUFF_OPAQUE_SURFACE_ALLOCATION;
249 s->opaque_alloc.Header.BufferSz = sizeof(s->opaque_alloc);
251 s->ext_buffers[s->num_ext_buffers++] = (mfxExtBuffer *)&s->opaque_alloc;
253 par.IOPattern = MFX_IOPATTERN_IN_OPAQUE_MEMORY | MFX_IOPATTERN_OUT_OPAQUE_MEMORY;
255 mfxFrameAllocator frame_allocator = {
257 .Alloc = frame_alloc,
259 .Unlock = frame_unlock,
260 .GetHDL = frame_get_hdl,
264 s->mem_ids = av_mallocz_array(hw_frames_hwctx->nb_surfaces,
265 sizeof(*s->mem_ids));
267 return AVERROR(ENOMEM);
268 for (i = 0; i < hw_frames_hwctx->nb_surfaces; i++)
269 s->mem_ids[i] = hw_frames_hwctx->surfaces[i].Data.MemId;
270 s->nb_mem_ids = hw_frames_hwctx->nb_surfaces;
272 err = MFXVideoCORE_SetFrameAllocator(s->session, &frame_allocator);
273 if (err != MFX_ERR_NONE)
274 return AVERROR_UNKNOWN;
276 par.IOPattern = MFX_IOPATTERN_IN_VIDEO_MEMORY | MFX_IOPATTERN_OUT_VIDEO_MEMORY;
279 par.ExtParam = s->ext_buffers;
280 par.NumExtParam = s->num_ext_buffers;
282 par.AsyncDepth = 1; // TODO async
284 par.vpp.In = hw_frames_hwctx->surfaces[0].Info;
286 par.vpp.In.CropW = ctx->inputs[0]->w;
287 par.vpp.In.CropH = ctx->inputs[0]->h;
289 if (ctx->inputs[0]->frame_rate.num) {
290 par.vpp.In.FrameRateExtN = ctx->inputs[0]->frame_rate.num;
291 par.vpp.In.FrameRateExtD = ctx->inputs[0]->frame_rate.den;
293 par.vpp.In.FrameRateExtN = ctx->inputs[0]->time_base.num;
294 par.vpp.In.FrameRateExtD = ctx->inputs[0]->time_base.den;
297 par.vpp.Out = par.vpp.In;
299 if (ctx->outputs[0]->frame_rate.num) {
300 par.vpp.Out.FrameRateExtN = ctx->outputs[0]->frame_rate.num;
301 par.vpp.Out.FrameRateExtD = ctx->outputs[0]->frame_rate.den;
303 par.vpp.Out.FrameRateExtN = ctx->outputs[0]->time_base.num;
304 par.vpp.Out.FrameRateExtD = ctx->outputs[0]->time_base.den;
307 err = MFXVideoVPP_Init(s->session, &par);
308 if (err != MFX_ERR_NONE) {
309 av_log(ctx, AV_LOG_ERROR, "Error opening the VPP for deinterlacing: %d\n", err);
310 return AVERROR_UNKNOWN;
316 static int qsvdeint_config_props(AVFilterLink *outlink)
318 AVFilterContext *ctx = outlink->src;
319 AVFilterLink *inlink = ctx->inputs[0];
320 QSVDeintContext *s = ctx->priv;
323 qsvdeint_uninit(ctx);
325 s->last_pts = AV_NOPTS_VALUE;
326 outlink->frame_rate = av_mul_q(inlink->frame_rate,
327 (AVRational){ 2, 1 });
328 outlink->time_base = av_mul_q(inlink->time_base,
329 (AVRational){ 1, 2 });
331 /* check that we have a hw context */
332 if (!inlink->hw_frames_ctx) {
333 av_log(ctx, AV_LOG_ERROR, "No hw context provided on input\n");
334 return AVERROR(EINVAL);
337 s->hw_frames_ctx = av_buffer_ref(inlink->hw_frames_ctx);
338 if (!s->hw_frames_ctx)
339 return AVERROR(ENOMEM);
341 av_buffer_unref(&outlink->hw_frames_ctx);
342 outlink->hw_frames_ctx = av_buffer_ref(inlink->hw_frames_ctx);
343 if (!outlink->hw_frames_ctx) {
344 qsvdeint_uninit(ctx);
345 return AVERROR(ENOMEM);
348 ret = init_out_session(ctx);
356 static void clear_unused_frames(QSVDeintContext *s)
358 QSVFrame *cur = s->work_frames;
360 if (!cur->surface.Data.Locked) {
361 av_frame_free(&cur->frame);
368 static int get_free_frame(QSVDeintContext *s, QSVFrame **f)
370 QSVFrame *frame, **last;
372 clear_unused_frames(s);
374 frame = s->work_frames;
375 last = &s->work_frames;
386 frame = av_mallocz(sizeof(*frame));
388 return AVERROR(ENOMEM);
395 static int submit_frame(AVFilterContext *ctx, AVFrame *frame,
396 mfxFrameSurface1 **surface)
398 QSVDeintContext *s = ctx->priv;
402 ret = get_free_frame(s, &qf);
408 qf->surface = *(mfxFrameSurface1*)qf->frame->data[3];
410 qf->surface.Data.Locked = 0;
411 qf->surface.Info.CropW = qf->frame->width;
412 qf->surface.Info.CropH = qf->frame->height;
414 qf->surface.Info.PicStruct = !qf->frame->interlaced_frame ? MFX_PICSTRUCT_PROGRESSIVE :
415 (qf->frame->top_field_first ? MFX_PICSTRUCT_FIELD_TFF :
416 MFX_PICSTRUCT_FIELD_BFF);
417 if (qf->frame->repeat_pict == 1)
418 qf->surface.Info.PicStruct |= MFX_PICSTRUCT_FIELD_REPEATED;
419 else if (qf->frame->repeat_pict == 2)
420 qf->surface.Info.PicStruct |= MFX_PICSTRUCT_FRAME_DOUBLING;
421 else if (qf->frame->repeat_pict == 4)
422 qf->surface.Info.PicStruct |= MFX_PICSTRUCT_FRAME_TRIPLING;
424 if (ctx->inputs[0]->frame_rate.num) {
425 qf->surface.Info.FrameRateExtN = ctx->inputs[0]->frame_rate.num;
426 qf->surface.Info.FrameRateExtD = ctx->inputs[0]->frame_rate.den;
428 qf->surface.Info.FrameRateExtN = ctx->inputs[0]->time_base.num;
429 qf->surface.Info.FrameRateExtD = ctx->inputs[0]->time_base.den;
432 qf->surface.Data.TimeStamp = av_rescale_q(qf->frame->pts,
433 ctx->inputs[0]->time_base,
434 (AVRational){1, 90000});
436 *surface = &qf->surface;
442 static int process_frame(AVFilterContext *ctx, const AVFrame *in,
443 mfxFrameSurface1 *surf_in)
445 QSVDeintContext *s = ctx->priv;
446 AVFilterLink *inlink = ctx->inputs[0];
447 AVFilterLink *outlink = ctx->outputs[0];
450 mfxFrameSurface1 *surf_out;
451 mfxSyncPoint sync = NULL;
455 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
457 ret = AVERROR(ENOMEM);
461 surf_out = (mfxFrameSurface1*)out->data[3];
462 surf_out->Info.CropW = outlink->w;
463 surf_out->Info.CropH = outlink->h;
464 surf_out->Info.PicStruct = MFX_PICSTRUCT_PROGRESSIVE;
467 err = MFXVideoVPP_RunFrameVPPAsync(s->session, surf_in, surf_out,
469 if (err == MFX_WRN_DEVICE_BUSY)
471 } while (err == MFX_WRN_DEVICE_BUSY);
473 if (err == MFX_ERR_MORE_DATA) {
475 return QSVDEINT_MORE_INPUT;
478 if ((err < 0 && err != MFX_ERR_MORE_SURFACE) || !sync) {
479 av_log(ctx, AV_LOG_ERROR, "Error during deinterlacing: %d\n", err);
480 ret = AVERROR_UNKNOWN;
483 if (err == MFX_ERR_MORE_SURFACE)
487 err = MFXVideoCORE_SyncOperation(s->session, sync, 1000);
488 } while (err == MFX_WRN_IN_EXECUTION);
490 av_log(ctx, AV_LOG_ERROR, "Error synchronizing the operation: %d\n", err);
491 ret = AVERROR_UNKNOWN;
495 ret = av_frame_copy_props(out, in);
499 out->width = outlink->w;
500 out->height = outlink->h;
501 out->interlaced_frame = 0;
503 out->pts = av_rescale_q(out->pts, inlink->time_base, outlink->time_base);
504 if (out->pts == s->last_pts)
506 s->last_pts = out->pts;
508 ret = ff_filter_frame(outlink, out);
512 return again ? QSVDEINT_MORE_OUTPUT : 0;
518 static int qsvdeint_filter_frame(AVFilterLink *link, AVFrame *in)
520 AVFilterContext *ctx = link->dst;
522 mfxFrameSurface1 *surf_in;
525 ret = submit_frame(ctx, in, &surf_in);
532 ret = process_frame(ctx, in, surf_in);
535 } while (ret == QSVDEINT_MORE_OUTPUT);
540 static int qsvdeint_request_frame(AVFilterLink *outlink)
542 AVFilterContext *ctx = outlink->src;
544 return ff_request_frame(ctx->inputs[0]);
547 #define OFFSET(x) offsetof(QSVDeintContext, x)
548 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
549 static const AVOption options[] = {
550 { "mode", "set deinterlace mode", OFFSET(mode), AV_OPT_TYPE_INT, {.i64 = MFX_DEINTERLACING_ADVANCED}, MFX_DEINTERLACING_BOB, MFX_DEINTERLACING_ADVANCED, FLAGS, "mode"},
551 { "bob", "bob algorithm", 0, AV_OPT_TYPE_CONST, {.i64 = MFX_DEINTERLACING_BOB}, MFX_DEINTERLACING_BOB, MFX_DEINTERLACING_ADVANCED, FLAGS, "mode"},
552 { "advanced", "Motion adaptive algorithm", 0, AV_OPT_TYPE_CONST, {.i64 = MFX_DEINTERLACING_ADVANCED}, MFX_DEINTERLACING_BOB, MFX_DEINTERLACING_ADVANCED, FLAGS, "mode"},
556 static const AVClass qsvdeint_class = {
557 .class_name = "deinterlace_qsv",
558 .item_name = av_default_item_name,
560 .version = LIBAVUTIL_VERSION_INT,
563 static const AVFilterPad qsvdeint_inputs[] = {
566 .type = AVMEDIA_TYPE_VIDEO,
567 .filter_frame = qsvdeint_filter_frame,
572 static const AVFilterPad qsvdeint_outputs[] = {
575 .type = AVMEDIA_TYPE_VIDEO,
576 .config_props = qsvdeint_config_props,
577 .request_frame = qsvdeint_request_frame,
582 AVFilter ff_vf_deinterlace_qsv = {
583 .name = "deinterlace_qsv",
584 .description = NULL_IF_CONFIG_SMALL("QuickSync video deinterlacing"),
586 .uninit = qsvdeint_uninit,
587 .query_formats = qsvdeint_query_formats,
589 .priv_size = sizeof(QSVDeintContext),
590 .priv_class = &qsvdeint_class,
592 .inputs = qsvdeint_inputs,
593 .outputs = qsvdeint_outputs,
595 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,