2 * gstvaapisink.c - VA-API video sink
4 * Copyright (C) 2010-2011 Splitted-Desktop Systems
5 * Copyright (C) 2011-2012 Intel Corporation
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public License
9 * as published by the Free Software Foundation; either version 2.1
10 * of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 * Boston, MA 02110-1301 USA
24 * SECTION:gstvaapisink
25 * @short_description: A VA-API based videosink
27 * vaapisink renders video frames to a drawable (X #Window) on a local
28 * display using the Video Acceleration (VA) API. The element will
29 * create its own internal window and render into it.
34 #include <gst/video/video.h>
35 #include <gst/video/videocontext.h>
36 #include <gst/vaapi/gstvaapivideobuffer.h>
37 #include <gst/vaapi/gstvaapivideosink.h>
38 #include <gst/vaapi/gstvaapidisplay_x11.h>
39 #include <gst/vaapi/gstvaapiwindow_x11.h>
41 #include <gst/vaapi/gstvaapidisplay_glx.h>
42 #include <gst/vaapi/gstvaapiwindow_glx.h>
45 /* Supported interfaces */
46 #include <gst/interfaces/xoverlay.h>
48 #include "gstvaapisink.h"
49 #include "gstvaapipluginutil.h"
51 #define GST_PLUGIN_NAME "vaapisink"
52 #define GST_PLUGIN_DESC "A VA-API based videosink"
54 GST_DEBUG_CATEGORY_STATIC(gst_debug_vaapisink);
55 #define GST_CAT_DEFAULT gst_debug_vaapisink
57 /* ElementFactory information */
58 static const GstElementDetails gst_vaapisink_details =
63 "Gwenole Beauchesne <gwenole.beauchesne@intel.com>");
65 /* Default template */
66 static GstStaticPadTemplate gst_vaapisink_sink_factory =
67 GST_STATIC_PAD_TEMPLATE(
71 GST_STATIC_CAPS(GST_VAAPI_SURFACE_CAPS));
74 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface);
77 gst_vaapisink_video_context_iface_init(GstVideoContextInterface *iface);
80 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface);
82 G_DEFINE_TYPE_WITH_CODE(
86 G_IMPLEMENT_INTERFACE(GST_TYPE_IMPLEMENTS_INTERFACE,
87 gst_vaapisink_implements_iface_init);
88 G_IMPLEMENT_INTERFACE(GST_TYPE_VIDEO_CONTEXT,
89 gst_vaapisink_video_context_iface_init);
90 G_IMPLEMENT_INTERFACE(GST_TYPE_X_OVERLAY,
91 gst_vaapisink_xoverlay_iface_init));
102 /* GstImplementsInterface interface */
105 gst_vaapisink_implements_interface_supported(
106 GstImplementsInterface *iface,
110 return (type == GST_TYPE_VIDEO_CONTEXT ||
111 type == GST_TYPE_X_OVERLAY);
115 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface)
117 iface->supported = gst_vaapisink_implements_interface_supported;
120 /* GstVaapiVideoSink interface */
123 gst_vaapisink_set_video_context(GstVideoContext *context, const gchar *type,
126 GstVaapiSink *sink = GST_VAAPISINK (context);
127 gst_vaapi_set_display (type, value, &sink->display);
131 gst_vaapisink_video_context_iface_init(GstVideoContextInterface *iface)
133 iface->set_context = gst_vaapisink_set_video_context;
136 /* GstXOverlay interface */
139 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id);
142 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer);
145 gst_vaapisink_xoverlay_set_window_handle(GstXOverlay *overlay, guintptr window)
147 GstVaapiSink * const sink = GST_VAAPISINK(overlay);
149 /* Disable GLX rendering when vaapisink is using a foreign X
150 window. It's pretty much useless */
151 sink->use_glx = FALSE;
153 sink->foreign_window = TRUE;
154 gst_vaapisink_ensure_window_xid(sink, window);
158 gst_vaapisink_xoverlay_set_render_rectangle(
159 GstXOverlay *overlay,
166 GstVaapiSink * const sink = GST_VAAPISINK(overlay);
167 GstVaapiRectangle * const display_rect = &sink->display_rect;
171 display_rect->width = width;
172 display_rect->height = height;
174 GST_DEBUG("render rect (%d,%d):%ux%u",
175 display_rect->x, display_rect->y,
176 display_rect->width, display_rect->height);
180 gst_vaapisink_xoverlay_expose(GstXOverlay *overlay)
182 GstBaseSink * const base_sink = GST_BASE_SINK(overlay);
185 buffer = gst_base_sink_get_last_buffer(base_sink);
187 gst_vaapisink_show_frame(base_sink, buffer);
188 gst_buffer_unref(buffer);
193 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface)
195 iface->set_window_handle = gst_vaapisink_xoverlay_set_window_handle;
196 iface->set_render_rectangle = gst_vaapisink_xoverlay_set_render_rectangle;
197 iface->expose = gst_vaapisink_xoverlay_expose;
201 gst_vaapisink_destroy(GstVaapiSink *sink)
203 g_clear_object(&sink->texture);
204 g_clear_object(&sink->display);
206 gst_caps_replace(&sink->caps, NULL);
209 /* Checks whether a ConfigureNotify event is in the queue */
210 typedef struct _ConfigureNotifyEventPendingArgs ConfigureNotifyEventPendingArgs;
211 struct _ConfigureNotifyEventPendingArgs {
219 configure_notify_event_pending_cb(Display *dpy, XEvent *xev, XPointer arg)
221 ConfigureNotifyEventPendingArgs * const args =
222 (ConfigureNotifyEventPendingArgs *)arg;
224 if (xev->type == ConfigureNotify &&
225 xev->xconfigure.window == args->window &&
226 xev->xconfigure.width == args->width &&
227 xev->xconfigure.height == args->height)
230 /* XXX: this is a hack to traverse the whole queue because we
231 can't use XPeekIfEvent() since it could block */
236 configure_notify_event_pending(
243 ConfigureNotifyEventPendingArgs args;
246 args.window = window;
248 args.height = height;
251 /* XXX: don't use XPeekIfEvent() because it might block */
253 gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
255 configure_notify_event_pending_cb, (XPointer)&args
261 gst_vaapisink_ensure_render_rect(GstVaapiSink *sink, guint width, guint height)
263 GstVaapiRectangle * const display_rect = &sink->display_rect;
264 guint num, den, display_par_n, display_par_d;
267 /* Return success if caps are not set yet */
271 GST_DEBUG("ensure render rect within %ux%u bounds", width, height);
273 gst_vaapi_display_get_pixel_aspect_ratio(
275 &display_par_n, &display_par_d
277 GST_DEBUG("display pixel-aspect-ratio %d/%d",
278 display_par_n, display_par_d);
280 success = gst_video_calculate_display_ratio(
282 sink->video_width, sink->video_height,
283 sink->video_par_n, sink->video_par_d,
284 display_par_n, display_par_d
288 GST_DEBUG("video size %dx%d, calculated ratio %d/%d",
289 sink->video_width, sink->video_height, num, den);
291 display_rect->width = gst_util_uint64_scale_int(height, num, den);
292 if (display_rect->width <= width) {
293 GST_DEBUG("keeping window height");
294 display_rect->height = height;
297 GST_DEBUG("keeping window width");
298 display_rect->width = width;
299 display_rect->height =
300 gst_util_uint64_scale_int(width, den, num);
302 GST_DEBUG("scaling video to %ux%u", display_rect->width, display_rect->height);
304 g_assert(display_rect->width <= width);
305 g_assert(display_rect->height <= height);
307 display_rect->x = (width - display_rect->width) / 2;
308 display_rect->y = (height - display_rect->height) / 2;
310 GST_DEBUG("render rect (%d,%d):%ux%u",
311 display_rect->x, display_rect->y,
312 display_rect->width, display_rect->height);
316 static inline gboolean
317 gst_vaapisink_ensure_window(GstVaapiSink *sink, guint width, guint height)
319 GstVaapiDisplay * const display = sink->display;
322 #if USE_VAAPISINK_GLX
324 sink->window = gst_vaapi_window_glx_new(display, width, height);
327 sink->window = gst_vaapi_window_x11_new(display, width, height);
329 gst_x_overlay_got_window_handle(
331 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window))
334 return sink->window != NULL;
338 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id)
341 unsigned int width, height, border_width, depth;
345 if (!gst_vaapi_ensure_display(sink, &sink->display))
348 gst_vaapi_display_lock(sink->display);
350 gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
353 &x, &y, &width, &height, &border_width, &depth
355 gst_vaapi_display_unlock(sink->display);
357 if ((width != sink->window_width || height != sink->window_height) &&
358 !configure_notify_event_pending(sink, xid, width, height)) {
359 if (!gst_vaapisink_ensure_render_rect(sink, width, height))
361 sink->window_width = width;
362 sink->window_height = height;
366 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window)) == xid)
369 g_clear_object(&sink->window);
371 #if USE_VAAPISINK_GLX
373 sink->window = gst_vaapi_window_glx_new_with_xid(sink->display, xid);
376 sink->window = gst_vaapi_window_x11_new_with_xid(sink->display, xid);
377 return sink->window != NULL;
381 gst_vaapisink_start(GstBaseSink *base_sink)
383 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
385 return gst_vaapi_ensure_display(sink, &sink->display);
389 gst_vaapisink_stop(GstBaseSink *base_sink)
391 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
393 g_clear_object(&sink->window);
394 g_clear_object(&sink->display);
400 gst_vaapisink_set_caps(GstBaseSink *base_sink, GstCaps *caps)
402 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
403 GstStructure * const structure = gst_caps_get_structure(caps, 0);
404 guint win_width, win_height, display_width, display_height;
405 gint video_width, video_height, video_par_n = 1, video_par_d = 1;
409 if (!gst_structure_get_int(structure, "width", &video_width))
411 if (!gst_structure_get_int(structure, "height", &video_height))
413 sink->video_width = video_width;
414 sink->video_height = video_height;
416 gst_video_parse_caps_pixel_aspect_ratio(caps, &video_par_n, &video_par_d);
417 sink->video_par_n = video_par_n;
418 sink->video_par_d = video_par_d;
419 GST_DEBUG("video pixel-aspect-ratio %d/%d", video_par_n, video_par_d);
421 gst_caps_replace(&sink->caps, caps);
423 if (!gst_vaapi_ensure_display(sink, &sink->display))
426 gst_vaapi_display_get_size(sink->display, &display_width, &display_height);
427 if (sink->foreign_window) {
428 win_width = sink->window_width;
429 win_height = sink->window_height;
431 else if (sink->fullscreen ||
432 video_width > display_width || video_height > display_height) {
433 win_width = display_width;
434 win_height = display_height;
437 win_width = video_width;
438 win_height = video_height;
442 if (!sink->foreign_window || sink->fullscreen)
443 gst_vaapi_window_set_size(sink->window, win_width, win_height);
446 gst_vaapi_display_lock(sink->display);
447 gst_x_overlay_prepare_xwindow_id(GST_X_OVERLAY(sink));
448 gst_vaapi_display_unlock(sink->display);
451 if (!gst_vaapisink_ensure_window(sink, win_width, win_height))
453 gst_vaapi_window_set_fullscreen(sink->window, sink->fullscreen);
454 gst_vaapi_window_show(sink->window);
455 gst_vaapi_window_get_size(sink->window, &win_width, &win_height);
457 sink->window_width = win_width;
458 sink->window_height = win_height;
459 GST_DEBUG("window size %ux%u", win_width, win_height);
461 return gst_vaapisink_ensure_render_rect(sink, win_width, win_height);
464 #if USE_VAAPISINK_GLX
466 render_background(GstVaapiSink *sink)
468 /* Original code from Mirco Muller (MacSlow):
469 <http://cgit.freedesktop.org/~macslow/gl-gst-player/> */
470 GLfloat fStartX = 0.0f;
471 GLfloat fStartY = 0.0f;
472 GLfloat fWidth = (GLfloat)sink->window_width;
473 GLfloat fHeight = (GLfloat)sink->window_height;
475 glClear(GL_COLOR_BUFFER_BIT);
478 /* top third, darker grey to white */
479 glColor3f(0.85f, 0.85f, 0.85f);
480 glVertex3f(fStartX, fStartY, 0.0f);
481 glColor3f(0.85f, 0.85f, 0.85f);
482 glVertex3f(fStartX + fWidth, fStartY, 0.0f);
483 glColor3f(1.0f, 1.0f, 1.0f);
484 glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
485 glColor3f(1.0f, 1.0f, 1.0f);
486 glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
488 /* middle third, just plain white */
489 glColor3f(1.0f, 1.0f, 1.0f);
490 glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
491 glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
492 glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
493 glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
495 /* bottom third, white to lighter grey */
496 glColor3f(1.0f, 1.0f, 1.0f);
497 glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
498 glColor3f(1.0f, 1.0f, 1.0f);
499 glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
500 glColor3f(0.62f, 0.66f, 0.69f);
501 glVertex3f(fStartX + fWidth, fStartY + fHeight, 0.0f);
502 glColor3f(0.62f, 0.66f, 0.69f);
503 glVertex3f(fStartX, fStartY + fHeight, 0.0f);
509 render_frame(GstVaapiSink *sink)
511 const guint x1 = sink->display_rect.x;
512 const guint x2 = sink->display_rect.x + sink->display_rect.width;
513 const guint y1 = sink->display_rect.y;
514 const guint y2 = sink->display_rect.y + sink->display_rect.height;
516 glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
519 glTexCoord2f(0.0f, 0.0f); glVertex2i(x1, y1);
520 glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y2);
521 glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y2);
522 glTexCoord2f(1.0f, 0.0f); glVertex2i(x2, y1);
528 render_reflection(GstVaapiSink *sink)
530 const guint x1 = sink->display_rect.x;
531 const guint x2 = sink->display_rect.x + sink->display_rect.width;
532 const guint y1 = sink->display_rect.y;
533 const guint rh = sink->display_rect.height / 5;
534 GLfloat ry = 1.0f - (GLfloat)rh / (GLfloat)sink->display_rect.height;
538 glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
539 glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y1);
540 glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y1);
542 glColor4f(1.0f, 1.0f, 1.0f, 0.0f);
543 glTexCoord2f(1.0f, ry); glVertex2i(x2, y1 + rh);
544 glTexCoord2f(0.0f, ry); glVertex2i(x1, y1 + rh);
550 gst_vaapisink_show_frame_glx(
552 GstVaapiSurface *surface,
556 GstVaapiWindowGLX * const window = GST_VAAPI_WINDOW_GLX(sink->window);
560 gst_vaapi_window_glx_make_current(window);
561 if (!sink->texture) {
562 sink->texture = gst_vaapi_texture_new(
570 goto error_create_texture;
572 if (!gst_vaapi_texture_put_surface(sink->texture, surface, flags))
573 goto error_transfer_surface;
575 target = gst_vaapi_texture_get_target(sink->texture);
576 texture = gst_vaapi_texture_get_id(sink->texture);
577 if (target != GL_TEXTURE_2D || !texture)
580 if (sink->use_reflection)
581 render_background(sink);
584 glBindTexture(target, texture);
586 if (sink->use_reflection) {
588 glRotatef(20.0f, 0.0f, 1.0f, 0.0f);
589 glTranslatef(50.0f, 0.0f, 0.0f);
592 if (sink->use_reflection) {
594 glTranslatef(0.0, (GLfloat)sink->display_rect.height + 5.0f, 0.0f);
595 render_reflection(sink);
600 glBindTexture(target, 0);
602 gst_vaapi_window_glx_swap_buffers(window);
606 error_create_texture:
608 GST_DEBUG("could not create VA/GLX texture");
611 error_transfer_surface:
613 GST_DEBUG("could not transfer VA surface to texture");
619 static inline gboolean
620 gst_vaapisink_show_frame_x11(
622 GstVaapiSurface *surface,
626 if (!gst_vaapi_window_put_surface(sink->window, surface,
627 NULL, &sink->display_rect, flags)) {
628 GST_DEBUG("could not render VA surface");
635 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer)
637 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
638 GstVaapiVideoBuffer * const vbuffer = GST_VAAPI_VIDEO_BUFFER(buffer);
639 GstVaapiSurface *surface;
642 GstVideoOverlayComposition * const composition =
643 gst_video_buffer_get_overlay_composition(buffer);
645 if (sink->display != gst_vaapi_video_buffer_get_display (vbuffer)) {
646 g_clear_object(&sink->display);
647 sink->display = g_object_ref (gst_vaapi_video_buffer_get_display (vbuffer));
651 return GST_FLOW_UNEXPECTED;
653 surface = gst_vaapi_video_buffer_get_surface(vbuffer);
655 return GST_FLOW_UNEXPECTED;
657 GST_DEBUG("render surface %" GST_VAAPI_ID_FORMAT,
658 GST_VAAPI_ID_ARGS(gst_vaapi_surface_get_id(surface)));
660 flags = gst_vaapi_video_buffer_get_render_flags(vbuffer);
662 if (!gst_vaapi_surface_set_subpictures_from_composition(surface,
664 GST_WARNING("could not update subtitles");
666 #if USE_VAAPISINK_GLX
668 success = gst_vaapisink_show_frame_glx(sink, surface, flags);
671 success = gst_vaapisink_show_frame_x11(sink, surface, flags);
672 return success ? GST_FLOW_OK : GST_FLOW_UNEXPECTED;
676 gst_vaapisink_query(GstBaseSink *base_sink, GstQuery *query)
678 GstVaapiSink *sink = GST_VAAPISINK(base_sink);
679 GST_DEBUG ("sharing display %p", sink->display);
680 return gst_vaapi_reply_to_query (query, sink->display);
684 gst_vaapisink_finalize(GObject *object)
686 gst_vaapisink_destroy(GST_VAAPISINK(object));
688 G_OBJECT_CLASS(gst_vaapisink_parent_class)->finalize(object);
692 gst_vaapisink_set_property(
699 GstVaapiSink * const sink = GST_VAAPISINK(object);
703 sink->use_glx = g_value_get_boolean(value);
705 case PROP_FULLSCREEN:
706 sink->fullscreen = g_value_get_boolean(value);
708 case PROP_SYNCHRONOUS:
709 sink->synchronous = g_value_get_boolean(value);
711 case PROP_USE_REFLECTION:
712 sink->use_reflection = g_value_get_boolean(value);
715 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
721 gst_vaapisink_get_property(
728 GstVaapiSink * const sink = GST_VAAPISINK(object);
732 g_value_set_boolean(value, sink->use_glx);
734 case PROP_FULLSCREEN:
735 g_value_set_boolean(value, sink->fullscreen);
737 case PROP_SYNCHRONOUS:
738 g_value_set_boolean(value, sink->synchronous);
740 case PROP_USE_REFLECTION:
741 g_value_set_boolean(value, sink->use_reflection);
744 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
750 gst_vaapisink_class_init(GstVaapiSinkClass *klass)
752 GObjectClass * const object_class = G_OBJECT_CLASS(klass);
753 GstElementClass * const element_class = GST_ELEMENT_CLASS(klass);
754 GstBaseSinkClass * const basesink_class = GST_BASE_SINK_CLASS(klass);
755 GstPadTemplate *pad_template;
757 GST_DEBUG_CATEGORY_INIT(gst_debug_vaapisink,
758 GST_PLUGIN_NAME, 0, GST_PLUGIN_DESC);
760 object_class->finalize = gst_vaapisink_finalize;
761 object_class->set_property = gst_vaapisink_set_property;
762 object_class->get_property = gst_vaapisink_get_property;
764 basesink_class->start = gst_vaapisink_start;
765 basesink_class->stop = gst_vaapisink_stop;
766 basesink_class->set_caps = gst_vaapisink_set_caps;
767 basesink_class->preroll = gst_vaapisink_show_frame;
768 basesink_class->render = gst_vaapisink_show_frame;
769 basesink_class->query = gst_vaapisink_query;
771 gst_element_class_set_details_simple(
773 gst_vaapisink_details.longname,
774 gst_vaapisink_details.klass,
775 gst_vaapisink_details.description,
776 gst_vaapisink_details.author
779 pad_template = gst_static_pad_template_get(&gst_vaapisink_sink_factory);
780 gst_element_class_add_pad_template(element_class, pad_template);
781 gst_object_unref(pad_template);
783 #if USE_VAAPISINK_GLX
784 g_object_class_install_property
787 g_param_spec_boolean("use-glx",
789 "Enables GLX rendering",
793 g_object_class_install_property
796 g_param_spec_boolean("use-reflection",
798 "Enables OpenGL reflection effect",
803 g_object_class_install_property
806 g_param_spec_boolean("fullscreen",
808 "Requests window in fullscreen state",
813 * GstVaapiSink:synchronous:
815 * When enabled, runs the X display in synchronous mode. Note that
816 * this is used only for debugging.
818 g_object_class_install_property
821 g_param_spec_boolean("synchronous",
823 "Toggles X display synchronous mode",
829 gst_vaapisink_init(GstVaapiSink *sink)
832 sink->display = NULL;
834 sink->window_width = 0;
835 sink->window_height = 0;
836 sink->texture = NULL;
837 sink->video_width = 0;
838 sink->video_height = 0;
839 sink->video_par_n = 1;
840 sink->video_par_d = 1;
841 sink->foreign_window = FALSE;
842 sink->fullscreen = FALSE;
843 sink->synchronous = FALSE;
844 sink->use_glx = USE_VAAPISINK_GLX;
845 sink->use_reflection = FALSE;