2 * Copyright (C) <2005> Julien Moutte <julien@moutte.net>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
21 * SECTION:element-ximagesink
23 * XImageSink renders video frames to a drawable (XWindow) on a local or remote
24 * display. This element can receive a Window ID from the application through
25 * the #GstVideoOverlay interface and will then render video frames in this
26 * drawable. If no Window ID was provided by the application, the element will
27 * create its own internal window and render into it.
30 * <title>Scaling</title>
32 * As standard XImage rendering to a drawable is not scaled, XImageSink will use
33 * reverse caps negotiation to try to get scaled video frames for the drawable.
34 * This is accomplished by asking the peer pad if it accepts some different caps
35 * which in most cases implies that there is a scaling element in the pipeline,
36 * or that an element generating the video frames can generate them with a
37 * different geometry. This mechanism is handled during buffer allocations, for
38 * each allocation request the video sink will check the drawable geometry, look
39 * at the #GstXImageSink:force-aspect-ratio property, calculate the geometry of
40 * desired video frames and then check that the peer pad accept those new caps.
41 * If it does it will then allocate a buffer in video memory with this new
42 * geometry and return it with the new caps.
46 * <title>Events</title>
48 * XImageSink creates a thread to handle events coming from the drawable. There
49 * are several kind of events that can be grouped in 2 big categories: input
50 * events and window state related events. Input events will be translated to
51 * navigation events and pushed upstream for other elements to react on them.
52 * This includes events such as pointer moves, key press/release, clicks etc...
53 * Other events are used to handle the drawable appearance even when the data
54 * is not flowing (GST_STATE_PAUSED). That means that even when the element is
55 * paused, it will receive expose events from the drawable and draw the latest
56 * frame with correct borders/aspect-ratio.
60 * <title>Pixel aspect ratio</title>
62 * When changing state to GST_STATE_READY, XImageSink will open a connection to
63 * the display specified in the #GstXImageSink:display property or the default
64 * display if nothing specified. Once this connection is open it will inspect
65 * the display configuration including the physical display geometry and
66 * then calculate the pixel aspect ratio. When caps negotiation will occur, the
67 * video sink will set the calculated pixel aspect ratio on the caps to make
68 * sure that incoming video frames will have the correct pixel aspect ratio for
69 * this display. Sometimes the calculated pixel aspect ratio can be wrong, it is
70 * then possible to enforce a specific pixel aspect ratio using the
71 * #GstXImageSink:pixel-aspect-ratio property.
75 * <title>Examples</title>
77 * gst-launch -v videotestsrc ! queue ! ximagesink
78 * ]| A pipeline to test reverse negotiation. When the test video signal appears
79 * you can resize the window and see that scaled buffers of the desired size are
80 * going to arrive with a short delay. This illustrates how buffers of desired
81 * size are allocated along the way. If you take away the queue, scaling will
82 * happen almost immediately.
84 * gst-launch -v videotestsrc ! navigationtest ! videoconvert ! ximagesink
85 * ]| A pipeline to test navigation events.
86 * While moving the mouse pointer over the test signal you will see a black box
87 * following the mouse pointer. If you press the mouse button somewhere on the
88 * video and release it somewhere else a green box will appear where you pressed
89 * the button and a red one where you released it. (The navigationtest element
90 * is part of gst-plugins-good.)
92 * gst-launch -v videotestsrc ! video/x-raw, pixel-aspect-ratio=(fraction)4/3 ! videoscale ! ximagesink
93 * ]| This is faking a 4/3 pixel aspect ratio caps on video frames produced by
94 * videotestsrc, in most cases the pixel aspect ratio of the display will be
95 * 1/1. This means that videoscale will have to do the scaling to convert
96 * incoming frames to a size that will match the display pixel aspect ratio
97 * (from 320x240 to 320x180 in this case). Note that you might have to escape
98 * some characters for your shell like '\(fraction\)'.
107 #include <gst/video/navigation.h>
108 #include <gst/video/videooverlay.h>
110 #include <gst/video/gstvideometa.h>
113 #include "ximagesink.h"
115 /* Debugging category */
116 #include <gst/gstinfo.h>
118 /* for XkbKeycodeToKeysym */
119 #include <X11/XKBlib.h>
121 GST_DEBUG_CATEGORY_EXTERN (gst_debug_ximagesink);
122 GST_DEBUG_CATEGORY_EXTERN (GST_CAT_PERFORMANCE);
123 #define GST_CAT_DEFAULT gst_debug_ximagesink
128 unsigned long functions;
129 unsigned long decorations;
131 unsigned long status;
133 MotifWmHints, MwmHints;
135 #define MWM_HINTS_DECORATIONS (1L << 1)
137 static void gst_ximagesink_reset (GstXImageSink * ximagesink);
138 static void gst_ximagesink_xwindow_update_geometry (GstXImageSink * ximagesink);
139 static void gst_ximagesink_expose (GstVideoOverlay * overlay);
141 static GstStaticPadTemplate gst_ximagesink_sink_template_factory =
142 GST_STATIC_PAD_TEMPLATE ("sink",
145 GST_STATIC_CAPS ("video/x-raw, "
146 "framerate = (fraction) [ 0, MAX ], "
147 "width = (int) [ 1, MAX ], " "height = (int) [ 1, MAX ]")
155 PROP_PIXEL_ASPECT_RATIO,
156 PROP_FORCE_ASPECT_RATIO,
163 /* ============================================================= */
167 /* ============================================================= */
169 /* =========================================== */
171 /* Object typing & Creation */
173 /* =========================================== */
174 static void gst_ximagesink_navigation_init (GstNavigationInterface * iface);
175 static void gst_ximagesink_video_overlay_init (GstVideoOverlayInterface *
177 #define gst_ximagesink_parent_class parent_class
178 G_DEFINE_TYPE_WITH_CODE (GstXImageSink, gst_ximagesink, GST_TYPE_VIDEO_SINK,
179 G_IMPLEMENT_INTERFACE (GST_TYPE_NAVIGATION, gst_ximagesink_navigation_init);
180 G_IMPLEMENT_INTERFACE (GST_TYPE_VIDEO_OVERLAY,
181 gst_ximagesink_video_overlay_init));
183 /* ============================================================= */
185 /* Private Methods */
187 /* ============================================================= */
191 /* We are called with the x_lock taken */
193 gst_ximagesink_xwindow_draw_borders (GstXImageSink * ximagesink,
194 GstXWindow * xwindow, GstVideoRectangle rect)
196 g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
197 g_return_if_fail (xwindow != NULL);
199 XSetForeground (ximagesink->xcontext->disp, xwindow->gc,
200 ximagesink->xcontext->black);
204 XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
205 0, 0, rect.x, xwindow->height);
209 if ((rect.x + rect.w) < xwindow->width) {
210 XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
211 rect.x + rect.w, 0, xwindow->width, xwindow->height);
216 XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
217 0, 0, xwindow->width, rect.y);
221 if ((rect.y + rect.h) < xwindow->height) {
222 XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
223 0, rect.y + rect.h, xwindow->width, xwindow->height);
227 /* This function puts a GstXImageBuffer on a GstXImageSink's window */
229 gst_ximagesink_ximage_put (GstXImageSink * ximagesink, GstBuffer * ximage)
231 GstXImageMemory *mem;
232 GstVideoCropMeta *crop;
233 GstVideoRectangle src, dst, result;
234 gboolean draw_border = FALSE;
236 /* We take the flow_lock. If expose is in there we don't want to run
237 concurrently from the data flow thread */
238 g_mutex_lock (&ximagesink->flow_lock);
240 if (G_UNLIKELY (ximagesink->xwindow == NULL)) {
241 g_mutex_unlock (&ximagesink->flow_lock);
245 /* Draw borders when displaying the first frame. After this
246 draw borders only on expose event or caps change (ximagesink->draw_border = TRUE). */
247 if (!ximagesink->cur_image || ximagesink->draw_border) {
251 /* Store a reference to the last image we put, lose the previous one */
252 if (ximage && ximagesink->cur_image != ximage) {
253 if (ximagesink->cur_image) {
254 GST_LOG_OBJECT (ximagesink, "unreffing %p", ximagesink->cur_image);
255 gst_buffer_unref (ximagesink->cur_image);
257 GST_LOG_OBJECT (ximagesink, "reffing %p as our current image", ximage);
258 ximagesink->cur_image = gst_buffer_ref (ximage);
261 /* Expose sends a NULL image, we take the latest frame */
264 if (ximagesink->cur_image) {
265 ximage = ximagesink->cur_image;
267 g_mutex_unlock (&ximagesink->flow_lock);
272 mem = (GstXImageMemory *) gst_buffer_peek_memory (ximage, 0);
273 crop = gst_buffer_get_video_crop_meta (ximage);
276 src.x = crop->x + mem->x;
277 src.y = crop->y + mem->y;
279 src.h = crop->height;
280 GST_LOG_OBJECT (ximagesink,
281 "crop %dx%d-%dx%d", crop->x, crop->y, crop->width, crop->height);
288 dst.w = ximagesink->xwindow->width;
289 dst.h = ximagesink->xwindow->height;
291 gst_video_sink_center_rect (src, dst, &result, FALSE);
293 g_mutex_lock (&ximagesink->x_lock);
296 gst_ximagesink_xwindow_draw_borders (ximagesink, ximagesink->xwindow,
298 ximagesink->draw_border = FALSE;
301 if (ximagesink->xcontext->use_xshm) {
302 GST_LOG_OBJECT (ximagesink,
303 "XShmPutImage on %p, src: %d, %d - dest: %d, %d, dim: %dx%d, win %dx%d",
304 ximage, 0, 0, result.x, result.y, result.w, result.h,
305 ximagesink->xwindow->width, ximagesink->xwindow->height);
306 XShmPutImage (ximagesink->xcontext->disp, ximagesink->xwindow->win,
307 ximagesink->xwindow->gc, mem->ximage, src.x, src.y, result.x, result.y,
308 result.w, result.h, FALSE);
310 #endif /* HAVE_XSHM */
312 GST_LOG_OBJECT (ximagesink,
313 "XPutImage on %p, src: %d, %d - dest: %d, %d, dim: %dx%d, win %dx%d",
314 ximage, 0, 0, result.x, result.y, result.w, result.h,
315 ximagesink->xwindow->width, ximagesink->xwindow->height);
316 XPutImage (ximagesink->xcontext->disp, ximagesink->xwindow->win,
317 ximagesink->xwindow->gc, mem->ximage, src.x, src.y, result.x, result.y,
321 XSync (ximagesink->xcontext->disp, FALSE);
323 g_mutex_unlock (&ximagesink->x_lock);
325 g_mutex_unlock (&ximagesink->flow_lock);
331 gst_ximagesink_xwindow_decorate (GstXImageSink * ximagesink,
334 Atom hints_atom = None;
337 g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), FALSE);
338 g_return_val_if_fail (window != NULL, FALSE);
340 g_mutex_lock (&ximagesink->x_lock);
342 hints_atom = XInternAtom (ximagesink->xcontext->disp, "_MOTIF_WM_HINTS",
344 if (hints_atom == None) {
345 g_mutex_unlock (&ximagesink->x_lock);
349 hints = g_malloc0 (sizeof (MotifWmHints));
351 hints->flags |= MWM_HINTS_DECORATIONS;
352 hints->decorations = 1 << 0;
354 XChangeProperty (ximagesink->xcontext->disp, window->win,
355 hints_atom, hints_atom, 32, PropModeReplace,
356 (guchar *) hints, sizeof (MotifWmHints) / sizeof (long));
358 XSync (ximagesink->xcontext->disp, FALSE);
360 g_mutex_unlock (&ximagesink->x_lock);
368 gst_ximagesink_xwindow_set_title (GstXImageSink * ximagesink,
369 GstXWindow * xwindow, const gchar * media_title)
372 g_free (ximagesink->media_title);
373 ximagesink->media_title = g_strdup (media_title);
376 /* we have a window */
377 if (xwindow->internal) {
378 XTextProperty xproperty;
379 const gchar *app_name;
380 const gchar *title = NULL;
381 gchar *title_mem = NULL;
383 /* set application name as a title */
384 app_name = g_get_application_name ();
386 if (app_name && ximagesink->media_title) {
387 title = title_mem = g_strconcat (ximagesink->media_title, " : ",
389 } else if (app_name) {
391 } else if (ximagesink->media_title) {
392 title = ximagesink->media_title;
396 if ((XStringListToTextProperty (((char **) &title), 1,
398 XSetWMName (ximagesink->xcontext->disp, xwindow->win, &xproperty);
399 XFree (xproperty.value);
408 /* This function handles a GstXWindow creation */
410 gst_ximagesink_xwindow_new (GstXImageSink * ximagesink, gint width, gint height)
412 GstXWindow *xwindow = NULL;
415 g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), NULL);
417 xwindow = g_new0 (GstXWindow, 1);
419 xwindow->width = width;
420 xwindow->height = height;
421 xwindow->internal = TRUE;
423 g_mutex_lock (&ximagesink->x_lock);
425 xwindow->win = XCreateSimpleWindow (ximagesink->xcontext->disp,
426 ximagesink->xcontext->root,
427 0, 0, width, height, 0, 0, ximagesink->xcontext->black);
429 /* We have to do that to prevent X from redrawing the background on
430 ConfigureNotify. This takes away flickering of video when resizing. */
431 XSetWindowBackgroundPixmap (ximagesink->xcontext->disp, xwindow->win, None);
433 /* set application name as a title */
434 gst_ximagesink_xwindow_set_title (ximagesink, xwindow, NULL);
436 if (ximagesink->handle_events) {
439 XSelectInput (ximagesink->xcontext->disp, xwindow->win, ExposureMask |
440 StructureNotifyMask | PointerMotionMask | KeyPressMask |
441 KeyReleaseMask | ButtonPressMask | ButtonReleaseMask);
443 /* Tell the window manager we'd like delete client messages instead of
445 wm_delete = XInternAtom (ximagesink->xcontext->disp,
446 "WM_DELETE_WINDOW", False);
447 (void) XSetWMProtocols (ximagesink->xcontext->disp, xwindow->win,
451 xwindow->gc = XCreateGC (ximagesink->xcontext->disp, xwindow->win,
454 XMapRaised (ximagesink->xcontext->disp, xwindow->win);
456 XSync (ximagesink->xcontext->disp, FALSE);
458 g_mutex_unlock (&ximagesink->x_lock);
460 gst_ximagesink_xwindow_decorate (ximagesink, xwindow);
462 gst_video_overlay_got_window_handle (GST_VIDEO_OVERLAY (ximagesink),
468 /* This function destroys a GstXWindow */
470 gst_ximagesink_xwindow_destroy (GstXImageSink * ximagesink,
471 GstXWindow * xwindow)
473 g_return_if_fail (xwindow != NULL);
474 g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
476 g_mutex_lock (&ximagesink->x_lock);
478 /* If we did not create that window we just free the GC and let it live */
479 if (xwindow->internal)
480 XDestroyWindow (ximagesink->xcontext->disp, xwindow->win);
482 XSelectInput (ximagesink->xcontext->disp, xwindow->win, 0);
484 XFreeGC (ximagesink->xcontext->disp, xwindow->gc);
486 XSync (ximagesink->xcontext->disp, FALSE);
488 g_mutex_unlock (&ximagesink->x_lock);
494 gst_ximagesink_xwindow_update_geometry (GstXImageSink * ximagesink)
496 XWindowAttributes attr;
497 gboolean reconfigure;
499 g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
501 /* Update the window geometry */
502 g_mutex_lock (&ximagesink->x_lock);
503 if (G_UNLIKELY (ximagesink->xwindow == NULL)) {
504 g_mutex_unlock (&ximagesink->x_lock);
508 XGetWindowAttributes (ximagesink->xcontext->disp,
509 ximagesink->xwindow->win, &attr);
511 /* Check if we would suggest a different width/height now */
512 reconfigure = (ximagesink->xwindow->width != attr.width)
513 || (ximagesink->xwindow->height != attr.height);
514 ximagesink->xwindow->width = attr.width;
515 ximagesink->xwindow->height = attr.height;
517 g_mutex_unlock (&ximagesink->x_lock);
520 gst_pad_push_event (GST_BASE_SINK (ximagesink)->sinkpad,
521 gst_event_new_reconfigure ());
525 gst_ximagesink_xwindow_clear (GstXImageSink * ximagesink, GstXWindow * xwindow)
527 g_return_if_fail (xwindow != NULL);
528 g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
530 g_mutex_lock (&ximagesink->x_lock);
532 XSetForeground (ximagesink->xcontext->disp, xwindow->gc,
533 ximagesink->xcontext->black);
535 XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
536 0, 0, xwindow->width, xwindow->height);
538 XSync (ximagesink->xcontext->disp, FALSE);
540 g_mutex_unlock (&ximagesink->x_lock);
543 /* This function handles XEvents that might be in the queue. It generates
544 GstEvent that will be sent upstream in the pipeline to handle interactivity
547 gst_ximagesink_handle_xevents (GstXImageSink * ximagesink)
550 guint pointer_x = 0, pointer_y = 0;
551 gboolean pointer_moved = FALSE;
552 gboolean exposed = FALSE, configured = FALSE;
554 g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
556 /* Then we get all pointer motion events, only the last position is
558 g_mutex_lock (&ximagesink->flow_lock);
559 g_mutex_lock (&ximagesink->x_lock);
560 while (XCheckWindowEvent (ximagesink->xcontext->disp,
561 ximagesink->xwindow->win, PointerMotionMask, &e)) {
562 g_mutex_unlock (&ximagesink->x_lock);
563 g_mutex_unlock (&ximagesink->flow_lock);
567 pointer_x = e.xmotion.x;
568 pointer_y = e.xmotion.y;
569 pointer_moved = TRUE;
574 g_mutex_lock (&ximagesink->flow_lock);
575 g_mutex_lock (&ximagesink->x_lock);
579 g_mutex_unlock (&ximagesink->x_lock);
580 g_mutex_unlock (&ximagesink->flow_lock);
582 GST_DEBUG ("ximagesink pointer moved over window at %d,%d",
583 pointer_x, pointer_y);
584 gst_navigation_send_mouse_event (GST_NAVIGATION (ximagesink),
585 "mouse-move", 0, pointer_x, pointer_y);
587 g_mutex_lock (&ximagesink->flow_lock);
588 g_mutex_lock (&ximagesink->x_lock);
591 /* We get all remaining events on our window to throw them upstream */
592 while (XCheckWindowEvent (ximagesink->xcontext->disp,
593 ximagesink->xwindow->win,
594 KeyPressMask | KeyReleaseMask |
595 ButtonPressMask | ButtonReleaseMask, &e)) {
597 const char *key_str = NULL;
599 /* We lock only for the X function call */
600 g_mutex_unlock (&ximagesink->x_lock);
601 g_mutex_unlock (&ximagesink->flow_lock);
605 /* Mouse button pressed/released over our window. We send upstream
606 events for interactivity/navigation */
607 GST_DEBUG ("ximagesink button %d pressed over window at %d,%d",
608 e.xbutton.button, e.xbutton.x, e.xbutton.x);
609 gst_navigation_send_mouse_event (GST_NAVIGATION (ximagesink),
610 "mouse-button-press", e.xbutton.button, e.xbutton.x, e.xbutton.y);
613 GST_DEBUG ("ximagesink button %d release over window at %d,%d",
614 e.xbutton.button, e.xbutton.x, e.xbutton.x);
615 gst_navigation_send_mouse_event (GST_NAVIGATION (ximagesink),
616 "mouse-button-release", e.xbutton.button, e.xbutton.x, e.xbutton.y);
620 /* Key pressed/released over our window. We send upstream
621 events for interactivity/navigation */
622 g_mutex_lock (&ximagesink->x_lock);
623 keysym = XkbKeycodeToKeysym (ximagesink->xcontext->disp,
624 e.xkey.keycode, 0, 0);
625 if (keysym != NoSymbol) {
626 key_str = XKeysymToString (keysym);
630 g_mutex_unlock (&ximagesink->x_lock);
631 GST_DEBUG_OBJECT (ximagesink,
632 "key %d pressed over window at %d,%d (%s)",
633 e.xkey.keycode, e.xkey.x, e.xkey.y, key_str);
634 gst_navigation_send_key_event (GST_NAVIGATION (ximagesink),
635 e.type == KeyPress ? "key-press" : "key-release", key_str);
638 GST_DEBUG_OBJECT (ximagesink, "ximagesink unhandled X event (%d)",
641 g_mutex_lock (&ximagesink->flow_lock);
642 g_mutex_lock (&ximagesink->x_lock);
646 while (XCheckWindowEvent (ximagesink->xcontext->disp,
647 ximagesink->xwindow->win, ExposureMask | StructureNotifyMask, &e)) {
652 case ConfigureNotify:
653 g_mutex_unlock (&ximagesink->x_lock);
654 gst_ximagesink_xwindow_update_geometry (ximagesink);
655 g_mutex_lock (&ximagesink->x_lock);
663 if (ximagesink->handle_expose && (exposed || configured)) {
664 g_mutex_unlock (&ximagesink->x_lock);
665 g_mutex_unlock (&ximagesink->flow_lock);
667 gst_ximagesink_expose (GST_VIDEO_OVERLAY (ximagesink));
669 g_mutex_lock (&ximagesink->flow_lock);
670 g_mutex_lock (&ximagesink->x_lock);
673 /* Handle Display events */
674 while (XPending (ximagesink->xcontext->disp)) {
675 XNextEvent (ximagesink->xcontext->disp, &e);
681 wm_delete = XInternAtom (ximagesink->xcontext->disp,
682 "WM_DELETE_WINDOW", False);
683 if (wm_delete == (Atom) e.xclient.data.l[0]) {
684 /* Handle window deletion by posting an error on the bus */
685 GST_ELEMENT_ERROR (ximagesink, RESOURCE, NOT_FOUND,
686 ("Output window was closed"), (NULL));
688 g_mutex_unlock (&ximagesink->x_lock);
689 gst_ximagesink_xwindow_destroy (ximagesink, ximagesink->xwindow);
690 ximagesink->xwindow = NULL;
691 g_mutex_lock (&ximagesink->x_lock);
700 g_mutex_unlock (&ximagesink->x_lock);
701 g_mutex_unlock (&ximagesink->flow_lock);
705 gst_ximagesink_event_thread (GstXImageSink * ximagesink)
707 g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), NULL);
709 GST_OBJECT_LOCK (ximagesink);
710 while (ximagesink->running) {
711 GST_OBJECT_UNLOCK (ximagesink);
713 if (ximagesink->xwindow) {
714 gst_ximagesink_handle_xevents (ximagesink);
716 /* FIXME: do we want to align this with the framerate or anything else? */
717 g_usleep (G_USEC_PER_SEC / 20);
719 GST_OBJECT_LOCK (ximagesink);
721 GST_OBJECT_UNLOCK (ximagesink);
727 gst_ximagesink_manage_event_thread (GstXImageSink * ximagesink)
729 GThread *thread = NULL;
731 /* don't start the thread too early */
732 if (ximagesink->xcontext == NULL) {
736 GST_OBJECT_LOCK (ximagesink);
737 if (ximagesink->handle_expose || ximagesink->handle_events) {
738 if (!ximagesink->event_thread) {
739 /* Setup our event listening thread */
740 GST_DEBUG_OBJECT (ximagesink, "run xevent thread, expose %d, events %d",
741 ximagesink->handle_expose, ximagesink->handle_events);
742 ximagesink->running = TRUE;
743 ximagesink->event_thread = g_thread_try_new ("ximagesink-events",
744 (GThreadFunc) gst_ximagesink_event_thread, ximagesink, NULL);
747 if (ximagesink->event_thread) {
748 GST_DEBUG_OBJECT (ximagesink, "stop xevent thread, expose %d, events %d",
749 ximagesink->handle_expose, ximagesink->handle_events);
750 ximagesink->running = FALSE;
751 /* grab thread and mark it as NULL */
752 thread = ximagesink->event_thread;
753 ximagesink->event_thread = NULL;
756 GST_OBJECT_UNLOCK (ximagesink);
758 /* Wait for our event thread to finish */
760 g_thread_join (thread);
765 /* This function calculates the pixel aspect ratio based on the properties
766 * in the xcontext structure and stores it there. */
768 gst_ximagesink_calculate_pixel_aspect_ratio (GstXContext * xcontext)
770 static const gint par[][2] = {
771 {1, 1}, /* regular screen */
772 {16, 15}, /* PAL TV */
773 {11, 10}, /* 525 line Rec.601 video */
774 {54, 59}, /* 625 line Rec.601 video */
775 {64, 45}, /* 1280x1024 on 16:9 display */
776 {5, 3}, /* 1280x1024 on 4:3 display */
777 {4, 3} /* 800x600 on 16:9 display */
784 #define DELTA(idx) (ABS (ratio - ((gdouble) par[idx][0] / par[idx][1])))
786 /* first calculate the "real" ratio based on the X values;
787 * which is the "physical" w/h divided by the w/h in pixels of the display */
788 ratio = (gdouble) (xcontext->widthmm * xcontext->height)
789 / (xcontext->heightmm * xcontext->width);
791 /* DirectFB's X in 720x576 reports the physical dimensions wrong, so
793 if (xcontext->width == 720 && xcontext->height == 576) {
794 ratio = 4.0 * 576 / (3.0 * 720);
796 GST_DEBUG ("calculated pixel aspect ratio: %f", ratio);
798 /* now find the one from par[][2] with the lowest delta to the real one */
802 for (i = 1; i < sizeof (par) / (sizeof (gint) * 2); ++i) {
803 gdouble this_delta = DELTA (i);
805 if (this_delta < delta) {
811 GST_DEBUG ("Decided on index %d (%d/%d)", index,
812 par[index][0], par[index][1]);
814 g_free (xcontext->par);
815 xcontext->par = g_new0 (GValue, 1);
816 g_value_init (xcontext->par, GST_TYPE_FRACTION);
817 gst_value_set_fraction (xcontext->par, par[index][0], par[index][1]);
818 GST_DEBUG ("set xcontext PAR to %d/%d",
819 gst_value_get_fraction_numerator (xcontext->par),
820 gst_value_get_fraction_denominator (xcontext->par));
823 /* This function gets the X Display and global info about it. Everything is
824 stored in our object and will be cleaned when the object is disposed. Note
825 here that caps for supported format are generated without any window or
828 gst_ximagesink_xcontext_get (GstXImageSink * ximagesink)
830 GstXContext *xcontext = NULL;
831 XPixmapFormatValues *px_formats = NULL;
832 gint nb_formats = 0, i;
834 GstVideoFormat vformat;
836 g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), NULL);
838 xcontext = g_new0 (GstXContext, 1);
840 g_mutex_lock (&ximagesink->x_lock);
842 xcontext->disp = XOpenDisplay (ximagesink->display_name);
844 if (!xcontext->disp) {
845 g_mutex_unlock (&ximagesink->x_lock);
847 GST_ELEMENT_ERROR (ximagesink, RESOURCE, WRITE,
848 ("Could not initialise X output"), ("Could not open display"));
852 xcontext->screen = DefaultScreenOfDisplay (xcontext->disp);
853 xcontext->screen_num = DefaultScreen (xcontext->disp);
854 xcontext->visual = DefaultVisual (xcontext->disp, xcontext->screen_num);
855 xcontext->root = DefaultRootWindow (xcontext->disp);
856 xcontext->white = XWhitePixel (xcontext->disp, xcontext->screen_num);
857 xcontext->black = XBlackPixel (xcontext->disp, xcontext->screen_num);
858 xcontext->depth = DefaultDepthOfScreen (xcontext->screen);
860 xcontext->width = DisplayWidth (xcontext->disp, xcontext->screen_num);
861 xcontext->height = DisplayHeight (xcontext->disp, xcontext->screen_num);
862 xcontext->widthmm = DisplayWidthMM (xcontext->disp, xcontext->screen_num);
863 xcontext->heightmm = DisplayHeightMM (xcontext->disp, xcontext->screen_num);
865 GST_DEBUG_OBJECT (ximagesink, "X reports %dx%d pixels and %d mm x %d mm",
866 xcontext->width, xcontext->height, xcontext->widthmm, xcontext->heightmm);
868 gst_ximagesink_calculate_pixel_aspect_ratio (xcontext);
870 /* We get supported pixmap formats at supported depth */
871 px_formats = XListPixmapFormats (xcontext->disp, &nb_formats);
874 XCloseDisplay (xcontext->disp);
875 g_mutex_unlock (&ximagesink->x_lock);
876 g_free (xcontext->par);
878 GST_ELEMENT_ERROR (ximagesink, RESOURCE, SETTINGS,
879 ("Could not get supported pixmap formats"), (NULL));
883 /* We get bpp value corresponding to our running depth */
884 for (i = 0; i < nb_formats; i++) {
885 if (px_formats[i].depth == xcontext->depth)
886 xcontext->bpp = px_formats[i].bits_per_pixel;
891 endianness = (ImageByteOrder (xcontext->disp) ==
892 LSBFirst) ? G_LITTLE_ENDIAN : G_BIG_ENDIAN;
894 /* Search for XShm extension support */
896 if (XShmQueryExtension (xcontext->disp) &&
897 gst_ximagesink_check_xshm_calls (ximagesink, xcontext)) {
898 xcontext->use_xshm = TRUE;
899 GST_DEBUG ("ximagesink is using XShm extension");
901 #endif /* HAVE_XSHM */
903 xcontext->use_xshm = FALSE;
904 GST_DEBUG ("ximagesink is not using XShm extension");
907 vformat = gst_video_format_from_masks (xcontext->depth, xcontext->bpp,
908 endianness, xcontext->visual->red_mask, xcontext->visual->green_mask,
909 xcontext->visual->blue_mask, 0);
911 if (vformat == GST_VIDEO_FORMAT_UNKNOWN)
914 /* update object's par with calculated one if not set yet */
915 if (!ximagesink->par) {
916 ximagesink->par = g_new0 (GValue, 1);
917 gst_value_init_and_copy (ximagesink->par, xcontext->par);
918 GST_DEBUG_OBJECT (ximagesink, "set calculated PAR on object's PAR");
920 xcontext->caps = gst_caps_new_simple ("video/x-raw",
921 "format", G_TYPE_STRING, gst_video_format_to_string (vformat),
922 "width", GST_TYPE_INT_RANGE, 1, G_MAXINT,
923 "height", GST_TYPE_INT_RANGE, 1, G_MAXINT,
924 "framerate", GST_TYPE_FRACTION_RANGE, 0, 1, G_MAXINT, 1, NULL);
925 if (ximagesink->par) {
928 nom = gst_value_get_fraction_numerator (ximagesink->par);
929 den = gst_value_get_fraction_denominator (ximagesink->par);
930 gst_caps_set_simple (xcontext->caps, "pixel-aspect-ratio",
931 GST_TYPE_FRACTION, nom, den, NULL);
934 g_mutex_unlock (&ximagesink->x_lock);
941 GST_ERROR_OBJECT (ximagesink, "unknown format");
946 /* This function cleans the X context. Closing the Display and unrefing the
947 caps for supported formats. */
949 gst_ximagesink_xcontext_clear (GstXImageSink * ximagesink)
951 GstXContext *xcontext;
953 g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
955 GST_OBJECT_LOCK (ximagesink);
956 if (ximagesink->xcontext == NULL) {
957 GST_OBJECT_UNLOCK (ximagesink);
961 /* Take the xcontext reference and NULL it while we
962 * clean it up, so that any buffer-alloced buffers
963 * arriving after this will be freed correctly */
964 xcontext = ximagesink->xcontext;
965 ximagesink->xcontext = NULL;
967 GST_OBJECT_UNLOCK (ximagesink);
969 gst_caps_unref (xcontext->caps);
970 g_free (xcontext->par);
971 g_free (ximagesink->par);
972 ximagesink->par = NULL;
974 if (xcontext->last_caps)
975 gst_caps_replace (&xcontext->last_caps, NULL);
977 g_mutex_lock (&ximagesink->x_lock);
979 XCloseDisplay (xcontext->disp);
981 g_mutex_unlock (&ximagesink->x_lock);
989 gst_ximagesink_getcaps (GstBaseSink * bsink, GstCaps * filter)
991 GstXImageSink *ximagesink;
995 ximagesink = GST_XIMAGESINK (bsink);
997 g_mutex_lock (&ximagesink->x_lock);
998 if (ximagesink->xcontext) {
1001 caps = gst_caps_ref (ximagesink->xcontext->caps);
1004 GstCaps *intersection;
1007 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
1008 gst_caps_unref (caps);
1009 caps = intersection;
1012 if (gst_caps_is_empty (caps)) {
1013 g_mutex_unlock (&ximagesink->x_lock);
1017 if (ximagesink->xwindow && ximagesink->xwindow->width) {
1018 GstStructure *s0, *s1;
1020 caps = gst_caps_make_writable (caps);
1022 /* There can only be a single structure because the xcontext
1023 * caps only have a single structure */
1024 s0 = gst_caps_get_structure (caps, 0);
1025 s1 = gst_structure_copy (gst_caps_get_structure (caps, 0));
1027 gst_structure_set (s0, "width", G_TYPE_INT, ximagesink->xwindow->width,
1028 "height", G_TYPE_INT, ximagesink->xwindow->height, NULL);
1029 gst_caps_append_structure (caps, s1);
1031 /* This will not change the order but will remove the
1032 * fixed width/height caps again if not possible
1035 GstCaps *intersection;
1038 gst_caps_intersect_full (caps, filter, GST_CAPS_INTERSECT_FIRST);
1039 gst_caps_unref (caps);
1040 caps = intersection;
1044 g_mutex_unlock (&ximagesink->x_lock);
1047 g_mutex_unlock (&ximagesink->x_lock);
1049 /* get a template copy and add the pixel aspect ratio */
1050 caps = gst_pad_get_pad_template_caps (GST_BASE_SINK (ximagesink)->sinkpad);
1051 if (ximagesink->par) {
1052 caps = gst_caps_make_writable (caps);
1053 for (i = 0; i < gst_caps_get_size (caps); ++i) {
1054 GstStructure *structure = gst_caps_get_structure (caps, i);
1057 nom = gst_value_get_fraction_numerator (ximagesink->par);
1058 den = gst_value_get_fraction_denominator (ximagesink->par);
1059 gst_structure_set (structure, "pixel-aspect-ratio",
1060 GST_TYPE_FRACTION, nom, den, NULL);
1065 GstCaps *intersection;
1068 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
1069 gst_caps_unref (caps);
1070 caps = intersection;
1077 gst_ximagesink_setcaps (GstBaseSink * bsink, GstCaps * caps)
1079 GstXImageSink *ximagesink;
1080 GstStructure *structure;
1082 GstBufferPool *newpool, *oldpool;
1085 static GstAllocationParams params = { 0, 15, 0, 0, };
1087 ximagesink = GST_XIMAGESINK (bsink);
1089 if (!ximagesink->xcontext)
1092 GST_DEBUG_OBJECT (ximagesink,
1093 "sinkconnect possible caps %" GST_PTR_FORMAT " with given caps %"
1094 GST_PTR_FORMAT, ximagesink->xcontext->caps, caps);
1096 /* We intersect those caps with our template to make sure they are correct */
1097 if (!gst_caps_can_intersect (ximagesink->xcontext->caps, caps))
1098 goto incompatible_caps;
1100 if (!gst_video_info_from_caps (&info, caps))
1101 goto invalid_format;
1105 structure = gst_caps_get_structure (caps, 0);
1106 /* if the caps contain pixel-aspect-ratio, they have to match ours,
1107 * otherwise linking should fail */
1108 par = gst_structure_get_value (structure, "pixel-aspect-ratio");
1110 if (ximagesink->par) {
1111 if (gst_value_compare (par, ximagesink->par) != GST_VALUE_EQUAL) {
1114 } else if (ximagesink->xcontext->par) {
1115 if (gst_value_compare (par, ximagesink->xcontext->par) != GST_VALUE_EQUAL) {
1121 GST_VIDEO_SINK_WIDTH (ximagesink) = info.width;
1122 GST_VIDEO_SINK_HEIGHT (ximagesink) = info.height;
1123 ximagesink->fps_n = info.fps_n;
1124 ximagesink->fps_d = info.fps_d;
1126 /* Notify application to set xwindow id now */
1127 g_mutex_lock (&ximagesink->flow_lock);
1128 if (!ximagesink->xwindow) {
1129 g_mutex_unlock (&ximagesink->flow_lock);
1130 gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (ximagesink));
1132 g_mutex_unlock (&ximagesink->flow_lock);
1135 /* Creating our window and our image */
1136 if (GST_VIDEO_SINK_WIDTH (ximagesink) <= 0 ||
1137 GST_VIDEO_SINK_HEIGHT (ximagesink) <= 0)
1140 g_mutex_lock (&ximagesink->flow_lock);
1141 if (!ximagesink->xwindow) {
1142 ximagesink->xwindow = gst_ximagesink_xwindow_new (ximagesink,
1143 GST_VIDEO_SINK_WIDTH (ximagesink), GST_VIDEO_SINK_HEIGHT (ximagesink));
1146 ximagesink->info = info;
1148 /* Remember to draw borders for next frame */
1149 ximagesink->draw_border = TRUE;
1151 /* create a new pool for the new configuration */
1152 newpool = gst_ximage_buffer_pool_new (ximagesink);
1154 structure = gst_buffer_pool_get_config (newpool);
1155 gst_buffer_pool_config_set_params (structure, caps, size, 2, 0);
1156 gst_buffer_pool_config_set_allocator (structure, NULL, ¶ms);
1157 if (!gst_buffer_pool_set_config (newpool, structure))
1160 oldpool = ximagesink->pool;
1161 /* we don't activate the pool yet, this will be done by downstream after it
1162 * has configured the pool. If downstream does not want our pool we will
1163 * activate it when we render into it */
1164 ximagesink->pool = newpool;
1165 g_mutex_unlock (&ximagesink->flow_lock);
1167 /* unref the old sink */
1169 /* we don't deactivate, some elements might still be using it, it will be
1170 * deactivated when the last ref is gone */
1171 gst_object_unref (oldpool);
1179 GST_ERROR_OBJECT (ximagesink, "caps incompatible");
1184 GST_ERROR_OBJECT (ximagesink, "caps invalid");
1189 GST_INFO_OBJECT (ximagesink, "pixel aspect ratio does not match");
1194 GST_ELEMENT_ERROR (ximagesink, CORE, NEGOTIATION, (NULL),
1195 ("Invalid image size."));
1200 GST_ERROR_OBJECT (ximagesink, "failed to set config.");
1201 g_mutex_unlock (&ximagesink->flow_lock);
1206 static GstStateChangeReturn
1207 gst_ximagesink_change_state (GstElement * element, GstStateChange transition)
1209 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1210 GstXImageSink *ximagesink;
1211 GstXContext *xcontext = NULL;
1213 ximagesink = GST_XIMAGESINK (element);
1215 switch (transition) {
1216 case GST_STATE_CHANGE_NULL_TO_READY:
1217 /* Initializing the XContext */
1218 if (ximagesink->xcontext == NULL) {
1219 xcontext = gst_ximagesink_xcontext_get (ximagesink);
1220 if (xcontext == NULL) {
1221 ret = GST_STATE_CHANGE_FAILURE;
1224 GST_OBJECT_LOCK (ximagesink);
1226 ximagesink->xcontext = xcontext;
1227 GST_OBJECT_UNLOCK (ximagesink);
1230 /* call XSynchronize with the current value of synchronous */
1231 GST_DEBUG_OBJECT (ximagesink, "XSynchronize called with %s",
1232 ximagesink->synchronous ? "TRUE" : "FALSE");
1233 g_mutex_lock (&ximagesink->x_lock);
1234 XSynchronize (ximagesink->xcontext->disp, ximagesink->synchronous);
1235 g_mutex_unlock (&ximagesink->x_lock);
1236 gst_ximagesink_manage_event_thread (ximagesink);
1238 case GST_STATE_CHANGE_READY_TO_PAUSED:
1239 g_mutex_lock (&ximagesink->flow_lock);
1240 if (ximagesink->xwindow)
1241 gst_ximagesink_xwindow_clear (ximagesink, ximagesink->xwindow);
1242 g_mutex_unlock (&ximagesink->flow_lock);
1244 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1250 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1252 switch (transition) {
1253 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1255 case GST_STATE_CHANGE_PAUSED_TO_READY:
1256 ximagesink->fps_n = 0;
1257 ximagesink->fps_d = 1;
1258 GST_VIDEO_SINK_WIDTH (ximagesink) = 0;
1259 GST_VIDEO_SINK_HEIGHT (ximagesink) = 0;
1260 g_mutex_lock (&ximagesink->flow_lock);
1261 if (ximagesink->pool)
1262 gst_buffer_pool_set_active (ximagesink->pool, FALSE);
1263 g_mutex_unlock (&ximagesink->flow_lock);
1265 case GST_STATE_CHANGE_READY_TO_NULL:
1266 gst_ximagesink_reset (ximagesink);
1277 gst_ximagesink_get_times (GstBaseSink * bsink, GstBuffer * buf,
1278 GstClockTime * start, GstClockTime * end)
1280 GstXImageSink *ximagesink;
1282 ximagesink = GST_XIMAGESINK (bsink);
1284 if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1285 *start = GST_BUFFER_TIMESTAMP (buf);
1286 if (GST_BUFFER_DURATION_IS_VALID (buf)) {
1287 *end = *start + GST_BUFFER_DURATION (buf);
1289 if (ximagesink->fps_n > 0) {
1291 gst_util_uint64_scale_int (GST_SECOND, ximagesink->fps_d,
1298 static GstFlowReturn
1299 gst_ximagesink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
1302 GstXImageSink *ximagesink;
1303 GstXImageMemory *mem;
1304 GstBuffer *to_put = NULL;
1306 ximagesink = GST_XIMAGESINK (vsink);
1308 if (gst_buffer_n_memory (buf) == 1
1309 && (mem = (GstXImageMemory *) gst_buffer_peek_memory (buf, 0))
1310 && g_strcmp0 (mem->parent.allocator->mem_type, "ximage") == 0
1311 && mem->sink == ximagesink) {
1312 /* If this buffer has been allocated using our buffer management we simply
1313 put the ximage which is in the PRIVATE pointer */
1314 GST_LOG_OBJECT (ximagesink, "buffer from our pool, writing directly");
1318 GstVideoFrame src, dest;
1319 GstBufferPoolAcquireParams params = { 0, };
1321 /* Else we have to copy the data into our private image, */
1322 /* if we have one... */
1323 GST_LOG_OBJECT (ximagesink, "buffer not from our pool, copying");
1325 /* we should have a pool, configured in setcaps */
1326 if (ximagesink->pool == NULL)
1329 if (!gst_buffer_pool_set_active (ximagesink->pool, TRUE))
1330 goto activate_failed;
1332 /* take a buffer from our pool, if there is no buffer in the pool something
1333 * is seriously wrong, waiting for the pool here might deadlock when we try
1334 * to go to PAUSED because we never flush the pool. */
1335 params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
1336 res = gst_buffer_pool_acquire_buffer (ximagesink->pool, &to_put, ¶ms);
1337 if (res != GST_FLOW_OK)
1340 GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, ximagesink,
1341 "slow copy into bufferpool buffer %p", to_put);
1343 if (!gst_video_frame_map (&src, &ximagesink->info, buf, GST_MAP_READ))
1344 goto invalid_buffer;
1346 if (!gst_video_frame_map (&dest, &ximagesink->info, to_put, GST_MAP_WRITE)) {
1347 gst_video_frame_unmap (&src);
1348 goto invalid_buffer;
1351 gst_video_frame_copy (&dest, &src);
1353 gst_video_frame_unmap (&dest);
1354 gst_video_frame_unmap (&src);
1357 if (!gst_ximagesink_ximage_put (ximagesink, to_put))
1362 gst_buffer_unref (to_put);
1369 GST_ELEMENT_ERROR (ximagesink, RESOURCE, WRITE,
1370 ("Internal error: can't allocate images"),
1371 ("We don't have a bufferpool negotiated"));
1372 return GST_FLOW_ERROR;
1376 /* No image available. That's very bad ! */
1377 GST_WARNING_OBJECT (ximagesink, "could not create image");
1382 /* No Window available to put our image into */
1383 GST_WARNING_OBJECT (ximagesink, "could not map image");
1389 /* No Window available to put our image into */
1390 GST_WARNING_OBJECT (ximagesink, "could not output image - no window");
1391 res = GST_FLOW_ERROR;
1396 GST_ERROR_OBJECT (ximagesink, "failed to activate bufferpool.");
1397 res = GST_FLOW_ERROR;
1403 gst_ximagesink_event (GstBaseSink * sink, GstEvent * event)
1405 GstXImageSink *ximagesink = GST_XIMAGESINK (sink);
1407 switch (GST_EVENT_TYPE (event)) {
1408 case GST_EVENT_TAG:{
1410 gchar *title = NULL;
1412 gst_event_parse_tag (event, &l);
1413 gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
1416 GST_DEBUG_OBJECT (ximagesink, "got tags, title='%s'", title);
1417 gst_ximagesink_xwindow_set_title (ximagesink, ximagesink->xwindow,
1427 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
1431 gst_ximagesink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
1433 GstXImageSink *ximagesink = GST_XIMAGESINK (bsink);
1434 GstBufferPool *pool;
1435 GstStructure *config;
1440 gst_query_parse_allocation (query, &caps, &need_pool);
1445 g_mutex_lock (&ximagesink->flow_lock);
1446 if ((pool = ximagesink->pool))
1447 gst_object_ref (pool);
1448 g_mutex_unlock (&ximagesink->flow_lock);
1453 /* we had a pool, check caps */
1454 config = gst_buffer_pool_get_config (pool);
1455 gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
1457 GST_DEBUG_OBJECT (ximagesink,
1458 "we had a pool with caps %" GST_PTR_FORMAT, pcaps);
1459 if (!gst_caps_is_equal (caps, pcaps)) {
1460 /* different caps, we can't use this pool */
1461 GST_DEBUG_OBJECT (ximagesink, "pool has different caps");
1462 gst_object_unref (pool);
1465 gst_structure_free (config);
1467 if (pool == NULL && need_pool) {
1470 if (!gst_video_info_from_caps (&info, caps))
1473 GST_DEBUG_OBJECT (ximagesink, "create new pool");
1474 pool = gst_ximage_buffer_pool_new (ximagesink);
1476 /* the normal size of a frame */
1479 config = gst_buffer_pool_get_config (pool);
1480 gst_buffer_pool_config_set_params (config, caps, size, 0, 0);
1481 if (!gst_buffer_pool_set_config (pool, config))
1485 /* we need at least 2 buffer because we hold on to the last one */
1486 gst_query_add_allocation_pool (query, pool, size, 2, 0);
1487 gst_object_unref (pool);
1490 /* we also support various metadata */
1491 gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL);
1492 gst_query_add_allocation_meta (query, GST_VIDEO_CROP_META_API_TYPE, NULL);
1499 GST_DEBUG_OBJECT (bsink, "no caps specified");
1504 GST_DEBUG_OBJECT (bsink, "invalid caps specified");
1509 GST_DEBUG_OBJECT (bsink, "failed setting config");
1510 gst_object_unref (pool);
1515 /* Interfaces stuff */
1517 gst_ximagesink_navigation_send_event (GstNavigation * navigation,
1518 GstStructure * structure)
1520 GstXImageSink *ximagesink = GST_XIMAGESINK (navigation);
1522 gint x_offset, y_offset;
1526 event = gst_event_new_navigation (structure);
1528 /* We are not converting the pointer coordinates as there's no hardware
1529 scaling done here. The only possible scaling is done by videoscale and
1530 videoscale will have to catch those events and tranform the coordinates
1531 to match the applied scaling. So here we just add the offset if the image
1532 is centered in the window. */
1534 /* We take the flow_lock while we look at the window */
1535 g_mutex_lock (&ximagesink->flow_lock);
1537 if (!ximagesink->xwindow) {
1538 g_mutex_unlock (&ximagesink->flow_lock);
1542 x_offset = ximagesink->xwindow->width - GST_VIDEO_SINK_WIDTH (ximagesink);
1543 y_offset = ximagesink->xwindow->height - GST_VIDEO_SINK_HEIGHT (ximagesink);
1545 g_mutex_unlock (&ximagesink->flow_lock);
1547 if (x_offset > 0 && gst_structure_get_double (structure, "pointer_x", &x)) {
1549 gst_structure_set (structure, "pointer_x", G_TYPE_DOUBLE, x, NULL);
1551 if (y_offset > 0 && gst_structure_get_double (structure, "pointer_y", &y)) {
1553 gst_structure_set (structure, "pointer_y", G_TYPE_DOUBLE, y, NULL);
1556 pad = gst_pad_get_peer (GST_VIDEO_SINK_PAD (ximagesink));
1558 if (GST_IS_PAD (pad) && GST_IS_EVENT (event)) {
1559 gst_pad_send_event (pad, event);
1561 gst_object_unref (pad);
1566 gst_ximagesink_navigation_init (GstNavigationInterface * iface)
1568 iface->send_event = gst_ximagesink_navigation_send_event;
1572 gst_ximagesink_set_window_handle (GstVideoOverlay * overlay, guintptr id)
1574 XID xwindow_id = id;
1575 GstXImageSink *ximagesink = GST_XIMAGESINK (overlay);
1576 GstXWindow *xwindow = NULL;
1577 XWindowAttributes attr;
1579 /* We acquire the stream lock while setting this window in the element.
1580 We are basically cleaning tons of stuff replacing the old window, putting
1581 images while we do that would surely crash */
1582 g_mutex_lock (&ximagesink->flow_lock);
1584 /* If we already use that window return */
1585 if (ximagesink->xwindow && (xwindow_id == ximagesink->xwindow->win)) {
1586 g_mutex_unlock (&ximagesink->flow_lock);
1590 /* If the element has not initialized the X11 context try to do so */
1591 if (!ximagesink->xcontext &&
1592 !(ximagesink->xcontext = gst_ximagesink_xcontext_get (ximagesink))) {
1593 g_mutex_unlock (&ximagesink->flow_lock);
1594 /* we have thrown a GST_ELEMENT_ERROR now */
1598 /* If a window is there already we destroy it */
1599 if (ximagesink->xwindow) {
1600 gst_ximagesink_xwindow_destroy (ximagesink, ximagesink->xwindow);
1601 ximagesink->xwindow = NULL;
1604 /* If the xid is 0 we go back to an internal window */
1605 if (xwindow_id == 0) {
1606 /* If no width/height caps nego did not happen window will be created
1607 during caps nego then */
1608 if (GST_VIDEO_SINK_WIDTH (ximagesink) && GST_VIDEO_SINK_HEIGHT (ximagesink)) {
1609 xwindow = gst_ximagesink_xwindow_new (ximagesink,
1610 GST_VIDEO_SINK_WIDTH (ximagesink),
1611 GST_VIDEO_SINK_HEIGHT (ximagesink));
1614 xwindow = g_new0 (GstXWindow, 1);
1616 xwindow->win = xwindow_id;
1618 /* We get window geometry, set the event we want to receive,
1620 g_mutex_lock (&ximagesink->x_lock);
1621 XGetWindowAttributes (ximagesink->xcontext->disp, xwindow->win, &attr);
1622 xwindow->width = attr.width;
1623 xwindow->height = attr.height;
1624 xwindow->internal = FALSE;
1625 if (ximagesink->handle_events) {
1626 XSelectInput (ximagesink->xcontext->disp, xwindow->win, ExposureMask |
1627 StructureNotifyMask | PointerMotionMask | KeyPressMask |
1631 xwindow->gc = XCreateGC (ximagesink->xcontext->disp, xwindow->win, 0, NULL);
1632 g_mutex_unlock (&ximagesink->x_lock);
1636 ximagesink->xwindow = xwindow;
1638 g_mutex_unlock (&ximagesink->flow_lock);
1642 gst_ximagesink_expose (GstVideoOverlay * overlay)
1644 GstXImageSink *ximagesink = GST_XIMAGESINK (overlay);
1646 gst_ximagesink_xwindow_update_geometry (ximagesink);
1647 gst_ximagesink_ximage_put (ximagesink, NULL);
1651 gst_ximagesink_set_event_handling (GstVideoOverlay * overlay,
1652 gboolean handle_events)
1654 GstXImageSink *ximagesink = GST_XIMAGESINK (overlay);
1656 ximagesink->handle_events = handle_events;
1658 g_mutex_lock (&ximagesink->flow_lock);
1660 if (G_UNLIKELY (!ximagesink->xwindow)) {
1661 g_mutex_unlock (&ximagesink->flow_lock);
1665 g_mutex_lock (&ximagesink->x_lock);
1667 if (handle_events) {
1668 if (ximagesink->xwindow->internal) {
1669 XSelectInput (ximagesink->xcontext->disp, ximagesink->xwindow->win,
1670 ExposureMask | StructureNotifyMask | PointerMotionMask |
1671 KeyPressMask | KeyReleaseMask | ButtonPressMask | ButtonReleaseMask);
1673 XSelectInput (ximagesink->xcontext->disp, ximagesink->xwindow->win,
1674 ExposureMask | StructureNotifyMask | PointerMotionMask |
1675 KeyPressMask | KeyReleaseMask);
1678 XSelectInput (ximagesink->xcontext->disp, ximagesink->xwindow->win, 0);
1681 g_mutex_unlock (&ximagesink->x_lock);
1683 g_mutex_unlock (&ximagesink->flow_lock);
1687 gst_ximagesink_video_overlay_init (GstVideoOverlayInterface * iface)
1689 iface->set_window_handle = gst_ximagesink_set_window_handle;
1690 iface->expose = gst_ximagesink_expose;
1691 iface->handle_events = gst_ximagesink_set_event_handling;
1694 /* =========================================== */
1696 /* Init & Class init */
1698 /* =========================================== */
1701 gst_ximagesink_set_property (GObject * object, guint prop_id,
1702 const GValue * value, GParamSpec * pspec)
1704 GstXImageSink *ximagesink;
1706 g_return_if_fail (GST_IS_XIMAGESINK (object));
1708 ximagesink = GST_XIMAGESINK (object);
1712 ximagesink->display_name = g_strdup (g_value_get_string (value));
1714 case PROP_SYNCHRONOUS:
1715 ximagesink->synchronous = g_value_get_boolean (value);
1716 if (ximagesink->xcontext) {
1717 GST_DEBUG_OBJECT (ximagesink, "XSynchronize called with %s",
1718 ximagesink->synchronous ? "TRUE" : "FALSE");
1719 g_mutex_lock (&ximagesink->x_lock);
1720 XSynchronize (ximagesink->xcontext->disp, ximagesink->synchronous);
1721 g_mutex_unlock (&ximagesink->x_lock);
1724 case PROP_FORCE_ASPECT_RATIO:
1725 ximagesink->keep_aspect = g_value_get_boolean (value);
1727 case PROP_PIXEL_ASPECT_RATIO:
1731 tmp = g_new0 (GValue, 1);
1732 g_value_init (tmp, GST_TYPE_FRACTION);
1734 if (!g_value_transform (value, tmp)) {
1735 GST_WARNING_OBJECT (ximagesink,
1736 "Could not transform string to aspect ratio");
1739 GST_DEBUG_OBJECT (ximagesink, "set PAR to %d/%d",
1740 gst_value_get_fraction_numerator (tmp),
1741 gst_value_get_fraction_denominator (tmp));
1742 g_free (ximagesink->par);
1743 ximagesink->par = tmp;
1747 case PROP_HANDLE_EVENTS:
1748 gst_ximagesink_set_event_handling (GST_VIDEO_OVERLAY (ximagesink),
1749 g_value_get_boolean (value));
1750 gst_ximagesink_manage_event_thread (ximagesink);
1752 case PROP_HANDLE_EXPOSE:
1753 ximagesink->handle_expose = g_value_get_boolean (value);
1754 gst_ximagesink_manage_event_thread (ximagesink);
1757 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1763 gst_ximagesink_get_property (GObject * object, guint prop_id,
1764 GValue * value, GParamSpec * pspec)
1766 GstXImageSink *ximagesink;
1768 g_return_if_fail (GST_IS_XIMAGESINK (object));
1770 ximagesink = GST_XIMAGESINK (object);
1774 g_value_set_string (value, ximagesink->display_name);
1776 case PROP_SYNCHRONOUS:
1777 g_value_set_boolean (value, ximagesink->synchronous);
1779 case PROP_FORCE_ASPECT_RATIO:
1780 g_value_set_boolean (value, ximagesink->keep_aspect);
1782 case PROP_PIXEL_ASPECT_RATIO:
1783 if (ximagesink->par)
1784 g_value_transform (ximagesink->par, value);
1786 case PROP_HANDLE_EVENTS:
1787 g_value_set_boolean (value, ximagesink->handle_events);
1789 case PROP_HANDLE_EXPOSE:
1790 g_value_set_boolean (value, ximagesink->handle_expose);
1792 case PROP_WINDOW_WIDTH:
1793 if (ximagesink->xwindow)
1794 g_value_set_uint64 (value, ximagesink->xwindow->width);
1796 g_value_set_uint64 (value, 0);
1798 case PROP_WINDOW_HEIGHT:
1799 if (ximagesink->xwindow)
1800 g_value_set_uint64 (value, ximagesink->xwindow->height);
1802 g_value_set_uint64 (value, 0);
1805 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1811 gst_ximagesink_reset (GstXImageSink * ximagesink)
1815 GST_OBJECT_LOCK (ximagesink);
1816 ximagesink->running = FALSE;
1817 /* grab thread and mark it as NULL */
1818 thread = ximagesink->event_thread;
1819 ximagesink->event_thread = NULL;
1820 GST_OBJECT_UNLOCK (ximagesink);
1822 /* Wait for our event thread to finish before we clean up our stuff. */
1824 g_thread_join (thread);
1826 if (ximagesink->cur_image) {
1827 gst_buffer_unref (ximagesink->cur_image);
1828 ximagesink->cur_image = NULL;
1831 g_mutex_lock (&ximagesink->flow_lock);
1833 if (ximagesink->pool) {
1834 gst_object_unref (ximagesink->pool);
1835 ximagesink->pool = NULL;
1838 if (ximagesink->xwindow) {
1839 gst_ximagesink_xwindow_clear (ximagesink, ximagesink->xwindow);
1840 gst_ximagesink_xwindow_destroy (ximagesink, ximagesink->xwindow);
1841 ximagesink->xwindow = NULL;
1843 g_mutex_unlock (&ximagesink->flow_lock);
1845 gst_ximagesink_xcontext_clear (ximagesink);
1849 gst_ximagesink_finalize (GObject * object)
1851 GstXImageSink *ximagesink;
1853 ximagesink = GST_XIMAGESINK (object);
1855 gst_ximagesink_reset (ximagesink);
1857 if (ximagesink->display_name) {
1858 g_free (ximagesink->display_name);
1859 ximagesink->display_name = NULL;
1861 if (ximagesink->par) {
1862 g_free (ximagesink->par);
1863 ximagesink->par = NULL;
1865 g_mutex_clear (&ximagesink->x_lock);
1866 g_mutex_clear (&ximagesink->flow_lock);
1868 g_free (ximagesink->media_title);
1870 G_OBJECT_CLASS (parent_class)->finalize (object);
1874 gst_ximagesink_init (GstXImageSink * ximagesink)
1876 ximagesink->display_name = NULL;
1877 ximagesink->xcontext = NULL;
1878 ximagesink->xwindow = NULL;
1879 ximagesink->cur_image = NULL;
1881 ximagesink->event_thread = NULL;
1882 ximagesink->running = FALSE;
1884 ximagesink->fps_n = 0;
1885 ximagesink->fps_d = 1;
1887 g_mutex_init (&ximagesink->x_lock);
1888 g_mutex_init (&ximagesink->flow_lock);
1890 ximagesink->par = NULL;
1892 ximagesink->pool = NULL;
1894 ximagesink->synchronous = FALSE;
1895 ximagesink->keep_aspect = TRUE;
1896 ximagesink->handle_events = TRUE;
1897 ximagesink->handle_expose = TRUE;
1901 gst_ximagesink_class_init (GstXImageSinkClass * klass)
1903 GObjectClass *gobject_class;
1904 GstElementClass *gstelement_class;
1905 GstBaseSinkClass *gstbasesink_class;
1906 GstVideoSinkClass *videosink_class;
1908 gobject_class = (GObjectClass *) klass;
1909 gstelement_class = (GstElementClass *) klass;
1910 gstbasesink_class = (GstBaseSinkClass *) klass;
1911 videosink_class = (GstVideoSinkClass *) klass;
1913 gobject_class->finalize = gst_ximagesink_finalize;
1914 gobject_class->set_property = gst_ximagesink_set_property;
1915 gobject_class->get_property = gst_ximagesink_get_property;
1917 g_object_class_install_property (gobject_class, PROP_DISPLAY,
1918 g_param_spec_string ("display", "Display", "X Display name",
1919 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1920 g_object_class_install_property (gobject_class, PROP_SYNCHRONOUS,
1921 g_param_spec_boolean ("synchronous", "Synchronous",
1922 "When enabled, runs the X display in synchronous mode. "
1923 "(unrelated to A/V sync, used only for debugging)", FALSE,
1924 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1925 g_object_class_install_property (gobject_class, PROP_FORCE_ASPECT_RATIO,
1926 g_param_spec_boolean ("force-aspect-ratio", "Force aspect ratio",
1927 "When enabled, reverse caps negotiation (scaling) will respect "
1928 "original aspect ratio", TRUE,
1929 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1930 g_object_class_install_property (gobject_class, PROP_PIXEL_ASPECT_RATIO,
1931 g_param_spec_string ("pixel-aspect-ratio", "Pixel Aspect Ratio",
1932 "The pixel aspect ratio of the device", "1/1",
1933 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1934 g_object_class_install_property (gobject_class, PROP_HANDLE_EVENTS,
1935 g_param_spec_boolean ("handle-events", "Handle XEvents",
1936 "When enabled, XEvents will be selected and handled", TRUE,
1937 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1938 g_object_class_install_property (gobject_class, PROP_HANDLE_EXPOSE,
1939 g_param_spec_boolean ("handle-expose", "Handle expose",
1941 "the current frame will always be drawn in response to X Expose "
1942 "events", TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1945 * GstXImageSink:window-width
1947 * Actual width of the video window.
1951 g_object_class_install_property (gobject_class, PROP_WINDOW_WIDTH,
1952 g_param_spec_uint64 ("window-width", "window-width",
1953 "Width of the window", 0, G_MAXUINT64, 0,
1954 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1957 * GstXImageSink:window-height
1959 * Actual height of the video window.
1963 g_object_class_install_property (gobject_class, PROP_WINDOW_HEIGHT,
1964 g_param_spec_uint64 ("window-height", "window-height",
1965 "Height of the window", 0, G_MAXUINT64, 0,
1966 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1968 gst_element_class_set_static_metadata (gstelement_class,
1969 "Video sink", "Sink/Video",
1970 "A standard X based videosink", "Julien Moutte <julien@moutte.net>");
1972 gst_element_class_add_pad_template (gstelement_class,
1973 gst_static_pad_template_get (&gst_ximagesink_sink_template_factory));
1975 gstelement_class->change_state = gst_ximagesink_change_state;
1977 gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_ximagesink_getcaps);
1978 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_ximagesink_setcaps);
1979 gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_ximagesink_get_times);
1980 gstbasesink_class->propose_allocation =
1981 GST_DEBUG_FUNCPTR (gst_ximagesink_propose_allocation);
1982 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_ximagesink_event);
1984 videosink_class->show_frame = GST_DEBUG_FUNCPTR (gst_ximagesink_show_frame);