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 ** Hardware accelerated common filters based on Intel Quick Sync Video VPP
26 #include "libavutil/opt.h"
27 #include "libavutil/eval.h"
28 #include "libavutil/avassert.h"
29 #include "libavutil/pixdesc.h"
30 #include "libavutil/mathematics.h"
35 #include "libavcodec/avcodec.h"
36 #include "libavformat/avformat.h"
40 #define OFFSET(x) offsetof(VPPContext, x)
41 #define FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM)
43 /* number of video enhancement filters */
44 #define ENH_FILTERS_COUNT (5)
46 typedef struct VPPContext{
51 /* Video Enhancement Algorithms */
52 mfxExtVPPDeinterlacing deinterlace_conf;
53 mfxExtVPPFrameRateConversion frc_conf;
54 mfxExtVPPDenoise denoise_conf;
55 mfxExtVPPDetail detail_conf;
56 mfxExtVPPProcAmp procamp_conf;
61 AVRational framerate; /* target framerate */
62 int use_frc; /* use framerate conversion */
63 int deinterlace; /* deinterlace mode : 0=off, 1=bob, 2=advanced */
64 int denoise; /* Enable Denoise algorithm. Value [0, 100] */
65 int detail; /* Enable Detail Enhancement algorithm. */
66 /* Level is the optional, value [0, 100] */
67 int use_crop; /* 1 = use crop; 0=none */
73 /* param for the procamp */
74 int procamp; /* enable procamp */
80 char *cx, *cy, *cw, *ch;
84 static const AVOption options[] = {
85 { "deinterlace", "deinterlace mode: 0=off, 1=bob, 2=advanced", OFFSET(deinterlace), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, MFX_DEINTERLACING_ADVANCED, .flags = FLAGS, "deinterlace" },
86 { "bob", "Bob deinterlace mode.", 0, AV_OPT_TYPE_CONST, { .i64 = MFX_DEINTERLACING_BOB }, .flags = FLAGS, "deinterlace" },
87 { "advanced", "Advanced deinterlace mode. ", 0, AV_OPT_TYPE_CONST, { .i64 = MFX_DEINTERLACING_ADVANCED }, .flags = FLAGS, "deinterlace" },
89 { "denoise", "denoise level [0, 100]", OFFSET(denoise), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 100, .flags = FLAGS },
90 { "detail", "enhancement level [0, 100]", OFFSET(detail), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 100, .flags = FLAGS },
91 { "framerate", "output framerate", OFFSET(framerate), AV_OPT_TYPE_RATIONAL, { .dbl = 0.0 },0, DBL_MAX, .flags = FLAGS },
92 { "procamp", "Enable ProcAmp", OFFSET(procamp), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, .flags = FLAGS},
93 { "hue", "ProcAmp hue", OFFSET(hue), AV_OPT_TYPE_FLOAT, { .dbl = 0.0 }, -180.0, 180.0, .flags = FLAGS},
94 { "saturation", "ProcAmp saturation", OFFSET(saturation), AV_OPT_TYPE_FLOAT, { .dbl = 1.0 }, 0.0, 10.0, .flags = FLAGS},
95 { "contrast", "ProcAmp contrast", OFFSET(contrast), AV_OPT_TYPE_FLOAT, { .dbl = 1.0 }, 0.0, 10.0, .flags = FLAGS},
96 { "brightness", "ProcAmp brightness", OFFSET(brightness), AV_OPT_TYPE_FLOAT, { .dbl = 0.0 }, -100.0, 100.0, .flags = FLAGS},
98 { "cw", "set the width crop area expression", OFFSET(cw), AV_OPT_TYPE_STRING, { .str = "iw" }, CHAR_MIN, CHAR_MAX, FLAGS },
99 { "ch", "set the height crop area expression", OFFSET(ch), AV_OPT_TYPE_STRING, { .str = "ih" }, CHAR_MIN, CHAR_MAX, FLAGS },
100 { "cx", "set the x crop area expression", OFFSET(cx), AV_OPT_TYPE_STRING, { .str = "(in_w-out_w)/2" }, CHAR_MIN, CHAR_MAX, FLAGS },
101 { "cy", "set the y crop area expression", OFFSET(cy), AV_OPT_TYPE_STRING, { .str = "(in_h-out_h)/2" }, CHAR_MIN, CHAR_MAX, FLAGS },
103 { "w", "Output video width", OFFSET(ow), AV_OPT_TYPE_STRING, { .str="cw" }, 0, 255, .flags = FLAGS },
104 { "width", "Output video width", OFFSET(ow), AV_OPT_TYPE_STRING, { .str="cw" }, 0, 255, .flags = FLAGS },
105 { "h", "Output video height", OFFSET(oh), AV_OPT_TYPE_STRING, { .str="w*ch/cw" }, 0, 255, .flags = FLAGS },
106 { "height", "Output video height", OFFSET(oh), AV_OPT_TYPE_STRING, { .str="w*ch/cw" }, 0, 255, .flags = FLAGS },
110 static const char *const var_names[] = {
125 VAR_oW, VAR_OUT_W, VAR_W,
126 VAR_oH, VAR_OUT_H, VAR_H,
134 static int eval_expr(AVFilterContext *ctx)
136 #define PASS_EXPR(e, s) {\
137 ret = av_expr_parse(&e, s, var_names, NULL, NULL, NULL, NULL, 0, ctx); \
139 av_log(ctx, AV_LOG_ERROR, "Error when passing '%s'.\n", s);\
143 #define CALC_EXPR(e, v, i) {\
144 i = v = av_expr_eval(e, var_values, NULL); \
146 VPPContext *vpp = ctx->priv;
147 double var_values[VAR_VARS_NB] = { NAN };
148 AVExpr *w_expr = NULL, *h_expr = NULL;
149 AVExpr *cw_expr = NULL, *ch_expr = NULL;
150 AVExpr *cx_expr = NULL, *cy_expr = NULL;
153 PASS_EXPR(cw_expr, vpp->cw);
154 PASS_EXPR(ch_expr, vpp->ch);
156 PASS_EXPR(w_expr, vpp->ow);
157 PASS_EXPR(h_expr, vpp->oh);
159 PASS_EXPR(cx_expr, vpp->cx);
160 PASS_EXPR(cy_expr, vpp->cy);
163 var_values[VAR_IN_W] = ctx->inputs[0]->w;
166 var_values[VAR_IN_H] = ctx->inputs[0]->h;
169 CALC_EXPR(cw_expr, var_values[CW], vpp->crop_w);
170 CALC_EXPR(ch_expr, var_values[CH], vpp->crop_h);
172 /* calc again in case cw is relative to ch */
173 CALC_EXPR(cw_expr, var_values[CW], vpp->crop_w);
176 var_values[VAR_OUT_W] = var_values[VAR_oW] = var_values[VAR_W],
179 var_values[VAR_OUT_H] = var_values[VAR_oH] = var_values[VAR_H],
182 /* calc again in case ow is relative to oh */
184 var_values[VAR_OUT_W] = var_values[VAR_oW] = var_values[VAR_W],
188 CALC_EXPR(cx_expr, var_values[CX], vpp->crop_x);
189 CALC_EXPR(cy_expr, var_values[CY], vpp->crop_y);
191 /* calc again in case cx is relative to cy */
192 CALC_EXPR(cx_expr, var_values[CX], vpp->crop_x);
194 if ((vpp->crop_w != var_values[VAR_iW]) || (vpp->crop_h != var_values[VAR_iH]))
198 av_expr_free(w_expr);
199 av_expr_free(h_expr);
200 av_expr_free(cw_expr);
201 av_expr_free(ch_expr);
202 av_expr_free(cx_expr);
203 av_expr_free(cy_expr);
210 static int config_input(AVFilterLink *inlink)
212 AVFilterContext *ctx = inlink->dst;
213 VPPContext *vpp = ctx->priv;
216 if (vpp->framerate.den == 0 || vpp->framerate.num == 0)
217 vpp->framerate = inlink->frame_rate;
219 if (av_cmp_q(vpp->framerate, inlink->frame_rate))
222 ret = eval_expr(ctx);
224 av_log(ctx, AV_LOG_ERROR, "Fail to eval expr.\n");
228 if (vpp->out_height == 0 || vpp->out_width == 0) {
229 vpp->out_width = inlink->w;
230 vpp->out_height = inlink->h;
234 vpp->crop_x = FFMAX(vpp->crop_x, 0);
235 vpp->crop_y = FFMAX(vpp->crop_y, 0);
237 if(vpp->crop_w + vpp->crop_x > inlink->w)
238 vpp->crop_x = inlink->w - vpp->crop_w;
239 if(vpp->crop_h + vpp->crop_y > inlink->h)
240 vpp->crop_y = inlink->h - vpp->crop_h;
246 static int config_output(AVFilterLink *outlink)
248 AVFilterContext *ctx = outlink->src;
249 VPPContext *vpp = ctx->priv;
250 QSVVPPParam param = { NULL };
251 QSVVPPCrop crop = { 0 };
252 mfxExtBuffer *ext_buf[ENH_FILTERS_COUNT];
253 AVFilterLink *inlink = ctx->inputs[0];
255 outlink->w = vpp->out_width;
256 outlink->h = vpp->out_height;
257 outlink->frame_rate = vpp->framerate;
258 outlink->time_base = av_inv_q(vpp->framerate);
260 param.filter_frame = NULL;
261 param.out_sw_format = AV_PIX_FMT_NV12;
262 param.num_ext_buf = 0;
263 param.ext_buf = ext_buf;
267 crop.x = vpp->crop_x;
268 crop.y = vpp->crop_y;
269 crop.w = vpp->crop_w;
270 crop.h = vpp->crop_h;
276 if (vpp->deinterlace) {
277 memset(&vpp->deinterlace_conf, 0, sizeof(mfxExtVPPDeinterlacing));
278 vpp->deinterlace_conf.Header.BufferId = MFX_EXTBUFF_VPP_DEINTERLACING;
279 vpp->deinterlace_conf.Header.BufferSz = sizeof(mfxExtVPPDeinterlacing);
280 vpp->deinterlace_conf.Mode = vpp->deinterlace == 1 ?
281 MFX_DEINTERLACING_BOB : MFX_DEINTERLACING_ADVANCED;
283 param.ext_buf[param.num_ext_buf++] = (mfxExtBuffer*)&vpp->deinterlace_conf;
287 memset(&vpp->frc_conf, 0, sizeof(mfxExtVPPFrameRateConversion));
288 vpp->frc_conf.Header.BufferId = MFX_EXTBUFF_VPP_FRAME_RATE_CONVERSION;
289 vpp->frc_conf.Header.BufferSz = sizeof(mfxExtVPPFrameRateConversion);
290 vpp->frc_conf.Algorithm = MFX_FRCALGM_DISTRIBUTED_TIMESTAMP;
292 param.ext_buf[param.num_ext_buf++] = (mfxExtBuffer*)&vpp->frc_conf;
296 memset(&vpp->denoise_conf, 0, sizeof(mfxExtVPPDenoise));
297 vpp->denoise_conf.Header.BufferId = MFX_EXTBUFF_VPP_DENOISE;
298 vpp->denoise_conf.Header.BufferSz = sizeof(mfxExtVPPDenoise);
299 vpp->denoise_conf.DenoiseFactor = vpp->denoise;
301 param.ext_buf[param.num_ext_buf++] = (mfxExtBuffer*)&vpp->denoise_conf;
305 memset(&vpp->detail_conf, 0, sizeof(mfxExtVPPDetail));
306 vpp->detail_conf.Header.BufferId = MFX_EXTBUFF_VPP_DETAIL;
307 vpp->detail_conf.Header.BufferSz = sizeof(mfxExtVPPDetail);
308 vpp->detail_conf.DetailFactor = vpp->detail;
310 param.ext_buf[param.num_ext_buf++] = (mfxExtBuffer*)&vpp->detail_conf;
314 memset(&vpp->procamp_conf, 0, sizeof(mfxExtVPPProcAmp));
315 vpp->procamp_conf.Header.BufferId = MFX_EXTBUFF_VPP_PROCAMP;
316 vpp->procamp_conf.Header.BufferSz = sizeof(mfxExtVPPProcAmp);
317 vpp->procamp_conf.Hue = vpp->hue;
318 vpp->procamp_conf.Saturation = vpp->saturation;
319 vpp->procamp_conf.Contrast = vpp->contrast;
320 vpp->procamp_conf.Brightness = vpp->brightness;
322 param.ext_buf[param.num_ext_buf++] = (mfxExtBuffer*)&vpp->procamp_conf;
325 if (vpp->use_frc || vpp->use_crop || vpp->deinterlace || vpp->denoise ||
326 vpp->detail || vpp->procamp || inlink->w != outlink->w || inlink->h != outlink->h)
327 return ff_qsvvpp_create(ctx, &vpp->qsv, ¶m);
329 av_log(ctx, AV_LOG_VERBOSE, "qsv vpp pass through mode.\n");
330 if (inlink->hw_frames_ctx)
331 outlink->hw_frames_ctx = av_buffer_ref(inlink->hw_frames_ctx);
337 static int filter_frame(AVFilterLink *inlink, AVFrame *picref)
340 AVFilterContext *ctx = inlink->dst;
341 VPPContext *vpp = inlink->dst->priv;
342 AVFilterLink *outlink = ctx->outputs[0];
345 ret = ff_qsvvpp_filter_frame(vpp->qsv, inlink, picref);
346 av_frame_free(&picref);
348 if (picref->pts != AV_NOPTS_VALUE)
349 picref->pts = av_rescale_q(picref->pts, inlink->time_base, outlink->time_base);
350 ret = ff_filter_frame(outlink, picref);
356 static int query_formats(AVFilterContext *ctx)
359 AVFilterFormats *in_fmts, *out_fmts;
360 static const enum AVPixelFormat in_pix_fmts[] = {
368 static const enum AVPixelFormat out_pix_fmts[] = {
374 in_fmts = ff_make_format_list(in_pix_fmts);
375 out_fmts = ff_make_format_list(out_pix_fmts);
376 ret = ff_formats_ref(in_fmts, &ctx->inputs[0]->out_formats);
379 ret = ff_formats_ref(out_fmts, &ctx->outputs[0]->in_formats);
386 static av_cold void vpp_uninit(AVFilterContext *ctx)
388 VPPContext *vpp = ctx->priv;
390 ff_qsvvpp_free(&vpp->qsv);
393 static const AVClass vpp_class = {
394 .class_name = "vpp_qsv",
395 .item_name = av_default_item_name,
397 .version = LIBAVUTIL_VERSION_INT,
400 static const AVFilterPad vpp_inputs[] = {
403 .type = AVMEDIA_TYPE_VIDEO,
404 .config_props = config_input,
405 .filter_frame = filter_frame,
410 static const AVFilterPad vpp_outputs[] = {
413 .type = AVMEDIA_TYPE_VIDEO,
414 .config_props = config_output,
419 AVFilter ff_vf_vpp_qsv = {
421 .description = NULL_IF_CONFIG_SMALL("Quick Sync Video VPP."),
422 .priv_size = sizeof(VPPContext),
423 .query_formats = query_formats,
424 .uninit = vpp_uninit,
425 .inputs = vpp_inputs,
426 .outputs = vpp_outputs,
427 .priv_class = &vpp_class,
428 .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,