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 * scale video filter - QSV
24 #include <mfx/mfxvideo.h>
29 #include "libavutil/avstring.h"
30 #include "libavutil/common.h"
31 #include "libavutil/eval.h"
32 #include "libavutil/hwcontext.h"
33 #include "libavutil/hwcontext_qsv.h"
34 #include "libavutil/internal.h"
35 #include "libavutil/mathematics.h"
36 #include "libavutil/opt.h"
37 #include "libavutil/pixdesc.h"
38 #include "libavutil/time.h"
39 #include "libavfilter/qsvvpp.h"
46 static const char *const var_names[] = {
72 typedef struct QSVScaleContext {
75 /* a clone of the main session, used internally for scaling */
81 mfxMemId *mem_ids_out;
84 mfxFrameSurface1 **surface_ptrs_in;
85 int nb_surface_ptrs_in;
87 mfxFrameSurface1 **surface_ptrs_out;
88 int nb_surface_ptrs_out;
90 mfxExtOpaqueSurfaceAlloc opaque_alloc;
91 mfxExtBuffer *ext_buffers[1];
93 int shift_width, shift_height;
96 * New dimensions. Special values are:
97 * 0 = original width/height
98 * -1 = keep original aspect
103 * Output sw format. AV_PIX_FMT_NONE for no conversion.
105 enum AVPixelFormat format;
107 char *w_expr; ///< width expression string
108 char *h_expr; ///< height expression string
112 static int qsvscale_init(AVFilterContext *ctx)
114 QSVScaleContext *s = ctx->priv;
116 if (!strcmp(s->format_str, "same")) {
117 s->format = AV_PIX_FMT_NONE;
119 s->format = av_get_pix_fmt(s->format_str);
120 if (s->format == AV_PIX_FMT_NONE) {
121 av_log(ctx, AV_LOG_ERROR, "Unrecognized pixel format: %s\n", s->format_str);
122 return AVERROR(EINVAL);
129 static void qsvscale_uninit(AVFilterContext *ctx)
131 QSVScaleContext *s = ctx->priv;
134 MFXClose(s->session);
138 av_freep(&s->mem_ids_in);
139 av_freep(&s->mem_ids_out);
140 s->nb_mem_ids_in = 0;
141 s->nb_mem_ids_out = 0;
143 av_freep(&s->surface_ptrs_in);
144 av_freep(&s->surface_ptrs_out);
145 s->nb_surface_ptrs_in = 0;
146 s->nb_surface_ptrs_out = 0;
149 static int qsvscale_query_formats(AVFilterContext *ctx)
151 static const enum AVPixelFormat pixel_formats[] = {
152 AV_PIX_FMT_QSV, AV_PIX_FMT_NONE,
154 AVFilterFormats *pix_fmts = ff_make_format_list(pixel_formats);
157 if ((ret = ff_set_common_formats(ctx, pix_fmts)) < 0)
163 static int init_out_pool(AVFilterContext *ctx,
164 int out_width, int out_height)
166 QSVScaleContext *s = ctx->priv;
167 AVFilterLink *outlink = ctx->outputs[0];
169 AVHWFramesContext *in_frames_ctx;
170 AVHWFramesContext *out_frames_ctx;
171 AVQSVFramesContext *in_frames_hwctx;
172 AVQSVFramesContext *out_frames_hwctx;
173 enum AVPixelFormat in_format;
174 enum AVPixelFormat out_format;
177 /* check that we have a hw context */
178 if (!ctx->inputs[0]->hw_frames_ctx) {
179 av_log(ctx, AV_LOG_ERROR, "No hw context provided on input\n");
180 return AVERROR(EINVAL);
182 in_frames_ctx = (AVHWFramesContext*)ctx->inputs[0]->hw_frames_ctx->data;
183 in_frames_hwctx = in_frames_ctx->hwctx;
185 in_format = in_frames_ctx->sw_format;
186 out_format = (s->format == AV_PIX_FMT_NONE) ? in_format : s->format;
188 outlink->hw_frames_ctx = av_hwframe_ctx_alloc(in_frames_ctx->device_ref);
189 if (!outlink->hw_frames_ctx)
190 return AVERROR(ENOMEM);
191 out_frames_ctx = (AVHWFramesContext*)outlink->hw_frames_ctx->data;
192 out_frames_hwctx = out_frames_ctx->hwctx;
194 out_frames_ctx->format = AV_PIX_FMT_QSV;
195 out_frames_ctx->width = FFALIGN(out_width, 32);
196 out_frames_ctx->height = FFALIGN(out_height, 32);
197 out_frames_ctx->sw_format = out_format;
198 out_frames_ctx->initial_pool_size = 4;
200 out_frames_hwctx->frame_type = in_frames_hwctx->frame_type;
202 ret = ff_filter_init_hw_frames(ctx, outlink, 32);
206 ret = av_hwframe_ctx_init(outlink->hw_frames_ctx);
210 for (i = 0; i < out_frames_hwctx->nb_surfaces; i++) {
211 mfxFrameInfo *info = &out_frames_hwctx->surfaces[i].Info;
212 info->CropW = out_width;
213 info->CropH = out_height;
219 static mfxStatus frame_alloc(mfxHDL pthis, mfxFrameAllocRequest *req,
220 mfxFrameAllocResponse *resp)
222 AVFilterContext *ctx = pthis;
223 QSVScaleContext *s = ctx->priv;
225 if (!(req->Type & MFX_MEMTYPE_VIDEO_MEMORY_PROCESSOR_TARGET) ||
226 !(req->Type & (MFX_MEMTYPE_FROM_VPPIN | MFX_MEMTYPE_FROM_VPPOUT)) ||
227 !(req->Type & MFX_MEMTYPE_EXTERNAL_FRAME))
228 return MFX_ERR_UNSUPPORTED;
230 if (req->Type & MFX_MEMTYPE_FROM_VPPIN) {
231 resp->mids = s->mem_ids_in;
232 resp->NumFrameActual = s->nb_mem_ids_in;
234 resp->mids = s->mem_ids_out;
235 resp->NumFrameActual = s->nb_mem_ids_out;
241 static mfxStatus frame_free(mfxHDL pthis, mfxFrameAllocResponse *resp)
246 static mfxStatus frame_lock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
248 return MFX_ERR_UNSUPPORTED;
251 static mfxStatus frame_unlock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
253 return MFX_ERR_UNSUPPORTED;
256 static mfxStatus frame_get_hdl(mfxHDL pthis, mfxMemId mid, mfxHDL *hdl)
262 static const mfxHandleType handle_types[] = {
263 MFX_HANDLE_VA_DISPLAY,
264 MFX_HANDLE_D3D9_DEVICE_MANAGER,
265 MFX_HANDLE_D3D11_DEVICE,
268 static int init_out_session(AVFilterContext *ctx)
271 QSVScaleContext *s = ctx->priv;
272 AVHWFramesContext *in_frames_ctx = (AVHWFramesContext*)ctx->inputs[0]->hw_frames_ctx->data;
273 AVHWFramesContext *out_frames_ctx = (AVHWFramesContext*)ctx->outputs[0]->hw_frames_ctx->data;
274 AVQSVFramesContext *in_frames_hwctx = in_frames_ctx->hwctx;
275 AVQSVFramesContext *out_frames_hwctx = out_frames_ctx->hwctx;
276 AVQSVDeviceContext *device_hwctx = in_frames_ctx->device_ctx->hwctx;
278 int opaque = !!(in_frames_hwctx->frame_type & MFX_MEMTYPE_OPAQUE_FRAME);
280 mfxHDL handle = NULL;
281 mfxHandleType handle_type;
288 /* extract the properties of the "master" session given to us */
289 err = MFXQueryIMPL(device_hwctx->session, &impl);
290 if (err == MFX_ERR_NONE)
291 err = MFXQueryVersion(device_hwctx->session, &ver);
292 if (err != MFX_ERR_NONE) {
293 av_log(ctx, AV_LOG_ERROR, "Error querying the session attributes\n");
294 return AVERROR_UNKNOWN;
297 for (i = 0; i < FF_ARRAY_ELEMS(handle_types); i++) {
298 err = MFXVideoCORE_GetHandle(device_hwctx->session, handle_types[i], &handle);
299 if (err == MFX_ERR_NONE) {
300 handle_type = handle_types[i];
305 if (err != MFX_ERR_NONE) {
306 av_log(ctx, AV_LOG_ERROR, "Error getting the session handle\n");
307 return AVERROR_UNKNOWN;
310 /* create a "slave" session with those same properties, to be used for
312 err = MFXInit(impl, &ver, &s->session);
313 if (err != MFX_ERR_NONE) {
314 av_log(ctx, AV_LOG_ERROR, "Error initializing a session for scaling\n");
315 return AVERROR_UNKNOWN;
319 err = MFXVideoCORE_SetHandle(s->session, handle_type, handle);
320 if (err != MFX_ERR_NONE)
321 return AVERROR_UNKNOWN;
324 if (QSV_RUNTIME_VERSION_ATLEAST(ver, 1, 25)) {
325 err = MFXJoinSession(device_hwctx->session, s->session);
326 if (err != MFX_ERR_NONE)
327 return AVERROR_UNKNOWN;
330 memset(&par, 0, sizeof(par));
333 s->surface_ptrs_in = av_mallocz_array(in_frames_hwctx->nb_surfaces,
334 sizeof(*s->surface_ptrs_in));
335 if (!s->surface_ptrs_in)
336 return AVERROR(ENOMEM);
337 for (i = 0; i < in_frames_hwctx->nb_surfaces; i++)
338 s->surface_ptrs_in[i] = in_frames_hwctx->surfaces + i;
339 s->nb_surface_ptrs_in = in_frames_hwctx->nb_surfaces;
341 s->surface_ptrs_out = av_mallocz_array(out_frames_hwctx->nb_surfaces,
342 sizeof(*s->surface_ptrs_out));
343 if (!s->surface_ptrs_out)
344 return AVERROR(ENOMEM);
345 for (i = 0; i < out_frames_hwctx->nb_surfaces; i++)
346 s->surface_ptrs_out[i] = out_frames_hwctx->surfaces + i;
347 s->nb_surface_ptrs_out = out_frames_hwctx->nb_surfaces;
349 s->opaque_alloc.In.Surfaces = s->surface_ptrs_in;
350 s->opaque_alloc.In.NumSurface = s->nb_surface_ptrs_in;
351 s->opaque_alloc.In.Type = in_frames_hwctx->frame_type;
353 s->opaque_alloc.Out.Surfaces = s->surface_ptrs_out;
354 s->opaque_alloc.Out.NumSurface = s->nb_surface_ptrs_out;
355 s->opaque_alloc.Out.Type = out_frames_hwctx->frame_type;
357 s->opaque_alloc.Header.BufferId = MFX_EXTBUFF_OPAQUE_SURFACE_ALLOCATION;
358 s->opaque_alloc.Header.BufferSz = sizeof(s->opaque_alloc);
360 s->ext_buffers[0] = (mfxExtBuffer*)&s->opaque_alloc;
362 par.ExtParam = s->ext_buffers;
363 par.NumExtParam = FF_ARRAY_ELEMS(s->ext_buffers);
365 par.IOPattern = MFX_IOPATTERN_IN_OPAQUE_MEMORY | MFX_IOPATTERN_OUT_OPAQUE_MEMORY;
367 mfxFrameAllocator frame_allocator = {
369 .Alloc = frame_alloc,
371 .Unlock = frame_unlock,
372 .GetHDL = frame_get_hdl,
376 s->mem_ids_in = av_mallocz_array(in_frames_hwctx->nb_surfaces,
377 sizeof(*s->mem_ids_in));
379 return AVERROR(ENOMEM);
380 for (i = 0; i < in_frames_hwctx->nb_surfaces; i++)
381 s->mem_ids_in[i] = in_frames_hwctx->surfaces[i].Data.MemId;
382 s->nb_mem_ids_in = in_frames_hwctx->nb_surfaces;
384 s->mem_ids_out = av_mallocz_array(out_frames_hwctx->nb_surfaces,
385 sizeof(*s->mem_ids_out));
387 return AVERROR(ENOMEM);
388 for (i = 0; i < out_frames_hwctx->nb_surfaces; i++)
389 s->mem_ids_out[i] = out_frames_hwctx->surfaces[i].Data.MemId;
390 s->nb_mem_ids_out = out_frames_hwctx->nb_surfaces;
392 err = MFXVideoCORE_SetFrameAllocator(s->session, &frame_allocator);
393 if (err != MFX_ERR_NONE)
394 return AVERROR_UNKNOWN;
396 par.IOPattern = MFX_IOPATTERN_IN_VIDEO_MEMORY | MFX_IOPATTERN_OUT_VIDEO_MEMORY;
399 par.AsyncDepth = 1; // TODO async
401 par.vpp.In = in_frames_hwctx->surfaces[0].Info;
402 par.vpp.Out = out_frames_hwctx->surfaces[0].Info;
404 /* Apparently VPP requires the frame rate to be set to some value, otherwise
405 * init will fail (probably for the framerate conversion filter). Since we
406 * are only doing scaling here, we just invent an arbitrary
408 par.vpp.In.FrameRateExtN = 25;
409 par.vpp.In.FrameRateExtD = 1;
410 par.vpp.Out.FrameRateExtN = 25;
411 par.vpp.Out.FrameRateExtD = 1;
413 err = MFXVideoVPP_Init(s->session, &par);
414 if (err != MFX_ERR_NONE) {
415 av_log(ctx, AV_LOG_ERROR, "Error opening the VPP for scaling\n");
416 return AVERROR_UNKNOWN;
422 static int init_scale_session(AVFilterContext *ctx, int in_width, int in_height,
423 int out_width, int out_height)
427 qsvscale_uninit(ctx);
429 ret = init_out_pool(ctx, out_width, out_height);
433 ret = init_out_session(ctx);
440 static int qsvscale_config_props(AVFilterLink *outlink)
442 AVFilterContext *ctx = outlink->src;
443 AVFilterLink *inlink = outlink->src->inputs[0];
444 QSVScaleContext *s = ctx->priv;
446 double var_values[VARS_NB], res;
450 var_values[VAR_PI] = M_PI;
451 var_values[VAR_PHI] = M_PHI;
452 var_values[VAR_E] = M_E;
453 var_values[VAR_IN_W] = var_values[VAR_IW] = inlink->w;
454 var_values[VAR_IN_H] = var_values[VAR_IH] = inlink->h;
455 var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
456 var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
457 var_values[VAR_A] = (double) inlink->w / inlink->h;
458 var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ?
459 (double) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
460 var_values[VAR_DAR] = var_values[VAR_A] * var_values[VAR_SAR];
462 /* evaluate width and height */
463 av_expr_parse_and_eval(&res, (expr = s->w_expr),
464 var_names, var_values,
465 NULL, NULL, NULL, NULL, NULL, 0, ctx);
466 s->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
467 if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
468 var_names, var_values,
469 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
471 s->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
472 /* evaluate again the width, as it may depend on the output height */
473 if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
474 var_names, var_values,
475 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
482 /* sanity check params */
483 if (w < -1 || h < -1) {
484 av_log(ctx, AV_LOG_ERROR, "Size values less than -1 are not acceptable.\n");
485 return AVERROR(EINVAL);
487 if (w == -1 && h == -1)
495 w = av_rescale(h, inlink->w, inlink->h);
497 h = av_rescale(w, inlink->h, inlink->w);
499 if (w > INT_MAX || h > INT_MAX ||
500 (h * inlink->w) > INT_MAX ||
501 (w * inlink->h) > INT_MAX)
502 av_log(ctx, AV_LOG_ERROR, "Rescaled value for width or height is too big.\n");
507 ret = init_scale_session(ctx, inlink->w, inlink->h, w, h);
511 av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d -> w:%d h:%d\n",
512 inlink->w, inlink->h, outlink->w, outlink->h);
514 if (inlink->sample_aspect_ratio.num)
515 outlink->sample_aspect_ratio = av_mul_q((AVRational){outlink->h*inlink->w,
516 outlink->w*inlink->h},
517 inlink->sample_aspect_ratio);
519 outlink->sample_aspect_ratio = inlink->sample_aspect_ratio;
524 av_log(NULL, AV_LOG_ERROR,
525 "Error when evaluating the expression '%s'\n", expr);
529 static int qsvscale_filter_frame(AVFilterLink *link, AVFrame *in)
531 AVFilterContext *ctx = link->dst;
532 QSVScaleContext *s = ctx->priv;
533 AVFilterLink *outlink = ctx->outputs[0];
535 mfxSyncPoint sync = NULL;
541 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
543 ret = AVERROR(ENOMEM);
548 err = MFXVideoVPP_RunFrameVPPAsync(s->session,
549 (mfxFrameSurface1*)in->data[3],
550 (mfxFrameSurface1*)out->data[3],
552 if (err == MFX_WRN_DEVICE_BUSY)
554 } while (err == MFX_WRN_DEVICE_BUSY);
556 if (err < 0 || !sync) {
557 av_log(ctx, AV_LOG_ERROR, "Error during scaling\n");
558 ret = AVERROR_UNKNOWN;
563 err = MFXVideoCORE_SyncOperation(s->session, sync, 1000);
564 } while (err == MFX_WRN_IN_EXECUTION);
566 av_log(ctx, AV_LOG_ERROR, "Error synchronizing the operation: %d\n", err);
567 ret = AVERROR_UNKNOWN;
571 ret = av_frame_copy_props(out, in);
575 out->width = outlink->w;
576 out->height = outlink->h;
578 av_reduce(&out->sample_aspect_ratio.num, &out->sample_aspect_ratio.den,
579 (int64_t)in->sample_aspect_ratio.num * outlink->h * link->w,
580 (int64_t)in->sample_aspect_ratio.den * outlink->w * link->h,
584 return ff_filter_frame(outlink, out);
591 #define OFFSET(x) offsetof(QSVScaleContext, x)
592 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM
593 static const AVOption options[] = {
594 { "w", "Output video width", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str = "iw" }, .flags = FLAGS },
595 { "h", "Output video height", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str = "ih" }, .flags = FLAGS },
596 { "format", "Output pixel format", OFFSET(format_str), AV_OPT_TYPE_STRING, { .str = "same" }, .flags = FLAGS },
601 static const AVClass qsvscale_class = {
602 .class_name = "qsvscale",
603 .item_name = av_default_item_name,
605 .version = LIBAVUTIL_VERSION_INT,
608 static const AVFilterPad qsvscale_inputs[] = {
611 .type = AVMEDIA_TYPE_VIDEO,
612 .filter_frame = qsvscale_filter_frame,
617 static const AVFilterPad qsvscale_outputs[] = {
620 .type = AVMEDIA_TYPE_VIDEO,
621 .config_props = qsvscale_config_props,
626 AVFilter ff_vf_scale_qsv = {
628 .description = NULL_IF_CONFIG_SMALL("QuickSync video scaling and format conversion"),
630 .init = qsvscale_init,
631 .uninit = qsvscale_uninit,
632 .query_formats = qsvscale_query_formats,
634 .priv_size = sizeof(QSVScaleContext),
635 .priv_class = &qsvscale_class,
637 .inputs = qsvscale_inputs,
638 .outputs = qsvscale_outputs,
640 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,