plugins: fix display type selection and propagation.
[platform/upstream/gstreamer-vaapi.git] / 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-2012 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 "config.h"
33 #include <gst/gst.h>
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>
40 #if USE_GLX
41 # include <gst/vaapi/gstvaapidisplay_glx.h>
42 # include <gst/vaapi/gstvaapiwindow_glx.h>
43 #endif
44
45 /* Supported interfaces */
46 #include <gst/interfaces/xoverlay.h>
47
48 #include "gstvaapisink.h"
49 #include "gstvaapipluginutil.h"
50
51 #define GST_PLUGIN_NAME "vaapisink"
52 #define GST_PLUGIN_DESC "A VA-API based videosink"
53
54 GST_DEBUG_CATEGORY_STATIC(gst_debug_vaapisink);
55 #define GST_CAT_DEFAULT gst_debug_vaapisink
56
57 /* ElementFactory information */
58 static const GstElementDetails gst_vaapisink_details =
59     GST_ELEMENT_DETAILS(
60         "VA-API sink",
61         "Sink/Video",
62         GST_PLUGIN_DESC,
63         "Gwenole Beauchesne <gwenole.beauchesne@intel.com>");
64
65 /* Default template */
66 static GstStaticPadTemplate gst_vaapisink_sink_factory =
67     GST_STATIC_PAD_TEMPLATE(
68         "sink",
69         GST_PAD_SINK,
70         GST_PAD_ALWAYS,
71         GST_STATIC_CAPS(GST_VAAPI_SURFACE_CAPS));
72
73 static void
74 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface);
75
76 static void
77 gst_vaapisink_video_context_iface_init(GstVideoContextInterface *iface);
78
79 static void
80 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface);
81
82 G_DEFINE_TYPE_WITH_CODE(
83     GstVaapiSink,
84     gst_vaapisink,
85     GST_TYPE_VIDEO_SINK,
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));
92
93 enum {
94     PROP_0,
95
96     PROP_DISPLAY_TYPE,
97     PROP_FULLSCREEN,
98     PROP_SYNCHRONOUS,
99     PROP_USE_REFLECTION
100 };
101
102 #define DEFAULT_DISPLAY_TYPE            GST_VAAPI_DISPLAY_TYPE_ANY
103
104 /* GstImplementsInterface interface */
105
106 static gboolean
107 gst_vaapisink_implements_interface_supported(
108     GstImplementsInterface *iface,
109     GType                   type
110 )
111 {
112     return (type == GST_TYPE_VIDEO_CONTEXT ||
113             type == GST_TYPE_X_OVERLAY);
114 }
115
116 static void
117 gst_vaapisink_implements_iface_init(GstImplementsInterfaceClass *iface)
118 {
119     iface->supported = gst_vaapisink_implements_interface_supported;
120 }
121
122 /* GstVaapiVideoSink interface */
123
124 static void
125 gst_vaapisink_set_video_context(GstVideoContext *context, const gchar *type,
126     const GValue *value)
127 {
128   GstVaapiSink *sink = GST_VAAPISINK (context);
129   gst_vaapi_set_display (type, value, &sink->display);
130 }
131
132 static void
133 gst_vaapisink_video_context_iface_init(GstVideoContextInterface *iface)
134 {
135     iface->set_context = gst_vaapisink_set_video_context;
136 }
137
138 /* GstXOverlay interface */
139
140 static gboolean
141 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id);
142
143 static GstFlowReturn
144 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer);
145
146 static void
147 gst_vaapisink_xoverlay_set_window_handle(GstXOverlay *overlay, guintptr window)
148 {
149     GstVaapiSink * const sink = GST_VAAPISINK(overlay);
150
151     /* Disable GLX rendering when vaapisink is using a foreign X
152        window. It's pretty much useless */
153     if (sink->display_type == GST_VAAPI_DISPLAY_TYPE_GLX)
154         sink->display_type = GST_VAAPI_DISPLAY_TYPE_X11;
155
156     sink->foreign_window = TRUE;
157     gst_vaapisink_ensure_window_xid(sink, window);
158 }
159
160 static void
161 gst_vaapisink_xoverlay_set_render_rectangle(
162     GstXOverlay *overlay,
163     gint         x,
164     gint         y,
165     gint         width,
166     gint         height
167 )
168 {
169     GstVaapiSink * const sink = GST_VAAPISINK(overlay);
170     GstVaapiRectangle * const display_rect = &sink->display_rect;
171
172     display_rect->x      = x;
173     display_rect->y      = y;
174     display_rect->width  = width;
175     display_rect->height = height;
176     
177     GST_DEBUG("render rect (%d,%d):%ux%u",
178               display_rect->x, display_rect->y,
179               display_rect->width, display_rect->height);
180 }
181
182 static void
183 gst_vaapisink_xoverlay_expose(GstXOverlay *overlay)
184 {
185     GstBaseSink * const base_sink = GST_BASE_SINK(overlay);
186     GstBuffer *buffer;
187
188     buffer = gst_base_sink_get_last_buffer(base_sink);
189     if (buffer) {
190         gst_vaapisink_show_frame(base_sink, buffer);
191         gst_buffer_unref(buffer);
192     }
193 }
194
195 static void
196 gst_vaapisink_xoverlay_iface_init(GstXOverlayClass *iface)
197 {
198     iface->set_window_handle    = gst_vaapisink_xoverlay_set_window_handle;
199     iface->set_render_rectangle = gst_vaapisink_xoverlay_set_render_rectangle;
200     iface->expose               = gst_vaapisink_xoverlay_expose;
201 }
202
203 static void
204 gst_vaapisink_destroy(GstVaapiSink *sink)
205 {
206     g_clear_object(&sink->texture);
207     g_clear_object(&sink->display);
208
209     gst_caps_replace(&sink->caps, NULL);
210 }
211
212 /* Checks whether a ConfigureNotify event is in the queue */
213 typedef struct _ConfigureNotifyEventPendingArgs ConfigureNotifyEventPendingArgs;
214 struct _ConfigureNotifyEventPendingArgs {
215     Window      window;
216     guint       width;
217     guint       height;
218     gboolean    match;
219 };
220
221 static Bool
222 configure_notify_event_pending_cb(Display *dpy, XEvent *xev, XPointer arg)
223 {
224     ConfigureNotifyEventPendingArgs * const args =
225         (ConfigureNotifyEventPendingArgs *)arg;
226
227     if (xev->type == ConfigureNotify &&
228         xev->xconfigure.window == args->window &&
229         xev->xconfigure.width  == args->width  &&
230         xev->xconfigure.height == args->height)
231         args->match = TRUE;
232
233     /* XXX: this is a hack to traverse the whole queue because we
234        can't use XPeekIfEvent() since it could block */
235     return False;
236 }
237
238 static gboolean
239 configure_notify_event_pending(
240     GstVaapiSink *sink,
241     Window        window,
242     guint         width,
243     guint         height
244 )
245 {
246     ConfigureNotifyEventPendingArgs args;
247     XEvent xev;
248
249     args.window = window;
250     args.width  = width;
251     args.height = height;
252     args.match  = FALSE;
253
254     /* XXX: don't use XPeekIfEvent() because it might block */
255     XCheckIfEvent(
256         gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
257         &xev,
258         configure_notify_event_pending_cb, (XPointer)&args
259     );
260     return args.match;
261 }
262
263 static const gchar *
264 get_display_type_name(GstVaapiDisplayType display_type)
265 {
266     gpointer const klass = g_type_class_peek(GST_VAAPI_TYPE_DISPLAY_TYPE);
267     GEnumValue * const e = g_enum_get_value(klass, display_type);
268
269     if (e)
270         return e->value_name;
271     return "<unknown-type>";
272 }
273
274 static inline gboolean
275 gst_vaapisink_ensure_display(GstVaapiSink *sink)
276 {
277     GstVaapiDisplayType display_type;
278
279     if (!gst_vaapi_ensure_display(sink, sink->display_type, &sink->display))
280         return FALSE;
281
282     display_type = gst_vaapi_display_get_display_type(sink->display);
283     if (display_type != sink->display_type) {
284         GST_INFO("created %s %p", get_display_type_name(display_type),
285             sink->display);
286         sink->display_type = display_type;
287     }
288     return TRUE;
289 }
290
291 static gboolean
292 gst_vaapisink_ensure_render_rect(GstVaapiSink *sink, guint width, guint height)
293 {
294     GstVaapiRectangle * const display_rect = &sink->display_rect;
295     guint num, den, display_par_n, display_par_d;
296     gboolean success;
297
298     /* Return success if caps are not set yet */
299     if (!sink->caps)
300         return TRUE;
301
302     GST_DEBUG("ensure render rect within %ux%u bounds", width, height);
303
304     gst_vaapi_display_get_pixel_aspect_ratio(
305         sink->display,
306         &display_par_n, &display_par_d
307     );
308     GST_DEBUG("display pixel-aspect-ratio %d/%d",
309               display_par_n, display_par_d);
310
311     success = gst_video_calculate_display_ratio(
312         &num, &den,
313         sink->video_width, sink->video_height,
314         sink->video_par_n, sink->video_par_d,
315         display_par_n, display_par_d
316     );
317     if (!success)
318         return FALSE;
319     GST_DEBUG("video size %dx%d, calculated ratio %d/%d",
320               sink->video_width, sink->video_height, num, den);
321
322     display_rect->width = gst_util_uint64_scale_int(height, num, den);
323     if (display_rect->width <= width) {
324         GST_DEBUG("keeping window height");
325         display_rect->height = height;
326     }
327     else {
328         GST_DEBUG("keeping window width");
329         display_rect->width  = width;
330         display_rect->height =
331             gst_util_uint64_scale_int(width, den, num);
332     }
333     GST_DEBUG("scaling video to %ux%u", display_rect->width, display_rect->height);
334
335     g_assert(display_rect->width  <= width);
336     g_assert(display_rect->height <= height);
337
338     display_rect->x = (width  - display_rect->width)  / 2;
339     display_rect->y = (height - display_rect->height) / 2;
340
341     GST_DEBUG("render rect (%d,%d):%ux%u",
342               display_rect->x, display_rect->y,
343               display_rect->width, display_rect->height);
344     return TRUE;
345 }
346
347 static inline gboolean
348 gst_vaapisink_ensure_window(GstVaapiSink *sink, guint width, guint height)
349 {
350     GstVaapiDisplay * const display = sink->display;
351
352     if (!sink->window) {
353         switch (sink->display_type) {
354 #if USE_GLX
355         case GST_VAAPI_DISPLAY_TYPE_GLX:
356             sink->window = gst_vaapi_window_glx_new(display, width, height);
357             break;
358 #endif
359         case GST_VAAPI_DISPLAY_TYPE_X11:
360             sink->window = gst_vaapi_window_x11_new(display, width, height);
361             break;
362         default:
363             GST_ERROR("unsupported display type %d", sink->display_type);
364             return FALSE;
365         }
366         if (sink->window)
367             gst_x_overlay_got_window_handle(
368                 GST_X_OVERLAY(sink),
369                 gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window))
370             );
371     }
372     return sink->window != NULL;
373 }
374
375 static gboolean
376 gst_vaapisink_ensure_window_xid(GstVaapiSink *sink, guintptr window_id)
377 {
378     Window rootwin;
379     unsigned int width, height, border_width, depth;
380     int x, y;
381     XID xid = window_id;
382
383     if (!gst_vaapisink_ensure_display(sink))
384         return FALSE;
385
386     gst_vaapi_display_lock(sink->display);
387     XGetGeometry(
388         gst_vaapi_display_x11_get_display(GST_VAAPI_DISPLAY_X11(sink->display)),
389         xid,
390         &rootwin,
391         &x, &y, &width, &height, &border_width, &depth
392     );
393     gst_vaapi_display_unlock(sink->display);
394
395     if ((width != sink->window_width || height != sink->window_height) &&
396         !configure_notify_event_pending(sink, xid, width, height)) {
397         if (!gst_vaapisink_ensure_render_rect(sink, width, height))
398             return FALSE;
399         sink->window_width  = width;
400         sink->window_height = height;
401     }
402
403     if (sink->window &&
404         gst_vaapi_window_x11_get_xid(GST_VAAPI_WINDOW_X11(sink->window)) == xid)
405         return TRUE;
406
407     g_clear_object(&sink->window);
408
409     switch (sink->display_type) {
410 #if USE_GLX
411     case GST_VAAPI_DISPLAY_TYPE_GLX:
412         sink->window = gst_vaapi_window_glx_new_with_xid(sink->display, xid);
413         break;
414 #endif
415     case GST_VAAPI_DISPLAY_TYPE_X11:
416         sink->window = gst_vaapi_window_x11_new_with_xid(sink->display, xid);
417         break;
418     default:
419         GST_ERROR("unsupported display type %d", sink->display_type);
420         return FALSE;
421     }
422     return sink->window != NULL;
423 }
424
425 static gboolean
426 gst_vaapisink_start(GstBaseSink *base_sink)
427 {
428     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
429
430     return gst_vaapisink_ensure_display(sink);
431 }
432
433 static gboolean
434 gst_vaapisink_stop(GstBaseSink *base_sink)
435 {
436     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
437
438     g_clear_object(&sink->window);
439     g_clear_object(&sink->display);
440
441     return TRUE;
442 }
443
444 static gboolean
445 gst_vaapisink_set_caps(GstBaseSink *base_sink, GstCaps *caps)
446 {
447     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
448     GstStructure * const structure = gst_caps_get_structure(caps, 0);
449     guint win_width, win_height, display_width, display_height;
450     gint video_width, video_height, video_par_n = 1, video_par_d = 1;
451
452     if (!structure)
453         return FALSE;
454     if (!gst_structure_get_int(structure, "width",  &video_width))
455         return FALSE;
456     if (!gst_structure_get_int(structure, "height", &video_height))
457         return FALSE;
458     sink->video_width  = video_width;
459     sink->video_height = video_height;
460
461     gst_video_parse_caps_pixel_aspect_ratio(caps, &video_par_n, &video_par_d);
462     sink->video_par_n  = video_par_n;
463     sink->video_par_d  = video_par_d;
464     GST_DEBUG("video pixel-aspect-ratio %d/%d", video_par_n, video_par_d);
465
466     gst_caps_replace(&sink->caps, caps);
467
468     if (!gst_vaapisink_ensure_display(sink))
469         return FALSE;
470
471     gst_vaapi_display_get_size(sink->display, &display_width, &display_height);
472     if (sink->foreign_window) {
473         win_width  = sink->window_width;
474         win_height = sink->window_height;
475     }
476     else if (sink->fullscreen ||
477              video_width > display_width || video_height > display_height) {
478         win_width  = display_width;
479         win_height = display_height;
480     }
481     else {
482         win_width  = video_width;
483         win_height = video_height;
484     }
485
486     if (sink->window) {
487         if (!sink->foreign_window || sink->fullscreen)
488             gst_vaapi_window_set_size(sink->window, win_width, win_height);
489     }
490     else {
491         gst_vaapi_display_lock(sink->display);
492         gst_x_overlay_prepare_xwindow_id(GST_X_OVERLAY(sink));
493         gst_vaapi_display_unlock(sink->display);
494         if (sink->window)
495             return TRUE;
496         if (!gst_vaapisink_ensure_window(sink, win_width, win_height))
497             return FALSE;
498         gst_vaapi_window_set_fullscreen(sink->window, sink->fullscreen);
499         gst_vaapi_window_show(sink->window);
500         gst_vaapi_window_get_size(sink->window, &win_width, &win_height);
501     }
502     sink->window_width  = win_width;
503     sink->window_height = win_height;
504     GST_DEBUG("window size %ux%u", win_width, win_height);
505
506     return gst_vaapisink_ensure_render_rect(sink, win_width, win_height);
507 }
508
509 #if USE_GLX
510 static void
511 render_background(GstVaapiSink *sink)
512 {
513     /* Original code from Mirco Muller (MacSlow):
514        <http://cgit.freedesktop.org/~macslow/gl-gst-player/> */
515     GLfloat fStartX = 0.0f;
516     GLfloat fStartY = 0.0f;
517     GLfloat fWidth  = (GLfloat)sink->window_width;
518     GLfloat fHeight = (GLfloat)sink->window_height;
519
520     glClear(GL_COLOR_BUFFER_BIT);
521     glBegin(GL_QUADS);
522     {
523         /* top third, darker grey to white */
524         glColor3f(0.85f, 0.85f, 0.85f);
525         glVertex3f(fStartX, fStartY, 0.0f);
526         glColor3f(0.85f, 0.85f, 0.85f);
527         glVertex3f(fStartX + fWidth, fStartY, 0.0f);
528         glColor3f(1.0f, 1.0f, 1.0f);
529         glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
530         glColor3f(1.0f, 1.0f, 1.0f);
531         glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
532
533         /* middle third, just plain white */
534         glColor3f(1.0f, 1.0f, 1.0f);
535         glVertex3f(fStartX, fStartY + fHeight / 3.0f, 0.0f);
536         glVertex3f(fStartX + fWidth, fStartY + fHeight / 3.0f, 0.0f);
537         glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
538         glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
539
540         /* bottom third, white to lighter grey */
541         glColor3f(1.0f, 1.0f, 1.0f);
542         glVertex3f(fStartX, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
543         glColor3f(1.0f, 1.0f, 1.0f);
544         glVertex3f(fStartX + fWidth, fStartY + 2.0f * fHeight / 3.0f, 0.0f);
545         glColor3f(0.62f, 0.66f, 0.69f);
546         glVertex3f(fStartX + fWidth, fStartY + fHeight, 0.0f);
547         glColor3f(0.62f, 0.66f, 0.69f);
548         glVertex3f(fStartX, fStartY + fHeight, 0.0f);
549     }
550     glEnd();
551 }
552
553 static void
554 render_frame(GstVaapiSink *sink)
555 {
556     const guint x1 = sink->display_rect.x;
557     const guint x2 = sink->display_rect.x + sink->display_rect.width;
558     const guint y1 = sink->display_rect.y;
559     const guint y2 = sink->display_rect.y + sink->display_rect.height;
560
561     glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
562     glBegin(GL_QUADS);
563     {
564         glTexCoord2f(0.0f, 0.0f); glVertex2i(x1, y1);
565         glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y2);
566         glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y2);
567         glTexCoord2f(1.0f, 0.0f); glVertex2i(x2, y1);
568     }
569     glEnd();
570 }
571
572 static void
573 render_reflection(GstVaapiSink *sink)
574 {
575     const guint x1 = sink->display_rect.x;
576     const guint x2 = sink->display_rect.x + sink->display_rect.width;
577     const guint y1 = sink->display_rect.y;
578     const guint rh = sink->display_rect.height / 5;
579     GLfloat     ry = 1.0f - (GLfloat)rh / (GLfloat)sink->display_rect.height;
580
581     glBegin(GL_QUADS);
582     {
583         glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
584         glTexCoord2f(0.0f, 1.0f); glVertex2i(x1, y1);
585         glTexCoord2f(1.0f, 1.0f); glVertex2i(x2, y1);
586
587         glColor4f(1.0f, 1.0f, 1.0f, 0.0f);
588         glTexCoord2f(1.0f, ry); glVertex2i(x2, y1 + rh);
589         glTexCoord2f(0.0f, ry); glVertex2i(x1, y1 + rh);
590     }
591     glEnd();
592 }
593
594 static gboolean
595 gst_vaapisink_show_frame_glx(
596     GstVaapiSink    *sink,
597     GstVaapiSurface *surface,
598     guint            flags
599 )
600 {
601     GstVaapiWindowGLX * const window = GST_VAAPI_WINDOW_GLX(sink->window);
602     GLenum target;
603     GLuint texture;
604
605     gst_vaapi_window_glx_make_current(window);
606     if (!sink->texture) {
607         sink->texture = gst_vaapi_texture_new(
608             sink->display,
609             GL_TEXTURE_2D,
610             GL_BGRA,
611             sink->video_width,
612             sink->video_height
613         );
614         if (!sink->texture)
615             goto error_create_texture;
616     }
617     if (!gst_vaapi_texture_put_surface(sink->texture, surface, flags))
618         goto error_transfer_surface;
619
620     target  = gst_vaapi_texture_get_target(sink->texture);
621     texture = gst_vaapi_texture_get_id(sink->texture);
622     if (target != GL_TEXTURE_2D || !texture)
623         return FALSE;
624
625     if (sink->use_reflection)
626         render_background(sink);
627
628     glEnable(target);
629     glBindTexture(target, texture);
630     {
631         if (sink->use_reflection) {
632             glPushMatrix();
633             glRotatef(20.0f, 0.0f, 1.0f, 0.0f);
634             glTranslatef(50.0f, 0.0f, 0.0f);
635         }
636         render_frame(sink);
637         if (sink->use_reflection) {
638             glPushMatrix();
639             glTranslatef(0.0, (GLfloat)sink->display_rect.height + 5.0f, 0.0f);
640             render_reflection(sink);
641             glPopMatrix();
642             glPopMatrix();
643         }
644     }
645     glBindTexture(target, 0);
646     glDisable(target);
647     gst_vaapi_window_glx_swap_buffers(window);
648     return TRUE;
649
650     /* ERRORS */
651 error_create_texture:
652     {
653         GST_DEBUG("could not create VA/GLX texture");
654         return FALSE;
655     }
656 error_transfer_surface:
657     {
658         GST_DEBUG("could not transfer VA surface to texture");
659         return FALSE;
660     }
661 }
662 #endif
663
664 static inline gboolean
665 gst_vaapisink_show_frame_x11(
666     GstVaapiSink    *sink,
667     GstVaapiSurface *surface,
668     guint            flags
669 )
670 {
671     if (!gst_vaapi_window_put_surface(sink->window, surface,
672                 NULL, &sink->display_rect, flags)) {
673         GST_DEBUG("could not render VA surface");
674         return FALSE;
675     }
676     return TRUE;
677 }
678
679 static GstFlowReturn
680 gst_vaapisink_show_frame(GstBaseSink *base_sink, GstBuffer *buffer)
681 {
682     GstVaapiSink * const sink = GST_VAAPISINK(base_sink);
683     GstVaapiVideoBuffer * const vbuffer = GST_VAAPI_VIDEO_BUFFER(buffer);
684     GstVaapiSurface *surface;
685     guint flags;
686     gboolean success;
687     GstVideoOverlayComposition * const composition =
688         gst_video_buffer_get_overlay_composition(buffer);
689
690     if (sink->display != gst_vaapi_video_buffer_get_display (vbuffer)) {
691       g_clear_object(&sink->display);
692       sink->display = g_object_ref (gst_vaapi_video_buffer_get_display (vbuffer));
693     }
694
695     if (!sink->window)
696         return GST_FLOW_UNEXPECTED;
697
698     surface = gst_vaapi_video_buffer_get_surface(vbuffer);
699     if (!surface)
700         return GST_FLOW_UNEXPECTED;
701
702     GST_DEBUG("render surface %" GST_VAAPI_ID_FORMAT,
703               GST_VAAPI_ID_ARGS(gst_vaapi_surface_get_id(surface)));
704
705     flags = gst_vaapi_video_buffer_get_render_flags(vbuffer);
706
707     if (!gst_vaapi_surface_set_subpictures_from_composition(surface,
708              composition, TRUE))
709         GST_WARNING("could not update subtitles");
710
711     switch (sink->display_type) {
712 #if USE_GLX
713     case GST_VAAPI_DISPLAY_TYPE_GLX:
714         success = gst_vaapisink_show_frame_glx(sink, surface, flags);
715         break;
716 #endif
717     case GST_VAAPI_DISPLAY_TYPE_X11:
718         success = gst_vaapisink_show_frame_x11(sink, surface, flags);
719         break;
720     default:
721         GST_ERROR("unsupported display type %d", sink->display_type);
722         success = FALSE;
723         break;
724     }
725     return success ? GST_FLOW_OK : GST_FLOW_UNEXPECTED;
726 }
727
728 static gboolean
729 gst_vaapisink_query(GstBaseSink *base_sink, GstQuery *query)
730 {
731     GstVaapiSink *sink = GST_VAAPISINK(base_sink);
732     GST_DEBUG ("sharing display %p", sink->display);
733     return gst_vaapi_reply_to_query (query, sink->display);
734 }
735
736 static void
737 gst_vaapisink_finalize(GObject *object)
738 {
739     gst_vaapisink_destroy(GST_VAAPISINK(object));
740
741     G_OBJECT_CLASS(gst_vaapisink_parent_class)->finalize(object);
742 }
743
744 static void
745 gst_vaapisink_set_property(
746     GObject      *object,
747     guint         prop_id,
748     const GValue *value,
749     GParamSpec   *pspec
750 )
751 {
752     GstVaapiSink * const sink = GST_VAAPISINK(object);
753
754     switch (prop_id) {
755     case PROP_DISPLAY_TYPE:
756         sink->display_type = g_value_get_enum(value);
757         break;
758     case PROP_FULLSCREEN:
759         sink->fullscreen = g_value_get_boolean(value);
760         break;
761     case PROP_SYNCHRONOUS:
762         sink->synchronous = g_value_get_boolean(value);
763         break;
764     case PROP_USE_REFLECTION:
765         sink->use_reflection = g_value_get_boolean(value);
766         break;
767     default:
768         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
769         break;
770     }
771 }
772
773 static void
774 gst_vaapisink_get_property(
775     GObject    *object,
776     guint       prop_id,
777     GValue     *value,
778     GParamSpec *pspec
779 )
780 {
781     GstVaapiSink * const sink = GST_VAAPISINK(object);
782
783     switch (prop_id) {
784     case PROP_DISPLAY_TYPE:
785         g_value_set_enum(value, sink->display_type);
786         break;
787     case PROP_FULLSCREEN:
788         g_value_set_boolean(value, sink->fullscreen);
789         break;
790     case PROP_SYNCHRONOUS:
791         g_value_set_boolean(value, sink->synchronous);
792         break;
793     case PROP_USE_REFLECTION:
794         g_value_set_boolean(value, sink->use_reflection);
795         break;
796     default:
797         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
798         break;
799     }
800 }
801
802 static void
803 gst_vaapisink_class_init(GstVaapiSinkClass *klass)
804 {
805     GObjectClass * const     object_class   = G_OBJECT_CLASS(klass);
806     GstElementClass * const  element_class  = GST_ELEMENT_CLASS(klass);
807     GstBaseSinkClass * const basesink_class = GST_BASE_SINK_CLASS(klass);
808     GstPadTemplate *pad_template;
809
810     GST_DEBUG_CATEGORY_INIT(gst_debug_vaapisink,
811                             GST_PLUGIN_NAME, 0, GST_PLUGIN_DESC);
812
813     object_class->finalize       = gst_vaapisink_finalize;
814     object_class->set_property   = gst_vaapisink_set_property;
815     object_class->get_property   = gst_vaapisink_get_property;
816
817     basesink_class->start        = gst_vaapisink_start;
818     basesink_class->stop         = gst_vaapisink_stop;
819     basesink_class->set_caps     = gst_vaapisink_set_caps;
820     basesink_class->preroll      = gst_vaapisink_show_frame;
821     basesink_class->render       = gst_vaapisink_show_frame;
822     basesink_class->query        = gst_vaapisink_query;
823
824     gst_element_class_set_details_simple(
825         element_class,
826         gst_vaapisink_details.longname,
827         gst_vaapisink_details.klass,
828         gst_vaapisink_details.description,
829         gst_vaapisink_details.author
830     );
831
832     pad_template = gst_static_pad_template_get(&gst_vaapisink_sink_factory);
833     gst_element_class_add_pad_template(element_class, pad_template);
834     gst_object_unref(pad_template);
835
836     g_object_class_install_property
837         (object_class,
838          PROP_DISPLAY_TYPE,
839          g_param_spec_enum("display",
840                            "display type",
841                            "display type to use",
842                            GST_VAAPI_TYPE_DISPLAY_TYPE,
843                            GST_VAAPI_DISPLAY_TYPE_ANY,
844                            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
845
846 #if USE_GLX
847     g_object_class_install_property
848         (object_class,
849          PROP_USE_REFLECTION,
850          g_param_spec_boolean("use-reflection",
851                               "Reflection effect",
852                               "Enables OpenGL reflection effect",
853                               FALSE,
854                               G_PARAM_READWRITE));
855 #endif
856
857     g_object_class_install_property
858         (object_class,
859          PROP_FULLSCREEN,
860          g_param_spec_boolean("fullscreen",
861                               "Fullscreen",
862                               "Requests window in fullscreen state",
863                               FALSE,
864                               G_PARAM_READWRITE));
865
866     /**
867      * GstVaapiSink:synchronous:
868      *
869      * When enabled, runs the X display in synchronous mode. Note that
870      * this is used only for debugging.
871      */
872     g_object_class_install_property
873         (object_class,
874          PROP_SYNCHRONOUS,
875          g_param_spec_boolean("synchronous",
876                               "Synchronous mode",
877                               "Toggles X display synchronous mode",
878                               FALSE,
879                               G_PARAM_READWRITE));
880 }
881
882 static void
883 gst_vaapisink_init(GstVaapiSink *sink)
884 {
885     sink->caps           = NULL;
886     sink->display        = NULL;
887     sink->window         = NULL;
888     sink->window_width   = 0;
889     sink->window_height  = 0;
890     sink->texture        = NULL;
891     sink->video_width    = 0;
892     sink->video_height   = 0;
893     sink->video_par_n    = 1;
894     sink->video_par_d    = 1;
895     sink->foreign_window = FALSE;
896     sink->fullscreen     = FALSE;
897     sink->synchronous    = FALSE;
898     sink->display_type   = DEFAULT_DISPLAY_TYPE;
899     sink->use_reflection = FALSE;
900 }