2 * gstvaapisink.c - VA-API video sink
4 * gstreamer-vaapi (C) 2010 Splitted-Desktop Systems
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 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 General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 * SECTION:gstvaapisink
23 * @short_description: A VA-API based videosink
25 * vaapisink renders video frames to a drawable (X #Window) on a local
26 * display using the Video Acceleration (VA) API. The element will
27 * create its own internal window and render into it.
32 #include <gst/video/video.h>
33 #include <gst/vaapi/gstvaapivideobuffer.h>
34 #include <gst/vaapi/gstvaapivideosink.h>
35 #include <gst/vaapi/gstvaapidisplay_x11.h>
36 #include <gst/vaapi/gstvaapiwindow_x11.h>
38 #include <gst/vaapi/gstvaapidisplay_glx.h>
39 #include <gst/vaapi/gstvaapiwindow_glx.h>
41 #include "gstvaapisink.h"
43 /* Supported interfaces */
44 #include <gst/interfaces/xoverlay.h>
46 #define GST_PLUGIN_NAME "vaapisink"
47 #define GST_PLUGIN_DESC "A VA-API based videosink"
49 GST_DEBUG_CATEGORY_STATIC(gst_debug_vaapisink);
50 #define GST_CAT_DEFAULT gst_debug_vaapisink
52 /* ElementFactory information */
53 static const GstElementDetails gst_vaapisink_details =
58 "Gwenole Beauchesne <gbeauchesne@splitted-desktop.com>");
60 /* Default template */
61 static GstStaticPadTemplate gst_vaapisink_sink_factory =
62 GST_STATIC_PAD_TEMPLATE(
66 GST_STATIC_CAPS(GST_VAAPI_SURFACE_CAPS));
68 static void gst_vaapisink_iface_init(GType type);
75 gst_vaapisink_iface_init);
87 /* GstImplementsInterface interface */
90 gst_vaapisink_implements_interface_supported(
91 GstImplementsInterface *iface,
95 return (type == GST_VAAPI_TYPE_VIDEO_SINK ||
96 type == GST_TYPE_X_OVERLAY);
100 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface)
102 iface->supported = gst_vaapisink_implements_interface_supported;
105 /* GstVaapiVideoSink interface */
107 static GstVaapiDisplay *
108 gst_vaapisink_get_display(GstVaapiSink *sink);
110 static GstVaapiDisplay *
111 gst_vaapi_video_sink_do_get_display(GstVaapiVideoSink *sink)
113 return gst_vaapisink_get_display(GST_VAAPISINK(sink));
117 gst_vaapi_video_sink_iface_init(GstVaapiVideoSinkInterface *iface)
119 iface->get_display = gst_vaapi_video_sink_do_get_display;
122 /* GstXOverlay interface */
125 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, XID xid);
128 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer);
131 gst_vaapisink_xoverlay_set_xid(GstXOverlay *overlay, XID xid)
133 GstVaapiSink * const sink = GST_VAAPISINK(overlay);
135 /* Disable GLX rendering when vaapisink is using a foreign X
136 window. It's pretty much useless */
137 sink->use_glx = FALSE;
139 gst_vaapisink_ensure_window_xid(sink, xid);
143 gst_vaapisink_xoverlay_expose(GstXOverlay *overlay)
145 GstBaseSink * const base_sink = GST_BASE_SINK(overlay);
148 buffer = gst_base_sink_get_last_buffer(base_sink);
150 gst_vaapisink_show_frame(base_sink, buffer);
151 gst_buffer_unref(buffer);
156 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface)
158 iface->set_xwindow_id = gst_vaapisink_xoverlay_set_xid;
159 iface->expose = gst_vaapisink_xoverlay_expose;
163 gst_vaapisink_iface_init(GType type)
165 const GType g_define_type_id = type;
167 G_IMPLEMENT_INTERFACE(GST_TYPE_IMPLEMENTS_INTERFACE,
168 gst_vaapisink_implements_iface_init);
169 G_IMPLEMENT_INTERFACE(GST_VAAPI_TYPE_VIDEO_SINK,
170 gst_vaapi_video_sink_iface_init);
171 G_IMPLEMENT_INTERFACE(GST_TYPE_X_OVERLAY,
172 gst_vaapisink_xoverlay_iface_init);
176 gst_vaapisink_destroy(GstVaapiSink *sink)
179 g_object_unref(sink->display);
180 sink->display = NULL;
183 if (sink->display_name) {
184 g_free(sink->display_name);
185 sink->display_name = NULL;
189 /* Checks whether a ConfigureNotify event is in the queue */
190 typedef struct _ConfigureNotifyEventPendingArgs ConfigureNotifyEventPendingArgs;
191 struct _ConfigureNotifyEventPendingArgs {
199 configure_notify_event_pending_cb(Display *dpy, XEvent *xev, XPointer arg)
201 ConfigureNotifyEventPendingArgs * const args =
202 (ConfigureNotifyEventPendingArgs *)arg;
204 if (xev->type == ConfigureNotify &&
205 xev->xconfigure.window == args->window &&
206 xev->xconfigure.width == args->width &&
207 xev->xconfigure.height == args->height)
210 /* XXX: this is a hack to traverse the whole queue because we
211 can't use XPeekIfEvent() since it could block */
216 configure_notify_event_pending(
223 ConfigureNotifyEventPendingArgs args;
226 args.window = window;
228 args.height = height;
231 /* XXX: don't use XPeekIfEvent() because it might block */
233 gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
235 configure_notify_event_pending_cb, (XPointer)&args
240 static inline gboolean
241 gst_vaapisink_ensure_display(GstVaapiSink *sink)
243 if (!sink->display) {
244 #if USE_VAAPISINK_GLX
246 sink->display = gst_vaapi_display_glx_new(sink->display_name);
249 sink->display = gst_vaapi_display_x11_new(sink->display_name);
250 if (!sink->display || !gst_vaapi_display_get_display(sink->display))
252 g_object_set(sink, "synchronous", sink->synchronous, NULL);
254 return sink->display != NULL;
258 gst_vaapisink_ensure_render_rect(GstVaapiSink *sink, guint width, guint height)
260 GstVaapiRectangle * const display_rect = &sink->display_rect;
261 guint num, den, display_par_n, display_par_d;
262 double display_ratio;
265 GST_DEBUG("ensure render rect within %ux%u bounds", width, height);
267 gst_vaapi_display_get_pixel_aspect_ratio(
269 &display_par_n, &display_par_d
271 GST_DEBUG("display pixel-aspect-ratio %d/%d",
272 display_par_n, display_par_d);
274 success = gst_video_calculate_display_ratio(
276 sink->video_width, sink->video_height,
277 sink->video_par_n, sink->video_par_d,
278 display_par_n, display_par_d
282 GST_DEBUG("video size %dx%d, calculated ratio %d/%d",
283 sink->video_width, sink->video_height, num, den);
285 if ((sink->video_height % den) == 0) {
286 GST_DEBUG("keeping video height");
287 display_rect->width =
288 gst_util_uint64_scale_int(sink->video_height, num, den);
289 display_rect->height = sink->video_height;
291 else if ((sink->video_width % num) == 0) {
292 GST_DEBUG("keeping video width");
293 display_rect->width = sink->video_width;
294 display_rect->height =
295 gst_util_uint64_scale_int(sink->video_width, den, num);
298 GST_DEBUG("approximating while keeping video height");
299 display_rect->width =
300 gst_util_uint64_scale_int(sink->video_height, num, den);
301 display_rect->height = sink->video_height;
303 display_ratio = (gdouble)display_rect->width / display_rect->height;
304 GST_DEBUG("scaling to %ux%u", display_rect->width, display_rect->height);
306 if (sink->fullscreen ||
307 display_rect->width > width || display_rect->height > height) {
308 if (sink->video_width > sink->video_height) {
309 display_rect->width = width;
310 display_rect->height = width / display_ratio;
313 display_rect->width = height * display_ratio;
314 display_rect->height = height;
318 if (sink->fullscreen) {
319 display_rect->x = (width - display_rect->width) / 2;
320 display_rect->y = (height - display_rect->height) / 2;
327 GST_DEBUG("render rect (%d,%d):%ux%u",
328 display_rect->x, display_rect->y,
329 display_rect->width, display_rect->height);
333 static inline gboolean
334 gst_vaapisink_ensure_window(GstVaapiSink *sink, guint width, guint height)
336 GstVaapiDisplay * const display = sink->display;
339 #if USE_VAAPISINK_GLX
341 sink->window = gst_vaapi_window_glx_new(display, width, height);
344 sink->window = gst_vaapi_window_x11_new(display, width, height);
346 gst_x_overlay_got_xwindow_id(
348 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window))
351 return sink->window != NULL;
355 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, XID xid)
358 unsigned int width, height, border_width, depth;
361 if (!gst_vaapisink_ensure_display(sink))
364 gst_vaapi_display_lock(sink->display);
366 gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
369 &x, &y, &width, &height, &border_width, &depth
371 gst_vaapi_display_unlock(sink->display);
373 if ((width != sink->window_width || height != sink->window_height) &&
374 !configure_notify_event_pending(sink, xid, width, height)) {
375 if (!gst_vaapisink_ensure_render_rect(sink, width, height))
377 sink->window_width = width;
378 sink->window_height = height;
382 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window)) == xid)
386 g_object_unref(sink->window);
390 #if USE_VAAPISINK_GLX
392 sink->window = gst_vaapi_window_glx_new_with_xid(sink->display, xid);
395 sink->window = gst_vaapi_window_x11_new_with_xid(sink->display, xid);
396 return sink->window != NULL;
400 gst_vaapisink_start(GstBaseSink *base_sink)
402 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
404 if (!gst_vaapisink_ensure_display(sink))
410 gst_vaapisink_stop(GstBaseSink *base_sink)
412 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
415 g_object_unref(sink->window);
420 g_object_unref(sink->display);
421 sink->display = NULL;
427 gst_vaapisink_set_caps(GstBaseSink *base_sink, GstCaps *caps)
429 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
430 GstStructure * const structure = gst_caps_get_structure(caps, 0);
431 guint display_width, display_height, win_width, win_height;
432 gint video_width, video_height, video_par_n = 1, video_par_d = 1;
436 if (!gst_structure_get_int(structure, "width", &video_width))
438 if (!gst_structure_get_int(structure, "height", &video_height))
440 sink->video_width = video_width;
441 sink->video_height = video_height;
443 gst_video_parse_caps_pixel_aspect_ratio(caps, &video_par_n, &video_par_d);
444 sink->video_par_n = video_par_n;
445 sink->video_par_d = video_par_d;
446 GST_DEBUG("video pixel-aspect-ratio %d/%d", video_par_n, video_par_d);
448 gst_vaapi_display_get_size(sink->display, &display_width, &display_height);
449 if (!gst_vaapisink_ensure_render_rect(sink, display_width, display_height))
452 if (sink->fullscreen) {
453 win_width = display_width;
454 win_height = display_height;
457 win_width = sink->display_rect.width;
458 win_height = sink->display_rect.height;
462 gst_vaapi_window_set_size(sink->window, win_width, win_height);
464 gst_vaapi_display_lock(sink->display);
465 gst_x_overlay_prepare_xwindow_id(GST_X_OVERLAY(sink));
466 gst_vaapi_display_unlock(sink->display);
469 if (!gst_vaapisink_ensure_window(sink, win_width, win_height))
471 gst_vaapi_window_set_fullscreen(sink->window, sink->fullscreen);
472 gst_vaapi_window_show(sink->window);
474 sink->window_width = win_width;
475 sink->window_height = win_height;
480 gst_vaapisink_buffer_alloc(
481 GstBaseSink *base_sink,
485 GstBuffer **pout_buffer
488 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
489 GstStructure *structure;
492 structure = gst_caps_get_structure(caps, 0);
493 if (!gst_structure_has_name(structure, "video/x-vaapi-surface"))
494 goto error_invalid_caps;
496 buffer = gst_vaapi_video_buffer_new(sink->display);
498 goto error_create_buffer;
500 gst_buffer_set_caps(buffer, caps);
501 *pout_buffer = buffer;
507 GST_DEBUG("failed to validate input caps");
508 return GST_FLOW_UNEXPECTED;
512 GST_DEBUG("failed to create video buffer");
513 return GST_FLOW_UNEXPECTED;
517 #if USE_VAAPISINK_GLX
519 render_background(GstVaapiSink *sink)
521 /* Original code from Mirco Muller (MacSlow):
522 <http://cgit.freedesktop.org/~macslow/gl-gst-player/> */
523 GLfloat fStartX = 0.0f;
524 GLfloat fStartY = 0.0f;
525 GLfloat fWidth = (GLfloat)sink->window_width;
526 GLfloat fHeight = (GLfloat)sink->window_height;
528 glClear(GL_COLOR_BUFFER_BIT);
531 /* top third, darker grey to white */
532 glColor3f(0.85f, 0.85f, 0.85f);
533 glVertex3f(fStartX, fStartY, 0.0f);
534 glColor3f(0.85f, 0.85f, 0.85f);
535 glVertex3f(fStartX + fWidth, fStartY, 0.0f);
536 glColor3f(1.0f, 1.0f, 1.0f);
537 glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
538 glColor3f(1.0f, 1.0f, 1.0f);
539 glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
541 /* middle third, just plain white */
542 glColor3f(1.0f, 1.0f, 1.0f);
543 glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
544 glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
545 glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
546 glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
548 /* bottom third, white to lighter grey */
549 glColor3f(1.0f, 1.0f, 1.0f);
550 glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
551 glColor3f(1.0f, 1.0f, 1.0f);
552 glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
553 glColor3f(0.62f, 0.66f, 0.69f);
554 glVertex3f(fStartX + fWidth, fStartY + fHeight, 0.0f);
555 glColor3f(0.62f, 0.66f, 0.69f);
556 glVertex3f(fStartX, fStartY + fHeight, 0.0f);
562 render_frame(GstVaapiSink *sink)
564 const guint x1 = sink->display_rect.x;
565 const guint x2 = sink->display_rect.x + sink->display_rect.width;
566 const guint y1 = sink->display_rect.y;
567 const guint y2 = sink->display_rect.y + sink->display_rect.height;
569 glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
572 glTexCoord2f(0.0f, 0.0f); glVertex2i(x1, y1);
573 glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y2);
574 glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y2);
575 glTexCoord2f(1.0f, 0.0f); glVertex2i(x2, y1);
581 render_reflection(GstVaapiSink *sink)
583 const guint x1 = sink->display_rect.x;
584 const guint x2 = sink->display_rect.x + sink->display_rect.width;
585 const guint y1 = sink->display_rect.y;
586 const guint rh = sink->display_rect.height / 5;
587 GLfloat ry = 1.0f - (GLfloat)rh / (GLfloat)sink->display_rect.height;
591 glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
592 glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y1);
593 glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y1);
595 glColor4f(1.0f, 1.0f, 1.0f, 0.0f);
596 glTexCoord2f(1.0f, ry); glVertex2i(x2, y1 + rh);
597 glTexCoord2f(0.0f, ry); glVertex2i(x1, y1 + rh);
603 gst_vaapisink_show_frame_glx(
605 GstVaapiSurface *surface,
609 GstVaapiWindowGLX * const window = GST_VAAPI_WINDOW_GLX(sink->window);
613 gst_vaapi_window_glx_make_current(window);
614 if (!sink->texture) {
615 sink->texture = gst_vaapi_texture_new(
623 goto error_create_texture;
625 if (!gst_vaapi_texture_put_surface(sink->texture, surface, flags))
626 goto error_transfer_surface;
628 target = gst_vaapi_texture_get_target(sink->texture);
629 texture = gst_vaapi_texture_get_id(sink->texture);
630 if (target != GL_TEXTURE_2D || !texture)
633 render_background(sink);
636 glBindTexture(target, texture);
638 if (sink->use_reflection) {
640 glRotatef(20.0f, 0.0f, 1.0f, 0.0f);
641 glTranslatef(50.0f, 0.0f, 0.0f);
644 if (sink->use_reflection) {
646 glTranslatef(0.0, (GLfloat)sink->display_rect.height + 5.0f, 0.0f);
647 render_reflection(sink);
652 glBindTexture(target, 0);
654 gst_vaapi_window_glx_swap_buffers(window);
658 error_create_texture:
660 GST_DEBUG("could not create VA/GLX texture");
663 error_transfer_surface:
665 GST_DEBUG("could not transfer VA surface to texture");
671 static inline gboolean
672 gst_vaapisink_show_frame_x11(
674 GstVaapiSurface *surface,
678 if (!gst_vaapi_window_put_surface(sink->window, surface,
679 NULL, &sink->display_rect, flags)) {
680 GST_DEBUG("could not render VA surface");
687 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer)
689 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
690 GstVaapiVideoBuffer * const vbuffer = GST_VAAPI_VIDEO_BUFFER(buffer);
691 GstVaapiSurface *surface;
696 return GST_FLOW_UNEXPECTED;
698 surface = gst_vaapi_video_buffer_get_surface(vbuffer);
700 return GST_FLOW_UNEXPECTED;
702 GST_DEBUG("render surface %" GST_VAAPI_ID_FORMAT,
703 GST_VAAPI_ID_ARGS(gst_vaapi_surface_get_id(surface)));
705 flags = GST_VAAPI_PICTURE_STRUCTURE_FRAME;
707 #if USE_VAAPISINK_GLX
709 success = gst_vaapisink_show_frame_glx(sink, surface, flags);
712 success = gst_vaapisink_show_frame_x11(sink, surface, flags);
713 return success ? GST_FLOW_OK : GST_FLOW_UNEXPECTED;
717 gst_vaapisink_finalize(GObject *object)
719 gst_vaapisink_destroy(GST_VAAPISINK(object));
721 G_OBJECT_CLASS(parent_class)->finalize(object);
725 gst_vaapisink_set_property(
732 GstVaapiSink * const sink = GST_VAAPISINK(object);
736 sink->use_glx = g_value_get_boolean(value);
739 g_free(sink->display_name);
740 sink->display_name = g_strdup(g_value_get_string(value));
742 case PROP_FULLSCREEN:
743 sink->fullscreen = g_value_get_boolean(value);
745 case PROP_SYNCHRONOUS:
746 sink->synchronous = g_value_get_boolean(value);
748 case PROP_USE_REFLECTION:
749 sink->use_reflection = g_value_get_boolean(value);
752 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
758 gst_vaapisink_get_property(
765 GstVaapiSink * const sink = GST_VAAPISINK(object);
769 g_value_set_boolean(value, sink->use_glx);
772 g_value_set_string(value, sink->display_name);
774 case PROP_FULLSCREEN:
775 g_value_set_boolean(value, sink->fullscreen);
777 case PROP_SYNCHRONOUS:
778 g_value_set_boolean(value, sink->synchronous);
780 case PROP_USE_REFLECTION:
781 g_value_set_boolean(value, sink->use_reflection);
784 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
790 gst_vaapisink_base_init(gpointer klass)
792 GstElementClass * const element_class = GST_ELEMENT_CLASS(klass);
794 gst_element_class_set_details(element_class, &gst_vaapisink_details);
796 gst_element_class_add_pad_template(
798 gst_static_pad_template_get(&gst_vaapisink_sink_factory)
803 gst_vaapisink_class_init(GstVaapiSinkClass *klass)
805 GObjectClass * const object_class = G_OBJECT_CLASS(klass);
806 GstBaseSinkClass * const basesink_class = GST_BASE_SINK_CLASS(klass);
808 object_class->finalize = gst_vaapisink_finalize;
809 object_class->set_property = gst_vaapisink_set_property;
810 object_class->get_property = gst_vaapisink_get_property;
812 basesink_class->start = gst_vaapisink_start;
813 basesink_class->stop = gst_vaapisink_stop;
814 basesink_class->set_caps = gst_vaapisink_set_caps;
815 basesink_class->buffer_alloc = gst_vaapisink_buffer_alloc;
816 basesink_class->preroll = gst_vaapisink_show_frame;
817 basesink_class->render = gst_vaapisink_show_frame;
819 #if USE_VAAPISINK_GLX
820 g_object_class_install_property
823 g_param_spec_boolean("use-glx",
825 "Enables GLX rendering",
829 g_object_class_install_property
832 g_param_spec_boolean("use-reflection",
834 "Enables OpenGL reflection effect",
839 g_object_class_install_property
842 g_param_spec_string("display",
848 g_object_class_install_property
851 g_param_spec_boolean("fullscreen",
853 "Requests window in fullscreen state",
858 * GstVaapiSink:synchronous:
860 * When enabled, runs the X display in synchronous mode. Note that
861 * this is used only for debugging.
863 g_object_class_install_property
866 g_param_spec_boolean("synchronous",
868 "Toggles X display synchronous mode",
874 gst_vaapisink_init(GstVaapiSink *sink, GstVaapiSinkClass *klass)
876 sink->display_name = NULL;
877 sink->display = NULL;
879 sink->window_width = 0;
880 sink->window_height = 0;
881 sink->texture = NULL;
882 sink->video_width = 0;
883 sink->video_height = 0;
884 sink->video_par_n = 1;
885 sink->video_par_d = 1;
886 sink->fullscreen = FALSE;
887 sink->synchronous = FALSE;
888 sink->use_glx = USE_VAAPISINK_GLX;
889 sink->use_reflection = FALSE;
893 gst_vaapisink_get_display(GstVaapiSink *sink)
895 if (!gst_vaapisink_ensure_display(sink))
897 return sink->display;
901 plugin_init(GstPlugin *plugin)
903 GST_DEBUG_CATEGORY_INIT(gst_debug_vaapisink,
904 GST_PLUGIN_NAME, 0, GST_PLUGIN_DESC);
906 return gst_element_register(plugin,
913 GST_VERSION_MAJOR, GST_VERSION_MINOR,