2 * gstvaapisink.c - VA-API video sink
4 * Copyright (C) 2010-2011 Splitted-Desktop Systems
5 * Copyright (C) 2011-2013 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.
32 #include "gst/vaapi/sysdeps.h"
34 #include <gst/video/video.h>
35 #include <gst/video/videocontext.h>
36 #include <gst/vaapi/gstvaapivalue.h>
38 # include <gst/vaapi/gstvaapidisplay_drm.h>
41 # include <gst/vaapi/gstvaapidisplay_x11.h>
42 # include <gst/vaapi/gstvaapiwindow_x11.h>
45 # include <gst/vaapi/gstvaapidisplay_glx.h>
46 # include <gst/vaapi/gstvaapiwindow_glx.h>
49 # include <gst/vaapi/gstvaapidisplay_wayland.h>
50 # include <gst/vaapi/gstvaapiwindow_wayland.h>
53 /* Supported interfaces */
54 #if GST_CHECK_VERSION(1,0,0)
55 # include <gst/video/videooverlay.h>
57 # include <gst/interfaces/xoverlay.h>
59 # define GST_TYPE_VIDEO_OVERLAY GST_TYPE_X_OVERLAY
60 # define GST_VIDEO_OVERLAY GST_X_OVERLAY
61 # define GstVideoOverlay GstXOverlay
62 # define GstVideoOverlayInterface GstXOverlayClass
64 # define gst_video_overlay_prepare_window_handle(sink) \
65 gst_x_overlay_prepare_xwindow_id(sink)
66 # define gst_video_overlay_got_window_handle(sink, window_handle) \
67 gst_x_overlay_got_window_handle(sink, window_handle)
70 #include "gstvaapisink.h"
71 #include "gstvaapipluginutil.h"
72 #include "gstvaapivideometa.h"
73 #if GST_CHECK_VERSION(1,0,0)
74 #include "gstvaapivideobufferpool.h"
75 #include "gstvaapivideomemory.h"
78 #define GST_PLUGIN_NAME "vaapisink"
79 #define GST_PLUGIN_DESC "A VA-API based videosink"
81 GST_DEBUG_CATEGORY_STATIC(gst_debug_vaapisink);
82 #define GST_CAT_DEFAULT gst_debug_vaapisink
84 /* Default template */
85 static const char gst_vaapisink_sink_caps_str[] =
86 #if !GST_CHECK_VERSION(1,0,0)
88 "width = (int) [ 1, MAX ], "
89 "height = (int) [ 1, MAX ]; "
91 GST_VAAPI_SURFACE_CAPS;
93 static GstStaticPadTemplate gst_vaapisink_sink_factory =
94 GST_STATIC_PAD_TEMPLATE(
98 GST_STATIC_CAPS(gst_vaapisink_sink_caps_str));
100 /* GstImplementsInterface interface */
101 #if !GST_CHECK_VERSION(1,0,0)
103 gst_vaapisink_implements_interface_supported(
104 GstImplementsInterface *iface,
108 return (type == GST_TYPE_VIDEO_CONTEXT ||
109 type == GST_TYPE_VIDEO_OVERLAY);
113 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface)
115 iface->supported = gst_vaapisink_implements_interface_supported;
119 /* GstVideoContext interface */
121 gst_vaapisink_set_video_context(GstVideoContext *context, const gchar *type,
124 GstVaapiSink *sink = GST_VAAPISINK (context);
125 gst_vaapi_set_display (type, value, &sink->display);
129 gst_vaapisink_video_context_iface_init(GstVideoContextInterface *iface)
131 iface->set_context = gst_vaapisink_set_video_context;
135 gst_vaapisink_video_overlay_iface_init(GstVideoOverlayInterface *iface);
137 G_DEFINE_TYPE_WITH_CODE(
141 #if !GST_CHECK_VERSION(1,0,0)
142 G_IMPLEMENT_INTERFACE(GST_TYPE_IMPLEMENTS_INTERFACE,
143 gst_vaapisink_implements_iface_init);
145 G_IMPLEMENT_INTERFACE(GST_TYPE_VIDEO_CONTEXT,
146 gst_vaapisink_video_context_iface_init);
147 G_IMPLEMENT_INTERFACE(GST_TYPE_VIDEO_OVERLAY,
148 gst_vaapisink_video_overlay_iface_init))
161 #define DEFAULT_DISPLAY_TYPE GST_VAAPI_DISPLAY_TYPE_ANY
162 #define DEFAULT_ROTATION GST_VAAPI_ROTATION_0
164 /* GstVideoOverlay interface */
168 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id);
172 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer);
175 gst_vaapisink_video_overlay_set_window_handle(GstVideoOverlay *overlay, guintptr window)
177 GstVaapiSink * const sink = GST_VAAPISINK(overlay);
179 /* Disable GLX rendering when vaapisink is using a foreign X
180 window. It's pretty much useless */
181 if (sink->display_type == GST_VAAPI_DISPLAY_TYPE_GLX)
182 sink->display_type = GST_VAAPI_DISPLAY_TYPE_X11;
184 sink->foreign_window = TRUE;
186 switch (sink->display_type) {
188 case GST_VAAPI_DISPLAY_TYPE_X11:
189 gst_vaapisink_ensure_window_xid(sink, window);
198 gst_vaapisink_video_overlay_set_render_rectangle(
199 GstVideoOverlay *overlay,
206 GstVaapiSink * const sink = GST_VAAPISINK(overlay);
207 GstVaapiRectangle * const display_rect = &sink->display_rect;
211 display_rect->width = width;
212 display_rect->height = height;
214 GST_DEBUG("render rect (%d,%d):%ux%u",
215 display_rect->x, display_rect->y,
216 display_rect->width, display_rect->height);
220 gst_vaapisink_video_overlay_expose(GstVideoOverlay *overlay)
222 GstVaapiSink * const sink = GST_VAAPISINK(overlay);
223 GstBaseSink * const base_sink = GST_BASE_SINK(overlay);
226 if (sink->use_overlay)
227 buffer = sink->video_buffer ? gst_buffer_ref(sink->video_buffer) : NULL;
229 #if GST_CHECK_VERSION(1,0,0)
230 GstSample * const sample = gst_base_sink_get_last_sample(base_sink);
233 buffer = gst_buffer_ref(gst_sample_get_buffer(sample));
234 gst_sample_unref(sample);
236 buffer = gst_base_sink_get_last_buffer(base_sink);
240 gst_vaapisink_show_frame(base_sink, buffer);
241 gst_buffer_unref(buffer);
246 gst_vaapisink_video_overlay_iface_init(GstVideoOverlayInterface *iface)
248 iface->set_window_handle = gst_vaapisink_video_overlay_set_window_handle;
249 iface->set_render_rectangle = gst_vaapisink_video_overlay_set_render_rectangle;
250 iface->expose = gst_vaapisink_video_overlay_expose;
254 gst_vaapisink_destroy(GstVaapiSink *sink)
256 gst_buffer_replace(&sink->video_buffer, NULL);
258 gst_vaapi_texture_replace(&sink->texture, NULL);
260 gst_vaapi_display_replace(&sink->display, NULL);
261 g_clear_object(&sink->uploader);
263 gst_caps_replace(&sink->caps, NULL);
267 /* Checks whether a ConfigureNotify event is in the queue */
268 typedef struct _ConfigureNotifyEventPendingArgs ConfigureNotifyEventPendingArgs;
269 struct _ConfigureNotifyEventPendingArgs {
277 configure_notify_event_pending_cb(Display *dpy, XEvent *xev, XPointer arg)
279 ConfigureNotifyEventPendingArgs * const args =
280 (ConfigureNotifyEventPendingArgs *)arg;
282 if (xev->type == ConfigureNotify &&
283 xev->xconfigure.window == args->window &&
284 xev->xconfigure.width == args->width &&
285 xev->xconfigure.height == args->height)
288 /* XXX: this is a hack to traverse the whole queue because we
289 can't use XPeekIfEvent() since it could block */
294 configure_notify_event_pending(
301 ConfigureNotifyEventPendingArgs args;
304 args.window = window;
306 args.height = height;
309 /* XXX: don't use XPeekIfEvent() because it might block */
311 gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
313 configure_notify_event_pending_cb, (XPointer)&args
320 get_display_type_name(GstVaapiDisplayType display_type)
322 gpointer const klass = g_type_class_peek(GST_VAAPI_TYPE_DISPLAY_TYPE);
323 GEnumValue * const e = g_enum_get_value(klass, display_type);
326 return e->value_name;
327 return "<unknown-type>";
330 static inline gboolean
331 gst_vaapisink_ensure_display(GstVaapiSink *sink)
333 GstVaapiDisplayType display_type;
334 GstVaapiRenderMode render_mode;
335 const gboolean had_display = sink->display != NULL;
337 if (!gst_vaapi_ensure_display(sink, sink->display_type, &sink->display))
340 display_type = gst_vaapi_display_get_display_type(sink->display);
341 if (display_type != sink->display_type || (!had_display && sink->display)) {
342 GST_INFO("created %s %p", get_display_type_name(display_type),
344 sink->display_type = display_type;
347 gst_vaapi_display_get_render_mode(sink->display, &render_mode) &&
348 render_mode == GST_VAAPI_RENDER_MODE_OVERLAY;
349 GST_DEBUG("use %s rendering mode", sink->use_overlay ? "overlay" : "texture");
351 sink->use_rotation = gst_vaapi_display_has_property(
352 sink->display, GST_VAAPI_DISPLAY_PROP_ROTATION);
358 gst_vaapisink_ensure_uploader(GstVaapiSink *sink)
360 if (!gst_vaapisink_ensure_display(sink))
363 if (!sink->uploader) {
364 sink->uploader = gst_vaapi_uploader_new(sink->display);
372 gst_vaapisink_ensure_render_rect(GstVaapiSink *sink, guint width, guint height)
374 GstVaapiRectangle * const display_rect = &sink->display_rect;
375 guint num, den, display_par_n, display_par_d;
378 /* Return success if caps are not set yet */
382 GST_DEBUG("ensure render rect within %ux%u bounds", width, height);
384 gst_vaapi_display_get_pixel_aspect_ratio(
386 &display_par_n, &display_par_d
388 GST_DEBUG("display pixel-aspect-ratio %d/%d",
389 display_par_n, display_par_d);
391 success = gst_video_calculate_display_ratio(
393 sink->video_width, sink->video_height,
394 sink->video_par_n, sink->video_par_d,
395 display_par_n, display_par_d
399 GST_DEBUG("video size %dx%d, calculated ratio %d/%d",
400 sink->video_width, sink->video_height, num, den);
402 display_rect->width = gst_util_uint64_scale_int(height, num, den);
403 if (display_rect->width <= width) {
404 GST_DEBUG("keeping window height");
405 display_rect->height = height;
408 GST_DEBUG("keeping window width");
409 display_rect->width = width;
410 display_rect->height =
411 gst_util_uint64_scale_int(width, den, num);
413 GST_DEBUG("scaling video to %ux%u", display_rect->width, display_rect->height);
415 g_assert(display_rect->width <= width);
416 g_assert(display_rect->height <= height);
418 display_rect->x = (width - display_rect->width) / 2;
419 display_rect->y = (height - display_rect->height) / 2;
421 GST_DEBUG("render rect (%d,%d):%ux%u",
422 display_rect->x, display_rect->y,
423 display_rect->width, display_rect->height);
428 gst_vaapisink_ensure_window_size(GstVaapiSink *sink, guint *pwidth, guint *pheight)
430 GstVideoRectangle src_rect, dst_rect, out_rect;
431 guint num, den, display_width, display_height, display_par_n, display_par_d;
432 gboolean success, scale;
434 if (sink->foreign_window) {
435 *pwidth = sink->window_width;
436 *pheight = sink->window_height;
440 gst_vaapi_display_get_size(sink->display, &display_width, &display_height);
441 if (sink->fullscreen) {
442 *pwidth = display_width;
443 *pheight = display_height;
447 gst_vaapi_display_get_pixel_aspect_ratio(
449 &display_par_n, &display_par_d
452 success = gst_video_calculate_display_ratio(
454 sink->video_width, sink->video_height,
455 sink->video_par_n, sink->video_par_d,
456 display_par_n, display_par_d
459 num = sink->video_par_n;
460 den = sink->video_par_d;
465 src_rect.w = gst_util_uint64_scale_int(sink->video_height, num, den);
466 src_rect.h = sink->video_height;
469 dst_rect.w = display_width;
470 dst_rect.h = display_height;
471 scale = (src_rect.w > dst_rect.w || src_rect.h > dst_rect.h);
472 gst_video_sink_center_rect(src_rect, dst_rect, &out_rect, scale);
473 *pwidth = out_rect.w;
474 *pheight = out_rect.h;
477 static inline gboolean
478 gst_vaapisink_ensure_window(GstVaapiSink *sink, guint width, guint height)
480 GstVaapiDisplay * const display = sink->display;
483 switch (sink->display_type) {
485 case GST_VAAPI_DISPLAY_TYPE_GLX:
486 sink->window = gst_vaapi_window_glx_new(display, width, height);
487 goto notify_video_overlay_interface;
490 case GST_VAAPI_DISPLAY_TYPE_X11:
491 sink->window = gst_vaapi_window_x11_new(display, width, height);
492 notify_video_overlay_interface:
495 gst_video_overlay_got_window_handle(
496 GST_VIDEO_OVERLAY(sink),
497 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window))
502 case GST_VAAPI_DISPLAY_TYPE_WAYLAND:
503 sink->window = gst_vaapi_window_wayland_new(display, width, height);
507 GST_ERROR("unsupported display type %d", sink->display_type);
511 return sink->window != NULL;
516 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id)
519 unsigned int width, height, border_width, depth;
523 if (!gst_vaapisink_ensure_display(sink))
526 gst_vaapi_display_lock(sink->display);
528 gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
531 &x, &y, &width, &height, &border_width, &depth
533 gst_vaapi_display_unlock(sink->display);
535 if ((width != sink->window_width || height != sink->window_height) &&
536 !configure_notify_event_pending(sink, xid, width, height)) {
537 if (!gst_vaapisink_ensure_render_rect(sink, width, height))
539 sink->window_width = width;
540 sink->window_height = height;
544 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window)) == xid)
547 gst_vaapi_window_replace(&sink->window, NULL);
549 switch (sink->display_type) {
551 case GST_VAAPI_DISPLAY_TYPE_GLX:
552 sink->window = gst_vaapi_window_glx_new_with_xid(sink->display, xid);
555 case GST_VAAPI_DISPLAY_TYPE_X11:
556 sink->window = gst_vaapi_window_x11_new_with_xid(sink->display, xid);
559 GST_ERROR("unsupported display type %d", sink->display_type);
562 return sink->window != NULL;
567 gst_vaapisink_ensure_rotation(GstVaapiSink *sink, gboolean recalc_display_rect)
569 gboolean success = FALSE;
571 g_return_val_if_fail(sink->display, FALSE);
573 if (sink->rotation == sink->rotation_req)
576 if (!sink->use_rotation) {
577 GST_WARNING("VA display does not support rotation");
581 gst_vaapi_display_lock(sink->display);
582 success = gst_vaapi_display_set_rotation(sink->display, sink->rotation_req);
583 gst_vaapi_display_unlock(sink->display);
585 GST_ERROR("failed to change VA display rotation mode");
589 if (((sink->rotation + sink->rotation_req) % 180) == 90) {
590 /* Orientation changed */
591 G_PRIMITIVE_SWAP(guint, sink->video_width, sink->video_height);
592 G_PRIMITIVE_SWAP(gint, sink->video_par_n, sink->video_par_d);
595 if (recalc_display_rect && !sink->foreign_window)
596 gst_vaapisink_ensure_render_rect(sink, sink->window_width,
597 sink->window_height);
601 sink->rotation = sink->rotation_req;
606 gst_vaapisink_ensure_video_buffer_pool(GstVaapiSink *sink, GstCaps *caps)
608 #if GST_CHECK_VERSION(1,0,0)
611 GstStructure *config;
615 if (!gst_vaapisink_ensure_display(sink))
618 if (sink->video_buffer_pool) {
619 config = gst_buffer_pool_get_config(sink->video_buffer_pool);
620 gst_buffer_pool_config_get_params(config, &pool_caps, NULL, NULL, NULL);
621 need_pool = !gst_caps_is_equal(caps, pool_caps);
622 gst_structure_free(config);
625 g_clear_object(&sink->video_buffer_pool);
626 sink->video_buffer_size = 0;
629 pool = gst_vaapi_video_buffer_pool_new(sink->display);
631 goto error_create_pool;
633 gst_video_info_init(&vi);
634 gst_video_info_from_caps(&vi, caps);
635 if (GST_VIDEO_INFO_FORMAT(&vi) == GST_VIDEO_FORMAT_ENCODED) {
636 GST_DEBUG("assume video buffer pool format is NV12");
637 gst_video_info_set_format(&vi, GST_VIDEO_FORMAT_NV12,
638 GST_VIDEO_INFO_WIDTH(&vi), GST_VIDEO_INFO_HEIGHT(&vi));
640 sink->video_buffer_size = vi.size;
642 config = gst_buffer_pool_get_config(pool);
643 gst_buffer_pool_config_set_params(config, caps, sink->video_buffer_size,
645 gst_buffer_pool_config_add_option(config,
646 GST_BUFFER_POOL_OPTION_VAAPI_VIDEO_META);
647 if (!gst_buffer_pool_set_config(pool, config))
648 goto error_pool_config;
649 sink->video_buffer_pool = pool;
655 GST_ERROR("failed to create buffer pool");
660 GST_ERROR("failed to reset buffer pool config");
661 gst_object_unref(pool);
670 gst_vaapisink_start(GstBaseSink *base_sink)
672 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
674 if (!gst_vaapisink_ensure_display(sink))
677 sink->uploader = gst_vaapi_uploader_new(sink->display);
684 gst_vaapisink_stop(GstBaseSink *base_sink)
686 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
688 gst_buffer_replace(&sink->video_buffer, NULL);
689 #if GST_CHECK_VERSION(1,0,0)
690 g_clear_object(&sink->video_buffer_pool);
692 gst_vaapi_window_replace(&sink->window, NULL);
693 gst_vaapi_display_replace(&sink->display, NULL);
694 g_clear_object(&sink->uploader);
700 gst_vaapisink_get_caps_impl(GstBaseSink *base_sink)
702 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
703 GstCaps *out_caps, *yuv_caps;
705 out_caps = gst_caps_from_string(GST_VAAPI_SURFACE_CAPS);
709 if (gst_vaapisink_ensure_uploader(sink)) {
710 yuv_caps = gst_vaapi_uploader_get_caps(sink->uploader);
712 gst_caps_append(out_caps, gst_caps_copy(yuv_caps));
717 #if GST_CHECK_VERSION(1,0,0)
718 static inline GstCaps *
719 gst_vaapisink_get_caps(GstBaseSink *base_sink, GstCaps *filter)
721 return gst_vaapisink_get_caps_impl(base_sink);
724 #define gst_vaapisink_get_caps gst_vaapisink_get_caps_impl
728 gst_vaapisink_set_caps(GstBaseSink *base_sink, GstCaps *caps)
730 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
732 guint win_width, win_height;
735 if (sink->display_type == GST_VAAPI_DISPLAY_TYPE_DRM)
739 if (!gst_vaapisink_ensure_video_buffer_pool(sink, caps))
742 if (!gst_video_info_from_caps(&vi, caps))
744 sink->use_video_raw = GST_VIDEO_INFO_IS_YUV(&vi);
745 sink->video_width = GST_VIDEO_INFO_WIDTH(&vi);
746 sink->video_height = GST_VIDEO_INFO_HEIGHT(&vi);
747 sink->video_par_n = GST_VIDEO_INFO_PAR_N(&vi);
748 sink->video_par_d = GST_VIDEO_INFO_PAR_D(&vi);
749 GST_DEBUG("video pixel-aspect-ratio %d/%d",
750 sink->video_par_n, sink->video_par_d);
752 gst_caps_replace(&sink->caps, caps);
754 if (!gst_vaapisink_ensure_display(sink))
757 gst_vaapisink_ensure_rotation(sink, FALSE);
759 gst_vaapisink_ensure_window_size(sink, &win_width, &win_height);
761 if (!sink->foreign_window || sink->fullscreen)
762 gst_vaapi_window_set_size(sink->window, win_width, win_height);
765 gst_vaapi_display_lock(sink->display);
766 gst_video_overlay_prepare_window_handle(GST_VIDEO_OVERLAY(sink));
767 gst_vaapi_display_unlock(sink->display);
770 if (!gst_vaapisink_ensure_window(sink, win_width, win_height))
772 gst_vaapi_window_set_fullscreen(sink->window, sink->fullscreen);
773 gst_vaapi_window_show(sink->window);
774 gst_vaapi_window_get_size(sink->window, &win_width, &win_height);
776 sink->window_width = win_width;
777 sink->window_height = win_height;
778 GST_DEBUG("window size %ux%u", win_width, win_height);
780 return gst_vaapisink_ensure_render_rect(sink, win_width, win_height);
785 render_background(GstVaapiSink *sink)
787 /* Original code from Mirco Muller (MacSlow):
788 <http://cgit.freedesktop.org/~macslow/gl-gst-player/> */
789 GLfloat fStartX = 0.0f;
790 GLfloat fStartY = 0.0f;
791 GLfloat fWidth = (GLfloat)sink->window_width;
792 GLfloat fHeight = (GLfloat)sink->window_height;
794 glClear(GL_COLOR_BUFFER_BIT);
797 /* top third, darker grey to white */
798 glColor3f(0.85f, 0.85f, 0.85f);
799 glVertex3f(fStartX, fStartY, 0.0f);
800 glColor3f(0.85f, 0.85f, 0.85f);
801 glVertex3f(fStartX + fWidth, fStartY, 0.0f);
802 glColor3f(1.0f, 1.0f, 1.0f);
803 glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
804 glColor3f(1.0f, 1.0f, 1.0f);
805 glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
807 /* middle third, just plain white */
808 glColor3f(1.0f, 1.0f, 1.0f);
809 glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
810 glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
811 glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
812 glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
814 /* bottom third, white to lighter grey */
815 glColor3f(1.0f, 1.0f, 1.0f);
816 glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
817 glColor3f(1.0f, 1.0f, 1.0f);
818 glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
819 glColor3f(0.62f, 0.66f, 0.69f);
820 glVertex3f(fStartX + fWidth, fStartY + fHeight, 0.0f);
821 glColor3f(0.62f, 0.66f, 0.69f);
822 glVertex3f(fStartX, fStartY + fHeight, 0.0f);
828 render_frame(GstVaapiSink *sink)
830 const guint x1 = sink->display_rect.x;
831 const guint x2 = sink->display_rect.x + sink->display_rect.width;
832 const guint y1 = sink->display_rect.y;
833 const guint y2 = sink->display_rect.y + sink->display_rect.height;
835 glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
838 glTexCoord2f(0.0f, 0.0f); glVertex2i(x1, y1);
839 glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y2);
840 glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y2);
841 glTexCoord2f(1.0f, 0.0f); glVertex2i(x2, y1);
847 render_reflection(GstVaapiSink *sink)
849 const guint x1 = sink->display_rect.x;
850 const guint x2 = sink->display_rect.x + sink->display_rect.width;
851 const guint y1 = sink->display_rect.y;
852 const guint rh = sink->display_rect.height / 5;
853 GLfloat ry = 1.0f - (GLfloat)rh / (GLfloat)sink->display_rect.height;
857 glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
858 glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y1);
859 glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y1);
861 glColor4f(1.0f, 1.0f, 1.0f, 0.0f);
862 glTexCoord2f(1.0f, ry); glVertex2i(x2, y1 + rh);
863 glTexCoord2f(0.0f, ry); glVertex2i(x1, y1 + rh);
869 gst_vaapisink_show_frame_glx(
871 GstVaapiSurface *surface,
875 GstVaapiWindowGLX * const window = GST_VAAPI_WINDOW_GLX(sink->window);
879 gst_vaapi_window_glx_make_current(window);
880 if (!sink->texture) {
881 sink->texture = gst_vaapi_texture_new(
889 goto error_create_texture;
891 if (!gst_vaapi_texture_put_surface(sink->texture, surface, flags))
892 goto error_transfer_surface;
894 target = gst_vaapi_texture_get_target(sink->texture);
895 texture = gst_vaapi_texture_get_id(sink->texture);
896 if (target != GL_TEXTURE_2D || !texture)
899 if (sink->use_reflection)
900 render_background(sink);
903 glBindTexture(target, texture);
905 if (sink->use_reflection) {
907 glRotatef(20.0f, 0.0f, 1.0f, 0.0f);
908 glTranslatef(50.0f, 0.0f, 0.0f);
911 if (sink->use_reflection) {
913 glTranslatef(0.0, (GLfloat)sink->display_rect.height + 5.0f, 0.0f);
914 render_reflection(sink);
919 glBindTexture(target, 0);
921 gst_vaapi_window_glx_swap_buffers(window);
925 error_create_texture:
927 GST_DEBUG("could not create VA/GLX texture");
930 error_transfer_surface:
932 GST_DEBUG("could not transfer VA surface to texture");
938 static inline gboolean
939 gst_vaapisink_put_surface(
941 GstVaapiSurface *surface,
945 if (!gst_vaapi_window_put_surface(sink->window, surface,
946 NULL, &sink->display_rect, flags)) {
947 GST_DEBUG("could not render VA surface");
954 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *src_buffer)
956 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
957 GstVaapiVideoMeta *meta;
958 GstVaapiSurface *surface;
963 meta = gst_buffer_get_vaapi_video_meta(src_buffer);
964 #if GST_CHECK_VERSION(1,0,0)
967 buffer = gst_buffer_ref(src_buffer);
970 buffer = gst_buffer_ref(src_buffer);
971 else if (sink->use_video_raw) {
972 buffer = gst_vaapi_uploader_get_buffer(sink->uploader);
975 meta = gst_buffer_get_vaapi_video_meta(buffer);
982 if (sink->use_video_raw &&
983 !gst_vaapi_uploader_process(sink->uploader, src_buffer, buffer)) {
984 GST_WARNING("failed to process raw YUV buffer");
989 if (sink->display != gst_vaapi_video_meta_get_display(meta))
990 gst_vaapi_display_replace(&sink->display,
991 gst_vaapi_video_meta_get_display(meta));
996 gst_vaapisink_ensure_rotation(sink, TRUE);
998 surface = gst_vaapi_video_meta_get_surface(meta);
1002 GST_DEBUG("render surface %" GST_VAAPI_ID_FORMAT,
1003 GST_VAAPI_ID_ARGS(gst_vaapi_surface_get_id(surface)));
1005 flags = gst_vaapi_video_meta_get_render_flags(meta);
1007 if (!gst_vaapi_apply_composition(surface, src_buffer))
1008 GST_WARNING("could not update subtitles");
1010 switch (sink->display_type) {
1012 case GST_VAAPI_DISPLAY_TYPE_DRM:
1017 case GST_VAAPI_DISPLAY_TYPE_GLX:
1019 goto put_surface_x11;
1020 success = gst_vaapisink_show_frame_glx(sink, surface, flags);
1024 case GST_VAAPI_DISPLAY_TYPE_X11:
1026 success = gst_vaapisink_put_surface(sink, surface, flags);
1030 case GST_VAAPI_DISPLAY_TYPE_WAYLAND:
1031 success = gst_vaapisink_put_surface(sink, surface, flags);
1035 GST_ERROR("unsupported display type %d", sink->display_type);
1042 /* Retain VA surface until the next one is displayed */
1043 if (sink->use_overlay)
1044 gst_buffer_replace(&sink->video_buffer, buffer);
1045 gst_buffer_unref(buffer);
1049 gst_buffer_unref(buffer);
1050 return GST_FLOW_EOS;
1053 #if GST_CHECK_VERSION(1,0,0)
1055 gst_vaapisink_propose_allocation(GstBaseSink *base_sink, GstQuery *query)
1057 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
1058 GstCaps *caps = NULL;
1061 gst_query_parse_allocation(query, &caps, &need_pool);
1066 if (!gst_vaapisink_ensure_video_buffer_pool(sink, caps))
1068 gst_query_add_allocation_pool(query, sink->video_buffer_pool,
1069 sink->video_buffer_size, 0, 0);
1072 gst_query_add_allocation_meta(query,
1073 GST_VAAPI_VIDEO_META_API_TYPE, NULL);
1074 gst_query_add_allocation_meta(query,
1075 GST_VIDEO_META_API_TYPE, NULL);
1076 gst_query_add_allocation_meta(query,
1077 GST_VIDEO_OVERLAY_COMPOSITION_META_API_TYPE, NULL);
1083 GST_ERROR("no caps specified");
1088 static GstFlowReturn
1089 gst_vaapisink_buffer_alloc(
1090 GstBaseSink *base_sink,
1097 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
1103 if (!sink->use_video_raw) {
1104 /* Note: this code path is rarely used but for raw YUV formats
1105 from custom pipeline. Otherwise, GstBaseSink::set_caps() is
1106 called first, and GstBaseSink::buffer_alloc() is not called
1107 in VA surface format mode */
1108 if (!gst_video_info_from_caps(&vi, caps))
1109 return GST_FLOW_NOT_SUPPORTED;
1110 if (!GST_VIDEO_INFO_IS_YUV(&vi))
1114 if (!gst_vaapi_uploader_ensure_display(sink->uploader, sink->display))
1115 return GST_FLOW_NOT_SUPPORTED;
1116 if (!gst_vaapi_uploader_ensure_caps(sink->uploader, caps, NULL))
1117 return GST_FLOW_NOT_SUPPORTED;
1119 buf = gst_vaapi_uploader_get_buffer(sink->uploader);
1121 GST_WARNING("failed to allocate resources for raw YUV buffer");
1122 return GST_FLOW_NOT_SUPPORTED;
1131 gst_vaapisink_query(GstBaseSink *base_sink, GstQuery *query)
1133 GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
1135 if (gst_vaapi_reply_to_query(query, sink->display)) {
1136 GST_DEBUG("sharing display %p", sink->display);
1139 return GST_BASE_SINK_CLASS(gst_vaapisink_parent_class)->query(base_sink,
1144 gst_vaapisink_finalize(GObject *object)
1146 gst_vaapisink_destroy(GST_VAAPISINK(object));
1148 G_OBJECT_CLASS(gst_vaapisink_parent_class)->finalize(object);
1152 gst_vaapisink_set_property(
1155 const GValue *value,
1159 GstVaapiSink * const sink = GST_VAAPISINK(object);
1162 case PROP_DISPLAY_TYPE:
1163 sink->display_type = g_value_get_enum(value);
1165 case PROP_FULLSCREEN:
1166 sink->fullscreen = g_value_get_boolean(value);
1168 case PROP_SYNCHRONOUS:
1169 sink->synchronous = g_value_get_boolean(value);
1172 sink->use_glx = g_value_get_boolean(value);
1174 case PROP_USE_REFLECTION:
1175 sink->use_reflection = g_value_get_boolean(value);
1178 sink->rotation_req = g_value_get_enum(value);
1181 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
1187 gst_vaapisink_get_property(
1194 GstVaapiSink * const sink = GST_VAAPISINK(object);
1197 case PROP_DISPLAY_TYPE:
1198 g_value_set_enum(value, sink->display_type);
1200 case PROP_FULLSCREEN:
1201 g_value_set_boolean(value, sink->fullscreen);
1203 case PROP_SYNCHRONOUS:
1204 g_value_set_boolean(value, sink->synchronous);
1207 g_value_set_boolean(value, sink->use_glx);
1209 case PROP_USE_REFLECTION:
1210 g_value_set_boolean(value, sink->use_reflection);
1213 g_value_set_enum(value, sink->rotation);
1216 G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
1222 gst_vaapisink_class_init(GstVaapiSinkClass *klass)
1224 GObjectClass * const object_class = G_OBJECT_CLASS(klass);
1225 GstElementClass * const element_class = GST_ELEMENT_CLASS(klass);
1226 GstBaseSinkClass * const basesink_class = GST_BASE_SINK_CLASS(klass);
1227 GstPadTemplate *pad_template;
1229 GST_DEBUG_CATEGORY_INIT(gst_debug_vaapisink,
1230 GST_PLUGIN_NAME, 0, GST_PLUGIN_DESC);
1232 object_class->finalize = gst_vaapisink_finalize;
1233 object_class->set_property = gst_vaapisink_set_property;
1234 object_class->get_property = gst_vaapisink_get_property;
1236 basesink_class->start = gst_vaapisink_start;
1237 basesink_class->stop = gst_vaapisink_stop;
1238 basesink_class->get_caps = gst_vaapisink_get_caps;
1239 basesink_class->set_caps = gst_vaapisink_set_caps;
1240 basesink_class->preroll = gst_vaapisink_show_frame;
1241 basesink_class->render = gst_vaapisink_show_frame;
1242 basesink_class->query = gst_vaapisink_query;
1243 #if GST_CHECK_VERSION(1,0,0)
1244 basesink_class->propose_allocation = gst_vaapisink_propose_allocation;
1246 basesink_class->buffer_alloc = gst_vaapisink_buffer_alloc;
1249 gst_element_class_set_static_metadata(element_class,
1253 "Gwenole Beauchesne <gwenole.beauchesne@intel.com>");
1255 pad_template = gst_static_pad_template_get(&gst_vaapisink_sink_factory);
1256 gst_element_class_add_pad_template(element_class, pad_template);
1258 g_object_class_install_property
1261 g_param_spec_enum("display",
1263 "display type to use",
1264 GST_VAAPI_TYPE_DISPLAY_TYPE,
1265 GST_VAAPI_DISPLAY_TYPE_ANY,
1266 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1269 g_object_class_install_property
1272 g_param_spec_boolean("use-glx",
1274 "Enables OpenGL rendering",
1276 G_PARAM_READWRITE));
1278 g_object_class_install_property
1280 PROP_USE_REFLECTION,
1281 g_param_spec_boolean("use-reflection",
1282 "Reflection effect",
1283 "Enables OpenGL reflection effect",
1285 G_PARAM_READWRITE));
1288 g_object_class_install_property
1291 g_param_spec_boolean("fullscreen",
1293 "Requests window in fullscreen state",
1295 G_PARAM_READWRITE));
1298 * GstVaapiSink:synchronous:
1300 * When enabled, runs the X display in synchronous mode. Note that
1301 * this is used only for debugging.
1303 g_object_class_install_property
1306 g_param_spec_boolean("synchronous",
1308 "Toggles X display synchronous mode",
1310 G_PARAM_READWRITE));
1313 * GstVaapiSink:rotation:
1315 * The VA display rotation mode, expressed as a #GstVaapiRotation.
1317 g_object_class_install_property
1320 g_param_spec_enum(GST_VAAPI_DISPLAY_PROP_ROTATION,
1322 "The display rotation mode",
1323 GST_VAAPI_TYPE_ROTATION,
1325 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1329 gst_vaapisink_init(GstVaapiSink *sink)
1332 sink->display = NULL;
1333 sink->window = NULL;
1334 sink->window_width = 0;
1335 sink->window_height = 0;
1336 sink->texture = NULL;
1337 sink->video_buffer = NULL;
1338 sink->video_width = 0;
1339 sink->video_height = 0;
1340 sink->video_par_n = 1;
1341 sink->video_par_d = 1;
1342 sink->foreign_window = FALSE;
1343 sink->fullscreen = FALSE;
1344 sink->synchronous = FALSE;
1345 sink->display_type = DEFAULT_DISPLAY_TYPE;
1346 sink->rotation = DEFAULT_ROTATION;
1347 sink->rotation_req = DEFAULT_ROTATION;
1348 sink->use_reflection = FALSE;
1349 sink->use_overlay = FALSE;
1350 sink->use_rotation = FALSE;