gst/vaapi/gstvaapisink.c

   1 /*
   2  *  gstvaapisink.c - VA-API video sink
   3  *
   4  *  Copyright (C) 2010-2011 Splitted-Desktop Systems
   5  *  Copyright (C) 2011-2013 Intel Corporation
   6  *
   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.
  11  *
  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.
  16  *
  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
  21  */
  22
  23 /**
  24  * SECTION:gstvaapisink
  25  * @short_description: A VA-API based videosink
  26  *
  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.
  30  */
  31
  32 #include "gst/vaapi/sysdeps.h"
  33 #include <gst/gst.h>
  34 #include <gst/video/video.h>
  35 #include <gst/video/videocontext.h>
  36 #include <gst/vaapi/gstvaapivalue.h>
  37 #include <gst/vaapi/gstvaapivideometa.h>
  38 #if USE_DRM
  39 # include <gst/vaapi/gstvaapidisplay_drm.h>
  40 #endif
  41 #if USE_X11
  42 # include <gst/vaapi/gstvaapidisplay_x11.h>
  43 # include <gst/vaapi/gstvaapiwindow_x11.h>
  44 #endif
  45 #if USE_GLX
  46 # include <gst/vaapi/gstvaapidisplay_glx.h>
  47 # include <gst/vaapi/gstvaapiwindow_glx.h>
  48 #endif
  49 #if USE_WAYLAND
  50 # include <gst/vaapi/gstvaapidisplay_wayland.h>
  51 # include <gst/vaapi/gstvaapiwindow_wayland.h>
  52 #endif
  53
  54 /* Supported interfaces */
  55 #include <gst/interfaces/xoverlay.h>
  56
  57 #include "gstvaapisink.h"
  58 #include "gstvaapipluginutil.h"
  59
  60 #define GST_PLUGIN_NAME "vaapisink"
  61 #define GST_PLUGIN_DESC "A VA-API based videosink"
  62
  63 GST_DEBUG_CATEGORY_STATIC(gst_debug_vaapisink);
  64 #define GST_CAT_DEFAULT gst_debug_vaapisink
  65
  66 /* Default template */
  67 static const char gst_vaapisink_sink_caps_str[] =
  68     "video/x-raw-yuv, "
  69     "width  = (int) [ 1, MAX ], "
  70     "height = (int) [ 1, MAX ]; "
  71     GST_VAAPI_SURFACE_CAPS;
  72
  73 static GstStaticPadTemplate gst_vaapisink_sink_factory =
  74     GST_STATIC_PAD_TEMPLATE(
  75         "sink",
  76         GST_PAD_SINK,
  77         GST_PAD_ALWAYS,
  78         GST_STATIC_CAPS(gst_vaapisink_sink_caps_str));
  79
  80 /* GstImplementsInterface interface */
  81 static gboolean
  82 gst_vaapisink_implements_interface_supported(
  83     GstImplementsInterface *iface,
  84     GType                   type
  85 )
  86 {
  87     return (type == GST_TYPE_VIDEO_CONTEXT ||
  88             type == GST_TYPE_X_OVERLAY);
  89 }
  90
  91 static void
  92 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface)
  93 {
  94     iface->supported = gst_vaapisink_implements_interface_supported;
  95 }
  96
  97 /* GstVideoContext interface */
  98 static void
  99 gst_vaapisink_set_video_context(GstVideoContext *context, const gchar *type,
 100     const GValue *value)
 101 {
 102   GstVaapiSink *sink = GST_VAAPISINK (context);
 103   gst_vaapi_set_display (type, value, &sink->display);
 104 }
 105
 106 static void
 107 gst_vaapisink_video_context_iface_init(GstVideoContextInterface *iface)
 108 {
 109     iface->set_context = gst_vaapisink_set_video_context;
 110 }
 111
 112 static void
 113 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface);
 114
 115 G_DEFINE_TYPE_WITH_CODE(
 116     GstVaapiSink,
 117     gst_vaapisink,
 118     GST_TYPE_VIDEO_SINK,
 119     G_IMPLEMENT_INTERFACE(GST_TYPE_IMPLEMENTS_INTERFACE,
 120                           gst_vaapisink_implements_iface_init);
 121     G_IMPLEMENT_INTERFACE(GST_TYPE_VIDEO_CONTEXT,
 122                           gst_vaapisink_video_context_iface_init);
 123     G_IMPLEMENT_INTERFACE(GST_TYPE_X_OVERLAY,
 124                           gst_vaapisink_xoverlay_iface_init))
 125
 126 enum {
 127     PROP_0,
 128
 129     PROP_DISPLAY_TYPE,
 130     PROP_FULLSCREEN,
 131     PROP_SYNCHRONOUS,
 132     PROP_USE_REFLECTION,
 133     PROP_ROTATION,
 134 };
 135
 136 #define DEFAULT_DISPLAY_TYPE            GST_VAAPI_DISPLAY_TYPE_ANY
 137 #define DEFAULT_ROTATION                GST_VAAPI_ROTATION_0
 138
 139 /* GstXOverlay interface */
 140
 141 #if USE_X11
 142 static gboolean
 143 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id);
 144 #endif
 145
 146 static GstFlowReturn
 147 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer);
 148
 149 static void
 150 gst_vaapisink_xoverlay_set_window_handle(GstXOverlay *overlay, guintptr window)
 151 {
 152     GstVaapiSink * const sink = GST_VAAPISINK(overlay);
 153
 154     /* Disable GLX rendering when vaapisink is using a foreign X
 155        window. It's pretty much useless */
 156     if (sink->display_type == GST_VAAPI_DISPLAY_TYPE_GLX)
 157         sink->display_type = GST_VAAPI_DISPLAY_TYPE_X11;
 158
 159     sink->foreign_window = TRUE;
 160
 161     switch (sink->display_type) {
 162 #if USE_X11
 163     case GST_VAAPI_DISPLAY_TYPE_X11:
 164         gst_vaapisink_ensure_window_xid(sink, window);
 165         break;
 166 #endif
 167     default:
 168         break;
 169     }
 170 }
 171
 172 static void
 173 gst_vaapisink_xoverlay_set_render_rectangle(
 174     GstXOverlay *overlay,
 175     gint         x,
 176     gint         y,
 177     gint         width,
 178     gint         height
 179 )
 180 {
 181     GstVaapiSink * const sink = GST_VAAPISINK(overlay);
 182     GstVaapiRectangle * const display_rect = &sink->display_rect;
 183
 184     display_rect->x      = x;
 185     display_rect->y      = y;
 186     display_rect->width  = width;
 187     display_rect->height = height;
 188
 189     GST_DEBUG("render rect (%d,%d):%ux%u",
 190               display_rect->x, display_rect->y,
 191               display_rect->width, display_rect->height);
 192 }
 193
 194 static void
 195 gst_vaapisink_xoverlay_expose(GstXOverlay *overlay)
 196 {
 197     GstBaseSink * const base_sink = GST_BASE_SINK(overlay);
 198     GstBuffer *buffer;
 199
 200     buffer = gst_base_sink_get_last_buffer(base_sink);
 201     if (buffer) {
 202         gst_vaapisink_show_frame(base_sink, buffer);
 203         gst_buffer_unref(buffer);
 204     }
 205 }
 206
 207 static void
 208 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface)
 209 {
 210     iface->set_window_handle    = gst_vaapisink_xoverlay_set_window_handle;
 211     iface->set_render_rectangle = gst_vaapisink_xoverlay_set_render_rectangle;
 212     iface->expose               = gst_vaapisink_xoverlay_expose;
 213 }
 214
 215 static void
 216 gst_vaapisink_destroy(GstVaapiSink *sink)
 217 {
 218     gst_buffer_replace(&sink->video_buffer, NULL);
 219     g_clear_object(&sink->texture);
 220     g_clear_object(&sink->display);
 221     g_clear_object(&sink->uploader);
 222
 223     gst_caps_replace(&sink->caps, NULL);
 224 }
 225
 226 #if USE_X11
 227 /* Checks whether a ConfigureNotify event is in the queue */
 228 typedef struct _ConfigureNotifyEventPendingArgs ConfigureNotifyEventPendingArgs;
 229 struct _ConfigureNotifyEventPendingArgs {
 230     Window      window;
 231     guint       width;
 232     guint       height;
 233     gboolean    match;
 234 };
 235
 236 static Bool
 237 configure_notify_event_pending_cb(Display *dpy, XEvent *xev, XPointer arg)
 238 {
 239     ConfigureNotifyEventPendingArgs * const args =
 240         (ConfigureNotifyEventPendingArgs *)arg;
 241
 242     if (xev->type == ConfigureNotify &&
 243         xev->xconfigure.window == args->window &&
 244         xev->xconfigure.width  == args->width  &&
 245         xev->xconfigure.height == args->height)
 246         args->match = TRUE;
 247
 248     /* XXX: this is a hack to traverse the whole queue because we
 249        can't use XPeekIfEvent() since it could block */
 250     return False;
 251 }
 252
 253 static gboolean
 254 configure_notify_event_pending(
 255     GstVaapiSink *sink,
 256     Window        window,
 257     guint         width,
 258     guint         height
 259 )
 260 {
 261     ConfigureNotifyEventPendingArgs args;
 262     XEvent xev;
 263
 264     args.window = window;
 265     args.width  = width;
 266     args.height = height;
 267     args.match  = FALSE;
 268
 269     /* XXX: don't use XPeekIfEvent() because it might block */
 270     XCheckIfEvent(
 271         gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
 272         &xev,
 273         configure_notify_event_pending_cb, (XPointer)&args
 274     );
 275     return args.match;
 276 }
 277 #endif
 278
 279 static const gchar *
 280 get_display_type_name(GstVaapiDisplayType display_type)
 281 {
 282     gpointer const klass = g_type_class_peek(GST_VAAPI_TYPE_DISPLAY_TYPE);
 283     GEnumValue * const e = g_enum_get_value(klass, display_type);
 284
 285     if (e)
 286         return e->value_name;
 287     return "<unknown-type>";
 288 }
 289
 290 static inline gboolean
 291 gst_vaapisink_ensure_display(GstVaapiSink *sink)
 292 {
 293     GstVaapiDisplayType display_type;
 294     GstVaapiRenderMode render_mode;
 295
 296     if (!gst_vaapi_ensure_display(sink, sink->display_type, &sink->display))
 297         return FALSE;
 298
 299     display_type = gst_vaapi_display_get_display_type(sink->display);
 300     if (display_type != sink->display_type) {
 301         GST_INFO("created %s %p", get_display_type_name(display_type),
 302             sink->display);
 303         sink->display_type = display_type;
 304
 305         sink->use_overlay =
 306             gst_vaapi_display_get_render_mode(sink->display, &render_mode) &&
 307             render_mode == GST_VAAPI_RENDER_MODE_OVERLAY;
 308         GST_DEBUG("use %s rendering mode", sink->use_overlay ? "overlay" : "texture");
 309
 310         sink->use_rotation = gst_vaapi_display_has_property(
 311             sink->display, GST_VAAPI_DISPLAY_PROP_ROTATION);
 312     }
 313     return TRUE;
 314 }
 315
 316 static gboolean
 317 gst_vaapisink_ensure_uploader(GstVaapiSink *sink)
 318 {
 319     if (!gst_vaapisink_ensure_display(sink))
 320         return FALSE;
 321
 322     if (!sink->uploader) {
 323         sink->uploader = gst_vaapi_uploader_new(sink->display);
 324         if (!sink->uploader)
 325             return FALSE;
 326     }
 327     return TRUE;
 328 }
 329
 330 static gboolean
 331 gst_vaapisink_ensure_render_rect(GstVaapiSink *sink, guint width, guint height)
 332 {
 333     GstVaapiRectangle * const display_rect = &sink->display_rect;
 334     guint num, den, display_par_n, display_par_d;
 335     gboolean success;
 336
 337     /* Return success if caps are not set yet */
 338     if (!sink->caps)
 339         return TRUE;
 340
 341     GST_DEBUG("ensure render rect within %ux%u bounds", width, height);
 342
 343     gst_vaapi_display_get_pixel_aspect_ratio(
 344         sink->display,
 345         &display_par_n, &display_par_d
 346     );
 347     GST_DEBUG("display pixel-aspect-ratio %d/%d",
 348               display_par_n, display_par_d);
 349
 350     success = gst_video_calculate_display_ratio(
 351         &num, &den,
 352         sink->video_width, sink->video_height,
 353         sink->video_par_n, sink->video_par_d,
 354         display_par_n, display_par_d
 355     );
 356     if (!success)
 357         return FALSE;
 358     GST_DEBUG("video size %dx%d, calculated ratio %d/%d",
 359               sink->video_width, sink->video_height, num, den);
 360
 361     display_rect->width = gst_util_uint64_scale_int(height, num, den);
 362     if (display_rect->width <= width) {
 363         GST_DEBUG("keeping window height");
 364         display_rect->height = height;
 365     }
 366     else {
 367         GST_DEBUG("keeping window width");
 368         display_rect->width  = width;
 369         display_rect->height =
 370             gst_util_uint64_scale_int(width, den, num);
 371     }
 372     GST_DEBUG("scaling video to %ux%u", display_rect->width, display_rect->height);
 373
 374     g_assert(display_rect->width  <= width);
 375     g_assert(display_rect->height <= height);
 376
 377     display_rect->x = (width  - display_rect->width)  / 2;
 378     display_rect->y = (height - display_rect->height) / 2;
 379
 380     GST_DEBUG("render rect (%d,%d):%ux%u",
 381               display_rect->x, display_rect->y,
 382               display_rect->width, display_rect->height);
 383     return TRUE;
 384 }
 385
 386 static void
 387 gst_vaapisink_ensure_window_size(GstVaapiSink *sink, guint *pwidth, guint *pheight)
 388 {
 389     GstVideoRectangle src_rect, dst_rect, out_rect;
 390     guint num, den, display_width, display_height, display_par_n, display_par_d;
 391     gboolean success, scale;
 392
 393     if (sink->foreign_window) {
 394         *pwidth  = sink->window_width;
 395         *pheight = sink->window_height;
 396         return;
 397     }
 398
 399     gst_vaapi_display_get_size(sink->display, &display_width, &display_height);
 400     if (sink->fullscreen) {
 401         *pwidth  = display_width;
 402         *pheight = display_height;
 403         return;
 404     }
 405
 406     gst_vaapi_display_get_pixel_aspect_ratio(
 407         sink->display,
 408         &display_par_n, &display_par_d
 409     );
 410
 411     success = gst_video_calculate_display_ratio(
 412         &num, &den,
 413         sink->video_width, sink->video_height,
 414         sink->video_par_n, sink->video_par_d,
 415         display_par_n, display_par_d
 416     );
 417     if (!success) {
 418         num = sink->video_par_n;
 419         den = sink->video_par_d;
 420     }
 421
 422     src_rect.x = 0;
 423     src_rect.y = 0;
 424     src_rect.w = gst_util_uint64_scale_int(sink->video_height, num, den);
 425     src_rect.h = sink->video_height;
 426     dst_rect.x = 0;
 427     dst_rect.y = 0;
 428     dst_rect.w = display_width;
 429     dst_rect.h = display_height;
 430     scale      = (src_rect.w > dst_rect.w || src_rect.h > dst_rect.h);
 431     gst_video_sink_center_rect(src_rect, dst_rect, &out_rect, scale);
 432     *pwidth    = out_rect.w;
 433     *pheight   = out_rect.h;
 434 }
 435
 436 static inline gboolean
 437 gst_vaapisink_ensure_window(GstVaapiSink *sink, guint width, guint height)
 438 {
 439     GstVaapiDisplay * const display = sink->display;
 440
 441     if (!sink->window) {
 442         switch (sink->display_type) {
 443 #if USE_GLX
 444         case GST_VAAPI_DISPLAY_TYPE_GLX:
 445             sink->window = gst_vaapi_window_glx_new(display, width, height);
 446             goto notify_xoverlay_interface;
 447 #endif
 448 #if USE_X11
 449         case GST_VAAPI_DISPLAY_TYPE_X11:
 450             sink->window = gst_vaapi_window_x11_new(display, width, height);
 451         notify_xoverlay_interface:
 452             if (!sink->window)
 453                 break;
 454             gst_x_overlay_got_window_handle(
 455                 GST_X_OVERLAY(sink),
 456                 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window))
 457             );
 458             break;
 459 #endif
 460 #if USE_WAYLAND
 461         case GST_VAAPI_DISPLAY_TYPE_WAYLAND:
 462             sink->window = gst_vaapi_window_wayland_new(display, width, height);
 463             break;
 464 #endif
 465         default:
 466             GST_ERROR("unsupported display type %d", sink->display_type);
 467             return FALSE;
 468         }
 469     }
 470     return sink->window != NULL;
 471 }
 472
 473 #if USE_X11
 474 static gboolean
 475 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id)
 476 {
 477     Window rootwin;
 478     unsigned int width, height, border_width, depth;
 479     int x, y;
 480     XID xid = window_id;
 481
 482     if (!gst_vaapisink_ensure_display(sink))
 483         return FALSE;
 484
 485     gst_vaapi_display_lock(sink->display);
 486     XGetGeometry(
 487         gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
 488         xid,
 489         &rootwin,
 490         &x, &y, &width, &height, &border_width, &depth
 491     );
 492     gst_vaapi_display_unlock(sink->display);
 493
 494     if ((width != sink->window_width || height != sink->window_height) &&
 495         !configure_notify_event_pending(sink, xid, width, height)) {
 496         if (!gst_vaapisink_ensure_render_rect(sink, width, height))
 497             return FALSE;
 498         sink->window_width  = width;
 499         sink->window_height = height;
 500     }
 501
 502     if (sink->window &&
 503         gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window)) == xid)
 504         return TRUE;
 505
 506     g_clear_object(&sink->window);
 507
 508     switch (sink->display_type) {
 509 #if USE_GLX
 510     case GST_VAAPI_DISPLAY_TYPE_GLX:
 511         sink->window = gst_vaapi_window_glx_new_with_xid(sink->display, xid);
 512         break;
 513 #endif
 514     case GST_VAAPI_DISPLAY_TYPE_X11:
 515         sink->window = gst_vaapi_window_x11_new_with_xid(sink->display, xid);
 516         break;
 517     default:
 518         GST_ERROR("unsupported display type %d", sink->display_type);
 519         return FALSE;
 520     }
 521     return sink->window != NULL;
 522 }
 523 #endif
 524
 525 static gboolean
 526 gst_vaapisink_ensure_rotation(GstVaapiSink *sink, gboolean recalc_display_rect)
 527 {
 528     gboolean success = FALSE;
 529
 530     g_return_val_if_fail(sink->display, FALSE);
 531
 532     if (sink->rotation == sink->rotation_req)
 533         return TRUE;
 534
 535     if (!sink->use_rotation) {
 536         GST_WARNING("VA display does not support rotation");
 537         goto end;
 538     }
 539
 540     gst_vaapi_display_lock(sink->display);
 541     success = gst_vaapi_display_set_rotation(sink->display, sink->rotation_req);
 542     gst_vaapi_display_unlock(sink->display);
 543     if (!success) {
 544         GST_ERROR("failed to change VA display rotation mode");
 545         goto end;
 546     }
 547
 548     if (((sink->rotation + sink->rotation_req) % 180) == 90) {
 549         /* Orientation changed */
 550         G_PRIMITIVE_SWAP(guint, sink->video_width, sink->video_height);
 551         G_PRIMITIVE_SWAP(gint, sink->video_par_n, sink->video_par_d);
 552     }
 553
 554     if (recalc_display_rect && !sink->foreign_window)
 555         gst_vaapisink_ensure_render_rect(sink, sink->window_width,
 556             sink->window_height);
 557     success = TRUE;
 558
 559 end:
 560     sink->rotation = sink->rotation_req;
 561     return success;
 562 }
 563
 564 static gboolean
 565 gst_vaapisink_start(GstBaseSink *base_sink)
 566 {
 567     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
 568
 569     if (!gst_vaapisink_ensure_display(sink))
 570         return FALSE;
 571
 572     sink->uploader = gst_vaapi_uploader_new(sink->display);
 573     if (!sink->uploader)
 574         return FALSE;
 575     return TRUE;
 576 }
 577
 578 static gboolean
 579 gst_vaapisink_stop(GstBaseSink *base_sink)
 580 {
 581     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
 582
 583     gst_buffer_replace(&sink->video_buffer, NULL);
 584     g_clear_object(&sink->window);
 585     g_clear_object(&sink->display);
 586     g_clear_object(&sink->uploader);
 587
 588     return TRUE;
 589 }
 590
 591 static GstCaps *
 592 gst_vaapisink_get_caps(GstBaseSink *base_sink)
 593 {
 594     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
 595     GstCaps *out_caps, *yuv_caps;
 596
 597     out_caps = gst_caps_from_string(GST_VAAPI_SURFACE_CAPS);
 598     if (!out_caps)
 599         return NULL;
 600
 601     if (gst_vaapisink_ensure_uploader(sink)) {
 602         yuv_caps = gst_vaapi_uploader_get_caps(sink->uploader);
 603         if (yuv_caps)
 604             gst_caps_append(out_caps, gst_caps_copy(yuv_caps));
 605     }
 606     return out_caps;
 607 }
 608
 609 static gboolean
 610 gst_vaapisink_set_caps(GstBaseSink *base_sink, GstCaps *caps)
 611 {
 612     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
 613     GstStructure * const structure = gst_caps_get_structure(caps, 0);
 614     GstVideoInfo vi;
 615     guint win_width, win_height;
 616
 617 #if USE_DRM
 618     if (sink->display_type == GST_VAAPI_DISPLAY_TYPE_DRM)
 619         return TRUE;
 620 #endif
 621
 622     if (!gst_video_info_from_caps(&vi, caps))
 623         return FALSE;
 624     sink->video_width  = GST_VIDEO_INFO_WIDTH(&vi);
 625     sink->video_height = GST_VIDEO_INFO_HEIGHT(&vi);
 626     sink->video_par_n  = GST_VIDEO_INFO_PAR_N(&vi);
 627     sink->video_par_d  = GST_VIDEO_INFO_PAR_D(&vi);
 628     GST_DEBUG("video pixel-aspect-ratio %d/%d",
 629               sink->video_par_n, sink->video_par_d);
 630
 631     if (gst_structure_has_name(structure, "video/x-raw-yuv"))
 632         sink->use_video_raw = TRUE;
 633
 634     gst_caps_replace(&sink->caps, caps);
 635
 636     if (!gst_vaapisink_ensure_display(sink))
 637         return FALSE;
 638
 639     gst_vaapisink_ensure_rotation(sink, FALSE);
 640
 641     gst_vaapisink_ensure_window_size(sink, &win_width, &win_height);
 642     if (sink->window) {
 643         if (!sink->foreign_window || sink->fullscreen)
 644             gst_vaapi_window_set_size(sink->window, win_width, win_height);
 645     }
 646     else {
 647         gst_vaapi_display_lock(sink->display);
 648         gst_x_overlay_prepare_xwindow_id(GST_X_OVERLAY(sink));
 649         gst_vaapi_display_unlock(sink->display);
 650         if (sink->window)
 651             return TRUE;
 652         if (!gst_vaapisink_ensure_window(sink, win_width, win_height))
 653             return FALSE;
 654         gst_vaapi_window_set_fullscreen(sink->window, sink->fullscreen);
 655         gst_vaapi_window_show(sink->window);
 656         gst_vaapi_window_get_size(sink->window, &win_width, &win_height);
 657     }
 658     sink->window_width  = win_width;
 659     sink->window_height = win_height;
 660     GST_DEBUG("window size %ux%u", win_width, win_height);
 661
 662     return gst_vaapisink_ensure_render_rect(sink, win_width, win_height);
 663 }
 664
 665 #if USE_GLX
 666 static void
 667 render_background(GstVaapiSink *sink)
 668 {
 669     /* Original code from Mirco Muller (MacSlow):
 670        <http://cgit.freedesktop.org/~macslow/gl-gst-player/> */
 671     GLfloat fStartX = 0.0f;
 672     GLfloat fStartY = 0.0f;
 673     GLfloat fWidth  = (GLfloat)sink->window_width;
 674     GLfloat fHeight = (GLfloat)sink->window_height;
 675
 676     glClear(GL_COLOR_BUFFER_BIT);
 677     glBegin(GL_QUADS);
 678     {
 679         /* top third, darker grey to white */
 680         glColor3f(0.85f, 0.85f, 0.85f);
 681         glVertex3f(fStartX, fStartY, 0.0f);
 682         glColor3f(0.85f, 0.85f, 0.85f);
 683         glVertex3f(fStartX + fWidth, fStartY, 0.0f);
 684         glColor3f(1.0f, 1.0f, 1.0f);
 685         glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
 686         glColor3f(1.0f, 1.0f, 1.0f);
 687         glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
 688
 689         /* middle third, just plain white */
 690         glColor3f(1.0f, 1.0f, 1.0f);
 691         glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
 692         glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
 693         glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
 694         glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
 695
 696         /* bottom third, white to lighter grey */
 697         glColor3f(1.0f, 1.0f, 1.0f);
 698         glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
 699         glColor3f(1.0f, 1.0f, 1.0f);
 700         glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
 701         glColor3f(0.62f, 0.66f, 0.69f);
 702         glVertex3f(fStartX + fWidth, fStartY + fHeight, 0.0f);
 703         glColor3f(0.62f, 0.66f, 0.69f);
 704         glVertex3f(fStartX, fStartY + fHeight, 0.0f);
 705     }
 706     glEnd();
 707 }
 708
 709 static void
 710 render_frame(GstVaapiSink *sink)
 711 {
 712     const guint x1 = sink->display_rect.x;
 713     const guint x2 = sink->display_rect.x + sink->display_rect.width;
 714     const guint y1 = sink->display_rect.y;
 715     const guint y2 = sink->display_rect.y + sink->display_rect.height;
 716
 717     glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
 718     glBegin(GL_QUADS);
 719     {
 720         glTexCoord2f(0.0f, 0.0f); glVertex2i(x1, y1);
 721         glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y2);
 722         glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y2);
 723         glTexCoord2f(1.0f, 0.0f); glVertex2i(x2, y1);
 724     }
 725     glEnd();
 726 }
 727
 728 static void
 729 render_reflection(GstVaapiSink *sink)
 730 {
 731     const guint x1 = sink->display_rect.x;
 732     const guint x2 = sink->display_rect.x + sink->display_rect.width;
 733     const guint y1 = sink->display_rect.y;
 734     const guint rh = sink->display_rect.height / 5;
 735     GLfloat     ry = 1.0f - (GLfloat)rh / (GLfloat)sink->display_rect.height;
 736
 737     glBegin(GL_QUADS);
 738     {
 739         glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
 740         glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y1);
 741         glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y1);
 742
 743         glColor4f(1.0f, 1.0f, 1.0f, 0.0f);
 744         glTexCoord2f(1.0f, ry); glVertex2i(x2, y1 + rh);
 745         glTexCoord2f(0.0f, ry); glVertex2i(x1, y1 + rh);
 746     }
 747     glEnd();
 748 }
 749
 750 static gboolean
 751 gst_vaapisink_show_frame_glx(
 752     GstVaapiSink    *sink,
 753     GstVaapiSurface *surface,
 754     guint            flags
 755 )
 756 {
 757     GstVaapiWindowGLX * const window = GST_VAAPI_WINDOW_GLX(sink->window);
 758     GLenum target;
 759     GLuint texture;
 760
 761     gst_vaapi_window_glx_make_current(window);
 762     if (!sink->texture) {
 763         sink->texture = gst_vaapi_texture_new(
 764             sink->display,
 765             GL_TEXTURE_2D,
 766             GL_BGRA,
 767             sink->video_width,
 768             sink->video_height
 769         );
 770         if (!sink->texture)
 771             goto error_create_texture;
 772     }
 773     if (!gst_vaapi_texture_put_surface(sink->texture, surface, flags))
 774         goto error_transfer_surface;
 775
 776     target  = gst_vaapi_texture_get_target(sink->texture);
 777     texture = gst_vaapi_texture_get_id(sink->texture);
 778     if (target != GL_TEXTURE_2D || !texture)
 779         return FALSE;
 780
 781     if (sink->use_reflection)
 782         render_background(sink);
 783
 784     glEnable(target);
 785     glBindTexture(target, texture);
 786     {
 787         if (sink->use_reflection) {
 788             glPushMatrix();
 789             glRotatef(20.0f, 0.0f, 1.0f, 0.0f);
 790             glTranslatef(50.0f, 0.0f, 0.0f);
 791         }
 792         render_frame(sink);
 793         if (sink->use_reflection) {
 794             glPushMatrix();
 795             glTranslatef(0.0, (GLfloat)sink->display_rect.height + 5.0f, 0.0f);
 796             render_reflection(sink);
 797             glPopMatrix();
 798             glPopMatrix();
 799         }
 800     }
 801     glBindTexture(target, 0);
 802     glDisable(target);
 803     gst_vaapi_window_glx_swap_buffers(window);
 804     return TRUE;
 805
 806     /* ERRORS */
 807 error_create_texture:
 808     {
 809         GST_DEBUG("could not create VA/GLX texture");
 810         return FALSE;
 811     }
 812 error_transfer_surface:
 813     {
 814         GST_DEBUG("could not transfer VA surface to texture");
 815         return FALSE;
 816     }
 817 }
 818 #endif
 819
 820 static inline gboolean
 821 gst_vaapisink_put_surface(
 822     GstVaapiSink    *sink,
 823     GstVaapiSurface *surface,
 824     guint            flags
 825 )
 826 {
 827     if (!gst_vaapi_window_put_surface(sink->window, surface,
 828                 NULL, &sink->display_rect, flags)) {
 829         GST_DEBUG("could not render VA surface");
 830         return FALSE;
 831     }
 832     return TRUE;
 833 }
 834
 835 static inline gboolean
 836 set_composition_from_buffer(GstVaapiSurface *surface, GstBuffer *buffer)
 837 {
 838     GstVideoOverlayComposition * const composition =
 839         gst_video_buffer_get_overlay_composition(buffer);
 840
 841     if (!composition)
 842         return FALSE;
 843     return gst_vaapi_surface_set_subpictures_from_composition(surface,
 844             composition, TRUE);
 845 }
 846
 847 static GstFlowReturn
 848 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *src_buffer)
 849 {
 850     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
 851     GstVaapiVideoMeta *meta;
 852     GstVaapiSurface *surface;
 853     GstBuffer *buffer;
 854     guint flags;
 855     gboolean success;
 856
 857     meta = gst_buffer_get_vaapi_video_meta(src_buffer);
 858     if (meta)
 859         buffer = gst_buffer_ref(src_buffer);
 860     else if (sink->use_video_raw) {
 861         buffer = gst_vaapi_uploader_get_buffer(sink->uploader);
 862         if (!buffer)
 863             return GST_FLOW_UNEXPECTED;
 864         meta = gst_buffer_get_vaapi_video_meta(buffer);
 865         if (!meta)
 866             goto error;
 867     }
 868     else
 869         return GST_FLOW_UNEXPECTED;
 870
 871     if (sink->use_video_raw &&
 872         !gst_vaapi_uploader_process(sink->uploader, src_buffer, buffer)) {
 873         GST_WARNING("failed to process raw YUV buffer");
 874         goto error;
 875     }
 876
 877     if (sink->display != gst_vaapi_video_meta_get_display(meta)) {
 878         g_clear_object(&sink->display);
 879         sink->display = g_object_ref(gst_vaapi_video_meta_get_display(meta));
 880     }
 881
 882     if (!sink->window)
 883         goto error;
 884
 885     gst_vaapisink_ensure_rotation(sink, TRUE);
 886
 887     surface = gst_vaapi_video_meta_get_surface(meta);
 888     if (!surface)
 889         goto error;
 890
 891     GST_DEBUG("render surface %" GST_VAAPI_ID_FORMAT,
 892               GST_VAAPI_ID_ARGS(gst_vaapi_surface_get_id(surface)));
 893
 894     flags = gst_vaapi_video_meta_get_render_flags(meta);
 895
 896     if (!set_composition_from_buffer(surface, src_buffer))
 897         GST_WARNING("could not update subtitles");
 898
 899     switch (sink->display_type) {
 900 #if USE_GLX
 901     case GST_VAAPI_DISPLAY_TYPE_GLX:
 902         success = gst_vaapisink_show_frame_glx(sink, surface, flags);
 903         break;
 904 #endif
 905 #if USE_DRM
 906     case GST_VAAPI_DISPLAY_TYPE_DRM:
 907         success = TRUE;
 908         break;
 909 #endif
 910 #if USE_X11
 911     case GST_VAAPI_DISPLAY_TYPE_X11:
 912         success = gst_vaapisink_put_surface(sink, surface, flags);
 913         break;
 914 #endif
 915 #if USE_WAYLAND
 916     case GST_VAAPI_DISPLAY_TYPE_WAYLAND:
 917         success = gst_vaapisink_put_surface(sink, surface, flags);
 918         break;
 919 #endif
 920     default:
 921         GST_ERROR("unsupported display type %d", sink->display_type);
 922         success = FALSE;
 923         break;
 924     }
 925     if (!success)
 926         goto error;
 927
 928     /* Retain VA surface until the next one is displayed */
 929     if (sink->use_overlay)
 930         gst_buffer_replace(&sink->video_buffer, buffer);
 931     gst_buffer_unref(buffer);
 932     return GST_FLOW_OK;
 933
 934 error:
 935     gst_buffer_unref(buffer);
 936     return GST_FLOW_UNEXPECTED;
 937 }
 938
 939 static GstFlowReturn
 940 gst_vaapisink_buffer_alloc(
 941     GstBaseSink        *base_sink,
 942     guint64             offset,
 943     guint               size,
 944     GstCaps            *caps,
 945     GstBuffer         **pbuf
 946 )
 947 {
 948     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
 949     GstStructure *structure;
 950     GstBuffer *buf;
 951
 952     *pbuf = NULL;
 953
 954     structure = gst_caps_get_structure(caps, 0);
 955     if (!gst_structure_has_name(structure, "video/x-raw-yuv"))
 956         return GST_FLOW_OK;
 957
 958     if (!gst_vaapi_uploader_ensure_display(sink->uploader, sink->display))
 959         return GST_FLOW_NOT_SUPPORTED;
 960     if (!gst_vaapi_uploader_ensure_caps(sink->uploader, caps, NULL))
 961         return GST_FLOW_NOT_SUPPORTED;
 962
 963     buf = gst_vaapi_uploader_get_buffer(sink->uploader);
 964     if (!buf) {
 965         GST_WARNING("failed to allocate resources for raw YUV buffer");
 966         return GST_FLOW_NOT_SUPPORTED;
 967     }
 968
 969     *pbuf = buf;
 970     return GST_FLOW_OK;
 971 }
 972
 973 static gboolean
 974 gst_vaapisink_query(GstBaseSink *base_sink, GstQuery *query)
 975 {
 976     GstVaapiSink *sink = GST_VAAPISINK(base_sink);
 977     GST_DEBUG ("sharing display %p", sink->display);
 978     return gst_vaapi_reply_to_query (query, sink->display);
 979 }
 980
 981 static void
 982 gst_vaapisink_finalize(GObject *object)
 983 {
 984     gst_vaapisink_destroy(GST_VAAPISINK(object));
 985
 986     G_OBJECT_CLASS(gst_vaapisink_parent_class)->finalize(object);
 987 }
 988
 989 static void
 990 gst_vaapisink_set_property(
 991     GObject      *object,
 992     guint         prop_id,
 993     const GValue *value,
 994     GParamSpec   *pspec
 995 )
 996 {
 997     GstVaapiSink * const sink = GST_VAAPISINK(object);
 998
 999     switch (prop_id) {
1000     case PROP_DISPLAY_TYPE:
1001         sink->display_type = g_value_get_enum(value);
1002         break;
1003     case PROP_FULLSCREEN:
1004         sink->fullscreen = g_value_get_boolean(value);
1005         break;
1006     case PROP_SYNCHRONOUS:
1007         sink->synchronous = g_value_get_boolean(value);
1008         break;
1009     case PROP_USE_REFLECTION:
1010         sink->use_reflection = g_value_get_boolean(value);
1011         break;
1012     case PROP_ROTATION:
1013         sink->rotation_req = g_value_get_enum(value);
1014         break;
1015     default:
1016         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
1017         break;
1018     }
1019 }
1020
1021 static void
1022 gst_vaapisink_get_property(
1023     GObject    *object,
1024     guint       prop_id,
1025     GValue     *value,
1026     GParamSpec *pspec
1027 )
1028 {
1029     GstVaapiSink * const sink = GST_VAAPISINK(object);
1030
1031     switch (prop_id) {
1032     case PROP_DISPLAY_TYPE:
1033         g_value_set_enum(value, sink->display_type);
1034         break;
1035     case PROP_FULLSCREEN:
1036         g_value_set_boolean(value, sink->fullscreen);
1037         break;
1038     case PROP_SYNCHRONOUS:
1039         g_value_set_boolean(value, sink->synchronous);
1040         break;
1041     case PROP_USE_REFLECTION:
1042         g_value_set_boolean(value, sink->use_reflection);
1043         break;
1044     case PROP_ROTATION:
1045         g_value_set_enum(value, sink->rotation);
1046         break;
1047     default:
1048         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
1049         break;
1050     }
1051 }
1052
1053 static void
1054 gst_vaapisink_class_init(GstVaapiSinkClass *klass)
1055 {
1056     GObjectClass * const     object_class   = G_OBJECT_CLASS(klass);
1057     GstElementClass * const  element_class  = GST_ELEMENT_CLASS(klass);
1058     GstBaseSinkClass * const basesink_class = GST_BASE_SINK_CLASS(klass);
1059     GstPadTemplate *pad_template;
1060
1061     GST_DEBUG_CATEGORY_INIT(gst_debug_vaapisink,
1062                             GST_PLUGIN_NAME, 0, GST_PLUGIN_DESC);
1063
1064     object_class->finalize       = gst_vaapisink_finalize;
1065     object_class->set_property   = gst_vaapisink_set_property;
1066     object_class->get_property   = gst_vaapisink_get_property;
1067
1068     basesink_class->start        = gst_vaapisink_start;
1069     basesink_class->stop         = gst_vaapisink_stop;
1070     basesink_class->get_caps     = gst_vaapisink_get_caps;
1071     basesink_class->set_caps     = gst_vaapisink_set_caps;
1072     basesink_class->preroll      = gst_vaapisink_show_frame;
1073     basesink_class->render       = gst_vaapisink_show_frame;
1074     basesink_class->query        = gst_vaapisink_query;
1075     basesink_class->buffer_alloc = gst_vaapisink_buffer_alloc;
1076
1077     gst_element_class_set_static_metadata(element_class,
1078         "VA-API sink",
1079         "Sink/Video",
1080         GST_PLUGIN_DESC,
1081         "Gwenole Beauchesne <gwenole.beauchesne@intel.com>");
1082
1083     pad_template = gst_static_pad_template_get(&gst_vaapisink_sink_factory);
1084     gst_element_class_add_pad_template(element_class, pad_template);
1085     gst_object_unref(pad_template);
1086
1087     g_object_class_install_property
1088         (object_class,
1089          PROP_DISPLAY_TYPE,
1090          g_param_spec_enum("display",
1091                            "display type",
1092                            "display type to use",
1093                            GST_VAAPI_TYPE_DISPLAY_TYPE,
1094                            GST_VAAPI_DISPLAY_TYPE_ANY,
1095                            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1096
1097 #if USE_GLX
1098     g_object_class_install_property
1099         (object_class,
1100          PROP_USE_REFLECTION,
1101          g_param_spec_boolean("use-reflection",
1102                               "Reflection effect",
1103                               "Enables OpenGL reflection effect",
1104                               FALSE,
1105                               G_PARAM_READWRITE));
1106 #endif
1107
1108     g_object_class_install_property
1109         (object_class,
1110          PROP_FULLSCREEN,
1111          g_param_spec_boolean("fullscreen",
1112                               "Fullscreen",
1113                               "Requests window in fullscreen state",
1114                               FALSE,
1115                               G_PARAM_READWRITE));
1116
1117     /**
1118      * GstVaapiSink:synchronous:
1119      *
1120      * When enabled, runs the X display in synchronous mode. Note that
1121      * this is used only for debugging.
1122      */
1123     g_object_class_install_property
1124         (object_class,
1125          PROP_SYNCHRONOUS,
1126          g_param_spec_boolean("synchronous",
1127                               "Synchronous mode",
1128                               "Toggles X display synchronous mode",
1129                               FALSE,
1130                               G_PARAM_READWRITE));
1131
1132     /**
1133      * GstVaapiSink:rotation:
1134      *
1135      * The VA display rotation mode, expressed as a #GstVaapiRotation.
1136      */
1137     g_object_class_install_property
1138         (object_class,
1139          PROP_ROTATION,
1140          g_param_spec_enum(GST_VAAPI_DISPLAY_PROP_ROTATION,
1141                            "rotation",
1142                            "The display rotation mode",
1143                            GST_VAAPI_TYPE_ROTATION,
1144                            DEFAULT_ROTATION,
1145                            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1146 }
1147
1148 static void
1149 gst_vaapisink_init(GstVaapiSink *sink)
1150 {
1151     sink->caps           = NULL;
1152     sink->display        = NULL;
1153     sink->window         = NULL;
1154     sink->window_width   = 0;
1155     sink->window_height  = 0;
1156     sink->texture        = NULL;
1157     sink->video_buffer   = NULL;
1158     sink->video_width    = 0;
1159     sink->video_height   = 0;
1160     sink->video_par_n    = 1;
1161     sink->video_par_d    = 1;
1162     sink->foreign_window = FALSE;
1163     sink->fullscreen     = FALSE;
1164     sink->synchronous    = FALSE;
1165     sink->display_type   = DEFAULT_DISPLAY_TYPE;
1166     sink->rotation       = DEFAULT_ROTATION;
1167     sink->rotation_req   = DEFAULT_ROTATION;
1168     sink->use_reflection = FALSE;
1169     sink->use_overlay    = FALSE;
1170     sink->use_rotation   = FALSE;
1171 }