2 * This file is part of Libav.
4 * Libav 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 * Libav 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 Libav; 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"
45 static const char *const var_names[] = {
71 typedef struct QSVScaleContext {
74 AVBufferRef *out_frames_ref;
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);
137 av_buffer_unref(&s->out_frames_ref);
139 av_freep(&s->mem_ids_in);
140 av_freep(&s->mem_ids_out);
141 s->nb_mem_ids_in = 0;
142 s->nb_mem_ids_out = 0;
144 av_freep(&s->surface_ptrs_in);
145 av_freep(&s->surface_ptrs_out);
146 s->nb_surface_ptrs_in = 0;
147 s->nb_surface_ptrs_out = 0;
150 static int qsvscale_query_formats(AVFilterContext *ctx)
152 static const enum AVPixelFormat pixel_formats[] = {
153 AV_PIX_FMT_QSV, AV_PIX_FMT_NONE,
155 AVFilterFormats *pix_fmts = ff_make_format_list(pixel_formats);
157 ff_set_common_formats(ctx, pix_fmts);
162 static int init_out_pool(AVFilterContext *ctx,
163 int out_width, int out_height)
165 QSVScaleContext *s = ctx->priv;
167 AVHWFramesContext *in_frames_ctx;
168 AVHWFramesContext *out_frames_ctx;
169 AVQSVFramesContext *in_frames_hwctx;
170 AVQSVFramesContext *out_frames_hwctx;
171 enum AVPixelFormat in_format;
172 enum AVPixelFormat out_format;
175 /* check that we have a hw context */
176 if (!ctx->inputs[0]->hw_frames_ctx) {
177 av_log(ctx, AV_LOG_ERROR, "No hw context provided on input\n");
178 return AVERROR(EINVAL);
180 in_frames_ctx = (AVHWFramesContext*)ctx->inputs[0]->hw_frames_ctx->data;
181 in_frames_hwctx = in_frames_ctx->hwctx;
183 in_format = in_frames_ctx->sw_format;
184 out_format = (s->format == AV_PIX_FMT_NONE) ? in_format : s->format;
186 s->out_frames_ref = av_hwframe_ctx_alloc(in_frames_ctx->device_ref);
187 if (!s->out_frames_ref)
188 return AVERROR(ENOMEM);
189 out_frames_ctx = (AVHWFramesContext*)s->out_frames_ref->data;
190 out_frames_hwctx = out_frames_ctx->hwctx;
192 out_frames_ctx->format = AV_PIX_FMT_QSV;
193 out_frames_ctx->width = FFALIGN(out_width, 32);
194 out_frames_ctx->height = FFALIGN(out_height, 32);
195 out_frames_ctx->sw_format = out_format;
196 out_frames_ctx->initial_pool_size = 32;
198 out_frames_hwctx->frame_type = in_frames_hwctx->frame_type;
200 ret = av_hwframe_ctx_init(s->out_frames_ref);
204 for (i = 0; i < out_frames_hwctx->nb_surfaces; i++) {
205 mfxFrameInfo *info = &out_frames_hwctx->surfaces[i].Info;
206 info->CropW = out_width;
207 info->CropH = out_height;
213 static mfxStatus frame_alloc(mfxHDL pthis, mfxFrameAllocRequest *req,
214 mfxFrameAllocResponse *resp)
216 AVFilterContext *ctx = pthis;
217 QSVScaleContext *s = ctx->priv;
219 if (!(req->Type & MFX_MEMTYPE_VIDEO_MEMORY_PROCESSOR_TARGET) ||
220 !(req->Type & (MFX_MEMTYPE_FROM_VPPIN | MFX_MEMTYPE_FROM_VPPOUT)) ||
221 !(req->Type & MFX_MEMTYPE_EXTERNAL_FRAME))
222 return MFX_ERR_UNSUPPORTED;
224 if (req->Type & MFX_MEMTYPE_FROM_VPPIN) {
225 resp->mids = s->mem_ids_in;
226 resp->NumFrameActual = s->nb_mem_ids_in;
228 resp->mids = s->mem_ids_out;
229 resp->NumFrameActual = s->nb_mem_ids_out;
235 static mfxStatus frame_free(mfxHDL pthis, mfxFrameAllocResponse *resp)
240 static mfxStatus frame_lock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
242 return MFX_ERR_UNSUPPORTED;
245 static mfxStatus frame_unlock(mfxHDL pthis, mfxMemId mid, mfxFrameData *ptr)
247 return MFX_ERR_UNSUPPORTED;
250 static mfxStatus frame_get_hdl(mfxHDL pthis, mfxMemId mid, mfxHDL *hdl)
256 static const mfxHandleType handle_types[] = {
257 MFX_HANDLE_VA_DISPLAY,
258 MFX_HANDLE_D3D9_DEVICE_MANAGER,
259 MFX_HANDLE_D3D11_DEVICE,
262 static int init_out_session(AVFilterContext *ctx)
265 QSVScaleContext *s = ctx->priv;
266 AVHWFramesContext *in_frames_ctx = (AVHWFramesContext*)ctx->inputs[0]->hw_frames_ctx->data;
267 AVHWFramesContext *out_frames_ctx = (AVHWFramesContext*)s->out_frames_ref->data;
268 AVQSVFramesContext *in_frames_hwctx = in_frames_ctx->hwctx;
269 AVQSVFramesContext *out_frames_hwctx = out_frames_ctx->hwctx;
270 AVQSVDeviceContext *device_hwctx = in_frames_ctx->device_ctx->hwctx;
272 int opaque = !!(in_frames_hwctx->frame_type & MFX_MEMTYPE_OPAQUE_FRAME);
274 mfxHDL handle = NULL;
275 mfxHandleType handle_type;
282 /* extract the properties of the "master" session given to us */
283 err = MFXQueryIMPL(device_hwctx->session, &impl);
284 if (err == MFX_ERR_NONE)
285 err = MFXQueryVersion(device_hwctx->session, &ver);
286 if (err != MFX_ERR_NONE) {
287 av_log(ctx, AV_LOG_ERROR, "Error querying the session attributes\n");
288 return AVERROR_UNKNOWN;
291 for (i = 0; i < FF_ARRAY_ELEMS(handle_types); i++) {
292 err = MFXVideoCORE_GetHandle(device_hwctx->session, handle_types[i], &handle);
293 if (err == MFX_ERR_NONE) {
294 handle_type = handle_types[i];
299 /* create a "slave" session with those same properties, to be used for
301 err = MFXInit(impl, &ver, &s->session);
302 if (err != MFX_ERR_NONE) {
303 av_log(ctx, AV_LOG_ERROR, "Error initializing a session for scaling\n");
304 return AVERROR_UNKNOWN;
308 err = MFXVideoCORE_SetHandle(s->session, handle_type, handle);
309 if (err != MFX_ERR_NONE)
310 return AVERROR_UNKNOWN;
313 memset(&par, 0, sizeof(par));
316 s->surface_ptrs_in = av_mallocz_array(in_frames_hwctx->nb_surfaces,
317 sizeof(*s->surface_ptrs_in));
318 if (!s->surface_ptrs_in)
319 return AVERROR(ENOMEM);
320 for (i = 0; i < in_frames_hwctx->nb_surfaces; i++)
321 s->surface_ptrs_in[i] = in_frames_hwctx->surfaces + i;
322 s->nb_surface_ptrs_in = in_frames_hwctx->nb_surfaces;
324 s->surface_ptrs_out = av_mallocz_array(out_frames_hwctx->nb_surfaces,
325 sizeof(*s->surface_ptrs_out));
326 if (!s->surface_ptrs_out)
327 return AVERROR(ENOMEM);
328 for (i = 0; i < out_frames_hwctx->nb_surfaces; i++)
329 s->surface_ptrs_out[i] = out_frames_hwctx->surfaces + i;
330 s->nb_surface_ptrs_out = out_frames_hwctx->nb_surfaces;
332 s->opaque_alloc.In.Surfaces = s->surface_ptrs_in;
333 s->opaque_alloc.In.NumSurface = s->nb_surface_ptrs_in;
334 s->opaque_alloc.In.Type = in_frames_hwctx->frame_type;
336 s->opaque_alloc.Out.Surfaces = s->surface_ptrs_out;
337 s->opaque_alloc.Out.NumSurface = s->nb_surface_ptrs_out;
338 s->opaque_alloc.Out.Type = out_frames_hwctx->frame_type;
340 s->opaque_alloc.Header.BufferId = MFX_EXTBUFF_OPAQUE_SURFACE_ALLOCATION;
341 s->opaque_alloc.Header.BufferSz = sizeof(s->opaque_alloc);
343 s->ext_buffers[0] = (mfxExtBuffer*)&s->opaque_alloc;
345 par.ExtParam = s->ext_buffers;
346 par.NumExtParam = FF_ARRAY_ELEMS(s->ext_buffers);
348 par.IOPattern = MFX_IOPATTERN_IN_OPAQUE_MEMORY | MFX_IOPATTERN_OUT_OPAQUE_MEMORY;
350 mfxFrameAllocator frame_allocator = {
352 .Alloc = frame_alloc,
354 .Unlock = frame_unlock,
355 .GetHDL = frame_get_hdl,
359 s->mem_ids_in = av_mallocz_array(in_frames_hwctx->nb_surfaces,
360 sizeof(*s->mem_ids_in));
362 return AVERROR(ENOMEM);
363 for (i = 0; i < in_frames_hwctx->nb_surfaces; i++)
364 s->mem_ids_in[i] = in_frames_hwctx->surfaces[i].Data.MemId;
365 s->nb_mem_ids_in = in_frames_hwctx->nb_surfaces;
367 s->mem_ids_out = av_mallocz_array(out_frames_hwctx->nb_surfaces,
368 sizeof(*s->mem_ids_out));
370 return AVERROR(ENOMEM);
371 for (i = 0; i < out_frames_hwctx->nb_surfaces; i++)
372 s->mem_ids_out[i] = out_frames_hwctx->surfaces[i].Data.MemId;
373 s->nb_mem_ids_out = out_frames_hwctx->nb_surfaces;
375 err = MFXVideoCORE_SetFrameAllocator(s->session, &frame_allocator);
376 if (err != MFX_ERR_NONE)
377 return AVERROR_UNKNOWN;
379 par.IOPattern = MFX_IOPATTERN_IN_VIDEO_MEMORY | MFX_IOPATTERN_OUT_VIDEO_MEMORY;
382 par.AsyncDepth = 1; // TODO async
384 par.vpp.In = in_frames_hwctx->surfaces[0].Info;
385 par.vpp.Out = out_frames_hwctx->surfaces[0].Info;
387 /* Apparently VPP requires the frame rate to be set to some value, otherwise
388 * init will fail (probably for the framerate conversion filter). Since we
389 * are only doing scaling here, we just invent an arbitrary
391 par.vpp.In.FrameRateExtN = 25;
392 par.vpp.In.FrameRateExtD = 1;
393 par.vpp.Out.FrameRateExtN = 25;
394 par.vpp.Out.FrameRateExtD = 1;
396 err = MFXVideoVPP_Init(s->session, &par);
397 if (err != MFX_ERR_NONE) {
398 av_log(ctx, AV_LOG_ERROR, "Error opening the VPP for scaling\n");
399 return AVERROR_UNKNOWN;
405 static int init_scale_session(AVFilterContext *ctx, int in_width, int in_height,
406 int out_width, int out_height)
408 QSVScaleContext *s = ctx->priv;
412 qsvscale_uninit(ctx);
414 ret = init_out_pool(ctx, out_width, out_height);
418 ret = init_out_session(ctx);
422 av_buffer_unref(&ctx->outputs[0]->hw_frames_ctx);
423 ctx->outputs[0]->hw_frames_ctx = av_buffer_ref(s->out_frames_ref);
424 if (!ctx->outputs[0]->hw_frames_ctx)
425 return AVERROR(ENOMEM);
430 static int qsvscale_config_props(AVFilterLink *outlink)
432 AVFilterContext *ctx = outlink->src;
433 AVFilterLink *inlink = outlink->src->inputs[0];
434 QSVScaleContext *s = ctx->priv;
436 double var_values[VARS_NB], res;
440 var_values[VAR_PI] = M_PI;
441 var_values[VAR_PHI] = M_PHI;
442 var_values[VAR_E] = M_E;
443 var_values[VAR_IN_W] = var_values[VAR_IW] = inlink->w;
444 var_values[VAR_IN_H] = var_values[VAR_IH] = inlink->h;
445 var_values[VAR_OUT_W] = var_values[VAR_OW] = NAN;
446 var_values[VAR_OUT_H] = var_values[VAR_OH] = NAN;
447 var_values[VAR_A] = (double) inlink->w / inlink->h;
448 var_values[VAR_SAR] = inlink->sample_aspect_ratio.num ?
449 (double) inlink->sample_aspect_ratio.num / inlink->sample_aspect_ratio.den : 1;
450 var_values[VAR_DAR] = var_values[VAR_A] * var_values[VAR_SAR];
452 /* evaluate width and height */
453 av_expr_parse_and_eval(&res, (expr = s->w_expr),
454 var_names, var_values,
455 NULL, NULL, NULL, NULL, NULL, 0, ctx);
456 s->w = var_values[VAR_OUT_W] = var_values[VAR_OW] = res;
457 if ((ret = av_expr_parse_and_eval(&res, (expr = s->h_expr),
458 var_names, var_values,
459 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
461 s->h = var_values[VAR_OUT_H] = var_values[VAR_OH] = res;
462 /* evaluate again the width, as it may depend on the output height */
463 if ((ret = av_expr_parse_and_eval(&res, (expr = s->w_expr),
464 var_names, var_values,
465 NULL, NULL, NULL, NULL, NULL, 0, ctx)) < 0)
472 /* sanity check params */
473 if (w < -1 || h < -1) {
474 av_log(ctx, AV_LOG_ERROR, "Size values less than -1 are not acceptable.\n");
475 return AVERROR(EINVAL);
477 if (w == -1 && h == -1)
485 w = av_rescale(h, inlink->w, inlink->h);
487 h = av_rescale(w, inlink->h, inlink->w);
489 if (w > INT_MAX || h > INT_MAX ||
490 (h * inlink->w) > INT_MAX ||
491 (w * inlink->h) > INT_MAX)
492 av_log(ctx, AV_LOG_ERROR, "Rescaled value for width or height is too big.\n");
497 ret = init_scale_session(ctx, inlink->w, inlink->h, w, h);
501 av_log(ctx, AV_LOG_VERBOSE, "w:%d h:%d -> w:%d h:%d\n",
502 inlink->w, inlink->h, outlink->w, outlink->h);
504 if (inlink->sample_aspect_ratio.num)
505 outlink->sample_aspect_ratio = av_mul_q((AVRational){outlink->h*inlink->w,
506 outlink->w*inlink->h},
507 inlink->sample_aspect_ratio);
509 outlink->sample_aspect_ratio = inlink->sample_aspect_ratio;
514 av_log(NULL, AV_LOG_ERROR,
515 "Error when evaluating the expression '%s'\n", expr);
519 static int qsvscale_filter_frame(AVFilterLink *link, AVFrame *in)
521 AVFilterContext *ctx = link->dst;
522 QSVScaleContext *s = ctx->priv;
523 AVFilterLink *outlink = ctx->outputs[0];
525 mfxSyncPoint sync = NULL;
531 out = ff_get_video_buffer(outlink, outlink->w, outlink->h);
533 ret = AVERROR(ENOMEM);
538 err = MFXVideoVPP_RunFrameVPPAsync(s->session,
539 (mfxFrameSurface1*)in->data[3],
540 (mfxFrameSurface1*)out->data[3],
542 if (err == MFX_WRN_DEVICE_BUSY)
544 } while (err == MFX_WRN_DEVICE_BUSY);
546 if (err < 0 || !sync) {
547 av_log(ctx, AV_LOG_ERROR, "Error during scaling\n");
548 ret = AVERROR_UNKNOWN;
553 err = MFXVideoCORE_SyncOperation(s->session, sync, 1000);
554 } while (err == MFX_WRN_IN_EXECUTION);
556 av_log(ctx, AV_LOG_ERROR, "Error synchronizing the operation: %d\n", err);
557 ret = AVERROR_UNKNOWN;
561 ret = av_frame_copy_props(out, in);
565 out->width = outlink->w;
566 out->height = outlink->h;
568 av_reduce(&out->sample_aspect_ratio.num, &out->sample_aspect_ratio.den,
569 (int64_t)in->sample_aspect_ratio.num * outlink->h * link->w,
570 (int64_t)in->sample_aspect_ratio.den * outlink->w * link->h,
574 return ff_filter_frame(outlink, out);
581 #define OFFSET(x) offsetof(QSVScaleContext, x)
582 #define FLAGS AV_OPT_FLAG_VIDEO_PARAM
583 static const AVOption options[] = {
584 { "w", "Output video width", OFFSET(w_expr), AV_OPT_TYPE_STRING, { .str = "iw" }, .flags = FLAGS },
585 { "h", "Output video height", OFFSET(h_expr), AV_OPT_TYPE_STRING, { .str = "ih" }, .flags = FLAGS },
586 { "format", "Output pixel format", OFFSET(format_str), AV_OPT_TYPE_STRING, { .str = "same" }, .flags = FLAGS },
591 static const AVClass qsvscale_class = {
592 .class_name = "qsvscale",
593 .item_name = av_default_item_name,
595 .version = LIBAVUTIL_VERSION_INT,
598 static const AVFilterPad qsvscale_inputs[] = {
601 .type = AVMEDIA_TYPE_VIDEO,
602 .filter_frame = qsvscale_filter_frame,
607 static const AVFilterPad qsvscale_outputs[] = {
610 .type = AVMEDIA_TYPE_VIDEO,
611 .config_props = qsvscale_config_props,
616 AVFilter ff_vf_scale_qsv = {
618 .description = NULL_IF_CONFIG_SMALL("QuickSync video scaling and format conversion"),
620 .init = qsvscale_init,
621 .uninit = qsvscale_uninit,
622 .query_formats = qsvscale_query_formats,
624 .priv_size = sizeof(QSVScaleContext),
625 .priv_class = &qsvscale_class,
627 .inputs = qsvscale_inputs,
628 .outputs = qsvscale_outputs,
630 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,