vf_scale_vaapi: Respect driver quirks around buffer destruction
[ffmpeg.git] / libavfilter / vf_scale_vaapi.c
1 /*
2  * This file is part of FFmpeg.
3  *
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.
8  *
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.
13  *
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
17  */
18
19 #include <string.h>
20
21 #include <va/va.h>
22 #include <va/va_vpp.h>
23
24 #include "libavutil/avassert.h"
25 #include "libavutil/hwcontext.h"
26 #include "libavutil/hwcontext_vaapi.h"
27 #include "libavutil/mem.h"
28 #include "libavutil/opt.h"
29 #include "libavutil/pixdesc.h"
30
31 #include "avfilter.h"
32 #include "formats.h"
33 #include "internal.h"
34
35 typedef struct ScaleVAAPIContext {
36     const AVClass *class;
37
38     AVVAAPIDeviceContext *hwctx;
39     AVBufferRef *device_ref;
40
41     int valid_ids;
42     VAConfigID  va_config;
43     VAContextID va_context;
44
45     AVBufferRef       *input_frames_ref;
46     AVHWFramesContext *input_frames;
47
48     AVBufferRef       *output_frames_ref;
49     AVHWFramesContext *output_frames;
50
51     char *output_format_string;
52     enum AVPixelFormat output_format;
53     int output_width;
54     int output_height;
55
56 } ScaleVAAPIContext;
57
58
59 static int scale_vaapi_query_formats(AVFilterContext *avctx)
60 {
61     enum AVPixelFormat pix_fmts[] = {
62         AV_PIX_FMT_VAAPI, AV_PIX_FMT_NONE,
63     };
64
65     ff_formats_ref(ff_make_format_list(pix_fmts),
66                    &avctx->inputs[0]->out_formats);
67     ff_formats_ref(ff_make_format_list(pix_fmts),
68                    &avctx->outputs[0]->in_formats);
69
70     return 0;
71 }
72
73 static int scale_vaapi_pipeline_uninit(ScaleVAAPIContext *ctx)
74 {
75     if (ctx->va_context != VA_INVALID_ID) {
76         vaDestroyContext(ctx->hwctx->display, ctx->va_context);
77         ctx->va_context = VA_INVALID_ID;
78     }
79
80     if (ctx->va_config != VA_INVALID_ID) {
81         vaDestroyConfig(ctx->hwctx->display, ctx->va_config);
82         ctx->va_config = VA_INVALID_ID;
83     }
84
85     av_buffer_unref(&ctx->output_frames_ref);
86     av_buffer_unref(&ctx->device_ref);
87     ctx->hwctx = 0;
88
89     return 0;
90 }
91
92 static int scale_vaapi_config_input(AVFilterLink *inlink)
93 {
94     AVFilterContext *avctx = inlink->dst;
95     ScaleVAAPIContext *ctx = avctx->priv;
96
97     scale_vaapi_pipeline_uninit(ctx);
98
99     if (!inlink->hw_frames_ctx) {
100         av_log(avctx, AV_LOG_ERROR, "A hardware frames reference is "
101                "required to associate the processing device.\n");
102         return AVERROR(EINVAL);
103     }
104
105     ctx->input_frames_ref = av_buffer_ref(inlink->hw_frames_ctx);
106     ctx->input_frames = (AVHWFramesContext*)ctx->input_frames_ref->data;
107
108     return 0;
109 }
110
111 static int scale_vaapi_config_output(AVFilterLink *outlink)
112 {
113     AVFilterContext *avctx = outlink->src;
114     ScaleVAAPIContext *ctx = avctx->priv;
115     AVVAAPIHWConfig *hwconfig = NULL;
116     AVHWFramesConstraints *constraints = NULL;
117     AVVAAPIFramesContext *va_frames;
118     VAStatus vas;
119     int err, i;
120
121     scale_vaapi_pipeline_uninit(ctx);
122
123     ctx->device_ref = av_buffer_ref(ctx->input_frames->device_ref);
124     ctx->hwctx = ((AVHWDeviceContext*)ctx->device_ref->data)->hwctx;
125
126     av_assert0(ctx->va_config == VA_INVALID_ID);
127     vas = vaCreateConfig(ctx->hwctx->display, VAProfileNone,
128                          VAEntrypointVideoProc, 0, 0, &ctx->va_config);
129     if (vas != VA_STATUS_SUCCESS) {
130         av_log(ctx, AV_LOG_ERROR, "Failed to create processing pipeline "
131                "config: %d (%s).\n", vas, vaErrorStr(vas));
132         err = AVERROR(EIO);
133         goto fail;
134     }
135
136     hwconfig = av_hwdevice_hwconfig_alloc(ctx->device_ref);
137     if (!hwconfig) {
138         err = AVERROR(ENOMEM);
139         goto fail;
140     }
141     hwconfig->config_id = ctx->va_config;
142
143     constraints = av_hwdevice_get_hwframe_constraints(ctx->device_ref,
144                                                       hwconfig);
145     if (!constraints) {
146         err = AVERROR(ENOMEM);
147         goto fail;
148     }
149
150     if (ctx->output_format == AV_PIX_FMT_NONE)
151         ctx->output_format = ctx->input_frames->sw_format;
152     if (constraints->valid_sw_formats) {
153         for (i = 0; constraints->valid_sw_formats[i] != AV_PIX_FMT_NONE; i++) {
154             if (ctx->output_format == constraints->valid_sw_formats[i])
155                 break;
156         }
157         if (constraints->valid_sw_formats[i] == AV_PIX_FMT_NONE) {
158             av_log(ctx, AV_LOG_ERROR, "Hardware does not support output "
159                    "format %s.\n", av_get_pix_fmt_name(ctx->output_format));
160             err = AVERROR(EINVAL);
161             goto fail;
162         }
163     }
164
165     if (ctx->output_width  < constraints->min_width  ||
166         ctx->output_height < constraints->min_height ||
167         ctx->output_width  > constraints->max_width  ||
168         ctx->output_height > constraints->max_height) {
169         av_log(ctx, AV_LOG_ERROR, "Hardware does not support scaling to "
170                "size %dx%d (constraints: width %d-%d height %d-%d).\n",
171                ctx->output_width, ctx->output_height,
172                constraints->min_width,  constraints->max_width,
173                constraints->min_height, constraints->max_height);
174         err = AVERROR(EINVAL);
175         goto fail;
176     }
177
178     ctx->output_frames_ref = av_hwframe_ctx_alloc(ctx->device_ref);
179     if (!ctx->output_frames_ref) {
180         av_log(ctx, AV_LOG_ERROR, "Failed to create HW frame context "
181                "for output.\n");
182         err = AVERROR(ENOMEM);
183         goto fail;
184     }
185
186     ctx->output_frames = (AVHWFramesContext*)ctx->output_frames_ref->data;
187
188     ctx->output_frames->format    = AV_PIX_FMT_VAAPI;
189     ctx->output_frames->sw_format = ctx->output_format;
190     ctx->output_frames->width     = ctx->output_width;
191     ctx->output_frames->height    = ctx->output_height;
192
193     // The number of output frames we need is determined by what follows
194     // the filter.  If it's an encoder with complex frame reference
195     // structures then this could be very high.
196     ctx->output_frames->initial_pool_size = 10;
197
198     err = av_hwframe_ctx_init(ctx->output_frames_ref);
199     if (err < 0) {
200         av_log(ctx, AV_LOG_ERROR, "Failed to initialise VAAPI frame "
201                "context for output: %d\n", err);
202         goto fail;
203     }
204
205     va_frames = ctx->output_frames->hwctx;
206
207     av_assert0(ctx->va_context == VA_INVALID_ID);
208     vas = vaCreateContext(ctx->hwctx->display, ctx->va_config,
209                           ctx->output_width, ctx->output_height,
210                           VA_PROGRESSIVE,
211                           va_frames->surface_ids, va_frames->nb_surfaces,
212                           &ctx->va_context);
213     if (vas != VA_STATUS_SUCCESS) {
214         av_log(ctx, AV_LOG_ERROR, "Failed to create processing pipeline "
215                "context: %d (%s).\n", vas, vaErrorStr(vas));
216         return AVERROR(EIO);
217     }
218
219     outlink->w = ctx->output_width;
220     outlink->h = ctx->output_height;
221
222     outlink->hw_frames_ctx = av_buffer_ref(ctx->output_frames_ref);
223     if (!outlink->hw_frames_ctx) {
224         err = AVERROR(ENOMEM);
225         goto fail;
226     }
227
228     av_freep(&hwconfig);
229     av_hwframe_constraints_free(&constraints);
230     return 0;
231
232 fail:
233     av_buffer_unref(&ctx->output_frames_ref);
234     av_freep(&hwconfig);
235     av_hwframe_constraints_free(&constraints);
236     return err;
237 }
238
239 static int vaapi_proc_colour_standard(enum AVColorSpace av_cs)
240 {
241     switch(av_cs) {
242 #define CS(av, va) case AVCOL_SPC_ ## av: return VAProcColorStandard ## va;
243         CS(BT709,     BT709);
244         CS(BT470BG,   BT601);
245         CS(SMPTE170M, SMPTE170M);
246         CS(SMPTE240M, SMPTE240M);
247 #undef CS
248     default:
249         return VAProcColorStandardNone;
250     }
251 }
252
253 static int scale_vaapi_filter_frame(AVFilterLink *inlink, AVFrame *input_frame)
254 {
255     AVFilterContext *avctx = inlink->dst;
256     AVFilterLink *outlink = avctx->outputs[0];
257     ScaleVAAPIContext *ctx = avctx->priv;
258     AVFrame *output_frame = NULL;
259     VASurfaceID input_surface, output_surface;
260     VAProcPipelineParameterBuffer params;
261     VABufferID params_id;
262     VAStatus vas;
263     int err;
264
265     av_log(ctx, AV_LOG_DEBUG, "Filter input: %s, %ux%u (%"PRId64").\n",
266            av_get_pix_fmt_name(input_frame->format),
267            input_frame->width, input_frame->height, input_frame->pts);
268
269     if (ctx->va_context == VA_INVALID_ID)
270         return AVERROR(EINVAL);
271
272     input_surface = (VASurfaceID)(uintptr_t)input_frame->data[3];
273     av_log(ctx, AV_LOG_DEBUG, "Using surface %#x for scale input.\n",
274            input_surface);
275
276     output_frame = av_frame_alloc();
277     if (!output_frame) {
278         av_log(ctx, AV_LOG_ERROR, "Failed to allocate output frame.");
279         err = AVERROR(ENOMEM);
280         goto fail;
281     }
282
283     err = av_hwframe_get_buffer(ctx->output_frames_ref, output_frame, 0);
284     if (err < 0) {
285         av_log(ctx, AV_LOG_ERROR, "Failed to get surface for "
286                "output: %d\n.", err);
287     }
288
289     output_surface = (VASurfaceID)(uintptr_t)output_frame->data[3];
290     av_log(ctx, AV_LOG_DEBUG, "Using surface %#x for scale output.\n",
291            output_surface);
292
293     memset(&params, 0, sizeof(params));
294
295     params.surface = input_surface;
296     params.surface_region = 0;
297     params.surface_color_standard =
298         vaapi_proc_colour_standard(input_frame->colorspace);
299
300     params.output_region = 0;
301     params.output_background_color = 0xff000000;
302     params.output_color_standard = params.surface_color_standard;
303
304     params.pipeline_flags = 0;
305     params.filter_flags = VA_FILTER_SCALING_HQ;
306
307     vas = vaBeginPicture(ctx->hwctx->display,
308                          ctx->va_context, output_surface);
309     if (vas != VA_STATUS_SUCCESS) {
310         av_log(ctx, AV_LOG_ERROR, "Failed to attach new picture: "
311                "%d (%s).\n", vas, vaErrorStr(vas));
312         err = AVERROR(EIO);
313         goto fail;
314     }
315
316     vas = vaCreateBuffer(ctx->hwctx->display, ctx->va_context,
317                          VAProcPipelineParameterBufferType,
318                          sizeof(params), 1, &params, &params_id);
319     if (vas != VA_STATUS_SUCCESS) {
320         av_log(ctx, AV_LOG_ERROR, "Failed to create parameter buffer: "
321                "%d (%s).\n", vas, vaErrorStr(vas));
322         err = AVERROR(EIO);
323         goto fail_after_begin;
324     }
325     av_log(ctx, AV_LOG_DEBUG, "Pipeline parameter buffer is %#x.\n",
326            params_id);
327
328     vas = vaRenderPicture(ctx->hwctx->display, ctx->va_context,
329                           &params_id, 1);
330     if (vas != VA_STATUS_SUCCESS) {
331         av_log(ctx, AV_LOG_ERROR, "Failed to render parameter buffer: "
332                "%d (%s).\n", vas, vaErrorStr(vas));
333         err = AVERROR(EIO);
334         goto fail_after_begin;
335     }
336
337     vas = vaEndPicture(ctx->hwctx->display, ctx->va_context);
338     if (vas != VA_STATUS_SUCCESS) {
339         av_log(ctx, AV_LOG_ERROR, "Failed to start picture processing: "
340                "%d (%s).\n", vas, vaErrorStr(vas));
341         err = AVERROR(EIO);
342         goto fail_after_render;
343     }
344
345     if (ctx->hwctx->driver_quirks &
346         AV_VAAPI_DRIVER_QUIRK_RENDER_PARAM_BUFFERS) {
347         vas = vaDestroyBuffer(ctx->hwctx->display, params_id);
348         if (vas != VA_STATUS_SUCCESS) {
349             av_log(ctx, AV_LOG_ERROR, "Failed to free parameter buffer: "
350                    "%d (%s).\n", vas, vaErrorStr(vas));
351             // And ignore.
352         }
353     }
354
355     av_frame_copy_props(output_frame, input_frame);
356     av_frame_free(&input_frame);
357
358     av_log(ctx, AV_LOG_DEBUG, "Filter output: %s, %ux%u (%"PRId64").\n",
359            av_get_pix_fmt_name(output_frame->format),
360            output_frame->width, output_frame->height, output_frame->pts);
361
362     return ff_filter_frame(outlink, output_frame);
363
364     // We want to make sure that if vaBeginPicture has been called, we also
365     // call vaRenderPicture and vaEndPicture.  These calls may well fail or
366     // do something else nasty, but once we're in this failure case there
367     // isn't much else we can do.
368 fail_after_begin:
369     vaRenderPicture(ctx->hwctx->display, ctx->va_context, &params_id, 1);
370 fail_after_render:
371     vaEndPicture(ctx->hwctx->display, ctx->va_context);
372 fail:
373     av_frame_free(&input_frame);
374     av_frame_free(&output_frame);
375     return err;
376 }
377
378 static av_cold int scale_vaapi_init(AVFilterContext *avctx)
379 {
380     ScaleVAAPIContext *ctx = avctx->priv;
381
382     ctx->va_config  = VA_INVALID_ID;
383     ctx->va_context = VA_INVALID_ID;
384     ctx->valid_ids  = 1;
385
386     if (ctx->output_format_string) {
387         ctx->output_format = av_get_pix_fmt(ctx->output_format_string);
388         if (ctx->output_format == AV_PIX_FMT_NONE) {
389             av_log(ctx, AV_LOG_ERROR, "Invalid output format.\n");
390             return AVERROR(EINVAL);
391         }
392     } else {
393         // Use the input format once that is configured.
394         ctx->output_format = AV_PIX_FMT_NONE;
395     }
396
397     return 0;
398 }
399
400 static av_cold void scale_vaapi_uninit(AVFilterContext *avctx)
401 {
402     ScaleVAAPIContext *ctx = avctx->priv;
403
404     if (ctx->valid_ids)
405         scale_vaapi_pipeline_uninit(ctx);
406
407     av_buffer_unref(&ctx->input_frames_ref);
408     av_buffer_unref(&ctx->output_frames_ref);
409     av_buffer_unref(&ctx->device_ref);
410 }
411
412
413 #define OFFSET(x) offsetof(ScaleVAAPIContext, x)
414 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM|AV_OPT_FLAG_VIDEO_PARAM)
415 static const AVOption scale_vaapi_options[] = {
416     { "w", "Output video width",
417       OFFSET(output_width),  AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, .flags = FLAGS },
418     { "h", "Output video height",
419       OFFSET(output_height), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, .flags = FLAGS },
420     { "format", "Output video format (software format of hardware frames)",
421       OFFSET(output_format_string), AV_OPT_TYPE_STRING, .flags = FLAGS },
422     { NULL },
423 };
424
425 static const AVClass scale_vaapi_class = {
426     .class_name = "scale_vaapi",
427     .item_name  = av_default_item_name,
428     .option     = scale_vaapi_options,
429     .version    = LIBAVUTIL_VERSION_INT,
430 };
431
432 static const AVFilterPad scale_vaapi_inputs[] = {
433     {
434         .name         = "default",
435         .type         = AVMEDIA_TYPE_VIDEO,
436         .filter_frame = &scale_vaapi_filter_frame,
437         .config_props = &scale_vaapi_config_input,
438     },
439     { NULL }
440 };
441
442 static const AVFilterPad scale_vaapi_outputs[] = {
443     {
444         .name = "default",
445         .type = AVMEDIA_TYPE_VIDEO,
446         .config_props = &scale_vaapi_config_output,
447     },
448     { NULL }
449 };
450
451 AVFilter ff_vf_scale_vaapi = {
452     .name          = "scale_vaapi",
453     .description   = NULL_IF_CONFIG_SMALL("Scale to/from VAAPI surfaces."),
454     .priv_size     = sizeof(ScaleVAAPIContext),
455     .init          = &scale_vaapi_init,
456     .uninit        = &scale_vaapi_uninit,
457     .query_formats = &scale_vaapi_query_formats,
458     .inputs        = scale_vaapi_inputs,
459     .outputs       = scale_vaapi_outputs,
460     .priv_class    = &scale_vaapi_class,
461 };