1 /*****************************************************************************
2 * chroma.c: VLC picture import into VDPAU
3 *****************************************************************************
4 * Copyright (C) 2013 Rémi Denis-Courmont
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as published by
8 * the Free Software Foundation; either version 2.1 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19 *****************************************************************************/
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
31 #include <vlc_filter.h>
32 #include "vlc_vdpau.h"
34 /* Picture history as recommended by VDPAU documentation */
44 VdpYCbCrFormat format;
48 vlc_vdp_video_field_t *field;
51 } history[MAX_PAST + 1 + MAX_FUTURE];
62 /** Initialize the colour space conversion matrix */
63 static VdpStatus MixerSetupColors(filter_t *filter, const VdpProcamp *procamp,
64 VdpCSCMatrix *restrict csc)
66 filter_sys_t *sys = filter->p_sys;
68 VdpColorStandard std = (filter->fmt_in.video.i_height > 576)
69 ? VDP_COLOR_STANDARD_ITUR_BT_709
70 : VDP_COLOR_STANDARD_ITUR_BT_601;
72 err = vdp_generate_csc_matrix(sys->vdp, procamp, std, csc);
73 if (err != VDP_STATUS_OK)
75 msg_Err(filter, "video %s failure: %s", "color space matrix",
76 vdp_get_error_string(sys->vdp, err));
82 sys->procamp.brightness = procamp->brightness;
83 sys->procamp.contrast = procamp->contrast;
84 sys->procamp.saturation = procamp->saturation;
85 sys->procamp.hue = procamp->hue;
89 sys->procamp.brightness = 0.f;
90 sys->procamp.contrast = 1.f;
91 sys->procamp.saturation = 1.f;
92 sys->procamp.hue = 0.f;
97 /** Create VDPAU video mixer */
98 static VdpVideoMixer MixerCreate(filter_t *filter)
100 filter_sys_t *sys = filter->p_sys;
105 /* Check for potentially useful features */
106 VdpVideoMixerFeature featv[5];
109 int algo = var_InheritInteger(filter, "vdpau-deinterlace");
111 if (algo == VDP_VIDEO_MIXER_FEATURE_DEINTERLACE_TEMPORAL_SPATIAL)
113 err = vdp_video_mixer_query_feature_support(sys->vdp, sys->device,
115 if (err == VDP_STATUS_OK && ok == VDP_TRUE)
116 msg_Dbg(filter, "using video mixer %s feature",
117 "temporal-spatial deinterlace");
119 algo = VDP_VIDEO_MIXER_FEATURE_DEINTERLACE_TEMPORAL; /* fallback */
121 if (algo == VDP_VIDEO_MIXER_FEATURE_DEINTERLACE_TEMPORAL)
123 err = vdp_video_mixer_query_feature_support(sys->vdp, sys->device,
125 if (err == VDP_STATUS_OK && ok == VDP_TRUE)
126 msg_Dbg(filter, "using video mixer %s feature",
127 "temporal deinterlace");
133 featv[featc++] = algo;
134 ivtc = var_InheritBool(filter, "vdpau-ivtc");
137 err = vdp_video_mixer_query_feature_support(sys->vdp, sys->device,
138 VDP_VIDEO_MIXER_FEATURE_INVERSE_TELECINE, &ok);
139 if (err == VDP_STATUS_OK && ok == VDP_TRUE)
140 msg_Dbg(filter, "using video mixer %s feature",
142 featv[featc++] = VDP_VIDEO_MIXER_FEATURE_INVERSE_TELECINE;
146 const float noise = var_InheritFloat(filter, "vdpau-noise-reduction");
149 err = vdp_video_mixer_query_feature_support(sys->vdp, sys->device,
150 VDP_VIDEO_MIXER_FEATURE_NOISE_REDUCTION, &ok);
151 if (err == VDP_STATUS_OK && ok == VDP_TRUE)
153 msg_Dbg(filter, "using video mixer %s feature", "noise reduction");
154 featv[featc++] = VDP_VIDEO_MIXER_FEATURE_NOISE_REDUCTION;
158 err = vdp_video_mixer_query_feature_support(sys->vdp, sys->device,
159 VDP_VIDEO_MIXER_FEATURE_SHARPNESS, &ok);
160 if (err == VDP_STATUS_OK && ok == VDP_TRUE)
162 msg_Dbg(filter, "using video mixer %s feature", "sharpness");
163 featv[featc++] = VDP_VIDEO_MIXER_FEATURE_SHARPNESS;
166 const int offset = VDP_VIDEO_MIXER_FEATURE_HIGH_QUALITY_SCALING_L1 - 1;
167 unsigned level = var_InheritInteger(filter, "vdpau-scaling");
171 err = vdp_video_mixer_query_feature_support(sys->vdp, sys->device,
172 offset + level, &ok);
173 if (err == VDP_STATUS_OK && ok == VDP_TRUE)
175 msg_Dbg(filter, "using video mixer high quality scaling L%u",
177 featv[featc++] = offset + level;
180 level--; /* fallback to lower quality */
183 /* Create the mixer */
184 VdpVideoMixerParameter parms[3] = {
185 VDP_VIDEO_MIXER_PARAMETER_VIDEO_SURFACE_WIDTH,
186 VDP_VIDEO_MIXER_PARAMETER_VIDEO_SURFACE_HEIGHT,
187 VDP_VIDEO_MIXER_PARAMETER_CHROMA_TYPE,
189 uint32_t width = filter->fmt_in.video.i_width;
190 uint32_t height = filter->fmt_in.video.i_height;
191 const void *values[3] = { &width, &height, &sys->chroma, };
193 err = vdp_video_mixer_create(sys->vdp, sys->device, featc, featv,
194 3, parms, values, &mixer);
195 if (err != VDP_STATUS_OK)
197 msg_Err(filter, "video %s %s failure: %s", "mixer", "creation",
198 vdp_get_error_string(sys->vdp, err));
199 return VDP_INVALID_HANDLE;
202 msg_Dbg(filter, "using video mixer %"PRIu32, mixer);
204 /* Set initial features and attributes */
205 VdpVideoMixerAttribute attrv[3];
213 if (MixerSetupColors(filter, NULL, &csc) == VDP_STATUS_OK)
215 attrv[attrc] = VDP_VIDEO_MIXER_ATTRIBUTE_CSC_MATRIX;
222 featv[featc++] = algo;
224 featv[featc++] = VDP_VIDEO_MIXER_FEATURE_INVERSE_TELECINE;
226 chroma_skip = var_InheritBool(filter, "vdpau-chroma-skip");
227 attrv[attrc] = VDP_VIDEO_MIXER_ATTRIBUTE_SKIP_CHROMA_DEINTERLACE;
228 valv[attrc] = &chroma_skip;
234 featv[featc++] = VDP_VIDEO_MIXER_FEATURE_NOISE_REDUCTION;
236 attrv[attrc] = VDP_VIDEO_MIXER_ATTRIBUTE_NOISE_REDUCTION_LEVEL;
237 valv[attrc] = &noise;
242 featv[featc++] = offset + level;
246 VdpBool enablev[featc];
248 for (unsigned i = 0; i < featc; i++)
249 enablev[i] = VDP_TRUE;
251 err = vdp_video_mixer_set_feature_enables(sys->vdp, mixer,
252 featc, featv, enablev);
253 if (err != VDP_STATUS_OK)
254 msg_Err(filter, "video %s %s failure: %s", "mixer", "features",
255 vdp_get_error_string(sys->vdp, err));
260 err = vdp_video_mixer_set_attribute_values(sys->vdp, mixer,
262 if (err != VDP_STATUS_OK)
263 msg_Err(filter, "video %s %s failure: %s", "mixer", "attributes",
264 vdp_get_error_string(sys->vdp, err));
270 static void Flush(filter_t *filter)
272 filter_sys_t *sys = filter->p_sys;
274 for (unsigned i = 0; i < MAX_PAST + MAX_FUTURE; i++)
275 if (sys->history[i].field != NULL)
277 sys->history[i].field->destroy(sys->history[i].field);
278 sys->history[i].field = NULL;
282 /** Get a VLC picture for a VDPAU output surface */
283 static picture_t *OutputAllocate(filter_t *filter)
285 filter_sys_t *sys = filter->p_sys;
287 picture_t *pic = filter_NewPicture(filter);
291 picture_sys_t *psys = pic->p_sys;
292 assert(psys->vdp != NULL);
294 if (likely(sys->mixer != VDP_INVALID_HANDLE))
295 { /* Not the first output picture */
296 assert(psys->vdp == sys->vdp);
300 /* First picture: get the context and allocate the mixer */
301 sys->vdp = vdp_hold_x11(psys->vdp, NULL);
302 sys->device = psys->device;
303 sys->mixer = MixerCreate(filter);
304 if (sys->mixer != VDP_INVALID_HANDLE)
307 vdp_release_x11(psys->vdp);
309 picture_Release(pic);
313 /** Export a VDPAU video surface picture to a normal VLC picture */
314 static picture_t *VideoExport(filter_t *filter, picture_t *src, picture_t *dst)
316 filter_sys_t *sys = filter->p_sys;
317 vlc_vdp_video_field_t *field = src->context;
318 vlc_vdp_video_frame_t *psys = field->frame;
320 VdpVideoSurface surface = psys->surface;
324 picture_CopyProperties(dst, src);
326 for (int i = 0; i < dst->i_planes; i++)
328 planes[i] = dst->p[i].p_pixels;
329 pitches[i] = dst->p[i].i_pitch;
331 if (dst->format.i_chroma == VLC_CODEC_I420
332 || dst->format.i_chroma == VLC_CODEC_I422)
334 planes[1] = dst->p[2].p_pixels;
335 planes[2] = dst->p[1].p_pixels;
336 pitches[1] = dst->p[2].i_pitch;
337 pitches[2] = dst->p[1].i_pitch;
339 err = vdp_video_surface_get_bits_y_cb_cr(psys->vdp, surface, sys->format,
341 if (err != VDP_STATUS_OK)
343 msg_Err(filter, "video %s %s failure: %s", "surface", "export",
344 vdp_get_error_string(psys->vdp, err));
345 picture_Release(dst);
348 picture_Release(src);
352 /** Import VLC picture into VDPAU video surface */
353 static picture_t *VideoImport(filter_t *filter, picture_t *src)
355 filter_sys_t *sys = filter->p_sys;
356 VdpVideoSurface surface;
359 if (sys->vdp == NULL)
362 /* Create surface (TODO: reuse?) */
363 err = vdp_video_surface_create(sys->vdp, sys->device, sys->chroma,
364 filter->fmt_in.video.i_width,
365 filter->fmt_in.video.i_height, &surface);
366 if (err != VDP_STATUS_OK)
368 msg_Err(filter, "video %s %s failure: %s", "surface", "creation",
369 vdp_get_error_string(sys->vdp, err));
374 const void *planes[3];
376 for (int i = 0; i < src->i_planes; i++)
378 planes[i] = src->p[i].p_pixels;
379 pitches[i] = src->p[i].i_pitch;
381 if (src->format.i_chroma == VLC_CODEC_I420)
383 planes[1] = src->p[2].p_pixels;
384 planes[2] = src->p[1].p_pixels;
385 pitches[1] = src->p[2].i_pitch;
386 pitches[2] = src->p[1].i_pitch;
388 err = vdp_video_surface_put_bits_y_cb_cr(sys->vdp, surface, sys->format,
390 if (err != VDP_STATUS_OK)
392 msg_Err(filter, "video %s %s failure: %s", "surface", "import",
393 vdp_get_error_string(sys->vdp, err));
397 /* Wrap surface into a picture */
398 video_format_t fmt = src->format;
399 fmt.i_chroma = (sys->chroma == VDP_CHROMA_TYPE_420)
400 ? VLC_CODEC_VDPAU_VIDEO_420 : VLC_CODEC_VDPAU_VIDEO_422;
402 picture_t *dst = picture_NewFromFormat(&fmt);
403 if (unlikely(dst == NULL))
405 picture_CopyProperties(dst, src);
406 picture_Release(src);
408 err = vlc_vdp_video_attach(sys->vdp, surface, dst);
409 if (unlikely(err != VDP_STATUS_OK))
411 picture_Release(dst);
416 vdp_video_surface_destroy(sys->vdp, surface);
418 picture_Release(src);
422 static inline VdpVideoSurface picture_GetVideoSurface(const picture_t *pic)
424 vlc_vdp_video_field_t *field = pic->context;
425 return field->frame->surface;
428 static picture_t *VideoRender(filter_t *filter, picture_t *src)
430 filter_sys_t *sys = filter->p_sys;
433 if (unlikely(src->context == NULL))
435 msg_Err(filter, "corrupt VDPAU video surface");
436 picture_Release(src);
440 picture_t *dst = OutputAllocate(filter);
442 /* Corner case: different VDPAU instances decoding and rendering */
443 vlc_vdp_video_field_t *field = src->context;
444 if (field->frame->vdp != sys->vdp)
446 video_format_t fmt = src->format;
449 case VDP_CHROMA_TYPE_420: fmt.i_chroma = VLC_CODEC_NV12; break;
450 case VDP_CHROMA_TYPE_422: fmt.i_chroma = VLC_CODEC_UYVY; break;
451 case VDP_CHROMA_TYPE_444: fmt.i_chroma = VLC_CODEC_NV24; break;
455 picture_t *pic = picture_NewFromFormat(&fmt);
456 if (likely(pic != NULL))
458 pic = VideoExport(filter, src, pic);
460 src = VideoImport(filter, pic);
466 picture_Release(src);
471 /* Update history and take "present" picture field */
472 if (likely(src != NULL))
474 sys->history[MAX_PAST + MAX_FUTURE].field =
475 vlc_vdp_video_copy(src->context);
476 sys->history[MAX_PAST + MAX_FUTURE].date = src->date;
477 sys->history[MAX_PAST + MAX_FUTURE].force = src->b_force;
478 picture_Release(src);
481 sys->history[MAX_PAST + MAX_FUTURE].field = NULL;
486 vlc_vdp_video_field_t *f = sys->history[MAX_PAST].field;
489 picture_Release(dst);
494 dst->date = sys->history[MAX_PAST].date;
495 dst->b_force = sys->history[MAX_PAST].force;
497 /* Enable/Disable features */
498 const VdpVideoMixerFeature features[] = {
499 VDP_VIDEO_MIXER_FEATURE_SHARPNESS,
501 const VdpBool enables[] = {
505 err = vdp_video_mixer_set_feature_enables(sys->vdp, sys->mixer,
506 sizeof (features) / sizeof (features[0]), features, enables);
507 if (err != VDP_STATUS_OK)
508 msg_Err(filter, "video %s %s failure: %s", "mixer", "features",
509 vdp_get_error_string(sys->vdp, err));
511 /* Configure mixer depending on upstream video filters */
512 VdpVideoMixerAttribute attrs[2] = {
513 VDP_VIDEO_MIXER_ATTRIBUTE_SHARPNESS_LEVEL,
515 const void *values[2] = {
521 if ((sys->procamp.brightness != f->procamp.brightness
522 || sys->procamp.contrast != f->procamp.contrast
523 || sys->procamp.saturation != f->procamp.saturation
524 || sys->procamp.hue != f->procamp.hue)
525 && (MixerSetupColors(filter, &f->procamp, &csc) == VDP_STATUS_OK))
527 attrs[count] = VDP_VIDEO_MIXER_ATTRIBUTE_CSC_MATRIX;
528 values[count] = &csc;
532 err = vdp_video_mixer_set_attribute_values(sys->vdp, sys->mixer,
533 count, attrs, values);
534 if (err != VDP_STATUS_OK)
535 msg_Err(filter, "video %s %s failure: %s", "mixer", "attributes",
536 vdp_get_error_string(sys->vdp, err));
538 /* Render video into output */
539 VdpVideoMixerPictureStructure structure = f->structure;
540 VdpVideoSurface past[MAX_PAST];
541 VdpVideoSurface surface = f->frame->surface;
542 VdpVideoSurface future[MAX_FUTURE];
544 filter->fmt_in.video.i_x_offset, filter->fmt_in.video.i_y_offset,
545 filter->fmt_in.video.i_visible_width + filter->fmt_in.video.i_x_offset,
546 filter->fmt_in.video.i_visible_height + filter->fmt_in.video.i_y_offset
548 VdpOutputSurface output = dst->p_sys->surface;
551 filter->fmt_out.video.i_visible_width,
552 filter->fmt_out.video.i_visible_height
555 for (unsigned i = 0; i < MAX_PAST; i++)
557 f = sys->history[(MAX_PAST - 1) - i].field;
558 past[i] = (f != NULL) ? f->frame->surface : VDP_INVALID_HANDLE;
560 for (unsigned i = 0; i < MAX_FUTURE; i++)
562 f = sys->history[(MAX_PAST + 1) + i].field;
563 future[i] = (f != NULL) ? f->frame->surface : VDP_INVALID_HANDLE;
566 err = vdp_video_mixer_render(sys->vdp, sys->mixer, VDP_INVALID_HANDLE,
568 MAX_PAST, past, surface, MAX_FUTURE, future,
569 &src_rect, output, &dst_rect, NULL, 0, NULL);
570 if (err != VDP_STATUS_OK)
572 msg_Err(filter, "video %s %s failure: %s", "mixer", "rendering",
573 vdp_get_error_string(sys->vdp, err));
574 picture_Release(dst);
579 f = sys->history[0].field;
581 f->destroy(f); /* Release oldest field */
582 memmove(sys->history, sys->history + 1, /* Advance history */
583 sizeof (sys->history[0]) * (MAX_PAST + MAX_FUTURE));
588 static picture_t *YCbCrRender(filter_t *filter, picture_t *src)
590 /* FIXME: Define a way to initialize the mixer in Open() instead. */
591 if (unlikely(filter->p_sys->vdp == NULL))
593 picture_t *dummy = OutputAllocate(filter);
595 picture_Release(dummy);
598 src = VideoImport(filter, src);
599 return (src != NULL) ? VideoRender(filter, src) : NULL;
602 static int OutputOpen(vlc_object_t *obj)
604 filter_t *filter = (filter_t *)obj;
605 if (filter->fmt_out.video.i_chroma != VLC_CODEC_VDPAU_OUTPUT)
608 filter_sys_t *sys = malloc(sizeof (*sys));
609 if (unlikely(sys == NULL))
613 sys->mixer = VDP_INVALID_HANDLE;
615 if (filter->fmt_in.video.i_chroma == VLC_CODEC_VDPAU_VIDEO_444)
617 sys->chroma = VDP_CHROMA_TYPE_444;
618 sys->format = VDP_YCBCR_FORMAT_NV12;
619 filter->pf_video_filter = VideoRender;
622 if (filter->fmt_in.video.i_chroma == VLC_CODEC_VDPAU_VIDEO_422)
624 sys->chroma = VDP_CHROMA_TYPE_422;
625 /* TODO: check if the drivery supports NV12 or UYVY */
626 sys->format = VDP_YCBCR_FORMAT_UYVY;
627 filter->pf_video_filter = VideoRender;
630 if (filter->fmt_in.video.i_chroma == VLC_CODEC_VDPAU_VIDEO_420)
632 sys->chroma = VDP_CHROMA_TYPE_420;
633 sys->format = VDP_YCBCR_FORMAT_NV12;
634 filter->pf_video_filter = VideoRender;
637 if (vlc_fourcc_to_vdp_ycc(filter->fmt_in.video.i_chroma,
638 &sys->chroma, &sys->format))
639 filter->pf_video_filter = YCbCrRender;
646 /* NOTE: The video mixer capabilities should be checked here, and the
647 * then video mixer set up. But:
648 * 1) The VDPAU back-end is accessible only once the first picture
649 * gets filtered. Thus the video mixer is created later.
650 * 2) Bailing out due to insufficient capabilities would break the
651 * video pipeline. Thus capabilities should be checked earlier. */
653 for (unsigned i = 0; i < MAX_PAST + MAX_FUTURE; i++)
654 sys->history[i].field = NULL;
656 sys->procamp.brightness = 0.f;
657 sys->procamp.contrast = 1.f;
658 sys->procamp.saturation = 1.f;
659 sys->procamp.hue = 0.f;
661 filter->pf_video_flush = Flush;
666 static void OutputClose(vlc_object_t *obj)
668 filter_t *filter = (filter_t *)obj;
669 filter_sys_t *sys = filter->p_sys;
672 if (sys->mixer != VDP_INVALID_HANDLE)
674 vdp_video_mixer_destroy(sys->vdp, sys->mixer);
675 vdp_release_x11(sys->vdp);
680 static picture_t *VideoExport_Filter(filter_t *filter, picture_t *src)
682 if (unlikely(src->context == NULL))
684 msg_Err(filter, "corrupt VDPAU video surface %p", src);
685 picture_Release(src);
689 picture_t *dst = filter_NewPicture(filter);
693 return VideoExport(filter, src, dst);
696 static int YCbCrOpen(vlc_object_t *obj)
698 filter_t *filter = (filter_t *)obj;
699 if (filter->fmt_in.video.i_chroma != VLC_CODEC_VDPAU_VIDEO_420
700 && filter->fmt_in.video.i_chroma != VLC_CODEC_VDPAU_VIDEO_422
701 && filter->fmt_in.video.i_chroma != VLC_CODEC_VDPAU_VIDEO_444)
704 if (filter->fmt_in.video.i_visible_width
705 != filter->fmt_out.video.i_visible_width
706 || filter->fmt_in.video.i_visible_height
707 != filter->fmt_out.video.i_visible_height
708 || filter->fmt_in.video.i_x_offset != filter->fmt_out.video.i_x_offset
709 || filter->fmt_in.video.i_y_offset != filter->fmt_out.video.i_y_offset
710 || (filter->fmt_in.video.i_sar_num * filter->fmt_out.video.i_sar_den
711 != filter->fmt_in.video.i_sar_den * filter->fmt_out.video.i_sar_num))
714 filter_sys_t *sys = malloc(sizeof (*sys));
715 if (unlikely(sys == NULL))
718 if (!vlc_fourcc_to_vdp_ycc(filter->fmt_out.video.i_chroma,
719 &sys->chroma, &sys->format))
725 filter->pf_video_filter = VideoExport_Filter;
730 static void YCbCrClose(vlc_object_t *obj)
732 filter_t *filter = (filter_t *)obj;
733 filter_sys_t *sys = filter->p_sys;
738 static const int algo_values[] = {
740 VDP_VIDEO_MIXER_FEATURE_DEINTERLACE_TEMPORAL,
741 VDP_VIDEO_MIXER_FEATURE_DEINTERLACE_TEMPORAL_SPATIAL,
744 static const char *const algo_names[] = {
745 N_("Bob"), N_("Temporal"), N_("Temporal-spatial"),
749 set_shortname(N_("VDPAU"))
750 set_description(N_("VDPAU surface conversions"))
751 set_capability("video filter2", 10)
752 set_category(CAT_VIDEO)
753 set_subcategory(SUBCAT_VIDEO_VFILTER)
754 set_callbacks(OutputOpen, OutputClose)
756 add_integer("vdpau-deinterlace",
757 VDP_VIDEO_MIXER_FEATURE_DEINTERLACE_TEMPORAL_SPATIAL,
758 N_("Deinterlace"), N_("Deinterlacing algorithm"), true)
759 change_integer_list(algo_values, algo_names)
760 add_bool("vdpau-ivtc", false,
761 N_("Inverse telecine"), N_("Inverse telecine"), true)
762 add_bool("vdpau-chroma-skip", false,
763 N_("Deinterlace chroma skip"),
764 N_("Whether temporal deinterlacing applies to luma only"), true)
765 add_float_with_range("vdpau-noise-reduction", 0., 0., 1.,
766 N_("Noise reduction level"), N_("Noise reduction level"), true)
767 add_integer_with_range("vdpau-scaling", 0, 0, 9,
768 N_("Scaling quality"), N_("High quality scaling level"), true)
771 set_callbacks(YCbCrOpen, YCbCrClose)